2017-06-27 12:14:35 -04:00
|
|
|
[role="xpack"]
|
2017-04-06 20:34:23 -04:00
|
|
|
[[monitoring-settings]]
|
2019-03-14 17:22:06 -04:00
|
|
|
=== Monitoring settings in Elasticsearch
|
2017-08-11 13:00:35 -04:00
|
|
|
++++
|
2018-10-25 13:32:50 -04:00
|
|
|
<titleabbrev>Monitoring settings</titleabbrev>
|
2017-08-11 13:00:35 -04:00
|
|
|
++++
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2018-03-20 14:26:34 -04:00
|
|
|
By default, monitoring is enabled but data collection is disabled. To enable
|
|
|
|
data collection, use the `xpack.monitoring.collection.enabled` setting.
|
2018-02-21 23:10:20 -05:00
|
|
|
|
2019-04-03 14:55:25 -04:00
|
|
|
You can configure these monitoring settings in the `elasticsearch.yml` file. You
|
|
|
|
can also dynamically set some of these settings using the
|
2018-03-20 14:26:34 -04:00
|
|
|
<<cluster-update-settings,cluster update settings API>>.
|
|
|
|
|
|
|
|
TIP: Cluster settings take precedence over settings in the `elasticsearch.yml`
|
|
|
|
file.
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2017-07-26 13:25:16 -04:00
|
|
|
To adjust how monitoring data is displayed in the monitoring UI, configure
|
2017-06-23 14:21:07 -04:00
|
|
|
{kibana-ref}/monitoring-settings-kb.html[`xpack.monitoring` settings] in
|
2020-03-17 14:38:50 -04:00
|
|
|
`kibana.yml`. To control how monitoring data is collected from Logstash,
|
|
|
|
configure monitoring settings in `logstash.yml`.
|
2017-06-23 14:21:07 -04:00
|
|
|
|
2019-10-07 18:23:19 -04:00
|
|
|
For more information, see <<monitor-elasticsearch-cluster>>.
|
2017-04-06 20:34:23 -04:00
|
|
|
|
|
|
|
[float]
|
|
|
|
[[general-monitoring-settings]]
|
2017-06-27 12:14:35 -04:00
|
|
|
==== General Monitoring Settings
|
2019-04-03 14:55:25 -04:00
|
|
|
|
2017-04-06 20:34:23 -04:00
|
|
|
`xpack.monitoring.enabled`::
|
2020-04-17 15:04:17 -04:00
|
|
|
deprecated:[7.8.0,Basic License features should always be enabled] +
|
2020-05-01 16:42:11 -04:00
|
|
|
This deprecated setting has no effect.
|
2017-04-06 20:34:23 -04:00
|
|
|
|
|
|
|
[float]
|
|
|
|
[[monitoring-collection-settings]]
|
2017-06-27 12:14:35 -04:00
|
|
|
==== Monitoring Collection Settings
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2017-07-26 13:25:16 -04:00
|
|
|
The `xpack.monitoring.collection` settings control how data is collected from
|
2019-04-03 14:55:25 -04:00
|
|
|
your Elasticsearch nodes. You can dynamically change all monitoring collection
|
|
|
|
settings using the <<cluster-update-settings,cluster update settings API>>.
|
2017-07-26 13:25:16 -04:00
|
|
|
|
2018-11-01 14:50:30 -04:00
|
|
|
`xpack.monitoring.collection.enabled` (<<cluster-update-settings,Dynamic>>)::
|
2018-02-21 23:10:20 -05:00
|
|
|
|
2018-03-20 14:26:34 -04:00
|
|
|
added[6.3.0] Set to `true` to enable the collection of monitoring data. When
|
|
|
|
this setting is `false` (default), {es} monitoring data is not collected and
|
|
|
|
all monitoring data from other sources such as {kib}, Beats, and Logstash is
|
|
|
|
ignored.
|
2018-02-21 23:10:20 -05:00
|
|
|
|
2020-02-03 08:42:30 -05:00
|
|
|
`xpack.monitoring.collection.interval` (<<cluster-update-settings,Dynamic>>)::
|
2018-02-26 20:53:09 -05:00
|
|
|
|
|
|
|
Setting to `-1` to disable data collection is no longer supported beginning with
|
2019-04-30 09:58:09 -04:00
|
|
|
7.0.0. deprecated[6.3.0, Use `xpack.monitoring.collection.enabled` set to `false` instead.]
|
2018-02-26 20:53:09 -05:00
|
|
|
+
|
|
|
|
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.
|
|
|
|
|
2018-11-01 14:50:30 -04:00
|
|
|
`xpack.monitoring.elasticsearch.collection.enabled` (<<cluster-update-settings,Dynamic>>)::
|
2018-09-17 21:33:43 -04:00
|
|
|
|
|
|
|
Controls whether statistics about your {es} cluster should be collected. Defaults to `true`.
|
|
|
|
This is different from xpack.monitoring.collection.enabled, which allows you to enable or disable
|
|
|
|
all monitoring collection. However, this setting simply disables the collection of Elasticsearch
|
|
|
|
data while still allowing other data (e.g., Kibana, Logstash, Beats, or APM Server monitoring data)
|
|
|
|
to pass through this cluster.
|
|
|
|
|
2019-04-03 14:55:25 -04:00
|
|
|
`xpack.monitoring.collection.cluster.stats.timeout` (<<cluster-update-settings,Dynamic>>)::
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2019-04-01 08:47:12 -04:00
|
|
|
(<<time-units,time value>>) Timeout for collecting the cluster statistics. Defaults to `10s`.
|
2019-03-18 03:59:02 -04:00
|
|
|
|
2019-04-03 14:55:25 -04:00
|
|
|
`xpack.monitoring.collection.node.stats.timeout` (<<cluster-update-settings,Dynamic>>)::
|
2019-03-18 03:59:02 -04:00
|
|
|
|
2019-04-01 08:47:12 -04:00
|
|
|
(<<time-units,time value>>) Timeout for collecting the node statistics. Defaults to `10s`.
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2018-11-01 14:50:30 -04:00
|
|
|
`xpack.monitoring.collection.indices` (<<cluster-update-settings,Dynamic>>)::
|
2017-04-06 20:34:23 -04:00
|
|
|
|
|
|
|
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
|
2019-01-10 18:06:44 -05:00
|
|
|
example `test*`. You can explicitly exclude indices by prepending `-`. For example `test*,-test3` will
|
|
|
|
monitor all indexes that start with `test` except for `test3`. System indices like .security* or .kibana*
|
|
|
|
always start with a `.`, and generally should be monitored. Consider adding `.*` to the list of indices
|
|
|
|
ensure monitoring of system indices. For example `.*,test*,-test3`
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2019-04-03 14:55:25 -04:00
|
|
|
`xpack.monitoring.collection.index.stats.timeout` (<<cluster-update-settings,Dynamic>>)::
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2019-04-01 08:47:12 -04:00
|
|
|
(<<time-units,time value>>) Timeout for collecting index statistics. Defaults to `10s`.
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2019-04-03 14:55:25 -04:00
|
|
|
`xpack.monitoring.collection.index.recovery.active_only` (<<cluster-update-settings,Dynamic>>)::
|
2017-04-06 20:34:23 -04:00
|
|
|
|
|
|
|
Controls whether or not all recoveries are collected. Set to `true` to
|
|
|
|
collect only active recoveries. Defaults to `false`.
|
|
|
|
|
2019-04-03 14:55:25 -04:00
|
|
|
`xpack.monitoring.collection.index.recovery.timeout` (<<cluster-update-settings,Dynamic>>)::
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2019-04-01 08:47:12 -04:00
|
|
|
(<<time-units,time value>>) Timeout for collecting the recovery information. Defaults to `10s`.
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2019-04-03 14:55:25 -04:00
|
|
|
`xpack.monitoring.history.duration` (<<cluster-update-settings,Dynamic>>)::
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2019-04-01 08:47:12 -04:00
|
|
|
(<<time-units,time value>>) Retention duration beyond which the indices created by a Monitoring
|
2017-11-29 11:25:59 -05:00
|
|
|
exporter are automatically deleted. Defaults to `7d` (7 days).
|
2017-04-06 20:34:23 -04:00
|
|
|
+
|
2017-11-29 11:25:59 -05:00
|
|
|
--
|
|
|
|
This setting has a minimum value of `1d` (1 day) to ensure that something is
|
|
|
|
being monitored, and it cannot be disabled.
|
|
|
|
|
2017-04-06 20:34:23 -04:00
|
|
|
IMPORTANT: This setting currently only impacts `local`-type exporters. Indices created using
|
|
|
|
the `http` exporter will not be deleted automatically.
|
2017-11-29 11:25:59 -05:00
|
|
|
--
|
|
|
|
|
2017-07-26 13:25:16 -04:00
|
|
|
`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
|
2019-09-27 17:58:10 -04:00
|
|
|
information, see <<local-exporter-settings,Local exporter settings>>,
|
|
|
|
<<http-exporter-settings,HTTP exporter settings>>, and
|
|
|
|
<<how-monitoring-works>>.
|
2017-07-26 13:25:16 -04:00
|
|
|
|
|
|
|
[float]
|
|
|
|
[[local-exporter-settings]]
|
|
|
|
==== Local Exporter Settings
|
|
|
|
|
|
|
|
The `local` exporter is the default exporter used by Monitoring. As the name is
|
|
|
|
meant to imply, it exports data to the _local_ cluster, which means that there
|
|
|
|
is not much needed to be configured.
|
|
|
|
|
|
|
|
If you do not supply _any_ exporters, then Monitoring will automatically create
|
|
|
|
one for you. If any exporter is provided, then no default is added.
|
|
|
|
|
|
|
|
[source,yaml]
|
|
|
|
----------------------------------
|
|
|
|
xpack.monitoring.exporters.my_local:
|
|
|
|
type: local
|
|
|
|
----------------------------------
|
|
|
|
|
|
|
|
`type`::
|
|
|
|
|
|
|
|
The value for a Local exporter must always be `local` and it is required.
|
|
|
|
|
|
|
|
`use_ingest`::
|
|
|
|
|
|
|
|
Whether to supply a placeholder pipeline to the cluster and a pipeline processor with
|
|
|
|
every bulk request. The default value is `true`. If disabled, then it means that it will not
|
|
|
|
use pipelines, which means that a future release cannot automatically upgrade bulk requests
|
|
|
|
to future-proof them.
|
|
|
|
|
|
|
|
`cluster_alerts.management.enabled`::
|
|
|
|
|
|
|
|
Whether to create cluster alerts for this cluster. The default value is `true`.
|
|
|
|
To use this feature, {watcher} must be enabled. If you have a basic license,
|
|
|
|
cluster alerts are not displayed.
|
|
|
|
|
2020-05-04 15:16:18 -04:00
|
|
|
`wait_master.timeout`::
|
|
|
|
|
|
|
|
(<<time-units,time value>>) Time to wait for the master node to setup `local` exporter for monitoring.
|
|
|
|
After that, the non-master nodes will warn the user for possible missing X-Pack configuration. Defaults to `30s`.
|
|
|
|
|
2017-07-26 13:25:16 -04:00
|
|
|
[float]
|
|
|
|
[[http-exporter-settings]]
|
|
|
|
==== HTTP Exporter Settings
|
|
|
|
|
|
|
|
The following lists settings that can be supplied with the `http` exporter.
|
|
|
|
All settings are shown as what follows the name you select for your exporter:
|
|
|
|
|
|
|
|
[source,yaml]
|
|
|
|
----------------------------------
|
|
|
|
xpack.monitoring.exporters.my_remote:
|
|
|
|
type: http
|
|
|
|
host: ["host:port", ...]
|
|
|
|
----------------------------------
|
|
|
|
|
|
|
|
`type`::
|
|
|
|
|
|
|
|
The value for an HTTP exporter must always be `http` and it is required.
|
|
|
|
|
|
|
|
`host`::
|
|
|
|
|
|
|
|
Host supports multiple formats, both as an array or as a single value. Supported formats include
|
|
|
|
`hostname`, `hostname:port`, `http://hostname` `http://hostname:port`, `https://hostname`, and
|
|
|
|
`https://hostname:port`. Hosts cannot be assumed. The default scheme is always `http` and the default
|
|
|
|
port is always `9200` if not supplied as part of the `host` string.
|
|
|
|
+
|
|
|
|
[source,yaml]
|
|
|
|
----------------------------------
|
|
|
|
xpack.monitoring.exporters:
|
|
|
|
example1:
|
|
|
|
type: http
|
|
|
|
host: "10.1.2.3"
|
|
|
|
example2:
|
|
|
|
type: http
|
|
|
|
host: ["http://10.1.2.4"]
|
|
|
|
example3:
|
|
|
|
type: http
|
|
|
|
host: ["10.1.2.5", "10.1.2.6"]
|
|
|
|
example4:
|
|
|
|
type: http
|
|
|
|
host: ["https://10.1.2.3:9200"]
|
|
|
|
----------------------------------
|
|
|
|
|
|
|
|
`auth.username`::
|
|
|
|
|
2020-02-03 08:42:30 -05:00
|
|
|
The username is required if `auth.secure_password` or `auth.password` is supplied.
|
|
|
|
|
|
|
|
`auth.secure_password` (<<secure-settings,Secure>>, <<reloadable-secure-settings,reloadable>>)::
|
|
|
|
|
|
|
|
The password for the `auth.username`. Takes precedence over `auth.password` if it is also specified.
|
2017-07-26 13:25:16 -04:00
|
|
|
|
|
|
|
`auth.password`::
|
|
|
|
|
2020-02-03 08:42:30 -05:00
|
|
|
The password for the `auth.username`. If `auth.secure_password` is also specified, this setting is ignored.
|
|
|
|
|
|
|
|
deprecated[7.7.0, Use `auth.secure_password` instead.]
|
2017-07-26 13:25:16 -04:00
|
|
|
|
|
|
|
`connection.timeout`::
|
|
|
|
|
2019-04-01 08:47:12 -04:00
|
|
|
(<<time-units,time value>>) Amount of time that the HTTP connection is supposed to wait for a socket to open for the
|
2017-07-26 13:25:16 -04:00
|
|
|
request. The default value is `6s`.
|
|
|
|
|
|
|
|
`connection.read_timeout`::
|
|
|
|
|
2019-04-01 08:47:12 -04:00
|
|
|
(<<time-units,time value>>) Amount of time that the HTTP connection is supposed to wait for a socket to
|
2017-07-26 13:25:16 -04:00
|
|
|
send back a response. The default value is `10 * connection.timeout` (`60s` if neither are set).
|
|
|
|
|
|
|
|
`ssl`::
|
|
|
|
|
|
|
|
Each HTTP exporter can define its own TLS / SSL settings or inherit them. See the
|
|
|
|
<<ssl-monitoring-settings, TLS / SSL section below>>.
|
|
|
|
|
|
|
|
`proxy.base_path`::
|
|
|
|
|
|
|
|
The base path to prefix any outgoing request, such as `/base/path` (e.g., bulk requests would
|
|
|
|
then be sent as `/base/path/_bulk`). There is no default value.
|
|
|
|
|
|
|
|
`headers`::
|
|
|
|
|
|
|
|
Optional headers that are added to every request, which can assist with routing requests through
|
|
|
|
proxies.
|
|
|
|
+
|
|
|
|
[source,yaml]
|
|
|
|
----------------------------------
|
|
|
|
xpack.monitoring.exporters.my_remote:
|
|
|
|
headers:
|
|
|
|
X-My-Array: [abc, def, xyz]
|
|
|
|
X-My-Header: abc123
|
|
|
|
----------------------------------
|
|
|
|
+
|
|
|
|
Array-based headers are sent `n` times where `n` is the size of the array. `Content-Type`
|
|
|
|
and `Content-Length` cannot be set. Any headers created by the Monitoring agent will override
|
|
|
|
anything defined here.
|
|
|
|
|
|
|
|
`index.name.time_format`::
|
|
|
|
|
|
|
|
A mechanism for changing the default date suffix for the, by default, daily Monitoring indices.
|
2020-05-08 17:09:42 -04:00
|
|
|
The default value is `yyyy.MM.dd`, which is why the indices are created daily.
|
2017-07-26 13:25:16 -04:00
|
|
|
|
|
|
|
`use_ingest`::
|
|
|
|
|
|
|
|
Whether to supply a placeholder pipeline to the monitoring cluster and a pipeline processor with
|
|
|
|
every bulk request. The default value is `true`. If disabled, then it means that it will not
|
|
|
|
use pipelines, which means that a future release cannot automatically upgrade bulk requests
|
|
|
|
to future-proof them.
|
|
|
|
|
|
|
|
`cluster_alerts.management.enabled`::
|
|
|
|
|
|
|
|
Whether to create cluster alerts for this cluster. The default value is `true`.
|
|
|
|
To use this feature, {watcher} must be enabled. If you have a basic license,
|
|
|
|
cluster alerts are not displayed.
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2018-01-16 16:09:38 -05:00
|
|
|
`cluster_alerts.management.blacklist`::
|
|
|
|
|
|
|
|
Prevents the creation of specific cluster alerts. It also removes any applicable
|
2020-06-16 14:43:22 -04:00
|
|
|
watches that already exist in the current cluster.
|
2018-01-16 16:09:38 -05:00
|
|
|
+
|
|
|
|
--
|
2020-06-16 14:43:22 -04:00
|
|
|
You can add any of the following watch identifiers to the list of blocked alerts:
|
2018-01-16 16:09:38 -05:00
|
|
|
|
|
|
|
* `elasticsearch_cluster_status`
|
|
|
|
* `elasticsearch_version_mismatch`
|
2018-01-16 16:18:57 -05:00
|
|
|
* `elasticsearch_nodes`
|
2018-01-16 16:09:38 -05:00
|
|
|
* `kibana_version_mismatch`
|
|
|
|
* `logstash_version_mismatch`
|
|
|
|
* `xpack_license_expiration`
|
|
|
|
|
|
|
|
For example: `["elasticsearch_version_mismatch","xpack_license_expiration"]`.
|
|
|
|
--
|
|
|
|
|
2017-04-06 20:34:23 -04:00
|
|
|
[[ssl-monitoring-settings]]
|
|
|
|
:ssl-prefix: xpack.monitoring.exporters.$NAME
|
|
|
|
:component: {monitoring}
|
|
|
|
:verifies:
|
|
|
|
:server!:
|
2019-05-29 08:24:25 -04:00
|
|
|
:ssl-context: monitoring
|
2017-04-06 20:34:23 -04:00
|
|
|
|
2017-06-27 12:14:35 -04:00
|
|
|
include::ssl-settings.asciidoc[]
|