diff --git a/src/core_plugins/kibana/common/tutorials/metricbeat_cloud_instructions.js b/src/core_plugins/kibana/common/tutorials/metricbeat_cloud_instructions.js new file mode 100644 index 0000000000000..a450045cd6436 --- /dev/null +++ b/src/core_plugins/kibana/common/tutorials/metricbeat_cloud_instructions.js @@ -0,0 +1,40 @@ +export const METRICBEAT_CLOUD_INSTRUCTIONS = { + CONFIG: { + OSX: { + title: 'Edit the configuration', + textPre: 'Modify `metricbeat.yml` to set the connection information for Elastic Cloud:', + commands: [ + 'cloud.id: "{config.cloud.id}"', + 'cloud.auth: "elastic:"' + ], + textPost: 'Where `` is the password of the `elastic` user.' + }, + DEB: { + title: 'Edit the configuration', + textPre: 'Modify `/etc/metricbeat/metricbeat.yml` to set the connection information for Elastic Cloud:', + commands: [ + 'cloud.id: "{config.cloud.id}"', + 'cloud.auth: "elastic:"' + ], + textPost: 'Where `` is the password of the `elastic` user.' + }, + RPM: { + title: 'Edit the configuration', + textPre: 'Modify `/etc/metricbeat/metricbeat.yml` to set the connection information for Elastic Cloud:', + commands: [ + 'cloud.id: "{config.cloud.id}"', + 'cloud.auth: "elastic:"' + ], + textPost: 'Where `` is the password of the `elastic` user.' + }, + WINDOWS: { + title: 'Edit the configuration', + textPre: 'Modify `C:\\Program Files\\Filebeat\\metricbeat.yml` to set the connection information for Elastic Cloud:', + commands: [ + 'cloud.id: "{config.cloud.id}"', + 'cloud.auth: "elastic:"' + ], + textPost: 'Where `` is the password of the `elastic` user.' + } + } +}; diff --git a/src/core_plugins/kibana/common/tutorials/metricbeat_instructions.js b/src/core_plugins/kibana/common/tutorials/metricbeat_instructions.js index cd866a237a4ab..5bc7761c429d9 100644 --- a/src/core_plugins/kibana/common/tutorials/metricbeat_instructions.js +++ b/src/core_plugins/kibana/common/tutorials/metricbeat_instructions.js @@ -2,45 +2,37 @@ 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]' + + textPre: '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]' + + textPre: '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.' + textPost: 'Looking for the 32 bits packages? See the [Download page](https://www.elastic.co/downloads/beats/metricbeat).' }, RPM: { title: 'Download and install Metricbeat', - textPre: 'Skip this step if Metricbeat is already installed.' + - ' First time using Metricbeat? See the [Getting Started Guide]' + + textPre: '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.' + textPost: 'Looking for the 32 bits packages? See the [Download page](https://www.elastic.co/downloads/beats/metricbeat).' }, WINDOWS: { title: 'Download and install Metricbeat', - textPre: 'Skip this step if Metricbeat is already installed.' + - ' First time using Metricbeat? See the [Getting Started Guide]' + + textPre: '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' + @@ -52,46 +44,104 @@ export const METRICBEAT_INSTRUCTIONS = { '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.' + textPost: 'Modify the settings under `output.elasticsearch` in the ' + + '`C:\\Program Files\\Metricbeat\\metricbeat.yml` file to point to your Elasticsearch installation.' } }, START: { OSX: { title: 'Start Metricbeat', + textPre: 'The `setup` command loads the Kibana dashboards.' + + ' If the dashboards are already set up, omit this command.', commands: [ - './metricbeat setup -e', + './metricbeat setup', './metricbeat -e', - ], - textPost: 'The `setup` command loads the Kibana dashboards.' + - ' If the dashboards are already set up, omit this command.' + ] }, DEB: { title: 'Start Metricbeat', + textPre: 'The `setup` command loads the Kibana dashboards. If the dashboards are already set up, ' + + 'omit this command.', commands: [ - 'sudo metricbeat setup -e', + 'sudo metricbeat setup', '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', + textPre: 'The `setup` command loads the Kibana dashboards. If the dashboards are already set up, ' + + 'omit this command.', commands: [ - 'sudo metricbeat setup -e', + 'sudo metricbeat setup', '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', + textPre: 'The `setup` command loads the Kibana dashboards. If the dashboards are already set up, ' + + 'omit this command.', commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe setup -e', + 'PS C:\\Program Files\\Metricbeat> metricbeat.exe setup', 'PS C:\\Program Files\\Metricbeat> Service-Start metricbeat', + ] + } + }, + CONFIG: { + OSX: { + title: 'Edit the configuration', + textPre: 'Modify `metricbeat.yml` to set the connection information:', + commands: [ + 'output.elasticsearch:', + ' hosts: [""]', + ' username: "elastic"', + ' password: ""', + 'setup.kibana:', + ' host: ""' + ], + textPost: 'Where `` is the password of the `elastic` user, ' + + '`` is the URL of Elasticsearch, and `` is the URL of Kibana.' + }, + DEB: { + title: 'Edit the configuration', + textPre: 'Modify `/etc/metricbeat/metricbeat.yml` to set the connection information:', + commands: [ + 'output.elasticsearch:', + ' hosts: [""]', + ' username: "elastic"', + ' password: ""', + 'setup.kibana:', + ' host: ""' + ], + textPost: 'Where `` is the password of the `elastic` user, ' + + '`` is the URL of Elasticsearch, and `` is the URL of Kibana.' + }, + RPM: { + title: 'Edit the configuration', + textPre: 'Modify `/etc/metricbeat/metricbeat.yml` to set the connection information:', + commands: [ + 'output.elasticsearch:', + ' hosts: [""]', + ' username: "elastic"', + ' password: ""', + 'setup.kibana:', + ' host: ""' + ], + textPost: 'Where `` is the password of the `elastic` user, ' + + '`` is the URL of Elasticsearch, and `` is the URL of Kibana.' + }, + WINDOWS: { + title: 'Edit the configuration', + textPre: 'Modify `C:\\Program Files\\Metricbeat\\metricbeat.yml` to set the connection information:', + commands: [ + 'output.elasticsearch:', + ' hosts: [""]', + ' username: "elastic"', + ' password: ""', + 'setup.kibana:', + ' host: ""' ], - textPost: 'The `setup` command loads the Kibana dashboards. If the dashboards are already installed, ' + - 'omit this command.' + textPost: 'Where `` is the password of the `elastic` user, ' + + '`` is the URL of Elasticsearch, and `` is the URL of Kibana.' } } }; diff --git a/src/core_plugins/kibana/common/tutorials/onprem_cloud_instructions.js b/src/core_plugins/kibana/common/tutorials/onprem_cloud_instructions.js index f429e484de026..19720fb3d0e9b 100644 --- a/src/core_plugins/kibana/common/tutorials/onprem_cloud_instructions.js +++ b/src/core_plugins/kibana/common/tutorials/onprem_cloud_instructions.js @@ -2,15 +2,15 @@ export const TRYCLOUD_OPTION1 = { title: 'Option 1: Try module in Elastic Cloud', textPre: 'Go to [Elastic Cloud](https://cloud.elastic.co/). Register if you ' + 'don\'t have an account.\n' + - ' * Select **Create Cluster**, leave size slider at 4 GB RAM, and click **Create**\n' + + ' * Select **Create Cluster**, leave size slider at 4 GB RAM, and click **Create**.\n' + ' * Wait for the cluster plan to complete.\n' + ' * Go to the new Cloud Kibana instance and follow the Kibana Home instructions.' }; export const TRYCLOUD_OPTION2 = { - title: 'Option 2: Local Kibana connected to a Cloud instance', + title: 'Option 2: Connect local Kibana to a Cloud instance', textPre: 'If you are running this Kibana instance against a hosted Elasticsearch instance,' + - ' proceed with manual setup.\n' + - ' * In **Overview >> Endpoints** note **Elasticsearch** as ``' + ' proceed with manual setup.\n\n' + + 'In **Overview >> Endpoints** note **Elasticsearch** as ``.' }; diff --git a/src/core_plugins/kibana/public/home/tutorial_resources/apache_metrics/screenshot.png b/src/core_plugins/kibana/public/home/tutorial_resources/apache_metrics/screenshot.png new file mode 100644 index 0000000000000..ac40d5a637a5f Binary files /dev/null and b/src/core_plugins/kibana/public/home/tutorial_resources/apache_metrics/screenshot.png differ diff --git a/src/core_plugins/kibana/public/home/tutorial_resources/mysql_logs/screenshot.png b/src/core_plugins/kibana/public/home/tutorial_resources/mysql_logs/screenshot.png new file mode 100644 index 0000000000000..d380042ca72e8 Binary files /dev/null and b/src/core_plugins/kibana/public/home/tutorial_resources/mysql_logs/screenshot.png differ diff --git a/src/core_plugins/kibana/public/home/tutorial_resources/mysql_metrics/screenshot.png b/src/core_plugins/kibana/public/home/tutorial_resources/mysql_metrics/screenshot.png new file mode 100644 index 0000000000000..e3091f5156c5a Binary files /dev/null and b/src/core_plugins/kibana/public/home/tutorial_resources/mysql_metrics/screenshot.png differ diff --git a/src/core_plugins/kibana/public/home/tutorial_resources/nginx_logs/screenshot.png b/src/core_plugins/kibana/public/home/tutorial_resources/nginx_logs/screenshot.png new file mode 100644 index 0000000000000..10522377112cb Binary files /dev/null and b/src/core_plugins/kibana/public/home/tutorial_resources/nginx_logs/screenshot.png differ diff --git a/src/core_plugins/kibana/public/home/tutorial_resources/nginx_metrics/screenshot.png b/src/core_plugins/kibana/public/home/tutorial_resources/nginx_metrics/screenshot.png new file mode 100644 index 0000000000000..003ea39191cdf Binary files /dev/null and b/src/core_plugins/kibana/public/home/tutorial_resources/nginx_metrics/screenshot.png differ diff --git a/src/core_plugins/kibana/public/home/tutorial_resources/system_logs/screenshot.png b/src/core_plugins/kibana/public/home/tutorial_resources/system_logs/screenshot.png new file mode 100644 index 0000000000000..dfb1d832e3a86 Binary files /dev/null and b/src/core_plugins/kibana/public/home/tutorial_resources/system_logs/screenshot.png differ diff --git a/src/core_plugins/kibana/public/home/tutorial_resources/system_metrics/screenshot.png b/src/core_plugins/kibana/public/home/tutorial_resources/system_metrics/screenshot.png new file mode 100644 index 0000000000000..2ee3d14f164b6 Binary files /dev/null and b/src/core_plugins/kibana/public/home/tutorial_resources/system_metrics/screenshot.png differ diff --git a/src/core_plugins/kibana/server/tutorials/apache_logs/index.js b/src/core_plugins/kibana/server/tutorials/apache_logs/index.js index b2eacd5993a9f..405ef51fce56f 100644 --- a/src/core_plugins/kibana/server/tutorials/apache_logs/index.js +++ b/src/core_plugins/kibana/server/tutorials/apache_logs/index.js @@ -29,6 +29,6 @@ export function apacheLogsSpecProvider() { previewImagePath: '/plugins/kibana/home/tutorial_resources/apache_logs/screenshot.png', onPrem: ON_PREM_INSTRUCTIONS, elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS, - onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS, + onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS }; } diff --git a/src/core_plugins/kibana/server/tutorials/apache_logs/on_prem_elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/apache_logs/on_prem_elastic_cloud.js index c664bfddb3693..2266d33eccd1f 100644 --- a/src/core_plugins/kibana/server/tutorials/apache_logs/on_prem_elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/apache_logs/on_prem_elastic_cloud.js @@ -4,6 +4,7 @@ import { TRYCLOUD_OPTION1, TRYCLOUD_OPTION2 } from '../../../common/tutorials/onprem_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -17,14 +18,7 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { TRYCLOUD_OPTION2, FILEBEAT_INSTRUCTIONS.INSTALL.OSX, FILEBEAT_INSTRUCTIONS.CONFIG.OSX, - { - title: 'Enable and configure the apache2 module', - textPre: 'From the installation directory, run:', - commands: [ - './filebeat modules enable apache2', - ], - textPost: 'Modify the settings in the `modules.d/apache2.yml` file.' - }, + ENABLE_INSTRUCTIONS.OSX, FILEBEAT_INSTRUCTIONS.START.OSX ] }, @@ -35,13 +29,7 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { TRYCLOUD_OPTION2, FILEBEAT_INSTRUCTIONS.INSTALL.DEB, FILEBEAT_INSTRUCTIONS.CONFIG.DEB, - { - title: 'Enable and configure the apache2 module', - commands: [ - 'sudo filebeat modules enable apache2', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/apache2.yml` file.' - }, + ENABLE_INSTRUCTIONS.DEB, FILEBEAT_INSTRUCTIONS.START.DEB ] }, @@ -52,13 +40,7 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { TRYCLOUD_OPTION2, FILEBEAT_INSTRUCTIONS.INSTALL.RPM, FILEBEAT_INSTRUCTIONS.CONFIG.RPM, - { - title: 'Enable and configure the apache2 module', - commands: [ - 'sudo filebeat modules enable apache2', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/apache2.yml` file.' - }, + ENABLE_INSTRUCTIONS.RPM, FILEBEAT_INSTRUCTIONS.START.RPM ] }, @@ -69,14 +51,7 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { TRYCLOUD_OPTION2, FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, FILEBEAT_INSTRUCTIONS.CONFIG.WINDOWS, - { - 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: 'Modify the settings in the `modules.d/apache2.yml` file.' - }, + ENABLE_INSTRUCTIONS.WINDOWS, FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } diff --git a/src/core_plugins/kibana/server/tutorials/apache_metrics/elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/apache_metrics/elastic_cloud.js index 058a16196e394..408ae869571e7 100644 --- a/src/core_plugins/kibana/server/tutorials/apache_metrics/elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/apache_metrics/elastic_cloud.js @@ -1,4 +1,7 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { METRICBEAT_CLOUD_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +11,37 @@ export const ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'elastiCloud instructions - TBD', - } + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + METRICBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + METRICBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + METRICBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/apache_metrics/enable.js b/src/core_plugins/kibana/server/tutorials/apache_metrics/enable.js new file mode 100644 index 0000000000000..9e18661701c7a --- /dev/null +++ b/src/core_plugins/kibana/server/tutorials/apache_metrics/enable.js @@ -0,0 +1,32 @@ +export const ENABLE_INSTRUCTIONS = { + OSX: { + title: 'Enable and configure the apache module', + textPre: 'From the installation directory, run:', + commands: [ + './metricbeat modules enable apache', + ], + textPost: 'Modify the settings in the `modules.d/apache.yml` file.' + }, + DEB: { + title: 'Enable and configure the apache module', + commands: [ + 'sudo metricbeat modules enable apache', + ], + textPost: 'Modify the settings in the `/etc/metricbeat/modules.d/apache.yml` file.' + }, + RPM: { + title: 'Enable and configure the apache module', + commands: [ + 'sudo metricbeat modules enable apache', + ], + textPost: 'Modify the settings in the `/etc/metricbeat/modules.d/apache.yml` file.' + }, + WINDOWS: { + title: 'Enable and configure the apache module', + textPre: 'From the `C:\\Program Files\\Metricbeat` folder, run:', + commands: [ + 'PS C:\\Program Files\\Metricbeat> metricbeat.exe modules enable apache', + ], + textPost: 'Modify the settings in the `modules.d/apache.yml` file.' + } +}; diff --git a/src/core_plugins/kibana/server/tutorials/apache_metrics/index.js b/src/core_plugins/kibana/server/tutorials/apache_metrics/index.js index bd09557bfdabb..9e8b84bd06a76 100644 --- a/src/core_plugins/kibana/server/tutorials/apache_metrics/index.js +++ b/src/core_plugins/kibana/server/tutorials/apache_metrics/index.js @@ -9,12 +9,24 @@ export function apacheMetricsSpecProvider() { name: 'Apache metrics', category: TUTORIAL_CATEGORY.METRICS, shortDescription: 'Fetches internal metrics from the Apache 2 HTTP server.', - longDescription: 'The apache Metricbeat module 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 + artifacts: { + dashboards: [ + { + title: 'Metricbeat-Apache-HTTPD-server-status', + linkLabel: 'Apache metrics dashboard', + isOverview: true + } + ], + exportedFields: { + documentationUrl: '{config.docs.beats.metricbeat}/exported-fields-apache.html' + } + }, completionTimeMinutes: 10, - //previewImagePath: 'kibana-apache.png', TODO + previewImagePath: '/plugins/kibana/home/tutorial_resources/apache_metrics/screenshot.png', onPrem: ON_PREM_INSTRUCTIONS, elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS, onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS diff --git a/src/core_plugins/kibana/server/tutorials/apache_metrics/on_prem.js b/src/core_plugins/kibana/server/tutorials/apache_metrics/on_prem.js index b5d4adfa17d26..8a47014420ebe 100644 --- a/src/core_plugins/kibana/server/tutorials/apache_metrics/on_prem.js +++ b/src/core_plugins/kibana/server/tutorials/apache_metrics/on_prem.js @@ -1,5 +1,6 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_INSTRUCTIONS = { instructionSets: [ @@ -10,21 +11,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.OSX, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.OSX, - { - title: 'Enable and configure the apache module', - textPre: 'From the installation directory, run:', - commands: [ - './metricbeat modules enable apache', - ], - textPost: 'Modify the settings in the `modules.d/apache.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - './metricbeat test modules apache' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, METRICBEAT_INSTRUCTIONS.START.OSX ] }, @@ -32,20 +20,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.DEB, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.DEB, - { - title: 'Enable and configure the apache module', - commands: [ - 'sudo metricbeat modules enable apache', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/apache.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'sudo metricbeat test modules apache' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, METRICBEAT_INSTRUCTIONS.START.DEB ] }, @@ -53,20 +29,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.RPM, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.RPM, - { - title: 'Enable and configure the apache module', - commands: [ - 'sudo metricbeat modules enable apache', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/apache.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'sudo metricbeat test modules apache' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, METRICBEAT_INSTRUCTIONS.START.RPM ] }, @@ -74,22 +38,9 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.WINDOWS, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, - { - 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: 'Modify the settings in the `modules.d/apache.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe test modules apache' - ] - }, - METRICBEAT_INSTRUCTIONS.START.WINDOWS, + METRICBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/apache_metrics/on_prem_elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/apache_metrics/on_prem_elastic_cloud.js index e01007c368606..fe1cdbcde9391 100644 --- a/src/core_plugins/kibana/server/tutorials/apache_metrics/on_prem_elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/apache_metrics/on_prem_elastic_cloud.js @@ -1,4 +1,10 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2 +} from '../../../common/tutorials/onprem_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +14,45 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'onPremElasticCloud instructions - TBD', - } + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, + METRICBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + METRICBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, + METRICBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + METRICBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, + METRICBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + METRICBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/mysql_logs/elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/mysql_logs/elastic_cloud.js index 058a16196e394..9a517988c9a9d 100644 --- a/src/core_plugins/kibana/server/tutorials/mysql_logs/elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/mysql_logs/elastic_cloud.js @@ -1,4 +1,7 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { FILEBEAT_CLOUD_INSTRUCTIONS } from '../../../common/tutorials/filebeat_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +11,37 @@ export const ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'elastiCloud instructions - TBD', - } + FILEBEAT_INSTRUCTIONS.INSTALL.OSX, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + FILEBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.DEB, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + FILEBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.RPM, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + FILEBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/mysql_logs/enable.js b/src/core_plugins/kibana/server/tutorials/mysql_logs/enable.js new file mode 100644 index 0000000000000..a303c18717511 --- /dev/null +++ b/src/core_plugins/kibana/server/tutorials/mysql_logs/enable.js @@ -0,0 +1,32 @@ +export const ENABLE_INSTRUCTIONS = { + OSX: { + title: 'Enable and configure the mysql module', + textPre: 'From the installation directory, run:', + commands: [ + './filebeat modules enable mysql', + ], + textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' + }, + DEB: { + title: 'Enable and configure the mysql module', + commands: [ + 'sudo filebeat modules enable mysql', + ], + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' + }, + RPM: { + title: 'Enable and configure the mysql module', + commands: [ + 'sudo filebeat modules enable mysql', + ], + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' + }, + WINDOWS: { + 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: 'Modify the settings in the `modules.d/mysql.yml` file.' + } +}; diff --git a/src/core_plugins/kibana/server/tutorials/mysql_logs/index.js b/src/core_plugins/kibana/server/tutorials/mysql_logs/index.js index cbc6daf6bd6d0..e87ecb9415e25 100644 --- a/src/core_plugins/kibana/server/tutorials/mysql_logs/index.js +++ b/src/core_plugins/kibana/server/tutorials/mysql_logs/index.js @@ -9,12 +9,24 @@ export function mysqlLogsSpecProvider() { name: 'MySQL logs', category: TUTORIAL_CATEGORY.LOGGING, shortDescription: 'Collect and parse error and slow logs created by MySQL.', - longDescription: 'The mysql Filebeat module parses 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.', + ' about the `mysql` module.', //iconPath: '', TODO + artifacts: { + dashboards: [ + { + title: 'Filebeat-MySQL-Dashboard', + linkLabel: 'MySQL logs dashboard', + isOverview: true + } + ], + exportedFields: { + documentationUrl: '{config.docs.beats.filebeat}/exported-fields-mysql.html' + } + }, completionTimeMinutes: 10, - //previewImagePath: '', TODO + previewImagePath: '/plugins/kibana/home/tutorial_resources/mysql_logs/screenshot.png', onPrem: ON_PREM_INSTRUCTIONS, elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS, onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS diff --git a/src/core_plugins/kibana/server/tutorials/mysql_logs/on_prem.js b/src/core_plugins/kibana/server/tutorials/mysql_logs/on_prem.js index fb11f099250dd..e280230d7b78e 100644 --- a/src/core_plugins/kibana/server/tutorials/mysql_logs/on_prem.js +++ b/src/core_plugins/kibana/server/tutorials/mysql_logs/on_prem.js @@ -1,5 +1,6 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_INSTRUCTIONS = { instructionSets: [ @@ -10,14 +11,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.OSX, instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.OSX, - { - title: 'Enable and configure the mysql module', - textPre: 'From the installation directory, run:', - commands: [ - './filebeat modules enable mysql', - ], - textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, FILEBEAT_INSTRUCTIONS.START.OSX ] }, @@ -25,13 +20,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.DEB, instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.DEB, - { - title: 'Enable and configure the mysql module', - commands: [ - 'sudo filebeat modules enable mysql', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, FILEBEAT_INSTRUCTIONS.START.DEB ] }, @@ -39,13 +29,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.RPM, instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.RPM, - { - title: 'Enable and configure the mysql module', - commands: [ - 'sudo filebeat modules enable mysql', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, FILEBEAT_INSTRUCTIONS.START.RPM ] }, @@ -53,14 +38,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.WINDOWS, instructions: [ FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, - { - 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: 'Modify the settings in the `modules.d/mysql.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } diff --git a/src/core_plugins/kibana/server/tutorials/mysql_logs/on_prem_elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/mysql_logs/on_prem_elastic_cloud.js index e01007c368606..2266d33eccd1f 100644 --- a/src/core_plugins/kibana/server/tutorials/mysql_logs/on_prem_elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/mysql_logs/on_prem_elastic_cloud.js @@ -1,4 +1,10 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2 +} from '../../../common/tutorials/onprem_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +14,45 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'onPremElasticCloud instructions - TBD', - } + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.OSX, + FILEBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + FILEBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.DEB, + FILEBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + FILEBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.RPM, + FILEBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + FILEBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + FILEBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/mysql_metrics/elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/mysql_metrics/elastic_cloud.js index 058a16196e394..408ae869571e7 100644 --- a/src/core_plugins/kibana/server/tutorials/mysql_metrics/elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/mysql_metrics/elastic_cloud.js @@ -1,4 +1,7 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { METRICBEAT_CLOUD_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +11,37 @@ export const ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'elastiCloud instructions - TBD', - } + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + METRICBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + METRICBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + METRICBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/mysql_metrics/enable.js b/src/core_plugins/kibana/server/tutorials/mysql_metrics/enable.js new file mode 100644 index 0000000000000..815f68f794910 --- /dev/null +++ b/src/core_plugins/kibana/server/tutorials/mysql_metrics/enable.js @@ -0,0 +1,32 @@ +export const ENABLE_INSTRUCTIONS = { + OSX: { + title: 'Enable and configure the mysql module', + textPre: 'From the installation directory, run:', + commands: [ + './metricbeat modules enable mysql', + ], + textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' + }, + DEB: { + title: 'Enable and configure the mysql module', + commands: [ + 'sudo metricbeat modules enable mysql', + ], + textPost: 'Modify the settings in the `/etc/metricbeat/modules.d/mysql.yml` file.' + }, + RPM: { + title: 'Enable and configure the mysql module', + commands: [ + 'sudo metricbeat modules enable mysql', + ], + textPost: 'Modify the settings in the `/etc/metricbeat/modules.d/mysql.yml` file.' + }, + WINDOWS: { + title: 'Enable and configure the mysql module', + textPre: 'From the `C:\\Program Files\\Metricbeat` folder, run:', + commands: [ + 'PS C:\\Program Files\\Metricbeat> metricbeat.exe modules enable mysql', + ], + textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' + } +}; diff --git a/src/core_plugins/kibana/server/tutorials/mysql_metrics/index.js b/src/core_plugins/kibana/server/tutorials/mysql_metrics/index.js index 6f2dea469910b..a8cacd7f60a77 100644 --- a/src/core_plugins/kibana/server/tutorials/mysql_metrics/index.js +++ b/src/core_plugins/kibana/server/tutorials/mysql_metrics/index.js @@ -9,12 +9,24 @@ export function mysqlMetricsSpecProvider() { name: 'MySQL metrics', category: TUTORIAL_CATEGORY.METRICS, shortDescription: 'Fetches internal metrics from MySQL.', - longDescription: 'The mysql Metricbeat module fetches internal metrics from the MySQL server.' + + 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 + artifacts: { + dashboards: [ + { + title: '66881e90-0006-11e7-bf7f-c9acc3d3e306', + linkLabel: 'MySQL metrics dashboard', + isOverview: true + } + ], + exportedFields: { + documentationUrl: '{config.docs.beats.metricbeat}/exported-fields-mysql.html' + } + }, completionTimeMinutes: 10, - //previewImagePath: 'kibana-mysql.png', TODO + previewImagePath: '/plugins/kibana/home/tutorial_resources/mysql_metrics/screenshot.png', onPrem: ON_PREM_INSTRUCTIONS, elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS, onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS diff --git a/src/core_plugins/kibana/server/tutorials/mysql_metrics/on_prem.js b/src/core_plugins/kibana/server/tutorials/mysql_metrics/on_prem.js index 151aee77683c5..8a47014420ebe 100644 --- a/src/core_plugins/kibana/server/tutorials/mysql_metrics/on_prem.js +++ b/src/core_plugins/kibana/server/tutorials/mysql_metrics/on_prem.js @@ -1,5 +1,6 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_INSTRUCTIONS = { instructionSets: [ @@ -10,21 +11,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.OSX, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.OSX, - { - title: 'Enable and configure the mysql module', - textPre: 'From the installation directory, run:', - commands: [ - './metricbeat modules enable mysql', - ], - textPost: 'Modify the settings in the `modules.d/mysql.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - './metricbeat test modules mysql' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, METRICBEAT_INSTRUCTIONS.START.OSX ] }, @@ -32,20 +20,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.DEB, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.DEB, - { - title: 'Enable and configure the mysql module', - commands: [ - 'sudo metricbeat modules enable mysql', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'sudo metricbeat test modules mysql' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, METRICBEAT_INSTRUCTIONS.START.DEB ] }, @@ -53,20 +29,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.RPM, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.RPM, - { - title: 'Enable and configure the mysql module', - commands: [ - 'sudo metricbeat modules enable mysql', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/mysql.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'sudo metricbeat test modules mysql' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, METRICBEAT_INSTRUCTIONS.START.RPM ] }, @@ -74,22 +38,9 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.WINDOWS, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, - { - 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: 'Modify the settings in the `modules.d/mysql.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe test modules mysql' - ] - }, - METRICBEAT_INSTRUCTIONS.START.WINDOWS, + METRICBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/mysql_metrics/on_prem_elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/mysql_metrics/on_prem_elastic_cloud.js index e01007c368606..fe1cdbcde9391 100644 --- a/src/core_plugins/kibana/server/tutorials/mysql_metrics/on_prem_elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/mysql_metrics/on_prem_elastic_cloud.js @@ -1,4 +1,10 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2 +} from '../../../common/tutorials/onprem_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +14,45 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'onPremElasticCloud instructions - TBD', - } + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, + METRICBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + METRICBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, + METRICBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + METRICBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, + METRICBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + METRICBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/nginx_logs/elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/nginx_logs/elastic_cloud.js index 058a16196e394..9a517988c9a9d 100644 --- a/src/core_plugins/kibana/server/tutorials/nginx_logs/elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/nginx_logs/elastic_cloud.js @@ -1,4 +1,7 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { FILEBEAT_CLOUD_INSTRUCTIONS } from '../../../common/tutorials/filebeat_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +11,37 @@ export const ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'elastiCloud instructions - TBD', - } + FILEBEAT_INSTRUCTIONS.INSTALL.OSX, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + FILEBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.DEB, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + FILEBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.RPM, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + FILEBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/nginx_logs/enable.js b/src/core_plugins/kibana/server/tutorials/nginx_logs/enable.js new file mode 100644 index 0000000000000..70be5bc520555 --- /dev/null +++ b/src/core_plugins/kibana/server/tutorials/nginx_logs/enable.js @@ -0,0 +1,32 @@ +export const ENABLE_INSTRUCTIONS = { + OSX: { + title: 'Enable and configure the nginx module', + textPre: 'From the installation directory, run:', + commands: [ + './filebeat modules enable nginx', + ], + textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' + }, + DEB: { + title: 'Enable and configure the nginx module', + commands: [ + 'sudo filebeat modules enable nginx', + ], + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' + }, + RPM: { + title: 'Enable and configure the nginx module', + commands: [ + 'sudo filebeat modules enable nginx', + ], + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' + }, + WINDOWS: { + 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: 'Modify the settings in the `modules.d/nginx.yml` file.' + } +}; diff --git a/src/core_plugins/kibana/server/tutorials/nginx_logs/index.js b/src/core_plugins/kibana/server/tutorials/nginx_logs/index.js index 4f084402f1e05..f6ab47590c153 100644 --- a/src/core_plugins/kibana/server/tutorials/nginx_logs/index.js +++ b/src/core_plugins/kibana/server/tutorials/nginx_logs/index.js @@ -9,12 +9,24 @@ export function nginxLogsSpecProvider() { name: 'Nginx logs', category: TUTORIAL_CATEGORY.LOGGING, 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.' + + 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 + artifacts: { + dashboards: [ + { + title: '55a9e6e0-a29e-11e7-928f-5dbe6f6f5519', + linkLabel: 'Nginx logs dashboard', + isOverview: true + } + ], + exportedFields: { + documentationUrl: '{config.docs.beats.filebeat}/exported-fields-nginx.html' + } + }, completionTimeMinutes: 10, - //previewImagePath: '', TODO + previewImagePath: '/plugins/kibana/home/tutorial_resources/nginx_logs/screenshot.png', onPrem: ON_PREM_INSTRUCTIONS, elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS, onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS diff --git a/src/core_plugins/kibana/server/tutorials/nginx_logs/on_prem.js b/src/core_plugins/kibana/server/tutorials/nginx_logs/on_prem.js index c63ab0e93cdaf..9ecaa557d2407 100644 --- a/src/core_plugins/kibana/server/tutorials/nginx_logs/on_prem.js +++ b/src/core_plugins/kibana/server/tutorials/nginx_logs/on_prem.js @@ -1,5 +1,6 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_INSTRUCTIONS = { instructionSets: [ @@ -9,58 +10,40 @@ export const ON_PREM_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ + FILEBEAT_INSTRUCTIONS.PLUGINS.GEOIP_AND_UA, FILEBEAT_INSTRUCTIONS.INSTALL.OSX, - { - title: 'Enable and configure the nginx module', - textPre: 'From the installation directory, run:', - commands: [ - './filebeat modules enable nginx', - ], - textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, FILEBEAT_INSTRUCTIONS.START.OSX ] }, { id: INSTRUCTION_VARIANT.DEB, instructions: [ + FILEBEAT_INSTRUCTIONS.PLUGINS.GEOIP_AND_UA, FILEBEAT_INSTRUCTIONS.INSTALL.DEB, - { - title: 'Enable and configure the nginx module', - commands: [ - 'sudo filebeat modules enable nginx', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, FILEBEAT_INSTRUCTIONS.START.DEB ] }, { id: INSTRUCTION_VARIANT.RPM, instructions: [ + FILEBEAT_INSTRUCTIONS.PLUGINS.GEOIP_AND_UA, FILEBEAT_INSTRUCTIONS.INSTALL.RPM, - { - title: 'Enable and configure the nginx module', - commands: [ - 'sudo filebeat modules enable nginx', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, FILEBEAT_INSTRUCTIONS.START.RPM ] }, { id: INSTRUCTION_VARIANT.WINDOWS, instructions: [ + FILEBEAT_INSTRUCTIONS.PLUGINS.GEOIP_AND_UA, FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, - { - 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: 'Modify the settings in the `modules.d/nginx.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } diff --git a/src/core_plugins/kibana/server/tutorials/nginx_logs/on_prem_elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/nginx_logs/on_prem_elastic_cloud.js index e01007c368606..2266d33eccd1f 100644 --- a/src/core_plugins/kibana/server/tutorials/nginx_logs/on_prem_elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/nginx_logs/on_prem_elastic_cloud.js @@ -1,4 +1,10 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2 +} from '../../../common/tutorials/onprem_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +14,45 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'onPremElasticCloud instructions - TBD', - } + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.OSX, + FILEBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + FILEBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.DEB, + FILEBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + FILEBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.RPM, + FILEBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + FILEBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + FILEBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/nginx_metrics/elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/nginx_metrics/elastic_cloud.js index 058a16196e394..408ae869571e7 100644 --- a/src/core_plugins/kibana/server/tutorials/nginx_metrics/elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/nginx_metrics/elastic_cloud.js @@ -1,4 +1,7 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { METRICBEAT_CLOUD_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +11,37 @@ export const ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'elastiCloud instructions - TBD', - } + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + METRICBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + METRICBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + METRICBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/nginx_metrics/enable.js b/src/core_plugins/kibana/server/tutorials/nginx_metrics/enable.js new file mode 100644 index 0000000000000..8f30486c54c90 --- /dev/null +++ b/src/core_plugins/kibana/server/tutorials/nginx_metrics/enable.js @@ -0,0 +1,32 @@ +export const ENABLE_INSTRUCTIONS = { + OSX: { + title: 'Enable and configure the nginx module', + textPre: 'From the installation directory, run:', + commands: [ + './metricbeat modules enable nginx', + ], + textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' + }, + DEB: { + title: 'Enable and configure the nginx module', + commands: [ + 'sudo metricbeat modules enable nginx', + ], + textPost: 'Modify the settings in the `/etc/metricbeat/modules.d/nginx.yml` file.' + }, + RPM: { + title: 'Enable and configure the nginx module', + commands: [ + 'sudo metricbeat modules enable nginx', + ], + textPost: 'Modify the settings in the `/etc/metricbeat/modules.d/nginx.yml` file.' + }, + WINDOWS: { + title: 'Enable and configure the nginx module', + textPre: 'From the `C:\\Program Files\\Metricbeat` folder, run:', + commands: [ + 'PS C:\\Program Files\\Metricbeat> metricbeat.exe modules enable nginx', + ], + textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' + } +}; diff --git a/src/core_plugins/kibana/server/tutorials/nginx_metrics/index.js b/src/core_plugins/kibana/server/tutorials/nginx_metrics/index.js index d04f9fcb088da..860422d892a6b 100644 --- a/src/core_plugins/kibana/server/tutorials/nginx_metrics/index.js +++ b/src/core_plugins/kibana/server/tutorials/nginx_metrics/index.js @@ -9,15 +9,27 @@ export function nginxMetricsSpecProvider() { name: 'Nginx metrics', category: TUTORIAL_CATEGORY.METRICS, shortDescription: 'Fetches internal metrics from the Nginx HTTP server.', - longDescription: 'The nginx Metricbeat module 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](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 + artifacts: { + dashboards: [ + { + title: '023d2930-f1a5-11e7-a9ef-93c69af7b129', + linkLabel: 'Nginx metrics dashboard', + isOverview: true + } + ], + exportedFields: { + documentationUrl: '{config.docs.beats.metricbeat}/exported-fields-nginx.html' + } + }, completionTimeMinutes: 10, - //previewImagePath: 'kibana-nginx.png', TODO + previewImagePath: '/plugins/kibana/home/tutorial_resources/nginx_metrics/screenshot.png', onPrem: ON_PREM_INSTRUCTIONS, elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS, onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS diff --git a/src/core_plugins/kibana/server/tutorials/nginx_metrics/on_prem.js b/src/core_plugins/kibana/server/tutorials/nginx_metrics/on_prem.js index 270d5ed09997d..8a47014420ebe 100644 --- a/src/core_plugins/kibana/server/tutorials/nginx_metrics/on_prem.js +++ b/src/core_plugins/kibana/server/tutorials/nginx_metrics/on_prem.js @@ -1,5 +1,6 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_INSTRUCTIONS = { instructionSets: [ @@ -10,21 +11,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.OSX, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.OSX, - { - title: 'Enable and configure the nginx module', - textPre: 'From the installation directory, run:', - commands: [ - './metricbeat modules enable nginx', - ], - textPost: 'Modify the settings in the `modules.d/nginx.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - './metricbeat test modules nginx' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, METRICBEAT_INSTRUCTIONS.START.OSX ] }, @@ -32,20 +20,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.DEB, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.DEB, - { - title: 'Enable and configure the nginx module', - commands: [ - 'sudo metricbeat modules enable nginx', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'sudo metricbeat test modules nginx' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, METRICBEAT_INSTRUCTIONS.START.DEB ] }, @@ -53,20 +29,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.RPM, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.RPM, - { - title: 'Enable and configure the nginx module', - commands: [ - 'sudo metricbeat modules enable nginx', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/nginx.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'sudo metricbeat test modules nginx' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, METRICBEAT_INSTRUCTIONS.START.RPM ] }, @@ -74,22 +38,9 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.WINDOWS, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, - { - 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: 'Modify the settings in the `modules.d/nginx.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'PS C:\\Program Files\\Metricbeat> metricbeat.exe test modules nginx' - ] - }, - METRICBEAT_INSTRUCTIONS.START.WINDOWS, + METRICBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/nginx_metrics/on_prem_elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/nginx_metrics/on_prem_elastic_cloud.js index e01007c368606..fe1cdbcde9391 100644 --- a/src/core_plugins/kibana/server/tutorials/nginx_metrics/on_prem_elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/nginx_metrics/on_prem_elastic_cloud.js @@ -1,4 +1,10 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2 +} from '../../../common/tutorials/onprem_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +14,45 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'onPremElasticCloud instructions - TBD', - } + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, + METRICBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + METRICBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, + METRICBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + METRICBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, + METRICBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + METRICBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/system_logs/elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/system_logs/elastic_cloud.js index 058a16196e394..9a517988c9a9d 100644 --- a/src/core_plugins/kibana/server/tutorials/system_logs/elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/system_logs/elastic_cloud.js @@ -1,4 +1,7 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { FILEBEAT_CLOUD_INSTRUCTIONS } from '../../../common/tutorials/filebeat_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +11,37 @@ export const ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'elastiCloud instructions - TBD', - } + FILEBEAT_INSTRUCTIONS.INSTALL.OSX, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + FILEBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.DEB, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + FILEBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.RPM, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + FILEBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + FILEBEAT_CLOUD_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/system_logs/enable.js b/src/core_plugins/kibana/server/tutorials/system_logs/enable.js new file mode 100644 index 0000000000000..32ed797e76367 --- /dev/null +++ b/src/core_plugins/kibana/server/tutorials/system_logs/enable.js @@ -0,0 +1,32 @@ +export const ENABLE_INSTRUCTIONS = { + OSX: { + title: 'Enable and configure the system module', + textPre: 'From the installation directory, run:', + commands: [ + './filebeat modules enable system', + ], + textPost: 'Modify the settings in the `modules.d/system.yml` file.' + }, + DEB: { + title: 'Enable and configure the system module', + commands: [ + 'sudo filebeat modules enable system', + ], + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' + }, + RPM: { + title: 'Enable and configure the system module', + commands: [ + 'sudo filebeat modules enable system', + ], + textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' + }, + WINDOWS: { + title: 'Enable and configure the system module', + textPre: 'From the `C:\\Program Files\\Filebeat` folder, run:', + commands: [ + 'PS C:\\Program Files\\Filebeat> filebeat.exe modules enable system', + ], + textPost: 'Modify the settings in the `modules.d/system.yml` file.' + } +}; diff --git a/src/core_plugins/kibana/server/tutorials/system_logs/index.js b/src/core_plugins/kibana/server/tutorials/system_logs/index.js index 7010437879faf..40bec08f98401 100644 --- a/src/core_plugins/kibana/server/tutorials/system_logs/index.js +++ b/src/core_plugins/kibana/server/tutorials/system_logs/index.js @@ -9,13 +9,25 @@ export function systemLogsSpecProvider() { name: 'System logs', category: TUTORIAL_CATEGORY.LOGGING, 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' + + 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.' + ' [Learn more]({config.docs.beats.filebeat}/filebeat-module-system.html)' + - ' about the system module.', + ' about the `system` module.', //iconPath: '', TODO + artifacts: { + dashboards: [ + { + title: 'Filebeat-syslog-dashboard', + linkLabel: 'System logs dashboard', + isOverview: true + } + ], + exportedFields: { + documentationUrl: '{config.docs.beats.filebeat}/exported-fields-system.html' + } + }, completionTimeMinutes: 10, - //previewImagePath: '', TODO + previewImagePath: '/plugins/kibana/home/tutorial_resources/system_logs/screenshot.png', onPrem: ON_PREM_INSTRUCTIONS, elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS, onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS diff --git a/src/core_plugins/kibana/server/tutorials/system_logs/on_prem.js b/src/core_plugins/kibana/server/tutorials/system_logs/on_prem.js index 65ed2f5c5fdd9..47c9024326573 100644 --- a/src/core_plugins/kibana/server/tutorials/system_logs/on_prem.js +++ b/src/core_plugins/kibana/server/tutorials/system_logs/on_prem.js @@ -1,5 +1,6 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_INSTRUCTIONS = { instructionSets: [ @@ -9,45 +10,42 @@ export const ON_PREM_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ + FILEBEAT_INSTRUCTIONS.PLUGINS.GEOIP, FILEBEAT_INSTRUCTIONS.INSTALL.OSX, - { - title: 'Enable and configure the system module', - textPre: 'From the installation directory, run:', - commands: [ - './filebeat modules enable system', - ], - textPost: 'Modify the settings in the `modules.d/system.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, FILEBEAT_INSTRUCTIONS.START.OSX ] }, { id: INSTRUCTION_VARIANT.DEB, instructions: [ + FILEBEAT_INSTRUCTIONS.PLUGINS.GEOIP, FILEBEAT_INSTRUCTIONS.INSTALL.DEB, - { - title: 'Enable and configure the system module', - commands: [ - 'sudo filebeat modules enable system', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, FILEBEAT_INSTRUCTIONS.START.DEB ] }, { id: INSTRUCTION_VARIANT.RPM, instructions: [ + FILEBEAT_INSTRUCTIONS.PLUGINS.GEOIP, FILEBEAT_INSTRUCTIONS.INSTALL.RPM, - { - title: 'Enable and configure the system module', - commands: [ - 'sudo filebeat modules enable system', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' - }, + FILEBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, FILEBEAT_INSTRUCTIONS.START.RPM ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + FILEBEAT_INSTRUCTIONS.PLUGINS.GEOIP, + FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + FILEBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + FILEBEAT_INSTRUCTIONS.START.WINDOWS + ] } ] } diff --git a/src/core_plugins/kibana/server/tutorials/system_logs/on_prem_elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/system_logs/on_prem_elastic_cloud.js index e01007c368606..2266d33eccd1f 100644 --- a/src/core_plugins/kibana/server/tutorials/system_logs/on_prem_elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/system_logs/on_prem_elastic_cloud.js @@ -1,4 +1,10 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { FILEBEAT_INSTRUCTIONS } from '../../../common/tutorials/filebeat_instructions'; +import { + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2 +} from '../../../common/tutorials/onprem_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +14,45 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'onPremElasticCloud instructions - TBD', - } + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.OSX, + FILEBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + FILEBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.DEB, + FILEBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + FILEBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.RPM, + FILEBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + FILEBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + FILEBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + FILEBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + FILEBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/system_metrics/elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/system_metrics/elastic_cloud.js index 058a16196e394..408ae869571e7 100644 --- a/src/core_plugins/kibana/server/tutorials/system_metrics/elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/system_metrics/elastic_cloud.js @@ -1,4 +1,7 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { METRICBEAT_CLOUD_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +11,37 @@ export const ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'elastiCloud instructions - TBD', - } + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + METRICBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + METRICBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + METRICBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_CLOUD_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ] diff --git a/src/core_plugins/kibana/server/tutorials/system_metrics/enable.js b/src/core_plugins/kibana/server/tutorials/system_metrics/enable.js new file mode 100644 index 0000000000000..f81af30a80ef7 --- /dev/null +++ b/src/core_plugins/kibana/server/tutorials/system_metrics/enable.js @@ -0,0 +1,32 @@ +export const ENABLE_INSTRUCTIONS = { + OSX: { + title: 'Enable and configure the system module', + textPre: 'From the installation directory, run:', + commands: [ + './metricbeat modules enable system', + ], + textPost: 'Modify the settings in the `modules.d/system.yml` file.' + }, + DEB: { + title: 'Enable and configure the system module', + commands: [ + 'sudo metricbeat modules enable system', + ], + textPost: 'Modify the settings in the `/etc/metricbeat/modules.d/system.yml` file.' + }, + RPM: { + title: 'Enable and configure the system module', + commands: [ + 'sudo metricbeat modules enable system', + ], + textPost: 'Modify the settings in the `/etc/metricbeat/modules.d/system.yml` file.' + }, + WINDOWS: { + title: 'Enable and configure the system module', + textPre: 'From the `C:\\Program Files\\Metricbeat` folder, run:', + commands: [ + 'PS C:\\Program Files\\Metricbeat> metricbeat.exe modules enable system', + ], + textPost: 'Modify the settings in the `modules.d/system.yml` file.' + } +}; diff --git a/src/core_plugins/kibana/server/tutorials/system_metrics/index.js b/src/core_plugins/kibana/server/tutorials/system_metrics/index.js index be8fef02569c3..0ffec8b8b2e66 100644 --- a/src/core_plugins/kibana/server/tutorials/system_metrics/index.js +++ b/src/core_plugins/kibana/server/tutorials/system_metrics/index.js @@ -9,13 +9,25 @@ export function systemMetricsSpecProvider() { name: 'System metrics', category: TUTORIAL_CATEGORY.METRICS, 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.' + + 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.' + ' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-system.html)' + ' about the system module.', //iconPath: '', TODO + artifacts: { + dashboards: [ + { + title: 'Metricbeat-system-overview', + linkLabel: 'System metrics dashboard', + isOverview: true + } + ], + exportedFields: { + documentationUrl: '{config.docs.beats.metricbeat}/exported-fields-system.html' + } + }, completionTimeMinutes: 10, - //previewImagePath: 'kibana-system.png', TODO + previewImagePath: '/plugins/kibana/home/tutorial_resources/system_metrics/screenshot.png', onPrem: ON_PREM_INSTRUCTIONS, elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS, onPremElasticCloud: ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS diff --git a/src/core_plugins/kibana/server/tutorials/system_metrics/on_prem.js b/src/core_plugins/kibana/server/tutorials/system_metrics/on_prem.js index e5f28401ec87b..8a47014420ebe 100644 --- a/src/core_plugins/kibana/server/tutorials/system_metrics/on_prem.js +++ b/src/core_plugins/kibana/server/tutorials/system_metrics/on_prem.js @@ -1,5 +1,6 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_INSTRUCTIONS = { instructionSets: [ @@ -10,21 +11,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.OSX, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.OSX, - { - title: 'Enable and configure the system module', - textPre: 'From the installation directory, run:', - commands: [ - './metricbeat modules enable system', - ], - textPost: 'Modify the settings in the `modules.d/system.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - './metricbeat test modules system' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, METRICBEAT_INSTRUCTIONS.START.OSX ] }, @@ -32,20 +20,8 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.DEB, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.DEB, - { - title: 'Enable and configure the system module', - commands: [ - 'sudo metricbeat modules enable system', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'sudo metricbeat test modules system' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, METRICBEAT_INSTRUCTIONS.START.DEB ] }, @@ -53,22 +29,19 @@ export const ON_PREM_INSTRUCTIONS = { id: INSTRUCTION_VARIANT.RPM, instructions: [ METRICBEAT_INSTRUCTIONS.INSTALL.RPM, - { - title: 'Enable and configure the system module', - commands: [ - 'sudo metricbeat modules enable system', - ], - textPost: 'Modify the settings in the `/etc/filebeat/modules.d/system.yml` file.' - }, - { - title: 'Optional: Test the module', - textPre: 'You can do a dry-run fetch by running the following command.', - commands: [ - 'sudo metricbeat test modules system' - ] - }, + METRICBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, METRICBEAT_INSTRUCTIONS.START.RPM ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS + ] } ] } diff --git a/src/core_plugins/kibana/server/tutorials/system_metrics/on_prem_elastic_cloud.js b/src/core_plugins/kibana/server/tutorials/system_metrics/on_prem_elastic_cloud.js index e01007c368606..fe1cdbcde9391 100644 --- a/src/core_plugins/kibana/server/tutorials/system_metrics/on_prem_elastic_cloud.js +++ b/src/core_plugins/kibana/server/tutorials/system_metrics/on_prem_elastic_cloud.js @@ -1,4 +1,10 @@ import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; +import { METRICBEAT_INSTRUCTIONS } from '../../../common/tutorials/metricbeat_instructions'; +import { + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2 +} from '../../../common/tutorials/onprem_cloud_instructions'; +import { ENABLE_INSTRUCTIONS } from './enable'; export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { instructionSets: [ @@ -8,9 +14,45 @@ export const ON_PREM_ELASTIC_CLOUD_INSTRUCTIONS = { { id: INSTRUCTION_VARIANT.OSX, instructions: [ - { - title: 'onPremElasticCloud instructions - TBD', - } + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.OSX, + METRICBEAT_INSTRUCTIONS.CONFIG.OSX, + ENABLE_INSTRUCTIONS.OSX, + METRICBEAT_INSTRUCTIONS.START.OSX + ] + }, + { + id: INSTRUCTION_VARIANT.DEB, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.DEB, + METRICBEAT_INSTRUCTIONS.CONFIG.DEB, + ENABLE_INSTRUCTIONS.DEB, + METRICBEAT_INSTRUCTIONS.START.DEB + ] + }, + { + id: INSTRUCTION_VARIANT.RPM, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.RPM, + METRICBEAT_INSTRUCTIONS.CONFIG.RPM, + ENABLE_INSTRUCTIONS.RPM, + METRICBEAT_INSTRUCTIONS.START.RPM + ] + }, + { + id: INSTRUCTION_VARIANT.WINDOWS, + instructions: [ + TRYCLOUD_OPTION1, + TRYCLOUD_OPTION2, + METRICBEAT_INSTRUCTIONS.INSTALL.WINDOWS, + METRICBEAT_INSTRUCTIONS.CONFIG.WINDOWS, + ENABLE_INSTRUCTIONS.WINDOWS, + METRICBEAT_INSTRUCTIONS.START.WINDOWS ] } ]