Integrate TiDB Cloud with Prometheus and Grafana
TiDB Cloud provides a Prometheus API endpoint. If you have a Prometheus service, you can monitor key metrics of TiDB Cloud from the endpoint easily.
This document describes how to configure your Prometheus service to read key metrics from the TiDB Cloud endpoint and how to view the metrics using Grafana.
To integrate TiDB Cloud with Prometheus, you must have a self-hosted or managed Prometheus service.
To edit third-party integration settings of TiDB Cloud, you must have the
Organization Owneraccess to your organization or
Project Memberaccess to the target project in TiDB Cloud.
You cannot use the Prometheus and Grafana integration in TiDB Serverless clusters.
Prometheus and Grafana integrations are not available when the cluster status is CREATING, RESTORING, PAUSED, or RESUMING.
Step 1. Get a scrape_config file for Prometheus
Before configuring your Prometheus service to read metrics of TiDB Cloud, you need to generate a scrape_config YAML file in TiDB Cloud first. The scrape_config file contains a unique bearer token that allows the Prometheus service to monitor any database clusters in the current project.
To get the scrape_config file for Prometheus, do the following:
Log in to the TiDB Cloud console.
In the left navigation pane of the Clusters page, do one of the following:
- If you have multiple projects, switch to the target project, and then click Admin > Integrations.
- If you only have one project, click Admin > Integrations.
Click Integration to Prometheus.
Click Add File to generate and show the scrape_config file for the current project.
Make a copy of the scrape_config file content for later use.
Step 2. Integrate with Prometheus
In the monitoring directory specified by your Prometheus service, locate the Prometheus configuration file.
In the Prometheus configuration file, locate the
scrape_configssection, and then copy the scrape_config file content obtained from TiDB Cloud to the section.
In your Prometheus service, check Status > Targets to confirm that the new scrape_config file has been read. If not, you might need to restart the Prometheus service.
Step 3. Use Grafana GUI dashboards to visualize the metrics
After your Prometheus service is reading metrics from TiDB Cloud, you can use Grafana GUI dashboards to visualize the metrics as follows:
- Download the Grafana dashboard JSON of TiDB Cloud here.
- Import this JSON to your own Grafana GUI to visualize the metrics.
- (Optional) Customize the dashboard as needed by adding or removing panels, changing data sources, and modifying display options.
For more information about how to use Grafana, see Grafana documentation.
Best practice of rotating scrape_config
To improve data security, it is a general best practice to periodically rotate scrape_config file bearer tokens.
- Follow Step 1 to create a new scrape_config file for Prometheus.
- Add the content of the new file to your Prometheus configuration file.
- Once you have confirmed that your Prometheus service is still able to read from TiDB Cloud, remove the content of the old scrape_config file from your Prometheus configuration file.
- On the Integration page of your project, delete the corresponding old scrape_config file to block anyone else from using it to read from the TiDB Cloud Prometheus endpoint.
Metrics available to Prometheus
Prometheus tracks the following metric data for your TiDB clusters.
|Metric name||Metric type||Labels||Description|
|The total number of statements executed|
|The total number of execution errors|
|Current number of connections in your TiDB server|
|The duration histogram of statements|
|tidbcloud_changefeed_latency||gauge||changefeed_id||The data replication latency between the upstream and the downstream of a changefeed|
|tidbcloud_changefeed_replica_rows||gauge||changefeed_id||The number of replicated rows that a changefeed writes to the downstream per second|
|The disk usage bytes of TiKV/TiFlash nodes|
|The disk capacity bytes of TiKV/TiFlash nodes|
|The CPU usage of TiDB/TiKV/TiFlash nodes|
|The CPU limit cores of TiDB/TiKV/TiFlash nodes|
|The used memory bytes of TiDB/TiKV/TiFlash nodes|
|The memory capacity bytes of TiDB/TiKV/TiFlash nodes|
Why does the same metric have different values on Grafana and the TiDB Cloud console at the same time?
The aggregation calculation logic is different between Grafana and TiDB Cloud, so the displayed aggregated values might differ. You can adjust the
mini stepconfiguration in Grafana to get more fine-grained metric values.