Metriccatcher 输出插件

编辑

Metriccatcher 输出插件

编辑
  • 插件版本:v3.0.4
  • 发布日期:2018-04-06
  • 变更日志

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

安装

编辑

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

获取帮助

编辑

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

描述

编辑

此输出将指标发送到 MetricCatcher,允许您利用 Coda Hale 的指标。

有关 MetricCatcher 的更多信息:https://github.com/clearspring/MetricCatcher

在 Clearspring,我们使用它来统计 Apache 日志中的响应代码

    metriccatcher {
        host => "localhost"
        port => "1420"
        type => "apache-access"
        fields => [ "response" ]
        meter => {
            "%{host}.apache.response.%{response}" => "1"
            }
    }

Metriccatcher 输出配置选项

编辑

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

设置 输入类型 必填

biased

hash

counter

hash

gauge

hash

host

字符串

meter

hash

port

数字

timer

hash

uniform

hash

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

 

biased

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

要发送的指标。这支持动态字符串,例如 %{host} 用于指标名称和值。这是一个哈希字段,键为指标名称,值为指标值。

该值将强制转换为浮点值。无法强制转换的值将为零 (0)

counter

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

要发送的指标。这支持动态字符串,例如 %{host} 用于指标名称和值。这是一个哈希字段,键为指标名称,值为指标值。示例

  counter => { "%{host}.apache.hits.%{response} => "1" }

该值将强制转换为浮点值。无法强制转换的值将为零 (0)

gauge

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

要发送的指标。这支持动态字符串,例如 %{host} 用于指标名称和值。这是一个哈希字段,键为指标名称,值为指标值。

该值将强制转换为浮点值。无法强制转换的值将为零 (0)

host

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

MetricCatcher 的地址

meter

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

要发送的指标。这支持动态字符串,例如 %{host} 用于指标名称和值。这是一个哈希字段,键为指标名称,值为指标值。

该值将强制转换为浮点值。无法强制转换的值将为零 (0)

port

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

连接 MetricCatcher 的端口

timer

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

要发送的指标。这支持动态字符串,例如 %{host} 用于指标名称和值。这是一个哈希字段,键为指标名称,值为指标值。示例

  timer => { "%{host}.apache.response_time => "%{response_time}" }

该值将强制转换为浮点值。无法强制转换的值将为零 (0)

uniform

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

要发送的指标。这支持动态字符串,例如 %{host} 用于指标名称和值。这是一个哈希字段,键为指标名称,值为指标值。

该值将强制转换为浮点值。无法强制转换的值将为零 (0)

通用选项

编辑

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

设置 输入类型 必填

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑

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

enable_metric

编辑

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

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

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

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

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