Prometheus 是一個託管於 CNCF 的開源系統監控和警報工具包，許多公司和組織都採用了 Prometheus 作為監控告警工具。

[eKuiper](https://ekuiper.org/zh) 的規則是一個持續執行的流式計算任務。規則用於處理無界的資料流，正常情況下，規則啟動後會一直執行，不斷產生執行狀態資料。直到規則被手動停止或出現不可恢復的錯誤後停止。eKuiper 中的規則提供了狀態 API，可獲取規則的執行指標。同時，eKuiper 整合了 Prometheus，可方便地透過後者監控各種狀態指標。

本教程面向已經初步瞭解 eKuiper 的使用者，將介紹規則狀態指標以及如何透過 Prometheus 監控特定的指標。

## 規則狀態指標

使用 eKuiper 建立規則並執行成功後，使用者可以透過 CLI、REST API 或者管理控制檯檢視規則的執行狀態指標。例如，已有規則 rule1，可透過 `curl -X GET "<http:>` 獲取 JSON 格式的規則執行指標，如下所示：

```json
{
  "status": "running",
  "source_demo_0_records_in_total": 265,
  "source_demo_0_records_out_total": 265,
  "source_demo_0_process_latency_us": 0,
  "source_demo_0_buffer_length": 0,
  "source_demo_0_last_invocation": "2022-08-22T17:19:10.979128",
  "source_demo_0_exceptions_total": 0,
  "source_demo_0_last_exception": "",
  "source_demo_0_last_exception_time": 0,
  "op_2_project_0_records_in_total": 265,
  "op_2_project_0_records_out_total": 265,
  "op_2_project_0_process_latency_us": 0,
  "op_2_project_0_buffer_length": 0,
  "op_2_project_0_last_invocation": "2022-08-22T17:19:10.979128",
  "op_2_project_0_exceptions_total": 0,
  "op_2_project_0_last_exception": "",
  "op_2_project_0_last_exception_time": 0,
  "sink_mqtt_0_0_records_in_total": 265,
  "sink_mqtt_0_0_records_out_total": 265,
  "sink_mqtt_0_0_process_latency_us": 0,
  "sink_mqtt_0_0_buffer_length": 0,
  "sink_mqtt_0_0_last_invocation": "2022-08-22T17:19:10.979128",
  "sink_mqtt_0_0_exceptions_total": 0,
  "sink_mqtt_0_0_last_exception": "",
  "sink_mqtt_0_0_last_exception_time": 0
}
```

執行指標主要包括兩個部分，一部分是 status，用於標示規則是否正常執行，其值可能為 running, stopped manually 等。另一部分為規則每個運算元的執行指標。規則的運算元根據規則的 SQL 生成，每個規則可能會有所不同。在此例中，規則 SQL 為最簡單的 `SELECT * FROM demo, action` 為 MQTT，其生成的運算元為 [source_demo, op_project, sink_mqtt] 3 個。每一種運算元都有相同數目的執行指標，與運算元名字合起來構成一條指標。例如，運算元 source_demo_0 的輸入數量 records_in_total 的指標為 source_demo_0_records_in_total。

### 執行指標

每個運算元的執行指標是相同的，主要有以下幾種：

- records_in_total：讀入的訊息總量，表示規則啟動後處理了多少條訊息。
- records_out_total：輸出的訊息總量，表示運算元**正確**處理的訊息數量。
- process_latency_us：最近一次處理的延時，單位為微妙。該值為瞬時值，可瞭解運算元的處理效能。整體規則的延時一般由延時最大的運算元決定。
- buffer_length：運算元緩衝區長度。由於運算元之間計算速度會有差異，各個運算元之間都有緩衝佇列。緩衝區長度較大的話說明運算元處理較慢，趕不上上游處理速度。
- last_invocation：運算元的最後一次執行的時間。
- exceptions_total：異常總量。運算元執行中產生的非不可恢復的錯誤，例如連線中斷，資料格式錯誤等均計入異常，而不會中斷規則。

在 1.6.1 版本以後，我們又新增了兩個異常相關指標，方便異常的除錯處理。

- last_exception：最近一次的異常的錯誤資訊。
- last_exception_time：最近一次異常的發生時間。

這些執行指標中的數值型別指標均可使用 Prometheus 進行監控。下一節我們將描述如何配置 eKuiper 中的 Prometheus 服務。

## 配置 eKuiper 的 Prometheus 服務

eKuiper 中自帶 Prometheus 服務，但是預設為關閉狀態。使用者可修改 etc/kuiper.yaml 中的配置開啟該服務。其中，prometheus 為布林值，修改為 true 可開啟服務；prometheusPort 配置服務的訪問埠。

```yaml
  prometheus: true
  prometheusPort: 20499
```

若使用 Docker 啟動 eKuiper，也可透過配置環境變數啟用服務。

```routeros
docker run -p 9081:9081 -d --name ekuiper MQTT_SOURCE__DEFAULT__SERVER="$MQTT_BROKER_ADDRESS" KUIPER__BASIC__PROMETHEUS=true lfedge/ekuiper:$tag
```

在啟動的日誌中，可以看到服務啟動的相關資訊，例如:

```pgsql
time="2022-08-22 17:16:50" level=info msg="Serving prometheus metrics on port <http:> file="server/prome_init.go:60"
Serving prometheus metrics on port <http:>
```

點選提示中的地址 `http://localhost:20499/metrics` ，可檢視到 Prometheus 中搜集到的 eKuiper 的原始指標資訊。eKuiper 有規則正常執行之後，可以在頁面中搜尋到類似 kuiper_sink_records_in_total 等的指標。使用者可以配置 Prometheus 接入 eKuiper，進行更豐富的展示。

## 使用 Prometheus 檢視狀態

上文我們已經實現了將 eKuiper 狀態輸出為 Prometheus 指標的功能，接下來我們可以配置 Prometheus 接入這一部分指標，並完成初步的監控。

### 安裝和配置

到 [Prometheus 官方網站](https://prometheus.io/download/) 下載所需要的系統版本然後解壓。

修改配置檔案，使其監控 eKuiper。開啟 prometheus.yml，修改 scrape_configs 部分，如下所示：

```nestedtext
global:
  scrape_interval:     15s
  evaluation_interval: 15s

rule_files:
  # - "first.rules"
  # - "second.rules"

scrape_configs:
  - job_name: ekuiper
    static_configs:
      - targets: ['localhost:20499']
```

此處定義了監控任務名為 eKuiper, targets 指向上一節啟動的服務的地址。配置完成後，啟動 Prometheus 。

```jboss-cli
./prometheus --config.file=prometheus.yml
```

啟動成功後，開啟 `http://localhost:9090/` 可進入管理控制檯。

### 簡單監控

監控所有規則的 sink 接收到的訊息數目變化。可以在如圖的搜尋框中輸入需要監控的指標名稱，點選 Execute 即可生成監控表。選擇 Graph 可切換為折線圖等展示方式。

點選 Add Panel，透過同樣的配置方式，可監控更多的指標。

## 總結

本文介紹了 eKuiper 中的規則狀態指標以及如何使用 Prometheus 簡單地監控這些狀態指標。使用者可以基於此進一步探索 Prometheus 的更多高階功能，更好地實現 eKuiper 的運維。

>版權宣告： 本文為 EMQ 原創，轉載請註明出處。
>
>原文連結：[https://www.emqx.com/zh/blog/use-prometheus-to-monitor-ekuiper-rules-status](https://www.emqx.com/zh/blog/use-prometheus-to-monitor-ekuiper-rules-status)</http:></http:></http:>

使用 Prometheus 監控 eKuiper 規則執行狀態

相關文章