forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[WIP] Logstash Netflow module tutorial (#5)
* First draft of Logstash Netflow module tutorial * Incorporated writing style suggestions
- Loading branch information
1 parent
1fc743e
commit 5a02133
Showing
2 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
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,65 @@ | ||
import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category'; | ||
import { INSTRUCTION_VARIANT } from '../../../common/tutorials/instruction_variant'; | ||
|
||
export function netflowSpecProvider() { | ||
return { | ||
id: 'netflow', | ||
name: 'Netflow', | ||
category: TUTORIAL_CATEGORY.SECURITY, | ||
shortDescription: 'Collect Netflow records sent by a Netflow exporter', | ||
longDescription: 'The Logstash Netflow module simplifies the collection, normalization, and visualization of network flow data. ' + | ||
'With a single command, the module parses network flow data, indexes the events into Elasticsearch, and installs a suite of Kibana ' + | ||
'dashboards to get you exploring your data immediately. Logstash modules support Netflow Version 5 and 9. [Learn more]' + | ||
'({config.elastic_docs.website_url}/guide/en/logstash/{config.elastic_docs.link_version}/netflow-module.html) about the Netflow ' + | ||
'module.', | ||
//iconPath: '', TODO | ||
completionTimeMinutes: 10, | ||
//previewImagePath: 'kibana-apache.png', TODO | ||
params: [ | ||
{ | ||
'netflow.var.input.udp.port': { | ||
type: 'number', // TODO: Make this a const as well? | ||
defaultValue: 2055 | ||
} | ||
} | ||
], | ||
instructionSets: [ | ||
{ | ||
title: 'Getting Started', | ||
instructionVariants: [ | ||
{ | ||
id: INSTRUCTION_VARIANT.OSX, | ||
instructions: [ | ||
{ | ||
title: 'Download and install Logstash', | ||
textPre: 'Skip this step if Logstash is already installed. First time using Logstash? See the ' + | ||
'[Getting Started Guide]({config.elastic_docs.website_url}/guide/en/logstash/{config.elastic_docs.link_version}' + | ||
'/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' | ||
] | ||
}, | ||
{ | ||
title: 'Setup the Netflow module', | ||
textPre: 'In the Logstash install directory, run the following command to setup the Netflow module.', | ||
commands: [ | ||
'./bin/logstash --modules netflow --setup', | ||
], | ||
textPost: 'The --setup option creates a `netflow-*` index pattern in Elasticsearch and imports' + | ||
' Kibana dashboards and visualizations. Running `--setup` is a one-time setup step. Omit this step' + | ||
' for subsequent runs of the module to avoid overwriting existing Kibana dashboards.' | ||
}, | ||
{ | ||
title: 'Start Logstash', | ||
commands: [ | ||
'./bin/logstash --modules netflow -M netflow.var.input.udp.port={params.netflow.var.input.udp.port}' | ||
] | ||
} | ||
] | ||
} | ||
] | ||
} | ||
] | ||
}; | ||
} |
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