Skip to content

Commit

Permalink
[DOCS] Clarify changes in monitoring settings (elastic#15003)
Browse files Browse the repository at this point in the history
* [DOCS] Clarify changes in monitoring settings

* Change topic names and order

* Add more fixes from the review

* Update libbeat/docs/monitoring/monitoring-beats.asciidoc
  • Loading branch information
dedemorton committed Jan 14, 2020
1 parent 8645e5f commit 6e79f12
Show file tree
Hide file tree
Showing 7 changed files with 202 additions and 340 deletions.
24 changes: 9 additions & 15 deletions libbeat/docs/monitoring/monitoring-beats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,14 @@ You can use the {stack} {monitor-features} to gain insight into the health of
{beatname_uc} agents running in your environment.

To monitor {beatname_uc}, make sure monitoring is enabled on your {es} cluster,
then configure the method used to collect {beatname_uc} metrics. You
ifndef::serverless[]
can use one of following methods:
endif::[]
ifdef::serverless[]
can use the following method:
endif::[]

* <<monitoring-internal-collection,Internal collection>>
ifndef::serverless[]
* <<monitoring-metricbeat-collection, {metricbeat} collection>>
endif::[]
then configure the method used to collect {beatname_uc} metrics. You can use one
of following methods:

* <<monitoring-internal-collection,Internal collection>> - Internal
collectors send monitoring data directly to your monitoring cluster.
* <<monitoring-internal-collection-legacy,Legacy internal collection (deprecated)>> -
Legacy internal collectors send monitoring data to your production cluster.


To learn about monitoring in general, see
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
Expand All @@ -29,6 +25,4 @@ To learn about monitoring in general, see

include::monitoring-internal-collection.asciidoc[]

ifndef::serverless[]
include::monitoring-metricbeat.asciidoc[]
endif::[]
include::monitoring-internal-collection-legacy.asciidoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
//////////////////////////////////////////////////////////////////////////
//// This content is shared by all Elastic Beats. Make sure you keep the
//// descriptions here generic enough to work for all Beats that include
//// this file. When using cross references, make sure that the cross
//// references resolve correctly for any files that include this one.
//// Use the appropriate variables defined in the index.asciidoc file to
//// resolve Beat names: beatname_uc and beatname_lc.
//// Use the following include to pull this content into a doc file:
//// include::../../libbeat/docs/monitoring/monitoring-internal-collection-legacy.asciidoc[]
//////////////////////////////////////////////////////////////////////////

[role="xpack"]
[[monitoring-internal-collection-legacy]]
== Use legacy internal collection to send monitoring data
++++
<titleabbrev>Legacy internal collection (deprecated)</titleabbrev>
++++

deprecated[7.2.0]

In {beatname_uc} version 7.1 and earlier, you configured internal collectors
that sent monitoring data to the production cluster, which would either index
the data locally, or forward the data to a dedicated monitoring cluster via HTTP
exporters.

Starting in {beatname_uc} version 7.2, the legacy settings for internal
collection are deprecated and will be removed in version 8.0.0. Instead of
sending monitoring data to your production cluster, it's recommended that you
use the configuration described under
<<monitoring-internal-collection,internal collection>> to route
monitoring data directly to your monitoring cluster.

include::shared-monitor-config-legacy.asciidoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,13 @@

[role="xpack"]
[[monitoring-internal-collection]]
== Collect {beatname_uc} monitoring data with internal collectors
== Use internal collection to send monitoring data
++++
<titleabbrev>Internal collection</titleabbrev>
++++

The following method involves sending the metrics to the production cluster,
which ultimately routes them to the monitoring cluster.
ifndef::serverless[]
For an alternative method, see <<monitoring-metricbeat-collection>>.
endif::[]
Use internal collectors to send {beats} monitoring data directly to your
monitoring cluster.

To learn about monitoring in general, see
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
Expand Down
252 changes: 0 additions & 252 deletions libbeat/docs/monitoring/monitoring-metricbeat.asciidoc

This file was deleted.

Loading

0 comments on commit 6e79f12

Please sign in to comment.