Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 66 additions & 63 deletions content/operate/rs/clusters/logging/alerts-events.md

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions content/operate/rs/monitoring/v1_monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ We recommend migrating to the metrics stream engine for enhanced accuracy, scala

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.

### Transition cluster manager alerts

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.

## Cluster manager metrics

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

Configured alerts are shown:

- 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
- 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
- In the **log**
- In email notifications, if you configure [email alerts](#send-alerts-by-email)

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

Configured alerts are shown:

- 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
- 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
- In the **log**
- In emails, if you configure [email alerts](#send-alerts-by-email)

Expand Down
62 changes: 62 additions & 0 deletions content/operate/rs/references/alerts/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
Title: Alerts
alwaysopen: false
categories:
- docs
- operate
- rs
- rc
description: Documents the alerts that are tracked with Redis Enterprise Software.
hideListLinks: true
linkTitle: Alerts
weight: $weight
---

Cluster alerts are triggered based on thresholds applied to these stored metrics.

## Cluster alerts

In **Cluster > Alert Settings**, you can enable alerts for node or cluster events, such as high memory usage or throughput.

Configured alerts are shown:

- 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
- In the **log**
- In email notifications, if you configure [email alerts](#send-alerts-by-email)

{{< note >}}
If you enable alerts for "Node joined" or "Node removed" actions,
you must also enable "Receive email alerts" so that the notifications are sent.
{{< /note >}}

To enable alerts for a cluster:

1. In **Cluster > Alert Settings**, click **Edit**.
1. Select the alerts that you want to show for the cluster and click **Save**.

## Database alerts

For each database, you can enable alerts for database events, such as high memory usage or throughput.

Configured alerts are shown:

- 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
- In the **log**
- In emails, if you configure [email alerts](#send-alerts-by-email)

To enable alerts for a database:

1. In **Configuration** for the database, click **Edit**.
1. Select the **Alerts** section to open it.
1. Select the alerts that you want to show for the database and click **Save**.

## Send alerts by email

To send cluster and database alerts by email:

1. In **Cluster > Alert Settings**, click **Edit**.
1. Select **Set an email** to configure the [email server settings]({{< relref "/operate/rs/clusters/configure/cluster-settings#configure-email-server-settings" >}}).
1. In **Configuration** for the database, click **Edit**.
1. Select the **Alerts** section to open it.
1. Select **Receive email alerts** and click **Save**.
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.
23 changes: 23 additions & 0 deletions content/operate/rs/references/alerts/alerts-v1-to-v2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
Title: Transition cluster manager alerts to Prometheus alerts
alwaysopen: false
categories:
- docs
- operate
- rs
description: Transition from internal cluster manager alerts to external monitoring alerts using Prometheus.
linkTitle: Transition cluster manager alerts to Prometheus
weight: 50
---

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.

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/):

| Cluster manager alert | Equivalent PromQL | Description |
|-----------------------|-------------------|-------------|
| 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% |
| 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% |
| 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% |
| 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% |
| 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% |
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ The [metrics stream engine]({{<relref "/operate/rs/monitoring/metrics_stream_eng

- 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.

- 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.

### Enhancements

- Module management enhancements:
Expand Down
13 changes: 13 additions & 0 deletions layouts/shortcodes/inline-icon.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{{ $fname := .Get "filename" | strings.TrimLeft "/" }}
{{ $cleanFname := $fname | strings.TrimSuffix "#no-click" }}
{{ $noClick := strings.HasSuffix $fname "#no-click" }}
{{ if not (hasPrefix $cleanFname "/") }}
{{ .Scratch.Set "file" (printf "/%s" $cleanFname) }}
{{ else }}
{{ .Scratch.Set "file" $cleanFname }}
{{ end }}
<img src='{{ relURL $cleanFname }}'
{{ with .Get "width" }} width="{{.}}"{{ end }}
{{ with .Get "height" }} height="{{.}}"{{ end }}
{{ with .Get "alt"}} alt="{{.}}"{{ end }}
class="inline align-middle m-0 p-0{{ if $noClick }} pointer-events-none cursor-default{{ end }}{{ with .Get "class" }} {{.}}{{ end }}"/>