› ›

自动发现

编辑

自动发现

编辑

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

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

提供程序

编辑

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

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

Docker

编辑

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

它具有以下设置：

host: (可选) Docker 套接字（UNIX 或 TCP 套接字）。默认情况下，它使用 unix:///var/run/docker.sock。
ssl: (可选) 连接到 Docker 套接字时使用的 SSL 配置。
cleanup_timeout: (可选) 指定在停止容器的运行配置之前的不活动时间，默认情况下禁用。
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。

Metricbeat 支持模块模板

metricbeat.autodiscover:
  providers:
    - type: docker
      labels.dedot: true
      templates:
        - condition:
            contains:
              docker.container.image: redis
          config:
            - module: redis
              metricsets: ["info", "keyspace"]
              hosts: "${data.host}:6379"

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

此外，Metricbeat 自动发现支持利用密钥存储来检索敏感数据，例如密码。以下是使用密钥存储的配置示例：

metricbeat.autodiscover:
  providers:
    - type: docker
      labels.dedot: true
      templates:
        - condition:
            contains:
              docker.container.image: redis
          config:
            - module: redis
              metricsets: ["info", "keyspace"]
              hosts: "${data.host}:6379"
              password: "${REDIS_PASSWORD}"

其中 REDIS_PASSWORD 是存储在 Metricbeat 本地密钥存储中的密钥。

Kubernetes

编辑

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

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

node: (可选) 指定要将 metricbeat 范围限定到的节点，以防无法准确检测到，例如在主机网络模式下运行 metricbeat 时。
namespace: (可选) 选择要从中收集资源事件的命名空间。如果未设置，提供程序将从所有命名空间收集它们。默认情况下未设置。命名空间配置仅适用于具有命名空间范围的 kubernetes 资源，并且如果 unique 字段设置为 false。
cleanup_timeout: (可选) 指定在停止容器的运行配置之前的不活动时间，默认情况下禁用。
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: (可选) 默认值为 metricbeat-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.*将不会进行去点操作，无论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"
    }
  },
}

示例

metricbeat.autodiscover:
  providers:
    - type: kubernetes
      scope: cluster
      node: ${NODE_NAME}
      unique: true
      identifier: leader-election-metricbeat
      templates:
        - config:
            - module: kubernetes
              hosts: ["kube-state-metrics:8080"]
              period: 10s
              add_metadata: true
              metricsets:
                - state_node

在部署在一个或多个Metricbeat实例上时，上述配置将仅为获得领导者租约/锁的Metricbeat实例启用state_node metricset。通过这种部署策略，当将Beat作为DaemonSet部署时，我们可以确保集群范围的metricset仅由一个Beat实例启用。

Metricbeat 支持模块模板

metricbeat.autodiscover:
  providers:
    - type: kubernetes
      include_annotations: ["prometheus.io.scrape"]
      templates:
        - condition:
            contains:
              kubernetes.annotations.prometheus.io/scrape: "true"
          config:
            - module: prometheus
              metricsets: ["collector"]
              hosts: "${data.host}:${data.port}"

此配置为所有带有注释prometheus.io/scrape=true的Pod的容器启动一个prometheus模块。

使用Kubernetes手动定义端口

编辑

如果可能，请在Pod规范中声明公开的端口。否则，您需要使用具有复杂过滤规则的多个模板。{port}变量将不存在，您需要硬编码端口。例如：{data.host}:1234

当未声明端口时，Autodiscover将使用您提供的模板为每个Pod和每个容器生成一个配置。生成这些配置后，会对其进行重复数据删除。如果多个容器的生成的配置相同，则将其合并为一个配置。

Pod共享相同的host。如果只内插{data.host}变量，则每个host将生成一个配置。这些配置将相同。重复数据删除后，将只使用一个。

为了定位一个特定的公开端口，可以在模板配置中使用{data.host}:{data.ports.web}，其中web是公开的容器端口的名称。

Metricbeat Autodiscover密钥管理

编辑

本地密钥库

编辑

Metricbeat autodiscover支持利用密钥库来检索敏感数据，如密码。以下是如何使用密钥库的配置示例

metricbeat.autodiscover:
  providers:
    - type: kubernetes
      templates:
        - condition:
            contains:
              kubernetes.labels.app: "redis"
          config:
            - module: redis
              metricsets: ["info", "keyspace"]
              hosts: "${data.host}:6379"
              password: "${REDIS_PASSWORD}"

其中 REDIS_PASSWORD 是存储在 Metricbeat 本地密钥存储中的密钥。

Kubernetes密钥

编辑

Metricbeat autodiscover支持利用Kubernetes密钥来检索敏感数据，如密码。为了启用此功能，请在Metricbeat的ClusterRole规则中添加以下部分

