Skip to main content

Export metrics

This article describes how to use metrics API to export metrics from a RisingWave Cloud cluster to various monitoring systems like Prometheus, DataDog, and InfluxDB. The metrics include all major components such as etcd, frontend, compute, compactor, and meta.

Step 1: Generate API key

Generate the API key ID and API key secret in the Cloud Portal. See Generate an API key for details.

Step 2: Get Cloud_HOST

Get the corresponding CLOUD_HOST for your region and Cloud provider from the table below:

Region/CloudProviderCLOUD_HOST
useast2/awscanary-useast2-mgmt.risingwave.cloud
us-east-1/awsprod-aws-usea1-mgmt.risingwave.cloud
us-west-2/awsprod-aws-uswe2-mgmt.risingwave.cloud
eu-west-2/awsprod-aws-euwe2-mgmt.risingwave.cloud
eu-north-1/awsprod-aws-euno1-mgmt.risingwave.cloud
us-central1/gcpprod-gcp-usce1-mgmt.risingwave.cloud
europe-west3/gcpprod-gcp-euwe3-mgmt.risingwave.cloud

Step 3: Configure monitoring systems

Choose one of the following methods to configure monitoring systems.

note

The metrics are formatted according to Prometheus standards. If your monitoring collection mode is compatible with the Prometheus format, refer to the Prometheus section below to configure the collection.

To import the metrics to Prometheus, edit the scrape_configs section in the prometheus.yaml file as follows:

scrape_configs:
- job_name: risingwave-remote
static_configs:
- targets:
- {CLOUD_HOST}
metrics_path: /api/v1/tenant/{CLUSTER_ID}/metrics
basic_auth:
username: {API_KEY}
password: {API_SECRET}
scrape_interval: 60s
scrape_timeout: 60s
scheme: https

Notes

  • Update the Cloud_HOST according to the region and Cloud provider of your RisingWave cluster.

  • Update the CLUSTER_ID with the specific cluster ID in your RisingWave environment. For example, if your cluster URL is risingwave-cloud.com/cluster/168/us-central1/overview/, replace CLUSTER_ID with the value 168.

Step 4: Set up dashboards

To set up dashboards based on key metrics, see RisingWave open source user-dashboard.