APM Server comes packaged with example Kibana dashboards, visualizations, and searches for visualizing APM Server data in Kibana.

To load the dashboards, you can either enable dashboard loading in the setup.dashboards section of the apm-server.yml config file, or you can run the setup command. Dashboard loading is disabled by default.

When dashboard loading is enabled, APM Server uses the Kibana API to load the sample dashboards. Dashboard loading is only attempted when APM Server starts up. If Kibana is not available at startup, APM Server will stop with an error.

To enable dashboard loading, add the following setting to the config file:

setup.dashboards.enabled: true

Configuration optionsedit

You can specify the following options in the setup.dashboards section of the apm-server.yml config file:

setup.dashboards.enablededit

If this option is set to true, APM Server 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.directoryedit

The directory that contains the dashboards to load. The default is the kibana folder in the home path.

setup.dashboards.urledit

The URL to use for downloading the dashboard archive. If this option is set, APM Server downloads the dashboard archive from the specified URL instead of using the local directory.

setup.dashboards.fileedit

The file archive (zip file) that contains the dashboards to load. If this option is set, APM Server looks for a dashboard archive in the specified path instead of using the local directory.

setup.dashboards.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 "apm-server".

setup.dashboards.kibana_indexedit

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

setup.dashboards.indexedit

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

setup.dashboards.always_kibanaedit

Force loading of dashboards using the Kibana API without querying Elasticsearch for the version The default is false.

setup.dashboards.retry.enablededit

If this option is set to true, and Kibana is not reachable at the time when dashboards are loaded, APM Server will retry to reconnect to Kibana instead of exiting with an error. Disabled by default.

setup.dashboards.retry.intervaledit

Duration interval between Kibana connection retries. Defaults to 1 second.

setup.dashboards.retry.maximumedit

Maximum number of retries before exiting with an error. Set to 0 for unlimited retrying. Default is unlimited.