This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
NOTE: This You are looking at documentation for an older release. For the latest information, see the current release documentation.
Load the Kibana dashboards
editLoad the Kibana dashboards
editJournalbeat comes packaged with example Kibana dashboards, visualizations, and searches for visualizing Journalbeat data in Kibana.
To load the dashboards, you can either enable dashboard loading in the
setup.dashboards section of the journalbeat.yml config file, or you can
run the setup command. Dashboard loading is disabled by default.
When dashboard loading is enabled, Journalbeat uses the Kibana API to load the sample dashboards. Dashboard loading is only attempted when Journalbeat starts up. If Kibana is not available at startup, Journalbeat 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
journalbeat.yml config file:
setup.dashboards.enabled
editIf this option is set to true, Journalbeat loads the sample Kibana dashboards
from the local kibana directory in the home path of the Journalbeat installation.
When dashboard loading is enabled, Journalbeat overwrites any existing dashboards that match the names of the dashboards you are loading. This happens every time Journalbeat starts.
If no other options are set, the dashboard are loaded
from the local kibana directory in the home path of the Journalbeat 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, Journalbeat 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, Journalbeat 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
"journalbeat".
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-*"
This setting only works for Kibana 6.0 and newer.
setup.dashboards.always_kibana
editForce loading of dashboards using the Kibana API without querying Elasticsearch for the version.
The default is false.
setup.dashboards.retry.enabled
editIf this option is set to true, and Kibana is not reachable at the time when dashboards are loaded, Journalbeat will retry to reconnect to Kibana instead of exiting with an error. Disabled by default.
setup.dashboards.retry.interval
editDuration interval between Kibana connection retries. Defaults to 1 second.
setup.dashboards.retry.maximum
editMaximum number of retries before exiting with an error. Set to 0 for unlimited retrying. Default is unlimited.