Skip to content
Open
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
7 changes: 7 additions & 0 deletions content/embeds/rs-alerts-transition-plan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
| 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
@@ -1,67 +1,3 @@
---
Title: Monitoring v2
alwaysopen: false
categories:
- docs
- operate
- rs
- kubernetes
description: The new metrics engine for monitoring Redis Enterprise Software.
hideListLinks: true
linkTitle: Monitoring v2
weight: 60
---

The new metrics stream engine is generally available as of [Redis Enterprise Software version 8.0]({{<relref "/operate/rs/release-notes/rs-8-0-releases">}}).

The new metrics stream engine:

- Exposes the v2 Prometheus scraping endpoint at `https://<IP>:8070/v2`.

- Exports all time-series metrics to external monitoring tools such as Grafana, DataDog, NewRelic, and Dynatrace using Prometheus.

- Enables real-time monitoring, including full monitoring during maintenance operations, which provides full visibility into performance during events such as shards' failovers and scaling operations.

## Integrate with external monitoring tools

To integrate Redis Enterprise metrics into your monitoring environment, see the integration guides for [Prometheus and Grafana]({{< relref "/operate/rs/monitoring/prometheus_and_grafana" >}}).

For a detailed tutorial to deploy a complete monitoring stack with Prometheus and Grafana, see [Redis Software Observability with Prometheus and Grafana](https://redis.io/learn/operate/observability/redis-software-prometheus-and-grafana).

Filter [Libraries and tools]({{<relref "/integrate">}}) by "observability" for additional tools and guides.

## Prometheus metrics v2

For a list of all available v2 metrics, see [Prometheus metrics v2]({{<relref "/operate/rs/references/metrics/prometheus-metrics-v2">}}).

The v2 scraping endpoint also exposes metrics for `node_exporter` version 1.8.1. For more information, see the [Prometheus node_exporter GitHub repository](https://github.com/prometheus/node_exporter).

## Transition from Prometheus v1 to Prometheus v2

If you are already using the existing scraping endpoint for integration, do the following to transition from v1 metrics to v2 metrics:

1. Change the `metrics_path` in your Prometheus configuration file from `/` to `/v2` to use the new scraping endpoint.

Here's an example of the updated scraping configuration in `prometheus.yml`:

```yaml
scrape_configs:
# Scrape Redis Enterprise
- job_name: redis-enterprise
scrape_interval: 30s
scrape_timeout: 30s
metrics_path: /v2
scheme: https
tls_config:
insecure_skip_verify: true
static_configs:
- targets: ["<cluster_name>:8070"]
```

1. Use the metrics tables in [this guide]({{<relref "/operate/rs/references/metrics/prometheus-metrics-v1-to-v2">}}) to transition from v1 metrics to equivalent v2 PromQL.

It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition.

## Best practices for monitoring

Follow these best practices when monitoring your Redis Enterprise Software cluster using the metrics stream engine.
Expand Down Expand Up @@ -117,4 +53,4 @@ For database performance, availability, and efficiency, monitor the following me
| Security – cert-based | <span class="break-all">`endpoint_successful_cba_authentication`</span>,<br /><span class="break-all">`endpoint_failed_cba_authentication`</span>,<br /><span class="break-all">`endpoint_disconnected_cba_client`</span> | Monitor certificate authentication status and failures. | Counter |
| Security – password | <span class="break-all">`endpoint_disconnected_user_password_client`</span> | Monitor password-authentication client disconnects and correlate with policy changes. | Counter |
| Security – ACL | <span class="break-all">`redis_server_acl_access_denied_auth`</span>,<br /><span class="break-all">`redis_server_acl_access_denied_cmd`</span>,<br /><span class="break-all">`redis_server_acl_access_denied_key`</span>,<br /><span class="break-all">`redis_server_acl_access_denied_channel`</span> | Monitor unauthorized access attempts and incorrectly scoped ACLs. | Counter |
| Configuration | <span class="break-all">`db_config`</span>| This is an information metric that holds database configuration within labels such as: db_name, db_version, db_port, tls_mode. | counter |
| Configuration | <span class="break-all">`db_config`</span>| This is an information metric that holds database configuration within labels such as: db_name, db_version, db_port, tls_mode. | counter |
40 changes: 22 additions & 18 deletions content/embeds/rs-prometheus-grafana-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,13 @@ Metrics are exposed at the cluster, node, database, shard, and proxy levels.
- [Grafana](https://grafana.com/) is an open source metrics visualization tool that processes Prometheus data.

You can use Prometheus and Grafana to:
- Collect and display metrics not available in the admin console
- Collect and display metrics not available in the Cluster Manager UI

- Set up automatic alerts for node or cluster events
- Set up automatic alerts for all resources

- Display Redis Enterprise Software metrics alongside data from other systems

{{<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.">}}

In each cluster, the metrics_exporter process exposes Prometheus metrics on port 8070.
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`.
{{<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 Software cluster, and Grafana queries those metrics for visualization." width="80%" class="mx-auto block my-6 p-4 border border-redis-pen-300 rounded-lg shadow-sm">}}

To get started with Prometheus and Grafana, see the following [quick start](#quick-start) or see [Redis Software Observability with Prometheus and Grafana](https://redis.io/learn/operate/observability/redis-software-prometheus-and-grafana) for a more detailed tutorial.

Expand All @@ -28,7 +25,7 @@ To get started with Prometheus and Grafana:
1. Create a directory called 'prometheus' on your local machine.

1. Within that directory, create a configuration file called `prometheus.yml`.
1. Add the following contents to the configuration file and replace `<cluster_name>` with your Redis Enterprise cluster's FQDN:
1. Add the following contents to the configuration file and replace `<cluster_name>` with your Redis Enterprise Software cluster's FQDN:

{{< multitabs id="prometheus-config-yml"
tab1="v2 (metrics stream engine)"
Expand Down Expand Up @@ -57,7 +54,7 @@ scrape_configs:
static_configs:
- targets: ["localhost:9090"]

# scrape Redis Enterprise
# scrape Redis Enterprise Software
- job_name: redis-enterprise
scrape_interval: 30s
scrape_timeout: 30s
Expand Down Expand Up @@ -94,7 +91,7 @@ scrape_configs:
static_configs:
- targets: ["localhost:9090"]

# scrape Redis Enterprise
# scrape Redis Enterprise Software
- job_name: redis-enterprise
scrape_interval: 30s
scrape_timeout: 30s
Expand Down Expand Up @@ -144,16 +141,23 @@ We recommend running Prometheus in Docker only for development and testing.
$ docker compose up -d
```

1. To check that all of the containers are up, run: `docker ps`
1. In your browser, sign in to Prometheus at http://localhost:9090 to make sure the server is running.
1. Select **Status** and then **Targets** to check that Prometheus is collecting data from your Redis Enterprise cluster.
1. To check that all of the containers are up, run:

```sh
docker ps
```

1. In your browser, sign in to Prometheus at `http://localhost:9090` to make sure the server is running.

1. Select **Status** and then **Targets** to check that Prometheus is collecting data from your Redis Enterprise Software cluster.

{{<image filename="images/rs/prometheus-target.png" alt="The Redis Enterprise target showing that Prometheus is connected to the Redis Enterprise Cluster.">}}
{{<image filename="images/rs/prometheus-target.png" alt="The Redis Enterprise Software target showing that Prometheus is connected to the Redis Enterprise Software Cluster.">}}

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.

1. Configure the Grafana datasource:
1. Sign in to Grafana. If you installed Grafana locally, go to http://localhost:3000 and sign in with:

1. Sign in to Grafana. If you installed Grafana locally, go to `http://localhost:3000` and sign in with:

- Username: admin
- Password: secret
Expand Down Expand Up @@ -186,9 +190,9 @@ We recommend running Prometheus in Docker only for development and testing.
1. Click **Import**.
1. Upload one or more [Grafana dashboards](#grafana-dashboards-for-redis-enterprise).

## Grafana dashboards for Redis Enterprise
## Grafana dashboards for Redis Enterprise Software

Redis publishes preconfigured dashboards for Redis Enterprise and Grafana.
Redis publishes preconfigured dashboards for Redis Enterprise Software and Grafana.

{{< note >}}
V1 dashboards are not compatible with the v2 metrics exporter endpoint. Make sure to use the correct dashboard version for your metrics endpoint.
Expand All @@ -202,7 +206,7 @@ For more information about configuring Grafana dashboards, see the [Grafana docu

Use the following dashboards when connecting to the v1 metrics endpoint (`https://<cluster_name>:8070/`):

* The [cluster status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-cluster-dashboard_v9-11.json) provides an overview of your Redis Enterprise clusters.
* The [cluster status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-cluster-dashboard_v9-11.json) provides an overview of your Redis Enterprise Software clusters.
* The [database status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-database-dashboard_v9-11.json) displays specific database metrics, including latency, memory usage, ops/second, and key count.
* 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.
* 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.
Expand All @@ -212,7 +216,7 @@ Use the following dashboards when connecting to the v1 metrics endpoint (`https:

Use the following dashboards when connecting to the v2 metrics endpoint (`https://<cluster_name>:8070/v2`):

* The [cluster status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-cluster-dashboard_v9-11.json) provides an overview of your Redis Enterprise clusters.
* The [cluster status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-cluster-dashboard_v9-11.json) provides an overview of your Redis Enterprise Software clusters.
* The [database status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-database-dashboard_v9-11.json) displays specific database metrics, including latency, memory usage, ops/second, and key count.
* The [node metrics dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-node-dashboard_v9-11.json) provides metrics for each of the nodes hosting your cluster.
* The [shard metrics dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/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.
Expand Down
22 changes: 11 additions & 11 deletions content/integrate/datadog-with-redis-enterprise/_index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
LinkTitle: Datadog with Redis Enterprise
Title: Datadog with Redis Enterprise
LinkTitle: Datadog with Redis Software
Title: Datadog with Redis Enterprise Software
alwaysopen: false
categories:
- docs
- integrate
- rs
description: To collect, view, and monitor metrics data from your databases and other
cluster components, you can connect Datadog to your Redis Enterprise cluster using
cluster components, you can connect Datadog to your Redis Enterprise Software cluster using
the Redis Datadog Integration.
group: observability
summary: To collect, view, and monitor metrics data from your databases and other
cluster components, you can connect Datadog to your Redis Enterprise cluster using
cluster components, you can connect Datadog to your Redis Enterprise Software cluster using
the Redis Datadog Integration.
type: integration
weight: 7
Expand All @@ -23,19 +23,19 @@ enable digital transformation and cloud migration, drive collaboration among dev
business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and
infrastructure, understand user behavior, and track key business metrics.

The Datadog Integration for Redis Enterprise uses Datadog's Integration API to connect to Redis metrics exporters.
The Datadog Integration for Redis Enterprise Software uses Datadog's Integration API to connect to Redis metrics exporters.
The integration is based on the Datadog
[OpenMetrics integration](https://datadoghq.dev/integrations-core/base/openmetrics/) in their core API. This integration
enables Redis Enterprise users to export metrics directly to Datadog for analysis, and includes Redis-designed
dashboards for use in monitoring Redis Enterprise clusters.
enables Redis Enterprise Software users to export metrics directly to Datadog for analysis, and includes Redis-designed
dashboards for use in monitoring Redis Enterprise Software clusters.

This integration makes it possible to:
- Collect and display metrics not available in the admin console
- Set up automatic alerts for node or cluster events
- Display these metrics alongside data from other systems

{{< image filename="/images/rc/redis-cloud-datadog.png" >}}
## Install Redis' Datadog Integration for Redis Enterprise
## Install Redis' Datadog Integration for Redis Enterprise Software

Installing the Datadog integration is a two-step process. Firstly, the installation must be part of your configuration.
Select 'Integrations' from the menu in the Datadog portal and then enter 'Redis' in the search bar, then select
Expand Down Expand Up @@ -63,14 +63,14 @@ tail -f /var/log/datadog/agent.log
```

It will take several minutes for data to reach Datadog. Finally, check the Datadog console by selecting
Infrastructure -> Host Map from the menu and then finding the host that is monitoring the Redis Enterprise instance. The host
Infrastructure -> Host Map from the menu and then finding the host that is monitoring the Redis Enterprise Software instance. The host
should be present, and in its list of components there should be a section called 'rdse', which is the namespace used by
the Redis Enterprise integration, although this can take several minutes to appear. It is also possible to verify the metrics
the Redis Enterprise Software integration, although this can take several minutes to appear. It is also possible to verify the metrics
by choosing Metrics -> Explorer from the menu and entering 'rdse.bdb_up'.

## View metrics

The Redis Enterprise Integration for Datadog contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment.
The Redis Enterprise Software Integration for Datadog contains pre-defined dashboards to aid in monitoring your Redis Enterprise Software deployment.

The following dashboards are currently available:

Expand Down
Loading