Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edited the Apache module tutorial #3

Closed
wants to merge 1 commit into from
Closed

Edited the Apache module tutorial #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 81 additions & 56 deletions src/core_plugins/kibana/public/home/tutorials/apache/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ import { INSTRUCTION_VARIANT } from '../../instruction_variant';
registerTutorial(() => {
return {
id: 'apache',
name: 'Apache',
name: 'Apache logs',
category: TUTORIAL_CATEGORY.LOGGING,
shortDescription: 'Some descriptive text about this application that will make you want to click on it',
longDescription: `This module periodically fetches metrics from Apache HTTPD servers.
The Apache status metricset collects data from the Apache mod_status module.
It scrapes the server status data from the web page generated by mod_status.`,
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 HTTP server.',
//iconPath: '', TODO
completionTimeMinutes: 10,
previewImagePath: 'kibana-apache2.png',
instructionSets: [
{
title: 'Getting Started',
Expand All @@ -19,83 +20,107 @@ It scrapes the server status data from the web page generated by mod_status.`,
id: INSTRUCTION_VARIANT.OSX,
instructions: [
{
title: 'Download and install Metricbeat',
textPre: 'Download and install the APM Server and follow the instructions described in the docs links below.',
title: 'Download and install Filebeat',
textPre: 'Download and install Filebeat by running the commands below.',
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-5.5.2-darwin-x86_64.tar.gz',
'tar xzvf metricbeat-5.5.2-darwin-x86_64.tar.gz'
'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'
]
},
{
title: 'Configure and run Apache data source',
textPre: 'In the Metricbeat install directory, run the following commands.',
title: 'Enable and configure the Apache module',
textPre: `In the Filebeat install directory, run the following commands to enable the Apache module,
to setup the module, and to start Filebeat.`,
commands: [
'./metricbeat modules enable apache',
'./metricbeat -setup -e',
' -E output.elasticsearch.hosts=[localhost:9200]',
' -E output.elasticsearch.username=elastic',
' -E output.elasticsearch.password=<elastic_password>',
' -E setup.kibana.host=localhsot:5601'
'cd filebeat-{config.kibana.version}-darwin-x86_64/',
'./filebeat modules enable apache2',
],
textPost: 'Optional: Modify the module settings in the `modules.d/apache2.yml` file.'
},
{
title: 'Start Filebeat',
textPre: 'Setup the Kibana dashboards and start Filebeat with the following commands.',
commands: [
'./filebeat setup -e',
'./filebeat -e',
],
textPost: 'Optional: Modify your Apache access details.'
}
]
},
{
id: INSTRUCTION_VARIANT.DEB,
instructions: [
]
},
{
id: INSTRUCTION_VARIANT.RPM,
instructions: [
]
},
{
id: INSTRUCTION_VARIANT.DOCKER,
instructions: [
]
},
{
id: INSTRUCTION_VARIANT.WINDOWS,
instructions: [
]
}
]
},
{
title: 'Phase 2',
instructionVariants: [
{
id: INSTRUCTION_VARIANT.OSX,
instructions: [
{
title: 'Do this next',
textPre: 'do some stuff.',
title: 'Download and install Filebeat',
textPre: 'Download and install Filebeat by running the commands below.',
commands: [
'ls',
'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'
]
},
{
title: 'Enable and configure the Apache module',
textPre: 'Run the following commands to enable the Apache module, to setup the module, and to start Filebeat.',
commands: [
'sudo filebeat modules enable apache2',
],
textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/apache2.yml` file.'
},
{
title: 'Start Filebeat',
textPre: 'Setup the Kibana dashboards and start Filebeat with the following commands.',
commands: [
'sudo filebeat setup -e',
'sudo filebeat -e',
],
}
]
},
{
id: INSTRUCTION_VARIANT.DEB,
instructions: [
]
},
{
id: INSTRUCTION_VARIANT.RPM,
instructions: [
]
},
{
id: INSTRUCTION_VARIANT.DOCKER,
instructions: [
{
title: 'Download and install Filebeat',
textPre: 'Download and install Filebeat by running the commands below.',
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'
]
},
{
title: 'Enable and configure the Apache module',
textPre: 'Run the following commands to enable the Apache module, to setup the module, and to start Filebeat.',
commands: [
'sudo filebeat modules enable apache2',
],
textPost: 'Optional: Modify the module settings in the `/etc/filebeat/modules.d/apache2.yml` file.'
},
{
title: 'Start Filebeat',
textPre: 'Setup the Kibana dashboards and start Filebeat with the following commands.',
commands: [
'sudo filebeat setup -e',
'sudo filebeat -e',
],
}
]
},
{
id: INSTRUCTION_VARIANT.WINDOWS,
instructions: [
{
title: 'Download and install Filebeat',
textPre: `1. Download the Filebeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats) page.
2. Extract the contents of the zip file into C:\Program Files.
3. Rename the filebeat-{config.kibana.version}-windows directory to Filebeat.
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.
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'
]
},
]
}
]
Expand Down
Binary file added src/core_plugins/kibana/public/home/tutorials/apache/kibana-apache2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.