指标化过滤器插件
编辑指标化过滤器插件
编辑- 插件版本: v3.0.3
- 发布日期: 2017-11-07
- 变更日志
对于其他版本，请参阅版本化的插件文档。
安装
编辑对于默认未捆绑的插件，可以通过运行 bin/logstash-plugin install logstash-filter-metricize 来轻松安装。有关更多详细信息，请参阅使用插件。
获取帮助
编辑有关该插件的问题，请在Discuss论坛中开启一个主题。对于错误或功能请求，请在Github中开启一个 issue。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。
描述
编辑指标化过滤器将包含多个指标的复杂事件拆分为多个事件，每个事件只包含一个指标。
示例
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"
} }
通用选项
编辑所有过滤器插件都支持这些配置选项
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
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 标签）。
id
编辑- 值类型为字符串
- 此设置没有默认值。
向插件配置添加唯一的 ID。如果未指定 ID，Logstash 将生成一个 ID。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时，这特别有用，例如，如果您有 2 个指标化过滤器。在这种情况下添加命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter {
metricize {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用来自密钥存储的值。
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（如果存在）。第二个示例也会删除一个悲伤的、不需要的标签。