## 場景

Prometheus 社群開發了 JMX Exporter 用於匯出 JVM 的監控指標，以便使用 Prometheus 來採集監控資料。當您的 Java 應用部署在Rainbond上後

可透過本文了解部署在 Rainbond 上的 Java 應用如何使用  JMX Exporter 暴露 JVM 監控指標。

## JMX Exporter 簡介

Java Management Extensions，JMX 是管理 Java 的一種擴充套件框架，JMX Exporter 基於此框架讀取 JVM 的執行時狀態。JMX Exporter 利用 Java 的 JMX 機制來讀取 JVM 執行時的監控資料，然後將其轉換為 Prometheus 可辨識的 metrics 格式，讓 Prometheus 對其進行監控採集。

JMX Exporter 提供 `啟動獨立程式` 及 `JVM 程式內啟動（in-process)`兩種方式暴露 JVM 監控指標：

**啟動獨立程式**

JVM 啟動時指定引數，暴露 JMX 的 RMI 介面。JMX Exporter 呼叫 RMI 獲取 JVM 執行時狀態資料，轉換為 Prometheus metrics 格式，並暴露埠讓 Prometheus 採集。

**JVM 程式內啟動（in-process)**

JVM 啟動時指定引數，透過 javaagent 的形式執行 JMX Exporter 的 jar 包，程式內讀取 JVM 執行時狀態資料，轉換為 Prometheus metrics 格式，並暴露埠讓 Prometheus 採集。

> 官方不建議使用 `啟動獨立程式` 方式，該方式配置複雜且需單獨的程式，程式本身的監控又引發了新的問題。本文以 `JVM 程式內啟動（in-process)`方式為例，在 Rainbond 中使用 JMX Exporter 暴露 JVM 監控指標。

## 在 Rainbond 上使用 JMX Exporter

在Rainbond上對於構建型別不同的元件有不同的處理方式，如下

**透過原始碼構建的Java應用**

自V5.3版本後透過 Rainbond 原始碼構建的 JAVA 應用，預設都會將 `JMX Exporter` 打包，使用者使用時只需新增環境變數開啟即可。

1. 為 JAVA 服務元件新增一個指定的環境變數 `ES_ENABLE_JMX_EXPORTER = true` ，即可開啟 `jmx_exporter`。

2. 在 JAVA 服務元件的埠管理處新增一個 `5556` 埠，這是 jmx_exporter 預設監聽的埠。

**透過映象構建的Java應用**

對於映象或應用市場構建的應用，可以使用初始化型別的外掛實現注入 `jmx_agent`。

往期文章中詳細講解過其實現原理，可以參考：Rainbond透過外掛整合SkyWalking，實現APM即插即用 *Agent外掛實現原理部分*。

* 構建 jmx_exporter 外掛

進入團隊 -> 外掛 -> 新建外掛，建立初始化型別外掛，原始碼地址：https://github.com/goodrain-apps/jmx_exporter.git

![](https://static.goodrain.com/wechat/app-monitor/create_jmx.png)

外掛構建成功後即可使用，為 JAVA 服務元件開通此外掛即可。

* 掛載儲存

為 JAVA 服務元件掛載儲存 `/tmp/agent`，使其可以與外掛共享儲存。

透過共享儲存，初始化外掛將所需的配置檔案以及 `Agent` 放在共享儲存中供主服務使用，實現服務無侵入。

* 新增環境變數

為 JAVA 服務元件新增環境變數 `JAVA_OPTS = -javaagent:/tmp/agent/jmx_prometheus_javaagent-0.16.1.jar=5556:/tmp/agent/prometheus-jmx-config.yaml`

可掛載配置檔案 `/tmp/agent/prometheus-jmx-config.yaml` 替換現有的配置檔案。

* 新增埠

在元件的埠管理處，新增新的埠 `5556`

最後更新元件即可生效。

## 新增應用監控點

應用監控是基於 `rbd-monitor` 實現，當我們新增了監控點後就相當於建立了一個 `servicemonitor`。

進入元件內 -> 監控 -> 業務監控 -> 管理監控點，新增監控點，填寫以下資訊：

* 配置名：自定義

* 收集任務名稱：自定義

* 收集間隔時間：10秒

* 指標路徑：/metrics

* 埠號：選擇 `jmx_exporter` 埠

新增完後更新元件使其生效。

## 新增監控圖表

接下來就可以新增一個監控圖表，來展示 JAVA 服務元件中 JVM 的指標行：

點選業務監控皮膚上方的 **新增圖表**

輸入新的標題，以及對應的查詢條件 `jvm_memory_bytes_used` 後，點選 **查詢**。如果正常返回圖表，則說明查詢條件是正確的。標題的定義儘量清晰明瞭，並在有必要的情況下明確單位。

更多指標可參考 [官方文件](https://github.com/prometheus/jmx_exporter)

![](https://static.goodrain.com/docs/5.3/practices/app-dev/java-exporter/java-exporter-2.png)

## 擴充套件Grafana

可透過`grafana` 展示，以下簡述操作步驟：

1. 獲取 `rbd-monitor` 服務 `CLUSTER IP`。

```shell
$ kubectl get svc -l name=rbd-monitor -n rbd-system

NAME          TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)    AGE
rbd-monitor   ClusterIP   10.43.112.131   <none>        9999/TCP   13d
```

2. 在平臺上新增第三方服務，填寫 `rbd-monitor` 服務的 `CLUSTER IP`。
3. 從開源應用商店安裝 `Grafana`並新增依賴。
4. 進入Grafana，Configuration -> Add Data Source -> URL為 `http://127.0.0.1:9999` ，匯入 *JVM dashboard ID 8878* ，透過Grafana皮膚展示應用監控資訊。

![](https://static.goodrain.com/wechat/app-monitor/grafana-dashboard.png)

## References Link

**jmx_export 外掛Github**  https://github.com/goodrain-apps/jmx_exporter.git

**jmx_export 官方**  https://github.com/prometheus/jmx_exporter.git

**jvm dashboard**  https://grafana.com/grafana/dashboards/8878

## 關於Rainbond

Rainbond 是一個開源的雲原生應用管理平臺，使用簡單，不需要懂容器和Kubernetes，支援管理多個Kubernetes叢集，提供企業級應用的全生命週期管理，功能包括應用開發環境、應用市場、微服務架構、應用持續交付、應用運維、應用級多雲管理等。

? Github：https://github.com/goodrain/rainbond
? 官網：https://www.rainbond.com
? 微信群：請搜尋 Rainbond 並關注微信公眾號進入技術交流群
? 釘釘群：請搜尋釘釘群號 31096419</none>

使用JMX Exporter監控Rainbond上的Java應用

相關文章