› ›

自动发现

编辑

自动发现

编辑

当您在容器中运行应用程序时，它们会成为监控系统的动态目标。自动发现允许您跟踪它们并在发生更改时调整设置。通过定义配置模板，自动发现子系统可以在服务开始运行时对其进行监控。

您可以在 filebeat.yml 配置文件的 filebeat.autodiscover 部分定义自动发现设置。要启用自动发现，请指定提供程序列表。

提供程序

编辑

自动发现提供程序通过监视系统上的事件并将这些事件转换为具有通用格式的内部自动发现事件来工作。配置提供程序时，您可以选择使用自动发现事件中的字段来设置条件，当满足这些条件时，将启动特定的配置。

启动时，Filebeat 将扫描现有容器并为其启动正确的配置。然后，它将监视新的启动/停止事件。这确保您无需担心状态，只需定义所需的配置即可。

Docker

编辑

Docker 自动发现提供程序监视 Docker 容器的启动和停止。

它具有以下设置：

host: (可选) Docker 套接字（UNIX 或 TCP 套接字）。默认情况下，它使用 unix:///var/run/docker.sock。
ssl: (可选) 连接到 Docker 套接字时使用的 SSL 配置。
cleanup_timeout: (可选) 指定在停止容器的运行配置之前的空闲时间，默认为 60 秒。
labels.dedot: (可选) 默认值为 false。如果设置为 true，则将标签中的点替换为 _。

这些是在配置模板中可用的字段。docker.* 字段将在每个发出的事件中可用。event

host
端口
docker.container.id
docker.container.image
docker.container.name
docker.container.labels

例如

{
  "host": "10.4.15.9",
  "port": 6379,
  "docker": {
    "container": {
      "id": "382184ecdb385cfd5d1f1a65f78911054c8511ae009635300ac28b4fc357ce51"
      "name": "redis",
      "image": "redis:3.2.11",
      "labels": {
        "io.kubernetes.pod.namespace": "default"
        ...
      }
    }
  }
}

您可以定义一组配置模板，当条件与事件匹配时应用这些模板。模板定义一个与自动发现事件匹配的条件，以及在发生此条件时启动的配置列表。

条件匹配来自提供程序的事件。提供程序对条件使用与处理器相同的格式。

配置模板可以包含来自自动发现事件的变量。可以在 data 命名空间下访问它们。例如，使用示例事件，“${data.port}”将解析为 6379。

Filebeat 支持输入和模块的模板。

filebeat.autodiscover:
  providers:
    - type: docker
      templates:
        - condition:
            contains:
              docker.container.image: redis
          config:
            - type: container
              paths:
                - /var/lib/docker/containers/${data.docker.container.id}/*.log
              exclude_lines: ["^\\s+[\\-`('.|_]"]  # drop asciiart lines

此配置为所有运行名称中包含 redis 的镜像的容器启动 docker 日志输入。labels.dedot 默认情况下对于 docker 自动发现设置为 true，这意味着 docker 标签中的点默认情况下将替换为 _。

如果您使用的是模块，则可以覆盖默认输入并改用 docker 输入。

filebeat.autodiscover:
  providers:
    - type: docker
      templates:
        - condition:
            contains:
              docker.container.image: redis
          config:
            - module: redis
              log:
                input:
                  type: container
                  paths:
                    - /var/lib/docker/containers/${data.docker.container.id}/*.log

使用自动发现时，在定义配置模板时必须小心，尤其是在它们从保存多个容器信息的地址读取信息时。例如，在以下文件结构下：

/mnt/logs/<container_id>/*.log

您可以定义如下配置模板：

错误设置:

autodiscover.providers:
  - type: docker
    templates:
      - condition.contains:
          docker.container.image: nginx
        config:
          - type: log
            paths:
              - "/mnt/logs/*/*.log"

这将多次读取给定路径下的所有文件（每个 nginx 容器一个）。您真正想要的是将模板的范围限定为与自动发现条件匹配的容器。正确设置

autodiscover.providers:
  - type: docker
    templates:
      - condition.contains:
          docker.container.image: nginx
        config:
          - type: log
            paths:
              - "/mnt/logs/${data.docker.container.id}/*.log"

Kubernetes

编辑

Kubernetes 自动发现提供程序监视 Kubernetes 节点、Pod 和服务的启动、更新和停止。

kubernetes 自动发现提供程序具有以下配置设置：

