Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify monitoring and monitoring.collection #9905

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify monitoring and monitoring.collection #9905

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions docs/static/monitoring/configuring-logstash.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,32 @@ monitoring cluster will show the Logstash metrics under the _monitoring_ cluster

. Verify that the `xpack.monitoring.collection.enabled` setting is `true` on the
production cluster. If that setting is `false`, the collection of monitoring data
is disabled in {es} and data is ignored from all other sources.

. Configure your Logstash nodes to send metrics by setting the
`xpack.monitoring.elasticsearch.url` in `logstash.yml`. If {security} is enabled,
you also need to specify the credentials for the
{stack-ov}/built-in-users.html[built-in `logstash_system` user]. For more information about these settings, see <<monitoring-settings>>.
is disabled in {es} and data is ignored from all other sources.

. Configure your Logstash nodes to send metrics.
Set `xpack.monitoring.enabled` to `true` and set the
`xpack.monitoring.elasticsearch.url` in `logstash.yml`. If {security} is
enabled, you also need to specify the credentials for the
{stack-ov}/built-in-users.html[built-in `logstash_system` user]. For more
information about these settings, see <<monitoring-settings>>.
+
--
[source,yaml]
--------------------------------------------------
xpack.monitoring.elasticsearch.url: ["http://es-prod-node-1:9200", "http://es-prod-node-2:9200"] <1>
xpack.monitoring.elasticsearch.username: "logstash_system" <2>
xpack.monitoring.enabled: true <1>
xpack.monitoring.elasticsearch.url: ["http://es-prod-node-1:9200", "http://es-prod-node-2:9200"] <2>
xpack.monitoring.elasticsearch.username: "logstash_system" <3>
xpack.monitoring.elasticsearch.password: "changeme"
--------------------------------------------------
<1> If SSL/TLS is enabled on the production cluster, you must
<1> Turns monitoring on. Note that the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, this doesn't really make clear that it's a two-part problem. The clarifying "note" tells me that Elasticsearch needs to be configured in a certain way, but by the time we're here my head is entirely in configure-logstash mode (which means I assume this is still a setting that goes in the logstash.yml).

<1> Turns monitoring on in Logstash, enabling Logstash to send monitoring data to Elasticseach. Note that Elasticsearch will ignore any monitoring events it receives unless it is separately configured with xpack.monitoring.collection.enabled: true.

Elasticsearch `xpack.monitoring.collection.enabled: true` setting in the previous
step is needed to start data collection.
<2> If SSL/TLS is enabled on the production cluster, you must
connect through HTTPS. As of v5.2.1, you can specify multiple
Elasticsearch hosts as an array as well as specifying a single
host as a string. If multiple URLs are specified, Logstash
can round-robin requests to these production nodes.
<2> If {security} is disabled on the production cluster, you can omit these
<3> If {security} is disabled on the production cluster, you can omit these
`username` and `password` settings.
--

Expand Down