2018-04-20 21:13:37 +02:00
[role="xpack"]
[[monitoring-settings-kb]]
2020-06-08 23:46:26 +02:00
=== Monitoring settings in {kib}
2018-04-20 21:13:37 +02:00
++++
2019-02-11 17:17:25 +01:00
<titleabbrev>Monitoring settings</titleabbrev>
2018-04-20 21:13:37 +02:00
++++
2020-08-27 19:39:44 +02:00
By default, *{stack-monitor-app}* is enabled, but data collection is disabled.
When you first start {kib} monitoring, you are prompted to enable data
collection. If you are using {stack-security-features}, you must be signed in as
a user with the `cluster:manage` privilege to enable data collection. The
built-in `superuser` role has this privilege and the built-in `elastic` user has
this role.
2018-05-31 17:16:31 +02:00
You can adjust how monitoring data is
2018-04-20 21:13:37 +02:00
collected from {kib} and displayed in {kib} by configuring settings in the
2020-01-30 17:13:14 +01:00
`kibana.yml` file. There are also `monitoring.ui.elasticsearch.*` settings,
2018-04-20 21:13:37 +02:00
which support the same values as <<settings,{kib} configuration settings>>.
To control how data is collected from your {es} nodes, you configure
{ref}/monitoring-settings.html[`xpack.monitoring.collection`
settings] in `elasticsearch.yml`. To control how monitoring data is collected
2020-03-17 21:11:40 +01:00
from Logstash, configure monitoring settings in `logstash.yml`.
2018-04-20 21:13:37 +02:00
For more information, see
2019-10-17 23:41:13 +02:00
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
2018-04-20 21:13:37 +02:00
[float]
[[monitoring-general-settings]]
2019-02-11 17:17:25 +01:00
==== General monitoring settings
2018-04-20 21:13:37 +02:00
2020-05-04 17:22:40 +02:00
[cols="2*<"]
|===
2021-08-19 21:38:49 +02:00
| `monitoring.ui.ccs.enabled`
| Set to `true` (default) to enable {ref}/modules-cross-cluster-search.html[cross-cluster search] of your monitoring data. The {ref}/modules-remote-clusters.html#remote-cluster-settings[`remote_cluster_client`] role must exist on each node.
2020-05-04 17:22:40 +02:00
| `monitoring.ui.elasticsearch.hosts`
| Specifies the location of the {es} cluster where your monitoring data is stored.
2020-09-23 17:01:05 +02:00
By default, this is the same as <<elasticsearch-hosts, `elasticsearch.hosts`>>. This setting enables
2020-05-04 17:22:40 +02:00
you to use a single {kib} instance to search and visualize data in your
production cluster as well as monitor data sent to a dedicated monitoring
cluster.
| `monitoring.ui.elasticsearch.username`
| Specifies the username used by {kib} monitoring to establish a persistent connection
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
monitoring cluster. +
+
2020-08-27 19:39:44 +02:00
Every other request performed by *{stack-monitor-app}* to the monitoring {es}
2020-05-04 17:22:40 +02:00
cluster uses the authenticated user's credentials, which must be the same on
both the {es} monitoring cluster and the {es} production cluster. +
+
2020-09-23 17:01:05 +02:00
If not set, {kib} uses the value of the <<elasticsearch-user-passwd, `elasticsearch.username`>> setting.
2020-05-04 17:22:40 +02:00
| `monitoring.ui.elasticsearch.password`
| Specifies the password used by {kib} monitoring to establish a persistent connection
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
monitoring cluster. +
+
2020-08-27 19:39:44 +02:00
Every other request performed by *{stack-monitor-app}* to the monitoring {es}
2020-05-04 17:22:40 +02:00
cluster uses the authenticated user's credentials, which must be the same on
both the {es} monitoring cluster and the {es} production cluster. +
+
2020-09-23 17:01:05 +02:00
If not set, {kib} uses the value of the <<elasticsearch-user-passwd, `elasticsearch.password`>> setting.
2020-05-04 17:22:40 +02:00
| `monitoring.ui.elasticsearch.pingTimeout`
| Specifies the time in milliseconds to wait for {es} to respond to internal
2020-09-23 17:01:05 +02:00
health checks. By default, it matches the <<elasticsearch-pingTimeout, `elasticsearch.pingTimeout`>> setting,
2020-05-04 17:22:40 +02:00
which has a default value of `30000`.
2020-10-21 16:32:16 +02:00
| `monitoring.ui.elasticsearch.ssl`
| Shares the same configuration as <<elasticsearch-ssl-cert-key, `elasticsearch.ssl`>>. These settings configure encrypted communication between {kib} and the monitoring cluster.
2020-05-04 17:22:40 +02:00
|===
2018-04-20 21:13:37 +02:00
[float]
[[monitoring-collection-settings]]
2019-02-11 17:17:25 +01:00
==== Monitoring collection settings
2018-04-20 21:13:37 +02:00
These settings control how data is collected from {kib}.
2020-05-04 17:22:40 +02:00
[cols="2*<"]
|===
| `monitoring.kibana.collection.enabled`
| Set to `true` (default) to enable data collection from the {kib} NodeJS server
2020-08-27 19:39:44 +02:00
for {kib} dashboards to be featured in *{stack-monitor-app}*.
2018-04-20 21:13:37 +02:00
2020-09-03 17:17:55 +02:00
| `monitoring.kibana.collection.interval` {ess-icon}
2020-05-04 17:22:40 +02:00
| Specifies the number of milliseconds to wait in between data sampling on the
{kib} NodeJS server for the metrics that are displayed in the {kib} dashboards.
Defaults to `10000` (10 seconds).
2018-04-20 21:13:37 +02:00
2020-05-04 17:22:40 +02:00
|===
2018-04-20 21:13:37 +02:00
[float]
[[monitoring-ui-settings]]
2019-02-11 17:17:25 +01:00
==== Monitoring UI settings
2018-04-20 21:13:37 +02:00
2020-08-27 19:39:44 +02:00
These settings adjust how *{stack-monitor-app}* displays monitoring data.
2018-04-20 21:13:37 +02:00
However, the defaults work best in most circumstances. For more information
about configuring {kib}, see
2020-08-27 19:39:44 +02:00
{kibana-ref}/settings.html[Setting {kib} server properties].
2018-04-20 21:13:37 +02:00
2020-05-04 17:22:40 +02:00
[cols="2*<"]
|===
| `monitoring.ui.elasticsearch.logFetchCount`
2020-08-27 19:39:44 +02:00
| Specifies the number of log entries to display in *{stack-monitor-app}*.
Defaults to `10`. The maximum value is `50`.
2020-09-23 17:01:05 +02:00
|[[monitoring-ui-enabled]] `monitoring.ui.enabled`
2020-08-27 19:39:44 +02:00
| Set to `false` to hide *{stack-monitor-app}*. The monitoring back-end
continues to run as an agent for sending {kib} stats to the monitoring
cluster. Defaults to `true`.
2020-09-03 17:17:55 +02:00
2020-08-27 19:39:44 +02:00
| `monitoring.ui.logs.index`
| Specifies the name of the indices that are shown on the
<<logs-monitor-page,*Logs*>> page in *{stack-monitor-app}*. The default value
is `filebeat-*`.
2018-04-20 21:13:37 +02:00
2020-05-04 17:22:40 +02:00
| `monitoring.ui.max_bucket_size`
| Specifies the number of term buckets to return out of the overall terms list when
performing terms aggregations to retrieve index and node metrics. For more
information about the `size` parameter, see
{ref}/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-size[Terms Aggregation].
Defaults to `10000`.
2018-04-20 21:13:37 +02:00
2020-09-03 17:17:55 +02:00
| `monitoring.ui.min_interval_seconds` {ess-icon}
2020-05-04 17:22:40 +02:00
| Specifies the minimum number of seconds that a time bucket in a chart can
represent. Defaults to 10. If you modify the
`monitoring.ui.collection.interval` in `elasticsearch.yml`, use the same
value in this setting.
2018-04-20 21:13:37 +02:00
2020-05-04 17:22:40 +02:00
|===
2019-06-18 17:37:39 +02:00
2018-04-20 21:13:37 +02:00
[float]
[[monitoring-ui-cgroup-settings]]
2019-02-11 17:17:25 +01:00
===== Monitoring UI container settings
2018-04-20 21:13:37 +02:00
2020-08-27 19:39:44 +02:00
*{stack-monitor-app}* exposes the Cgroup statistics that we collect for you to make
2018-04-20 21:13:37 +02:00
better decisions about your container performance, rather than guessing based on
the overall machine performance. If you are not running your applications in a
container, then Cgroup statistics are not useful.
2020-05-04 17:22:40 +02:00
[cols="2*<"]
|===
2020-09-03 17:17:55 +02:00
| `monitoring.ui.container.elasticsearch.enabled` {ess-icon}
2020-05-04 17:22:40 +02:00
| For {es} clusters that are running in containers, this setting changes the
*Node Listing* to display the CPU utilization based on the reported Cgroup
statistics. It also adds the calculated Cgroup CPU utilization to the
*Node Overview* page instead of the overall operating system's CPU
utilization. Defaults to `false`.
| `monitoring.ui.container.logstash.enabled`
| For {ls} nodes that are running in containers, this setting
changes the {ls} *Node Listing* to display the CPU utilization
based on the reported Cgroup statistics. It also adds the
calculated Cgroup CPU utilization to the {ls} node detail
pages instead of the overall operating system’ s CPU utilization. Defaults to `false`.
|===