Scraping zusätzlicher Prometheus-Quellen und Importieren dieser Metriken - Amazon CloudWatch

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Scraping zusätzlicher Prometheus-Quellen und Importieren dieser Metriken

Der CloudWatch Agent mit Prometheus-Überwachung benötigt zwei Konfigurationen, um die Prometheus-Metriken zu erfassen. Er folgt der standardmäßigen Prometheus-Konfiguration, wie in <scrape_config> in der Prometheus-Dokumentation erläutert. Die andere ist für die Agentenkonfiguration vorgesehen. CloudWatch

Für Amazon EKS-Cluster sind die Konfigurationen in prometheus-eks.yaml (für den EC2 Starttyp) oder prometheus-eks-fargate.yaml (für den Fargate-Starttyp) als zwei Konfigurationszuordnungen definiert:

  • Der name: prometheus-config-Abschnitt enthält die Einstellungen für Prometheus-Scraping.

  • Der name: prometheus-cwagentconfig Abschnitt enthält die Konfiguration für den CloudWatch Agenten. In diesem Abschnitt können Sie konfigurieren, wie die Prometheus-Metriken von erfasst werden. CloudWatch Sie geben beispielsweise an, in welche Metriken importiert werden sollen CloudWatch, und definieren deren Dimensionen.

Für Kubernetes-Cluster, die auf EC2 Amazon-Instances ausgeführt werden, sind die Konfigurationen in der prometheus-k8s.yaml YAML-Datei als zwei Konfigurationszuordnungen definiert:

  • Der name: prometheus-config-Abschnitt enthält die Einstellungen für Prometheus-Scraping.

  • Der name: prometheus-cwagentconfig Abschnitt enthält die Konfiguration für den Agenten. CloudWatch

Um zusätzliche Prometheus-Metrikquellen zu scrapen und diese Metriken zu importieren CloudWatch, ändern Sie sowohl die Prometheus-Scrape-Konfiguration als auch die Agentenkonfiguration und stellen dann den CloudWatch Agenten mit der aktualisierten Konfiguration erneut bereit.

Anforderungen an VPC-Sicherheitsgruppen

Die Eingangsregeln der Sicherheitsgruppen für die Prometheus-Workloads müssen die Prometheus-Ports für den CloudWatch Agenten öffnen, damit er die Prometheus-Metriken über die private IP scrapen kann.

Die Ausgangsregeln der Sicherheitsgruppe für den CloudWatch Agenten müssen es dem CloudWatch Agenten ermöglichen, über eine private IP eine Verbindung zum Port der Prometheus-Workloads herzustellen.

Prometheus-Scrape-Konfiguration

Der CloudWatch Agent unterstützt die standardmäßigen Prometheus-Scrape-Konfigurationen, wiehttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config <scrape_config>in der Prometheus-Dokumentation dokumentiert. Sie können diesen Abschnitt bearbeiten, um die Konfigurationen zu aktualisieren, die sich bereits in dieser Datei befinden, und zusätzliche Prometheus-Scraping-Ziele hinzufügen. Standardmäßig enthält die Beispielkonfigurationsdatei die folgenden globalen Konfigurationszeilen:

global: scrape_interval: 1m scrape_timeout: 10s
  • scrape_interval – Definiert, wie oft das Scraping von zielen durchgeführt werden soll.

  • scrape_timeout – Definiert, wie lange gewartet werden soll, bis für eine Scrape-Anforderung eine Zeitüberschreitung eintritt.

Sie können auch verschiedene Werte für diese Einstellungen auf Auftragsebene definieren, um die globalen Konfigurationen zu überschreiben.

Prometheus-Scraping-Aufträge

Für die YAML-Dateien des CloudWatch Agenten sind bereits einige Standard-Scraping-Jobs konfiguriert. In prometheus-eks.yaml werden beispielsweise die Standard-Scraping-Aufträge in den job_name-Zeilen im Abschnitt scrape_configs konfiguriert. In dieser Datei kratzt der folgende Standard-kubernetes-pod-jmx-Abschnitt JMX-Exporter-Metriken.

