Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 4.66 KB

monitor-datadog-integration.md

File metadata and controls

62 lines (42 loc) · 4.66 KB
title summary
Datadog Integration (Third-Party Monitoring Service)
Learn how to monitor your TiDB cluster with the Datadog integration.

Datadog Integration

You can configure TiDB Cloud to send metric data about your TiDB clusters to Datadog. After that, you can view these metrics in your Datadog dashboards directly.

Prerequisites

  • To integrate TiDB Cloud with Datadog, you must have a Datadog account and a Datadog API key. Datadog grants you an API key when you first create a Datadog account.

    If you do not have a Datadog account, sign up at https://app.datadoghq.com/signup.

  • To edit third-party integration settings of TiDB Cloud, you must have the Organization Owner access to your organization or Project Member access to the target project in TiDB Cloud.

Limitation

You cannot use the Datadog integration in Developer Tier clusters.

Steps

Step 1. Integrate with your Datadog API Key

  1. On the TiDB Cloud console, choose a target project for Datadog integration, and then click the Project Settings tab.

  2. In the left pane, click Integrations.

  3. Click Integration to Datadog.

  4. Enter your API key of Datadog and choose the site of Datadog.

  5. Click Test Integration.

    • If the test successes, the Confirm button is displayed.
    • If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the integration.

  6. Click Confirm to complete the integration.

Step 2. Install TiDB Cloud Integration in Datadog

  1. Log in to Datadog.
  2. Go to the TiDB Cloud Integration page (https://app.datadoghq.com/account/settings#integrations/tidb-cloud) in Datadog.
  3. In the Configuration tab, click Install Integration. The TiDBCloud Cluster Overview dashboard is displayed in your Dashboard List.

Pre-built dashboard

Click the Dashboard link in the Datadog card of the integrations. You can see the pre-built dashboard of your TiDB clusters.

Metrics available to Datadog

Datadog tracks the following metric data for your TiDB clusters.

Metric name Metric type Labels Description
tidb_cloud.db_queries_total count sql_type: Select|Insert|...
cluster_name: <cluster name>
instance: tidb-0|tidb-1…
component: tidb		 The total number of statements executed
tidb_cloud.db_failed_queries_total count type: planner:xxx|executor:2345|...
cluster_name: <cluster name>
instance: tidb-0|tidb-1…
component: tidb		 The total number of execution errors
tidb_cloud.db_connections gauge cluster_name: <cluster name>
instance: tidb-0|tidb-1…
component: tidb		 Current number of connections in your TiDB server
tidb_cloud.db_query_duration_seconds histogram sql_type: Select|Insert|...
cluster_name: <cluster name>
instance: tidb-0|tidb-1…
component: tidb		 The duration histogram of statements
tidb_cloud.node_storage_used_bytes gauge cluster_name: <cluster name>
instance: tikv-0|tikv-1…|tiflash-0|tiflash-1…
component: tikv|tiflash		 The disk usage bytes of TiKV/TiFlash nodes
tidb_cloud.node_storage_capacity_bytes gauge cluster_name: <cluster name>
instance: tikv-0|tikv-1…|tiflash-0|tiflash-1…
component: tikv|tiflash		 The disk capacity bytes of TiKV/TiFlash nodes
tidb_cloud.node_cpu_seconds_total count cluster_name: <cluster name>
instance: tidb-0|tidb-1…|tikv-0…|tiflash-0…
component: tidb|tikv|tiflash		 The CPU usage of TiDB/TiKV/TiFlash nodes
tidb_cloud.node_cpu_capacity_cores gauge cluster_name: <cluster name>
instance: tidb-0|tidb-1…|tikv-0…|tiflash-0…
component: tidb|tikv|tiflash		 The CPU limit cores of TiDB/TiKV/TiFlash nodes
tidb_cloud.node_memory_used_bytes gauge cluster_name: <cluster name>
instance: tidb-0|tidb-1…|tikv-0…|tiflash-0…
component: tidb|tikv|tiflash		 The used memory bytes of TiDB/TiKV/TiFlash nodes
tidb_cloud.node_memory_capacity_bytes gauge cluster_name: <cluster name>
instance: tidb-0|tidb-1…|tikv-0…|tiflash-0…
component: tidb|tikv|tiflash		 The memory capacity bytes of TiDB/TiKV/TiFlash nodes