抓取其他 Prometheus 源并导入这些指标 - Amazon CloudWatch
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

抓取其他 Prometheus 源并导入这些指标

具有 Prometheus 监控的 CloudWatch 代理需要两个配置才能抓取 Prometheus 指标。其中一个用于 Prometheus 文档的 <scrape_config> 中记录的标准 Prometheus 配置。另一个用于 CloudWatch 代理配置。

对于 Amazon EKS 集群,配置在 prometheus-eks.yaml (对于 EC2 启动类型)或 prometheus-eks-fargate.yaml (对于 Fargate 启动类型)中定义为两个配置映射:

  • name: prometheus-config 部分包含 Prometheus 抓取的设置。

  • name: prometheus-cwagentconfig 部分包含 CloudWatch 代理的配置。您可以使用此部分配置 CloudWatch 如何收集 Prometheus 指标。例如,您指定要导入 的指标CloudWatch,并定义其维度。

对于在 Amazon EC2 实例上运行的 Kubernetes 集群,配置在 prometheus-k8s.yaml YAML 文件中定义为两个配置映射:

  • name: prometheus-config 部分包含 Prometheus 抓取的设置。

  • name: prometheus-cwagentconfig 部分包含 CloudWatch 代理的配置。

要抓取其他 Prometheus 指标源并将这些指标导入 CloudWatch,请修改 Prometheus 抓取配置和 CloudWatch 代理配置,然后使用更新后的配置重新部署 代理。

VPC 安全组要求

Prometheus 工作负载的安全组的传入规则必须打开 Prometheus 端口到 CloudWatch 代理,以便按私有 IP 抓取 Prometheus 指标。

CloudWatch 代理的安全组的出口规则必须允许CloudWatch代理通过私有 IP 连接到 Prometheus 工作负载的端口。

Prometheus 抓取配置

CloudWatch 代理支持 Prometheus 文档的 中记录的标准 <scrape_config> Prometheus 抓取配置。您可以编辑此部分以更新该文件中已有的配置,并添加其他 Prometheus 抓取目标。默认情况下,示例配置文件包含以下全局配置行:

global: scrape_interval: 1m scrape_timeout: 10s
  • scrape_interval— 定义抓取目标的频率。

  • scrape_timeout— 定义在抓取请求超时之前等待的时长。

您还可以在作业级别为这些设置定义不同的值,以覆盖全局配置。

Prometheus 抓取作业

CloudWatch 代理 YAML 文件已配置了一些默认的抓取作业。例如,在 中prometheus-eks.yaml,默认抓取作业是在 job_name 部分中的scrape_configs行中配置的。在此文件中,以下默认kubernetes-pod-jmx部分将抓取 JMX 导出程序指标。

- job_name: 'kubernetes-pod-jmx' sample_limit: 10000 metrics_path: /metrics kubernetes_sd_configs: - role: pod relabel_configs: - source_labels: [__address__] action: keep regex: '.*:9404$' - action: labelmap regex: __meta_kubernetes_pod_label_(.+) - action: replace source_labels: - __meta_kubernetes_namespace target_label: Namespace - source_labels: [__meta_kubernetes_pod_name] action: replace target_label: pod_name - action: replace source_labels: - __meta_kubernetes_pod_container_name target_label: container_name - action: replace source_labels: - __meta_kubernetes_pod_controller_name target_label: pod_controller_name - action: replace source_labels: - __meta_kubernetes_pod_controller_kind target_label: pod_controller_kind - action: replace source_labels: - __meta_kubernetes_pod_phase target_label: pod_phase

这些默认目标中的每个目标都会被抓取,并使用嵌入式指标格式在日志事件中将指标发送到 CloudWatch。有关更多信息,请参阅采用 CloudWatch 嵌入式指标格式提取高基数日志并生成指标

来自 Amazon EKS 和 Kubernetes 集群的日志事件存储在 /aws/containerinsights/cluster_name中的 /prometheus 日志组CloudWatch Logs。来自 Amazon ECS 集群的日志事件存储在 /aws/ecs/containerinsights/cluster_name/prometheus 日志组。

每个抓取作业都包含在此日志组中的不同日志流中。例如,为 kubernetes-pod-appmesh-envoy 定义了 Prometheus 抓取作业 App Mesh。App Mesh 和 Kubernetes 集群中的所有 Amazon EKS Prometheus 指标将发送到名为 /aws/containerinsights/ 的日志流cluster_name>prometheus/kubernetes-pod-appmesh-envoy/

