Riemann 输出插件

编辑
  • 插件版本: v3.0.7
  • 发布日期: 2020-07-15
  • 更新日志

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

安装

编辑

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

获取帮助

编辑

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

描述

编辑

Riemann 是一个网络事件流处理系统。

虽然 Riemann 在概念上与 Logstash 非常相似,但在作为监控系统替代品方面,它拥有更多功能。

Riemann 在 Logstash 中的使用方式与 statsd 或其他与指标相关的输出类似。

您可以在此处了解 Riemann

您可以在此处观看作者的讲解视频

Riemann 输出配置选项

编辑

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

设置 输入类型 必填

debug

布尔值

host

字符串

map_fields

布尔值

port

数字

protocol

字符串,其中之一 ["tcp", "udp"]

riemann_event

哈希表

sender

字符串

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

 

debug

编辑

启用调试输出?

host

编辑
  • 值类型为 字符串
  • 默认值为 "localhost"

Riemann 服务器的地址。

map_fields

编辑

如果设置为 true,则自动将所有 Logstash 定义的字段映射到 riemann 事件字段。所有嵌套的 Logstash 字段都将映射到包含所有父键(用点分隔)和最深值 riemann 字段。

例如,Logstash 事件

   {
     "@timestamp":"2013-12-10T14:36:26.151+0000",
     "@version": 1,
     "message":"log message",
     "host": "host.domain.com",
     "nested_field": {
                       "key": "value"
                     }
   }

映射到此 Riemann 事件

  {
    :time 1386686186,
    :host host.domain.com,
    :message log message,
    :nested_field.key value
  }

它可以与 riemann_event 选项结合使用,也可以独立使用。当与 riemann_event 一起使用时,任何重复的键都将从 riemann_event 而不是 Logstash 事件本身接收其值。

port

编辑
  • 值类型为 数字
  • 默认值为 5555

连接到 Riemann 服务器的端口。

protocol

编辑
  • 值可以是:tcpudp
  • 默认值为 "tcp"

要使用的协议 UDP是非阻塞的,TCP是阻塞的

Logstash 的默认输出行为是绝不丢失事件。因此,我们在此处使用 tcp 作为默认值。

riemann_event

编辑
  • 值类型为 哈希表
  • 此设置没有默认值。

用于设置 Riemann 事件字段的哈希表 (http://riemann.io/concepts.html)。

支持以下事件字段:descriptionstatemetricttlservice

Logstash 事件中找到的标签将自动添加到 Riemann 事件中。

此处设置的任何其他字段都将作为事件属性传递给 Riemann。

示例

    riemann {
        riemann_event => {
            "metric"  => "%{metric}"
            "service" => "%{service}"
        }
    }

metricttl 值将被强制转换为浮点值。无法强制转换的值将为零 (0.0)。

description 默认情况下将设置为事件消息,但此处可以覆盖。

sender

编辑
  • 值类型为 字符串
  • 默认值为 "%{host}"

发送者的名称。这将设置 Riemann 事件中的 host 值。

常用选项

编辑

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

设置 输入类型 必填

codec

codec

enable_metric

布尔值

id

字符串

codec

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

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

enable_metric

编辑

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

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

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

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

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