From 905ca441e70009b905c8ed56fd877feb7d51504b Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 26 Sep 2019 12:50:17 -0700 Subject: [PATCH] Removes redundant monitoring pages --- .../monitoring/how-monitoring-works.asciidoc | 33 ----- docs/en/stack/monitoring/index.asciidoc | 5 +- docs/en/stack/monitoring/intro.asciidoc | 5 +- docs/en/stack/monitoring/production.asciidoc | 124 ------------------ docs/en/stack/redirects.asciidoc | 18 +++ 5 files changed, 20 insertions(+), 165 deletions(-) delete mode 100644 docs/en/stack/monitoring/how-monitoring-works.asciidoc delete mode 100644 docs/en/stack/monitoring/production.asciidoc diff --git a/docs/en/stack/monitoring/how-monitoring-works.asciidoc b/docs/en/stack/monitoring/how-monitoring-works.asciidoc deleted file mode 100644 index 4c1b834ae..000000000 --- a/docs/en/stack/monitoring/how-monitoring-works.asciidoc +++ /dev/null @@ -1,33 +0,0 @@ -[role="xpack"] -[[how-monitoring-works]] -== How monitoring works - -Monitoring collects data from {es} nodes, Logstash nodes, {kib} instances, and -Beats. - -In general, the {es} cluster you are monitoring controls where the monitoring -metrics for the stack are stored. By default, they 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 using a separate Kibana instance for -viewing the monitoring data. - -You can use {metricbeat} to collect and ship data about {es}, {kib}, {ls}, and -Beats directly to your monitoring cluster rather than routing it through your -production cluster. The following diagram illustrates a typical monitoring -architecture with separate production and monitoring clusters: - -image::monitoring/images/architecture30.png[A typical monitoring environment] - -If you have at least a gold 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 the latest -release of the previous major version. diff --git a/docs/en/stack/monitoring/index.asciidoc b/docs/en/stack/monitoring/index.asciidoc index 50e9a7e0a..20536805d 100644 --- a/docs/en/stack/monitoring/index.asciidoc +++ b/docs/en/stack/monitoring/index.asciidoc @@ -1,5 +1,2 @@ include::intro.asciidoc[] -include::how-monitoring-works.asciidoc[] -include::production.asciidoc[] -include::esms.asciidoc[] -include::troubleshooting.asciidoc[] \ No newline at end of file +include::esms.asciidoc[] \ No newline at end of file diff --git a/docs/en/stack/monitoring/intro.asciidoc b/docs/en/stack/monitoring/intro.asciidoc index 437dec86e..70ea21b29 100644 --- a/docs/en/stack/monitoring/intro.asciidoc +++ b/docs/en/stack/monitoring/intro.asciidoc @@ -15,9 +15,7 @@ monitoring indices. For more information, see: -* <> -* <> -* {ref}/es-monitoring.html[Monitoring {es}] +* {ref}/monitor-elasticsearch-cluster.html[Monitoring a cluster] * {kibana-ref}/xpack-monitoring.html[Monitoring {kib}] * {logstash-ref}/monitoring-logstash.html[Monitoring {ls}] * Monitoring Beats: @@ -30,5 +28,4 @@ For more information, see: ** {winlogbeat-ref}/monitoring.html[{winlogbeat}] - -- diff --git a/docs/en/stack/monitoring/production.asciidoc b/docs/en/stack/monitoring/production.asciidoc deleted file mode 100644 index b38eef8c6..000000000 --- a/docs/en/stack/monitoring/production.asciidoc +++ /dev/null @@ -1,124 +0,0 @@ -[role="xpack"] -[[monitoring-production]] -== Monitoring in a production environment - -In production, you should send monitoring data to a separate _monitoring cluster_ -so that historical data is available even when the nodes you are monitoring are -not. For example, you can use {metricbeat} to ship monitoring data about {kib}, -{es}, {ls}, and Beats to the monitoring cluster. If you are sending your data to -the {esms-init}, see <>. - -If you have at least a gold license, using a dedicated monitoring cluster also -enables you to monitor multiple clusters from a central location. - -To store monitoring data in a separate cluster: - -. Set up the {es} cluster you want to use as the monitoring cluster. -For example, you might set up a two host cluster with the nodes `es-mon-1` and -`es-mon-2`. -+ --- -[IMPORTANT] -=============================== -* To monitor an {es} {major-version} cluster, you must run {es} {major-version} -on the monitoring cluster. -* There must be at least one {ref}/ingest.html[ingest node] in the monitoring -cluster; it does not need to be a dedicated ingest node. -=============================== --- - -.. (Optional) Verify that the collection of monitoring data is disabled on the -monitoring cluster. By default, the `xpack.monitoring.collection.enabled` setting -is `false`. -+ --- -For example, you can use the following APIs to review and change this setting: - -[source,js] ----------------------------------- -GET _cluster/settings - -PUT _cluster/settings -{ - "persistent": { - "xpack.monitoring.collection.enabled": false - } -} ----------------------------------- -// CONSOLE --- - -.. If the {es} {security-features} are enabled on the monitoring cluster, create -users that can send and retrieve monitoring data. -+ --- -NOTE: If you plan to use {kib} to view monitoring data, username and password -credentials must be valid on both the {kib} server and the monitoring cluster. - --- - -*** If you plan to use {metricbeat} to collect data about {es} or {kib}, -create a user that has the `remote_monitoring_collector` built-in role and a -user that has the `remote_monitoring_agent` -<>. Alternatively, use the -`remote_monitoring_user` <>. - -*** If you plan to use HTTP exporters to route data through your production -cluster, create a user that has the `remote_monitoring_agent` -<>. -+ --- -For example, the -following request creates a `remote_monitor` user that has the -`remote_monitoring_agent` role: - -[source, sh] ---------------------------------------------------------------- -POST /_security/user/remote_monitor -{ - "password" : "changeme", - "roles" : [ "remote_monitoring_agent"], - "full_name" : "Internal Agent For Remote Monitoring" -} ---------------------------------------------------------------- -// CONSOLE -// TEST[skip:needs-gold+-license] - -Alternatively, use the `remote_monitoring_user` <>. --- - -. Configure your production cluster to collect data and send it to the -monitoring cluster. - -** {ref}/configuring-metricbeat.html[Use {metricbeat}]. - -** {ref}/configuring-monitoring.html[Use HTTP exporters]. - -. (Optional) -{logstash-ref}/configuring-logstash.html[Configure {ls} to collect data and send it to the monitoring cluster]. - -. (Optional) Configure the Beats to collect data and send it to the monitoring -cluster. -** {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] - -. (Optional) Configure {kib} to collect data and send it to the monitoring cluster: - -** {kibana-ref}/monitoring-metricbeat.html[Use {metricbeat}]. - -** {kibana-ref}/monitoring-kibana.html[Use HTTP exporters]. - -. (Optional) Create a dedicated {kib} instance for monitoring, rather than using -a single {kib} instance to access both your production cluster and monitoring -cluster. - -.. (Optional) Disable the collection of monitoring data in this {kib} instance. -Set the `xpack.monitoring.kibana.collection.enabled` setting to `false` in the -`kibana.yml` file. For more information about this setting, see -{kibana-ref}/monitoring-settings-kb.html[Monitoring settings in {kib}]. - -. {kibana-ref}/monitoring-data.html[Configure {kib} to retrieve and display the monitoring data]. diff --git a/docs/en/stack/redirects.asciidoc b/docs/en/stack/redirects.asciidoc index 1154834d8..23216eaa6 100644 --- a/docs/en/stack/redirects.asciidoc +++ b/docs/en/stack/redirects.asciidoc @@ -101,3 +101,21 @@ See {ref}/remote-recovery.html[Remote recovery]. This page has moved. See {ref}/ccr-upgrading.html[Upgrading clusters]. + +[role="exclude",id="monitoring-production"] +=== Monitoring in a production environment + +This page has moved. +// See {ref}/monitoring-production.html[Monitoring in a production environment]. + +[role="exclude",id="how-monitoring-works"] +=== How monitoring works + +This page has moved. +See {ref}/how-monitoring-works.html[How monitoring works]. + +[role="exclude",id="monitoring-troubleshooting"] +== Troubleshooting monitoring + +This page has moved. +// See {ref}/monitoring-troubleshooting.html[Troubleshooting monitoring]. \ No newline at end of file