forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* More edits on the Apache logs tutorial * Added nginx, mysql, and sytem modules for FB * Moved apache to apacheLogs and added an apacheMetrics tutorial * Added mysqlMetrics, nginxMetrics, systemMetrics tutorials * Reduce duplication in the tutorials This uses common objects for the install and start steps for Filebeat. Same can be done for MB. * fix windows path for config file
- Loading branch information
Showing
11 changed files
with
1,220 additions
and
131 deletions.
There are no files selected for viewing
103 changes: 103 additions & 0 deletions
103
src/core_plugins/kibana/common/tutorials/tutorial_beats_instructions.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| 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.' | ||
| } | ||
| } | ||
| }; |
129 changes: 0 additions & 129 deletions
129
src/core_plugins/kibana/server/tutorials/apache/index.js
This file was deleted.
Oops, something went wrong.
84 changes: 84 additions & 0 deletions
84
src/core_plugins/kibana/server/tutorials/apacheLogs/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| 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'; | ||
|
|
||
| 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].', | ||
| //iconPath: '', TODO | ||
| completionTimeMinutes: 10, | ||
| previewImagePath: 'kibana-apache2.png', | ||
| instructionSets: [ | ||
| { | ||
| title: 'Getting Started', | ||
| instructionVariants: [ | ||
| { | ||
| id: INSTRUCTION_VARIANT.OSX, | ||
| 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.', | ||
| commands: [ | ||
| './filebeat modules enable apache2', | ||
| ], | ||
| textPost: 'Optional: Modify the module settings in the `modules.d/apache2.yml` file.' | ||
| }, | ||
| FILEBEAT_INSTRUCTIONS.START.OSX | ||
| ] | ||
| }, | ||
| { | ||
| id: INSTRUCTION_VARIANT.DEB, | ||
| instructions: [ | ||
| FILEBEAT_INSTRUCTIONS.INSTALL.DEB, | ||
| { | ||
| title: 'Enable and configure the Apache module', | ||
| textPre: 'Run the following commands to enable the Apache module.', | ||
| commands: [ | ||
| 'sudo filebeat modules enable apache2', | ||
| ], | ||
| textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/apache2.yml` file.' | ||
| }, | ||
| FILEBEAT_INSTRUCTIONS.START.DEB | ||
| ] | ||
| }, | ||
| { | ||
| id: INSTRUCTION_VARIANT.RPM, | ||
| instructions: [ | ||
| FILEBEAT_INSTRUCTIONS.INSTALL.RPM, | ||
| { | ||
| title: 'Enable and configure the Apache module', | ||
| textPre: 'Run the following commands to enable the Apache module.', | ||
| commands: [ | ||
| 'sudo filebeat modules enable apache2', | ||
| ], | ||
| textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/apache2.yml` file.' | ||
| }, | ||
| FILEBEAT_INSTRUCTIONS.START.RPM | ||
| ] | ||
| }, | ||
| { | ||
| id: INSTRUCTION_VARIANT.WINDOWS, | ||
| 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.', | ||
| commands: [ | ||
| 'PS C:\\Program Files\\Filebeat> filebeat.exe modules enable apache2', | ||
| ], | ||
| textPost: 'Optional: Modify the module settings in the `modules.d/apache2.yml` file.' | ||
| }, | ||
| FILEBEAT_INSTRUCTIONS.START.WINDOWS | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }; | ||
| } |
Oops, something went wrong.