Kibana dashboards.md

FileBeat附带了示例Kibana仪表板、可视化以及在Kibana中搜索可视化FileBeat数据。

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

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

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

setup.dashboards.enabled: true

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

setup.dashboards.enabled

如果此选项设置为true，FileBeat将从FileBeat安装的主路径中的本地kibana目录加载示例Kibana仪表板。

Filebeat loads dashboards on startup if either enabled is set to true or the setup.dashboards section is included in the configuration.

如果enabled设置为true或配置中包含setup.dashboards部分，FileBeat将在启动时加载仪表板。

启用仪表板加载后，FileBeat会覆盖与您正在加载的仪表板名称匹配的任何现有仪表板。每次FileBeat启动时都会发生这种情况。

If no other options are set, the dashboard are loaded from the local kibana directory in the home path of the Filebeat 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

包含要加载的仪表板的目录。默认为主路径中的kibana文件夹。

setup.dashboards.url

The URL to use for downloading the dashboard archive。如果设置了此选项，Filebeat downloads the dashboard archive from the specified URL instead of using the local directory.

setup.dashboards.file

包含要加载的仪表板的文件存档（zip文件）。如果设置了此选项，FileBeat会在指定路径中查找仪表板存档，而不是使用本地目录。

setup.dashboards.beat

如果存档包含多个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 "filebeat".

setup.dashboards.kibana_index

用于设置配置的Kibana索引的名称。 The default is ".kibana"

setup.dashboards.index

Elasticsearch索引名称。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

使用Kibana API强制加载仪表板，而无需查询Elasticsearch版本。The default is false.

setup.dashboards.retry.enabled

如果此选项设置为true，并且加载仪表板时无法访问Kibana，FileBeat将重试重新连接到Kibana，而不是退出并出现错误。默认情况下禁用。

setup.dashboards.retry.interval

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

setup.dashboards.retry.maximum

退出错误前的最大重试次数。设置为0以无限制重试。默认是无限的。

setup.dashboards.string_replacements

The needle and replacements string map, which is used to replace needle string in dashboards and their references contents.