Graphite 输出插件

编辑
  • 插件版本: v3.1.6
  • 发布日期: 2018-07-11
  • 变更日志

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

获取帮助

编辑

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

描述

编辑

此输出允许您从日志中提取指标并将它们发送到 Graphite。Graphite 是一个用于存储和绘制指标图的开源工具。

一个用例示例:某些应用程序每 10 秒在日志中发出聚合统计信息。使用 grok 过滤器和此输出,可以从日志中捕获指标值并将它们发送到 Graphite。

Graphite 输出配置选项

编辑

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

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

 

exclude_metrics

编辑
  • 值类型为数组
  • 默认值为["%{[^}]+}"]

排除正则表达式匹配的指标名称,默认情况下排除未解析的 %{field} 字符串。

fields_are_metrics

编辑

一个数组,指示这些事件字段应被视为指标,并将逐字发送到 Graphite。您可以使用 fields_are_metricsmetrics,但不能同时使用两者。

host

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

Graphite 服务器的主机名或 IP 地址。

include_metrics

编辑
  • 值类型为数组
  • 默认值为 [".*"]

仅包含正则表达式匹配的指标名称。

metrics

编辑
  • 值类型为哈希
  • 默认值为{}

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

    metrics => { "%{host}/uptime" => "%{uptime_1m}" }

该值将被强制转换为浮点值。无法强制转换的值将被设置为零 (0)。您可以使用 metricsfields_are_metrics,但不能同时使用两者。

metrics_format

编辑

定义指标字符串的格式。占位符*将被实际指标的名称替换。

    metrics_format => "foo.bar.*.sum"

如果未定义 metrics_format,则指标名称将用作后备。

nested_object_separator

编辑

当哈希作为值传入时,它们会被分解为点号表示法。例如,如果您使用以下配置此插件# [source,ruby] metrics ⇒ "mymetrics"

并且 "mymetrics" 是一个嵌套哈希,其中 {a ⇒ 1, b ⇒ { c ⇒ 2 }},则此插件将生成两个指标:a ⇒ 1 和 b.c ⇒ 2。如果您指定了 metrics_format,它将遵守该格式,但您仍然可能希望控制这些嵌套键名称中的分隔符。此配置设置会将分隔符从默认的 . 更改。

port

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

要连接到 Graphite 服务器的端口。

reconnect_interval

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

重新连接到 Carbon 的尝试之间的间隔。

resend_on_failure

编辑

如果失败,是否应重新发送指标?

timestamp_field

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

使用此字段作为时间戳,而不是默认的 @timestamp。当回填或只是为了将更准确的数据导入 graphite 时,此功能非常有用,因为您可能在 Logstash 前面有一个缓存层。

通用选项

编辑

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

设置 输入类型 必需

codec

codec

enable_metric

布尔值

id

字符串

codec

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

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

enable_metric

编辑

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

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

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

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

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