node: (可选) 指定要将 filebeat 范围限定到的节点，例如在主机网络模式下运行 filebeat 时无法准确检测到节点的情况。
namespace: (可选) 选择要从中收集资源事件的命名空间。如果未设置，提供程序将从所有命名空间收集它们。默认为未设置。命名空间配置仅适用于具有命名空间范围的 Kubernetes 资源，并且如果 unique 字段设置为 false。
cleanup_timeout: (可选) 指定在停止容器的运行配置之前的空闲时间，默认为 60 秒。
kube_config: (可选) 使用给定的配置文件作为 Kubernetes 客户端的配置。如果未设置 kube_config，则将检查 KUBECONFIG 环境变量，如果不存在，则将回退到 InCluster。
kube_client_options: (可选) 可以为 Kubernetes 客户端配置其他选项。当前支持客户端 QPS 和突发，如果未设置，将使用 Kubernetes 客户端的默认 QPS 和突发。示例

      kube_client_options:
        qps: 5
        burst: 10

resource

(可选) 选择要对其进行发现的资源。当前支持的 Kubernetes 资源为 pod、service 和 node。如果未配置，resource 默认为 pod。

scope

(可选) 指定需要在哪个级别进行自动发现。scope 可以取 node 或 cluster 作为值。node 范围允许发现指定节点中的资源。cluster 范围允许集群范围的发现。只有 pod 和 node 资源可以在节点范围内发现。

add_resource_metadata

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

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

示例

      add_resource_metadata:
        namespace:
          include_labels: ["namespacelabel1"]
        node:
          include_labels: ["nodelabel2"]
          include_annotations: ["nodeannotation1"]
        # deployment: false
        # cronjob: false

unique: (可选) 默认为 false。将自动发现提供程序标记为唯一会导致提供程序仅在获得领导者租约时启用提供的模板。此设置只能与 cluster 范围组合使用。启用 unique 时，将不考虑 resource 和 add_resource_metadata 设置。
leader_lease: (可选) 默认为 filebeat-cluster-leader。这将是锁租约的名称。可以使用 kubectl describe lease beats-cluster-leader 监控租约的状态。引用相同领导者租约的不同 Beats 将成为持有租约的竞争者，每次只有一个将被选为领导者。
leader_leaseduration: (可选) 非领导者候选者将等待强制获取租约领导权的持续时间。默认为 15s。
leader_renewdeadline: (可选) 领导者在放弃之前将重试刷新其领导地位的持续时间。默认为 10s。
leader_retryperiod: (可选) 运行以获取租约的 metricbeat 实例在尝试操作之间应等待的持续时间。默认为 2s。

配置模板可以包含来自自动发现事件的变量。这些变量可以在 data 命名空间下访问，例如，访问 Pod IP：${data.kubernetes.pod.ip}。

这些是在配置模板中可用的字段。kubernetes.* 字段将在每个发出的事件中可用

通用字段

编辑

host

Pod 特定字段

编辑

键	类型	描述
`端口`	`字符串`	Pod 端口。如果 Pod 公开了多个端口，则应改用 `ports.<port-name>`
`kubernetes.namespace`	`字符串`	Pod 运行所在的命名空间
`kubernetes.namespace_uuid`	`字符串`	Pod 运行所在的命名空间的 UUID
`kubernetes.namespace_annotations.*`	`对象`	Pod 运行所在的命名空间的注释。注释应使用非去点格式，例如 `kubernetes.namespace_annotations.app.kubernetes.io/name`
`kubernetes.pod.name`	`字符串`	Pod 的名称
`kubernetes.pod.uid`	`字符串`	Pod 的 UID
`kubernetes.pod.ip`	`字符串`	Pod 的 IP
`kubernetes.labels.*`	`对象`	Pod 标签的对象。标签应使用非去点格式，例如 `kubernetes.labels.app.kubernetes.io/name`
`kubernetes.annotations.*`	`对象`	Pod 注释的对象。注释应使用非去点格式，例如 `kubernetes.annotations.test.io/test`
`kubernetes.container.name`	`字符串`	容器的名称
`kubernetes.container.runtime`	`字符串`	容器的运行时
`kubernetes.container.id`	`字符串`	容器的 ID
`kubernetes.container.image`	`字符串`	容器的镜像
`kubernetes.node.name`	`字符串`	节点的名称
`kubernetes.node.uid`	`字符串`	节点的 UID
`kubernetes.node.hostname`	`字符串`	节点的主机名

节点特定字段

编辑

键	类型	描述
`kubernetes.labels.*`	`对象`	节点标签的对象
`kubernetes.annotations.*`	`对象`	节点注释的对象
`kubernetes.node.name`	`字符串`	节点的名称
`kubernetes.node.uid`	`字符串`	节点的 UID
`kubernetes.node.hostname`	`字符串`	节点的主机名

服务特定字段

编辑