- 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

Jedes dieser Standardziele wird gelöscht, und die Metriken werden im eingebetteten Metrikformat CloudWatch an Protokollereignisse gesendet. Weitere Informationen finden Sie unter Einbetten von Metriken in Protokollen.

Protokollereignisse von Amazon EKS- und Kubernetes-Clustern werden in der Protokollgruppe /aws/containerinsights/ /prometheus unter cluster_name Logs gespeichert. CloudWatch Protokollereignisse von Amazon ECS-Clustern werden in der Protokollgruppe/aws/ecs/containerinsights/cluster_name/prometheus gespeichert.

Jeder Scraping-Auftrag ist in einem anderen Protokoll-Stream in dieser Protokollgruppe enthalten. Beispielsweise ist der Prometheus-Scraping-Auftrag kubernetes-pod-appmesh-envoy für App Mesh definiert. Alle App Mesh Prometheus-Metriken von Amazon EKS- und Kubernetes-Clustern werden an den Protokollstream mit dem Namen /aws/containerinsights/ >prometheus//gesendet. cluster_name kubernetes-pod-appmesh-envoy

Um ein neues Scraping-Ziel hinzuzufügen, fügen Sie dem Abschnitt scrape_configs der YAML-Datei einen neuen job_name-Abschnitt hinzu und starten Sie den Agenten neu. Ein Beispiel für diesen Prozess finden Sie unter Tutorial zum Hinzufügen eines neuen Prometheus-Scrape-Ziels: Prometheus-API-Server-Metriken.

CloudWatch Agentenkonfiguration für Prometheus

