WARNING: Version 5.5 of Metricbeat has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
dashboards section of the
metricbeat.yml config file contains options
for automatically loading the sample Beats dashboards. Automatic dashboard
loading is disabled by default, but can be enabled either from the configuration
file or by using the
-setup CLI flag.
If dashboard loading is enabled, Metricbeat attempts to configure Kibana by
writing directly in the Elasticsearch index for the Kibana configuration (by
.kibana). To connect to Elasticsearch, Metricbeat uses the
settings defined in the Elasticsearch output. If the Elasticsearch output is
not configured or not enabled, Metricbeat will stop with an error. Dashboard
loading is only attempted at Beat startup. If Elasticsearch is not available when
the Beat starts, Metricbeat will stop with an error.
Here is an example configuration:
You can specify the following options in the
dashboards section of the
metricbeat.yml config file:
If this option is set to true, Metricbeat loads the sample Kibana dashboards automatically on startup. If no other options are set, the dashboard archive is downloaded from the elastic.co website.
The URL to use for downloading the dashboard archive. By default this URL is computed based on the Beat name and version. For released versions, this URL points to the dashboard archive on the artifacts.elastic.co website.
The directory that contains the dashboards to load. If this option is set, Metricbeat looks for dashboards in the specified directory instead of downloading an archive from a URL.
The file archive (zip file) that contains the dashboards to load. If this option is set, Metricbeat looks for a dashboard archive in the specified path instead of downloading the archive from a URL.
If this option is set to true, the snapshot URL is used instead of the default URL.
The URL to use for downloading the snapshot version of the dashboards. By default the snapshot URL is computed based on the Beat name and version.
In case the archive contains the dashboards for multiple Beats, this setting
lets you select the Beat for which you want to load dashboards. To load all the
dashboards in the archive, set this option to an empty string. The default is
The name of the Kibana index to use for setting the configuration. The default
The Elasticsearch index name. This setting overwrites the index name defined
in the dashboards and index pattern. Example: