Skip to content

Commit 8919f69

Browse files
committed
DOC-4800 Started top-level RS monitoring section
1 parent 391c08d commit 8919f69

File tree

14 files changed

+1802
-460
lines changed

14 files changed

+1802
-460
lines changed

content/embeds/rs-prometheus-metrics-transition-plan.md

Lines changed: 260 additions & 0 deletions
Large diffs are not rendered by default.

content/embeds/rs-prometheus-metrics-v2.md

Lines changed: 199 additions & 0 deletions
Large diffs are not rendered by default.

content/integrate/prometheus-with-redis-enterprise/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ summary: You can use Prometheus and Grafana to collect and visualize your Redis
1212
Software metrics.
1313
type: integration
1414
weight: 5
15+
tocEmbedHeaders: true
1516
---
1617

1718
You can use Prometheus and Grafana to collect and visualize your Redis Enterprise Software metrics.

content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions.md

Lines changed: 2 additions & 199 deletions
Large diffs are not rendered by default.

content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2.md

Lines changed: 2 additions & 260 deletions
Large diffs are not rendered by default.

content/operate/rs/clusters/monitoring/_index.md renamed to content/operate/rs/monitoring/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ categories:
99
description: Use the metrics that measure the performance of your Redis Enterprise Software clusters, nodes, databases, and shards to track the performance of your databases.
1010
hideListLinks: true
1111
linkTitle: Monitoring
12-
weight: 96
12+
weight: 70
13+
aliases: /operate/rs/clusters/monitoring/
1314
---
15+
1416
You can use the metrics that measure the performance of your Redis Enterprise Software clusters, nodes, databases, and shards
1517
to monitor the performance of your databases.
1618
In the Redis Enterprise Cluster Manager UI, you can view metrics, configure alerts, and send notifications based on alert parameters. You can also access metrics and configure alerts through the REST API.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
Title: Metrics stream engine preview
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
- kubernetes
9+
description: Use the metrics that measure the performance of your Redis Enterprise Software clusters, nodes, databases, and shards to track the performance of your databases.
10+
hideListLinks: true
11+
linkTitle: Metrics stream engine - v2 monitoring preview
12+
weight: 60
13+
---
14+
15+
TBA
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
Title: Transition from Prometheus v1 to Prometheus v2
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- integrate
7+
- rs
8+
description: Transition from v1 metrics to v2 PromQL equivalents.
9+
group: observability
10+
linkTitle: Transition from Prometheus v1 to v2
11+
summary: Transition from v1 metrics to v2 PromQL equivalents.
12+
type: integration
13+
weight: 49
14+
tocEmbedHeaders: true
15+
---
16+
17+
You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{<relref "/integrate/prometheus-with-redis-enterprise/">}}) to create dashboards for important metrics.
18+
19+
As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 PromQL metrics, see [Prometheus metrics v2]({{<relref "/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions">}}).
20+
21+
{{<embed-md "rs-prometheus-metrics-transition-plan.md">}}
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
Title: Prometheus metrics v2 preview
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- integrate
7+
- rs
8+
description: V2 metrics available to Prometheus as of Redis Enterprise Software version 7.8.2.
9+
group: observability
10+
linkTitle: Prometheus metrics v2
11+
summary: V2 metrics available to Prometheus as of Redis Enterprise Software version 7.8.2.
12+
type: integration
13+
weight: 50
14+
tocEmbedHeaders: true
15+
---
16+
17+
{{<banner-article>}}
18+
While the metrics stream engine is in preview, this document provides only a partial list of v2 metrics. More metrics will be added.
19+
{{</banner-article>}}
20+
21+
You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{<relref "/integrate/prometheus-with-redis-enterprise/">}}) to create dashboards for important metrics.
22+
23+
The v2 metrics in the following tables are available as of Redis Enterprise Software version 7.8.0. For help transitioning from v1 metrics to v2 PromQL, see [Prometheus v1 metrics and equivalent v2 PromQL]({{<relref "/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2">}}).
24+
25+
{{<embed-md "rs-prometheus-metrics-v2.md">}}
Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
LinkTitle: Prometheus and Grafana
3+
Title: Prometheus and Grafana with Redis Enterprise Software
4+
alwaysopen: false
5+
categories:
6+
- docs
7+
- integrate
8+
- rs
9+
description: Use Prometheus and Grafana to collect and visualize Redis Enterprise Software metrics.
10+
group: observability
11+
summary: You can use Prometheus and Grafana to collect and visualize your Redis Enterprise
12+
Software metrics.
13+
type: integration
14+
weight: 5
15+
tocEmbedHeaders: true
16+
---
17+
18+
You can use Prometheus and Grafana to collect and visualize your Redis Enterprise Software metrics.
19+
20+
Metrics are exposed at the cluster, node, database, shard, and proxy levels.
21+
22+
23+
- [Prometheus](https://prometheus.io/) is an open source systems monitoring and alerting toolkit that aggregates metrics from different sources.
24+
- [Grafana](https://grafana.com/) is an open source metrics visualization tool that processes Prometheus data.
25+
26+
You can use Prometheus and Grafana to:
27+
- Collect and display metrics not available in the [admin console]({{< relref "/operate/rs/references/metrics" >}})
28+
29+
- Set up automatic alerts for node or cluster events
30+
31+
- Display Redis Enterprise Software metrics alongside data from other systems
32+
33+
{{<image filename="images/rs/grafana-prometheus.png" alt="Graphic showing how Prometheus and Grafana collect and display data from a Redis Enterprise Cluster. Prometheus collects metrics from the Redis Enterprise cluster, and Grafana queries those metrics for visualization.">}}
34+
35+
In each cluster, the metrics_exporter process exposes Prometheus metrics on port 8070.
36+
Redis Enterprise version 7.8.2 introduces a preview of the new metrics stream engine that exposes the v2 Prometheus scraping endpoint at `https://<IP>:8070/v2`.
37+
38+
## Quick start
39+
40+
To get started with Prometheus and Grafana:
41+
42+
1. Create a directory called 'prometheus' on your local machine.
43+
44+
1. Within that directory, create a configuration file called `prometheus.yml`.
45+
1. Add the following contents to the configuration file and replace `<cluster_name>` with your Redis Enterprise cluster's FQDN:
46+
47+
{{< note >}}
48+
49+
We recommend running Prometheus in Docker only for development and testing.
50+
51+
{{< /note >}}
52+
53+
```yml
54+
global:
55+
scrape_interval: 15s
56+
evaluation_interval: 15s
57+
58+
# Attach these labels to any time series or alerts when communicating with
59+
# external systems (federation, remote storage, Alertmanager).
60+
external_labels:
61+
monitor: "prometheus-stack-monitor"
62+
63+
# Load and evaluate rules in this file every 'evaluation_interval' seconds.
64+
#rule_files:
65+
# - "first.rules"
66+
# - "second.rules"
67+
68+
scrape_configs:
69+
# scrape Prometheus itself
70+
- job_name: prometheus
71+
scrape_interval: 10s
72+
scrape_timeout: 5s
73+
static_configs:
74+
- targets: ["localhost:9090"]
75+
76+
# scrape Redis Enterprise
77+
- job_name: redis-enterprise
78+
scrape_interval: 30s
79+
scrape_timeout: 30s
80+
metrics_path: /
81+
scheme: https
82+
tls_config:
83+
insecure_skip_verify: true
84+
static_configs:
85+
- targets: ["<cluster_name>:8070"] # For v2, use ["<cluster_name>:8070/v2"]
86+
```
87+
88+
1. Set up your Prometheus and Grafana servers.
89+
To set up Prometheus and Grafana on Docker:
90+
1. Create a _docker-compose.yml_ file:
91+
92+
```yml
93+
version: '3'
94+
services:
95+
prometheus-server:
96+
image: prom/prometheus
97+
ports:
98+
- 9090:9090
99+
volumes:
100+
- ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
101+
102+
grafana-ui:
103+
image: grafana/grafana
104+
ports:
105+
- 3000:3000
106+
environment:
107+
- GF_SECURITY_ADMIN_PASSWORD=secret
108+
links:
109+
- prometheus-server:prometheus
110+
```
111+
112+
1. To start the containers, run:
113+
114+
```sh
115+
$ docker compose up -d
116+
```
117+
118+
1. To check that all of the containers are up, run: `docker ps`
119+
1. In your browser, sign in to Prometheus at http://localhost:9090 to make sure the server is running.
120+
1. Select **Status** and then **Targets** to check that Prometheus is collecting data from your Redis Enterprise cluster.
121+
122+
{{<image filename="images/rs/prometheus-target.png" alt="The Redis Enterprise target showing that Prometheus is connected to the Redis Enterprise Cluster.">}}
123+
124+
If Prometheus is connected to the cluster, you can type **node_up** in the Expression field on the Prometheus home page to see the cluster metrics.
125+
126+
1. Configure the Grafana datasource:
127+
1. Sign in to Grafana. If you installed Grafana locally, go to http://localhost:3000 and sign in with:
128+
129+
- Username: admin
130+
- Password: secret
131+
132+
1. In the Grafana configuration menu, select **Data Sources**.
133+
134+
1. Select **Add data source**.
135+
136+
1. Select **Prometheus** from the list of data source types.
137+
138+
{{<image filename="images/rs/prometheus-datasource.png" alt="The Prometheus data source in the list of data sources on Grafana.">}}
139+
140+
1. Enter the Prometheus configuration information:
141+
142+
- Name: `redis-enterprise`
143+
- URL: `http://<your prometheus server name>:9090`
144+
145+
{{<image filename="images/rs/prometheus-connection.png" alt="The Prometheus connection form in Grafana.">}}
146+
147+
{{< note >}}
148+
149+
- If the network port is not accessible to the Grafana server, select the **Browser** option from the Access menu.
150+
- In a testing environment, you can select **Skip TLS verification**.
151+
152+
{{< /note >}}
153+
154+
1. Add dashboards for cluster, database, node, and shard metrics.
155+
To add preconfigured dashboards:
156+
1. In the Grafana dashboards menu, select **Manage**.
157+
1. Click **Import**.
158+
1. Upload one or more [Grafana dashboards](#grafana-dashboards-for-redis-enterprise).
159+
160+
### Grafana dashboards for Redis Enterprise
161+
162+
Redis publishes four preconfigured dashboards for Redis Enterprise and Grafana:
163+
164+
* The [cluster status dashboard](https://grafana.com/grafana/dashboards/18405-cluster-status-dashboard/) provides an overview of your Redis Enterprise clusters.
165+
* The [database status dashboard](https://grafana.com/grafana/dashboards/18408-database-status-dashboard/) displays specific database metrics, including latency, memory usage, ops/second, and key count.
166+
* The [node metrics dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-node-dashboard_v9-11.json) provides metrics for each of the nodes hosting your cluster.
167+
* The [shard metrics dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-shard-dashboard_v9-11.json) displays metrics for the individual Redis processes running on your cluster nodes
168+
* The [Active-Active dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-active-active-dashboard_v9-11.json) displays metrics specific to [Active-Active databases]({{< relref "/operate/rs/databases/active-active" >}}).
169+
170+
These dashboards are open source. For additional dashboard options, or to file an issue, see the [Redis Enterprise observability Github repository](https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/grafana).
171+
172+
For more information about configuring Grafana dashboards, see the [Grafana documentation](https://grafana.com/docs/).
173+

0 commit comments

Comments
 (0)