如何在 Kubernetes 裡部署 JMX Exporter

SRETalk發表於2024-07-31
Export

本文會透過一個 Java 應用，演示 Prometheus JMX Exporter 在 Kubernetes 裡的部署和配置方式。為了更好地理解 JMX Exporter，我們將使用 Spring Boot Java 應用程式並將所有 JMX 指標匯出給 Prometheus。在本指南結束時，您將學習：

  • 使用 Java 應用映象啟動 JMX Exporter
  • 將 JMX 指標匯出給 Prometheus
  • 使用 Prometheus SD 配置抓取應用程式的 JMX 指標
  • 從 Prometheus 儀表板驗證和查詢 JMX 指標

先決條件

  • 具有部署許可權的 Kubernetes 叢集
  • 在 Kubernetes 上執行的 Prometheus

JMX Exporter

首先，讓我們瞭解一下 JMX Exporter 是如何工作的。下圖顯示了在 Kubernetes 上部署 JMX Exporter 時的工作流。

jmx-on-kubernetes-1

MBean（Managed Bean）Server 位於 Java 應用程式的 Java 虛擬機器 （JVM） 中，充當與應用程式的執行狀況和效能相關的資料儲存庫。MBean 元件公開應用程式指標，例如狀態、動作和操作資訊。

javaagent 可以訪問 Mbean Server 並獲取執行狀況和效能資料。Prometheus JMX Exporter 也是一個 javaagent，它能夠訪問 MBean Server 的資料並將該資料轉換為 Prometheus 指標格式。然後，Prometheus 從 JMX Exporter 的預設指標路徑（即 /metrics）中抓取指標。

在 Kubernetes 中部署 JMX Exporter

步驟 1：使用 JMX agent 構建應用程式 Docker 映象

JMX Exporter 的 javaagent 要和應用程式一起執行（Java 程式透過 java -javaagent 引數指定 JMX Exporter 的 jar 包路徑）。您可以從此處下載 JMX exporter agent jar 檔案 -> JMX Exporter Download。構建 Java 程式映象時，將 JMX Exporter jar 檔案一併新增到映象中。

FROM techiescamp/jre-17:1.0.0

ENV APP_NAME=jmx-java-app
ENV JMX_PORT=5556

WORKDIR /app

