Google Cloud Pub/Sub 输出插件

编辑

Google Cloud Pub/Sub 输出插件

编辑
  • 插件版本:v1.2.0
  • 发布日期:2023-08-22
  • 更新日志

其他版本,请参见 版本化插件文档.

安装

编辑

对于默认情况下未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-google_pubsub 轻松安装。更多详情,请参见 使用插件

获取帮助

编辑

如有关于插件的问题,请在 Discuss 论坛中发起主题。如遇错误或有功能请求,请在 Github 中提交问题。如需查看 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵

描述

编辑

一个 Logstash 插件,用于将日志事件上传到 Google Cloud Pub/Sub。为了提高效率,事件会批量处理并在后台上传。消息有效负载是事件的序列化 JSON 表示。

用例示例

  • 通过 Pub/Sub 将事件流传输到 Dataproc 以进行实时分析。
  • 将本地数据中心的事件转发到云中的 Logstash。
  • 使用 Pub/Sub 作为可扩展缓冲区,以平衡处理步骤之间的事件流。

注意:虽然 Google 部分维护此项目,但这并非 Google 官方产品。

环境配置

编辑

要使用此插件,必须创建一个 服务帐号 并授予其主题的发布权限。您也可以使用分配给计算实例的 应用程序默认凭据

在运行插件之前,Pub/Sub 主题 *必须* 存在。

配置示例

编辑

基本配置

编辑

一个仅包含项目、主题和 JSON 密钥文件的基本配置

output {
  google_pubsub {
    # Required attributes
    project_id => "my_project"
    topic => "my_topic"

    # Optional if you're using app default credentials
    json_key_file => "service_account_key.json"
  }
}

高负载

编辑

如果您发现上传速度太慢,可以增加消息批量处理大小。

output {
  google_pubsub {
    project_id => "my_project"
    topic => "my_topic"
    json_key_file => "service_account_key.json"

    # Options for configuring the upload
    message_count_threshold => 1000
    delay_threshold_secs => 10
    request_byte_threshold => 5000000
  }
}

属性

编辑

您可以为每个请求附加其他属性。例如,您可以将数据中心标签附加到日志消息以帮助调试。

output {
  google_pubsub {
    project_id => "my_project"
    topic => "my_topic"
    json_key_file => "service_account_key.json"


    attributes => {"origin" => "pacific-datacenter"}
  }
}

不同的编解码器

编辑

您可以使用编解码器与该插件一起更改事件的主体。

output {
  google_pubsub {
    project_id => "my_project"
    topic => "my_topic"
    json_key_file => "service_account_key.json"


    codec => plain {format => "%{[time]}: %{[message]}"}
  }
}

Google Cloud Pub/Sub 输出配置选项

编辑

此插件支持以下配置选项以及稍后描述的 常用选项

另请参见 常用选项,了解所有输入插件支持的选项列表。

project_id

编辑
  • 值类型为 字符串
  • 此设置没有默认值。

Google Cloud 项目 ID(名称,而非编号)。

topic

编辑
  • 值类型为 字符串
  • 此设置没有默认值。

Google Cloud Pub/Sub 主题。在运行此插件之前,必须手动创建主题。

json_key_file

编辑
  • 值类型为 路径
  • 此设置没有默认值。

用于向存储桶验证用户身份的密钥路径。此服务用户*必须*具有 pubsub.topics.publish 权限,以便可以发布到主题。

如果 Logstash 在 Google Compute Engine 中运行并且未定义 json_key_file,则插件将使用 GCE 的应用程序默认凭据。在 GCE 之外,必须指定服务帐号 JSON 密钥文件。

delay_threshold_secs

编辑
  • 值类型为 数字
  • 默认为:5

从第一个消息排队的时间起,经过此延迟后发送批次。必须大于 0。

message_count_threshold

编辑
  • 值类型为 数字
  • 默认为:100

排队消息达到此数量后,即使延迟阈值尚未到期,也会在一次调用中发送所有消息。必须 < 1000。值为 0 将导致消息立即发送,但由于开销而会降低总吞吐量。

request_byte_threshold

编辑
  • 值类型为 字节
  • 默认为:1000000

批量请求中的字节数达到此阈值后,即使延迟或消息计数阈值尚未超过,也会在一次调用中发送所有消息。这包括完整的消息有效负载大小,包括设置的任何属性。

attributes

编辑

以键值对格式添加到消息的属性。键和值*必须*是字符串。

常用选项

编辑

所有输出插件都支持这些配置选项

设置 输入类型 必填

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑

用于输出数据的编解码器。输出编解码器是在数据离开输出之前对其进行编码的一种便捷方法,无需在 Logstash 管道中使用单独的过滤器。

enable_metric

编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下,我们会记录所有可以记录的指标,但是您可以禁用特定插件的指标收集。

  • 值类型为 字符串
  • 此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID,Logstash 将生成一个。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用。例如,如果您有两个 google_pubsub 输出。在这种情况下,添加命名的 ID 将有助于在使用监控 API 时监控 Logstash。

output {
  google_pubsub {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。