Monitor data of OceanBase Cloud with Prometheus

. Download OBCloud Exporter.

. Deploy OBCloud Exporter.

1. Unzip the OBCloud Exporter installation package, and the installation directory is /opt/obcloud-exporter.

   mkdir /opt/obcloud-exporter
   tar -zxvf Obcloud_Exporter.tar.gz -C /opt/obcloud-exporter --strip-components=1
   

   The directory contains the following files:

   • Dockerfile: Docker container build file.
   • muticloud_metric_config.yaml: Metric configuration file, which does not require modification by default.
   • application.yaml: Collection configuration file.
   • obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar: OBCloud Exporter program.
   • readme.md: Project instructions.

2. Edit the configuration file application.yaml.

   # Monitoring Name
   obcloud_monitor:
     # Credentials
     credential:
       access_key_id: xxx
       access_key_secret: xx
       # Endpoint
       end_point: xxx
       # Whether to periodically refresh metrics, default is false
       metric_meta_auto_refresh: false
     instances:
         # Instance ID
       - instance_id: xxx
         # Query tenant under specified cluster, tenant_id needs to be configured
         tenant_id: xxx
         # Instance type, cluster for cluster instance, tenant for tenant instance
         instance_type: cluster
         # Metrics
         metrics: 
   

   • access_key_id、access_key_secret: Authentication information, obtained by accessing My Account > AccessKey. For details, refer to Manage AccessKey.

   • end_point: Refer to Service access point.

   • metric_meta_auto_refresh: Whether to periodically refresh metrics, the default is false.

   • instances: Monitoring instances, including multiple cluster/tenant instances, entered with a hyphen (-).

   • instance_id: Instance ID.

     Note

     Using tenant ID under the cluster instance is not supported.

   • instance_type: Filled in according to the instance type, "cluster" for cluster instance, "tenant" for tenant instance.

   • tenant_id: To query tenants under a specified cluster, tenant_id needs to be configured.

   • metrics: Metric information. If it is left blank, it indicates that all metrics are collected. When specific metrics need to be collected, the format is as follows:

     instances:
       -instance_id: xxx
         tenant_id: xxx
         instance_type: cluster
         metrics: 
           - sql_all_rt
           - sql_delete_rt
     

     Note

     Collecting too many metrics may affect the collection speed. Under appropriate circumstances, metrics can be split into multiple exporters.

. Run OBCloud Exporter through Java.

java -jar /opt/obcloud-exporter/obcloud-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar

Verify the deployment result through the browser. Access Port 9400 of the corresponding IP address, and confirm whether monitoring data is obtained.

. Download Prometheus, find the required version of Prometheus installation package on the official website, and download it. Here, V2.50.1 of the linux version is used as an example.

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

. Deploy Prometheus.

1. Unzip and install Prometheus, and the installation directory is /opt/prometheus.

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

2. Transfer the configuration file prometheus.yml to the working directory and edit it as needed.

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

   Modify the parameters as follows:

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

3. Create a Prometheus service file and related data storage directory.

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

   Fill in the following content and save it.

   Note

   User and Group parameters are optional. To set user and group, refer to the step below.

   [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. (Optional) Set user and group. If the user/group is already configured in the previous step, you can skip this step.

   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
   

. Start the Prometheus service.

# Load the new systemd configuration
sudo systemctl daemon-reload

# Start the Prometheus service
sudo systemctl start prometheus

# Enable auto-start on boot
sudo systemctl enable prometheus

# Check the service status
sudo systemctl status prometheus

. Confirm if Prometheus has started successfully.

sudo netstat -ntlp | grep 9090