Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions cockroachdb_dedicated/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# CHANGELOG - CockroachDB Dedicated

## 1.0.0

***Added***:

* Versioning existing release.

## 2.0.0

***Added***:

* Limited preview dashboard for serverless.
35 changes: 19 additions & 16 deletions cockroachdb_dedicated/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Cockroach Cloud

## Overview
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.

The CockroachDB Cloud integration for Datadog enables data collection and alerting on a subset of CockroachDB metrics using the Datadog platform.

## Setup

### Installation

To enable Datadog monitoring for a Cockroach Cloud cluster:

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

2. Fill in the **API key** and **Datadog Site** fields with the corresponding values.
- 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].
Expand All @@ -22,16 +22,18 @@ To enable Datadog monitoring for a Cockroach Cloud cluster:

### Configuration

Open your Datadog [Dashboard List][5] and click `CockroachDB Dedicated Overview`. This out of the box dashboard presents metrics on CockroachDB Dedicated Overview.
Open your Datadog [Dashboard List][5]. There are two out of the box dashboards that present CockroachDB metrics
- CockroachDB Cloud Serverless (Limited Preview)
- CockroachDB Cloud Dedicated

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

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.
The [available metrics][8] are intended for use as building blocks for your own charts.

To preview the metrics being collected, you can:

- Click on your cluster's entry in the [Infrastructure List][4] to display time-series graphs for each available metric.
- Use the [Metrics Explorer][9] to search for and view `crdb_dedicated` metrics.
- Use the [Metrics Explorer][9] to search for and view `crdb_cloud` or `crdb_dedicated` metrics.

### Validation

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

To monitor the health of metrics export, you can [create a custom Monitor](#monitor-health-of-metrics-export) in Datadog.
To monitor the health of metrics export, you can create a custom Monitor in Datadog.

### Update integration

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

### Metrics

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

### Service Checks

The CockroachDB Dedicated integration does not include any service checks.
The Cockroach Cloud integration does not include any service checks.

### Events

The CockroachDB Dedicated integration does not include any events.
The Cockroach Cloud integration does not include any events.

## Support

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


[1]: https://www.cockroachlabs.com/docs/stable/monitoring-and-alerting.html#prometheus-endpoint
[1]: https://www.cockroachlabs.com/docs/cockroachcloud/essential-metrics
[2]: https://docs.datadoghq.com/account_management/api-app-keys/#add-an-api-key-or-client-token
[3]: https://docs.datadoghq.com/getting_started/site/
[4]: https://docs.datadoghq.com/infrastructure/list/
[5]: https://docs.datadoghq.com/dashboards/#dashboard-list
[6]: https://docs.datadoghq.com/dashboards/#clone-dashboard
[5]: https://app.datadoghq.com/dashboard/lists
[6]: https://docs.datadoghq.com/dashboards/configure/#configuration-actions
[7]: https://docs.datadoghq.com/dashboards/#new-dashboard
[8]: https://docs.datadoghq.com/integrations/cockroachdb_dedicated
[8]: https://docs.datadoghq.com/integrations/cockroachdb_dedicated/#data-collected
[9]: https://docs.datadoghq.com/metrics/explorer/
[10]: https://support.cockroachlabs.com/
[11]: https://docs.datadoghq.com/developers/guide/data-collection-resolution-retention/
[12]: https://docs.datadoghq.com/help/
[13]: https://github.com/DataDog/integrations-extras/blob/master/cockroachdb_dedicated/metadata.csv
[14]: https://www.cockroachlabs.com/docs/cockroachcloud/tools-page
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "CockroachDB Dedicated Overview",
"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.",
"title": "CockroachDB Cloud Dedicated ",
"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.",
"widgets": [
{
"id": 8635810201263258,
Expand Down
Loading