Die CloudWatch Agentenkonfigurationsdatei enthält einen prometheus Abschnitt metrics_collected für die Prometheus-Scraping-Konfiguration. Es sind folgende Konfigurationsoptionen enthalten:

  • Clustername – Gibt den Clusternamen an, der als Bezeichnung im Protokollereignis hinzugefügt werden soll. Dies ist ein optionales Feld. Wenn Sie es weglassen, kann der Agent den Amazon-EKS- oder Kubernetes-Clusternamen erkennen.

  • log_group_name – Gibt den Namen der Protokollgruppe für die Prometheus-Scrape-Metriken an. Dies ist ein optionales Feld. Wenn Sie es weglassen, wird /aws/containerinsights/ cluster_name /prometheus für Protokolle von Amazon EKS- und Kubernetes-Clustern CloudWatch verwendet.

  • prometheus_config_path – gibt den Pfad der Prometheus-Scrape-Konfigurationsdatei an. Wenn der Wert dieses Felds mit env: beginnt, wird der Inhalt der Prometheus-Scrape-Konfigurationsdatei aus der Umgebungsvariablen des Containers abgerufen. Ändern Sie dieses Feld nicht.

  • ecs_service_discovery – ist der Abschnitt zum Angeben der Konfiguration für die Amazon-ECS-Prometheus-Serviceerkennung. Weitere Informationen finden Sie unter Ausführliche Anleitung zu Autodiscovery auf Amazon-ECS-Clustern.

    Der Abschnitt ecs_service_discovery kann die folgenden Felder enthalten:

    • sd_frequency ist die Häufigkeit, mit der die Prometheus-Exporteure entdeckt werden. Geben Sie eine Zahl und ein Einheitensuffix an. Zum Beispiel 1m für einmal pro Minute oder 30s für einmal pro 30 Sekunden. Gültige Einheitensuffixe sind ns, us, ms, s, m und h.

      Dies ist ein optionales Feld. Der Standardwert ist 60 Sekunden (1 Minute).

    • sd_target_cluster ist der Name des Amazon-ECS-Ziel-Clusters für die automatische Erkennung. Dies ist ein optionales Feld. Der Standard ist der Name des Amazon ECS-Clusters, auf dem der CloudWatch Agent installiert ist.

    • sd_cluster_region ist die Region des Amazon-ECS-Ziel-Clusters. Dies ist ein optionales Feld. Die Standardeinstellung ist die Region des Amazon ECS-Clusters, in der der CloudWatch Agent installiert ist.

    • sd_result_file ist der Pfad der YAML-Datei für die Prometheus Zielergebnisse. Die Prometheus-Scrape-Konfiguration bezieht sich auf diese Datei.

    • docker_label ist ein optionaler Abschnitt, mit dem Sie die Konfiguration für die Docker-Beschriftungs-basierte Service-Discovery angeben können. Wenn Sie diesen Abschnitt auslassen, wird die Docker-Bezeichnungs-basierte Erkennung nicht verwendet. Dieser Abschnitt kann die folgenden Felder enthalten:

      • sd_port_label ist der Docker-Bezeichnungsname des Containers, der den Container-Port für Prometheus Metriken angibt. Der Standardwert ist ECS_PROMETHEUS_EXPORTER_PORT. Wenn der Container dieses Docker-Label nicht hat, überspringt der CloudWatch Agent es.

      • sd_metrics_path_label ist der Docker-Bezeichnungsname des Containers, der den Pfad für Prometheus Metriken angibt. Der Standardwert ist ECS_PROMETHEUS_METRICS_PATH. Wenn der Container nicht über diese Docker-Bezeichnung verfügt, nimmt der Agent den Standardpfad /metrics an.

      • sd_job_name_label ist der Docker-Bezeichnungsname des Containers, der den Container-Scraping-Auftrag-Namen für Prometheus angibt. Der Standardwert ist job. Wenn der Container dieses Docker-Label nicht hat, verwendet der CloudWatch Agent den Jobnamen in der Prometheus-Scrape-Konfiguration.

    • task_definition_list ist ein optionaler Abschnitt, den Sie verwenden können, um die Konfiguration der aufgabendefinitionsbasierten Serviceerkennung anzugeben. Wenn Sie diesen Abschnitt auslassen, wird die aufgabendefinitionsbasierte Erkennung nicht verwendet. Dieser Abschnitt kann die folgenden Felder enthalten:

      • sd_task_definition_arn_pattern ist das Muster, das verwendet wird, um die zu erkennenden Amazon-ECS-Aufgabendefinitionen anzugeben. Dies ist ein regulärer Ausdruck.

      • sd_metrics_ports listet den containerPort für die Prometheus-Metriken auf. Trennen Sie die ContainerPorts durch Semikolons.

      • sd_container_name_pattern gibt die Namen des Amazon-ECS-Aufgabencontainers an. Dies ist ein regulärer Ausdruck.

      • sd_metrics_path gibt den Prometheus-Metrikpfad an. Wenn Sie dies weglassen, übernimmt der Agent den Standardpfad /metrics

      • sd_job_name gibt den Namen des Prometheus -Scrape-Auftrags an. Wenn Sie dieses Feld weglassen, verwendet der CloudWatch Agent den Jobnamen in der Prometheus-Scrape-Konfiguration.

  • metric_declaration – sind Abschnitte, die das Array von Protokollen mit eingebettetem Metrikformat angeben, das generiert werden soll. Es gibt metric_declaration-Abschnitte für jede Prometheus-Quelle, aus der der CloudWatch -Agent standardmäßig importiert. Diese Abschnitte enthalten jeweils die folgenden Felder:

    • label_matcher ist ein regulärer Ausdruck, der den Wert der in source_labels aufgelisteten Beschriftungen überprüft. Die übereinstimmenden Metriken sind für die Aufnahme in das eingebettete Metrikformat aktiviert, das an gesendet wird. CloudWatch

      Wenn in source_labels mehrere Bezeichnungen angegeben sind, empfehlen wir, keine ^- oder $-Zeichen im regulären Ausdruck für label_matcher zu verwenden.

    • source_labels gibt den Wert der Beschriftungen an, die von der label_matcher-Zeile überprüft werden.

    • label_separator gibt das Trennzeichen an, das in der Zeile label_matcherverwendet werden soll, wenn mehrere source_labels angegeben werden. Der Standardwert ist ;. Sie können diesen Standardwert in der Zeile label_matcher im folgenden Beispiel sehen.

    • metric_selectors ist ein regulärer Ausdruck, der die Metriken angibt, die erfasst und an CloudWatch gesendet werden sollen.

    • dimensions ist die Liste der Beschriftungen, die als CloudWatch-Dimensionen für jede ausgewählte Metrik verwendet werden sollen.

