mirror of
https://github.com/elastic/logstash.git
synced 2025-04-24 14:47:19 -04:00
126 lines
4.4 KiB
Text
126 lines
4.4 KiB
Text
[role="xpack"]
|
||
[[monitoring-settings]]
|
||
==== Monitoring settings for internal collection
|
||
experimental[]
|
||
++++
|
||
<titleabbrev>Monitoring Settings</titleabbrev>
|
||
++++
|
||
|
||
You can set the following `monitoring` settings in `logstash.yml` to
|
||
control how monitoring data is collected from your Logstash nodes. However, the
|
||
defaults work best in most circumstances. For more information about configuring
|
||
Logstash, see <<logstash-settings-file>>.
|
||
|
||
|
||
[[monitoring-general-settings]]
|
||
===== General monitoring settings
|
||
|
||
`monitoring.enabled`::
|
||
|
||
Monitoring is disabled by default. Set to `true` to enable monitoring.
|
||
|
||
`monitoring.elasticsearch.hosts`::
|
||
|
||
The {es} monitoring cluster that you want to ship your Logstash metrics to. This
|
||
might be the same {es} instance specified in the `outputs` section in your
|
||
Logstash configuration, or a dedicated monitoring cluster. You can specify a
|
||
single host as a string, or specify multiple hosts as an array. Defaults to
|
||
`http://localhost:9200`.
|
||
|
||
NOTE: If your Elasticsearch monitoring cluster is configured with dedicated
|
||
master-eligible nodes, Logstash metrics should _not_ be routed to these nodes.
|
||
Doing so can create resource contention and impact the stability of the
|
||
Elasticsearch cluster. Therefore, do not include such nodes in
|
||
`monitoring.elasticsearch.hosts`.
|
||
|
||
`monitoring.elasticsearch.username` and `monitoring.elasticsearch.password`::
|
||
|
||
If your {es} is protected with basic authentication, these settings provide the
|
||
username and password that the Logstash instance uses to authenticate for
|
||
shipping monitoring data.
|
||
|
||
`monitoring.elasticsearch.proxy`::
|
||
|
||
Optional setting that allows you to specify a proxy URL if Logstash needs to use a proxy
|
||
to reach your Elasticsearch cluster.
|
||
|
||
[[monitoring-collection-settings]]
|
||
===== Monitoring collection settings
|
||
|
||
`monitoring.collection.interval`::
|
||
|
||
Controls how often data samples are collected and shipped on the Logstash side.
|
||
Defaults to `10s`. If you modify the collection interval, set the
|
||
`monitoring.min_interval_seconds` option in `kibana.yml` to the same value.
|
||
|
||
[[monitoring-cluster-uuid]]
|
||
`monitoring.cluster_uuid`::
|
||
|
||
The universally unique identifier (UUID) for the monitoring cluster.
|
||
By default, {ls} identifies and uses the `cluster uuid` value from each
|
||
elasticsearch output defined in the pipelines, and ignores this
|
||
setting.
|
||
+
|
||
If no `cluster_uuid` is discovered in elasticsearch outputs, then {ls}
|
||
uses this value to tag the data shipped to the monitoring cluster.
|
||
|
||
[[monitoring-ssl-settings]]
|
||
===== Monitoring TLS/SSL settings
|
||
|
||
You can configure the following Transport Layer Security (TLS) or
|
||
Secure Sockets Layer (SSL) settings. For more information, see
|
||
<<ls-monitoring-user>>.
|
||
|
||
`monitoring.elasticsearch.ssl.certificate_authority`::
|
||
|
||
Optional setting that enables you to specify a path to the `.pem` file for the
|
||
certificate authority for your {es} instance.
|
||
|
||
`monitoring.elasticsearch.ssl.truststore.path`::
|
||
|
||
Optional settings that provide the paths to the Java keystore (JKS) to validate
|
||
the server’s certificate.
|
||
|
||
`monitoring.elasticsearch.ssl.truststore.password`::
|
||
|
||
Optional settings that provide the password to the truststore.
|
||
|
||
`monitoring.elasticsearch.ssl.keystore.path`::
|
||
|
||
Optional settings that provide the paths to the Java keystore (JKS) to validate
|
||
the client’s certificate.
|
||
|
||
`monitoring.elasticsearch.ssl.keystore.password`::
|
||
|
||
Optional settings that provide the password to the keystore.
|
||
|
||
`monitoring.elasticsearch.ssl.verification_mode`::
|
||
|
||
Option to validate the server’s certificate. Defaults to `certificate`. To
|
||
disable, set to `none`. Disabling this severely compromises security.
|
||
|
||
`monitoring.elasticsearch.sniffing`::
|
||
|
||
Finds all {es} cluster nodes and adds them to the hosts list.
|
||
Defaults to `false`.
|
||
|
||
[[monitoring-additional-settings]]
|
||
===== Additional settings
|
||
|
||
`monitoring.elasticsearch.cloud_id`::
|
||
|
||
If you're using {es} in {ecloud}, you should specify the identifier here.
|
||
This setting is an alternative to `monitoring.elasticsearch.hosts`.
|
||
If `cloud_id` is configured, `monitoring.elasticsearch.hosts` should not be used.
|
||
The {es} instances that you want to ship your Logstash metrics to. This might be
|
||
the same {es} instance specified in the `outputs` section in your Logstash
|
||
configuration, or a different one.
|
||
|
||
`monitoring.elasticsearch.cloud_auth`::
|
||
|
||
If you're using {es} in {ecloud}, you can set your auth credentials here.
|
||
This setting is an alternative to both `monitoring.elasticsearch.username`
|
||
and `monitoring.elasticsearch.password`. If `cloud_auth` is configured,
|
||
those settings should not be used.
|
||
|
||
|