COPY /java-agent/*.jar /app/jmx-agent.jar
COPY /java-app/*.jar /app/java.jar
COPY config.yaml /app/

CMD java -javaagent:jmx-agent.jar=${JMX_PORT}:config.yaml -jar java.jar

我已經構建了 docker 映象並將其推送到 Dockerhub。如果您正在學習測試 JMX，則可以直接使用下面的映象。

techiescamp/jmx-pet-clinic-app:latest

步驟 2：為 JMX Exporter 建立 ConfigMap

我們需要為 JMX 配置建立一個名為 jmx-exporter-configmap.yaml 的 ConfigMap 物件。在此檔案中，我們將提供資訊以從 MBean Server 中過濾所需的指標。此配置避免了不必要的指標收集，將其限制為僅我們需要的指標。

建立 jmx-exporter-configmap.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: jmx-exporter-config
  namespace: monitoring
data:
  config.yaml: |-
    lowercaseOutputName: true
    lowercaseOutputLabelNames: true
    whitelistObjectNames: ["java.lang:type=Memory", "java.lang:type=GarbageCollector,*"]

在這裡，您可以看到我已經提到名稱空間值是 monitoring，這是因為我的所有監控元件都位於該特定名稱空間中。如果要使用相同的配置，請在開始配置之前建立具有相同名稱的名稱空間。

在資料部分，我們可以定義 JMX Exporter 必須從 MBean Server 收集的指標型別。在此配置中，我給出了一個小示例來過濾應用程式的記憶體相關指標。要了解有關配置的更多資訊，請訪問官方文件。

要在 Kubernetes 中部署此配置，請使用以下命令。

kubectl apply -f jmx-exporter-configmap.yaml

檢視 monitoring 名稱空間中的 ConfigMap。

kubectl get configmaps -n monitoring

步驟 3：為應用程式建立部署清單

建立部署 YAML 檔案 app-deployment.yaml。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: jmx-java-app
  namespace: monitoring
spec:
  replicas: 2
  selector:
    matchLabels:
      app: jmx-java-app
  template:
    metadata:
      labels:
        app: jmx-java-app
    spec:
      containers:
        - name: jmx-java-app-container
          image: techiescamp/jmx-pet-clinic-app:latest
          ports:
            - containerPort: 8080
            - containerPort: 5556
          volumeMounts:
            - name: jmx-exporter-config-volume
              mountPath: /app/config.yaml
              subPath: config.yaml
      volumes:
        - name: jmx-exporter-config-volume
          configMap:
            name: jmx-exporter-config

在這裡，您可以看到我在容器外部公開埠 8080 和 5556。這裡很重要的一點是 volumeMounts 部分。mountPath 使用 configmap 作為卷。它覆蓋容器預設的 /app/config.yaml。現在我們 apply 一下：

kubectl apply -f app-deployment.yaml

檢視 monitoring 名稱空間中的 Deployment。

kubectl get deployments -n monitoring

檢視 monitoring 名稱空間中的 Pod。

kubectl get pods -n monitoring -o wide

出於測試目的，我提供了兩個副本，因此我們可以看到兩個 Java 應用程式 Pod 在 monitoring namespace 中執行。

步驟 4：為應用程式建立服務

為應用程式建立服務清單：app-service.yaml

apiVersion: v1
kind: Service
metadata:
  name: jmx-java-app-nodeport
  namespace: monitoring
spec:
  selector:
    app: jmx-java-app
  ports:
  - name: http
    protocol: TCP
    port: 8080
    targetPort: 8080
    nodePort: 30750  
  - name: jmx
    protocol: TCP
    port: 5556
    targetPort: 5556
    nodePort: 30850  
  type: NodePort

我想透過網路訪問應用程式和指標，因此我使用 spec.type: NodePort，並定義 nodePort 埠號，例如應用程式的 30750 和指標的 30850。

下面 apply 一下：

kubectl apply -f app-service.yaml

在 monitoring namespace 中檢視服務列表。

kubectl get svc -n monitoring

現在，讓我們嘗試透過網路訪問應用程式和指標，為此，您需要任意一個 Node 的 IP 和埠號。

應用程式的輸出：

SpringBoot Java Application using JMX Exporter jar

指標的輸出：

SpringBoot Java Application Expose Metrics

步驟 5：在 Prometheus 中新增 Scrape 配置

注意：此配置必須在 Prometheus Server 上完成。

JMX Exporter 已成功公開 Java 應用程式的度量指標。現在我們在 Prometheus 伺服器配置檔案中新增一個作業來抓取這些指標，然後只有我們可以將它們儲存在 TSDB 中或進行查詢。

找到 Prometheus ConfigMap，在我的設定中，檔名是 config-map.yaml。使用文字編輯器開啟它。

vim config-map.yaml

如果想檢視 monitoring 名稱空間中的 ConfigMap，請使用以下命令：kubectl get configmaps -n monitoring

在 Prometheus 的配置檔案的 scrape_configs 部分新增以下配置。

scrape_configs:
- job_name: 'jmx-java-app'
  kubernetes_sd_configs:
  - role: pod
    namespaces:
      names:
        - monitoring
  relabel_configs:
  - source_labels: [__meta_kubernetes_pod_label_app]
    action: keep
    regex: 'jmx-java-app'
  - source_labels: [__meta_kubernetes_namespace]
    target_label: namespace
  - source_labels: [__meta_kubernetes_pod_name]
    target_label: pod_name
  - target_label: __address__
    replacement: "jmx-java-app-nodeport:5556"

在此 Promtheus 配置中，我使用的是 kubernetes_sd_configs 服務發現方法，該方法使用 jmx-java-app 標籤自動識別屬於 jmx-java-app 部署的 pod。即 relabel 的 keep 部分起到了這個過濾效果：

- source_labels: [__meta_kubernetes_pod_label_app]
  action: keep
  regex: 'jmx-java-app'

下面我們 apply 一下：

kubectl apply -f config-map.yaml

在 Prometheus 儀表板中複製更改可能需要幾分鐘時間。如果看不到更改，請使用以下命令執行部署。將 prometheus-deployment 更改為實際的 Prometheus Deployment 名稱。

kubectl rollout restart deployment prometheus-deployment -n monitoring

步驟 6：從 Prometheus Dashboard 驗證 JMX 指標

您可以從 Prometheus 儀表板驗證 JMX 目標。在“目標”選單下，我們可以看到 endpoint 詳細資訊、狀態和其他資訊，如下所示。

JMX: Prometheus targets

在 Graph 部分，我們可以進行查詢並獲得結果。例如，以下儀表板顯示了應用中 jvm_memory_bytes_used 指標。

JMX: Prometheus Graph

步驟 7：Grafana 儀表板

我們可以根據自己的要求在 Grafana 儀表板中視覺化 JMX 指標。如果您已設定 Grafana 並將 Prometheus 新增為資料來源，則可以使用 JMX 指標模板 建立儀表板。您可以在 Grafana 部落格上檢視視覺化 Promtheus 指標以瞭解更多資訊。

JMX Exporter Dashboard

總結

在這篇部落格中，我們介紹了在 Kubernetes 叢集上實現 JMX Exporter 的步驟。此外，在匯出器 Configmap 中，您可以為 JMX Exporter 新增其他過濾器設定，以收集其他指標。

原文：https://devopscube.com/jenkins-architecture-explained/
譯文：https://flashcat.cloud/blog/jenkins-architecture-explained/
譯者：巴輝特

本部落格出自快貓星雲的小夥伴們，快貓星雲是一家專注在監控/可觀測性領域的初創公司，其團隊是開源專案 Open-Falcon、Nightingale 的創始團隊。如果您想要採購監控/可觀測性相關的產品方案，歡迎 聯絡我們做產品技術交流。

相關文章