要添加新的抓取目标,请将新的 job_name 部分添加到 YAML 文件的 scrape_configs 部分,然后重新启动代理。有关此过程的示例,请参阅 添加新的 Prometheus 抓取目标的教程:Prometheus API 服务器指标

CloudWatchPrometheus 的 代理配置

代理CloudWatch配置文件在 下有一个prometheus用于 Prometheus 抓取配置的 metrics_collected 部分。它包括以下配置选项:

  • cluster_name— 指定要在日志事件中作为标签添加的集群名称。此字段为可选项。如果省略它,则 代理可以检测 Amazon EKS 或 Kubernetes 集群名称。

  • log_group_name— 指定已抓取的 Prometheus 指标的日志组名称。此字段为可选项。如果省略它, CloudWatch 将使用 /aws/containerinsights/cluster_name适用于 和 KubernetesAmazon EKS 集群中的日志的 /prometheus。

  • prometheus_config_path— 指定 Prometheus 抓取配置文件路径。如果此字段的值以 Prometheus 抓取配置文件内容开头env:,则将从容器的 环境变量中检索。请勿更改此字段。

  • ecs_service_discovery— 是指定 Amazon ECS Prometheus 服务发现的配置的部分。有关更多信息,请参阅Amazon ECS 集群上的自动发现的详细指南

    ecs_service_discovery 部分可以包含以下字段:

    • sd_frequency 是发现 Prometheus 导出程序的频率。指定数字和单位后缀。例如, 1m 表示每分钟一次, 表示每 30 秒30s一次。有效的单位后缀为 nsusmssmh

      此字段为可选项。默认值为 60 秒(1 分钟)。

    • sd_target_cluster 是自动发现的目标Amazon ECS集群名称。此字段为可选项。默认值为在其中安装 Amazon ECS 代理的CloudWatch集群的名称。

    • sd_cluster_region 是目标Amazon ECS集群的区域。此字段为可选项。默认值为安装了 Amazon ECS 代理的 CloudWatch 集群的区域。

    • sd_result_file 是 Prometheus 目标结果的 YAML 文件的路径。Prometheus 抓取配置将引用此文件。

    • docker_label 是一个可选部分,可用于为基于 docker 标签的服务发现指定配置。如果省略此部分,则不使用基于 docker 标签的发现。该部分可以包含以下字段:

      • sd_port_label 是容器的 Docker 标签名称,用于指定 Prometheus 指标的容器端口。默认值为 ECS_PROMETHEUS_EXPORTER_PORT。如果容器没有此 Docker 标签CloudWatch,代理将跳过它。

      • sd_metrics_path_label 是指定 Prometheus 指标路径的容器的 Docker 标签名称。默认值为 ECS_PROMETHEUS_METRICS_PATH。如果容器没有此 Docker 标签,则代理将采用默认路径 /metrics

      • sd_job_name_label 是容器的 Docker 标签名称,用于指定 Prometheus 抓取作业名称。默认值为 job。如果容器没有此 Docker 标签CloudWatch,则代理将在 Prometheus 抓取配置中使用作业名称。

    • task_definition_list 是一个可选部分,可用于指定基于任务定义的服务发现的配置。如果省略此部分,则不使用基于任务定义的发现。该部分可以包含以下字段:

      • sd_task_definition_arn_pattern 是用于指定要发现Amazon ECS的任务定义的模式。这是一个正则表达式。

      • sd_metrics_ports 列出 Prometheus 指标的 containerPort。使用分号分隔 containerPorts。

      • sd_container_name_pattern 指定Amazon ECS任务容器名称。这是一个正则表达式。

      • sd_metrics_path 指定 Prometheus 指标路径。如果省略此项,则代理将采用默认路径 /metrics

      • sd_job_name 指定 Prometheus 抓取作业名称。如果省略该字段, CloudWatch 代理将在 Prometheus 抓取配置中使用作业名称。

  • metric_declaration— 是指定要生成的采用嵌入式指标格式的日志数组的部分。默认情况下,metric_declaration 代理从中进行导入的每个 Prometheus 源都有 CloudWatch 部分。这些部分各包括以下字段:

    • label_matcher 是一个正则表达式,用于检查 中列出的标签的值source_labels。启用匹配的指标以包含在发送到 的嵌入式指标格式中CloudWatch。

    • source_labels 指定由 label_matcher 行检查的标签的值。

    • label_separator 指定要在 label_matcher 行中使用的分隔符(如果指定了多个 source_labels)。默认值为 ;。您可以在以下示例中看到 label_matcher 行中使用的此默认值。

    • metric_selectors 是一个正则表达式,用于指定要收集并发送到 的指标。CloudWatch

    • dimensions 是要用作每个选定指标的 CloudWatch 维度的标签列表。

