github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-25 07:07:54 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add fixes from review

Browse source 
Fixes #7966
This commit is contained in:
DeDe Morton 2017-08-10 13:09:25 -07:00
parent ea5282dbd5
commit e5c9cb7334
1 changed files with 20 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/static/pipeline-viewer.asciidoc vendored
View file

@ -7,8 +7,6 @@ paid {xpack} license. See the
https://www.elastic.co/subscriptions[Elastic Subscriptions] page for https://www.elastic.co/subscriptions[Elastic Subscriptions] page for
information about obtaining a license. information about obtaining a license.
//REVIEWERS: Not sure what license is required here. Does this come with basic?
The pipeline viewer in {xpack} provides a simple way for you to visualize and The pipeline viewer in {xpack} provides a simple way for you to visualize and
monitor the behavior of complex Logstash pipeline configurations. Within the monitor the behavior of complex Logstash pipeline configurations. Within the
pipeline viewer, you can explore a directed acyclic graph (DAG) representation pipeline viewer, you can explore a directed acyclic graph (DAG) representation
@ -20,12 +18,24 @@ The diagram includes visual indicators to draw your attention to potential
bottlenecks in the pipeline, making it easy for you to diagnose and fix bottlenecks in the pipeline, making it easy for you to diagnose and fix
problems. problems.
[IMPORTANT]
==========================================================================
When you configure the stages in your Logstash pipeline, make sure you specify
semantic IDs. If you don't specify IDs, Logstash generates them for you.
Using semantic IDs makes it easier to identify the configurations that are
causing bottlenecks. For example, you may have several grok filters running
in your pipeline. If you haven't specified semantic IDs, you won't be able
to tell at a glance which filters are slow. If you specify semantic IDs,
such as `apacheParsingGrok` and `cloudwatchGrok`, you'll know exactly which
grok filters are causing bottlenecks.
==========================================================================
Before using the pipeline viewer, you need to Before using the pipeline viewer, you need to
{logstash-ref}/setup-xpack.html[set up {xpack}] and configure {logstash-ref}/setup-xpack.html[set up {xpack}] and configure
{xpack-ref}/monitoring-logstash.html[Logstash monitoring]. {xpack-ref}/monitoring-logstash.html[Logstash monitoring].
//REVIEWERS: Is anything else required to use the pipeline viewer?
[float] [float]
==== View the pipeline diagram ==== View the pipeline diagram
@ -46,15 +56,17 @@ image::static/docs/images/monitoring-ui.png[Monitoring UI]
being monitored. being monitored.
+ +
Each pipeline is identified by a pipeline ID (`main` by default). For each Each pipeline is identified by a pipeline ID (`main` by default). For each
pipeline, you'll see a list of all versions of the pipeline running during pipeline, you'll see a list of all versions of the pipeline stats that were
the specified time range. captured during the specified time range.
+ +
image::static/docs/images/pipeline-viewer-overview.png[Pipeline Overview] image::static/docs/images/pipeline-viewer-overview.png[Pipeline Overview]
+ +
The version information is auto-generated by Logstash. Each time you modify a The version information is auto-generated by Logstash. Each time you modify a
pipeline, Logstash generates a new version hash. Viewing different versions pipeline, Logstash generates a new version hash. Viewing different versions
allows you see how changes to the pipeline over time affect throughput and of the pipeline stats allows you see how changes to the pipeline over time
other metrics. affect throughput and other metrics. Note that Logstash stores multiple versions
of the pipeline stats; it does not store multiple versions of the pipeline
configurations themselves.
. Click a pipeline version in the list to drill down and explore the pipeline . Click a pipeline version in the list to drill down and explore the pipeline
diagram. diagram.
@ -103,5 +115,3 @@ image::static/docs/images/pipeline-output-detail.png[Output node]
are ancestors or descendants of the current node. are ancestors or descendants of the current node.
. Explore the diagram and look for performance anomalies. . Explore the diagram and look for performance anomalies.
//REVIEWERS: Not clear to me where users specify the user-supplied ID. Also, should we mention how it's used. I think it's used to correlate stats across different versions of the pipeline, but I'm not sure if that's useful to mention to users yet.