添加 Nomad 元数据

编辑

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

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

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

  • 分配名称、标识符和状态。
  • 作业名称和类型。
  • 部署作业的命名空间。
  • 运行分配的代理所在的数据中心和区域。
processors:
  - add_nomad_metadata: ~

它具有以下设置来配置连接

地址
(可选) 用于请求元数据的代理 API 的 URL。默认使用 http://127.0.0.1:4646
命名空间
(可选) 要监视的命名空间。如果设置,则仅注释此命名空间中分配的事件。
区域
(可选) 要监视的区域。如果设置,则仅注释此区域中分配的事件。
secret_id
(可选) 与代理 API 连接时要使用的 SecretID。这是一个应用于令牌的示例 ACL 策略。
namespace "*" {
  policy = "read"
}
node {
  policy = "read"
}
agent {
  policy = "read"
}
refresh_interval
(可选) 用于更新缓存元数据的间隔。默认为 30 秒。
cleanup_timeout
(可选) 在删除分配后,等待清理其关联资源的时间。如果您希望在删除分配后接收事件(这在收集日志时可能发生),则此功能很有用。默认为 60 秒。

您可以通过使用以下设置配置范围,来决定 Heartbeat 是否应注释与本地节点或整个集群中的分配相关的事件

范围
(可选) 要监视的资源的范围。它可以是 node 以仅获取单个代理中分配的元数据,也可以是 global 以获取在任何代理上运行的分配的元数据。默认为 node
节点
(可选) 当使用 scope: node 时,如果无法自动发现本地节点名称,请使用 node 指定本地节点名称。

例如,如果 Heartbeat 正在收集集群中所有分配的事件,则可以使用以下配置

processors:
  - add_nomad_metadata:
      scope: global

索引器和匹配器

编辑

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

索引器

编辑

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

可用的索引器为: allocation_name:按其名称和命名空间(如 <namespace>/<name>)标识分配 allocation_uuid:按其唯一标识符标识分配。

匹配器

编辑

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

field_format

编辑

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

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

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

processors:
- 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 的某些字段进行查找,它在事件中找到的第一个字段

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