Sehen Sie sich das folgende metric_declaration-Beispiel an.

"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$" ] } ]

In diesem Beispiel wird ein eingebetteter Metrikformatabschnitt konfiguriert, der als Protokollereignis gesendet wird, wenn die folgenden Bedingungen erfüllt sind:

  • Der Wert von Service enthält entweder node-exporter oder kube-dns.

  • Der Wert von Namespace ist kube-system.

  • Die Prometheus-Metrik coredns_dns_request_type_count_total enthält sowohl Service-als auch Namespace-Beschriftungen.

Das Protokollereignis, das gesendet wird, enthält den folgenden hervorgehobenen Abschnitt:

{ "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", ... }

Tutorial zum Hinzufügen eines neuen Prometheus-Scrape-Ziels: Prometheus-API-Server-Metriken

Der Kubernetes API Server stellt Prometheus-Metriken standardmäßig auf Endpunkten zur Verfügung. Das offizielle Beispiel für die Kubernetes API Server-Scraping-Konfiguration ist auf Github verfügbar.

Das folgende Tutorial zeigt, wie Sie die folgenden Schritte ausführen, um mit dem Importieren von Kubernetes API Server-Metriken in CloudWatch zu beginnen:

  • Hinzufügen der Prometheus-Scraping-Konfiguration für Kubernetes API Server zur CloudWatch -Agent-YAML-Datei.

  • Konfiguration der Metrikdefinitionen im eingebetteten Metrikformat in der YAML-Datei des CloudWatch Agenten.

  • (Optional) Erstellen eines CloudWatch Dashboards für die Kubernetes API-Server-Metriken.

Anmerkung

Der Kubernetes API Server stellt Mess-, Zähler-, Histogramm- und Übersichtsmetriken zur Verfügung. In dieser Version der Prometheus-Metrikunterstützung werden nur die Metriken mit den Typen Messgerät, Zähler und Zusammenfassung CloudWatch importiert.

