|
| 1 | +--- |
| 2 | +Title: Metrics and alerts for monitoring v1 |
| 3 | +alwaysopen: false |
| 4 | +categories: |
| 5 | +- docs |
| 6 | +- operate |
| 7 | +- rs |
| 8 | +- kubernetes |
| 9 | +description: Monitor Redis Enterprise Software clusters and databases using internal monitoring systems and external monitoring tools. |
| 10 | +hideListLinks: true |
| 11 | +linkTitle: Monitoring v1 |
| 12 | +weight: 50 |
| 13 | +url: '/operate/rs/7.8/monitoring/v1_monitoring/' |
| 14 | +--- |
| 15 | + |
| 16 | +The current approach to monitoring Redis Enterprise Software includes: |
| 17 | + |
| 18 | +- Internal monitoring systems: |
| 19 | + |
| 20 | + - [Statistics APIs]({{<relref "/operate/rs/references/rest-api/objects/statistics">}}), which collect various statistics at regular time intervals for clusters, nodes, databases, shards, and endpoints. |
| 21 | + |
| 22 | + - Cluster manager metrics and alerts. |
| 23 | + |
| 24 | +- The v1 Prometheus scraping endpoint to integrate with external monitoring tools such as [Prometheus and Grafana]({{<relref "/operate/rs/monitoring/prometheus_and_grafana">}}). |
| 25 | + |
| 26 | +## Cluster manager metrics |
| 27 | + |
| 28 | +You can see the metrics of the cluster in: |
| 29 | + |
| 30 | +- **Cluster > Metrics** |
| 31 | +- **Node > Metrics** for each node |
| 32 | +- **Database > Metrics** for each database, including the shards for that database |
| 33 | + |
| 34 | +The scale selector at the top of the page allows you to set the X-axis (time) scale of the graph. |
| 35 | + |
| 36 | +To choose which metrics to display in the two large graphs at the top of the page: |
| 37 | + |
| 38 | +1. Hover over the graph you want to show in a large graph. |
| 39 | +1. Click on the right or left arrow to choose which side to show the graph. |
| 40 | + |
| 41 | +We recommend that you show two similar metrics in the top graphs so you can compare them side-by-side. |
| 42 | + |
| 43 | +See the following topics for metrics definitions: |
| 44 | +- [Database operations]({{< relref "/operate/rs/references/metrics/database-operations" >}}) for database metrics |
| 45 | +- [Resource usage]({{< relref "/operate/rs/references/metrics/resource-usage" >}}) for resource and database usage metrics |
| 46 | +- [Auto Tiering]({{< relref "/operate/rs/references/metrics/auto-tiering" >}}) for additional metrics for [Auto Tiering ]({{< relref "/operate/rs/databases/auto-tiering" >}}) databases |
| 47 | + |
| 48 | +## Cluster alerts |
| 49 | + |
| 50 | +In **Cluster > Alert Settings**, you can enable alerts for node or cluster events, such as high memory usage or throughput. |
| 51 | + |
| 52 | +Configured alerts are shown: |
| 53 | + |
| 54 | +- 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 |
| 55 | +- In the **log** |
| 56 | +- In email notifications, if you configure [email alerts](#send-alerts-by-email) |
| 57 | + |
| 58 | +{{< note >}} |
| 59 | +If you enable alerts for "Node joined" or "Node removed" actions, |
| 60 | +you must also enable "Receive email alerts" so that the notifications are sent. |
| 61 | +{{< /note >}} |
| 62 | + |
| 63 | +To enable alerts for a cluster: |
| 64 | + |
| 65 | +1. In **Cluster > Alert Settings**, click **Edit**. |
| 66 | +1. Select the alerts that you want to show for the cluster and click **Save**. |
| 67 | + |
| 68 | +## Database alerts |
| 69 | + |
| 70 | +For each database, you can enable alerts for database events, such as high memory usage or throughput. |
| 71 | + |
| 72 | +Configured alerts are shown: |
| 73 | + |
| 74 | +- 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 |
| 75 | +- In the **log** |
| 76 | +- In emails, if you configure [email alerts](#send-alerts-by-email) |
| 77 | + |
| 78 | +To enable alerts for a database: |
| 79 | + |
| 80 | +1. In **Configuration** for the database, click **Edit**. |
| 81 | +1. Select the **Alerts** section to open it. |
| 82 | +1. Select the alerts that you want to show for the database and click **Save**. |
| 83 | + |
| 84 | +## Send alerts by email |
| 85 | + |
| 86 | +To send cluster and database alerts by email: |
| 87 | + |
| 88 | +1. In **Cluster > Alert Settings**, click **Edit**. |
| 89 | +1. Select **Set an email** to configure the [email server settings]({{< relref "/operate/rs/clusters/configure/cluster-settings#configuring-email-server-settings" >}}). |
| 90 | +1. In **Configuration** for the database, click **Edit**. |
| 91 | +1. Select the **Alerts** section to open it. |
| 92 | +1. Select **Receive email alerts** and click **Save**. |
| 93 | +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. |
0 commit comments