youtubebeat/vendor/github.com/elastic/beats/metricbeat/docs/modules/kibana.asciidoc

53 lines
1.1 KiB
Text
Raw Normal View History

2018-11-18 11:08:38 +01:00
////
This file is generated! See scripts/docs_collector.py
////
[[metricbeat-module-kibana]]
== Kibana module
beta[]
The Kibana module only tracks the high-level metrics. To monitor more Kibana metrics, use our {monitoringdoc}/xpack-monitoring.html[monitoring] feature.
The default metricset is `status`.
[float]
=== Compatibility
The Kibana module is tested with Kibana 6.3.
[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
----
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[]