Um mit der Erfassung von Kubernetes API Server Prometheus-Metriken zu beginnen in CloudWatch
  1. Laden Sie die aktuelle Version der prometheus-eks.yaml-, prometheus-eks-fargate.yaml- oder prometheus-k8s.yaml-Datei herunter, indem Sie einen der folgenden Befehle eingeben.

    Geben Sie für einen Amazon EKS-Cluster mit dem EC2 Starttyp den folgenden Befehl ein:

    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

    Geben Sie den folgenden Befehl für einen Amazon-EKS-Cluster mit dem Fargate-Starttyp ein:

    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

    Geben Sie für einen Kubernetes-Cluster, der auf einer EC2 Amazon-Instance ausgeführt wird, den folgenden Befehl ein:

    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. Öffnen Sie die Datei mit einem Texteditor, suchen Sie den Abschnitt prometheus-config und fügen Sie den folgenden Abschnitt in diesem Abschnitt hinzu. Speichern Sie dann die Änderungen:

    # 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. Während Sie die YAML-Datei noch im Texteditor geöffnet haben, suchen Sie den Abschnitt cwagentconfig.json. Fügen Sie den folgenden Unterabschnitt hinzu und speichern Sie die Änderungen. In diesem Abschnitt werden die API-Server-Metriken in die Zulassungsliste für CloudWatch Agenten aufgenommen. Drei Typen von API-Server-Metriken werden der Genehmigungsliste hinzugefügt:

    • etcd-Objektanzahl

    • API-Server-Registrierungscontroller-Metriken

    • API-Server-Anforderungsmetriken

    {"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. Wenn Sie den CloudWatch Agenten mit Prometheus-Unterstützung bereits im Cluster bereitgestellt haben, müssen Sie ihn löschen, indem Sie den folgenden Befehl eingeben:

    kubectl delete deployment cwagent-prometheus -n amazon-cloudwatch
  5. Stellen Sie den CloudWatch Agenten mit Ihrer aktualisierten Konfiguration bereit, indem Sie einen der folgenden Befehle eingeben. Geben Sie für einen Amazon EKS-Cluster mit dem EC2 Starttyp Folgendes ein:

    kubectl apply -f prometheus-eks.yaml

    Geben Sie den folgenden Befehl für einen Amazon-EKS-Cluster mit dem Fargate-Starttyp ein. Ersetzen Sie MyCluster und region durch Werte, die Ihrer Bereitstellung entsprechen.

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

    Geben Sie für einen Kubernetes-Cluster den folgenden Befehl ein. Ersetzen Sie MyCluster und region durch Werte, die Ihrer Bereitstellung entsprechen.

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

Sobald Sie dies getan haben, sollten Sie einen neuen Protokollstream mit dem Namen kubernetes-apiservers in der Protokollgruppe /aws/containerinsights/ /prometheus-Protokollgruppe sehen. cluster_name Dieser Protokoll-Stream sollte Protokollereignisse mit einer Definition des eingebetteten Metrikformats wie folgt einschließen:

{ "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" }

Sie können Ihre Metriken in der CloudWatch Konsole im ContainerInsights/Prometheus-Namespace anzeigen. Sie können optional auch ein CloudWatch Dashboard für Ihre Prometheus Kubernetes API Server-Metriken erstellen.

(Optional) Erstellen eines Dashboards für die Kubernetes API-Server-Metriken.

Um Kubernetes API Server-Metriken in Ihrem Dashboard anzuzeigen, müssen Sie zuerst die Schritte in den vorherigen Abschnitten ausgeführt haben, damit mit dem Sammeln dieser Metriken in CloudWatch begonnen wird.

So erstellen Sie ein Dashboard für Kubernetes-API-Server-Metriken
  1. Öffnen Sie die Konsole unter. CloudWatch https://console.aws.amazon.com/cloudwatch/

  2. Vergewissern Sie sich, dass Sie die richtige AWS Region ausgewählt haben.

  3. Wählen Sie im Navigationsbereich Dashboards aus.

  4. Klicken Sie auf Create Dashboard (Dashboard erstellen). Geben Sie einen Namen für das neue Dashboard ein und wählen Sie Create dashboard (Dashboard erstellen).

  5. Wählen Sie unter Add to this dashboard (Zu diesem Dashboard hinzufügen) die Option Cancel (Abbrechen).

  6. Wählen Sie Actions (Aktionen), View/edit source (Quelle anzeigen/bearbeiten).

  7. Laden Sie die folgende JSON-Datei herunter: Kubernetes API Dashboard-Quelle.

  8. Öffnen Sie die heruntergeladene JSON-Datei mit einem Texteditor und nehmen Sie die folgenden Änderungen vor:

    • Ersetzen Sie alle {{YOUR_CLUSTER_NAME}}-Zeichenfolgen durch den genauen Namen Ihres Clusters. Stellen Sie sicher, dass keine Leerzeichen vor oder nach dem Text hinzugefügt werden.

    • Ersetzen Sie alle {{YOUR_AWS_REGION}}-Zeichenfolgen durch den Namen der Region, in der die Metriken erfasst werden. Zum Beispiel us-west-2. Stellen Sie sicher, dass keine Leerzeichen vor oder nach dem Text hinzugefügt werden.

  9. Kopieren Sie das gesamte JSON-Blob und fügen Sie es in das Textfeld in der CloudWatch-Konsole ein. Ersetzen Sie dabei den Inhalt des Feldes.

  10. Wählen Sie Update (Aktualisieren), Save dashboard (Dashboard speichern).