- apiGroups: [""]
  resources:
    - secrets
  verbs: ["get"]

上述规则将授予Metricbeat Pod访问Kubernetes密钥API的权限。这意味着任何拥有Metricbeat Pod访问权限的人（例如kubectl exec）都将能够访问Kubernetes密钥API并获取特定密钥，无论它属于哪个命名空间。在使用提示时，应仔细考虑此选项，尤其是在使用提示时。

仅为一个命名空间授予权限，而不是集群范围的权限的一种方法是，为目标命名空间使用特定角色，以便更好地控制访问。

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  namespace: marketing-team
  name: secret-reader
rules:
- apiGroups: [""] # "" indicates the core API group
  resources: ["secrets"]
  verbs: ["get"]

可以在官方Kubernetes文档中找到有关Role和ClusterRole的更多信息。

以下是如何使用Kubernetes密钥的配置示例

metricbeat.autodiscover:
  providers:
    - type: kubernetes
      templates:
        - condition:
            contains:
              kubernetes.labels.app: "redis"
          config:
            - module: redis
              metricsets: ["info", "keyspace"]
              hosts: "${data.host}:6379"
              password: "${kubernetes.default.somesecret.value}"

其中kubernetes.default.somesecret.value指定存储为Kubernetes密钥的密钥，如下所示

Kubernetes命名空间：default
Kubernetes密钥名称：somesecret
密钥数据键：value

可以使用以下命令在Kubernetes环境中创建此密钥

cat << EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: somesecret
type: Opaque
data:
  value: $(echo -n "passpass" | base64)
EOF

请注意，Pod只能使用属于相同Kubernetes命名空间的密钥。例如，如果Podmy-redis在staging命名空间下运行，则它无法访问testing命名空间下的密钥，例如kubernetes.testing.xxx.yyy。

Jolokia

编辑

Jolokia autodiscover提供程序使用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，并通过向该组发送查询来完成发现。您必须考虑到必须允许Metricbeat和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

Metricbeat 支持模块模板

metricbeat.autodiscover:
  providers:
    - type: jolokia
      interfaces:
      - name: br*
        interval: 5s
        grace_period: 10s
      - name: en*
      templates:
      - condition:
          contains:
            jolokia.server.product: "tomcat"
        config:
        - module: jolokia
          metricsets: ["jmx"]
          hosts: "${data.jolokia.url}"
          namespace: test
          jmx.mappings:
          - mbean: "java.lang:type=Runtime"
            attributes:
            - attr: Uptime
              field: uptime

此配置启动一个jolokia模块，该模块收集每个已发现的tomcat实例的正常运行时间。使用所有以br和en开头的接口发送发现探测，对于br接口，interval和grace_period分别减少到5秒和10秒。

Amazon EC2实例

编辑

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

Amazon EC2 autodiscover提供程序发现EC2实例。这对用户启动Metricbeat模块以监控在AWS EC2实例上运行的服务非常有用。

例如，您可以使用此提供程序从在具有特定标签service: mysql的EC2实例上运行的MySQL服务器收集MySQL指标。

此提供程序将使用标准AWS环境变量和共享凭证文件加载AWS凭证，请参阅管理AWS访问密钥的最佳实践以了解更多信息。如果您不想使用这些，您可以显式设置access_key_id和secret_access_key变量。

这些是在配置模板化过程中可用的字段。aws.ec2.*字段和cloud.*字段将在每个发出的事件中可用。

cloud.availability_zone
cloud.instance.id
cloud.machine.type
cloud.provider
cloud.region
aws.ec2.architecture
aws.ec2.image.id
aws.ec2.kernel.id
aws.ec2.monitoring.state
aws.ec2.private.dns_name
aws.ec2.private.ip
aws.ec2.public.dns_name
aws.ec2.public.ip
aws.ec2.root_device_name
aws.ec2.state.code
aws.ec2.state.name
aws.ec2.subnet.id
aws.ec2.tags
aws.ec2.vpc.id

Metricbeat 支持模块模板

metricbeat.autodiscover:
  providers:
    - type: aws_ec2
      period: 1m
      credential_profile_name: elastic-beats
      templates:
        - condition:
            equals:
              aws.ec2.tags.service: "mysql"
          config:
            - module: mysql
              metricsets: ["status", "galera_status"]
              period: 10s
              hosts: ["root:password@tcp(${data.aws.ec2.public.ip}:3306)/"]
              username: root
              password: password

此autodiscover提供程序采用我们的标准AWS凭证选项。通过此配置，将为所有具有service: mysql作为标签的EC2实例启动mysql metricbeat模块。

此autodiscover提供程序采用我们的标准AWS凭证选项。

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