导入现有 Beat 仪表盘

编辑

官方 Beats 附带 Kibana 仪表盘,从 6.0.0 版本开始,它们是每个 Beat 软件包的一部分。

您可以使用 Beat 可执行文件导入 Beat 的所有仪表盘和索引模式,包括可视化和搜索等依赖项。

要导入仪表盘,请运行 setup 命令。

./metricbeat setup

setup 阶段加载多个依赖项,例如:

  • Elasticsearch 中的索引映射模板
  • Kibana 仪表盘
  • 摄取管道
  • ILM 策略

依赖项因您正在设置的 Beat 而异。

有关 setup 命令的更多详细信息,请参阅命令行帮助。例如:

./metricbeat help setup

This command does initial setup of the environment:

 * Index mapping template in Elasticsearch to ensure fields are mapped.
 * Kibana dashboards (where available).
 * ML jobs (where available).
 * Ingest pipelines (where available).
 * ILM policy (for Elasticsearch 6.5 and newer).

Usage:
  metricbeat setup [flags]

Flags:
      --dashboards         Setup dashboards
  -h, --help               help for setup
      --index-management   Setup all components related to Elasticsearch index management, including template, ilm policy and rollover alias
      --pipelines          Setup Ingest pipelines

当您不想加载所有内容时,这些标志非常有用。例如,要仅导入仪表盘,请使用 --dashboards 标志

./metricbeat setup --dashboards

从 Beats 6.0.0 版本开始,仪表盘不再直接加载到 Elasticsearch 中。而是直接导入到 Kibana 中。因此,如果您的 Kibana 实例未在 localhost 上监听,或者您为 Kibana 启用了 X-Pack,则需要在 Beat 的配置中配置 Kibana 端点,或者将 Kibana 主机和凭据作为参数传递给 setup 命令。例如:

./metricbeat setup -E setup.kibana.host=192.168.3.206:5601 -E setup.kibana.username=elastic -E setup.kibana.password=secret

默认情况下,setup 命令从 Beat 软件包中提供的 kibana 目录导入仪表盘。

Kibana 5.x 和 6.x 之间的已保存仪表盘格式不兼容。因此,Kibana 5.x 仪表盘位于 5.x 目录中,Kibana 6.0 及更早版本的仪表盘位于 default 目录中。

如果您使用的是自定义仪表盘,则可以导入它们:

  • 从本地目录

    ./metricbeat setup -E setup.dashboards.directory=kibana
  • 从本地 zip 压缩包

    ./metricbeat setup -E setup.dashboards.file=metricbeat-dashboards-6.0.zip
  • 从可在线访问的 zip 压缩包

    ./metricbeat setup -E setup.dashboards.url=path/to/url

    有关 setup.dashboards 配置选项的说明,请参阅 Kibana 仪表盘配置

导入开发用仪表盘

编辑

您可以使用 Beat GitHub 代码库中的 Magefile 来导入仪表盘。如果 Kibana 在 localhost 上运行,则可以从 Beat 的根目录运行以下命令:

mage dashboards

Kibana 仪表盘配置

编辑

每个 Beat 的配置文件(*.reference.yml)都包含 setup.dashboards 部分,用于配置获取 Kibana 仪表盘的位置以及索引模式的名称。可以使用 -E 标志通过命令行选项覆盖这些配置选项中的每一个。

setup.dashboards.directory=<local_dir>
包含已保存仪表盘及其依赖项的本地目录。默认值为 Beat 软件包中提供的 kibana 目录。
setup.dashboards.file=<local_archive>
包含仪表盘的本地 zip 压缩包。该压缩包可以包含单个 Beat 或多个 Beat 的 Kibana 仪表盘。每个 Beat 的仪表盘都放置在以 Beat 名称命名的单独目录下。
setup.dashboards.url=<zip_url>
包含仪表盘的可在线访问的 zip 压缩包。该压缩包可以包含单个 Beat 或多个 Beat 的 Kibana 仪表盘。每个 Beat 的仪表盘都放置在以 Beat 名称命名的单独目录下。
setup.dashboards.index <elasticsearch_index>
只有当您想要更改默认使用的索引模式名称时,才应使用此选项。例如,如果默认值为 metricbeat-*,则可以将其更改为 custombeat-*