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

编辑

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

bsubtype

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

子类型

btags

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

标签。设置此事件的任何自定义标签。如果没有,则默认为 Logstash 标签。

btype

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

类型

end_time

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

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

org_id

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

您的 Boundary Org ID

start_time

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

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

常用选项

编辑

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

设置 输入类型 必填

编解码器

编解码器

启用指标

布尔值

ID

字符串

codec

编辑

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

enable_metric

编辑

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

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

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

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

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