键	类型	描述
`端口`	`字符串`	服务端口
`kubernetes.namespace`	`字符串`	服务的命名空间
`kubernetes.namespace_uuid`	`字符串`	服务的命名空间的 UUID
`kubernetes.namespace_annotations.*`	`对象`	服务的命名空间的注释。注释应使用非去点格式，例如 `kubernetes.namespace_annotations.app.kubernetes.io/name`
`kubernetes.labels.*`	`对象`	服务的标签的对象
`kubernetes.annotations.*`	`对象`	服务的注释的对象
`kubernetes.service.name`	`字符串`	服务的名称
`kubernetes.service.uid`	`字符串`	服务的 UID

如果将 include_annotations 配置添加到提供程序配置，则配置中存在的注释列表将添加到事件中。

如果在提供程序配置中添加了include_labels配置，则配置中存在的标签列表将添加到事件中。

如果在提供程序配置中添加了exclude_labels配置，则配置中存在的标签列表将从事件中排除。

如果在提供程序配置中将labels.dedot配置设置为true，则标签中的.将被替换为_。默认值为true。

如果在提供程序配置中将annotations.dedot配置设置为true，则注释中的.将被替换为_。默认值为true。

从8.6版本开始，在配置模板中使用的kubernetes.labels.*将不会进行dedot处理，无论labels.dedot的值如何。此配置参数仅影响最终Elasticsearch文档中添加的字段。例如，对于具有标签app.kubernetes.io/name=ingress-nginx的Pod，匹配条件应为condition.equals: kubernetes.labels.app.kubernetes.io/name: "ingress-nginx"。如果labels.dedot设置为true（默认值），则标签将存储在Elasticsearch中，名称为kubernetes.labels.app_kubernetes_io/name。Kubernetes注释也适用此规则。

例如

{
  "host": "172.17.0.21",
  "port": 9090,
  "kubernetes": {
    "container": {
      "id": "bb3a50625c01b16a88aa224779c39262a9ad14264c3034669a50cd9a90af1527",
      "image": "prom/prometheus",
      "name": "prometheus"
    },
    "labels": {
      "project": "prometheus",
      ...
    },
    "namespace": "default",
    "node": {
      "name": "minikube"
    },
    "pod": {
      "name": "prometheus-2657348378-k1pnh"
    }
  },
}

Filebeat 支持输入和模块的模板。

