ApsaraDB for OceanBase：通過 Prometheus 監控 OceanBase 資料

背景資訊

OBCloud Exporter 是OceanBase 提供的一款資料庫資料處理工具，可通過該工具完成 OceanBase 資料庫的鑒權和資料擷取。再結合本地 Prometheus 工具對資料庫進行相應的監控。

下文通過系統直接部署和通過 docker 部署兩種方式說明相應的工具使用方法。

前提條件

1. 已部署 Java 8 及以上的運行環境。

2. 已完成 Docker 部署。

系統運行 Prometheus 監控 OceanBase 雲資料

1. 下載 OBCloud Exporter。

   說明

   目前 OBCloud Exporter 暫未放開直接下載，可聯絡技術支援人員擷取。

2. 部署 OBCloud Exporter。

   1. 解壓 OBCloud Exporter 安裝包，安裝目錄為 /opt/obcloud-exporter。

      mkdir /opt/obcloud-exporter
      unzip Obcloud_Exporter.zip -d /opt/obcloud-exporter

      解壓後目錄包含如下檔案：

      • Dockerfile：Docker 容器構建檔案。

      • muticloud_metric_config.yaml：指標設定檔，此檔案預設不需要修改。

      • application.yaml：採集設定檔。

      • obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar：OBCloud Exporter 程式。

      • readme.md：專案說明。

   2. 編輯設定檔 application.yaml。

      aliyun_monitor:
        ## 身份憑據
        credential:
          access_key_id: xxx
          access_key_secret: xx
          region_id: ap-southeast-1
          end_point: xxx
        metric_meta_auto_refresh: false
        default_metric:
          - sql_all_rt
          - sql_delete_rt
        ## 執行個體資訊
        instances:
          instance_id: xxx
          tenant_id: xxx
          instance_type: cluster
          metrics: 
            - sql_all_rt
            - sql_delete_rt

      參數說明：

      參數名稱	是否必填	參數描述	樣本值
      access_key_id	是	鑒權資訊，訪問 我的帳號 > AccessKey 擷取，可在對應平台申請。具體操作，請參見，建立AccessKey。	************
      access_key_secret	是	鑒權資訊，訪問 我的帳號 > AccessKey 擷取，可在對應平台申請。具體操作，請參見，建立AccessKey。	************
      region_id	是	地區資訊，請參見 公用雲端服務地區說明。	ap-southeast-1
      end_point	是	終端地址，請參見 公用雲端服務地區說明。	oceanbasepro.ap-southeast-1.aliyuncs.com
      metric_meta_auto_refresh	否	是否定時重新整理 metric 指標，預設為 false。	false
      default_metric	否	預設指標，當沒有配置 instances 指定採集的執行個體和指標時，可通過 default_metric 控制帳號下所有執行個體採集指定的指標。	- sql_all_rt
      instance_id	否	叢集執行個體 ID 或租戶執行個體 ID。可包含多個叢集、租戶執行個體，通過短劃線（-）並列填入。	ob************
      tenant_id	否	查詢叢集下指定租戶，需配置 tenant_id, instance_type=cluster 時可以不配置。 當執行個體為租戶執行個體時，需 instance_id 和 tenant_id 都配置相同的執行個體 ID，並且指定 instance_type 為 tenant。	t************
      instance_type	否	執行個體類型： cluster：叢集主機維度監控指標，並且會自動採集叢集下所有租戶的監控資料。 tenant：租戶資料庫維度指標。	tenant
      metrics	否	指標資訊，預設為採集全部指標。具體指標清單，請參見本文 監控指標清單 章節。 說明 採集指標過多可能會影響採集速度，適當情況下拆分為多個 exporter。	- sql_all_rt

3. 通過 Java 運行 OBCloud Exporter。

   1. 可以通過如下命令，指定設定檔啟動 OBCloud Exporter。

      java -Dconfig=/xx/application.yaml -jar obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar --spring.config.location=/xx/application.properties

      • -Dconfig：（可選）指定監控設定檔啟動。

      • --spring.config.location：（可選）程式預設整合並開啟了 SpringBoot 的 actuator 組件，預設連接埠為 8082，實際使用中也可以自行配置，根據實際配置的地址連接埠進行訪問。預設配置為：

        server.port=-1
        management.server.port=8082
        management.endpoints.web.exposure.include=health,info
        management.endpoint.health.show-details=always

        常見樣本：

        # 預設配置啟動 OBCloud Exporter
        java -jar obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar
        # 指定環境組態變數啟動 OBCloud Exporter
        java -jar obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar --spring.config.location=/xx/application.properties
        # 指定監控設定檔啟動 OBCloud Exporter
        java -Dconfig=/xx/application.yaml -jar obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar
        # 同時指定監控設定檔和環境變數配置啟動 OBCloud Exporter
        java -Dconfig=/xx/application.yaml -jar obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar --spring.config.location=/xx/application.properties

   2. 通過瀏覽器驗證部署結果，訪問對應 IP 位址的 9400 連接埠，確認是否擷取到監控資料。

      說明

      實際使用中，根據實際配置的地址連接埠進行訪問。

