////
This file is generated! See scripts/mage/docs_collector.go
////

:modulename: kibana

[[metricbeat-module-kibana]]
== Kibana module

The `kibana` module collects metrics about {kib}.

[float]
=== Compatibility

The `kibana` module works with {kib} 6.7.0 and later.

[float]
=== Usage for {stack} Monitoring

The `kibana` module can be used to collect metrics shown in our {stack-monitor-app}
UI in {kib}. 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`.

NOTE: When this module is used for {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
{ref}/config-monitoring-indices.html[Configuring indices for monitoring].


[float]
=== Example configuration

The Kibana module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
----
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 <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-kibana-stats,stats>>

* <<metricbeat-metricset-kibana-status,status>>

include::kibana/stats.asciidoc[]

include::kibana/status.asciidoc[]

