You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cockroachdb_dedicated/README.md
+19-16Lines changed: 19 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
# Cockroach Cloud
2
2
3
3
## Overview
4
-
5
-
The Cockroach Cloud integration for Datadog enables data collection and alerting on a subset of CockroachDB metrics available at the [Prometheus endpoint][1], using the Datadog platform.
6
-
4
+
5
+
The CockroachDB Cloud integration for Datadog enables data collection and alerting on a subset of CockroachDB metrics using the Datadog platform.
6
+
7
7
## Setup
8
8
9
9
### Installation
10
10
11
11
To enable Datadog monitoring for a Cockroach Cloud cluster:
12
12
13
-
1. On the cluster's **Monitoring**page, click **Setup**in the **Datadog** panel.
13
+
1. On the cluster's **Monitoring**> [**Tools**page][14].
14
14
15
15
2. Fill in the **API key** and **Datadog Site** fields with the corresponding values.
16
16
- The **API key** is associated with your Datadog organization. If you don't have an API key to use with your Cockroach Cloud cluster, you need to create one. For instructions, see the [Datadog documentation][2].
@@ -22,16 +22,18 @@ To enable Datadog monitoring for a Cockroach Cloud cluster:
22
22
23
23
### Configuration
24
24
25
-
Open your Datadog [Dashboard List][5] and click `CockroachDB Dedicated Overview`. This out of the box dashboard presents metrics on CockroachDB Dedicated Overview.
25
+
Open your Datadog [Dashboard List][5]. There are two out of the box dashboards that present CockroachDB metrics
26
+
- CockroachDB Cloud Serverless (Limited Preview)
27
+
- CockroachDB Cloud Dedicated
26
28
27
-
To create your own Cockroach Cloud dashboard, you can either [clone][6] the default `CockroachDB Dedicated Overview` dashboard and edit the widgets, or [create a new dashboard][7].
29
+
To create your own Cockroach Cloud dashboard, you can either [clone][6] the default `CockroachDB Cloud Dedicated` dashboard and edit the widgets, or [create a new dashboard][7].
28
30
29
-
The [available metrics][8] are drawn directly from the CockroachDB [Prometheus endpoint][1] and are intended for use as building blocks for your own charts.
31
+
The [available metrics][8] are intended for use as building blocks for your own charts.
30
32
31
33
To preview the metrics being collected, you can:
32
34
33
35
- Click on your cluster's entry in the [Infrastructure List][4] to display time-series graphs for each available metric.
34
-
- Use the [Metrics Explorer][9] to search for and view `crdb_dedicated` metrics.
36
+
- Use the [Metrics Explorer][9] to search for and view `crdb_cloud` or `crdb_dedicated` metrics.
35
37
36
38
### Validation
37
39
@@ -48,7 +50,7 @@ Metrics export from CockroachDB can be interrupted in the event of:
48
50
- A stale API key. In this case, the integration status will be `Unhealthy`. To resolve the issue, [update your integration](#update-integration) with a new API key.
49
51
- Transient CockroachDB unavailbility. In this case, the integration status will continue to be `Active`. To resolve the issue, try [deactivating](#deactivate-integration) and reactivating the integration from the **Datadog** panel. If this does not resolve the issue, [contact our support team][10].
50
52
51
-
To monitor the health of metrics export, you can [create a custom Monitor](#monitor-health-of-metrics-export) in Datadog.
53
+
To monitor the health of metrics export, you can create a custom Monitor in Datadog.
52
54
53
55
### Update integration
54
56
@@ -72,31 +74,32 @@ After deactivating an integration, the metrics data will remain in Datadog for a
72
74
73
75
### Metrics
74
76
75
-
See [metadata.csv][13] for a list of metrics provided by this integration.
77
+
-`crdb_cloud` & `crdb_dedicated`[Metrics][13]
76
78
77
79
### Service Checks
78
80
79
-
The CockroachDB Dedicated integration does not include any service checks.
81
+
The Cockroach Cloud integration does not include any service checks.
80
82
81
83
### Events
82
84
83
-
The CockroachDB Dedicated integration does not include any events.
85
+
The Cockroach Cloud integration does not include any events.
Copy file name to clipboardExpand all lines: cockroachdb_dedicated/assets/dashboards/cockroach_cloud_dedicated_overview.json
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
{
2
-
"title": "CockroachDB Dedicated Overview",
3
-
"description": "## CockroachDB Dedicated Overview\n\nThis dashboard provides a high-level view of your CockroachDB Dedicated cluster, including:\nA high-level view of SQL performance & latency.\n- Information about resource consumption to help aid in capacity planning.\n- Ability to drill down to specific nodes (identified by a (node, region) tag pair) within your cluster.",
2
+
"title": "CockroachDB Cloud Dedicated",
3
+
"description": "## CockroachDB Cloud Dedicated Overview\n\nThis dashboard provides a high-level view of your CockroachDB Dedicated cluster, including:\nA high-level view of SQL performance & latency.\n- Information about resource consumption to help aid in capacity planning.\n- Ability to drill down to specific nodes (identified by a (node, region) tag pair) within your cluster.",
0 commit comments