From 604ad7259ffc4654db55fc8e3374abe4efade1ab Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 30 May 2018 09:02:39 -0700 Subject: [PATCH] [DOCS] Move monitoring folder to docs (#9677) --- docs/index.asciidoc | 4 ++-- docs/static/monitoring.asciidoc | 2 +- .../static}/monitoring/collectors.asciidoc | 0 .../monitoring/configuring-logstash.asciidoc | 2 +- .../static}/monitoring/images/monitoring-ui.png | Bin .../static}/monitoring/images/nodestats.png | Bin .../static}/monitoring/images/overviewstats.png | Bin .../monitoring/images/pipeline-diagram.png | Bin .../monitoring/images/pipeline-filter-detail.png | Bin .../monitoring/images/pipeline-input-detail.png | Bin .../monitoring/images/pipeline-output-detail.png | Bin .../images/pipeline-viewer-detail-drawer.png | Bin .../images/pipeline-viewer-overview.png | Bin .../en => docs/static}/monitoring/index.asciidoc | 0 .../en => docs/static}/monitoring/intro.asciidoc | 0 .../static}/monitoring/monitoring-output.asciidoc | 0 .../monitoring/monitoring-overview.asciidoc | 0 .../static}/monitoring/monitoring-ui.asciidoc | 4 ++-- .../static}/monitoring/pipeline-viewer.asciidoc | 14 +++++++------- .../monitoring/pipelines/tweets_about_rain.conf | 0 .../static}/monitoring/troubleshooting.asciidoc | 0 21 files changed, 13 insertions(+), 13 deletions(-) rename {x-pack/docs/en => docs/static}/monitoring/collectors.asciidoc (100%) rename {x-pack/docs/en => docs/static}/monitoring/configuring-logstash.asciidoc (97%) rename {x-pack/docs/en => docs/static}/monitoring/images/monitoring-ui.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/images/nodestats.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/images/overviewstats.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/images/pipeline-diagram.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/images/pipeline-filter-detail.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/images/pipeline-input-detail.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/images/pipeline-output-detail.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/images/pipeline-viewer-detail-drawer.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/images/pipeline-viewer-overview.png (100%) rename {x-pack/docs/en => docs/static}/monitoring/index.asciidoc (100%) rename {x-pack/docs/en => docs/static}/monitoring/intro.asciidoc (100%) rename {x-pack/docs/en => docs/static}/monitoring/monitoring-output.asciidoc (100%) rename {x-pack/docs/en => docs/static}/monitoring/monitoring-overview.asciidoc (100%) rename {x-pack/docs/en => docs/static}/monitoring/monitoring-ui.asciidoc (80%) rename {x-pack/docs/en => docs/static}/monitoring/pipeline-viewer.asciidoc (91%) rename {x-pack/docs/en => docs/static}/monitoring/pipelines/tweets_about_rain.conf (100%) rename {x-pack/docs/en => docs/static}/monitoring/troubleshooting.asciidoc (100%) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 959550a29e4..42279f2e940 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -132,8 +132,8 @@ ifdef::include-xpack[] :edit_url: https://github.com/elastic/logstash/edit/{branch}/x-pack/docs/en/management/configuring-centralized-pipelines.asciidoc include::{xls-repo-dir}/management/configuring-centralized-pipelines.asciidoc[] -:edit_url: https://github.com/elastic/logstash/edit/{branch}/x-pack/docs/en/monitoring/configuring-logstash.asciidoc -include::{xls-repo-dir}/monitoring/configuring-logstash.asciidoc[] +:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/monitoring/configuring-logstash.asciidoc +include::static/monitoring/configuring-logstash.asciidoc[] :edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/security/logstash.asciidoc include::static/security/logstash.asciidoc[] diff --git a/docs/static/monitoring.asciidoc b/docs/static/monitoring.asciidoc index fc1280e77f1..f52093f1046 100644 --- a/docs/static/monitoring.asciidoc +++ b/docs/static/monitoring.asciidoc @@ -18,5 +18,5 @@ requiring any extra configuration. ifdef::include-xpack[] :edit_url!: -include::{xls-repo-dir}/monitoring/index.asciidoc[] +include::monitoring/index.asciidoc[] endif::include-xpack[] diff --git a/x-pack/docs/en/monitoring/collectors.asciidoc b/docs/static/monitoring/collectors.asciidoc similarity index 100% rename from x-pack/docs/en/monitoring/collectors.asciidoc rename to docs/static/monitoring/collectors.asciidoc diff --git a/x-pack/docs/en/monitoring/configuring-logstash.asciidoc b/docs/static/monitoring/configuring-logstash.asciidoc similarity index 97% rename from x-pack/docs/en/monitoring/configuring-logstash.asciidoc rename to docs/static/monitoring/configuring-logstash.asciidoc index c54d7431f42..55e5899ca4c 100644 --- a/x-pack/docs/en/monitoring/configuring-logstash.asciidoc +++ b/docs/static/monitoring/configuring-logstash.asciidoc @@ -93,7 +93,7 @@ your Logstash nodes should be visible in the Logstash section. When security is enabled, to view the monitoring dashboards you must log in to {kib} as a user who has the `kibana_user` and `monitoring_user` roles. + -image:monitoring/images/monitoring-ui.png["Monitoring",link="monitoring/images/monitoring-ui.png"] +image:static/monitoring/images/monitoring-ui.png["Monitoring",link="monitoring/images/monitoring-ui.png"] [float] [[monitoring-upgraded-logstash]] diff --git a/x-pack/docs/en/monitoring/images/monitoring-ui.png b/docs/static/monitoring/images/monitoring-ui.png similarity index 100% rename from x-pack/docs/en/monitoring/images/monitoring-ui.png rename to docs/static/monitoring/images/monitoring-ui.png diff --git a/x-pack/docs/en/monitoring/images/nodestats.png b/docs/static/monitoring/images/nodestats.png similarity index 100% rename from x-pack/docs/en/monitoring/images/nodestats.png rename to docs/static/monitoring/images/nodestats.png diff --git a/x-pack/docs/en/monitoring/images/overviewstats.png b/docs/static/monitoring/images/overviewstats.png similarity index 100% rename from x-pack/docs/en/monitoring/images/overviewstats.png rename to docs/static/monitoring/images/overviewstats.png diff --git a/x-pack/docs/en/monitoring/images/pipeline-diagram.png b/docs/static/monitoring/images/pipeline-diagram.png similarity index 100% rename from x-pack/docs/en/monitoring/images/pipeline-diagram.png rename to docs/static/monitoring/images/pipeline-diagram.png diff --git a/x-pack/docs/en/monitoring/images/pipeline-filter-detail.png b/docs/static/monitoring/images/pipeline-filter-detail.png similarity index 100% rename from x-pack/docs/en/monitoring/images/pipeline-filter-detail.png rename to docs/static/monitoring/images/pipeline-filter-detail.png diff --git a/x-pack/docs/en/monitoring/images/pipeline-input-detail.png b/docs/static/monitoring/images/pipeline-input-detail.png similarity index 100% rename from x-pack/docs/en/monitoring/images/pipeline-input-detail.png rename to docs/static/monitoring/images/pipeline-input-detail.png diff --git a/x-pack/docs/en/monitoring/images/pipeline-output-detail.png b/docs/static/monitoring/images/pipeline-output-detail.png similarity index 100% rename from x-pack/docs/en/monitoring/images/pipeline-output-detail.png rename to docs/static/monitoring/images/pipeline-output-detail.png diff --git a/x-pack/docs/en/monitoring/images/pipeline-viewer-detail-drawer.png b/docs/static/monitoring/images/pipeline-viewer-detail-drawer.png similarity index 100% rename from x-pack/docs/en/monitoring/images/pipeline-viewer-detail-drawer.png rename to docs/static/monitoring/images/pipeline-viewer-detail-drawer.png diff --git a/x-pack/docs/en/monitoring/images/pipeline-viewer-overview.png b/docs/static/monitoring/images/pipeline-viewer-overview.png similarity index 100% rename from x-pack/docs/en/monitoring/images/pipeline-viewer-overview.png rename to docs/static/monitoring/images/pipeline-viewer-overview.png diff --git a/x-pack/docs/en/monitoring/index.asciidoc b/docs/static/monitoring/index.asciidoc similarity index 100% rename from x-pack/docs/en/monitoring/index.asciidoc rename to docs/static/monitoring/index.asciidoc diff --git a/x-pack/docs/en/monitoring/intro.asciidoc b/docs/static/monitoring/intro.asciidoc similarity index 100% rename from x-pack/docs/en/monitoring/intro.asciidoc rename to docs/static/monitoring/intro.asciidoc diff --git a/x-pack/docs/en/monitoring/monitoring-output.asciidoc b/docs/static/monitoring/monitoring-output.asciidoc similarity index 100% rename from x-pack/docs/en/monitoring/monitoring-output.asciidoc rename to docs/static/monitoring/monitoring-output.asciidoc diff --git a/x-pack/docs/en/monitoring/monitoring-overview.asciidoc b/docs/static/monitoring/monitoring-overview.asciidoc similarity index 100% rename from x-pack/docs/en/monitoring/monitoring-overview.asciidoc rename to docs/static/monitoring/monitoring-overview.asciidoc diff --git a/x-pack/docs/en/monitoring/monitoring-ui.asciidoc b/docs/static/monitoring/monitoring-ui.asciidoc similarity index 80% rename from x-pack/docs/en/monitoring/monitoring-ui.asciidoc rename to docs/static/monitoring/monitoring-ui.asciidoc index 0cd3545a6a1..73062b90458 100644 --- a/x-pack/docs/en/monitoring/monitoring-ui.asciidoc +++ b/docs/static/monitoring/monitoring-ui.asciidoc @@ -8,11 +8,11 @@ to gain deep visibility into metrics about your Logstash deployment. In the overview dashboard, you can see all events received and sent by Logstash, plus info about memory usage and uptime: -image::monitoring/images/overviewstats.png[Logstash monitoring overview dashboard in Kibana] +image::static/monitoring/images/overviewstats.png[Logstash monitoring overview dashboard in Kibana] Then you can drill down to see stats about a specific node: -image::monitoring/images/nodestats.png[Logstash monitoring node stats dashboard in Kibana] +image::static/monitoring/images/nodestats.png[Logstash monitoring node stats dashboard in Kibana] NOTE: A Logstash node is considered unique based on its persistent UUID, which is written to the <> directory when the node diff --git a/x-pack/docs/en/monitoring/pipeline-viewer.asciidoc b/docs/static/monitoring/pipeline-viewer.asciidoc similarity index 91% rename from x-pack/docs/en/monitoring/pipeline-viewer.asciidoc rename to docs/static/monitoring/pipeline-viewer.asciidoc index 2a0d8127fae..7e6ef287345 100644 --- a/x-pack/docs/en/monitoring/pipeline-viewer.asciidoc +++ b/docs/static/monitoring/pipeline-viewer.asciidoc @@ -59,7 +59,7 @@ metrics to the monitoring cluster. You should see a Logstash section. + [role="screenshot"] -image::monitoring/images/monitoring-ui.png[Monitoring UI] +image::static/monitoring/images/monitoring-ui.png[Monitoring UI] . Click the *Pipelines* link under Logstash to see all the pipelines that are being monitored. @@ -69,7 +69,7 @@ pipeline, you'll see charts showing the pipeline's throughput and the number of nodes on which the pipeline is running during the selected time range. + [role="screenshot"] -image::monitoring/images/pipeline-viewer-overview.png[Pipeline Overview] +image::static/monitoring/images/pipeline-viewer-overview.png[Pipeline Overview] + // To update the screenshot above, see pipelines/tweets_about_rain.conf + @@ -89,7 +89,7 @@ The diagram shows all the stages feeding data through the pipeline. It also show conditional logic. + [role="screenshot"] -image::monitoring/images/pipeline-diagram.png[Pipeline Diagram] +image::static/monitoring/images/pipeline-diagram.png[Pipeline Diagram] + // To update the screenshot above, see pipelines/tweets_about_rain.conf + @@ -98,7 +98,7 @@ The information displayed on each vertex varies depending on the plugin type. Here's an example of an *input* vertex: + [role="screenshot"] -image::monitoring/images/pipeline-input-detail.png[Input vertex] +image::static/monitoring/images/pipeline-input-detail.png[Input vertex] + The *I* badge indicates that this is an input stage. The vertex shows: + @@ -110,7 +110,7 @@ The *I* badge indicates that this is an input stage. The vertex shows: Here's an example of a *filter* vertex. [role="screenshot"] -image::monitoring/images/pipeline-filter-detail.png[Filter vertex] +image::static/monitoring/images/pipeline-filter-detail.png[Filter vertex] The filter icon indicates that this is a filter stage. The vertex shows: @@ -128,7 +128,7 @@ An *output* vertex shows the same information as a vertex node, but it has an *O* badge to indicate that it is an output stage: [role="screenshot"] -image::monitoring/images/pipeline-output-detail.png[Output vertex] +image::static/monitoring/images/pipeline-output-detail.png[Output vertex] -- . Hover over a vertex in the diagram, and you'll see only the related nodes that @@ -139,4 +139,4 @@ are ancestors or descendants of the current vertex. . Click on a vertex to see details about it. + [role="screenshot"] -image::monitoring/images/pipeline-viewer-detail-drawer.png[Vertex detail] \ No newline at end of file +image::static/monitoring/images/pipeline-viewer-detail-drawer.png[Vertex detail] \ No newline at end of file diff --git a/x-pack/docs/en/monitoring/pipelines/tweets_about_rain.conf b/docs/static/monitoring/pipelines/tweets_about_rain.conf similarity index 100% rename from x-pack/docs/en/monitoring/pipelines/tweets_about_rain.conf rename to docs/static/monitoring/pipelines/tweets_about_rain.conf diff --git a/x-pack/docs/en/monitoring/troubleshooting.asciidoc b/docs/static/monitoring/troubleshooting.asciidoc similarity index 100% rename from x-pack/docs/en/monitoring/troubleshooting.asciidoc rename to docs/static/monitoring/troubleshooting.asciidoc