使用 JMX Exporter 監控 JVM

參考：
https://www.kubernetes.org.cn/8515.html

概述

當你的 Java 業務容器化上 K8S 后，如何對其進行監控呢？Prometheus 社區開發了 JMX Exporter 來導出 JVM 的監控指標，以便使用 Prometheus 來采集監控數據。本文將介紹如何利用 Prometheus 與 JMX Exporter 來監控你 Java 應用的 JVM。

什么是 JMX Exporter ?

JMX Exporter 利用 Java 的 JMX 機制來讀取 JVM 運行時的一些監控數據，然后將其轉換為 Prometheus 所認知的 metrics 格式，以便讓 Prometheus 對其進行監控采集。
那么，JMX 又是什么呢？它的全稱是：Java Management Extensions。顧名思義，是管理 Java 的一種擴展框架，JMX Exporter 正是基於此框架來讀取 JVM 的運行時狀態的。

如何使用 JMX Exporter 暴露 JVM 監控指標 ?

下面介紹如何通過 JMX Exporter 來暴露 Java 應用的 JVM 監控指標。

JMX Exporter 的兩種用法

JMX-Exporter 提供了兩種用法:

1.啟動獨立進程。-- JVM 啟動時指定參數，暴露 JMX 的 RMI 接口，JMX-Exporter 調用 RMI 獲取 JVM 運行時狀態數據，轉換為 Prometheus metrics 格式，並暴露端口讓 Prometheus 采集。
2.JVM 進程內啟動(in-process)。-- JVM 啟動時指定參數，通過 javaagent 的形式運行 JMX-Exporter 的 jar 包，進程內讀取 JVM 運行時狀態數據，轉換為 Prometheus metrics 格式，並暴露端口讓 Prometheus 采集。

官方不推薦使用第一種方式，一方面配置復雜，另一方面因為它需要一個單獨的進程，而這個進程本身的監控又成了新的問題，所以本文重點圍繞第二種用法講如何在 K8S 環境下使用 JMX Exporter 暴露 JVM 監控指標。

打包鏡像

使用第二種用法，啟動 JVM 時需要指定 JMX Exporter 的 jar 包文件和配置文件。jar 包是二進制文件，不好通過 configmap 掛載，配置文件我們幾乎不需要修改，所以建議是直接將 JMX Exporter 的 jar 包和配置文件都打包到業務容器鏡像中。

首先准備一個制作鏡像的目錄，放入 JMX Exporter 配置文件 prometheus-jmx-config.yaml:

---
ssl: false
lowercaseOutputName: false
lowercaseOutputLabelNames: false

注: 更多配置項請參考官方文檔。

---
startDelaySeconds: 0
hostPort: 127.0.0.1:1234
username: 
password: 
jmxUrl: service:jmx:rmi:///jndi/rmi://127.0.0.1:1234/jmxrmi
ssl: false
lowercaseOutputName: false
lowercaseOutputLabelNames: false
whitelistObjectNames: ["org.apache.cassandra.metrics:*"]
blacklistObjectNames: ["org.apache.cassandra.metrics:type=ColumnFamily,*"]
rules:
  - pattern: 'org.apache.cassandra.metrics<type=(\w+), name=(\w+)><>Value: (\d+)'
    name: cassandra_$1_$2
    value: $3
    valueFactor: 0.001
    labels: {}
    help: "Cassandra metric $1 $2"
    cache: false
    type: GAUGE
    attrNameSnakeCase: false

然后准備 jar 包文件，可以在 jmx_exporter 的 Github 頁面找到最新的 jar 包下載地址，下載到當前目錄:

wget https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent/0.13.0/jmx_prometheus_javaagent-0.13.0.jar

再准備 Dockerfile，這里以 tomcat 為例:

FROM tomcat:jdk8-openjdk-slim
ADD prometheus-jmx-config.yaml /prometheus-jmx-config.yaml
ADD jmx_prometheus_javaagent-0.13.0.jar /jmx_prometheus_javaagent-0.13.0.jar

最后編譯鏡像:

docker build . -t ccr.ccs.tencentyun.com/imroc/tomcat:jdk8

搞定！如果想要更簡單，可以利用 docker 多階段構建，省掉手動下載 jar 包的步驟，Dockerfile 示例:

FROM ubuntu:16.04 as jar
WORKDIR /
RUN apt-get update -y
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y wget
RUN wget https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent/0.13.0/jmx_prometheus_javaagent-0.13.0.jar

FROM tomcat:jdk8-openjdk-slim
ADD prometheus-jmx-config.yaml /prometheus-jmx-config.yaml
COPY --from=jar /jmx_prometheus_javaagent-0.13.0.jar /jmx_prometheus_javaagent-0.13.0.jar

部署 Java 應用

有了打包好的鏡像，下一步我們看下如何部署應用到 K8S，關鍵點在於如何修改 JVM 啟動參數以便啟動時加載 JMX Exporter。JVM 啟動時會讀取 JAVA_OPTS 環境變量，作為額外的啟動參數，所以我們部署時可以為應用增加一下這個環境變量，示例:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: tomcat
spec:
  replicas: 1
  selector:
    matchLabels:
      app: tomcat
  template:
    metadata:
      labels:
        app: tomcat
    spec:
      containers:
      - name: tomcat
        image: ccr.ccs.tencentyun.com/imroc/tomcat:jdk8
        env:
        - name: JAVA_OPTS
          value: "-javaagent:/jmx_prometheus_javaagent-0.13.0.jar=8088:/prometheus-jmx-config.yaml"
---
apiVersion: v1
kind: Service
metadata:
  name: tomcat
  labels:
    app: tomcat
spec:
  type: ClusterIP
  ports:
  - port: 8080
    protocol: TCP
    name: http
  - port: 8088
    protocol: TCP
    name: jmx-metrics
  selector:
    app: tomcat

• 啟動參數格式: -javaagent:<jar>=<port>:<config>。
• 這里使用了 8088 端口暴露 JVM 的監控指標，可自行更改。

添加 Prometheus 監控配置

暴露了 JVM 的監控指標，現在來配置下 Prometheus，讓監控數據被采集到，配置示例:

    - job_name: tomcat
      scrape_interval: 5s
      kubernetes_sd_configs:
      - role: endpoints
        namespaces:
          names:
          - default
      relabel_configs:
      - action: keep
        source_labels:
        - __meta_kubernetes_service_label_app
        regex: tomcat
      - action: keep
        source_labels:
        - __meta_kubernetes_endpoint_port_name
        regex: jmx-metrics

如果是安裝了 prometheus-operator，也可以通過創建 ServiceMonitor 的 CRD 對象來配置 Prometheus:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: tomcat
  namespace: default
  labels:
    app: tomcat
spec:
  endpoints:
  - port: jmx-metrics
    interval: 5s
  namespaceSelector:
    matchNames:
    - default
  selector:
    matchLabels:
      app: tomcat

添加 Grafana 監控面板

采集到了數據，下面看下如何展示數據，如果熟悉 Prometheus 和 Grafana，可自行根據指標設計需要的面板，社區也有提供現成的，不過都有些老了，部分視圖可能展示不出來，用的比較多的是 https://grafana.com/grafana/dashboards/8563 ，可以直接導入，面板效果圖:

參考資料

• JMX Exporter 項目地址: https://github.com/prometheus/jmx_exporter
• JVM 監控面板: https://grafana.com/grafana/dashboards/8563