Memcached 过滤器插件

编辑
  • 插件版本:v1.2.0
  • 发布日期:2023-01-18
  • 变更日志

其他版本请参见 版本化插件文档

获取帮助

编辑

如有任何关于插件的问题,请在 Discuss 论坛发帖提问。如发现错误或有功能需求,请在 Github 上提交 issue。有关 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵

描述

编辑

Memcached 过滤器提供了与 Memcached 中外部数据的集成。

它目前提供以下功能

  • get:获取一个或多个 Memcached 密钥的值,并将它们注入到提供的路径下的事件中。
  • set:将事件中的值设置为对应的 Memcached 密钥。

示例

编辑

此插件支持针对 Memcached 对象缓存系统进行键值查找增强。您可以使用此插件查询值,如果未找到则设置值。

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

数组

namespace

字符串

get

哈希表

set

哈希表

tag_on_failure

字符串

ttl

数字

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

 

hosts

编辑
  • 值类型为 数组
  • 默认值为 localhost

hosts 参数接受对应于 Memcached 实例的一组地址。

主机可以通过 FQDN(例如 example.com)、IPV4 地址(例如 123.45.67.89)或 IPV6 地址(例如 ::12001:0db8:85a3:0000:0000:8a2e:0370:7334)指定。如果您的 Memcached 主机使用非标准端口,则可以通过附加冒号 (:) 和端口号来指定端口;要在 IPv6 地址中包含端口,必须先将地址括在方括号 ([]) 中,例如 [::1]:11211

如果指定了多个主机,请求将使用每个密钥的 CRC-32 校验和的模数分发到给定的主机。

namespace

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

如果指定,则使用给定的字符串后跟冒号 (:) 作为所有 Memcached 密钥的前缀;如果此插件使用的所有密钥都共享一个公共前缀,这将非常有用。

示例

在以下配置中,我们将从 Memcached 中获取 fruit:bananafruit:apple

filter {
  memcached {
    namespace => "fruit"
    get => {
      "banana" => "[fruit-stats][banana]"
      "apple"  => "[fruit-stats][apple]
    }
  }
}
  • 值类型为 哈希表
  • 此设置没有默认值。

如果指定,则从 Memcached 中获取给定密钥的值,并将它们存储在事件上的对应字段中。

  • 密钥是内插的(例如,如果事件具有值为 bar 的字段 foo,则密钥 sand/%{foo} 将评估为 sand/bar
  • 字段可以是嵌套引用
filter {
  memcached {
    get => {
      "memcached-key-1" => "field1"
      "memcached-key-2" => "[nested][field2]"
    }
  }
}
  • 值类型为 哈希表
  • 此设置没有默认值。

如果指定,则从给定的事件字段中提取值,并将对应的密钥设置为 Memcached 中这些值,并使用配置的 ttl

  • 密钥是内插的(例如,如果事件具有值为 bar 的字段 foo,则密钥 sand/%{foo} 将评估为 sand/bar
  • 字段可以是嵌套引用
filter {
  memcached {
    set => {
      "field1"           => "memcached-key-1"
      "[nested][field2]" => "memcached-key-2"
    }
  }
}

tag_on_failure

编辑
  • 值类型为 字符串
  • 此设置的默认值为 _memcached_failure

当 Memcached 操作导致插件中抛出运行时异常时,操作将安全中止,不会导致插件崩溃,并且事件将使用提供的标签进行标记。

对于将数据持久化到 Memcached 的此插件的使用情况(例如,set),以秒为单位的生存时间

  • 值类型为 数字
  • 默认值为 0(无过期时间)

常用选项

编辑

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

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 标签)。

enable_metric

编辑

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

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

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

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

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

periodic_flush

编辑

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

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(如果存在)。第二个示例也将删除一个令人悲伤的、不需要的标签。