diff --git a/content/integrate/datadog-with-redis-cloud/_index.md b/content/integrate/datadog-with-redis-cloud/_index.md index e70660827a..0d6c402afa 100644 --- a/content/integrate/datadog-with-redis-cloud/_index.md +++ b/content/integrate/datadog-with-redis-cloud/_index.md @@ -18,6 +18,8 @@ weight: 7 --- +Redis Cloud Pro accounts can also connect Datadog with the [native integration]({{< relref "/integrate/datadog-with-redis-cloud/native" >}}), which pushes metrics directly from the Redis Cloud console with no agent to deploy or maintain. + [Datadog](https://www.datadoghq.com/) is used by organizations of all sizes and across a wide range of industries to enable digital transformation and cloud migration, drive collaboration among development, operations, security and business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and diff --git a/content/integrate/datadog-with-redis-cloud/native.md b/content/integrate/datadog-with-redis-cloud/native.md new file mode 100644 index 0000000000..8787ac9b73 --- /dev/null +++ b/content/integrate/datadog-with-redis-cloud/native.md @@ -0,0 +1,163 @@ +--- +LinkTitle: Native integration +Title: Native Datadog integration +alwaysopen: false +categories: +- docs +- integrate +- rc +description: Push Redis Cloud metrics directly to Datadog with the native, API-based integration, configured from the Redis Cloud console. +group: observability +weight: 10 +--- + +The native Datadog integration pushes Redis Cloud metrics directly to your Datadog account over an API. You don't need a Datadog Agent, VPC peering, or any network configuration. Redis Cloud sends account-level metrics for all subscriptions and databases in your account, and provides a prebuilt dashboard. + +{{< note >}} +The native Datadog integration is available on Redis Cloud Pro only. On Essentials plans, use the [agent-based Datadog integration]({{< relref "/integrate/datadog-with-redis-cloud" >}}) instead. +{{< /note >}} + +## How the native integration works + +- Redis Cloud pushes metrics to Datadog over an API, so there's no agent, VPC peering, or firewall configuration to manage. +- You configure and manage the integration entirely from the Redis Cloud console. Setup takes about two minutes. +- Metrics are account-level: they cover every subscription and database in your account, with automatic discovery of new subscriptions and databases. +- Metrics appear in Datadog within about 30 seconds of activation. +- A prebuilt dashboard is available in Datadog when you activate the integration. +- The API key you provide is encrypted at rest and used only to push metrics. Redis Cloud never reads from or modifies your Datadog account. + +### Native compared to agent-based + +| | Agent-based | Native | +|---|---|---| +| Setup | Manual, per cluster | From the console, account-level | +| Maintenance | Ongoing (reconfigure after redeployments) | None | +| Data scope | Cluster-level only | Account-level, with auto-discovery of subscriptions and databases | +| Infrastructure | A Datadog Agent per cluster | None | + +The [agent-based integration]({{< relref "/integrate/datadog-with-redis-cloud" >}}) remains available for Essentials plans and for Pro accounts that haven't migrated yet. + +## Prerequisites + +- An active Redis Cloud Pro subscription. +- An active Datadog account. +- Permission to create and manage Datadog API keys. + +## Create a Datadog API key + +In Datadog, go to **Organization Settings > API Keys > New Key**. Copy the key — you need it during setup. + +## Set up the integration + +1. Sign in to the [Redis Cloud console](https://cloud.redis.io). +1. Select **Account**, then open the **Integrations** tab. +1. On the **Datadog** card (its status is **Not connected**), select **Configure**. +1. Enter your Datadog API key and select your Datadog region, such as **US-1** or **EU-1**. +1. Select **Connect**. + +The Datadog integration appears on the **Account > Integrations** page: + +{{< image filename="/images/rc/datadog-native-integrations-page.png" alt="The Datadog integration card on the Account Integrations page in the Redis Cloud console" >}} + +In the **Datadog integration** dialog, enter your API key, select your API region, and select **Connect**: + +{{< image filename="/images/rc/datadog-native-configure.png" alt="The Datadog integration dialog with fields for the Datadog API key and API region" >}} + +Redis Cloud validates the key and activates the integration. When validation succeeds, the Datadog card shows a green **Connected** badge. + +{{< note >}} +Make sure the region you select matches your Datadog account: + +- `app.datadoghq.com` → **US-1** +- `app.datadoghq.eu` → **EU-1** +{{< /note >}} + +## Verify the connection + +The Datadog card shows a real-time status indicator: + +- **Connected** — metrics are being pushed successfully. +- **Not connected** — the integration hasn't been activated. +- **Connection error** — a push failure was detected. + +To verify the end-to-end flow, select **Test connection**. Redis Cloud sends a test metric and updates the status automatically. + +{{< image filename="/images/rc/datadog-native-connected.png" alt="The Datadog card showing a green Connected badge and a Manage button" >}} + +## Verify metrics in Datadog + +Metrics begin appearing in Datadog within about 30 seconds. All Redis Cloud metrics use the `rdse2.` prefix. + +To confirm that metrics are arriving: + +1. In Datadog, go to **Metrics > Explorer**. +1. Search for `rdse2.db_config`. + +If the metric returns data, metrics are reaching Datadog. If it doesn't, see [Troubleshoot](#troubleshoot). + +To scope the metrics you view, use the **Subscription** and **Database** filters in the Redis Cloud dashboard. + +## Built-in dashboard + +A prebuilt Redis Cloud dashboard is available in Datadog after you activate the integration. It covers key database metrics, including performance, memory utilization, latency, operations, connections, and cache efficiency. A link to the dashboard is available from the integration settings. + +{{< image filename="/images/rc/datadog-native-dashboard.png" alt="The prebuilt Redis Cloud Database dashboard in Datadog" >}} + +If the dashboard isn't available yet, import it manually: in Datadog, go to **Dashboards > New Dashboard > Import dashboard JSON**, then select the dashboard JSON file. + +## Metrics reference + +All metrics use the `rdse2.` prefix. The following table lists a subset of the available metrics. + +| Metric | Description | +|---|---| +| `rdse2.db_config` | Database availability (1 = up, 0 = down) | +| `rdse2.redis_server_used_memory` | Database memory usage | +| `rdse2.db_memory_limit_bytes` | Configured memory limit | +| `rdse2.redis_server_db_keys` | Number of keys in the database | +| `rdse2.endpoint_read_requests` | Total read commands received by the proxy endpoint | +| `rdse2.endpoint_write_requests` | Total write commands received by the proxy endpoint | +| `rdse2.endpoint_other_requests` | Total non-read/write commands received by the proxy endpoint | +| `rdse2.endpoint_read_requests_latency_histogram_sum` | Cumulative sum of read request latency observations (µs) | +| `rdse2.endpoint_read_requests_latency_histogram_count` | Cumulative count of read request latency observations | +| `rdse2.endpoint_write_requests_latency_histogram_sum` | Cumulative sum of write request latency observations (µs) | +| `rdse2.endpoint_write_requests_latency_histogram_count` | Cumulative count of write request latency observations | +| `rdse2.endpoint_other_requests_latency_histogram_sum` | Cumulative sum of other request latency observations (µs) | +| `rdse2.endpoint_other_requests_latency_histogram_count` | Cumulative count of other request latency observations | +| `rdse2.redis_server_connected_clients` | Number of client connections currently open to this shard | +| `rdse2.redis_server_keyspace_read_hits` | Cumulative successful read-command key lookups (cache hits) | +| `rdse2.redis_server_keyspace_read_misses` | Cumulative read-command key lookups that missed | +| `rdse2.redis_server_keyspace_write_hits` | Cumulative successful write-command key lookups | +| `rdse2.redis_server_keyspace_write_misses` | Cumulative write-command key lookups that missed | +| `rdse2.node_memory_MemFree_bytes` | Free memory on the host node, in bytes | + +## Migrate from the agent-based integration + +If you currently use the agent-based integration, the console provides a guided migration flow. You can enable the native push integration without downtime, then disable the legacy agent afterward. + +To avoid a gap in observability, complete the migration and verify that metrics are arriving in Datadog before you disable the Datadog Agent. Data collected by the legacy agent remains available in its existing dashboard. + +## Manage the integration + +1. Sign in to the [Redis Cloud console](https://cloud.redis.io). +1. Select **Account**, open the **Integrations** tab, and select **Manage** on the Datadog card. + +From there, you can: + +- Replace the API key. +- Change the Datadog region. +- Test the connection. +- Disable the integration. + +## Troubleshoot + +### The connection test fails + +- Verify that the Datadog API key is correct. +- Make sure the Datadog region you selected matches your account. +- Confirm that the API key is active and has the required permissions. + +### No metrics appear after a few minutes + +- Confirm that the integration status is **Connected** in the Redis Cloud console. +- In Datadog, go to **Metrics > Explorer** and search for `rdse2.db_config`. If the metric exists, data is reaching Datadog. If not, recheck the integration configuration and API key. diff --git a/content/operate/rc/accounts/account-settings.md b/content/operate/rc/accounts/account-settings.md index 510acc6837..6c035a89f0 100644 --- a/content/operate/rc/accounts/account-settings.md +++ b/content/operate/rc/accounts/account-settings.md @@ -86,6 +86,7 @@ Select **Save changes** to save your changes or **Discard changes** to revert th The **Integrations** tab includes settings that help you manage integrations of your Redis Cloud account with other services. For more details, see: +- [Native Datadog integration]({{< relref "/integrate/datadog-with-redis-cloud/native" >}}) (Redis Cloud Pro) - [Use the Redis Sink Confluent Connector]({{< relref "/integrate/confluent-with-redis-cloud/" >}}) - [Prometheus and Grafana with Redis Cloud]({{< relref "/integrate/prometheus-with-redis-cloud/" >}}) diff --git a/static/images/rc/datadog-native-configure.png b/static/images/rc/datadog-native-configure.png new file mode 100644 index 0000000000..5116d41aac Binary files /dev/null and b/static/images/rc/datadog-native-configure.png differ diff --git a/static/images/rc/datadog-native-connected.png b/static/images/rc/datadog-native-connected.png new file mode 100644 index 0000000000..c49f02ea72 Binary files /dev/null and b/static/images/rc/datadog-native-connected.png differ diff --git a/static/images/rc/datadog-native-dashboard.png b/static/images/rc/datadog-native-dashboard.png new file mode 100644 index 0000000000..67c13986f9 Binary files /dev/null and b/static/images/rc/datadog-native-dashboard.png differ diff --git a/static/images/rc/datadog-native-integrations-page.png b/static/images/rc/datadog-native-integrations-page.png new file mode 100644 index 0000000000..30aa5a3650 Binary files /dev/null and b/static/images/rc/datadog-native-integrations-page.png differ