Skip to content

Commit

Permalink
Updating monitoring docs with direct monitoring configuration (#11678)
Browse files Browse the repository at this point in the history
* Updating monitoring docs with direct monitoring configuration

* [DOCS] Fixes outdated terms and links
  • Loading branch information
ycombinator authored Apr 6, 2019
1 parent 5554677 commit aa8df15
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions libbeat/docs/monitoring/monitoring-beats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
[partintro]
--

NOTE: {monitoring} for {beatname_uc} requires {es} {beat_monitoring_version} or later.
NOTE: The {monitor-features} for {beatname_uc} require {es} {beat_monitoring_version} or later.

{monitoring} enables you to easily monitor {beatname_uc} from {kib}. For more
The {stack} {monitor-features} enable you to easily monitor {beatname_uc} from {kib}. For more
information, see
{xpack-ref}/xpack-monitoring.html[Monitoring the Elastic Stack] and
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}] and
{kibana-ref}/beats-page.html[Beats Monitoring Metrics].

To configure {beatname_uc} to collect and send monitoring metrics:
Expand All @@ -30,35 +30,34 @@ To configure {beatname_uc} to collect and send monitoring metrics:
data to {es}. For example, you can use the built-in +{beat_monitoring_user}+ user or
assign the built-in +{beat_monitoring_user}+ role to another user. For more
information, see
{xpack-ref}/setting-up-authentication.html[Setting Up User Authentication] and
{xpack-ref}/built-in-roles.html[Built-in Roles].
{stack-ov}/setting-up-authentication.html[Setting Up User Authentication] and
{stack-ov}/built-in-roles.html[Built-in Roles].

. Add the `xpack.monitoring` settings in the {beatname_uc} configuration file. If you
configured {es} output, specify the following minimal configuration:
. Add the `monitoring` settings in the {beatname_uc} configuration file. If you
configured the {es} output and want to send {beatname_uc} monitoring events to
the same {es} cluster, specify the following minimal configuration:
+
--
[source, yml]
--------------------
xpack.monitoring.enabled: true
monitoring.enabled: true
--------------------

If you configured a different output, such as {ls}, you must specify additional
configuration options. For example:
If you configured a different output, such as {ls} or you want to send {beatname_uc}
monitoring events to a separate {es} cluster (referred to as the _monitoring cluster_),
you must specify additional configuration options. For example:

["source","yml",subs="attributes"]
--------------------
xpack.monitoring:
monitoring:
enabled: true
elasticsearch:
hosts: ["https://example.com:9200", "https://example2.com:9200"]
hosts: ["https://example.com:9200", "https://example2.com:9200"] <1>
username: {beat_monitoring_user}
password: somepassword
--------------------

NOTE: Currently you must send monitoring data to the same cluster as all other events.
If you configured {es} output, do not specify additional hosts in the monitoring
configuration.

<1> This setting identifies the hosts and port numbers of {es} nodes
that are part of the monitoring cluster.
--

. {kibana-ref}/monitoring-xpack-kibana.html[Configure monitoring in {kib}].
Expand Down

0 comments on commit aa8df15

Please sign in to comment.