Skip to content

Commit 17fa68e

Browse files
rrelledgedwdougherty
rrelledge
and
dwdougherty
authored
RS: Alerts transition plan (#2250)
* Separated RS alerts and events into separate tables * DOC-5200 RS: Added a transition plan for deprecated alerts * Update content/operate/rs/references/alerts/_index.md Co-authored-by: David Dougherty <[email protected]> * Added inline-icon shortcode to fix whitespace formatting issue with inline images and lists * Feedback update - remove node wording --------- Co-authored-by: David Dougherty <[email protected]>
1 parent 445e3bb commit 17fa68e

File tree

6 files changed

+172
-65
lines changed

6 files changed

+172
-65
lines changed

‎content/operate/rs/clusters/logging/alerts-events.md‎

Lines changed: 66 additions & 63 deletions
Large diffs are not rendered by default.

‎content/operate/rs/monitoring/v1_monitoring.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ We recommend migrating to the metrics stream engine for enhanced accuracy, scala
7070

7171
If you are already using the existing scraping endpoint for integration, follow [this guide]({{<relref "/operate/rs/references/metrics/prometheus-metrics-v1-to-v2">}}) to transition and try the new engine. It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition.
7272

73+
### Transition cluster manager alerts
74+
75+
As part of Redis Enterprise Software's transition to the [new metrics stream engine]({{<relref "/operate/rs/monitoring/metrics_stream_engine">}}), some internal cluster manager alerts were deprecated in favor of external monitoring solutions. See the [alerts transition plan]({{<relref "/operate/rs/references/alerts/alerts-v1-to-v2">}}) for guidance.
76+
7377
## Cluster manager metrics
7478

7579
You can see the metrics of the cluster in:
@@ -98,7 +102,7 @@ In **Cluster > Alert Settings**, you can enable alerts for node or cluster eve
98102

99103
Configured alerts are shown:
100104

101-
- As a notification on the status icon ( {{< image filename="/images/rs/icons/icon_warning.png#no-click" alt="Warning" width="18px" class="inline" >}} ) for the node and cluster
105+
- As a notification on the status icon ( {{< inline-icon filename="/images/rs/icons/icon_warning.png#no-click" alt="Warning" width="18px" >}} ) for the node and cluster
102106
- In the **log**
103107
- In email notifications, if you configure [email alerts](#send-alerts-by-email)
104108

@@ -118,7 +122,7 @@ For each database, you can enable alerts for database events, such as high memor
118122

119123
Configured alerts are shown:
120124

121-
- As a notification on the status icon ( {{< image filename="/images/rs/icons/icon_warning.png#no-click" alt="Warning" width="18px" class="inline" >}} ) for the database
125+
- As a notification on the status icon ( {{< inline-icon filename="/images/rs/icons/icon_warning.png#no-click" alt="Warning" width="18px" >}} ) for the database
122126
- In the **log**
123127
- In emails, if you configure [email alerts](#send-alerts-by-email)
124128

‎content/operate/rs/references/alerts/_index.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
Title: Alerts
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
- rc
9+
description: Documents the alerts that are tracked with Redis Enterprise Software.
10+
hideListLinks: true
11+
linkTitle: Alerts
12+
weight: $weight
13+
---
14+
15+
Cluster alerts are triggered based on thresholds applied to these stored metrics.
16+
17+
## Cluster alerts
18+
19+
In **Cluster > Alert Settings**, you can enable alerts for node or cluster events, such as high memory usage or throughput.
20+
21+
Configured alerts are shown:
22+
23+
- As a notification on the status icon ( {{< inline-icon filename="/images/rs/icons/icon_warning.png#no-click" alt="Warning" width="18px" >}} ) for the node and cluster
24+
- In the **log**
25+
- In email notifications, if you configure [email alerts](#send-alerts-by-email)
26+
27+
{{< note >}}
28+
If you enable alerts for "Node joined" or "Node removed" actions,
29+
you must also enable "Receive email alerts" so that the notifications are sent.
30+
{{< /note >}}
31+
32+
To enable alerts for a cluster:
33+
34+
1. In **Cluster > Alert Settings**, click **Edit**.
35+
1. Select the alerts that you want to show for the cluster and click **Save**.
36+
37+
## Database alerts
38+
39+
For each database, you can enable alerts for database events, such as high memory usage or throughput.
40+
41+
Configured alerts are shown:
42+
43+
- As a notification on the status icon ( {{< inline-icon filename="/images/rs/icons/icon_warning.png#no-click" alt="Warning" width="18px" >}} ) for the database
44+
- In the **log**
45+
- In emails, if you configure [email alerts](#send-alerts-by-email)
46+
47+
To enable alerts for a database:
48+
49+
1. In **Configuration** for the database, click **Edit**.
50+
1. Select the **Alerts** section to open it.
51+
1. Select the alerts that you want to show for the database and click **Save**.
52+
53+
## Send alerts by email
54+
55+
To send cluster and database alerts by email:
56+
57+
1. In **Cluster > Alert Settings**, click **Edit**.
58+
1. Select **Set an email** to configure the [email server settings]({{< relref "/operate/rs/clusters/configure/cluster-settings#configure-email-server-settings" >}}).
59+
1. In **Configuration** for the database, click **Edit**.
60+
1. Select the **Alerts** section to open it.
61+
1. Select **Receive email alerts** and click **Save**.
62+
1. In **Access Control**, select the [database and cluster alerts]({{< relref "/operate/rs/security/access-control/manage-users" >}}) that you want each user to receive.

‎content/operate/rs/references/alerts/alerts-v1-to-v2.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
Title: Transition cluster manager alerts to Prometheus alerts
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Transition from internal cluster manager alerts to external monitoring alerts using Prometheus.
9+
linkTitle: Transition cluster manager alerts to Prometheus
10+
weight: 50
11+
---
12+
13+
As Redis Enterprise Software transitions from the [deprecated monitoring system]({{<relref "/operate/rs/monitoring/v1_monitoring">}}) to the [new metrics stream engine]({{<relref "/operate/rs/monitoring/metrics_stream_engine">}}), some internal cluster manager alerts were deprecated in favor of external monitoring solutions.
14+
15+
You can use the following table to transition from the deprecated alerts and set up equivalent alerts in Prometheus with [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/):
16+
17+
| Cluster manager alert | Equivalent PromQL | Description |
18+
|-----------------------|-------------------|-------------|
19+
| BdbSizeAlert | <span class="break-all">`sum by(db, cluster) (redis_server_used_memory) / sum by(db, cluster) (redis_server_maxmemory) > 0.8`</span> | Redis server memory usage exceeds 80% |
20+
| NodeMemoryAlert | <span class="break-all">`(node_memory_MemTotal_bytes - node_memory_MemAvailable_bytes) / node_memory_MemTotal_bytes > 0.7`</span> | Node memory usage exceeds 70% |
21+
| NodeFreeFlashAlert | <span class="break-all">`(node_available_flash_bytes - node_bigstore_free_bytes) / node_available_flash_bytes > 0.7`</span> | Node flash storage usage exceeds 70% |
22+
| NodeEphemeralStorageAlert | <span class="break-all">`(node_ephemeral_storage_avail_bytes - node_ephemeral_storage_free_bytes) / node_ephemeral_storage_avail_bytes > 0.7`</span> | Node ephemeral storage usage exceeds 70% |
23+
| NodePersistentStorageAlert | <span class="break-all">`(node_persistent_storage_avail_bytes - node_persistent_storage_free_bytes) / node_persistent_storage_avail_bytes > 0.7`</span> | Node persistent storage usage exceeds 70% |

‎content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-tba.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,8 @@ The [metrics stream engine]({{<relref "/operate/rs/monitoring/metrics_stream_eng
136136
137137
- To transition to the metrics stream engine, either migrate your existing dashboards using [Prometheus v1 metrics and equivalent v2 PromQL]({{<relref "/operate/rs/references/metrics/prometheus-metrics-v1-to-v2">}}), or use new preconfigured dashboards when they become available.
138138
139+
- As part of the transition to the metrics stream engine, some internal cluster manager alerts were deprecated in favor of external monitoring solutions. See the [alerts transition plan]({{<relref "/operate/rs/references/alerts/alerts-v1-to-v2">}}) for guidance.
140+
139141
### Enhancements
140142
141143
- Module management enhancements:

‎layouts/shortcodes/inline-icon.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{{ $fname := .Get "filename" | strings.TrimLeft "/" }}
2+
{{ $cleanFname := $fname | strings.TrimSuffix "#no-click" }}
3+
{{ $noClick := strings.HasSuffix $fname "#no-click" }}
4+
{{ if not (hasPrefix $cleanFname "/") }}
5+
{{ .Scratch.Set "file" (printf "/%s" $cleanFname) }}
6+
{{ else }}
7+
{{ .Scratch.Set "file" $cleanFname }}
8+
{{ end }}
9+
<img src='{{ relURL $cleanFname }}'
10+
{{ with .Get "width" }} width="{{.}}"{{ end }}
11+
{{ with .Get "height" }} height="{{.}}"{{ end }}
12+
{{ with .Get "alt"}} alt="{{.}}"{{ end }}
13+
class="inline align-middle m-0 p-0{{ if $noClick }} pointer-events-none cursor-default{{ end }}{{ with .Get "class" }} {{.}}{{ end }}"/>

0 commit comments

Comments
 (0)