Skip to content

Commit c60979f

Browse files
committed
DOC-4800 Additional monitoring reorg
1 parent 8919f69 commit c60979f

File tree

20 files changed

+214
-1370
lines changed

20 files changed

+214
-1370
lines changed

content/operate/rs/monitoring/v1_monitoring/observability.md renamed to content/embeds/rs-observability.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
---
2-
Title: Redis Enterprise Software observability and monitoring guidance
3-
alwaysopen: false
4-
categories:
5-
- docs
6-
- integrate
7-
- rs
8-
description: Using monitoring and observability with Redis Enterprise
9-
group: observability
10-
linkTitle: Observability and monitoring
11-
summary: Observe Redis Enterprise resources and database perfomance indicators.
12-
type: integration
13-
weight: 45
14-
---
151

162
## Introduction
173

@@ -47,7 +33,7 @@ In addition to manually monitoring these resources and indicators, it is best pr
4733

4834
## Core cluster resource monitoring
4935

50-
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. This new engine exports all time-series metrics to external monitoring tools such as Grafana, DataDog, NewRelic, and Dynatrace using Prometheus.
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`. This new engine exports all time-series metrics to external monitoring tools such as Grafana, DataDog, NewRelic, and Dynatrace using Prometheus.
5137

5238
The new engine enables real-time monitoring, including full monitoring during maintenance operations, providing full visibility into performance during events such as shards' failovers and scaling operations. See [Monitoring with metrics and alerts]({{<relref "/operate/rs/clusters/monitoring/">}}) for more details.
5339

@@ -135,7 +121,7 @@ An acceptable rate of key evictions depends on the total number of keys in the d
135121
and the measure of application-level latency. If application latency is high,
136122
check to see that key evictions have not increased.
137123

138-
### Eviction Policies
124+
### Eviction policies
139125

140126
| Name | Description |
141127
| ------ | :------ |
@@ -376,11 +362,11 @@ See [eviction policy]({{< relref "/operate/rs/databases/memory-performance/evict
376362
Dashboard displaying object evictions - [Database Dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/classic/database_dashboard_v9-11.json)
377363
{{< image filename="/images/playbook_eviction-expiration.png" alt="Dashboard displaying object evictions">}}
378364

379-
## Proxy Performance
365+
## Proxy performance
380366

381-
Redis Enterprise Software (RS) provides high-performance data access through a proxy process that manages and optimizes access to shards within the RS cluster. Each node contains a single proxy process. Each proxy can be active and take incoming traffic or it can be passive and wait for failovers.
367+
Redis Enterprise Software provides high-performance data access through a proxy process that manages and optimizes access to shards within the cluster. Each node contains a single proxy process. Each proxy can be active and take incoming traffic or it can be passive and wait for failovers.
382368

383-
### Proxy Policies
369+
### Proxy policies
384370

385371

386372
| Policy | Description |
@@ -535,7 +521,7 @@ To use these alerts, install [Prometheus Alertmanager](https://prometheus.io/doc
535521
For a comprehensive guide to alerting with Prometheus and Grafana,
536522
see the [Grafana blog post on the subject](https://grafana.com/blog/2020/02/25/step-by-step-guide-to-setting-up-prometheus-alertmanager-with-slack-pagerduty-and-gmail/).
537523

538-
## Configuring Prometheus
524+
## Configure Prometheus
539525

540526
To configure Prometheus for alerting, open the `prometheus.yml` configuration file.
541527

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
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-
---
161

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

@@ -169,4 +154,3 @@ Redis publishes four preconfigured dashboards for Redis Enterprise and Grafana:
169154
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).
170155

171156
For more information about configuring Grafana dashboards, see the [Grafana documentation](https://grafana.com/docs/).
172-
Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,3 @@
1-
---
2-
Title: Prometheus metrics v1
3-
alwaysopen: false
4-
categories:
5-
- docs
6-
- integrate
7-
- rs
8-
description: V1 metrics available to Prometheus.
9-
group: observability
10-
linkTitle: Prometheus metrics v1
11-
summary: You can use Prometheus and Grafana to collect and visualize your Redis Enterprise Software metrics.
12-
type: integration
13-
weight: 48
14-
---
15-
16-
You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{<relref "/integrate/prometheus-with-redis-enterprise/">}}) to create dashboards for important metrics.
17-
18-
As of Redis Enterprise Software version 7.8.2, v1 metrics are deprecated but still available. 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">}}).
191

202
The following tables include the v1 metrics available to Prometheus.
213

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

Lines changed: 1 addition & 156 deletions
Original file line numberDiff line numberDiff line change
@@ -15,159 +15,4 @@ weight: 5
1515
tocEmbedHeaders: true
1616
---
1717

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-
18+
{{<embed-md "rs-prometheus-grafana-quickstart.md">}}

0 commit comments

Comments
 (0)