Dashboardsedit

Warning

This functionality is in beta and is subject to change. The design and code is considered to be less mature than official GA features. Elastic will take a best effort approach to fix any issues, but beta features are not subject to the support SLA of official GA features.

The dashboards section of the packetbeat.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, Packetbeat attempts to configure Kibana by writing directly in the Elasticsearch index for the Kibana configuration (by default, .kibana). To connect to Elasticsearch, Packetbeat uses the settings defined in the Elasticsearch output. If the Elasticsearch output is not configured or not enabled, Packetbeat will stop with an error. Dashboard loading is only attempted at Beat startup. If Elasticsearch is not available when the Beat starts, Packetbeat will stop with an error.

Here is an example configuration:

dashboards.enabled: true

Dashboards Loading Optionsedit

You can specify the following options in the dashboards section of the packetbeat.yml config file:

enablededit

If this option is set to true, Packetbeat loads the sample Kibana dashboards automatically on startup. If no other options are set, the dashboard archive is downloaded from the elastic.co website.

To load dashboards from a different location, you can configure one of the following options: url, directory, or file.

To load dashboards from a snapshot URL, use the snapshot option and optionally snapshot-url.

urledit

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.

directoryedit

The directory that contains the dashboards to load. If this option is set, Packetbeat looks for dashboards in the specified directory instead of downloading an archive from a URL.

fileedit

The file archive (zip file) that contains the dashboards to load. If this option is set, Packetbeat looks for a dashboard archive in the specified path instead of downloading the archive from a URL.

snapshotedit

If this option is set to true, the snapshot URL is used instead of the default URL.

snapshot_urledit

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.

beatedit

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 "packetbeat".

kibana_indexedit

The name of the Kibana index to use for setting the configuration. The default is ".kibana"

indexedit

The Elasticsearch index name. This setting overwrites the index name defined in the dashboards and index pattern. Example: "testbeat-*"