› ›

Metricize 过滤器插件

编辑

Metricize 过滤器插件

编辑

插件版本: v3.0.3
发布日期: 2017-11-07
更新日志

对于其他版本，请参见版本化插件文档.

安装

编辑

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

获取帮助

编辑

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

描述

编辑

metricize 过滤器接收包含多个指标的复杂事件，并将这些事件拆分为多个事件，每个事件包含单个指标。

示例

Assume the following filter configuration:

filter {
  metricize {
    metrics => [ "metric1", "metric2" ]
  }
}

Assuming the following event is passed in:

{
     type => "type A"
     metric1 => "value1"
     metric2 => "value2"
}

This will result in the following 2 events being generated in addition to the original event:

{                               {
    type => "type A"                type => "type A"
    metric => "metric1"             metric => "metric2"
    value => "value1"               value => "value2"
}                               }

Metricize 过滤器配置选项

编辑

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

设置	输入类型	必需
`drop_original_event`	布尔值	否
`metric_field_name`	字符串	否
`metrics`	数组	是
`value_field_name`	字符串	否

另请参见常用选项，了解所有过滤器插件支持的选项列表。

`drop_original_event`

编辑

值类型为布尔值
默认值为 false

指示是否应丢弃原始事件的标志。

`metric_field_name`

编辑

值类型为字符串
默认值为 "metric"

将指标名称写入的字段的名称。

`metrics`

编辑

这是一个必需的设置。
值类型为数组
此设置没有默认值。

对于此列表中的每个指标字段，都会创建一个新的指标事件。此列表中的所有字段都将从生成的事件中删除。

`value_field_name`

编辑

值类型为字符串
默认值为 "value"

将指标值写入的字段的名称。

常用选项

编辑

所有过滤器插件都支持这些配置选项

设置	输入类型	必需
`add_field`	哈希表	否
`add_tag`	数组	否
`enable_metric`	布尔值	否
`id`	字符串	否
`periodic_flush`	布尔值	否
`remove_field`	数组	否
`remove_tag`	数组	否

`add_field`

编辑

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

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

示例

    filter {
      metricize {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }

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

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

`add_tag`

编辑

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

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

示例

    filter {
      metricize {
        add_tag => [ "foo_%{somefield}" ]
      }
    }

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

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加标签 foo_hello（第二个示例当然会添加 taggedy_tag 标签）。

`enable_metric`

编辑

值类型为布尔值
默认值为 true

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

`id`

编辑

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

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

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

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

`periodic_flush`

编辑

值类型为布尔值
默认值为 false

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

`remove_field`

编辑

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

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

    filter {
      metricize {
        remove_field => [ "foo_%{somefield}" ]
      }
    }

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

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

`remove_tag`

编辑

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

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

示例

    filter {
      metricize {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }

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

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

« Memcached 过滤器插件 Metrics 过滤器插件 »