边界输出插件编辑

  • 插件版本:v3.0.6
  • 发布时间:2023-05-30
  • 更新日志

有关其他版本,请参阅版本化插件文档

安装编辑

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

获取帮助编辑

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

描述编辑

此输出允许您根据 Logstash 事件将注释发送到 Boundary

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

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

边界输出配置选项编辑

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

设置 输入类型 是否必需

api_key

密码

自动

布尔值

bsubtype

字符串

btags

数组

btype

字符串

end_time

字符串

org_id

字符串

start_time

字符串

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

 

api_key编辑

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

您的 Boundary API 密钥

自动编辑

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

bsubtype编辑

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

子类型

btags编辑

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

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

btype编辑

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

类型

end_time编辑

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

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

org_id编辑

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

您的 Boundary 组织 ID

start_time编辑

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

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

通用选项编辑

所有输出插件都支持以下配置选项

设置 输入类型 是否必需

编解码器

编解码器

enable_metric

布尔值

id

字符串

编解码器编辑

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

enable_metric编辑

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

id编辑

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

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

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

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