Memcached 过滤器插件
编辑Memcached 过滤器插件编辑
- 插件版本:v1.2.0
- 发布时间:2023-01-18
- 更新日志
有关其他版本,请参阅版本化插件文档。
获取帮助编辑
如有关于插件的问题,请在论坛中打开一个主题。如有错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵。
描述编辑
Memcached 过滤器提供与 Memcached 中外部数据的集成。
它目前提供以下功能
-
get
:获取一个或多个 memcached 键的值,并将它们注入到事件中提供的路径中 -
set
:将事件中的值设置为相应的 memcached 键
示例编辑
此插件支持针对 Memcached 对象缓存系统进行键/值查找 enriquecimiento。您可以使用此插件查询值,如果未找到则设置它。
GET 示例编辑
memcached { hosts => ["localhost"] namespace => "convert_mm" get => { "%{millimeters}" => "[inches]" } add_tag => ["from_cache"] id => "memcached-get" }
SET 示例编辑
memcached { hosts => ["localhost"] namespace => "convert_mm" set => { "[inches]" => "%{millimeters}" } id => "memcached-set" }
Memcached 过滤器配置选项编辑
此插件支持以下配置选项以及稍后描述的通用选项。
另请参阅通用选项,以获取所有过滤器插件支持的选项列表。
hosts
编辑
- 值类型为数组
- 默认值为
localhost
hosts
参数接受与 memcached 实例对应的地址数组。
主机可以通过 FQDN(例如,example.com
)、IPV4 地址(例如,123.45.67.89
)或 IPV6 地址(例如,::1
或 2001:0db8:85a3:0000:0000:8a2e:0370:7334
)指定。如果您的 memcached 主机使用非标准端口,则可以通过附加冒号(:
)和端口号来指定端口;要包含带有 IPV6 地址的端口,必须首先将地址括在方括号([
和 ]
)中,例如,[::1]:11211
。
如果指定了多个主机,则请求将使用每个键的 CRC-32 校验和的模数分布到给定的主机。
namespace
编辑
- 值类型为字符串
- 此设置没有默认值。
如果指定,则使用给定的字符串后跟冒号(:
)作为所有 memcached 键的前缀;如果此插件使用的所有键共享一个公共前缀,则此选项很有用。
示例
在以下配置中,我们将从 memcached 中获取fruit:banana
和 fruit:apple
filter { memcached { namespace => "fruit" get => { "banana" => "[fruit-stats][banana]" "apple" => "[fruit-stats][apple] } } }
get
编辑
- 值类型为哈希
- 此设置没有默认值。
如果指定,则从 memcached 中获取给定键的值,并将它们存储在事件上的相应字段中。
- 键是插值的(例如,如果事件具有值为
bar
的字段foo
,则键sand/%{foo}
将评估为sand/bar
) - 字段可以是嵌套引用
filter { memcached { get => { "memcached-key-1" => "field1" "memcached-key-2" => "[nested][field2]" } } }
set
编辑
- 值类型为哈希
- 此设置没有默认值。
如果指定,则从给定的事件字段中提取值,并使用配置的ttl在 memcached 中将相应键设置为这些值
- 键是插值的(例如,如果事件具有值为
bar
的字段foo
,则键sand/%{foo}
将评估为sand/bar
) - 字段可以是嵌套引用
filter { memcached { set => { "field1" => "memcached-key-1" "[nested][field2]" => "memcached-key-2" } } }
通用选项编辑
以下配置选项受所有过滤器插件支持
add_field
编辑
- 值类型为哈希
- 默认值为
{}
如果此过滤器成功,则向此事件添加任意字段。字段名称可以是动态的,并且可以使用%{field}
包含事件的一部分。
示例
filter { memcached { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } } }
# You can also add multiple fields at once: filter { memcached { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" "new_field" => "new_static_value" } } }
如果事件具有字段"somefield" == "hello"
,则此过滤器在成功时将添加字段foo_hello
(如果存在),其值为上述值,并将%{host}
部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。
add_tag
编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则向事件添加任意标签。标签可以是动态的,并且可以使用%{field}
语法包含事件的一部分。
示例
filter { memcached { add_tag => [ "foo_%{somefield}" ] } }
# You can also add multiple tags at once: filter { memcached { add_tag => [ "foo_%{somefield}", "taggedy_tag"] } }
如果事件具有字段"somefield" == "hello"
,则此过滤器在成功时将添加标签foo_hello
(当然,第二个示例将添加taggedy_tag
标签)。
id
编辑
- 值类型为字符串
- 此设置没有默认值。
向插件配置添加唯一的ID
。如果未指定 ID,Logstash 将生成一个。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时,例如,如果您有两个 memcached 过滤器,这将特别有用。在这种情况下,添加命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter { memcached { id => "ABC" } }
id
字段中的变量替换仅支持环境变量,不支持使用密钥库中的值。
remove_field
编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并且可以使用 %{field} 示例
filter { memcached { remove_field => [ "foo_%{somefield}" ] } }
# You can also remove multiple fields at once: filter { memcached { remove_field => [ "foo_%{somefield}", "my_extraneous_field" ] } }
如果事件具有字段"somefield" == "hello"
,则此过滤器在成功时将删除名称为foo_hello
的字段(如果存在)。第二个示例将删除另一个非动态字段。
remove_tag
编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则从事件中删除任意标签。标签可以是动态的,并且可以使用 %{field}
语法包含事件的部分内容。
示例
filter { memcached { remove_tag => [ "foo_%{somefield}" ] } }
# You can also remove multiple tags at once: filter { memcached { remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"] } }
如果事件的字段 "somefield" == "hello"
,则此过滤器在成功时将删除标签 foo_hello
(如果存在)。第二个示例还将删除一个悲伤的、不需要的标签。