指标过滤器插件编辑

  • 插件版本:v4.0.7
  • 发布时间:2021-01-20
  • 更新日志

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

获取帮助编辑

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

描述编辑

指标过滤器对聚合指标非常有用。

Elasticsearch 2.0 不再允许字段名称中包含点。指标过滤器插件 3.0 版更改了行为,使用嵌套字段而不是点符号来避免与 Elasticsearch 2.0+ 版本冲突。请注意文档中的更改(使用下划线和子字段)。

例如,如果您有一个字段 response 是 http 响应代码,并且您想统计每种响应的数量,您可以这样做

    filter {
      metrics {
        meter => [ "http_%{response}" ]
        add_tag => "metric"
      }
    }

指标默认每 5 秒刷新一次,或根据 flush_interval 刷新。指标在事件流中显示为新事件,并通过之后出现的任何过滤器以及输出。

通常,您需要为指标添加一个标签,并让输出明确查找该标签。

刷新的事件将以下列方式包含每个 *meter* 和 *timer* 指标

meter编辑

对于 meter => "thing",您将收到以下字段

  • "[thing][count]" - 事件总数
  • "[thing][rate_1m]" - 1 分钟滑动窗口中的每秒事件速率
  • "[thing][rate_5m]" - 5 分钟滑动窗口中的每秒事件速率
  • "[thing][rate_15m]" - 15 分钟滑动窗口中的每秒事件速率

timer编辑

对于 timer => { "thing" => "%{duration}" },您将收到以下字段

  • "[thing][count]" - 事件总数
  • "[thing][rate_1m]" - 1 分钟滑动窗口中的每秒平均值
  • "[thing][rate_5m]" - 5 分钟滑动窗口中的每秒平均值
  • "[thing][rate_15m]" - 15 分钟滑动窗口中的每秒平均值
  • "[thing][min]" - 此指标的最小值
  • "[thing][max]" - 此指标的最大值
  • "[thing][stddev]" - 此指标的标准差
  • "[thing][mean]" - 此指标的平均值
  • "[thing][pXX]" - 此指标的第 XX 个百分位数(请参阅 percentiles

可以使用 rates 选项配置事件速率窗口的默认长度(1、5 和 15 分钟)。

示例:计算事件速率编辑

举一个简单的例子,让我们跟踪每秒钟通过 logstash 的事件数量

    input {
      generator {
        type => "generated"
      }
    }

    filter {
      if [type] == "generated" {
        metrics {
          meter => "events"
          add_tag => "metric"
        }
      }
    }

    output {
      # only emit events with the 'metric' tag
      if "metric" in [tags] {
        stdout {
          codec => line {
            format => "rate: %{[events][rate_1m]}"
          }
        }
      }
    }

运行上述代码

    % bin/logstash -f example.conf
    rate: 23721.983566819246
    rate: 24811.395722536377
    rate: 25875.892745934525
    rate: 26836.42375967113

我们看到输出包含事件的 1 分钟速率。

在现实世界中,您会将其发送到 graphite 或其他指标存储,如下所示

    output {
      graphite {
        metrics => [ "events.rate_1m", "%{[events][rate_1m]}" ]
      }
    }

指标过滤器配置选项编辑

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

另请参阅通用选项,了解所有过滤器插件支持的选项列表。

 

clear_interval编辑

  • 值类型为数字
  • 默认值为 -1

清除间隔,此时所有计数器都将重置。

如果设置为 -1(默认值),则永远不会清除指标。否则,应为 5 秒的倍数。

flush_interval编辑

  • 值类型为数字
  • 默认值为 5

刷新间隔,此时创建指标事件。必须为 5 秒的倍数。

ignore_older_than编辑

  • 值类型为数字
  • 默认值为 0

不跟踪 @timestamp 超过一定秒数的事件。

如果您只想在指标中包含接近实时的事件,这将非常有用。

例如,要仅统计实时 10 秒内的事件,您可以这样做

filter {
  metrics {
    meter => [ "hits" ]
    ignore_older_than => 10
  }
}

meter编辑

  • 值类型为数组
  • 默认值为 []

语法:meter => [ "指标名称", "指标名称" ]

percentiles编辑

  • 值类型为数组
  • 默认值为 [1, 5, 10, 90, 95, 99, 100]

应为计时器值测量和发出的百分位数。

rates编辑

  • 值类型为数组
  • 默认值为 [1, 5, 15]

应测量的速率,以分钟为单位。可能的值为 1、5 和 15。

timer编辑

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

语法:timer => [ "指标名称", "%{time_value}" ]

通用选项编辑

以下配置选项受所有过滤器插件支持

add_field编辑

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

如果此过滤器成功,则向此事件添加任何任意字段。字段名称可以是动态的,并且可以使用 %{field} 包含事件的一部分。

示例

    filter {
      metrics {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }
    # You can also add multiple fields at once:
    filter {
      metrics {
        add_field => {
          "foo_%{somefield}" => "Hello world, from %{host}"
          "new_field" => "new_static_value"
        }
      }
    }

如果事件的字段 "somefield" == "hello",则此过滤器在成功时将添加字段 foo_hello(如果存在),其值为上述值,并将 %{host} 部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。

add_tag编辑

  • 值类型为数组
  • 默认值为 []

如果此过滤器成功,则向事件添加任意标签。标签可以是动态的,并且可以使用 %{field} 语法包含事件的一部分。

示例

    filter {
      metrics {
        add_tag => [ "foo_%{somefield}" ]
      }
    }
    # You can also add multiple tags at once:
    filter {
      metrics {
        add_tag => [ "foo_%{somefield}", "taggedy_tag"]
      }
    }

如果事件的字段 "somefield" == "hello",则此过滤器在成功时将添加标签 foo_hello(第二个示例当然会添加 taggedy_tag 标签)。

enable_metric编辑

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

id编辑

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

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

    filter {
      metrics {
        id => "ABC"
      }
    }

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

periodic_flush编辑

定期调用过滤器刷新方法。可选。

remove_field编辑

  • 值类型为数组
  • 默认值为 []

如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并且可以使用 %{field} 示例

    filter {
      metrics {
        remove_field => [ "foo_%{somefield}" ]
      }
    }
    # You can also remove multiple fields at once:
    filter {
      metrics {
        remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
      }
    }

如果事件具有字段 "somefield" == "hello",则此过滤器在成功时将删除名为 foo_hello 的字段(如果存在)。第二个示例将删除另一个非动态字段。

remove_tag编辑

  • 值类型为数组
  • 默认值为 []

如果此过滤器成功,则从事件中删除任意标签。标签可以是动态的,并且可以使用 %{field} 语法包含事件的一部分。

示例

    filter {
      metrics {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }
    # You can also remove multiple tags at once:
    filter {
      metrics {
        remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
      }
    }

如果事件具有字段 "somefield" == "hello",则此过滤器在成功时将删除标签 foo_hello(如果存在)。第二个示例还将删除一个不需要的标签。