Skip to content

Commit

Permalink
[6.x] Tutorial copy (#16135) (#16164)
Browse files Browse the repository at this point in the history
* Tutorial copy (#16135)

* update short descriptions

* apache log updates

* apache metrics and and APM updates

* docker, mysql, and kubernetes updates

* netflow updates

* all of the rest

* remove From the installation directory, fix type Logstash modules => This modules

* add APM dashboard screenshot

* fix typo and download URL

* Adding "collects" to align with standard Netflow terminology of a collector
  • Loading branch information
nreese authored Jan 19, 2018
1 parent 20b879a commit fa2108b
Show file tree
Hide file tree
Showing 24 changed files with 72 additions and 88 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const FILEBEAT_INSTRUCTIONS = {
'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: 'Looking for the 32 bits packages? See the [Download page](https://www.elastic.co/downloads/beats/filebeat).'
textPost: 'Looking for the 32-bit packages? See the [Download page](https://www.elastic.co/downloads/beats/filebeat).'
},
RPM: {
title: 'Download and install Filebeat',
Expand All @@ -28,17 +28,17 @@ export const FILEBEAT_INSTRUCTIONS = {
'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: 'Looking for the 32 bits packages? See the [Download page](https://www.elastic.co/downloads/beats/filebeat).'
textPost: 'Looking for the 32-bit packages? See the [Download page](https://www.elastic.co/downloads/beats/filebeat).'
},
WINDOWS: {
title: 'Download and install Filebeat',
textPre: 'First time using Filebeat? See the [Getting Started Guide]' +
'({config.docs.beats.filebeat}/filebeat-getting-started.html).\n' +
'1. Download the Filebeat Windows zip file from the [downloads](https://www.elastic.co/downloads/beats/filebeat) page.\n' +
'1. Download the Filebeat Windows zip file from the [Download](https://www.elastic.co/downloads/beats/filebeat) page.\n' +
'2. Extract the contents of the zip file into `C:\\Program Files`.\n' +
'3. Rename the `filebeat-{config.kibana.version}-windows` directory to `Filebeat`.\n' +
'4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' +
' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' +
' **Run As Administrator**). If you are running Windows XP, you might 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',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ export const LOGSTASH_INSTRUCTIONS = {
},
{
title: 'Download and install Logstash',
textPre: 'First time using Logstash? See the ' +
'[Getting Started Guide]({config.docs.base_url}guide/en/logstash/current/getting-started-with-logstash.html).',
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/logstash/logstash-{config.kibana.version}.tar.gz',
'tar xzvf logstash-{config.kibana.version}.tar.gz'
Expand All @@ -15,12 +17,15 @@ export const LOGSTASH_INSTRUCTIONS = {
],
WINDOWS: [
{
title: 'Download and install the Java runtime environment',
title: 'Download and install the Java Runtime Environment',
textPre: 'Follow the installation instructions [here](https://docs.oracle.com/javase/8/docs/technotes/guides/install/windows_jre_install.html).'
},
{
title: 'Download and install Logstash',
textPre: 'Download Logstash from [here](https://artifacts.elastic.co/downloads/logstash/logstash-{config.kibana.version}.zip) and unzip it.'
textPre: 'First time using Logstash? See the ' +
'[Getting Started Guide]({config.docs.base_url}guide/en/logstash/current/getting-started-with-logstash.html).\n' +
' 1. [Download](https://artifacts.elastic.co/downloads/logstash/logstash-{config.kibana.version}.zip) the Logstash Windows zip file.\n' +
' 2. Extract the contents of the zip file.'
}
],
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const METRICBEAT_INSTRUCTIONS = {
'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: 'Looking for the 32 bits packages? See the [Download page](https://www.elastic.co/downloads/beats/metricbeat).'
textPost: 'Looking for the 32-bit packages? See the [Download page](https://www.elastic.co/downloads/beats/metricbeat).'
},
RPM: {
title: 'Download and install Metricbeat',
Expand All @@ -28,17 +28,17 @@ export const METRICBEAT_INSTRUCTIONS = {
'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: 'Looking for the 32 bits packages? See the [Download page](https://www.elastic.co/downloads/beats/metricbeat).'
textPost: 'Looking for the 32-bit packages? See the [Download page](https://www.elastic.co/downloads/beats/metricbeat).'
},
WINDOWS: {
title: 'Download and install Metricbeat',
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' +
'1. Download the Metricbeat Windows zip file from the [Download](https://www.elastic.co/downloads/beats/metricbeat) page.\n' +
'2. Extract the contents of the zip file into `C:\\Program Files`.\n' +
'3. Rename the `metricbeat-{config.kibana.version}-windows` directory to `Metricbeat`.\n' +
'4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select' +
' Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.\n' +
' **Run As Administrator**). If you are running Windows XP, you might need to download and install PowerShell.\n' +
'5. From the PowerShell prompt, run the following commands to install Metricbeat as a Windows service.',
commands: [
'PS > cd C:\\Program Files\\Metricbeat',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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' +
' * Wait for the cluster plan to complete.\n' +
' * Go to the new Cloud Kibana instance and follow the Kibana Home instructions.'
' 1. Select **Create Cluster**, leave size slider at 4 GB RAM, and click **Create**.\n' +
' 2. Wait for the cluster plan to complete.\n' +
' 3. Go to the new Cloud Kibana instance and follow the Kibana Home instructions.'

};

export const TRYCLOUD_OPTION2 = {
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\n' +
'In **Overview >> Endpoints** note **Elasticsearch** as `<es_url>`.'
'In **Overview > Endpoints**, note **Elasticsearch** as `<es_url>`.'
};
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export function Footer({ overviewDashboard }) {
<EuiFlexItem grow={false}>
<EuiText>
<p>
{`Once all steps are completed, you're ready to explore your data`}
{`When all steps are complete, you're ready to explore your data.`}
</p>
</EuiText>
</EuiFlexItem>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ export function apacheLogsSpecProvider() {
category: TUTORIAL_CATEGORY.LOGGING,
shortDescription: 'Collect and parse access and error logs created by the Apache HTTP server.',
longDescription: 'The apache2 Filebeat module parses access and error logs created by the Apache 2 HTTP server.' +
' [Learn more]({config.docs.beats.filebeat}/filebeat-module-apache2.html)' +
' about the apache2 module.',
' [Learn more]({config.docs.beats.filebeat}/filebeat-module-apache2.html).',
//iconPath: '', TODO
artifacts: {
dashboards: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ export function apacheMetricsSpecProvider() {
id: 'apacheMetrics',
name: 'Apache metrics',
category: TUTORIAL_CATEGORY.METRICS,
shortDescription: 'Fetches internal metrics from the Apache 2 HTTP server.',
shortDescription: 'Fetch 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.',
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-apache.html).',
//iconPath: '', TODO
artifacts: {
dashboards: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const NODE_CLIENT_INSTRUCTIONS = [
`{curlyClose})`,
],
textPost: 'See [the documentation]({config.docs.base_url}guide/en/apm/agent/nodejs/1.x/index.html)' +
' for advanced usage. Babel users, please refer to [the documentation]' +
' for advanced usage. Babel users, refer to [the documentation]' +
'({config.docs.base_url}guide/en/apm/agent/nodejs/1.x/advanced-setup.html#es-modules).'
}
];
Expand Down Expand Up @@ -109,7 +109,7 @@ export const RAILS_CLIENT_INSTRUCTIONS = [
},
{
title: 'Configure the agent',
textPre: 'APM is automatically installed. Configure the agent, by creating the config file `config/elastic_apm.yml`',
textPre: 'Configure the agent by creating the config file `config/elastic_apm.yml`.',
commands: [
`# config/elastic_apm.yml`,
`server_url: 'http://localhost:8200'`,
Expand All @@ -130,7 +130,7 @@ export const RACK_CLIENT_INSTRUCTIONS = [
},
{
title: 'Configure the agent',
textPre: 'Rack or compatible framework (like Sinatra). Include the middleware in your app and start the agent',
textPre: 'For a Rack or compatible framework such as Sinatra, include the middleware in your app and start the agent.',
commands: [
`# config.ru`,
`require 'sinatra/base'`,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const EDIT_CONFIG = {
title: 'Edit the configuration',
textPre: `If you're using an X-Pack secured version of Elastic Stack, you need to specify` +
`credentials in the apm-server.yml config file.`,
textPre: `If you're using an X-Pack secured version of Elastic Stack, you must specify` +
' credentials in the `apm-server.yml` config file.',
commands: [
'output.elasticsearch:',
' hosts: ["<es_url>"]',
Expand All @@ -12,12 +12,12 @@ const EDIT_CONFIG = {

const IMPORT_DASHBOARD = {
title: 'Import dashboards',
textPre: 'APM Server ships with pre-configured dashboards'
textPre: 'APM Server ships with preconfigured dashboards.'
};

const START_SERVER = {
title: 'Start APM Server',
textPre: 'The server processes and stores application performance metrics in Elasticsearch'
textPre: 'The server processes and stores application performance metrics in Elasticsearch.'
};

export const DOWNLOAD_SERVER = {
Expand Down Expand Up @@ -47,7 +47,7 @@ export const WINDOWS_SERVER_INSTRUCTIONS = [
'curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-6.2.0-windows-x86_64.zip',
'sudo dpkg -i apm-server-6.2.0-windows-x86_64.zip'
],
textPost: 'Looking for the 32 bits packages? See the [Download page]({config.docs.base_url}downloads/apm/apm-server).'
textPost: 'Looking for the 32-bit packages? See the [Download page]({config.docs.base_url}downloads/apm/apm-server).'
},
{
...IMPORT_DASHBOARD,
Expand Down
15 changes: 6 additions & 9 deletions src/core_plugins/kibana/server/tutorials/apm/index.js
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category';
import { ON_PREM_INSTRUCTIONS } from './on_prem';

const apmIntro = 'APM (Application Performance Monitoring) automatically collects in-depth' +
' performance metrics and errors from inside your applications.';
const apmIntro = 'Collect in-depth performance metrics and errors from inside your applications.';

export function apmSpecProvider() {
return {
id: 'apm',
name: 'APM',
category: TUTORIAL_CATEGORY.OTHER,
shortDescription: apmIntro,
longDescription: `${apmIntro} APM consists of three components - the Agents, the Server, and the UI:\n` +
'* The Agents are libraries in your application that run inside of your application process.\n' +
'* The Server processes data from agents and stores the application data in Elasticsearch.\n' +
'* The UI is the dedicated APM UI (X-Pack Basic) and preconfigured dashboards.\n\n' +
'For more information, [please see our documentation]' +
'({config.docs.base_url}guide/en/apm/get-started/{config.docs.version}/index.html).' +
' To get started, follow the steps below.',
longDescription: 'Application Performance Monitoring (APM) collects in-depth' +
' performance metrics and errors from inside your application.' +
' It allows you to monitor the performance of thousands of applications in real time.' +
' [Learn more]({config.docs.base_url}guide/en/apm/get-started/{config.docs.version}/index.html).',
artifacts: {
dashboards: [
{
Expand All @@ -27,5 +23,6 @@ export function apmSpecProvider() {
]
},
onPrem: ON_PREM_INSTRUCTIONS,
previewImagePath: '/plugins/kibana/home/tutorial_resources/apm/apm_dashboard_transactions.jpg',
};
}
4 changes: 2 additions & 2 deletions src/core_plugins/kibana/server/tutorials/apm/on_prem.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export const ON_PREM_INSTRUCTIONS = {
'curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-6.2.0-amd64.deb',
'sudo dpkg -i apm-server-6.2.0-amd64.deb',
],
textPost: 'Looking for the 32 bits packages? See the [Download page]({config.docs.base_url}downloads/apm/apm-server).'
textPost: 'Looking for the 32-bit packages? See the [Download page]({config.docs.base_url}downloads/apm/apm-server).'
},
...UNIX_FAMILY_SERVER_INSTRUCTIONS
]
Expand All @@ -55,7 +55,7 @@ export const ON_PREM_INSTRUCTIONS = {
'curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-6.2.0-x86_64.rpm',
'sudo dpkg -i apm-server-6.2.0-x86_64.rpm'
],
textPost: 'Looking for the 32 bits packages? See the [Download page]({config.docs.base_url}downloads/apm/apm-server).'
textPost: 'Looking for the 32-bit packages? See the [Download page]({config.docs.base_url}downloads/apm/apm-server).'
},
...UNIX_FAMILY_SERVER_INSTRUCTIONS
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ export function dockerMetricsSpecProvider() {
id: 'dockerMetrics',
name: 'Docker metrics',
category: TUTORIAL_CATEGORY.METRICS,
shortDescription: 'Fetches metrics about your Docker containers.',
shortDescription: 'Fetch metrics about your Docker containers.',
longDescription: 'The `docker` Metricbeat module fetches metrics from the Docker server.' +
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-docker.html)' +
' about the docker module.',
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-docker.html).',
//iconPath: '', TODO
artifacts: {
dashboards: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ export function kubernetesMetricsSpecProvider() {
id: 'kubernetesMetrics',
name: 'Kubernetes metrics',
category: TUTORIAL_CATEGORY.METRICS,
shortDescription: 'Fetches metrics from your Kubernetes installation.',
shortDescription: 'Fetch metrics from your Kubernetes installation.',
longDescription: 'The `kubernetes` Metricbeat module fetches metrics from the Kubernetes APIs.' +
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-kubernetes.html)' +
' about the kubernetes module.',
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-kubernetes.html).',
//iconPath: '', TODO
artifacts: {
dashboards: [
Expand Down
3 changes: 1 addition & 2 deletions src/core_plugins/kibana/server/tutorials/mysql_logs/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ export function mysqlLogsSpecProvider() {
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.' +
' [Learn more]({config.docs.beats.filebeat}/filebeat-module-mysql.html)' +
' about the `mysql` module.',
' [Learn more]({config.docs.beats.filebeat}/filebeat-module-mysql.html).',
//iconPath: '', TODO
artifacts: {
dashboards: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ export function mysqlMetricsSpecProvider() {
id: 'mysqlMetrics',
name: 'MySQL metrics',
category: TUTORIAL_CATEGORY.METRICS,
shortDescription: 'Fetches internal metrics from MySQL.',
shortDescription: 'Fetch internal metrics from MySQL.',
longDescription: 'The `mysql` Metricbeat module fetches internal metrics from the MySQL server.' +
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-mysql.html)' +
' about the mysql module.',
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-mysql.html).',
//iconPath: '', TODO
artifacts: {
dashboards: [
Expand Down
Loading

0 comments on commit fa2108b

Please sign in to comment.