Riemann 输出插件

编辑

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

安装

编辑

对于默认未捆绑的插件,可以通过运行 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

编辑

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

enable_metric

编辑

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

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

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

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

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