Boundary 输出插件

编辑
  • 插件版本:v3.0.6
  • 发布日期:2023-05-30
  • 更新日志

对于其他版本,请参阅版本化插件文档

安装

编辑

对于默认未捆绑的插件,可以通过运行bin/logstash-plugin install logstash-output-boundary轻松安装。有关更多详细信息,请参阅使用插件

获取帮助

编辑

有关插件的问题,请在Discuss论坛中开一个主题。对于错误或功能请求,请在Github中开一个 issue。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵

描述

编辑

此输出允许您基于 Logstash 事件向 Boundary 发送注释

请注意,由于 Logstash 不维护状态,这些将是一次性事件

默认情况下,开始和停止时间将是事件时间戳

Boundary 输出配置选项

编辑

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

另请参阅通用选项,查看所有输出插件支持的选项列表。

 

api_key

编辑
  • 这是一个必填设置。
  • 值类型为密码
  • 此设置没有默认值。

您的 Boundary API 密钥

auto

编辑

Auto 如果设置为 true,logstash 将尝试从事件中提取 boundary 字段。任何通过配置选项显式设置的字段都将覆盖这些字段。['type', 'subtype', 'creation_time', 'end_time', 'links', 'tags', 'loc']

bsubtype

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

子类型

btags

编辑
  • 值类型为数组
  • 此设置没有默认值。

为该事件设置任何自定义标签。默认值为 Logstash 标签(如果有)

btype

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

类型

end_time

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

结束时间覆盖停止时间。请注意,Boundary 要求这是自 epoch 以来的秒数。如果覆盖,您有责任正确键入此值。默认情况下,此值设置为event.get("@timestamp").to_i

org_id

编辑
  • 这是一个必填设置。
  • 值类型为字符串
  • 此设置没有默认值。

您的 Boundary 组织 ID

start_time

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

开始时间覆盖开始时间。请注意,Boundary 要求这是自 epoch 以来的秒数。如果覆盖,您有责任正确键入此值。默认情况下,此值设置为event.get("@timestamp").to_i

通用选项

编辑

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

设置 输入类型 必填

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑
  • 值类型为codec
  • 默认值为"plain"

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

enable_metric

编辑

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

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

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

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

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