4. 下載 Prometheus 軟體，在官網找到所需版本的 Prometheus 安裝包，進行下載，如下以 2.50.1 的 Linux 版本為例。

   wget https://github.com/prometheus/prometheus/releases/download/v2.50.1/prometheus-2.50.1.linux-amd64.tar.gz

5. 部署 Prometheus。

   1. 解壓並安裝 Prometheus 軟體，安裝目錄為 /opt/prometheus。

      mkdir -p /opt/prometheus
      tar -zxvf prometheus-2.50.1.linux-amd64.tar.gz -C /opt/prometheus --strip-components=1

   2. 轉移設定檔 prometheus.yml 到工作目錄，並根據需要進行編輯。

      mv /opt/prometheus/prometheus.yml /usr/local/bin/
      vi /usr/local/bin/prometheus.yml

      修改如下參數：

      global:
        scrape_interval: 30s
        scrape_timeout: 20s
      
      scrape_configs:
        - job_name: "nodes"
          static_configs:
          - targets: ['localhost:9400']

   3. 建立 Prometheus 服務檔案和相關資料存放區目錄。

      mkdir /var/lib/prometheus/
      sudo vim /etc/systemd/system/Prometheus.service

      填寫如下內容並儲存。

      說明

      User（使用者）和 Group（使用者組）參數是可選的，設定方法請參考下一步驟 設定使用者名稱和使用者組。

      [Unit]
      Description=Prometheus
      Wants=network-online.target
      After=network-online.target
      
      [Service]
      User=prometheus
      Group=prometheus
      Restart=on-failure
      ExecStart=/opt/prometheus/prometheus \
            --config.file /usr/local/bin/prometheus.yml \
            --storage.tsdb.path /var/lib/prometheus/
      
      [Install]
      WantedBy=multi-user.target

   4. （可選）設定使用者名稱和使用者組，上一步驟中配置已有的使用者/使用者組或者沒有配置，可忽略此步驟。

      sudo groupadd prometheus
      sudo useradd -r -g prometheus prometheus
      sudo chown -R prometheus:prometheus /opt/prometheus /var/lib/prometheus
      sudo chmod -R 755 /opt/prometheus /var/lib/prometheus

6. 啟動 Prometheus 服務。

   # 載入新的 systemd 配置
   sudo systemctl daemon-reload
   
   # 啟動 Prometheus 服務
   sudo systemctl start prometheus
   
   # 設定開機啟動
   sudo systemctl enable prometheus
   
   # 檢查服務狀態
   sudo systemctl status prometheus

7. 確認 Prometheus 是否啟動成功。

    sudo netstat -ntlp | grep 9090

通過 docker 部署 prometheus 監控 OceanBase 雲資料庫

1. 下載 OBCloud Exporter。

   說明

   目前 OBCloud Exporter 暫未放開直接下載，可聯絡技術支援人員擷取。

2. 部署 OBCloud Exporter。

   1. 解壓 OBCloud Exporter 安裝包，安裝目錄為 /opt/obcloud-exporter。

      mkdir /opt/obcloud-exporter
      unzip Obcloud_Exporter.zip -d /opt/obcloud-exporter

      解壓後目錄包含如下檔案：

      • Dockerfile：Docker 容器構建檔案。

      • muticloud_metric_config.yaml：指標設定檔，此檔案預設不需要修改。

      • application.yaml：採集設定檔。

      • obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar：OBCloud Exporter 程式。

      • readme.md：專案說明。

   2. 編輯設定檔 application.yaml。

      aliyun_monitor:
        ## 身份憑據
        credential:
          access_key_id: xxx
          access_key_secret: xx
          region_id: ap-southeast-1
          end_point: xxx
        metric_meta_auto_refresh: false
        default_metric:
          - sql_all_rt
          - sql_delete_rt
        ## 執行個體資訊
        instances:
          instance_id: xxx
          tenant_id: xxx
          instance_type: cluster
          metrics: 
            - sql_all_rt
            - sql_delete_rt

      參數說明：

      參數名稱	是否必填	參數描述	樣本值
      access_key_id	是	鑒權資訊，訪問 我的帳號 > AccessKey 擷取，可在對應平台申請。具體操作，請參見，建立AccessKey。	************
      access_key_secret	是	鑒權資訊，訪問 我的帳號 > AccessKey 擷取，可在對應平台申請。具體操作，請參見，建立AccessKey。	************
      region_id	是	地區資訊，請參見 公用雲端服務地區說明。	ap-southeast-1
      end_point	是	終端地址，請參見 公用雲端服務地區說明。	oceanbasepro.ap-southeast-1.aliyuncs.com
      metric_meta_auto_refresh	否	是否定時重新整理 metric 指標，預設為 false。	false
      default_metric	否	預設指標，當沒有配置 instances 指定採集的執行個體和指標時，可通過 default_metric 控制帳號下所有執行個體採集指定的指標。	- sql_all_rt
      instance_id	否	叢集執行個體 ID 或租戶執行個體 ID。可包含多個叢集、租戶執行個體，通過短劃線（-）並列填入。	ob************
      tenant_id	否	查詢叢集下指定租戶，需配置 tenant_id, instance_type=cluster 時可以不配置。 當執行個體為租戶執行個體時，需 instance_id 和 tenant_id 都配置相同的執行個體 ID，並且指定 instance_type 為 tenant。	t************
      instance_type	否	執行個體類型： cluster：叢集主機維度監控指標，並且會自動採集叢集下所有租戶的監控資料。 tenant：租戶資料庫維度指標。	tenant
      metrics	否	指標資訊，預設為採集全部指標。具體指標清單，請參見本文 監控指標清單 章節。 說明 採集指標過多可能會影響採集速度，適當情況下拆分為多個 exporter。	- sql_all_rt

