IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Machine learning settings in Kibana Reporting settings in Kibana »

› › ›

Monitoring settings in Kibana

edit

Monitoring settings in Kibana

edit

By default, the Monitoring application is enabled, but data collection is disabled. When you first start Kibana monitoring, you are prompted to enable data collection. If you are using X-Pack security, 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.

You can adjust how monitoring data is collected from Kibana and displayed in Kibana by configuring settings in the kibana.yml file. There are also xpack.monitoring.elasticsearch.* settings, which support the same values as Kibana configuration settings.

To control how data is collected from your Elasticsearch nodes, you configure xpack.monitoring.collection settings in elasticsearch.yml. To control how monitoring data is collected from Logstash, you configure xpack.monitoring settings in logstash.yml.

For more information, see Monitor a cluster.

General monitoring settings

edit

`monitoring.cluster_alerts.email_notifications.enabled`	When enabled, sends email notifications for Watcher alerts to the specified email address. The default is `true`.
`monitoring.cluster_alerts.email_notifications.email_address` ::	When enabled, specifies the email address where you want to receive cluster alert notifications.
`xpack.monitoring.enabled`	Set to `true` (default) to enable the monitoring features in Kibana. Unlike the `monitoring.ui.enabled` setting, when this setting is `false`, the monitoring back-end does not run and Kibana stats are not sent to the monitoring cluster.
`xpack.monitoring.elasticsearch.hosts`	Specifies the location of the Elasticsearch cluster where your monitoring data is stored. By default, this is the same as `elasticsearch.hosts`. This setting enables you to use a single Kibana instance to search and visualize data in your production cluster as well as monitor data sent to a dedicated monitoring cluster.
`xpack.monitoring.elasticsearch.username`	Specifies the user ID that Kibana uses for authentication when it retrieves data from the monitorning cluster. If not set, Kibana uses the value of the `elasticsearch.username` setting.
`xpack.monitoring.elasticsearch.password`	Specifies the password that Kibana uses for authentication when it retrieves data from the monitoring cluster. If not set, Kibana uses the value of the `elasticsearch.password` setting.
`xpack.monitoring.elasticsearch.pingTimeout`	Specifies the time in milliseconds to wait for Elasticsearch to respond to internal health checks. By default, it matches the `elasticsearch.pingTimeout` setting, which has a default value of `30000`.

Monitoring collection settings

edit

These settings control how data is collected from Kibana.

`xpack.monitoring.kibana.collection.enabled`	Set to `true` (default) to enable data collection from the Kibana NodeJS server for Kibana Dashboards to be featured in the Monitoring.
`xpack.monitoring.kibana.collection.interval`	Specifies the number of milliseconds to wait in between data sampling on the Kibana NodeJS server for the metrics that are displayed in the Kibana dashboards. Defaults to `10000` (10 seconds).

Monitoring UI settings

edit

These settings adjust how the Kibana Monitoring page displays monitoring data. However, the defaults work best in most circumstances. For more information about configuring Kibana, see Setting Kibana Server Properties.

`xpack.monitoring.elasticsearch.logFetchCount`	Specifies the number of log entries to display in the Monitoring UI. Defaults to `10`. The maximum value is `50`.
`xpack.monitoring.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 Terms Aggregation. Defaults to `10000`.
`xpack.monitoring.min_interval_seconds`	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.
`xpack.monitoring.ui.enabled`	Set to `false` to hide the Monitoring UI in Kibana. The monitoring back-end continues to run as an agent for sending Kibana stats to the monitoring cluster. Defaults to `true`.

Monitoring UI container settings

edit

The Monitoring UI exposes the Cgroup statistics that we collect for you to make 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.

`xpack.monitoring.ui.container.elasticsearch.enabled`	For Elasticsearch 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`.
`xpack.monitoring.ui.container.logstash.enabled`	For Logstash nodes that are running in containers, this setting changes the Logstash Node Listing to display the CPU utilization based on the reported Cgroup statistics. It also adds the calculated Cgroup CPU utilization to the Logstash node detail pages instead of the overall operating system’s CPU utilization. Defaults to `false`.

« Machine learning settings in Kibana Reporting settings in Kibana »