WARNING: Version 6.1 of Packetbeat 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
editPacketbeat comes packaged with example Kibana dashboards, visualizations, and searches for visualizing Packetbeat data in Kibana.
To load the dashboards, you can either enable dashboard loading in the
setup.dashboards
section of the packetbeat.yml
config file, or you can
run the setup
command. Dashboard loading is disabled by default.
When dashboard loading is enabled, Packetbeat uses the Kibana API to load the sample dashboards. Dashboard loading is only attempted at Beat startup. If Kibana is not available at startup, Packetbeat 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
packetbeat.yml
config file:
setup.dashboards.enabled
editIf this option is set to true, Packetbeat 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, Packetbeat 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, Packetbeat 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
"packetbeat"
.
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
.