Elastic Docs› Metricbeat Reference [8.4]› Modules
« Kafka producer metricset Kibana cluster_actions metricset »

Kibana moduleedit

Prefer to use Elastic Agent for this use case?

Refer to the Elastic Integrations documentation.

Learn more

Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of Beats and Elastic Agent.

The kibana module collects metrics about Kibana.

Compatibilityedit

The kibana module works with Kibana 6.7.0 and later.

Usage for Elastic Stack Monitoringedit

The kibana module can be used to collect metrics shown in our Stack Monitoring 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.

When this module is used for Elastic Stack Monitoring, it sends metrics to the monitoring index instead of the default index typically used by Metricbeat. For more details about the monitoring index, see Configuring indices for monitoring.

Example configuration

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

The following metricsets are available:

« Kafka producer metricset Kibana cluster_actions metricset »