请参阅以下 metric_declaration 示例。

"metric_declaration": [ { "source_labels":[ "Service", "Namespace"], "label_matcher":"(.*node-exporter.*|.*kube-dns.*);kube-system$", "dimensions":[ ["Service", "Namespace"] ], "metric_selectors":[ "^coredns_dns_request_type_count_total$" ] } ]

此示例配置嵌入式指标格式部分,以便在满足以下条件时作为日志事件发送:

  • 的值Service包含 node-exporterkube-dns

  • 的值为 Namespace kube-system

  • Prometheus 指标 coredns_dns_request_type_count_total 同时包含 ServiceNamespace 标签。

发送的日志事件包括以下突出显示的部分:

{ "CloudWatchMetrics":[ { "Metrics":[ { "Name":"coredns_dns_request_type_count_total" } ], "Dimensions":[ [ "Namespace", "Service" ] ], "Namespace":"ContainerInsights/Prometheus" } ], "Namespace":"kube-system", "Service":"kube-dns", "coredns_dns_request_type_count_total":2562, "eks_amazonaws_com_component":"kube-dns", "instance":"192.168.61.254:9153", "job":"kubernetes-service-endpoints", ... }

添加新的 Prometheus 抓取目标的教程:Prometheus API 服务器指标

默认情况下,Kubernetes API 服务器会在终端节点上公开 Prometheus 指标。Kubernetes API 服务器抓取配置的官方示例可在 Github 上找到。

以下教程演示如何执行以下步骤以开始将 Kubernetes API 服务器指标导入到 CloudWatch 中:

  • 将 Kubernetes API 服务器的 Prometheus 抓取配置添加到 CloudWatch 代理 YAML 文件。

  • 在 CloudWatch 代理 YAML 文件中配置嵌入式指标格式指标定义。

  • (可选)为 Kubernetes API 服务器指标创建 CloudWatch 控制面板。

注意

Kubernetes API 服务器公开计量表、计数器、直方图和摘要指标。在此版本的 Prometheus 指标支持中, 仅CloudWatch导入具有量规、计数器和摘要类型的指标。

开始在 中收集 Kubernetes API Server Prometheus 指标 CloudWatch

  1. 输入以下命令之一以下载最新版本的 prometheus-eks.yamlprometheus-eks-fargate.yamlprometheus-k8s.yaml 文件。

    对于具有 EC2 启动类型的 Amazon EKS 集群,请输入以下命令:

    curl -O https://raw.githubusercontent.com/aws-samples/amazon-cloudwatch-container-insights/latest/k8s-deployment-manifest-templates/deployment-mode/service/cwagent-prometheus/prometheus-eks.yaml

    对于具有 Amazon EKS 启动类型的 Fargate 集群,请输入以下命令:

    curl -O https://raw.githubusercontent.com/aws-samples/amazon-cloudwatch-container-insights/latest/k8s-deployment-manifest-templates/deployment-mode/service/cwagent-prometheus/prometheus-eks-fargate.yaml

    对于在 Amazon EC2 实例上运行的 Kubernetes 集群,请输入以下命令:

    curl -O https://raw.githubusercontent.com/aws-samples/amazon-cloudwatch-container-insights/latest/k8s-deployment-manifest-templates/deployment-mode/service/cwagent-prometheus/prometheus-k8s.yaml
  2. 使用文本编辑器打开文件,找到 prometheus-config 部分,然后在该部分中添加以下部分。然后,保存更改:

    # Scrape config for API servers - job_name: 'kubernetes-apiservers' kubernetes_sd_configs: - role: endpoints namespaces: names: - default scheme: https tls_config: ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt insecure_skip_verify: true bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token relabel_configs: - source_labels: [__meta_kubernetes_service_name, __meta_kubernetes_endpoint_port_name] action: keep regex: kubernetes;https - action: replace source_labels: - __meta_kubernetes_namespace target_label: Namespace - action: replace source_labels: - __meta_kubernetes_service_name target_label: Service
  3. 当 YAML 文件仍在文本编辑器中处于打开状态时,找到 cwagentconfig.json 部分。添加以下子部分并保存更改。本部分将 API 服务器指标放在CloudWatch代理允许列表中。将三种类型的 API Server 指标添加到允许列表中:

    • etcd 对象计数

    • API 服务器注册控制器指标

    • API 服务器请求指标

    {"source_labels": ["job", "resource"], "label_matcher": "^kubernetes-apiservers;(services|daemonsets.apps|deployments.apps|configmaps|endpoints|secrets|serviceaccounts|replicasets.apps)", "dimensions": [["ClusterName","Service","resource"]], "metric_selectors": [ "^etcd_object_counts$" ] }, {"source_labels": ["job", "name"], "label_matcher": "^kubernetes-apiservers;APIServiceRegistrationController$", "dimensions": [["ClusterName","Service","name"]], "metric_selectors": [ "^workqueue_depth$", "^workqueue_adds_total$", "^workqueue_retries_total$" ] }, {"source_labels": ["job","code"], "label_matcher": "^kubernetes-apiservers;2[0-9]{2}$", "dimensions": [["ClusterName","Service","code"]], "metric_selectors": [ "^apiserver_request_total$" ] }, {"source_labels": ["job"], "label_matcher": "^kubernetes-apiservers", "dimensions": [["ClusterName","Service"]], "metric_selectors": [ "^apiserver_request_total$" ] },
  4. 如果您已在集群中部署了具有 Prometheus 支持的 CloudWatch 代理,则必须通过输入以下命令将其删除:

    kubectl delete deployment cwagent-prometheus -n amazon-cloudwatch
  5. 通过输入以下命令之一,使用更新的配置部署 CloudWatch 代理。对于具有 EC2 启动类型的 Amazon EKS 集群,请输入:

    kubectl apply -f prometheus-eks.yaml

    对于具有 Amazon EKS 启动类型的 Fargate 集群,请输入以下命令。Replace MyClusterregion 替换为与您的部署匹配的值。

    cat prometheus-eks-fargate.yaml \ | sed "s/{{cluster_name}}/MyCluster/;s/{{region_name}}/region/" \ | kubectl apply -f -

    对于 Kubernetes 集群,请输入以下命令。Replace MyClusterregion 替换为与您的部署匹配的值。

    cat prometheus-k8s.yaml \ | sed "s/{{cluster_name}}/MyCluster/;s/{{region_name}}/region/" \ | kubectl apply -f -

