› › ›

配置 Kafka 输出

配置 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 版本。

协议版本控制可用于 Heartbeat 的 Kafka 客户端功能；它不会阻止 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.14.3、error-8.14.3 和 logs-8.14.3 的主题。

`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 毫秒。

`max_retries`编辑

在发布失败后重试发布事件的次数。在指定的重试次数后，事件通常会被丢弃。

将 max_retries 设置为小于 0 的值，以便在所有事件发布之前一直重试。

默认值为 3。

`backoff.init`编辑

在网络错误后，在尝试重新发布到 Kafka 之前要等待的秒数。在等待 backoff.init 秒后，Heartbeat 将尝试重新发布。如果尝试失败，则回退计时器将以指数方式增加，直到达到 backoff.max。在成功发布后，回退计时器将重置。默认值为 1 秒。

`backoff.max`编辑

在网络错误后尝试重新发布到 Kafka 之前要等待的最大秒数。默认值为 60 秒。

`bulk_max_size`edit

一次 Kafka 请求中可以批量处理的最大事件数。默认值为 2048。

`bulk_flush_frequency`edit

在发送批量 Kafka 请求之前要等待的持续时间。0 表示没有延迟。默认值为 0。

`timeout`edit

在超时之前等待来自 Kafka 代理的响应的秒数。默认值为 30（秒）。

`broker_timeout`edit

代理等待所需 ACK 数的最大持续时间。默认值为 10 秒。

`channel_buffer_size`edit

每个 Kafka 代理在输出管道中缓冲的消息数量。默认值为 256。

`keep_alive`edit

活动网络连接的保持活动时间段。如果为 0 秒，则禁用保持活动。默认值为 0 秒。

`compression`edit

设置输出压缩编解码器。必须是 none、snappy、lz4 和 gzip 之一。默认值为 gzip。

Azure Event Hub for Kafka 的已知问题

当目标为 Azure Event Hub for Kafka 时，请将 compression 设置为 none，因为提供的编解码器不受支持。

`compression_level`edit

设置 gzip 使用的压缩级别。将此值设置为 0 将禁用压缩。压缩级别必须在 1（最佳速度）到 9（最佳压缩）之间。

提高压缩级别将减少网络使用量，但会增加 CPU 使用量。

默认值为 4。

`max_message_bytes`edit

JSON 编码消息的最大允许大小。较大的消息将被丢弃。默认值为 1000000（字节）。此值应该等于或小于代理的 message.max.bytes。

`required_acks`edit

代理所需的 ACK 可靠性级别。0=无响应，1=等待本地提交，-1=等待所有副本提交。默认值为 1。

注意：如果设置为 0，则 Kafka 不会返回任何 ACK。消息可能会在错误时被静默丢失。

`ssl`edit

用于 SSL 参数的配置选项，例如 Kafka 连接的根 CA。Kafka 主机密钥库应使用 -keyalg RSA 参数创建，以确保它使用 Filebeat 的 Kafka 库支持的密码。有关更多信息，请参见 SSL。

`kerberos`edit

此功能处于测试阶段，可能会发生变化。设计和代码不如官方 GA 功能成熟，并且按原样提供，不提供任何保证。测试版功能不受官方 GA 功能支持 SLA 的约束。

Kerberos 身份验证的配置选项。

有关更多信息，请参见 Kerberos。

« 配置 Logstash 输出配置 Redis 输出 »

配置 Kafka 输出