filebeat.autodiscover:
  providers:
    - type: kubernetes
      templates:
        - condition:
            equals:
              kubernetes.namespace: kube-system
          config:
            - type: container
              paths:
                - /var/log/containers/*-${data.kubernetes.container.id}.log
              exclude_lines: ["^\\s+[\\-`('.|_]"]  # drop asciiart lines

此配置为Kubernetes命名空间kube-system中运行的Pod的所有容器启动docker日志输入。

如果您使用的是模块，则可以覆盖默认输入并改用 docker 输入。

filebeat.autodiscover:
  providers:
    - type: kubernetes
      templates:
        - condition:
            equals:
              kubernetes.container.image: "redis"
          config:
            - module: redis
              log:
                input:
                  type: container
                  paths:
                    - /var/log/containers/*-${data.kubernetes.container.id}.log

Jolokia

编辑

Jolokia自动发现提供程序使用Jolokia Discovery查找在您的主机或网络中运行的代理。

此提供程序的配置包括一组网络接口，以及与其他提供程序一样的一组模板。网络接口将用于发现探测，interfaces的每个项目都具有以下设置

名称: 接口的名称（例如br0），它可以包含通配符作为后缀，以便将相同的设置应用于相同类型的多个网络接口（例如br*）。
间隔: 探测之间的时间（默认为10秒）
宽限期: 自上次回复以来将实例视为停止的时间（默认为30秒）
探测超时: 自发送探测以来等待响应的最长时间（默认为1秒）

Jolokia Discovery机制自1.2.0版本以来受任何Jolokia代理支持，当Jolokia作为JVM代理包含在应用程序中时，默认情况下启用，但在其他情况下（如OSGI或WAR（Java EE）代理）禁用。无论如何，此功能由两个属性控制

discoveryEnabled，用于启用此功能
discoveryAgentUrl，如果设置，则这是代理在被发现时公布的URL，设置此参数会隐式启用此功能

设置这些属性的方法有多种，并且会因应用程序而异，请参阅您的应用程序文档以查找最适合您情况的设置方法。

Jolokia Discovery基于UDP组播请求。代理加入组播组239.192.48.84，端口24884，并通过向该组发送查询来完成发现。您必须考虑到必须允许Filebeat和Jolokia代理之间的UDP流量。还要注意，此组播地址位于239.0.0.0/8范围内，该范围保留用于组织内的私有用途，因此只能在私有网络中使用。

这些是在配置模板化期间可用的字段。jolokia.*字段将在每个发出的事件中可用。

jolokia.agent.id
jolokia.agent.version
jolokia.secured
jolokia.server.product
jolokia.server.vendor
jolokia.server.version
jolokia.url

Filebeat支持输入和模块的模板

filebeat.autodiscover:
  providers:
    - type: jolokia
      interfaces:
      - name: lo
      templates:
      - condition:
          contains:
            jolokia.server.product: "kafka"
        config:
        - module: kafka
          log:
            enabled: true
            var.paths:
            - /var/log/kafka/*.log

此配置启动一个jolokia模块，如果Kafka正在运行，则收集Kafka的日志。使用本地接口发送发现探测。

Nomad

编辑

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

Nomad自动发现提供程序监视Nomad作业的启动、更新和停止。

nomad自动发现提供程序具有以下配置设置

地址: （可选）指定Nomad代理的地址。默认情况下，它将尝试与本地运行的Nomad代理通信（http://127.0.0.1:4646）。
区域: （可选）要使用的区域。如果未提供，则使用默认代理区域。
namespace: （可选）要使用的命名空间。如果未提供，则使用default命名空间。
secret_id: （可选）如果在Nomad中启用ACL，则要使用的SecretID。这是一个应用于令牌的ACL策略示例。

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

node: （可选）如果使用node范围，则指定要将filebeat范围限制到的节点，以防无法准确检测到。
scope: （可选）指定需要在哪个级别执行自动发现。scope可以取node或cluster作为值。node范围允许发现指定节点中的资源。cluster范围允许集群范围的发现。默认为node。
等待时间: （可选）限制Watch阻塞的时间。如果未指定（或设置为0），则使用代理的默认配置。
允许陈旧: （可选）允许任何Nomad服务器（非领导者）服务读取。这通常意味着分配Filebeat的本地节点将服务Filebeat的请求。默认为true。

模板和条件的配置类似于Docker提供程序。配置模板可以包含来自自动发现事件的变量。它们可以在data命名空间下访问。

这些是在配置模板化期间可用的字段。nomad.*字段将在每个发出的事件中可用。

nomad.allocation.id
nomad.allocation.name
nomad.allocation.status
nomad.datacenter
nomad.job.name
nomad.job.type
nomad.namespace
nomad.region
nomad.task.name
nomad.task.service.canary_tags
nomad.task.service.name
nomad.task.service.tags

如果在提供程序配置中添加了include_labels配置，则配置中存在的标签列表将添加到事件中。

如果在提供程序配置中添加了exclude_labels配置，则配置中存在的标签列表将从事件中排除。

如果在提供程序配置中将labels.dedot配置设置为true，则标签中的.将被替换为_。

例如

{
  ...
  "region": "europe",
  "allocation": {
    "name": "coffeshop.api[0]",
    "id": "35eba07f-e5e4-20ac-6def-85117bee6efb",
    "status": "running"
  },
  "datacenters": [
    "europe-west4"
  ],
  "namespace": "default",
  "job": {
    "type": "service",
    "name": "coffeshop"
  },
  "task": {
    "service": {
      "name": [
        "coffeshop"
      ],
      "tags": [
        "coffeshop",
        "nginx"
      ],
      "canary_tags": [
        "coffeshop"
      ]
    },
    "name": "api"
  },
  ...
}

Filebeat 支持输入和模块的模板。

filebeat.autodiscover:
  providers:
    - type: nomad
      node: nomad1
      scope: local
      hints.enabled: true
      allow_stale: true
      templates:
        - condition:
            equals:
              nomad.namespace: web
          config:
            - type: log
              paths:
                - /var/lib/nomad/alloc/${data.nomad.allocation.id}/alloc/logs/${data.nomad.task.name}.stderr.[0-9]*
              exclude_lines: ["^\\s+[\\-`('.|_]"]  # drop asciiart lines

此配置为web Nomad命名空间下的所有作业启动log输入。

如果使用模块，您可以覆盖默认输入并自定义它以从${data.nomad.task.name}.stdout和/或${data.nomad.task.name}.stderr文件读取。

filebeat.autodiscover:
  providers:
    - type: nomad
      templates:
        - condition:
            equals:
              nomad.task.service.tags: "redis"
          config:
            - module: redis
              log:
                input:
                  type: log
                  paths:
                    - /var/lib/nomad/alloc/${data.nomad.allocation.id}/alloc/logs/${data.nomad.task.name}.*

目前不支持docker输入。Nomad不公开与分配关联的容器ID。如果没有容器ID，则无法生成读取容器日志的正确路径。

« URL 解码基于提示的自动发现 »