3. 通過 Docker 啟動 OBCloud Exporter。

   1. 在/opt/obcloud-exporter目錄下，構建 obcloud-exporter 容器。

      cd /opt/obcloud-exporter
      docker build -t obcloud-exporter:1.0 .

   2. 啟動容器或者映射外部設定檔啟動。

      1. 直接啟動 Docker 容器

         docker run -itd -p9400:9400 --name obcloud-exporter obcloud-exporter:1.0

      2. 通過映射外部設定檔啟動 Docker 容器。

         docker run -itd -p9400:9400 -v /opt/obcloud-exporter/application.yaml:/app/application.yaml --name obcloud-exporter obcloud-exporter:1.0

4. 通過瀏覽器驗證部署結果，訪問對應 IP 位址的 9400 連接埠，確認是否擷取到監控資料。

   說明

   實際使用中，根據實際配置的地址連接埠進行訪問。

5. 建立 Prometheus 設定檔 prometheus.yml。

   vi /usr/local/bin/prometheus.yml

   編輯設定檔內容：

   global:
     scrape_interval: 30s
     evaluation_interval: 30s
   
   scrape_configs:
     - job_name: obcloud-exporter-test
       static_configs:
           # 本機伺服器加連接埠
         - targets: ['obcloud-exporter:9400']
           labels:
             instance: obcloud-exporter

6. 啟動 Prometheus 服務。

    docker run  -d \
      -p 9090:9090 \
      -v /usr/local/bin/prometheus.yml:/etc/prometheus/prometheus.yml  \
      --link obcloud-exporter  \
      --name prometheus \
      prom/prometheus

7. 確認 Prometheus 是否啟動成功。

   sudo netstat -ntlp | grep 9090

通過 Prometheus 查看資料庫監控

通過瀏覽器訪問 Prometheus 服務地址：http://localhost:9090/targets，查看相應的監控資訊。

配置樣本

動態擷取帳號下執行個體

• 採集所有指標

  ## 監控名稱
  monitor:
    ## 身份憑據
    credential:
      access_key_id: xxx
      access_key_secret: xx
      region_id: ap-southeast-1
      ## 終端地址
      end_point: xxx
    metric_meta_auto_refresh: false

• 採集指定指標

  ## 監控名稱
  monitor:
    ## 身份憑據
    credential:
      access_key_id: xxx
      access_key_secret: xx
      region_id: ap-southeast-1
      ## 終端地址
      end_point: xxx
    metric_meta_auto_refresh: false
    ## 預設指標，當沒有配置instances自動擷取執行個體時，可通過 default_metric 指定採集的指標
    default_metric:
      - sql_all_rt
      - sql_delete_rt

採集帳號下指定的叢集

• 採集所有指標，instance_type 值設定為 cluster 時，可同時採集叢集的主機指標和租戶資料庫指標。

  ## 監控名稱
  monitor:
    ## 身份憑據
    credential:
      access_key_id: xxx
      access_key_secret: xx
      region_id: ap-southeast-1
      end_point: xxx
    metric_meta_auto_refresh: false
    instances:
        instance_id: xxx
        instance_type: cluster

• 採集租戶資料庫所有指標，instance_type 值設定為 tenant 時，只採集指定租戶的租戶資料庫指標。

  ## 監控名稱
  monitor:
    ## 身份憑據
    credential:
      access_key_id: xxx
      access_key_secret: xx
      region_id: ap-southeast-1
      end_point: xxx
    metric_meta_auto_refresh: false
    instances:
        instance_id: xxx
        tenant_id: xx
        instance_type: tenant

• 採集指定的指標，可根據實際情況選擇 instance_type。

  ## 監控名稱
  monitor:
    ## 身份憑據
    credential:
      access_key_id: xxx
      access_key_secret: xx
      region_id: ap-southeast-1
      end_point: xxx
    metric_meta_auto_refresh: false
    instances:
        instance_id: xxx
        tenant_id: xxx
        instance_type: tenant
        metrics: 
          - sql_all_rt
          - sql_delete_rt

採集多個帳號

## 監控名稱
aliyun:
  ## 身份憑據
  credential:
    access_key_id: xxx
    access_key_secret: xx
    region_id: ap-southeast-1
    end_point: xxx
  metric_meta_auto_refresh: false
muti:
  ## 身份憑據
  credential:
    access_key_id: xxx
    access_key_secret: xx
    end_point: xxx

監控指標清單

叢集主機

租戶資料庫

效能與 SQL

事務

儲存與緩衝