Skip to content

Commit 60f6b2d

Browse files
aa-joshiestherk15
andauthored
Cockcroach cloud integration update (#2322)
* cockroach cloud : add versioning for initial release * cockroach cloud : add preview dashboard for serverless * Apply suggestions from code review Co-authored-by: Esther Kim <esthercodes2019@gmail.com> * Update cockroachdb_dedicated/assets/dashboards/cockroach_cloud_serverless_overview.json Co-authored-by: Esther Kim <esthercodes2019@gmail.com> * update title in default dashboard for cockroach cloud dedicated --------- Co-authored-by: Esther Kim <esthercodes2019@gmail.com>
1 parent 63d6268 commit 60f6b2d

File tree

6 files changed

+2671
-22
lines changed

6 files changed

+2671
-22
lines changed

cockroachdb_dedicated/CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
# CHANGELOG - CockroachDB Dedicated
22

3+
## 1.0.0
4+
5+
***Added***:
6+
7+
* Versioning existing release.
8+
9+
## 2.0.0
10+
11+
***Added***:
12+
13+
* Limited preview dashboard for serverless.

cockroachdb_dedicated/README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Cockroach Cloud
22

33
## 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+
77
## Setup
88

99
### Installation
1010

1111
To enable Datadog monitoring for a Cockroach Cloud cluster:
1212

13-
1. On the cluster's **Monitoring** page, click **Setup** in the **Datadog** panel.
13+
1. On the cluster's **Monitoring** > [**Tools** page][14].
1414

1515
2. Fill in the **API key** and **Datadog Site** fields with the corresponding values.
1616
- 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:
2222

2323
### Configuration
2424

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
2628

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].
2830

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.
3032

3133
To preview the metrics being collected, you can:
3234

3335
- 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.
3537

3638
### Validation
3739

@@ -48,7 +50,7 @@ Metrics export from CockroachDB can be interrupted in the event of:
4850
- 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.
4951
- 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].
5052

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.
5254

5355
### Update integration
5456

@@ -72,31 +74,32 @@ After deactivating an integration, the metrics data will remain in Datadog for a
7274

7375
### Metrics
7476

75-
See [metadata.csv][13] for a list of metrics provided by this integration.
77+
- `crdb_cloud` & `crdb_dedicated` [Metrics][13]
7678

7779
### Service Checks
7880

79-
The CockroachDB Dedicated integration does not include any service checks.
81+
The Cockroach Cloud integration does not include any service checks.
8082

8183
### Events
8284

83-
The CockroachDB Dedicated integration does not include any events.
85+
The Cockroach Cloud integration does not include any events.
8486

8587
## Support
8688

8789
Need help? Contact [Datadog support][12].
8890

8991

90-
[1]: https://www.cockroachlabs.com/docs/stable/monitoring-and-alerting.html#prometheus-endpoint
92+
[1]: https://www.cockroachlabs.com/docs/cockroachcloud/essential-metrics
9193
[2]: https://docs.datadoghq.com/account_management/api-app-keys/#add-an-api-key-or-client-token
9294
[3]: https://docs.datadoghq.com/getting_started/site/
9395
[4]: https://docs.datadoghq.com/infrastructure/list/
94-
[5]: https://docs.datadoghq.com/dashboards/#dashboard-list
95-
[6]: https://docs.datadoghq.com/dashboards/#clone-dashboard
96+
[5]: https://app.datadoghq.com/dashboard/lists
97+
[6]: https://docs.datadoghq.com/dashboards/configure/#configuration-actions
9698
[7]: https://docs.datadoghq.com/dashboards/#new-dashboard
97-
[8]: https://docs.datadoghq.com/integrations/cockroachdb_dedicated
99+
[8]: https://docs.datadoghq.com/integrations/cockroachdb_dedicated/#data-collected
98100
[9]: https://docs.datadoghq.com/metrics/explorer/
99101
[10]: https://support.cockroachlabs.com/
100102
[11]: https://docs.datadoghq.com/developers/guide/data-collection-resolution-retention/
101103
[12]: https://docs.datadoghq.com/help/
102104
[13]: https://github.com/DataDog/integrations-extras/blob/master/cockroachdb_dedicated/metadata.csv
105+
[14]: https://www.cockroachlabs.com/docs/cockroachcloud/tools-page

cockroachdb_dedicated/assets/dashboards/cockroach_cloud_overview.json renamed to cockroachdb_dedicated/assets/dashboards/cockroach_cloud_dedicated_overview.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
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.",
44
"widgets": [
55
{
66
"id": 8635810201263258,

0 commit comments

Comments
 (0)