› › ›

添加 Kubernetes 元数据

编辑

添加 Kubernetes 元数据

编辑

add_kubernetes_metadata 处理器会根据事件的来源 Kubernetes Pod，为每个事件添加相关的元数据。此处理器仅为尚未包含元数据的事件添加元数据。

在启动时，它会检测 in_cluster 环境并缓存 Kubernetes 相关元数据。只有检测到有效的配置时，才会为事件添加注释。如果无法检测到有效的 Kubernetes 配置，则不会为事件添加 Kubernetes 相关元数据。

每个事件都会添加以下注释：

Pod 名称
Pod UID
命名空间
标签

此外，节点和命名空间元数据会添加到 Pod 元数据中。

add_kubernetes_metadata 处理器有两个基本构建块：

索引器
匹配器

索引器使用 Pod 元数据为每个 Pod 创建唯一的标识符。这些标识符有助于将观察到的 Pod 的元数据与实际事件相关联。例如，ip_port 索引器可以获取一个 Kubernetes Pod，并根据其所有 pod_ip:container_port 组合为其创建标识符。

匹配器使用事件中的信息来构造查找键，以匹配索引器创建的标识符。例如，当 fields 匹配器将 ["metricset.host"] 作为查找字段时，它将使用 metricset.host 字段的值构造查找键。当这些查找键中的一个与其中一个标识符匹配时，该事件将使用已识别的 Pod 的元数据进行丰富。

每个 Beat 可以定义自己的默认索引器和匹配器，这些索引器和匹配器默认情况下处于启用状态。例如，Filebeat 启用 container 索引器，该索引器基于所有容器 ID 识别 Pod 元数据；以及 logs_path 匹配器，该匹配器获取 log.file.path 字段，提取容器 ID，并使用它来检索元数据。

你可以在索引器和匹配器中找到有关可用索引器和匹配器的更多信息以及一些示例。

以下配置在 winlogbeat 作为 Kubernetes 中的 Pod 运行时启用该处理器。

processors:
  - add_kubernetes_metadata:
      # Defining indexers and matchers manually is required for winlogbeat, for instance:
      #indexers:
      #  - ip_port:
      #matchers:
      #  - fields:
      #      lookup_fields: ["metricset.host"]
      #labels.dedot: true
      #annotations.dedot: true

以下配置在作为 Kubernetes 节点上的进程运行的 Beat 上启用该处理器。

processors:
  - add_kubernetes_metadata:
      host: <hostname>
      # If kube_config is not set, KUBECONFIG environment variable will be checked
      # and if not present it will fall back to InCluster
      kube_config: $Winlogbeat Reference [8.17]/.kube/config
      # Defining indexers and matchers manually is required for winlogbeat, for instance:
      #indexers:
      #  - ip_port:
      #matchers:
      #  - fields:
      #      lookup_fields: ["metricset.host"]
      #labels.dedot: true
      #annotations.dedot: true

以下配置禁用默认索引器和匹配器，并启用用户感兴趣的索引器和匹配器。

processors:
  - add_kubernetes_metadata:
      host: <hostname>
      # If kube_config is not set, KUBECONFIG environment variable will be checked
      # and if not present it will fall back to InCluster
      kube_config: ~/.kube/config
      default_indexers.enabled: false
      default_matchers.enabled: false
      indexers:
        - ip_port:
      matchers:
        - fields:
            lookup_fields: ["metricset.host"]
      #labels.dedot: true
      #annotations.dedot: true

add_kubernetes_metadata 处理器具有以下配置设置：

host

（可选）指定 winlogbeat 的节点范围，以便在无法准确检测到节点时（例如在主机网络模式下运行 winlogbeat 时）使用。

scope

（可选）指定处理器应在节点级别还是在整个集群级别具有可见性。可能的值为 node 和 cluster。默认情况下，范围为 node。

namespace

（可选）选择要从中收集元数据的命名空间。如果未设置，处理器将从所有命名空间收集元数据。默认情况下未设置。

add_resource_metadata

（可选）指定将添加到事件中的额外元数据的过滤器和配置。配置参数

