Skip to content

Commit ffda065

Browse files
Merge pull request #839 from j8-redis/devex_integration_tiles
initial add of observability integration tiles
2 parents 68d8a18 + 20e5a80 commit ffda065

File tree

13 files changed

+515
-0
lines changed

13 files changed

+515
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ package-lock.json
1414
.hugo_build.lock
1515
.vscode/
1616
.DS_Store
17+
.idea
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
LinkTitle: Datadog with Redis Cloud
3+
Title: Datadog with Redis Cloud
4+
alwaysopen: false
5+
categories:
6+
- docs
7+
- integrate
8+
- rs
9+
description: To collect, view, and monitor metrics data from your databases and other
10+
cluster components, you can connect Datadog to your Redis Cloud cluster using the
11+
Redis Datadog Integration.
12+
group: observability
13+
summary: To collect, view, and monitor metrics data from your databases and other
14+
cluster components, you can connect Datadog to your Redis Cloud cluster using the
15+
Redis Datadog Integration.
16+
type: integration
17+
weight: 7
18+
---
19+
20+
21+
[Datadog](https://www.datadoghq.com/) is used by organizations of all sizes and across a wide range of industries to
22+
enable digital transformation and cloud migration, drive collaboration among development, operations, security and
23+
business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and
24+
infrastructure, understand user behavior, and track key business metrics.
25+
26+
The Datadog Integration for Redis Cloud uses the Datadog Integration API to connect to Redis metrics exporters.
27+
The integration is based on Datadog's
28+
[OpenMetrics integration](https://datadoghq.dev/integrations-core/base/openmetrics/) in their core API. This integration
29+
enables Redis Cloud users to export metrics directly to Datadog for analysis, and includes Redis-designed
30+
dashboards for use in monitoring Redis Cloud clusters.
31+
32+
This integration makes it possible to:
33+
- Collect and display metrics not available in the admin console
34+
- Set up automatic alerts for node or cluster events
35+
- Display these metrics alongside data from other systems
36+
37+
{{< image filename="/images/rc/redis-cloud-datadog.png" alt="screenshot of datadog dashboard">}}
38+
## Install Redis' Datadog Integration for Redis Cloud
39+
40+
Installing the Datadog integration is a two-step process. Firstly, the installation must be part of your configuration.
41+
Select 'Integrations' from the menu in the Datadog portal and then enter 'Redis' in the search bar, then select
42+
'Redis Cloud by Redis, Inc.'. Next click 'Install Integration' in the top-right corner of the overview page.
43+
44+
If you have not already created a VPC between the Redis Cloud cluster and the network in which the machine hosting the
45+
Datadog agent lives you should do so now. Please visit [VPC Peering](https://redis.io/docs/latest/operate/rc/security/vpc-peering/)
46+
and follow the instructions for the cloud platform of your choice.
47+
48+
Returning to the Datadog console, open the 'Configure' tab of the integration and follow the instructions for installing
49+
the integration on the local machine. After it has been installed follow the instruction for adding an instance to the
50+
conf.yaml in /etc/datadog-agent/conf.d/redis_cloud.d.
51+
52+
After you have edited the conf.yaml file please restart the service and check its status:
53+
54+
```shell
55+
sudo service datadog-agent restart
56+
```
57+
58+
followed by:
59+
60+
```shell
61+
sudo service datadog-agent status
62+
```
63+
64+
to be certain that the service itself is running and did not encounter any problems. Next, check the output of the
65+
service; in the terminal on the Datadog agent host run the following command:
66+
67+
```shell
68+
tail -f /var/log/datadog/agent.log
69+
```
70+
71+
It will take several minutes for data to reach Datadog. Finally, check the Datadog console by selecting
72+
Infrastructure -> Host Map from the menu and then finding the host that is monitoring the Redis Cloud instance. The host
73+
should be present, and in its list of components there should be a section called 'rdsc', which is the namespace used by
74+
the Redis Cloud integration, although this can take several minutes to appear. It is also possible to verify the metrics
75+
by choosing Metrics -> Explorer from the menu and entering 'rdsc.bdb_up'.
76+
77+
## View metrics
78+
79+
The Redis Cloud Integration for Datadog contains pre-defined dashboards to aid in monitoring your Redis Cloud deployment.
80+
81+
The following dashboards are currently available:
82+
83+
- Overview
84+
- Database
85+
- Network
86+
87+
A number of additional dashboards will be included in the next release (v1.1.0).
88+
89+
## Monitor metrics
90+
91+
See [Observability and monitoring guidance]({{< relref "/integrate/prometheus-with-redis-enterprise/observability/" >}}) for monitoring details.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
LinkTitle: Datadog with Redis Enterprise
3+
Title: Datadog with Redis Enterprise
4+
alwaysopen: false
5+
categories:
6+
- docs
7+
- integrate
8+
- rs
9+
description: To collect, view, and monitor metrics data from your databases and other
10+
cluster components, you can connect Datadog to your Redis Enterprise cluster using
11+
the Redis Datadog Integration.
12+
group: observability
13+
summary: To collect, view, and monitor metrics data from your databases and other
14+
cluster components, you can connect Datadog to your Redis Enterprise cluster using
15+
the Redis Datadog Integration.
16+
type: integration
17+
weight: 7
18+
---
19+
20+
21+
[Datadog](https://www.datadoghq.com/) is used by organizations of all sizes and across a wide range of industries to
22+
enable digital transformation and cloud migration, drive collaboration among development, operations, security and
23+
business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and
24+
infrastructure, understand user behavior, and track key business metrics.
25+
26+
The Datadog Integration for Redis Enterprise uses Datadog's Integration API to connect to Redis metrics exporters.
27+
The integration is based on the Datadog
28+
[OpenMetrics integration](https://datadoghq.dev/integrations-core/base/openmetrics/) in their core API. This integration
29+
enables Redis Enterprise users to export metrics directly to Datadog for analysis, and includes Redis-designed
30+
dashboards for use in monitoring Redis Enterprise clusters.
31+
32+
This integration makes it possible to:
33+
- Collect and display metrics not available in the admin console
34+
- Set up automatic alerts for node or cluster events
35+
- Display these metrics alongside data from other systems
36+
37+
{{< image filename="/images/rc/redis-cloud-datadog.png" >}}
38+
## Install Redis' Datadog Integration for Redis Enterprise
39+
40+
Installing the Datadog integration is a two-step process. Firstly, the installation must be part of your configuration.
41+
Select 'Integrations' from the menu in the Datadog portal and then enter 'Redis' in the search bar, then select
42+
'Redis Enterprise by Redis, Inc.'. Next click 'Install Integration' in the top-right corner of the overview page.
43+
Once it has been installed follow the instructions for adding an instance to the conf.yaml in
44+
/etc/datadog-agent/conf.d/redis_cloud.d.
45+
46+
After you have edited the conf.yaml file please restart the service and check its status:
47+
48+
```shell
49+
sudo service datadog-agent restart
50+
```
51+
52+
followed by:
53+
54+
```shell
55+
sudo service datadog-agent status
56+
```
57+
58+
to be certain that the service itself is running and did not encounter any problems. Next, check the output of the
59+
service; in the terminal on the Datadog agent host run the following command:
60+
61+
```shell
62+
tail -f /var/log/datadog/agent.log
63+
```
64+
65+
It will take several minutes for data to reach Datadog. Finally, check the Datadog console by selecting
66+
Infrastructure -> Host Map from the menu and then finding the host that is monitoring the Redis Enterprise instance. The host
67+
should be present, and in its list of components there should be a section called 'rdse', which is the namespace used by
68+
the Redis Enterprise integration, although this can take several minutes to appear. It is also possible to verify the metrics
69+
by choosing Metrics -> Explorer from the menu and entering 'rdse.bdb_up'.
70+
71+
## View metrics
72+
73+
The Redis Enterprise Integration for Datadog contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment.
74+
75+
The following dashboards are currently available:
76+
77+
- Overview
78+
- Database
79+
- Node
80+
- Shard
81+
- Active-Active
82+
- Proxy
83+
- Proxy Threads
84+
85+
86+
## Monitor metrics
87+
88+
See [Observability and monitoring guidance]({{< relref "/integrate/prometheus-with-redis-enterprise/observability/" >}}) for monitoring details.
89+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
Title: Dynatrace with Redis Cloud
3+
LinkTitle: Dynatrace with Redis Cloud
4+
categories:
5+
- docs
6+
- integrate
7+
- rs
8+
description: To collect, view, and monitor metrics data from your databases and other
9+
cluster components, you can connect Dynatrace to your Redis Cloud cluster using
10+
the Redis Dynatrace Integration.
11+
group: observability
12+
summary: To collect, view, and monitor metrics data from your databases and other
13+
cluster components, you can connect Dynatrace to your Redis Cloud cluster using
14+
the Redis Dynatrace Integration.
15+
type: integration
16+
weight: 7
17+
---
18+
19+
20+
[Dynatrace](https://www.dynatrace.com/) is used by organizations of all sizes and across a wide range of industries to
21+
enable digital transformation and cloud migration, drive collaboration among development, operations, security and
22+
business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and
23+
infrastructure, understand user behavior, and track key business metrics.
24+
25+
The Redis Dynatrace Integration for Redis Cloud uses Prometheus remote write functionality to connect Prometheus data
26+
sources to Dynatrace. This integration enables Redis Cloud users to export metrics to Dynatrace for analysis,
27+
and includes Redis-designed dashboards for use in monitoring Redis Cloud clusters.
28+
29+
This integration makes it possible to:
30+
- Collect and display metrics not available in the admin console
31+
- Set up automatic alerts for node or cluster events
32+
- Display these metrics alongside data from other systems
33+
34+
{{< image filename="/images/rc/redis-cloud-dynatrace.png" >}}
35+
## Install Redis' Dynatrace Integration for Redis Cloud
36+
37+
The Dynatrace Integration is based on a feature of the Prometheus data source. Prometheus can forward metrics on to
38+
another destination using remote writes. This will require a Prometheus installation inside the same datacenter as the
39+
Redis Cloud deployment.
40+
41+
If you have not already created a VPC between the Redis Cloud cluster and the network in which the machine hosting
42+
Prometheus lives you should do so now. Please visit [VPC Peering](https://redis.io/docs/latest/operate/rc/security/vpc-peering/)
43+
and follow the instructions for the cloud platform of your choice.
44+
45+
46+
47+
## View metrics
48+
49+
The Redis Cloud Integration for Dynatrace contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment.
50+
51+
The following dashboards are currently available:
52+
53+
- Cluster: top-level statistics indicating the general health of the cluster
54+
- Database: performance metrics at the database level
55+
- Shard: low-level details of an individual shard
56+
- Active-Active: replication and performance for geo-replicated clusters
57+
- Proxy: network and command information regarding the proxy
58+
- Proxy Threads: processor usage information regarding the proxy's component threads
59+
60+
## Monitor metrics
61+
62+
Dynatrace dashboards can be filtered using the text area. For example, when viewing a cluster dashboard it is possible
63+
filter the display to show data for only one cluster by typing 'cluster' in the text area and waiting for the system to
64+
retrieve the relevant data before choosing one of the options in the 'cluster' section.
65+
66+
Certain types of data do not know the name of the database from which they were drawn. The dashboard should have a list
67+
of database names and ids; use the id value when filtering input to the dashboard.
68+
69+
70+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
LinkTitle: Dynatrace with Redis Enterprise
3+
Title: Dynatrace with Redis Enterprise
4+
alwaysopen: false
5+
categories:
6+
- docs
7+
- integrate
8+
- rs
9+
description: To collect, view, and monitor metrics data from your databases and other
10+
cluster components, you can connect Dynatrace to your Redis Enterprise cluster using
11+
the Redis Dynatrace Integration.
12+
group: observability
13+
summary: To collect, view, and monitor metrics data from your databases and other
14+
cluster components, you can connect Dynatrace to your Redis Enterprise cluster using
15+
the Redis Dynatrace Integration.
16+
type: integration
17+
weight: 7
18+
---
19+
20+
21+
[Dynatrace](https://www.dynatrace.com/) is used by organizations of all sizes and across a wide range of industries to
22+
enable digital transformation and cloud migration, drive collaboration among development, operations, security and
23+
business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and
24+
infrastructure, understand user behavior, and track key business metrics.
25+
26+
The Dynatrace Integration for Redis Enterprise uses Prometheus remote write functionality to connect Prometheus data
27+
sources to Dynatrace. This integration enables Redis Enterprise users to export metrics to Dynatrace for analysis,
28+
and includes Redis-designed dashboards for use in monitoring Redis Enterprise clusters.
29+
30+
This integration makes it possible to:
31+
- Collect and display metrics not available in the admin console
32+
- Set up automatic alerts for node or cluster events
33+
- Display these metrics alongside data from other systems
34+
35+
{{< image filename="/images/rs/redis-enterprise-dynatrace.png" >}}
36+
## Install Redis' Dynatrace Integration for Redis Enterprise
37+
38+
At the present time the Dynatrace integration is not signed by Dynatrace, meaning that it will be necessary to download
39+
the source configuration and dashboards and assemble them and sign them cryptologically with a certificate that you have
40+
created. The instructions for this procedure can be found on the Dynatrace
41+
[site](https://docs.dynatrace.com/docs/extend-dynatrace/extensions20/sign-extension). Please note that the instructions
42+
would have you place the dashboards next to the src folder; this is incorrect, the dashboards should be located inside
43+
the src folder.
44+
45+
## View metrics
46+
47+
The Redis Enterprise Integration for Dynatrace contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment.
48+
49+
The following dashboards are currently available:
50+
51+
- Cluster: top-level statistics indicating the general health of the cluster
52+
- Database: performance metrics at the database level
53+
- Node: machine performance statistics
54+
- Shard: low-level details of an individual shard
55+
- Active-Active: replication and performance for geo-replicated clusters
56+
- Proxy: network and command information regarding the proxy
57+
- Proxy Threads: processor usage information regarding the proxy's component threads
58+
59+
60+
## Monitor metrics
61+
62+
Dynatrace dashboards can be filtered using the text area. For example, when viewing a cluster dashboard it is possible to
63+
filter the display to show data for only one cluster by typing 'cluster' in the text area and waiting for the system to
64+
retrieve the relevant data before choosing one of the options in the 'cluster' section.
65+
66+
Certain types of data do not know the name of the database from which they were drawn. The dashboard should have a list
67+
of database names and ids; use the id value when filtering input to the dashboard.
68+
69+

0 commit comments

Comments
 (0)