From 4364deffa74b313ae4fdac003b9110f05de22269 Mon Sep 17 00:00:00 2001 From: Tudor Golubenco Date: Wed, 15 Nov 2017 16:03:56 +0100 Subject: [PATCH] Edits for the existing tutorials (#7) * Implements most edits recommended by @dedemorten * Extracts common parts of the MB tutorials in a `metricbeat_instructions.js` file * Adds correct links to the docs by using the variables --- .../common/tutorials/filebeat_instructions.js | 101 ++++++++++++ .../tutorials/metricbeat_instructions.js | 97 +++++++++++ .../tutorials/tutorial_beats_instructions.js | 103 ------------ .../server/tutorials/apacheLogs/index.js | 31 ++-- .../server/tutorials/apacheMetrics/index.js | 135 +++------------- .../server/tutorials/mysqlLogs/index.js | 31 ++-- .../server/tutorials/mysqlMetrics/index.js | 135 +++------------- .../server/tutorials/nginxLogs/index.js | 31 ++-- .../server/tutorials/nginxMetrics/index.js | 138 +++------------- .../server/tutorials/systemLogs/index.js | 25 ++- .../server/tutorials/systemMetrics/index.js | 151 ++++-------------- 11 files changed, 358 insertions(+), 620 deletions(-) create mode 100644 src/core_plugins/kibana/common/tutorials/filebeat_instructions.js create mode 100644 src/core_plugins/kibana/common/tutorials/metricbeat_instructions.js delete mode 100644 src/core_plugins/kibana/common/tutorials/tutorial_beats_instructions.js diff --git a/src/core_plugins/kibana/common/tutorials/filebeat_instructions.js b/src/core_plugins/kibana/common/tutorials/filebeat_instructions.js new file mode 100644 index 00000000000000..bb138d33a4eca9 --- /dev/null +++ b/src/core_plugins/kibana/common/tutorials/filebeat_instructions.js @@ -0,0 +1,101 @@ +export const FILEBEAT_INSTRUCTIONS = { + INSTALL: { + OSX: { + title: 'Download and install Filebeat', + textPre: 'Skip this step if Filebeat is already installed.' + + ' First time using Filebeat? See the [Getting Started Guide]' + + '({config.docs.beats.filebeat}/filebeat-getting-started.html).', + commands: [ + 'curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{config.kibana.version}-darwin-x86_64.tar.gz', + 'tar xzvf filebeat-{config.kibana.version}-darwin-x86_64.tar.gz', + 'cd filebeat-{config.kibana.version}-darwin-x86_64/', + ], + textPost: 'Modify the settings under `output.elasticsearch` in the ' + + '`filebeat.yml` file to point to your Elasticsearch installation.' + }, + DEB: { + title: 'Download and install Filebeat', + textPre: 'Skip this step if Filebeat is already installed.' + + ' First time using Filebeat? See the [Getting Started Guide]' + + '({config.docs.beats.filebeat}/filebeat-getting-started.html).', + commands: [ + 'curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{config.kibana.version}-amd64.deb', + 'sudo dpkg -i filebeat-{config.kibana.version}-amd64.deb' + ], + textPost: 'Modify the settings under `output.elasticsearch` in the ' + + '`/etc/filebeat/filebeat.yml` file to point to your Elasticsearch installation.\n\n' + + 'Looking for the 32 bits packages? See the [Download page](https://www.elastic.co/downloads/beats/filebeat).' + }, + RPM: { + title: 'Download and install Filebeat', + textPre: 'Skip this step if Filebeat is already installed.' + + ' First time using Filebeat? See the [Getting Started Guide]' + + '({config.docs.beats.filebeat}/filebeat-getting-started.html).', + commands: [ + 'curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{config.kibana.version}-x86_64.rpm', + 'sudo rpm -vi filebeat-{config.kibana.version}-x86_64.rpm' + ], + textPost: 'Modify the settings under `output.elasticsearch` in the ' + + '`/etc/filebeat/filebeat.yml` file to point to your Elasticsearch installation.\n\n' + + 'Looking for the 32 bits packages? See the [Download page](https://www.elastic.co/downloads/beats/filebeat).' + }, + WINDOWS: { + title: 'Download and install Filebeat', + textPre: 'Skip this step if Filebeat is already installed.' + + ' First time using Filebeat? See the [Getting Started Guide]' + + '({config.docs.beats.filebeat}/filebeat-getting-started.html).\n' + + '1. Download the Filebeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats/filebeat) page.\n' + + '2. Extract the contents of the zip file into `C:\\Program Files`.\n' + + '3. Rename the `filebeat-{config.kibana.version}-windows` directory to `Filebeat`.\n' + + '4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' + + ' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' + + '5. From the PowerShell prompt, run the following commands to install Filebeat as a Windows service.', + commands: [ + 'PS > cd C:\\Program Files\\Filebeat', + 'PS C:\\Program Files\\Filebeat> .\\install-service-filebeat.ps1' + ], + textPost: 'Modify the settings under `output.elasticsearch` in the ' + + '`C:\\Program Files\\Filebeat\\filebeat.yml` file to point to your Elasticsearch installation.' + } + }, + START: { + OSX: { + title: 'Start Filebeat', + commands: [ + './filebeat setup -e', + './filebeat -e', + ], + textPost: 'The `setup` command loads the Kibana dashboards.' + + ' If the dashboards are already set up, omit this command.' + }, + DEB: { + title: 'Start Filebeat', + commands: [ + 'sudo filebeat setup -e', + 'sudo service filebeat start', + ], + textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already set up, ' + + 'omit this command.' + }, + RPM: { + title: 'Start Filebeat', + commands: [ + 'sudo filebeat setup -e', + 'sudo service filebeat start', + ], + textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already set up, ' + + 'omit this command.' + }, + WINDOWS: { + title: 'Start Filebeat', + commands: [ + 'PS C:\\Program Files\\Filebeat> filebeat.exe setup -e', + 'PS C:\\Program Files\\Filebeat> Service-Start filebeat', + ], + textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already set up, ' + + 'omit this command.' + } + } +}; + + diff --git a/src/core_plugins/kibana/common/tutorials/metricbeat_instructions.js b/src/core_plugins/kibana/common/tutorials/metricbeat_instructions.js new file mode 100644 index 00000000000000..365b42a0837f94 --- /dev/null +++ b/src/core_plugins/kibana/common/tutorials/metricbeat_instructions.js @@ -0,0 +1,97 @@ +export const METRICBEAT_INSTRUCTIONS = { + INSTALL: { + OSX: { + title: 'Download and install Metricbeat', + textPre: 'Skip this step if Metricbeat is already installed.' + + ' First time using Metricbeat? See the [Getting Started Guide]' + + '({config.docs.beats.metricbeat}/metricbeat-getting-started.html).', + commands: [ + 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz', + 'tar xzvf metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz', + 'cd metricbeat-{config.kibana.version}-darwin-x86_64/', + ], + textPost: 'Modify the settings under `output.elasticsearch` in the ' + + '`metricbeat.yml` file to point to your Elasticsearch installation.' + }, + DEB: { + title: 'Download and install Metricbeat', + textPre: 'Skip this step if Metricbeat is already installed.' + + ' First time using Metricbeat? See the [Getting Started Guide]' + + '({config.docs.beats.metricbeat}/metricbeat-getting-started.html).', + commands: [ + 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-amd64.deb', + 'sudo dpkg -i metricbeat-{config.kibana.version}-amd64.deb' + ], + textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + + 'adjust the `output.elasticsearch` settings if needed.' + }, + RPM: { + title: 'Download and install Metricbeat', + textPre: 'Skip this step if Metricbeat is already installed.' + + ' First time using Metricbeat? See the [Getting Started Guide]' + + '({config.docs.beats.metricbeat}/metricbeat-getting-started.html).', + commands: [ + 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-x86_64.rpm', + 'sudo rpm -vi metricbeat-{config.kibana.version}-x86_64.rpm' + ], + textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + + 'adjust the `output.elasticsearch` settings if needed.' + }, + WINDOWS: { + title: 'Download and install Metricbeat', + textPre: 'Skip this step if Metricbeat is already installed.' + + ' First time using Metricbeat? See the [Getting Started Guide]' + + '({config.docs.beats.metricbeat}/metricbeat-getting-started.html).\n' + + '1. Download the Metricbeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats/metricbeat) page.\n' + + '2. Extract the contents of the zip file into `C:\\Program Files`.\n' + + '3. Rename the `metricbeat-{config.kibana.version}-windows` directory to `Metricbeat`.\n' + + '4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' + + ' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' + + '5. From the PowerShell prompt, run the following commands to install Metricbeat as a Windows service.', + commands: [ + 'PS > cd C:\\Program Files\\Metricbeat', + 'PS C:\\Program Files\\Metricbeat> .\\install-service-metricbeat.ps1' + ], + textPost: 'Edit the `C:\\Program Files\\Metricbeat\\metricbeat.yml` file and ' + + 'adjust the `output.elasticsearch` settings if needed.' + } + }, + START: { + OSX: { + title: 'Start Metricbeat', + commands: [ + './metricbeat setup -e', + './metricbeat -e --setup', + ], + textPost: 'The `setup` command loads the Kibana dashboards.' + + ' If the dashboards are already set up, omit this command.' + }, + DEB: { + title: 'Start Metricbeat', + commands: [ + 'sudo metricbeat setup -e', + 'sudo service metricbeat start', + ], + textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + + 'omit this command.' + }, + RPM: { + title: 'Start Metricbeat', + commands: [ + 'sudo metricbeat setup -e', + 'sudo service metricbeat start', + ], + textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + + 'omit this command.' + }, + WINDOWS: { + title: 'Start Metricbeat', + commands: [ + 'PS C:\\Program Files\\Metricbeat> metricbeat.exe setup -e', + 'PS C:\\Program Files\\Metricbeat> Service-Start metricbeat', + ], + textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + + 'omit this command.' + } + } +}; diff --git a/src/core_plugins/kibana/common/tutorials/tutorial_beats_instructions.js b/src/core_plugins/kibana/common/tutorials/tutorial_beats_instructions.js deleted file mode 100644 index 32971df986b465..00000000000000 --- a/src/core_plugins/kibana/common/tutorials/tutorial_beats_instructions.js +++ /dev/null @@ -1,103 +0,0 @@ -export const FILEBEAT_INSTRUCTIONS = { - INSTALL: { - OSX: { - title: 'Download and install Filebeat', - textPre: 'Download and install Filebeat by running the commands below.' + - ' Skip this step if you already have Filebeat installed.' + - ' If you are installing Filebeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{config.kibana.version}-darwin-x86_64.tar.gz', - 'tar xzvf filebeat-{config.kibana.version}-darwin-x86_64.tar.gz' - ], - textPost: 'Edit the `filebeat-{config.kibana.version}-darwin-x86_64/filebeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - DEB: { - title: 'Download and install Filebeat', - textPre: 'Download and install Filebeat by running the commands below.' + - ' Skip this step if you already have Filebeat installed.' + - ' If you are installing Filebeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{config.kibana.version}-amd64.deb', - 'sudo dpkg -i filebeat-{config.kibana.version}-amd64.deb' - ], - textPost: 'Edit the `/etc/filebeat/filebeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - RPM: { - title: 'Download and install Filebeat', - textPre: 'Download and install Filebeat by running the commands below.' + - ' Skip this step if you already have Filebeat installed.' + - ' If you are installing Filebeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{config.kibana.version}-x86_64.rpm', - 'sudo rpm -vi filebeat-{config.kibana.version}-x86_64.rpm' - ], - textPost: 'Edit the `/etc/filebeat/filebeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - WINDOWS: { - title: 'Download and install Filebeat', - textPre: 'Skip this step if you already have Filebeat installed.' + - ' If you are installing Filebeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation\n' + - '1. Download the Filebeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats) page.\n' + - '2. Extract the contents of the zip file into `C:\\Program Files`.\n' + - '3. Rename the filebeat-{config.kibana.version}-windows directory to Filebeat.\n' + - '4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' + - ' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' + - '5. From the PowerShell prompt, run the following commands to install Filebeat as a Windows service.', - commands: [ - 'PS > cd C:\\Program Files\\Filebeat', - 'PS C:\\Program Files\\Filebeat> .\\install-service-filebeat.ps1' - ], - textPost: 'Edit the `C:\\Program Files\\Filebeat\\filebeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - } - }, - START: { - OSX: { - title: 'Start Filebeat', - textPre: 'Setup the Kibana dashboards and start Filebeat with the following commands.' + - ' Skip this step if you already have Filebeat installed.', - commands: [ - './filebeat -e --setup', - ], - textPost: 'The `--setup` flag loads the Kibana dashboards. If the dashboards are already setup, ' + - 'you don\'t need to use this flag.' - }, - DEB: { - title: 'Start Filebeat', - textPre: 'Setup the Kibana dashboards and start Filebeat with the following commands.', - commands: [ - 'sudo filebeat setup -e', - 'sudo service filebeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - }, - RPM: { - title: 'Start Filebeat', - textPre: 'Setup the Kibana dashboards and start Filebeat with the following commands.', - commands: [ - 'sudo filebeat setup -e', - 'sudo service filebeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - }, - WINDOWS: { - title: 'Start Filebeat', - textPre: 'Setup the Kibana dashboards and start Filebeat as a service with the following commands.', - commands: [ - 'PS C:\\Program Files\\Filebeat> filebeat.exe setup -e', - 'PS C:\\Program Files\\Filebeat> Service-Start filebeat', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } - } -}; diff --git a/src/core_plugins/kibana/server/tutorials/apacheLogs/index.js b/src/core_plugins/kibana/server/tutorials/apacheLogs/index.js index 9813081074cbc4..7436a24c349dde 100644 --- a/src/core_plugins/kibana/server/tutorials/apacheLogs/index.js +++ b/src/core_plugins/kibana/server/tutorials/apacheLogs/index.js @@ -1,15 +1,16 @@ import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; -import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/tutorial_beats_instructions'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; export function apacheLogsSpecProvider() { return { id: 'apacheLogs', name: 'Apache logs', category: TUTORIAL_CATEGORY.LOGGING, - shortDescription: 'This module parses access and error logs created by the Apache HTTP server.', - longDescription: 'This module parses access and error logs created by the Apache 2 HTTP server.' + - ' You can read more about the Filebeat Apache module in the [documentation].', + shortDescription: 'Collect and parse access and error logs created by the Apache HTTP server.', + longDescription: 'The apache2 Filebeat module parses access and error logs created by the Apache 2 HTTP server.' + + ' [Learn more]({config.docs.beats.filebeat}/filebeat-module-apache2.html)' + + ' about the apache2 module.', //iconPath: '', TODO completionTimeMinutes: 10, previewImagePath: '/plugins/kibana/home/tutorial_resources/apacheLogs/kibana-apache2.png', @@ -22,12 +23,12 @@ export function apacheLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.OSX, { - title: 'Enable and configure the Apache module', - textPre: 'In the Filebeat install directory, run the following commands to enable the Apache module.', + title: 'Enable and configure the apache2 module', + textPre: 'From the installation directory, run:', commands: [ './filebeat modules enable apache2', ], - textPost: 'Optional: Modify the module settings in the `modules.d/apache2.yml` file.' + textPost: 'Modify the settings in the `modules.d/apache2.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.OSX ] @@ -37,12 +38,11 @@ export function apacheLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.DEB, { - title: 'Enable and configure the Apache module', - textPre: 'Run the following commands to enable the Apache module.', + title: 'Enable and configure the apache2 module', commands: [ 'sudo filebeat modules enable apache2', ], - textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/apache2.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/apache2.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.DEB ] @@ -52,12 +52,11 @@ export function apacheLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.RPM, { - title: 'Enable and configure the Apache module', - textPre: 'Run the following commands to enable the Apache module.', + title: 'Enable and configure the apache2 module', commands: [ 'sudo filebeat modules enable apache2', ], - textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/apache2.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/apache2.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.RPM ] @@ -67,12 +66,12 @@ export function apacheLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, { - title: 'Enable and configure the Apache module', - textPre: 'In the `C:\\Program Files\\Filebeat` folder, run the following commands to enable the Apache module.', + title: 'Enable and configure the apache2 module', + textPre: 'From the `C:\\Program Files\\Filebeat` folder, run:', commands: [ 'PS C:\\Program Files\\Filebeat> filebeat.exe modules enable apache2', ], - textPost: 'Optional: Modify the module settings in the `modules.d/apache2.yml` file.' + textPost: 'Modify the settings in the `modules.d/apache2.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.WINDOWS ] diff --git a/src/core_plugins/kibana/server/tutorials/apacheMetrics/index.js b/src/core_plugins/kibana/server/tutorials/apacheMetrics/index.js index 292f223db2e1a8..2734e5094a50d9 100644 --- a/src/core_plugins/kibana/server/tutorials/apacheMetrics/index.js +++ b/src/core_plugins/kibana/server/tutorials/apacheMetrics/index.js @@ -1,14 +1,16 @@ import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; export function apacheMetricsSpecProvider() { return { id: 'apacheMetrics', name: 'Apache metrics', category: TUTORIAL_CATEGORY.METRICS, - shortDescription: 'This module fetches internal metrics from the Apache HTTP server.', - longDescription: 'This module fetches internal metrics from the Apache 2 HTTP server.' + - ' You can read more about the Metricbeat Apache module in the [documentation].', + shortDescription: 'Fetches internal metrics from the Apache 2 HTTP server.', + longDescription: 'The apache Metricbeat module fetches internal metrics from the Apache 2 HTTP server.' + + ' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-apache.html)' + + ' about the apache module.', //iconPath: '', TODO completionTimeMinutes: 10, //previewImagePath: 'kibana-apache.png', TODO @@ -19,26 +21,14 @@ export function apacheMetricsSpecProvider() { { id: INSTRUCTION_VARIANT.OSX, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz', - 'tar xzvf metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz' - ], - textPost: 'Edit the `metricbeat-{config.kibana.version}-darwin-x86_64/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the Apache module', - textPre: 'In the Metricbeat install directory, run the following commands to enable the Apache module.', + title: 'Enable and configure the apache module', + textPre: 'From the installation directory, run:', commands: [ './metricbeat modules enable apache', ], - textPost: 'Optional: Modify the module settings in the `modules.d/apache.yml` file.' + textPost: 'Modify the settings in the `modules.d/apache.yml` file.' }, { title: 'Optional: Test the module', @@ -47,41 +37,19 @@ export function apacheMetricsSpecProvider() { './metricbeat test modules apache' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.' + - ' Skip this step if you already have Metricbeat installed.', - commands: [ - './metricbeat -e --setup', - ], - textPost: 'The `--setup` flag loads the Kibana dashboards. If the dashboards are already setup, ' + - 'you don\'t need to use this flag.' - } + METRICBEAT_INSTRUCTIONS.START.OSX ] }, { id: INSTRUCTION_VARIANT.DEB, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-amd64.deb', - 'sudo dpkg -i metricbeat-{config.kibana.version}-amd64.deb' - ], - textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the Apache module', - textPre: 'Run the following commands to enable the Apache module.', + title: 'Enable and configure the apache module', commands: [ 'sudo metricbeat modules enable apache', ], - textPost: 'Optional: Modify the module settings in the `/etc/metricbeat/modules.d/apache.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/apache.yml` file.' }, { title: 'Optional: Test the module', @@ -90,41 +58,19 @@ export function apacheMetricsSpecProvider() { 'sudo metricbeat test modules apache' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.', - commands: [ - 'sudo metricbeat setup -e', - 'sudo service metricbeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.DEB ] }, { id: INSTRUCTION_VARIANT.RPM, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-x86_64.rpm', - 'sudo rpm -vi metricbeat-{config.kibana.version}-x86_64.rpm' - ], - textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the Apache module', - textPre: 'Run the following commands to enable the Apache module.', + title: 'Enable and configure the apache module', commands: [ 'sudo metricbeat modules enable apache', ], - textPost: 'Optional: Modify the module settings in the `/etc/metricbeat/modules.d/apache.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/apache.yml` file.' }, { title: 'Optional: Test the module', @@ -133,46 +79,20 @@ export function apacheMetricsSpecProvider() { 'sudo metricbeat test modules apache' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.', - commands: [ - 'sudo metricbeat setup -e', - 'sudo service metricbeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.RPM ] }, { id: INSTRUCTION_VARIANT.WINDOWS, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, { - title: 'Download and install Metricbeat', - textPre: 'Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation\n' + - '1. Download the Metricbeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats) page.\n' + - '2. Extract the contents of the zip file into `C:\\Program Files`.\n' + - '3. Rename the metricbeat-{config.kibana.version}-windows directory to Metricbeat.\n' + - '4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' + - ' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' + - '5. From the PowerShell prompt, run the following commands to install Metricbeat as a Windows service.', - commands: [ - 'PS > cd C:\\Program Files\\Metricbeat', - 'PS C:\\Program Files\\Metricbeat> .\\install-service-metricbeat.ps1' - ], - textPost: 'Edit the `C:\\Program Files\\Metricbeat\\metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the Apache module', - textPre: 'In the `C:\\Program Files\\Metricbeat` folder, run the following commands to enable the Apache module.', + title: 'Enable and configure the apache module', + textPre: 'From the `C:\\Program Files\\Filebeat` folder, run:', commands: [ 'PS C:\\Program Files\\Metricbeat> metricbeat.exe modules enable apache', ], - textPost: 'Optional: Modify the module settings in the `modules.d/apache.yml` file.' + textPost: 'Modify the settings in the `modules.d/apache.yml` file.' }, { title: 'Optional: Test the module', @@ -181,16 +101,7 @@ export function apacheMetricsSpecProvider() { 'PS C:\\Program Files\\Metricbeat> metricbeat.exe test modules apache' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat as a service with the following commands.', - commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe setup -e', - 'PS C:\\Program Files\\Metricbeat> Service-Start metricbeat', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.WINDOWS, ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/mysqlLogs/index.js b/src/core_plugins/kibana/server/tutorials/mysqlLogs/index.js index 512aff600790b9..9c786f79746f38 100644 --- a/src/core_plugins/kibana/server/tutorials/mysqlLogs/index.js +++ b/src/core_plugins/kibana/server/tutorials/mysqlLogs/index.js @@ -1,15 +1,16 @@ import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; -import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/tutorial_beats_instructions'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; export function mysqlLogsSpecProvider() { return { id: 'mysqlLogs', name: 'MySQL logs', category: TUTORIAL_CATEGORY.LOGGING, - shortDescription: 'This module parses slow logs and error logs created by MySQL.', - longDescription: 'This module parses slow logs and error logs created by MySQL.' + - ' You can read more about the Filebeat MySQL module in the [documentation].', + shortDescription: 'Collect and parse error and slow logs created by MySQL.', + longDescription: 'The mysql Filebeat module parses error and slow logs created by MySQL.' + + ' [Learn more]({config.docs.beats.filebeat}/filebeat-module-mysql.html)' + + ' about the mysql module.', //iconPath: '', TODO completionTimeMinutes: 10, //previewImagePath: '', TODO @@ -22,12 +23,12 @@ export function mysqlLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.OSX, { - title: 'Enable and configure the MySQL module', - textPre: 'In the Filebeat install directory, run the following commands to enable the MySQL module.', + title: 'Enable and configure the mysql module', + textPre: 'From the installation directory, run:', commands: [ './filebeat modules enable mysql', ], - textPost: 'Optional: Modify the module settings in the `modules.d/mysql.yml` file.' + textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.OSX ] @@ -37,12 +38,11 @@ export function mysqlLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.DEB, { - title: 'Enable and configure the MySQL module', - textPre: 'Run the following commands to enable the MySQL module.', + title: 'Enable and configure the mysql module', commands: [ 'sudo filebeat modules enable mysql', ], - textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/mysql.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.DEB ] @@ -52,12 +52,11 @@ export function mysqlLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.RPM, { - title: 'Enable and configure the MySQL module', - textPre: 'Run the following commands to enable the MySQL module.', + title: 'Enable and configure the mysql module', commands: [ 'sudo filebeat modules enable mysql', ], - textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/mysql.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.RPM ] @@ -67,12 +66,12 @@ export function mysqlLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, { - title: 'Enable and configure the MySQL module', - textPre: 'In the `C:\\Program Files\\Filebeat` folder, run the following commands to enable the MySQL module.', + title: 'Enable and configure the mysql module', + textPre: 'From the `C:\\Program Files\\Filebeat` folder, run:', commands: [ 'PS C:\\Program Files\\Filebeat> filebeat.exe modules enable mysql', ], - textPost: 'Optional: Modify the module settings in the `modules.d/mysql.yml` file.' + textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.WINDOWS ] diff --git a/src/core_plugins/kibana/server/tutorials/mysqlMetrics/index.js b/src/core_plugins/kibana/server/tutorials/mysqlMetrics/index.js index ad95e0f56547a8..16639f8cfff61c 100644 --- a/src/core_plugins/kibana/server/tutorials/mysqlMetrics/index.js +++ b/src/core_plugins/kibana/server/tutorials/mysqlMetrics/index.js @@ -1,14 +1,16 @@ import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; export function mysqlMetricsSpecProvider() { return { id: 'mysqlMetrics', name: 'MySQL metrics', category: TUTORIAL_CATEGORY.METRICS, - shortDescription: 'This module fetches internal metrics from MySQL.', - longDescription: 'This module fetches internal metrics from MySQL.' + - ' You can read more about the Metricbeat MySQL module in the [documentation].', + shortDescription: 'Fetches internal metrics from MySQL.', + longDescription: 'The mysql Metricbeat module fetches internal metrics from the MySQL server.' + + ' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-mysql.html)' + + ' about the mysql module.', //iconPath: '', TODO completionTimeMinutes: 10, //previewImagePath: 'kibana-mysql.png', TODO @@ -19,26 +21,14 @@ export function mysqlMetricsSpecProvider() { { id: INSTRUCTION_VARIANT.OSX, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz', - 'tar xzvf metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz' - ], - textPost: 'Edit the `metricbeat-{config.kibana.version}-darwin-x86_64/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the MySQL module', - textPre: 'In the Metricbeat install directory, run the following commands to enable the MySQL module.', + title: 'Enable and configure the mysql module', + textPre: 'From the installation directory, run:', commands: [ './metricbeat modules enable mysql', ], - textPost: 'Optional: Modify the module settings in the `modules.d/mysql.yml` file.' + textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' }, { title: 'Optional: Test the module', @@ -47,41 +37,19 @@ export function mysqlMetricsSpecProvider() { './metricbeat test modules mysql' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.' + - ' Skip this step if you already have Metricbeat installed.', - commands: [ - './metricbeat -e --setup', - ], - textPost: 'The `--setup` flag loads the Kibana dashboards. If the dashboards are already setup, ' + - 'you don\'t need to use this flag.' - } + METRICBEAT_INSTRUCTIONS.START.OSX ] }, { id: INSTRUCTION_VARIANT.DEB, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-amd64.deb', - 'sudo dpkg -i metricbeat-{config.kibana.version}-amd64.deb' - ], - textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the MySQL module', - textPre: 'Run the following commands to enable the MySQL module.', + title: 'Enable and configure the mysql module', commands: [ 'sudo metricbeat modules enable mysql', ], - textPost: 'Optional: Modify the module settings in the `/etc/metricbeat/modules.d/mysql.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' }, { title: 'Optional: Test the module', @@ -90,41 +58,19 @@ export function mysqlMetricsSpecProvider() { 'sudo metricbeat test modules mysql' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.', - commands: [ - 'sudo metricbeat setup -e', - 'sudo service metricbeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.DEB ] }, { id: INSTRUCTION_VARIANT.RPM, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-x86_64.rpm', - 'sudo rpm -vi metricbeat-{config.kibana.version}-x86_64.rpm' - ], - textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the MySQL module', - textPre: 'Run the following commands to enable the MySQL module.', + title: 'Enable and configure the mysql module', commands: [ 'sudo metricbeat modules enable mysql', ], - textPost: 'Optional: Modify the module settings in the `/etc/metricbeat/modules.d/mysql.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' }, { title: 'Optional: Test the module', @@ -133,46 +79,20 @@ export function mysqlMetricsSpecProvider() { 'sudo metricbeat test modules mysql' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.', - commands: [ - 'sudo metricbeat setup -e', - 'sudo service metricbeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.RPM ] }, { id: INSTRUCTION_VARIANT.WINDOWS, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, { - title: 'Download and install Metricbeat', - textPre: 'Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation\n' + - '1. Download the Metricbeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats) page.\n' + - '2. Extract the contents of the zip file into `C:\\Program Files`.\n' + - '3. Rename the metricbeat-{config.kibana.version}-windows directory to Metricbeat.\n' + - '4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' + - ' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' + - '5. From the PowerShell prompt, run the following commands to install Metricbeat as a Windows service.', - commands: [ - 'PS > cd C:\\Program Files\\Metricbeat', - 'PS C:\\Program Files\\Metricbeat> .\\install-service-metricbeat.ps1' - ], - textPost: 'Edit the `C:\\Program Files\\Metricbeat\\metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the MySQL module', - textPre: 'In the `C:\\Program Files\\Metricbeat` folder, run the following commands to enable the MySQL module.', + title: 'Enable and configure the mysql module', + textPre: 'From the `C:\\Program Files\\Filebeat` folder, run:', commands: [ 'PS C:\\Program Files\\Metricbeat> metricbeat.exe modules enable mysql', ], - textPost: 'Optional: Modify the module settings in the `modules.d/mysql.yml` file.' + textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' }, { title: 'Optional: Test the module', @@ -181,16 +101,7 @@ export function mysqlMetricsSpecProvider() { 'PS C:\\Program Files\\Metricbeat> metricbeat.exe test modules mysql' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat as a service with the following commands.', - commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe setup -e', - 'PS C:\\Program Files\\Metricbeat> Service-Start metricbeat', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.WINDOWS, ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/nginxLogs/index.js b/src/core_plugins/kibana/server/tutorials/nginxLogs/index.js index e459e6c69441de..a234d6fe217079 100644 --- a/src/core_plugins/kibana/server/tutorials/nginxLogs/index.js +++ b/src/core_plugins/kibana/server/tutorials/nginxLogs/index.js @@ -1,15 +1,16 @@ import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; -import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/tutorial_beats_instructions'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; export function nginxLogsSpecProvider() { return { id: 'nginxLogs', name: 'Nginx logs', category: TUTORIAL_CATEGORY.LOGGING, - shortDescription: 'This module parses access and error logs created by the Nginx HTTP server.', - longDescription: 'This module parses access and error logs created by the Nginx HTTP server.' + - ' You can read more about the Filebeat Nginx module in the [documentation].', + shortDescription: 'Collect and parse access and error logs created by the Nginx HTTP server.', + longDescription: 'The nginx Filebeat module parses access and error logs created by the Nginx HTTP server.' + + ' [Learn more]({config.docs.beats.filebeat}/filebeat-module-nginx.html)' + + ' about the nginx module.', //iconPath: '', TODO completionTimeMinutes: 10, //previewImagePath: '', TODO @@ -22,12 +23,12 @@ export function nginxLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.OSX, { - title: 'Enable and configure the Nginx module', - textPre: 'In the Filebeat install directory, run the following commands to enable the Nginx module.', + title: 'Enable and configure the nginx module', + textPre: 'From the installation directory, run:', commands: [ './filebeat modules enable nginx', ], - textPost: 'Optional: Modify the module settings in the `modules.d/nginx.yml` file.' + textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.OSX ] @@ -37,12 +38,11 @@ export function nginxLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.DEB, { - title: 'Enable and configure the Nginx module', - textPre: 'Run the following commands to enable the Nginx module.', + title: 'Enable and configure the nginx module', commands: [ 'sudo filebeat modules enable nginx', ], - textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/nginx.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.DEB ] @@ -52,12 +52,11 @@ export function nginxLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.RPM, { - title: 'Enable and configure the Nginx module', - textPre: 'Run the following commands to enable the Nginx module.', + title: 'Enable and configure the nginx module', commands: [ 'sudo filebeat modules enable nginx', ], - textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/nginx.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.RPM ] @@ -67,12 +66,12 @@ export function nginxLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, { - title: 'Enable and configure the Nginx module', - textPre: 'In the `C:\\Program Files\\Filebeat` folder, run the following commands to enable the Nginx module.', + title: 'Enable and configure the nginx module', + textPre: 'From the `C:\\Program Files\\Filebeat` folder, run:', commands: [ 'PS C:\\Program Files\\Filebeat> filebeat.exe modules enable nginx', ], - textPost: 'Optional: Modify the module settings in the `modules.d/nginx.yml` file.' + textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.WINDOWS ] diff --git a/src/core_plugins/kibana/server/tutorials/nginxMetrics/index.js b/src/core_plugins/kibana/server/tutorials/nginxMetrics/index.js index 22c659d8045631..705f52fe553a0b 100644 --- a/src/core_plugins/kibana/server/tutorials/nginxMetrics/index.js +++ b/src/core_plugins/kibana/server/tutorials/nginxMetrics/index.js @@ -1,16 +1,19 @@ import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; export function nginxMetricsSpecProvider() { return { id: 'nginxMetrics', name: 'Nginx metrics', category: TUTORIAL_CATEGORY.METRICS, - shortDescription: 'This module fetches internal metrics from the Nginx HTTP server.', - longDescription: 'This module fetches internal metrics from the Nginx HTTP server.' + - ' You can read more about the Metricbeat Nginx module in the [documentation].' + + shortDescription: 'Fetches internal metrics from the Nginx HTTP server.', + longDescription: 'The nginx Metricbeat module fetches internal metrics from the Nginx HTTP server.' + ' The module scrapes the server status data from the web page generated by the' + - ' [ngx_http_stub_status] module, which needs to be enabled in you Nginx installation', + ' [ngx_http_stub_status_module](http://nginx.org/en/docs/http/ngx_http_stub_status_module.html)' + + ' module, which needs to be enabled in you Nginx installation.' + + ' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-nginx.html)' + + ' about the nginx module.', //iconPath: '', TODO completionTimeMinutes: 10, //previewImagePath: 'kibana-nginx.png', TODO @@ -21,26 +24,14 @@ export function nginxMetricsSpecProvider() { { id: INSTRUCTION_VARIANT.OSX, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz', - 'tar xzvf metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz' - ], - textPost: 'Edit the `metricbeat-{config.kibana.version}-darwin-x86_64/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the Nginx module', - textPre: 'In the Metricbeat install directory, run the following commands to enable the Nginx module.', + title: 'Enable and configure the nginx module', + textPre: 'From the installation directory, run:', commands: [ './metricbeat modules enable nginx', ], - textPost: 'Optional: Modify the module settings in the `modules.d/nginx.yml` file.' + textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' }, { title: 'Optional: Test the module', @@ -49,41 +40,19 @@ export function nginxMetricsSpecProvider() { './metricbeat test modules nginx' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.' + - ' Skip this step if you already have Metricbeat installed.', - commands: [ - './metricbeat -e --setup', - ], - textPost: 'The `--setup` flag loads the Kibana dashboards. If the dashboards are already setup, ' + - 'you don\'t need to use this flag.' - } + METRICBEAT_INSTRUCTIONS.START.OSX ] }, { id: INSTRUCTION_VARIANT.DEB, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-amd64.deb', - 'sudo dpkg -i metricbeat-{config.kibana.version}-amd64.deb' - ], - textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the Nginx module', - textPre: 'Run the following commands to enable the Nginx module.', + title: 'Enable and configure the nginx module', commands: [ 'sudo metricbeat modules enable nginx', ], - textPost: 'Optional: Modify the module settings in the `/etc/metricbeat/modules.d/nginx.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' }, { title: 'Optional: Test the module', @@ -92,41 +61,19 @@ export function nginxMetricsSpecProvider() { 'sudo metricbeat test modules nginx' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.', - commands: [ - 'sudo metricbeat setup -e', - 'sudo service metricbeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.DEB ] }, { id: INSTRUCTION_VARIANT.RPM, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-x86_64.rpm', - 'sudo rpm -vi metricbeat-{config.kibana.version}-x86_64.rpm' - ], - textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the Nginx module', - textPre: 'Run the following commands to enable the Nginx module.', + title: 'Enable and configure the nginx module', commands: [ 'sudo metricbeat modules enable nginx', ], - textPost: 'Optional: Modify the module settings in the `/etc/metricbeat/modules.d/nginx.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' }, { title: 'Optional: Test the module', @@ -135,46 +82,20 @@ export function nginxMetricsSpecProvider() { 'sudo metricbeat test modules nginx' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.', - commands: [ - 'sudo metricbeat setup -e', - 'sudo service metricbeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.RPM ] }, { id: INSTRUCTION_VARIANT.WINDOWS, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, { - title: 'Download and install Metricbeat', - textPre: 'Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation\n' + - '1. Download the Metricbeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats) page.\n' + - '2. Extract the contents of the zip file into `C:\\Program Files`.\n' + - '3. Rename the metricbeat-{config.kibana.version}-windows directory to Metricbeat.\n' + - '4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' + - ' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' + - '5. From the PowerShell prompt, run the following commands to install Metricbeat as a Windows service.', - commands: [ - 'PS > cd C:\\Program Files\\Metricbeat', - 'PS C:\\Program Files\\Metricbeat> .\\install-service-metricbeat.ps1' - ], - textPost: 'Edit the `C:\\Program Files\\Metricbeat\\metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the Nginx module', - textPre: 'In the `C:\\Program Files\\Metricbeat` folder, run the following commands to enable the Nginx module.', + title: 'Enable and configure the nginx module', + textPre: 'From the `C:\\Program Files\\Filebeat` folder, run:', commands: [ 'PS C:\\Program Files\\Metricbeat> metricbeat.exe modules enable nginx', ], - textPost: 'Optional: Modify the module settings in the `modules.d/nginx.yml` file.' + textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' }, { title: 'Optional: Test the module', @@ -183,16 +104,7 @@ export function nginxMetricsSpecProvider() { 'PS C:\\Program Files\\Metricbeat> metricbeat.exe test modules nginx' ] }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat as a service with the following commands.', - commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe setup -e', - 'PS C:\\Program Files\\Metricbeat> Service-Start metricbeat', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.WINDOWS, ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/systemLogs/index.js b/src/core_plugins/kibana/server/tutorials/systemLogs/index.js index e6951c24be5ddd..5d7f81e3482f61 100644 --- a/src/core_plugins/kibana/server/tutorials/systemLogs/index.js +++ b/src/core_plugins/kibana/server/tutorials/systemLogs/index.js @@ -1,16 +1,17 @@ import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; -import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/tutorial_beats_instructions'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; export function systemLogsSpecProvider() { return { id: 'systemLogs', name: 'System logs', category: TUTORIAL_CATEGORY.LOGGING, - shortDescription: 'This module parses logs written by the local Syslog server.', - longDescription: 'This module collects and parses logs created by the system logging service of common' + + shortDescription: 'Collect and parse logs written by the local Syslog server.', + longDescription: 'The system Filebeat module collects and parses logs created by the system logging service of common' + ' Unix/Linux based distributions. This module is not available on Windows.' + - ' You can read more about the Filebeat System module in the [documentation].', + ' [Learn more]({config.docs.beats.filebeat}/filebeat-module-system.html)' + + ' about the system module.', //iconPath: '', TODO completionTimeMinutes: 10, //previewImagePath: '', TODO @@ -23,12 +24,12 @@ export function systemLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.OSX, { - title: 'Enable and configure the System module', - textPre: 'In the Filebeat install directory, run the following commands to enable the System module.', + title: 'Enable and configure the system module', + textPre: 'From the installation directory, run:', commands: [ './filebeat modules enable system', ], - textPost: 'Optional: Modify the module settings in the `modules.d/system.yml` file.' + textPost: 'Modify the settings in the `modules.d/system.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.OSX ] @@ -38,12 +39,11 @@ export function systemLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.DEB, { - title: 'Enable and configure the System module', - textPre: 'Run the following commands to enable the System module.', + title: 'Enable and configure the system module', commands: [ 'sudo filebeat modules enable system', ], - textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/system.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.DEB ] @@ -53,12 +53,11 @@ export function systemLogsSpecProvider() { instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.RPM, { - title: 'Enable and configure the System module', - textPre: 'Run the following commands to enable the System module.', + title: 'Enable and configure the system module', commands: [ 'sudo filebeat modules enable system', ], - textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/system.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' }, FILEBEAT_INSTRUCTIONS.START.RPM ] diff --git a/src/core_plugins/kibana/server/tutorials/systemMetrics/index.js b/src/core_plugins/kibana/server/tutorials/systemMetrics/index.js index 35176ba653cb9b..eeb29fb43e1e83 100644 --- a/src/core_plugins/kibana/server/tutorials/systemMetrics/index.js +++ b/src/core_plugins/kibana/server/tutorials/systemMetrics/index.js @@ -1,15 +1,17 @@ import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; export function systemMetricsSpecProvider() { return { id: 'systemMetrics', name: 'System metrics', category: TUTORIAL_CATEGORY.METRICS, - shortDescription: 'This module collects CPU, memory, network, and disk statistics from the host.', - longDescription: 'This module CPU, memory, network, and disk statistics from the host.' + + shortDescription: 'Collects CPU, memory, network, and disk statistics from the host.', + longDescription: 'The system Metricbeat module collects CPU, memory, network, and disk statistics from the host.' + ' It collects system wide statistics as well as per process and per filesystem statistics.' + - ' You can read more about the Metricbeat System module in the [documentation].', + ' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-system.html)' + + ' about the system module.', //iconPath: '', TODO completionTimeMinutes: 10, //previewImagePath: 'kibana-system.png', TODO @@ -20,154 +22,65 @@ export function systemMetricsSpecProvider() { { id: INSTRUCTION_VARIANT.OSX, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz', - 'tar xzvf metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz' - ], - textPost: 'Edit the `metricbeat-{config.kibana.version}-darwin-x86_64/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the System module', - textPre: 'In the Metricbeat install directory, run the following commands to enable the System module.' + - ' Note that the System module is enabled by default.', + title: 'Enable and configure the system module', + textPre: 'From the installation directory, run:', commands: [ './metricbeat modules enable system', ], - textPost: 'Optional: Modify the module settings in the `modules.d/system.yml` file.' + textPost: 'Modify the settings in the `modules.d/system.yml` file.' }, { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.' + - ' Skip this step if you already have Metricbeat installed.', + title: 'Optional: Test the module', + textPre: 'You can do a dry-run fetch by running the following command.', commands: [ - './metricbeat -e --setup', - ], - textPost: 'The `--setup` flag loads the Kibana dashboards. If the dashboards are already setup, ' + - 'you don\'t need to use this flag.' - } + './metricbeat test modules system' + ] + }, + METRICBEAT_INSTRUCTIONS.START.OSX ] }, { id: INSTRUCTION_VARIANT.DEB, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-amd64.deb', - 'sudo dpkg -i metricbeat-{config.kibana.version}-amd64.deb' - ], - textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the System module', - textPre: 'Run the following commands to enable the System module.' + - ' Note that the System module is enabled by default.', + title: 'Enable and configure the system module', commands: [ 'sudo metricbeat modules enable system', ], - textPost: 'Optional: Modify the module settings in the `/etc/metricbeat/modules.d/system.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' }, { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.', + title: 'Optional: Test the module', + textPre: 'You can do a dry-run fetch by running the following command.', commands: [ - 'sudo metricbeat setup -e', - 'sudo service metricbeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + 'sudo metricbeat test modules system' + ] + }, + METRICBEAT_INSTRUCTIONS.START.DEB ] }, { id: INSTRUCTION_VARIANT.RPM, instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, { - title: 'Download and install Metricbeat', - textPre: 'Download and install Metricbeat by running the commands below.' + - ' Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation.', - commands: [ - 'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-x86_64.rpm', - 'sudo rpm -vi metricbeat-{config.kibana.version}-x86_64.rpm' - ], - textPost: 'Edit the `/etc/metricbeat/metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' - }, - { - title: 'Enable and configure the System module', - textPre: 'Run the following commands to enable the System module.' + - ' Note that the System module is enabled by default.', + title: 'Enable and configure the system module', commands: [ 'sudo metricbeat modules enable system', ], - textPost: 'Optional: Modify the module settings in the `/etc/metricbeat/modules.d/system.yml` file.' + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' }, { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat with the following commands.', + title: 'Optional: Test the module', + textPre: 'You can do a dry-run fetch by running the following command.', commands: [ - 'sudo metricbeat setup -e', - 'sudo service metricbeat start', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } - ] - }, - { - id: INSTRUCTION_VARIANT.WINDOWS, - instructions: [ - { - title: 'Download and install Metricbeat', - textPre: 'Skip this step if you already have Metricbeat installed.' + - ' If you are installing Metricbeat for the first time, we recommend reading the [Getting Started]' + - ' guide in the online documentation\n' + - '1. Download the Metricbeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats) page.\n' + - '2. Extract the contents of the zip file into `C:\\Program Files`.\n' + - '3. Rename the metricbeat-{config.kibana.version}-windows directory to Metricbeat.\n' + - '4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' + - ' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' + - '5. From the PowerShell prompt, run the following commands to install Metricbeat as a Windows service.', - commands: [ - 'PS > cd C:\\Program Files\\Metricbeat', - 'PS C:\\Program Files\\Metricbeat> .\\install-service-metricbeat.ps1' - ], - textPost: 'Edit the `C:\\Program Files\\Metricbeat\\metricbeat.yml` file and ' + - 'adjust the `output.elasticsearch` settings if needed.' + 'sudo metricbeat test modules system' + ] }, - { - title: 'Enable and configure the System module', - textPre: 'In the `C:\\Program Files\\Metricbeat` folder, run the following commands to enable the System module.' + - ' Note that the System module is enabled by default.', - commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe modules enable system', - ], - textPost: 'Optional: Modify the module settings in the `modules.d/system.yml` file.' - }, - { - title: 'Start Metricbeat', - textPre: 'Setup the Kibana dashboards and start Metricbeat as a service with the following commands.', - commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe setup -e', - 'PS C:\\Program Files\\Metricbeat> Service-Start metricbeat', - ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'you don\'t need to run it again.' - } + METRICBEAT_INSTRUCTIONS.START.RPM ] } ]