node 或 namespace：指定来自节点和命名空间的额外元数据的标签和注释过滤器。默认情况下，包含所有标签，但不包含注释。要更改默认行为，可以定义 include_labels、exclude_labels 和 include_annotations。当存储需要特殊处理以避免存储输出过载的标签和注释时，这些设置非常有用。注意：这些设置不支持通配符。可以通过设置 enabled: false 来单独禁用 node 或 namespace 元数据的丰富。
deployment：如果资源是 pod 并且是从 deployment 创建的，则默认情况下会添加 deployment 名称，可以通过设置 deployment: false 来禁用此功能。
cronjob：如果资源是 pod 并且是从 cronjob 创建的，则默认情况下会添加 cronjob 名称，可以通过设置 cronjob: false 来禁用此功能。

示例

      add_resource_metadata:
        namespace:
          include_labels: ["namespacelabel1"]
          #labels.dedot: true
          #annotations.dedot: true
        node:
          include_labels: ["nodelabel2"]
          include_annotations: ["nodeannotation1"]
          #labels.dedot: true
          #annotations.dedot: true
        deployment: false
        cronjob: false

kube_config: （可选）使用给定的配置文件作为 Kubernetes 客户端的配置。如果存在，则默认为 KUBECONFIG 环境变量。
use_kubeadm: （可选）默认为 true。默认情况下，会对 kubeadm config map 发出请求，以便通过请求 /api/v1/namespaces/kube-system/configmaps/kubeadm-config API 端点来丰富集群名称。
kube_client_options: （可选）可以为 Kubernetes 客户端配置其他选项。目前支持客户端 QPS 和突发，如果未设置，将使用 Kubernetes 客户端的默认 QPS 和突发。示例

      kube_client_options:
        qps: 5
        burst: 10

cleanup_timeout: （可选）指定停止容器正在运行的配置之前的不活动时间。默认情况下为 60s。
sync_period: （可选）指定列出历史资源的超时时间。
default_indexers.enabled: （可选）当你想指定自己的索引器时，启用或禁用默认的 Pod 索引器。
default_matchers.enabled: （可选）当你想指定自己的匹配器时，启用或禁用默认的 Pod 匹配器。
labels.dedot: （可选）默认为 true。如果设置为 true，则标签中的 . 将替换为 _。
annotations.dedot: （可选）默认为 true。如果设置为 true，则标签中的 . 将替换为 _。

索引器和匹配器

编辑

索引器

编辑

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

可用的索引器有：

container: 使用其容器的 ID 标识 Pod 元数据。
ip_port: 使用其 IP 和其公开端口的组合标识 Pod 元数据。当使用此索引器时，元数据使用 Pod 的 IP 以及其容器公开的每个端口的 ip:port 组合来标识。
pod_name: 使用其命名空间及其名称（格式为 namespace/pod_name）标识 Pod 元数据。
pod_uid: 使用 Pod 的 UID 标识 Pod 元数据。

匹配器

编辑

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

`field_format`

编辑

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

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

例如，以下配置使用 ip_port 索引器，通过 Pod IP 及其公开端口的组合来识别 Pod 元数据，并使用事件中的目标 IP 和端口作为匹配键。

processors:
- add_kubernetes_metadata:
    ...
    default_indexers.enabled: false
    default_matchers.enabled: false
    indexers:
      - ip_port:
    matchers:
      - field_format:
          format: '%{[destination.ip]}:%{[destination.port]}'

`fields`

编辑

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

此匹配器有一个选项 lookup_fields 来定义将用于查找的文件值。

例如，以下配置使用 ip_port 索引器来标识 Pod，并定义一个匹配器，该匹配器使用目标 IP 或服务器 IP 进行查找，查找事件中找到的第一个。

processors:
- add_kubernetes_metadata:
    ...
    default_indexers.enabled: false
    default_matchers.enabled: false
    indexers:
      - ip_port:
    matchers:
      - fields:
          lookup_fields: ['destination.ip', 'server.ip']

« 为事件生成 ID 添加标签 »