Memcached 过滤器插件

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

对于其他版本,请参阅版本化插件文档

获取帮助

编辑

关于插件的问题,请在Discuss论坛中开启一个主题。对于错误或功能请求,请在Github中开启一个问题。有关 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 中 GET 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。当您有两个或多个相同类型的插件时,这特别有用,例如,如果您有 2 个 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。第二个示例也会删除一个令人伤心、不需要的标签。