Skip to content

Commit 1c48947

Browse files
slorello89slorello89
authored
Merge pull request #52 from redis-field-engineering/feature/terraform-kickstarters-dynatrace-newrelic
adding terraform kickstarters for dynatrace and newrelic
2 parents 8e3d7f3 + aafc899 commit 1c48947

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+2294
-19
lines changed

‎.gitignore

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,33 @@ logs
1515
playbook/target
1616

1717
.vscode
18+
.tfvars
19+
20+
# Local .terraform directories
21+
**/.terraform/*
22+
23+
# .tfstate files
24+
*.tfstate
25+
*.tfstate.*
26+
27+
# Crash log files
28+
crash.log
29+
crash.*.log
30+
31+
# Exclude all .tfvars files, which are likely to contain sensitive data, such as
32+
# password, private keys, and other secrets. These should not be part of version
33+
# control as they are data points which are potentially sensitive and subject
34+
# to change depending on the environment.
35+
*.tfvars
36+
*.tfvars.json
37+
38+
# Ignore override files as they are usually used to override resources locally and so
39+
# are not checked in
40+
override.tf
41+
override.tf.json
42+
*_override.tf
43+
*_override.tf.json
44+
45+
# Ignore transient lock info files created by terraform apply
46+
.terraform.tfstate.lock.info
47+
.claude

‎datadog_v2/README.adoc

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
:linkattrs:
2+
:project-owner: redis-field-engineering
3+
:project-name: redis-enterprise-observability
4+
5+
= Redis Enterprise Datadog Integration
6+
7+
This directory contains resources for monitoring Redis Enterprise Software and Redis Cloud using Datadog. The integration uses Datadog's OpenMetrics integration to collect Prometheus metrics from Redis Enterprise clusters.
8+
9+
== Table of Contents
10+
11+
* link:#Important-Note[Important Note]
12+
* link:#Requirements[Requirements]
13+
* link:#Installation[Installation]
14+
* link:#Configuration[Configuration]
15+
* link:#Usage[Usage]
16+
* link:#Kickstarter[Kickstarter]
17+
* link:#Support[Support]
18+
* link:#License[License]
19+
20+
== Important Note
21+
22+
[IMPORTANT]
23+
====
24+
The Datadog integration for Redis Enterprise is not included in this repository. It is maintained separately in the official Datadog integrations repository at https://github.com/DataDog/datadog-integrations-extras under the `redis_enterprise_prometheus` integration.
25+
26+
Currently, you will need to use the Field Engineering branch at https://github.com/redis-field-engineering/datadog-integrations-extras/tree/redis_enterprise_prometheus to build and deploy the integration directly, as it is pending merger into the main Datadog repository.
27+
====
28+
29+
== Requirements
30+
31+
To use this integration, you will need:
32+
33+
* A https://docs.redis.com/latest/rs/[Redis Software] deployment or a https://docs.redis.com/latest/rc/[Redis Cloud] account with a https://docs.redis.com/latest/rc/subscriptions/create-flexible-subscription/[Flexible or Annual subscription]
34+
* A https://www.datadoghq.com/[Datadog account] with API access
35+
* A Datadog Agent deployment with the `redis_enterprise_prometheus` integration installed
36+
37+
=== Redis Enterprise Software
38+
39+
To monitor a Redis Enterprise Software deployment, you will need your cluster's FQDN or hostname. The Prometheus endpoint is available on port 8070 at the `/v2` path.
40+
41+
=== Redis Enterprise Cloud
42+
43+
To monitor a Redis Cloud deployment, you will need the https://docs.redis.com/latest/rc/databases/view-edit-database/[private endpoint] for one of the databases associated with your Redis Cloud subscription.
44+
45+
This private endpoint will have the following form:
46+
`redis-12345.internal.c67890.us-central1-1.gcp.cloud.rlrcp.com:121212`.
47+
48+
To get the Prometheus endpoint for your Redis Cloud subscription, drop the section before the first dot (in this case, the "redis-12345"), and specify the Prometheus exporter port 8070:
49+
`internal.c67890.us-central1-1.gcp.cloud.rlrcp.com:8070`
50+
51+
== Installation
52+
53+
=== Building the Integration from Source
54+
55+
Since the integration is not yet available in the main Datadog repository, you'll need to build it from the Field Engineering branch:
56+
57+
1. Clone the Field Engineering fork:
58+
+
59+
[source,bash]
60+
----
61+
git clone https://github.com/redis-field-engineering/datadog-integrations-extras.git
62+
cd datadog-integrations-extras
63+
git checkout redis_enterprise_prometheus
64+
----
65+
66+
2. Navigate to the Redis Enterprise integration directory:
67+
+
68+
[source,bash]
69+
----
70+
cd redis_enterprise_prometheus
71+
----
72+
73+
3. Build the integration wheel:
74+
+
75+
[source,bash]
76+
----
77+
# Install build dependencies
78+
pip install -r requirements-dev.txt
79+
80+
# Build the wheel
81+
python setup.py bdist_wheel
82+
----
83+
84+
4. Install the integration on your Datadog Agent:
85+
+
86+
[source,bash]
87+
----
88+
# Copy the wheel to your Datadog Agent host
89+
# Install using the Datadog Agent's pip
90+
sudo -u dd-agent /opt/datadog-agent/embedded/bin/pip install dist/datadog_redis_enterprise_prometheus-*.whl
91+
----
92+
93+
5. Restart the Datadog Agent:
94+
+
95+
[source,bash]
96+
----
97+
sudo systemctl restart datadog-agent
98+
----
99+
100+
== Configuration
101+
102+
=== Agent Configuration
103+
104+
Create a configuration file for the Redis Enterprise integration at `/etc/datadog-agent/conf.d/redis_enterprise_prometheus.d/conf.yaml`:
105+
106+
[source,yaml]
107+
----
108+
init_config:
109+
110+
instances:
111+
- openmetrics_endpoint: https://your-redis-cluster.example.com:8070/v2
112+
tls_verify: false
113+
type_overrides:
114+
endpoint_client_connections: gauge
115+
----
116+
117+
=== Configuration Options
118+
119+
* `openmetrics_endpoint`: The Redis Enterprise Prometheus metrics endpoint (required)
120+
* `tls_verify`: Set to `false` to skip TLS certificate verification (default: `true`)
121+
* `type_overrides`: Override metric types as needed
122+
123+
=== Network Access Requirements
124+
125+
Ensure your Datadog Agent can reach:
126+
* Redis Enterprise cluster on port 8070 (HTTPS)
127+
* For Redis Cloud, ensure VPC peering or appropriate network connectivity
128+
129+
== Usage
130+
131+
=== Verifying the Integration
132+
133+
1. Check that the integration is loaded:
134+
+
135+
[source,bash]
136+
----
137+
sudo datadog-agent status
138+
----
139+
140+
2. Verify metrics are being collected:
141+
+
142+
[source,bash]
143+
----
144+
sudo datadog-agent check redis_enterprise_prometheus
145+
----
146+
147+
3. In the Datadog UI, search for metrics starting with `redis_enterprise_prometheus.*`
148+
149+
=== Available Metrics
150+
151+
The integration collects Redis Enterprise metrics including:
152+
* Database metrics (connections, operations, memory usage)
153+
* Node metrics (CPU, memory, network)
154+
* Cluster metrics (shard distribution, replication)
155+
* Proxy metrics (throughput, latency)
156+
157+
== Kickstarter
158+
159+
This repository includes a Terraform-based kickstarter to automate the deployment of the Datadog Agent with the Redis Enterprise integration. See the link:kickstarter/README.md[kickstarter README] for detailed instructions on using Terraform to deploy monitoring infrastructure on GCP.
160+
161+
The kickstarter handles:
162+
* VM deployment with Datadog Agent
163+
* Integration installation and configuration
164+
* Network and security configuration
165+
* Automated setup for Redis Enterprise monitoring
166+
167+
== Support
168+
169+
This project is supported by Redis, Inc. on a good faith effort basis. To report bugs, request features, or receive assistance, please https://github.com/{project-owner}/{project-name}/issues[file an issue].
170+
171+
== License
172+
173+
This code in this repository is licensed under the MIT License. Copyright (C) 2025 Redis, Inc.

0 commit comments

Comments
 (0)