[6.6][DOCS] Merge monitoring sections in Elasticsearch book (#47758)

lcawl · web-flow · commit c19747f8eb73 · 2019-10-09T10:12:36.000-07:00
diff --git a/docs/reference/index.asciidoc b/docs/reference/index.asciidoc
@@ -18,8 +18,6 @@ include::setup/installing-xes.asciidoc[]
 
 include::setup/setup-xes.asciidoc[]
 
-include::monitoring/configuring-monitoring.asciidoc[]
-
 include::{xes-repo-dir}/security/configuring-es.asciidoc[]
 
 include::setup/setup-xclient.asciidoc[]
diff --git a/docs/reference/monitoring/collecting-monitoring-data.asciidoc b/docs/reference/monitoring/collecting-monitoring-data.asciidoc
@@ -1,10 +1,7 @@
 [role="xpack"]
 [testenv="gold"]
 [[collecting-monitoring-data]]
-=== Collecting monitoring data
-++++
-<titleabbrev>Collecting monitoring data</titleabbrev>
-++++
+== Collecting monitoring data
 
 If you enable the Elastic {monitor-features} in your cluster, you can 
 optionally collect metrics about {es}. By default, monitoring is enabled but 
diff --git a/docs/reference/monitoring/collectors.asciidoc b/docs/reference/monitoring/collectors.asciidoc
@@ -110,7 +110,7 @@ For more information about the configuration options for the collectors, see
 
 [float]
 [[es-monitoring-stack]]
-=== Collecting data from across the Elastic Stack
+==== Collecting data from across the Elastic Stack
 
 {monitoring} in {es} also receives monitoring data from other parts of the
 Elastic Stack. In this way, it serves as an unscheduled monitoring data
diff --git a/docs/reference/monitoring/configuring-metricbeat.asciidoc b/docs/reference/monitoring/configuring-metricbeat.asciidoc
@@ -1,7 +1,7 @@
 [role="xpack"]
 [testenv="gold"]
 [[configuring-metricbeat]]
-=== Collecting {es} monitoring data with {metricbeat}
+== Collecting {es} monitoring data with {metricbeat}
 
 [subs="attributes"]
 ++++
diff --git a/docs/reference/monitoring/configuring-monitoring.asciidoc b/docs/reference/monitoring/configuring-monitoring.asciidoc
diff --git a/docs/reference/monitoring/exporters.asciidoc b/docs/reference/monitoring/exporters.asciidoc
@@ -167,6 +167,3 @@ which is used to determine whether the resource should be replaced. The `version
 field value represents the latest version of {monitoring} that changed the 
 resource. If a resource is edited by someone or something external to 
 {monitoring}, those changes are lost the next time an automatic update occurs. 
-
-include::local-export.asciidoc[]
-include::http-export.asciidoc[]
diff --git a/docs/reference/monitoring/how-monitoring-works.asciidoc b/docs/reference/monitoring/how-monitoring-works.asciidoc
@@ -0,0 +1,40 @@
+[role="xpack"]
+[testenv="basic"]
+[[how-monitoring-works]]
+== How monitoring works
+++++
+<titleabbrev>How it works</titleabbrev>
+++++
+
+Each {es} node, {ls} node, {kib} instance, and Beat is considered unique in the
+cluster based on its persistent UUID, which is written to the
+<<path-settings,`path.data`>> directory when the node or instance starts.
+
+Monitoring documents are just ordinary JSON documents built by monitoring each 
+{stack} component at some collection interval. If you want to alter the
+templates for these indices, see <<config-monitoring-indices>>.
+
+Each component in the {stack} is responsible for monitoring itself and then 
+forwarding those documents to the production cluster for both routing and 
+indexing (storage). The routing and indexing processes in {es} are handled by 
+what are called <<es-monitoring-collectors,collectors>> and 
+<<es-monitoring-exporters,exporters>>. 
+
+beta[] Alternatively, in 6.4 and later, you can use {metricbeat} to collect 
+monitoring data about {kib} and ship it directly to the monitoring cluster, 
+rather than routing it through the production cluster. In 6.5 and later, you 
+can also use {metricbeat} to collect and ship data about {es}. 
+
+To learn how to collect monitoring data, see:
+
+* <<collecting-monitoring-data>>
+* <<configuring-metricbeat>>
+* {kibana-ref}/xpack-monitoring.html[Monitoring {kib}]
+* {logstash-ref}/monitoring-logstash.html[Monitoring Logstash]
+* Monitoring Beats:
+** {auditbeat-ref}/monitoring.html[Auditbeat]
+** {filebeat-ref}/monitoring.html[Filebeat]
+** {heartbeat-ref}/monitoring.html[Heartbeat]
+** {metricbeat-ref}/monitoring.html[Metricbeat]
+** {packetbeat-ref}/monitoring.html[Packetbeat]
+** {winlogbeat-ref}/monitoring.html[Winlogbeat] 
diff --git a/docs/reference/monitoring/http-export.asciidoc b/docs/reference/monitoring/http-export.asciidoc
@@ -1,7 +1,7 @@
 [role="xpack"]
 [testenv="basic"]
 [[http-exporter]]
-=== HTTP Exporters
+=== HTTP exporters
 
 The `http` exporter is the preferred exporter in {monitoring} because it enables 
 the use of a separate monitoring cluster. As a secondary benefit, it avoids 
diff --git a/docs/reference/monitoring/images/architecture10.png b/docs/reference/monitoring/images/architecture10.png
diff --git a/docs/reference/monitoring/images/architecture20.png b/docs/reference/monitoring/images/architecture20.png
diff --git a/docs/reference/monitoring/index.asciidoc b/docs/reference/monitoring/index.asciidoc
@@ -1,54 +1,31 @@
 [role="xpack"]
 [testenv="basic"]
-[[es-monitoring]]
-= Monitoring {es}
+[[monitor-elasticsearch-cluster]]
+= Monitor a cluster
 
 [partintro]
 --
-The Elastic {monitor-features} enable you to easily monitor the health of 
-your {es} cluster. The monitoring metrics are collected from each node and 
-stored in {es} indices. 
-
-TIP: In production environments, it is recommended to store the monitoring data 
-in a separate _monitoring cluster_. See 
-{stack-ov}/monitoring-production.html[Monitoring in a production environment]. 
-
-Each {es} node is considered unique based on its persistent UUID, which is
-written on first start to its <<path-settings,`path.data`>> directory, which
-defaults to `./data`.
-
-All settings associated with monitoring in {es} must be set in either the
-`elasticsearch.yml` file for each node or, where possible, in the dynamic
-cluster settings. For more information, see <<configuring-monitoring>>.
-
-[[es-monitoring-overview]]
-{es} is also at the core of monitoring across the {stack}. In all cases, 
-monitoring documents are just ordinary JSON documents built by monitoring each 
-{stack} component at some collection interval, then indexing those 
-documents into the monitoring cluster. 
-
-Each component in the stack is responsible for monitoring itself and then 
-forwarding those documents to the {es} production cluster for both routing and 
-indexing (storage). The routing and indexing processes in {es} are handled by 
-what are called <<es-monitoring-collectors,collectors>> and 
-<<es-monitoring-exporters,exporters>>. 
-
-beta[] Alternatively, in 6.4 and later, you can use {metricbeat} to collect 
-monitoring data about {kib} and ship it directly to the monitoring cluster, 
-rather than routing it through the production cluster. In 6.5 and later, you 
-can also use {metricbeat} to collect and ship data about {es}. 
-
-You can view monitoring data from {kib} where it’s easy to spot issues at a
-glance or delve into the system behavior over time to diagnose operational
-issues. In addition to the built-in status warnings, you can also set up custom
-alerts based on the data in the monitoring indices.
-
-For an introduction to monitoring your {stack}, including Beats, {ls}, and {kib}, 
-see {stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
-
+The {stack} {monitor-features} provide a way to keep a pulse on the health and
+performance of your {es} cluster. 
+
+* <<monitoring-overview>>
+* <<how-monitoring-works>>
+* <<collecting-monitoring-data>>
+* <<configuring-metricbeat>>
+* <<config-monitoring-indices>>
+* <<monitoring-tribe>>
+* <<es-monitoring-collectors>>
+* <<es-monitoring-exporters>>
 --
 
+include::overview.asciidoc[]
+include::how-monitoring-works.asciidoc[]
+include::collecting-monitoring-data.asciidoc[]
+include::pause-export.asciidoc[]
+include::configuring-metricbeat.asciidoc[]
+include::indices.asciidoc[]
+include::tribe.asciidoc[]
 include::collectors.asciidoc[]
 include::exporters.asciidoc[]
-include::pause-export.asciidoc[]
-
+include::local-export.asciidoc[]
+include::http-export.asciidoc[]
diff --git a/docs/reference/monitoring/indices.asciidoc b/docs/reference/monitoring/indices.asciidoc
@@ -1,7 +1,7 @@
 [role="xpack"]
 [testenv="basic"]
 [[config-monitoring-indices]]
-=== Configuring indices for monitoring
+== Configuring indices for monitoring
 
 <<indices-templates,Index templates>> are used to configure the indices
 that store the monitoring data collected from a cluster.
diff --git a/docs/reference/monitoring/local-export.asciidoc b/docs/reference/monitoring/local-export.asciidoc
@@ -1,7 +1,7 @@
 [role="xpack"]
 [testenv="basic"]
 [[local-exporter]]
-=== Local Exporters
+=== Local exporters
 
 The `local` exporter is the default exporter in {monitoring}. It routes data 
 back into the same (local) cluster. In other words, it uses the production 
@@ -56,7 +56,7 @@ For more information about the configuration options for the `local` exporter,
 see <<local-exporter-settings>>.
 
 [[local-exporter-cleaner]]
-==== Cleaner Service
+==== Cleaner service
 
 One feature of the `local` exporter, which is not present in the `http` exporter, 
 is a cleaner service. The cleaner service runs once per day at 01:00 AM UTC on 
diff --git a/docs/reference/monitoring/overview.asciidoc b/docs/reference/monitoring/overview.asciidoc
@@ -0,0 +1,42 @@
+[role="xpack"]
+[[monitoring-overview]]
+== Monitoring overview
+++++
+<titleabbrev>Overview</titleabbrev>
+++++
+
+When you monitor a cluster, you collect data from the {es} nodes, {ls} nodes,
+{kib} instances, and Beats in your cluster.
+
+All of the monitoring metrics are stored in {es}, which enables you to easily
+visualize the data from {kib}. By default, the monitoring metrics are stored in
+local indices.
+
+TIP: In production, we strongly recommend using a separate monitoring cluster.
+Using a separate monitoring cluster prevents production cluster outages from
+impacting your ability to access your monitoring data. It also prevents
+monitoring activities from impacting the performance of your production cluster.
+For the same reason, we also recommend to use a separate {kib} instance for
+viewing the monitoring data.
+
+The following diagram illustrates a typical monitoring architecture with separate
+production and monitoring clusters:
+
+image::monitoring/images/architecture10.png["A typical monitoring environment"]
+
+beta[] In 6.4 and later, you can use {metricbeat} to collect and ship data about
+{kib}, rather than routing it through {es}. In 6.5 and later, you can also use
+{metricbeat} to collect and ship data about {es}. For example:
+
+image::monitoring/images/architecture20.png[A typical monitoring environment that includes {metricbeat}]
+
+If you have the appropriate license, you can route data from multiple production
+clusters to a single monitoring cluster. For more information about the
+differences between various subscription levels, see:
+https://www.elastic.co/subscriptions
+
+IMPORTANT: In general, the monitoring cluster and the clusters being monitored
+should be running the same version of the stack. A monitoring cluster cannot
+monitor production clusters running newer versions of the stack. If necessary,
+the monitoring cluster can monitor production clusters running older versions,
+but the versions cannot differ by more than one major version.
diff --git a/docs/reference/monitoring/pause-export.asciidoc b/docs/reference/monitoring/pause-export.asciidoc
@@ -1,7 +1,7 @@
 [role="xpack"]
 [testenv="basic"]
 [[pause-export]]
-== Pausing Data Collection
+=== Pausing data collection
 
 To stop generating {monitoring} data in {es}, disable data collection:
 
diff --git a/docs/reference/monitoring/tribe.asciidoc b/docs/reference/monitoring/tribe.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[monitoring-tribe]]
-=== Configuring a Tribe Node to Work with Monitoring
+=== Configuring a tribe node to work with monitoring
 
 If you connect to a cluster through a <<modules-tribe,tribe node>>,
 and you want to monitor the tribe node, then you will need to install {xpack} on
diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc
@@ -550,3 +550,12 @@ See <<commands>>.
 
 See <<api-definitions>>.
 
+[role="exclude",id="configuring-monitoring"]
+=== Configuring monitoring in {es}
+
+See <<monitoring-overview>>.
+
+[role="exclude",id="es-monitoring"]
+=== Monitoring {es}
+
+See <<monitor-elasticsearch-cluster>>.
diff --git a/docs/reference/settings/configuring-xes.asciidoc b/docs/reference/settings/configuring-xes.asciidoc
@@ -10,5 +10,6 @@
 include::{asciidoc-dir}/../../shared/settings65.asciidoc[]
 include::license-settings.asciidoc[]
 include::ml-settings.asciidoc[]
+include::monitoring-settings.asciidoc[]
 include::notification-settings.asciidoc[]
 include::sql-settings.asciidoc[]
diff --git a/docs/reference/setup/setup-xes.asciidoc b/docs/reference/setup/setup-xes.asciidoc
@@ -13,7 +13,6 @@ functionality of the {xpack} components. For more information, see
 https://www.elastic.co/subscriptions.
 
 * <<installing-xpack-es>>
-* <<configuring-monitoring>>
 * <<configuring-security>>
 * <<setup-xpack-client>>
 * <<settings-xpack>>
diff --git a/x-pack/docs/en/security/tribe-clients-integrations/monitoring.asciidoc b/x-pack/docs/en/security/tribe-clients-integrations/monitoring.asciidoc
@@ -17,7 +17,7 @@ with the monitoring cluster.
 
 For more information, see:
 
-* {ref}/configuring-monitoring.html[Configuring monitoring in {es}]
+* {ref}/monitor-elasticsearch-cluster.html[Monitor a cluster]
 * {kibana-ref}/monitoring-xpack-kibana.html[Configuring monitoring in {kib}]
 * {logstash-ref}/configuring-logstash.html[Configuring monitoring for Logstash nodes]
 
