› › ›

配置 Kafka 输出

Kafka 输出将事件发送到 Apache Kafka。

要使用此输出，请编辑 Heartbeat 配置文件，通过注释掉 Elasticsearch 输出将其禁用，并通过取消注释 Kafka 部分来启用 Kafka 输出。

对于 Kafka 0.10.0.0+ 版本，消息创建时间戳由 Beats 设置，等于事件的初始时间戳。这会影响 Kafka 中的保留策略：例如，如果一个 Beat 事件是在 2 周前创建的，保留策略设置为 7 天，并且来自 Beats 的消息今天到达 Kafka，那么它将立即被丢弃，因为时间戳值早于过去 7 天。可以通过在消息到达时设置时间戳来更改此行为，以便消息不会被丢弃，而是保留 7 天。为此，请在 Kafka 配置中将 log.message.timestamp.type 设置为 LogAppendTime（默认值为 CreateTime）。

示例配置

output.kafka:
  # initial brokers for reading cluster metadata
  hosts: ["kafka1:9092", "kafka2:9092", "kafka3:9092"]

  # message topic selection + partitioning
  topic: '%{[fields.log_topic]}'
  partition.round_robin:
    reachable_only: false

  required_acks: 1
  compression: gzip
  max_message_bytes: 1000000

大于 max_message_bytes 的事件将被丢弃。为避免此问题，请确保 Heartbeat 生成的事件不大于 max_message_bytes。

兼容性

编辑

此输出可以连接到 Kafka 0.8.2.0 及更高版本。较旧的版本也可能有效，但不支持。

配置选项

编辑

您可以在 heartbeat.yml 配置文件的 kafka 部分中指定以下选项

`enabled`

编辑

enabled 配置是一个布尔值设置，用于启用或禁用输出。如果设置为 false，则输出被禁用。

默认值为 true。

`hosts`

编辑

要从中获取集群元数据的 Kafka 代理地址列表。集群元数据包含事件发布到的实际 Kafka 代理。

`version`

编辑

Heartbeat 连接时将请求的 Kafka 协议版本。默认为 1.0.0。

有效值为 0.8.2.0 和 2.6.0 之间的 Kafka 所有版本。

协议版本控制 Kafka 客户端可用于 Heartbeat 的功能；它不会阻止 Heartbeat 连接到比协议版本更新的 Kafka 版本。

有关支持的版本信息，请参阅兼容性。

`username`

编辑

连接到 Kafka 的用户名。如果配置了用户名，则也必须配置密码。

`password`

编辑

连接到 Kafka 的密码。

`sasl.mechanism`

编辑

连接到 Kafka 时使用的 SASL 机制。它可以是以下之一：

PLAIN 用于 SASL/PLAIN。
SCRAM-SHA-256 用于 SCRAM-SHA-256。
SCRAM-SHA-512 用于 SCRAM-SHA-512。

如果未设置 sasl.mechanism，则如果提供了 username 和 password，则使用 PLAIN。否则，SASL 身份验证将被禁用。

要使用 GSSAPI 机制使用 Kerberos 进行身份验证，必须将此字段留空，并使用 kerberos 选项。

`topic`

编辑

用于生成事件的 Kafka 主题。

您可以使用格式字符串访问任何事件字段来动态设置主题。例如，此配置使用自定义字段 fields.log_topic 来设置每个事件的主题

topic: '%{[fields.log_topic]}'

要了解如何向事件添加自定义字段，请参阅 fields 选项。

有关其他动态设置主题的方法，请参阅 topics 设置。

`topics`

编辑

主题选择器规则数组。每个规则指定用于与规则匹配的事件的 topic。在发布期间，Heartbeat 根据数组中第一个匹配规则为每个事件设置 topic。规则可以包含条件、基于格式字符串的字段和名称映射。如果缺少 topics 设置或没有规则匹配，则使用 topic 字段。

规则设置

topic: 要使用的主题格式字符串。如果此字符串包含字段引用，例如 %{[fields.name]}，则必须存在这些字段，否则规则将失败。
mappings: 一个字典，它获取 topic 返回的值并将其映射到一个新名称。
default: 如果 mappings 未找到匹配项，则要使用的默认字符串值。
when: 必须成功的条件才能执行当前规则。此处也支持处理器支持的所有条件。

以下示例根据消息字段是否包含指定的字符串来设置主题

output.kafka:
  hosts: ["localhost:9092"]
  topic: "logs-%{[agent.version]}"
  topics:
    - topic: "critical-%{[agent.version]}"
      when.contains:
        message: "CRITICAL"
    - topic: "error-%{[agent.version]}"
      when.contains:
        message: "ERR"

此配置导致名为 critical-8.16.0、error-8.16.0 和 logs-8.16.0 的主题。

`key`

编辑

指定 Kafka 事件密钥的可选格式化字符串。如果已配置，则可以使用格式字符串从事件中提取事件密钥。

有关特定密钥选择的含义，请参阅 Kafka 文档；默认情况下，密钥由 Kafka 集群选择。

`partition`

编辑

Kafka 输出代理事件分区策略。必须是 random、round_robin 或 hash 之一。默认情况下，使用 hash 分区器。

random.group_events：在分区器随机选择新分区之前，设置要发布到同一分区的事件数。默认值为 1，这意味着在每个事件之后都会随机选择一个新分区。

round_robin.group_events：在分区器选择下一个分区之前，设置要发布到同一分区的事件数。默认值为 1，这意味着在每个事件之后将选择下一个分区。

hash.hash：用于从事件中计算分区哈希值的字段列表。如果未配置任何字段，则将使用事件的 key 值。

hash.random：如果无法计算哈希值或密钥值，则随机分配事件。

默认情况下，所有分区器都将尝试将事件发布到所有分区。如果分区的领导者对于 Beat 变得不可访问，则输出可能会阻塞。所有分区器都支持设置 reachable_only 以覆盖此行为。如果 reachable_only 设置为 true，则事件将仅发布到可用的分区。

发布到可用分区的一个子集可能会增加资源使用量，因为事件可能会分布不均。

`headers`

编辑

标头是键值对，可以使用相同的 key 包含多个标头。仅支持字符串值。这些标头将包含在每个生成的 Kafka 消息中。

output.kafka:
  hosts: ["localhost:9092"]
  topic: "logs-%{[agent.version]}"
  headers:
    - key: "some-key"
      value: "some value"
    - key: "another-key"
      value: "another value"

`client_id`

编辑

用于日志记录、调试和审计目的的可配置 ClientID。默认为“beats”。

`codec`

编辑

输出编解码器配置。如果缺少 codec 部分，则事件将被 JSON 编码。

有关更多信息，请参阅更改输出编解码器。

`metadata`

编辑

Kafka 元数据更新设置。元数据包含有关代理、主题、分区和用于发布的活动领导者的信息。

refresh_frequency: 元数据刷新间隔。默认为 10 分钟。
full: 获取元数据时要使用的策略，当此选项为 true 时，客户端将为所有可用主题维护一组完整的元数据，如果此选项设置为 false，则它将仅刷新配置主题的元数据。默认为 false。
retry.max: 当集群处于领导者选举中间时，元数据更新重试的总数。默认为 3。
retry.backoff: 领导者选举期间重试之间的等待时间。默认为 250 毫秒。