配置模块

您可以在 modules.d 目录（推荐）或 Metricbeat 配置文件中配置模块。 modules.d 目录中已启用模块的设置优先于 Metricbeat 配置文件中的模块设置。

在启用模块的情况下运行 Metricbeat 之前，请确保您还设置了使用 Kibana 仪表板的环境。有关更多信息，请参阅快速入门：安装和配置。

modules.d 目录包含 Metricbeat 中所有可用模块的默认配置。要启用或禁用 modules.d 下的特定模块配置，请运行 modules enable 或 modules disable 命令。例如

metricbeat modules enable apache mysql

metricbeat modules enable apache mysql

./metricbeat modules enable apache mysql

./metricbeat modules enable apache mysql

PS > .\metricbeat.exe modules enable apache mysql

然后，当您运行 Metricbeat 时，它会加载 modules.d 目录中指定的相应模块配置（例如，modules.d/apache.yml 和 modules.d/mysql.yml）。

要查看已启用和已禁用模块的列表，请运行

metricbeat modules list

metricbeat modules list

./metricbeat modules list

./metricbeat modules list

PS > .\metricbeat.exe modules list

要更改默认模块配置，请修改 modules.d 目录中的 .yml 文件。

以下示例显示了 Apache 模块的基本配置

- module: apache
  metricsets: ["status"]
  hosts: ["http://127.0.0.1/"]
  period: 10s
  fields:
    dc: west
  tags: ["tag"]
  processors:
  ....

有关其他配置示例，请参阅配置组合。

在可能的情况下，您应该使用 modules.d 目录中的配置文件。

但是，如果您是从以前版本的 Metricbeat 升级，并且不想将模块配置移动到 modules.d 目录，则直接在配置文件中配置模块是一种实用的方法。您可以继续在 metricbeat.yml 文件中配置模块，但您将无法使用 modules 命令来启用和禁用配置，因为该命令需要 modules.d 布局。

要在 metricbeat.yml 配置文件中启用特定的模块和指标集，请将条目添加到 metricbeat.modules 列表。列表中的每个条目都以破折号 (-) 开头，后跟该模块的设置。

以下示例显示了启用 apache 和 mysql 模块的配置

metricbeat.modules:

#---------------------------- Apache Status Module ---------------------------
- module: apache
  metricsets: ["status"]
  period: 1s
  hosts: ["http://127.0.0.1/"]

#---------------------------- MySQL Status Module ----------------------------
- module: mysql
  metricsets: ["status"]
  period: 2s
  hosts: ["root@tcp(127.0.0.1:3306)/"]

在以下示例中，每秒都会爬取 Redis 主机以获取 stats 信息，因为这是关键数据，但仅每 30 秒提取一次完整的 Apache 指标集列表，因为这些指标不那么关键。

metricbeat.modules:
- module: redis
  metricsets: ["info"]
  hosts: ["host1"]
  period: 1s
- module: apache
  metricsets: ["info"]
  hosts: ["host1"]
  period: 30s

每个模块都带有默认配置文件。一些模块还带有一个或多个变体配置文件，其中包含该模块的常见替代配置。

当您看到已启用和已禁用模块的列表时，具有配置变体的模块将显示为 <module_name>-<variant_name>。您可以通过指定 metricbeat modules enable <module_name>-<variant_name> 和 metricbeat modules disable <module_name>-<variant_name> 分别启用或禁用模块的特定配置变体。

您可以指定使用指标集、周期和主机的不同组合的模块配置。

对于定义了多个指标集的模块，可以定义该模块两次，并为每个指标集指定不同的使用周期。对于以下示例，将每 10 秒提取一次 set1 指标集，而每 2 分钟提取一次 set2 指标集

- module: example
  metricsets: ["set1"]
  hosts: ["host1"]
  period: 10s
- module: example
  metricsets: ["set2"]
  hosts: ["host1"]
  period: 2m

您可以为任何 Metricbeat 模块指定以下选项。某些模块需要其他配置设置。有关更多信息，请参阅模块部分。

要运行的模块的名称。有关每个模块的文档，请参阅模块部分。

要执行的指标集列表。请确保您仅列出模块中可用的指标集。无法引用其他模块中的指标集。有关可用指标集的列表，请参阅模块。

一个布尔值，指定是否启用模块。如果您使用默认配置文件 metricbeat.yml，则默认情况下启用系统模块（设置为 enabled: true）。如果配置块中缺少 enabled 选项，则默认情况下启用该模块。

执行指标集的频率。如果系统不可访问，则 Metricbeat 将为每个周期返回一个错误。此设置是必需的。

从中获取信息的主机列表。对于某些指标集（例如，系统模块），此设置是可选的。

将随指标集事件发送的字段字典。此设置是可选的。

将随指标集事件发送的标签列表。此设置是可选的。

要应用于指标集生成的数据的处理程序列表。

有关在配置中指定处理程序的信息，请参阅处理程序。

如果存在，则此格式化字符串将覆盖来自此模块的事件的索引（对于 Elasticsearch 输出），或设置事件元数据的 raw_index 字段（对于其他输出）。此字符串只能引用代理名称和版本以及事件时间戳；要访问动态字段，请使用 output.elasticsearch.index 或处理程序。

示例值："%{[agent.name]}-myindex-%{+yyyy.MM.dd}" 可能会扩展为 "metricbeat-myindex-2019.12.13"。

如果此选项设置为 true，则具有 null 值的字段将在输出文档中发布。默认情况下，keep_null 设置为 false。

用户给定的从其中收集数据的服务的名称。例如，它可以用于标识从具有相同 service.type 的不同集群节点收集的信息。

将主机定义为 HTTP URL 的模块和指标集可以使用 HTTP 的标准方案（http:// 和 https://）以及以下方案来连接到本地管道

以下选项可用于将主机定义为 HTTP URL 的模块和指标集

用于基本身份验证的用户名。

用于基本身份验证的密码。

完成 HTTP 连接的总时间限制（默认值：2 秒）。

模块发出的 HTTP 请求的总时间限制（默认值：10 秒）。

用于 HTTPS 连接的 SSL 参数的配置选项，例如要使用的证书颁发机构。

有关更多信息，请参阅SSL。

要用于 HTTP 请求的标头列表。例如

headers:
  Cookie: abcdef=123456
  My-Custom-Header: my-custom-value

如果已定义，Metricbeat 将在初始化时读取一次文件内容，然后将该值用于 HTTP 授权标头。

要在 HTTP URI 中使用的可选基本路径。如果已定义，Metricbeat 将此值作为 HTTP URI 路径中的第一个段插入。

在 YAML 中传递通用查询参数的可选值。您可以使用 ?key=value&key2&value2 语法在主机值中设置查询参数，而不是在此处进行设置，如下所示

query:
  key: value
  key2: value2
  list:
  - 1.1
  - 2.95
  - -15