IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Kafka partition metricset Kibana stats metricset »
Elastic Docs ›Metricbeat Reference [7.3] ›Modules

Kibana module

edit

Kibana module

edit

There are two modules that collect metrics about Kibana:

  • The Kibana module tracks only the high-level metrics. The default metricset in this module is status.
  • The Kibana X-Pack module enables you to monitor more Kibana metrics with our monitoring feature. The default metricset in this module is stats.

Compatibility

edit

The Kibana module is tested with Kibana 6.3.

Example configuration

edit

The Kibana module supports the standard configuration options that are described in Specify which modules to run. Here is an example configuration:

metricbeat.modules:
- module: kibana
  metricsets: ["status"]
  period: 10s
  hosts: ["localhost:5601"]
  basepath: ""
  enabled: true

  # Set to true to send data collected by module to X-Pack
  # Monitoring instead of metricbeat-* indices.
  #xpack.enabled: false

This module supports TLS connections when using ssl config field, as described in Specify SSL settings. It also supports the options described in Standard HTTP config options.

Metricsets

edit

The following metricsets are available:

« Kafka partition metricset Kibana stats metricset »