GCP Pub/Sub 输入

除了稍后描述的通用选项之外，gcp-pubsub 输入还支持以下配置选项。

Google Cloud 项目 ID。必需。

Google Cloud Pub/Sub 主题名称。必需。

要从中读取的订阅的名称。必需。

布尔值，用于配置输入在订阅不存在时创建订阅。默认值为 true。

要创建以从订阅读取的 goroutine 数量。这不会限制可以并发处理的消息数量或输入将创建的最大 goroutine 数量。即使只有一个 goroutine，也可能同时处理许多消息，因为该 goroutine 可能会持续接收消息。要限制正在并发处理的消息数量，请设置 subscription.max_outstanding_messages。默认值为 1。

未处理消息（未确认但尚未过期）的最大数量。如果该值为负数，则未处理消息的数量将没有限制。由于内部队列的存在，输入会一直阻塞，直到达到 queue.mem.flush.min_events 或 queue.mem.flush.timeout。为了防止此阻塞，此选项必须至少为 queue.mem.flush.min_events。默认值为 1600。

包含用于订阅的凭据和密钥的 JSON 文件的路径。或者，您可以使用 credentials_json 配置选项或依靠Google 应用默认凭据 (ADC)。

包含用于订阅的凭据和密钥的 JSON 块。如果您想将凭据数据嵌入到配置文件中或将信息放入密钥库中，则可以使用此选项作为 credentials_file 的替代方案。您也可以使用Google 应用默认凭据 (ADC)。

所有输入都支持以下配置选项。

使用 enabled 选项启用和禁用输入。默认情况下，enabled 设置为 true。

Filebeat 在每个发布事件的 tags 字段中包含的一系列标签。标签使您能够轻松地在 Kibana 中选择特定事件或在 Logstash 中应用条件过滤。这些标签将附加到在常规配置中指定的标签列表中。

示例

filebeat.inputs:
- type: gcp-pubsub
  . . .
  tags: ["json"]

您可以指定的可选字段，以向输出添加其他信息。例如，您可以添加可用于过滤日志数据的字段。字段可以是标量值、数组、字典或这些的任何嵌套组合。默认情况下，您在此处指定的字段将在输出文档中的 fields 子字典下分组。要将自定义字段存储为顶级字段，请将 fields_under_root 选项设置为 true。如果在常规配置中声明了重复字段，则其值将被此处声明的值覆盖。

filebeat.inputs:
- type: gcp-pubsub
  . . .
  fields:
    app_id: query_engine_12

如果将此选项设置为 true，则自定义fields 将存储为输出文档中的顶级字段，而不是分组在 fields 子字典下。如果自定义字段名称与 Filebeat 添加的其他字段名称冲突，则自定义字段会覆盖其他字段。

要应用于输入数据的处理器列表。

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

为此输入生成的事件设置的摄取管道 ID。

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

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

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

默认情况下，所有事件都包含 host.name。此选项可以设置为 true 以禁用将此字段添加到所有事件中。默认值为 false。

此输入在HTTP 监控端点下公开指标。这些指标在 /inputs 路径下公开。它们可用于观察输入的活动。