添加 Nomad 元数据编辑

此功能处于技术预览阶段,可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题,但技术预览中的功能不受官方 GA 功能支持 SLA 的约束。

add_nomad_metadata 处理器添加了与在 Nomad 中部署的应用程序相关的元数据的字段。

每个事件都使用以下信息进行注释

  • 分配名称、标识符和状态
  • 作业名称和类型
  • 部署作业的命名空间
  • 运行分配的代理所在的机房和区域。

示例编辑

  - add_nomad_metadata: ~

配置设置编辑

Elastic Agent 处理器在摄取管道之前执行,这意味着它们处理原始事件数据而不是发送到 Elasticsearch 的最终事件。有关相关限制,请参阅 使用处理器的局限性是什么?

名称 必需 默认 描述

address

http://127.0.0.1:4646

用于请求元数据的代理 API 的 URL。

namespace

要观察的命名空间。如果设置,则仅注释此命名空间中的分配的事件。

region

要观察的区域。如果设置,则仅注释此区域中的分配的事件。

secret_id

与代理 API 连接时要使用的 SecretID。这是一个要应用于令牌的示例 ACL 策略。

namespace "*" {
  policy = "read"
}
node {
  policy = "read"
}
agent {
  policy = "read"
}

refresh_interval

30s

用于更新缓存元数据的间隔。

cleanup_timeout

60s

在分配被删除后等待清理分配的关联资源的时间。如果您希望在分配被删除后接收事件,这将很有用,这在收集日志时可能会发生。

scope

node

要观察的资源范围。指定 node 以获取单个代理中分配的元数据,或指定 global 以获取在任何代理上运行的分配的元数据。

node

当使用 scope: node 时,如果无法自动发现本地节点的名称,请使用 node 指定本地节点的名称。

例如,当 Elastic Agent 从集群中的所有分配收集事件时,您可以使用以下配置

  - add_nomad_metadata:
      scope: global

索引器和匹配器编辑

索引器和匹配器用于将事件中的字段与实际元数据相关联。Elastic Agent 使用此信息来了解在每个事件中包含哪些元数据。

索引器编辑

索引器使用分配元数据为每个 Pod 创建唯一的标识符。

可用的索引器是

allocation_name
通过其名称和命名空间(作为 <namespace>/<name>)识别分配
allocation_uuid
通过其唯一标识符识别分配。
匹配器编辑

匹配器用于构建与索引创建的标识符匹配的查找键。

field_format编辑

使用使用可以包含事件字段的字符串格式创建的键查找分配元数据。

此匹配器有一个选项 format 用于定义字符串格式。此字符串格式可以包含事件中任何字段的占位符。

例如,以下配置使用 allocation_name 索引器通过其名称和命名空间识别分配元数据,并使用事件中存在的自定义字段作为匹配键

- add_nomad_metadata:
    ...
    default_indexers.enabled: false
    default_matchers.enabled: false
    indexers:
      - allocation_name:
    matchers:
      - field_format:
          format: '%{[labels.nomad_namespace]}/%{[fields.nomad_alloc_name]}'
fields编辑

使用某些特定字段的值作为键查找分配元数据。当定义多个字段时,将使用事件中包含的第一个字段。

此匹配器有一个选项 lookup_fields 用于定义其值将用于查找的字段。

例如,以下配置使用 allocation_uuid 索引器识别分配,并定义一个匹配器,该匹配器使用一些字段,其中可以找到分配 UUID 用于查找,它在事件中找到的第一个

- add_nomad_metadata:
    ...
    default_indexers.enabled: false
    default_matchers.enabled: false
    indexers:
      - allocation_uuid:
    matchers:
      - fields:
          lookup_fields: ['host.name', 'fields.nomad_alloc_uuid']
logs_path编辑

使用从存储在 log.file.path 字段中的日志路径中提取的标识符查找分配元数据。

此匹配器有一个可选的 logs_path 选项,其中包含包含本地代理日志的目录的基路径。

默认配置能够在日志收集到 /var/lib/nomad 下时使用分配 UUID 查找元数据。

例如,以下配置将在日志从 /var/lib/NomadClient001/alloc/<alloc UUID>/alloc/logs/... 收集时使用分配 UUID。

- add_nomad_metadata:
    ...
    default_indexers.enabled: false
    default_matchers.enabled: false
    indexers:
      - allocation_uuid:
    matchers:
      - logs_path:
          logs_path: '/var/lib/NomadClient001'