- Metricbeat Reference: other versions:
- Overview
- Contributing to Beats
- Getting started with Metricbeat
- Setting up and running Metricbeat
- Upgrading Metricbeat
- How Metricbeat works
- Configuring Metricbeat
- Specify which modules to run
- Specify general settings
- Load external configuration files
- Configure the internal queue
- Configure the output
- Specify SSL settings
- Filter and enhance the exported data
- Parse logs by using ingest node
- Set up project paths
- Set up the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Set up logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- metricbeat.reference.yml
- Modules
- Aerospike module
- Apache module
- Ceph module
- Couchbase module
- Docker module
- Dropwizard module
- Elasticsearch module
- Etcd module
- Golang module
- Graphite module
- HAProxy module
- HTTP module
- Jolokia module
- Kafka module
- Kibana module
- Kubernetes module
- Kubernetes container metricset
- Kubernetes event metricset
- Kubernetes node metricset
- Kubernetes pod metricset
- Kubernetes state_container metricset
- Kubernetes state_deployment metricset
- Kubernetes state_node metricset
- Kubernetes state_pod metricset
- Kubernetes state_replicaset metricset
- Kubernetes system metricset
- Kubernetes volume metricset
- Logstash module
- Memcached module
- MongoDB module
- MySQL module
- Nginx module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- System module
- vSphere module
- Windows module
- ZooKeeper module
- Exported fields
- Aerospike fields
- Apache fields
- Beat fields
- Ceph fields
- Cloud provider metadata fields
- Common fields
- Couchbase fields
- Docker fields
- Docker fields
- Dropwizard fields
- Elasticsearch fields
- Etcd fields
- Golang fields
- Graphite fields
- HAProxy fields
- HTTP fields
- Jolokia fields
- Kafka fields
- Kibana fields
- Kubernetes fields
- Kubernetes fields
- Logstash fields
- Memcached fields
- MongoDB fields
- MySQL fields
- Nginx fields
- PHP_FPM fields
- PostgreSQL fields
- Prometheus fields
- RabbitMQ fields
- Redis fields
- System fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Securing Metricbeat
- Troubleshooting
WARNING: Version 6.1 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.
Load the Kibana dashboards
editLoad the Kibana dashboards
editMetricbeat comes packaged with example Kibana dashboards, visualizations, and searches for visualizing Metricbeat data in Kibana.
To load the dashboards, you can either enable dashboard loading in the
setup.dashboards section of the metricbeat.yml config file, or you can
run the setup command. Dashboard loading is disabled by default.
When dashboard loading is enabled, Metricbeat uses the Kibana API to load the sample dashboards. Dashboard loading is only attempted at Beat startup. If Kibana is not available at startup, Metricbeat will stop with an error.
To enable dashboard loading, add the following setting to the config file:
setup.dashboards.enabled: true
Configuration options
editYou can specify the following options in the setup.dashboards section of the
metricbeat.yml config file:
setup.dashboards.enabled
editIf this option is set to true, Metricbeat loads the sample Kibana dashboards
automatically on startup. If no other options are set, the dashboard are loaded
from the local kibana directory in the home path of the installation.
To load dashboards from a different location, you can configure one of the
following options: setup.dashboards.directory,
setup.dashboards.url, or
setup.dashboards.file.
setup.dashboards.directory
editThe directory that contains the dashboards to load. The default is the kibana
folder in the home path.
setup.dashboards.url
editThe URL to use for downloading the dashboard archive. If this option is set, Metricbeat downloads the dashboard archive from the specified URL instead of using the local directory.
setup.dashboards.file
editThe 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 using the local directory.
setup.dashboards.beat
editIn 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
"metricbeat".
setup.dashboards.kibana_index
editThe name of the Kibana index to use for setting the configuration. The default
is ".kibana"
setup.dashboards.index
editThe Elasticsearch index name. This setting overwrites the index name defined
in the dashboards and index pattern. Example: "testbeat-*"
setup.dashboards.always_kibana
editForce loading of dashboards using the Kibana API without querying Elasticsearch for the version
The default is false.
On this page