96 lines
3.6 KiB
Plaintext
96 lines
3.6 KiB
Plaintext
[[monitoring-settings]]
|
|
== Monitoring Settings
|
|
|
|
Monitoring is enabled by default when you install {xpack}. You configure
|
|
<<monitoring-collection-settings, `xpack.monitoring.collection`>>
|
|
settings in `elasticsearch.yml` to control how data is collected from your
|
|
Elasticsearch nodes.
|
|
|
|
To adjust how monitoring data is displayed in the Monitoring UI, you configure
|
|
{kibana-ref}/monitoring-settings-kb.html[`xpack.monitoring` settings] in
|
|
`kibana.yml`. To control how monitoring data is collected from
|
|
Logstash, you configure {logstash-ref}/settings-xpack.html#monitoring-settings[
|
|
`xpack.monitoring` settings] in `logstash.yml`.
|
|
|
|
For more information, see
|
|
{xpack-ref}/xpack-monitoring.html[Monitoring the Elastic Stack].
|
|
|
|
[float]
|
|
[[general-monitoring-settings]]
|
|
=== General Monitoring Settings
|
|
`xpack.monitoring.enabled`::
|
|
Set to `false` to disable {es} {monitoring} for Elasticsearch.
|
|
|
|
[float]
|
|
[[monitoring-collection-settings]]
|
|
=== Monitoring Collection Settings
|
|
|
|
`xpack.monitoring.collection.cluster.state.timeout`::
|
|
|
|
Sets the timeout for collecting the cluster state. Defaults to `10m`.
|
|
|
|
`xpack.monitoring.collection.cluster.stats.timeout`::
|
|
|
|
Sets the timeout for collecting the cluster statistics. Defaults to `10m`.
|
|
|
|
`xpack.monitoring.collection.indices`::
|
|
|
|
Controls which indices Monitoring collects data from. Defaults to all indices. Specify the index names
|
|
as a comma-separated list, for example `test1,test2,test3`. Names can include wildcards, for
|
|
example `test*`. You can explicitly include or exclude indices by prepending
|
|
`+` to include the index, or `-` to exclude the index. For example, to include all indices that
|
|
start with `test` except `test3`, you could specify `+test*,-test3`.
|
|
+
|
|
You can update this setting through the Cluster Update Settings API.
|
|
|
|
`xpack.monitoring.collection.index.stats.timeout`::
|
|
|
|
Sets the timeout for collecting index statistics. Defaults to `10m`.
|
|
|
|
`xpack.monitoring.collection.indices.stats.timeout`::
|
|
|
|
Sets the timeout for collecting total indices statistics. Defaults to `10m`.
|
|
|
|
`xpack.monitoring.exporters` ::
|
|
|
|
Configures where the agent stores monitoring data. By default, the agent uses a local exporter that
|
|
indexes monitoring data on the cluster where it is installed. Use an HTTP exporter to send data to
|
|
a separate monitoring cluster. For more information, see {xpack-ref}/monitoring-cluster.html[Setting
|
|
up a Separate Monitoring Cluster].
|
|
|
|
`xpack.monitoring.collection.index.recovery.active_only`::
|
|
|
|
Controls whether or not all recoveries are collected. Set to `true` to
|
|
collect only active recoveries. Defaults to `false`.
|
|
|
|
`xpack.monitoring.collection.index.recovery.timeout`::
|
|
|
|
Sets the timeout for collecting the recovery information. Defaults to `10m`.
|
|
|
|
`xpack.monitoring.collection.interval`::
|
|
|
|
Controls how often data samples are collected. Defaults to `10s`. If you
|
|
modify the collection interval, set the `xpack.monitoring.min_interval_seconds`
|
|
option in `kibana.yml` to the same value. Set to `-1` to temporarily disable
|
|
data collection. You can update this setting through the Cluster Update
|
|
Settings API.
|
|
|
|
`xpack.monitoring.history.duration`::
|
|
|
|
Sets the retention duration beyond which the indices created by a Monitoring exporter will
|
|
be automatically deleted. Defaults to `7d` (7 days).
|
|
+
|
|
This setting has a minimum value of `1d` (1 day) to ensure that something is being monitored,
|
|
and it cannot be disabled.
|
|
+
|
|
IMPORTANT: This setting currently only impacts `local`-type exporters. Indices created using
|
|
the `http` exporter will not be deleted automatically.
|
|
|
|
|
|
[[ssl-monitoring-settings]]
|
|
:ssl-prefix: xpack.monitoring.exporters.$NAME
|
|
:component: {monitoring}
|
|
:verifies:
|
|
:server!:
|
|
|
|
include::ssl-settings.asciidoc[] |