完成此操作后,您应该在 /aws/containerinsights/ 中看到名为 kubernetes-apiservers 的新日志流。cluster_name/prometheus 日志组。此日志流应使用嵌入式指标格式定义来嵌入日志事件,如下所示:

{ "CloudWatchMetrics":[ { "Metrics":[ { "Name":"apiserver_request_total" } ], "Dimensions":[ [ "ClusterName", "Service" ] ], "Namespace":"ContainerInsights/Prometheus" } ], "ClusterName":"my-cluster-name", "Namespace":"default", "Service":"kubernetes", "Timestamp":"1592267020339", "Version":"0", "apiserver_request_count":0, "apiserver_request_total":0, "code":"0", "component":"apiserver", "contentType":"application/json", "instance":"192.0.2.0:443", "job":"kubernetes-apiservers", "prom_metric_type":"counter", "resource":"pods", "scope":"namespace", "verb":"WATCH", "version":"v1" }

您可以在 CloudWatch 控制台中的 ContainerInsights/Prometheus 命名空间中查看您的指标。您还可以选择为 Prometheus Kubernetes API 服务器指标创建CloudWatch控制面板。

(可选)为 Kubernetes API Server 指标创建控制面板

要在控制面板中查看 Kubernetes API 服务器指标,您必须先完成前面几个部分中的步骤,然后才能开始在 CloudWatch 中收集这些指标。

为 Kubernetes API Server 指标创建控制面板

  1. 通过以下网址打开 CloudWatch 控制台:https://console.amazonaws.cn/cloudwatch/

  2. 确保选择了正确的 AWS 区域。

  3. 在导航窗格中,选择 Dashboards

  4. 选择创建控制面板。输入新控制面板的名称,然后选择创建控制面板

  5. 添加到该控制面板中,选择取消

  6. 依次选择操作编辑控制面板

  7. 下载以下 JSON 文件:Kubernetes API 控制面板源

  8. 使用文本编辑器打开下载的 JSON 文件,然后执行以下更改:

    • 将所有 {{YOUR_CLUSTER_NAME}} 字符串替换为您的集群的确切名称。请勿在文本之前或之后添加空格。

    • 将所有 {{YOUR_REGION}} 字符串替换为在其中收集指标的区域的名称。例如 us-west-2。请勿在文本之前或之后添加空格。

  9. 复制整个 JSON blob 并将其粘贴到 CloudWatch 控制台的文本框中,替换框中已有的内容。

  10. 选择更新保存控制面板