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

Kibana module

edit

Kibana module

edit

The kibana module collects metrics about Kibana.

Compatibility

edit

The kibana module works with Kibana 6.7.0 and later.

Usage for Stack Monitoring

edit

The kibana module can be used to collect metrics shown in our Elastic Stack monitoring features UI in Kibana. To enable this usage, set xpack.enabled: true and remove any metricsets from the module’s configuration. Alternatively, run metricbeat modules disable kibana and metricbeat modules enable kibana-xpack.

Example configuration

edit

The Kibana module supports the standard configuration options that are described in Modules. 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 SSL. It also supports the options described in Standard HTTP config options.

Metricsets

edit

The following metricsets are available:

« Kafka producer metricset Kibana stats metricset »