diff --git a/content/embeds/rs-alerts-transition-plan.md b/content/embeds/rs-alerts-transition-plan.md new file mode 100644 index 0000000000..0c08de82a1 --- /dev/null +++ b/content/embeds/rs-alerts-transition-plan.md @@ -0,0 +1,7 @@ +| Cluster manager alert | Equivalent PromQL | Description | +|-----------------------|-------------------|-------------| +| BdbSizeAlert | `sum by(db, cluster) (redis_server_used_memory) / sum by(db, cluster) (redis_server_maxmemory) > 0.8` | Redis server memory usage exceeds 80% | +| NodeMemoryAlert | `(node_memory_MemTotal_bytes - node_memory_MemAvailable_bytes) / node_memory_MemTotal_bytes > 0.7` | Node memory usage exceeds 70% | +| NodeFreeFlashAlert | `(node_available_flash_bytes - node_bigstore_free_bytes) / node_available_flash_bytes > 0.7` | Node flash storage usage exceeds 70% | +| NodeEphemeralStorageAlert | `(node_ephemeral_storage_avail_bytes - node_ephemeral_storage_free_bytes) / node_ephemeral_storage_avail_bytes > 0.7` | Node ephemeral storage usage exceeds 70% | +| NodePersistentStorageAlert | `(node_persistent_storage_avail_bytes - node_persistent_storage_free_bytes) / node_persistent_storage_avail_bytes > 0.7` | Node persistent storage usage exceeds 70% | diff --git a/content/operate/rs/monitoring/metrics_stream_engine.md b/content/embeds/rs-monitoring-best-practices.md similarity index 77% rename from content/operate/rs/monitoring/metrics_stream_engine.md rename to content/embeds/rs-monitoring-best-practices.md index f597f8d2d2..e28923ba15 100644 --- a/content/operate/rs/monitoring/metrics_stream_engine.md +++ b/content/embeds/rs-monitoring-best-practices.md @@ -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]({{}}). - -The new metrics stream engine: - -- Exposes the v2 Prometheus scraping endpoint at `https://: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]({{}}) by "observability" for additional tools and guides. - -## Prometheus metrics v2 - -For a list of all available v2 metrics, see [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: [":8070"] - ``` - -1. Use the metrics tables in [this guide]({{}}) 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. @@ -117,4 +53,4 @@ For database performance, availability, and efficiency, monitor the following me | Security – cert-based | `endpoint_successful_cba_authentication`,
`endpoint_failed_cba_authentication`,
`endpoint_disconnected_cba_client` | Monitor certificate authentication status and failures. | Counter | | Security – password | `endpoint_disconnected_user_password_client` | Monitor password-authentication client disconnects and correlate with policy changes. | Counter | | Security – ACL | `redis_server_acl_access_denied_auth`,
`redis_server_acl_access_denied_cmd`,
`redis_server_acl_access_denied_key`,
`redis_server_acl_access_denied_channel` | Monitor unauthorized access attempts and incorrectly scoped ACLs. | Counter | -| Configuration | `db_config`| This is an information metric that holds database configuration within labels such as: db_name, db_version, db_port, tls_mode. | counter | +| Configuration | `db_config`| This is an information metric that holds database configuration within labels such as: db_name, db_version, db_port, tls_mode. | counter | diff --git a/content/embeds/rs-prometheus-grafana-quickstart.md b/content/embeds/rs-prometheus-grafana-quickstart.md index a932506c06..378ee7210c 100644 --- a/content/embeds/rs-prometheus-grafana-quickstart.md +++ b/content/embeds/rs-prometheus-grafana-quickstart.md @@ -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 -{{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://:8070/v2`. +{{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.}} 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. @@ -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 `` with your Redis Enterprise cluster's FQDN: +1. Add the following contents to the configuration file and replace `` with your Redis Enterprise Software cluster's FQDN: {{< multitabs id="prometheus-config-yml" tab1="v2 (metrics stream engine)" @@ -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 @@ -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 @@ -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. - {{The Redis Enterprise target showing that Prometheus is connected to the Redis Enterprise Cluster.}} + {{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 @@ -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. @@ -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://: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. @@ -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://: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. diff --git a/content/integrate/datadog-with-redis-enterprise/_index.md b/content/integrate/datadog-with-redis-enterprise/_index.md index 8d5b1d5e41..cffe5ac48c 100644 --- a/content/integrate/datadog-with-redis-enterprise/_index.md +++ b/content/integrate/datadog-with-redis-enterprise/_index.md @@ -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 @@ -23,11 +23,11 @@ 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 @@ -35,7 +35,7 @@ This integration makes it possible to: - 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 @@ -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: diff --git a/content/integrate/dynatrace-with-redis-enterprise/_index.md b/content/integrate/dynatrace-with-redis-enterprise/_index.md index c348c3d66a..8e756e9a37 100644 --- a/content/integrate/dynatrace-with-redis-enterprise/_index.md +++ b/content/integrate/dynatrace-with-redis-enterprise/_index.md @@ -1,17 +1,17 @@ --- -LinkTitle: Dynatrace with Redis Enterprise -Title: Dynatrace with Redis Enterprise +LinkTitle: Dynatrace with Redis Software +Title: Dynatrace 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 Dynatrace to your Redis Enterprise cluster using + cluster components, you can connect Dynatrace to your Redis Enterprise Software cluster using the Redis Dynatrace Integration. group: observability summary: To collect, view, and monitor metrics data from your databases and other - cluster components, you can connect Dynatrace to your Redis Enterprise cluster using + cluster components, you can connect Dynatrace to your Redis Enterprise Software cluster using the Redis Dynatrace Integration. type: integration weight: 7 @@ -23,9 +23,9 @@ 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 Dynatrace Integration for Redis Enterprise uses Prometheus remote write functionality to connect Prometheus data -sources to Dynatrace. This integration enables Redis Enterprise users to export metrics to Dynatrace for analysis, -and includes Redis-designed dashboards for use in monitoring Redis Enterprise clusters. +The Dynatrace Integration for Redis Enterprise Software uses Prometheus remote write functionality to connect Prometheus data +sources to Dynatrace. This integration enables Redis Enterprise Software users to export metrics to Dynatrace 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 @@ -33,7 +33,7 @@ This integration makes it possible to: - Display these metrics alongside data from other systems {{< image filename="/images/rs/redis-enterprise-dynatrace.png" >}} -## Install Redis' Dynatrace Integration for Redis Enterprise +## Install Redis' Dynatrace Integration for Redis Enterprise Software At the present time the Dynatrace integration is not signed by Dynatrace, meaning that it will be necessary to download the source configuration and dashboards and assemble them and sign them cryptologically with a certificate that you have @@ -44,7 +44,7 @@ the src folder. ## View metrics -The Redis Enterprise Integration for Dynatrace contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment. +The Redis Enterprise Software Integration for Dynatrace contains pre-defined dashboards to aid in monitoring your Redis Enterprise Software deployment. The following dashboards are currently available: diff --git a/content/integrate/new-relic-with-redis-enterprise/_index.md b/content/integrate/new-relic-with-redis-enterprise/_index.md index 2afdff69e9..c455592b07 100644 --- a/content/integrate/new-relic-with-redis-enterprise/_index.md +++ b/content/integrate/new-relic-with-redis-enterprise/_index.md @@ -1,17 +1,17 @@ --- -LinkTitle: New Relic with Redis Enterprise -Title: New Relic with Redis Enterprise +LinkTitle: New Relic with Redis Software +Title: New Relic 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 New Relic to your Redis Enterprise cluster using + cluster components, you can connect New Relic to your Redis Enterprise Software cluster using the Redis New Relic Integration. group: observability summary: To collect, view, and monitor metrics data from your databases and other - cluster components, you can connect New Relic to your Redis Enterprise cluster using + cluster components, you can connect New Relic to your Redis Enterprise Software cluster using the Redis New Relic Integration. type: integration weight: 7 @@ -23,9 +23,9 @@ 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 New Relic Integration for Redis Enterprise uses Prometheus remote write functionality to connect Prometheus data -sources to New Relic. This integration enables Redis Enterprise users to export metrics to New Relic for analysis, -and includes Redis-designed dashboards for use in monitoring Redis Enterprise clusters. +The New Relic Integration for Redis Enterprise Software uses Prometheus remote write functionality to connect Prometheus data +sources to New Relic. This integration enables Redis Enterprise Software users to export metrics to New Relic 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 @@ -33,13 +33,13 @@ This integration makes it possible to: - Display these metrics alongside data from other systems {{< image filename="/images/rs/redis-enterprise-newrelic.png" >}} -## Install Redis' New Relic Integration for Redis Enterprise +## Install Redis' New Relic Integration for Redis Enterprise Software The New Relic Integration for Redis is based on a feature of the Prometheus data source. Prometheus can forward metrics on to another destination using remote writes. The Prometheus installation must be configured to pull metrics from Redis Enterprise and write them to New Relic. There are two sections, first the pull from Redis and second the write to New Relic. -Get metrics from Redis Enterprise: +Get metrics from Redis Enterprise Software: ```yaml - job_name: "redis-enterprise" @@ -50,7 +50,7 @@ Get metrics from Redis Enterprise: tls_config: insecure_skip_verify: true static_configs: - # The default Redis Enterprise Prometheus port is 8070. + # The default Redis Enterprise Software Prometheus port is 8070. # Replace REDIS_ENTERPRISE_HOST with your cluster's hostname. - targets: ["REDIS_ENTERPRISE_HOST:8070"] ``` @@ -69,7 +69,7 @@ remote_write: ## View metrics -The Redis Enterprise Integration for New Relic contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment. +The Redis Enterprise Software Integration for New Relic contains pre-defined dashboards to aid in monitoring your Redis Enterprise Software deployment. The following dashboards are currently available: diff --git a/content/operate/rs/7.22/references/rest-api/objects/statistics/_index.md b/content/operate/rs/7.22/references/rest-api/objects/statistics/_index.md index 6e3ed97eed..3468dab6ae 100644 --- a/content/operate/rs/7.22/references/rest-api/objects/statistics/_index.md +++ b/content/operate/rs/7.22/references/rest-api/objects/statistics/_index.md @@ -12,6 +12,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/objects/statistics/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + ## Statistics overview Clusters, databases, nodes, and shards collect various statistics at regular time intervals. View the statistics for these objects using `GET stats` requests to their respective endpoints: diff --git a/content/operate/rs/7.22/references/rest-api/objects/statistics/cluster-metrics.md b/content/operate/rs/7.22/references/rest-api/objects/statistics/cluster-metrics.md index 9047c40ee9..3fb9296cda 100644 --- a/content/operate/rs/7.22/references/rest-api/objects/statistics/cluster-metrics.md +++ b/content/operate/rs/7.22/references/rest-api/objects/statistics/cluster-metrics.md @@ -12,6 +12,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/objects/statistics/cluster-metrics/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Metric name | Type | Description | |-------------|------|-------------| | available_flash | float | Sum of available flash in all nodes (bytes) | diff --git a/content/operate/rs/7.22/references/rest-api/objects/statistics/db-metrics.md b/content/operate/rs/7.22/references/rest-api/objects/statistics/db-metrics.md index d587549e95..6f4f10d5cc 100644 --- a/content/operate/rs/7.22/references/rest-api/objects/statistics/db-metrics.md +++ b/content/operate/rs/7.22/references/rest-api/objects/statistics/db-metrics.md @@ -12,6 +12,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/objects/statistics/db-metrics/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Metric name | Type | Description | |-------------|------|-------------| | avg_latency | float | Average latency of operations on the DB (microseconds). Only returned when there is traffic. | diff --git a/content/operate/rs/7.22/references/rest-api/objects/statistics/node-metrics.md b/content/operate/rs/7.22/references/rest-api/objects/statistics/node-metrics.md index c165633c4c..b381190b12 100644 --- a/content/operate/rs/7.22/references/rest-api/objects/statistics/node-metrics.md +++ b/content/operate/rs/7.22/references/rest-api/objects/statistics/node-metrics.md @@ -12,6 +12,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/objects/statistics/node-metrics/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Metric name | Type | Description | |-------------|------|-------------| | available_flash | float | Available flash on the node (bytes) | diff --git a/content/operate/rs/7.22/references/rest-api/objects/statistics/shard-metrics.md b/content/operate/rs/7.22/references/rest-api/objects/statistics/shard-metrics.md index f44e7bba0d..20b61c26ae 100644 --- a/content/operate/rs/7.22/references/rest-api/objects/statistics/shard-metrics.md +++ b/content/operate/rs/7.22/references/rest-api/objects/statistics/shard-metrics.md @@ -12,6 +12,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/objects/statistics/shard-metrics/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Metric name | Type | Description | |-------------|------|-------------| | aof_rewrite_inprog | float | The number of simultaneous AOF rewrites that are in progress | diff --git a/content/operate/rs/7.22/references/rest-api/requests/bdbs/stats/_index.md b/content/operate/rs/7.22/references/rest-api/requests/bdbs/stats/_index.md index b10be50a8c..5281246b28 100644 --- a/content/operate/rs/7.22/references/rest-api/requests/bdbs/stats/_index.md +++ b/content/operate/rs/7.22/references/rest-api/requests/bdbs/stats/_index.md @@ -13,6 +13,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/requests/bdbs/stats/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-all-bdbs-stats) | `/v1/bdbs/stats` | Get stats for all databases | diff --git a/content/operate/rs/7.22/references/rest-api/requests/cluster/stats/_index.md b/content/operate/rs/7.22/references/rest-api/requests/cluster/stats/_index.md index 24520f65e3..bb12c900cf 100644 --- a/content/operate/rs/7.22/references/rest-api/requests/cluster/stats/_index.md +++ b/content/operate/rs/7.22/references/rest-api/requests/cluster/stats/_index.md @@ -13,6 +13,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/requests/cluster/stats/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-cluster-stats) | `/v1/cluster/stats` | Get cluster stats | diff --git a/content/operate/rs/7.22/references/rest-api/requests/endpoints-stats/_index.md b/content/operate/rs/7.22/references/rest-api/requests/endpoints-stats/_index.md index c556b0d0c3..fd5d8ae3b2 100644 --- a/content/operate/rs/7.22/references/rest-api/requests/endpoints-stats/_index.md +++ b/content/operate/rs/7.22/references/rest-api/requests/endpoints-stats/_index.md @@ -13,6 +13,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/requests/endpoints-stats/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-endpoints-stats) | `/v1/endpoints/stats` | Get stats for all endpoints | diff --git a/content/operate/rs/7.22/references/rest-api/requests/nodes/stats/_index.md b/content/operate/rs/7.22/references/rest-api/requests/nodes/stats/_index.md index 58aabcb462..bcf8a96427 100644 --- a/content/operate/rs/7.22/references/rest-api/requests/nodes/stats/_index.md +++ b/content/operate/rs/7.22/references/rest-api/requests/nodes/stats/_index.md @@ -13,6 +13,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/requests/nodes/stats/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-all-nodes-stats) | `/v1/nodes/stats` | Get stats for all nodes | diff --git a/content/operate/rs/7.22/references/rest-api/requests/shards/stats/_index.md b/content/operate/rs/7.22/references/rest-api/requests/shards/stats/_index.md index fa28bd6226..f5ce8d5133 100644 --- a/content/operate/rs/7.22/references/rest-api/requests/shards/stats/_index.md +++ b/content/operate/rs/7.22/references/rest-api/requests/shards/stats/_index.md @@ -13,6 +13,10 @@ weight: $weight url: '/operate/rs/7.22/references/rest-api/requests/shards/stats/' --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/7.22/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-all-shards-stats) | `/v1/shards/stats` | Get stats for all shards | diff --git a/content/operate/rs/monitoring/_index.md b/content/operate/rs/monitoring/_index.md index 28c363cb8a..4d9392e7a3 100644 --- a/content/operate/rs/monitoring/_index.md +++ b/content/operate/rs/monitoring/_index.md @@ -30,7 +30,15 @@ See [Metrics stream engine for monitoring v2]({{}}). +To integrate Redis Enterprise metrics into your monitoring environment, see the following integration guides: + +- [Grafana]({{}}) + +- [Datadog]({{}}) + +- [Dynatrace]({{}}) + +- [New Relic]({{}}) 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). diff --git a/content/operate/rs/monitoring/get-started.md b/content/operate/rs/monitoring/get-started.md new file mode 100644 index 0000000000..41da141ce0 --- /dev/null +++ b/content/operate/rs/monitoring/get-started.md @@ -0,0 +1,175 @@ +--- +LinkTitle: Get started +Title: Get started with monitoring Redis Enterprise Software +alwaysopen: false +categories: +- docs +- integrate +- rs +description: Collect and visualize Redis Enterprise Software metrics. +group: observability +summary: Collect and visualize your Redis Enterprise Software metrics. +type: integration +weight: 5 +tocEmbedHeaders: true +aliases: /operate/rs/monitoring/prometheus_and_grafana/ +--- + +You can use Prometheus and compatible integrations to collect and visualize your Redis Enterprise Software metrics. + +Metrics are exposed at the cluster, node, database, shard, and proxy levels. + +- [Prometheus](https://prometheus.io/) is an open source systems monitoring and alerting toolkit that aggregates metrics from different sources. + +You can use Prometheus integrations to: +- Collect and display metrics not available in the Cluster Manager UI + +- Set up automatic alerts for all resources + +- Display Redis Enterprise Software metrics alongside data from other systems + +## Prometheus integrations + +You can integrate Redis Enterprise Software with Prometheus and one of the following tools to collect and visualize your deployment's metrics: + +- [Grafana]({{}}) + +- [Datadog]({{}}) + +- [Dynatrace]({{}}) + +- [New Relic]({{}}) + +{{}} + +## Prometheus quick start + +To get started with Prometheus: + +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 `` with your Redis Enterprise Software cluster's FQDN: + + {{< multitabs id="prometheus-config-yml" +tab1="v2 (metrics stream engine)" +tab2="v1" >}} + +```yml +global: + scrape_interval: 15s + evaluation_interval: 15s + +# Attach these labels to any time series or alerts when communicating with +# external systems (federation, remote storage, Alertmanager). + external_labels: + monitor: "prometheus-stack-monitor" + +# Load and evaluate rules in this file every 'evaluation_interval' seconds. +#rule_files: +# - "first.rules" +# - "second.rules" + +scrape_configs: +# scrape Prometheus itself + - job_name: prometheus + scrape_interval: 10s + scrape_timeout: 5s + static_configs: + - targets: ["localhost:9090"] + +# scrape Redis Enterprise Software + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: /v2 + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] +``` + +-tab-sep- + +```yml +global: + scrape_interval: 15s + evaluation_interval: 15s + +# Attach these labels to any time series or alerts when communicating with +# external systems (federation, remote storage, Alertmanager). + external_labels: + monitor: "prometheus-stack-monitor" + +# Load and evaluate rules in this file every 'evaluation_interval' seconds. +#rule_files: +# - "first.rules" +# - "second.rules" + +scrape_configs: +# scrape Prometheus itself + - job_name: prometheus + scrape_interval: 10s + scrape_timeout: 5s + static_configs: + - targets: ["localhost:9090"] + +# scrape Redis Enterprise Software + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: / + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] +``` + {{< /multitabs >}} + +1. Set up your Prometheus server. + + {{< note >}} +We recommend running Prometheus in Docker only for development and testing. + {{< /note >}} + + To set up Prometheus on Docker: + + 1. Create a _docker-compose.yml_ file: + + ```yml + version: '3' + services: + prometheus-server: + image: prom/prometheus + ports: + - 9090:9090 + volumes: + - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml + ``` + + 1. To start the containers, run: + + ```sh + $ docker compose up -d + ``` + + 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. + + {{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. Integrate Redis Enterprise Software and your Prometheus server with one of the [compatible tools](#prometheus-integrations). For help, see the integration guide and official documentation for your chosen tool. + +1. Add dashboards for cluster, database, node, and shard metrics. diff --git a/content/operate/rs/monitoring/metrics_stream_engine/_index.md b/content/operate/rs/monitoring/metrics_stream_engine/_index.md new file mode 100644 index 0000000000..c64a934b91 --- /dev/null +++ b/content/operate/rs/monitoring/metrics_stream_engine/_index.md @@ -0,0 +1,74 @@ +--- +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 +tocEmbedHeaders: true +--- + +The new metrics stream engine is generally available as of [Redis Enterprise Software version 8.0]({{}}). + +The new metrics stream engine: + +- Exposes the v2 Prometheus scraping endpoint at `https://: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 following integration guides: + +- [Grafana]({{}}) + +- [Datadog]({{}}) + +- [Dynatrace]({{}}) + +- [New Relic]({{}}) + +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]({{}}) by "observability" for additional tools and guides. + +## Prometheus metrics v2 + +For a list of all available v2 metrics, see [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: [":8070"] + ``` + +1. Use the metrics tables in [this guide]({{}}) 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. + +{{}} \ No newline at end of file diff --git a/content/operate/rs/monitoring/metrics_stream_engine/alerts-v1-to-v2.md b/content/operate/rs/monitoring/metrics_stream_engine/alerts-v1-to-v2.md new file mode 100644 index 0000000000..c1662b2108 --- /dev/null +++ b/content/operate/rs/monitoring/metrics_stream_engine/alerts-v1-to-v2.md @@ -0,0 +1,17 @@ +--- +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]({{}}) to the [new 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/): + +{{}} \ No newline at end of file diff --git a/content/operate/rs/monitoring/metrics_stream_engine/prometheus-metrics-v1-to-v2.md b/content/operate/rs/monitoring/metrics_stream_engine/prometheus-metrics-v1-to-v2.md new file mode 100644 index 0000000000..4a64379918 --- /dev/null +++ b/content/operate/rs/monitoring/metrics_stream_engine/prometheus-metrics-v1-to-v2.md @@ -0,0 +1,43 @@ +--- +Title: Transition from Prometheus v1 to Prometheus v2 +alwaysopen: false +categories: +- docs +- integrate +- rs +description: Transition from v1 metrics to v2 PromQL equivalents. +group: observability +linkTitle: Transition from Prometheus v1 to v2 +summary: Transition from v1 metrics to v2 PromQL equivalents. +type: integration +weight: 49 +tocEmbedHeaders: true +--- + +You can integrate Redis Enterprise Software with Prometheus and tools such as [Grafana]({{}}), [Datadog]({{}}), [Dynatrace]({{}}), or [New Relic]({{}}) to create dashboards for important metrics. + +As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. + +To transition from v1 metrics to v2 metrics, you need to 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: [":8070"] +``` + +You can scrape both v1 and v2 endpoints simultaneously during the transition period to prepare dashboards and ensure a smooth transition. + +You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 metrics, see [Prometheus metrics v2]({{}}). + +{{}} diff --git a/content/operate/rs/monitoring/metrics_stream_engine/prometheus-metrics-v2.md b/content/operate/rs/monitoring/metrics_stream_engine/prometheus-metrics-v2.md new file mode 100644 index 0000000000..088d9b276c --- /dev/null +++ b/content/operate/rs/monitoring/metrics_stream_engine/prometheus-metrics-v2.md @@ -0,0 +1,23 @@ +--- +Title: Prometheus metrics v2 +alwaysopen: false +categories: +- docs +- integrate +- rs +description: V2 metrics available to Prometheus as of Redis Enterprise Software version 7.8.2. +group: observability +linkTitle: Prometheus metrics v2 +summary: V2 metrics available to Prometheus as of Redis Enterprise Software version 7.8.2. +type: integration +weight: 50 +tocEmbedHeaders: true +--- + +You can integrate Redis Enterprise Software with Prometheus and tools such as [Grafana]({{}}), [Datadog]({{}}), [Dynatrace]({{}}), or [New Relic]({{}}) to create dashboards for important metrics. + +The v2 metrics in the following tables are available as of Redis Enterprise Software version 7.8.0. For help transitioning from v1 metrics to v2 PromQL, see [Prometheus v1 metrics and equivalent v2 PromQL]({{}}). + +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). + +{{}} diff --git a/content/operate/rs/monitoring/observability.md b/content/operate/rs/monitoring/observability.md index 6f7e0ba281..e59a696067 100644 --- a/content/operate/rs/monitoring/observability.md +++ b/content/operate/rs/monitoring/observability.md @@ -7,10 +7,10 @@ categories: - rs description: Using monitoring and observability with Redis Enterprise group: observability -linkTitle: Observability and monitoring +linkTitle: Observability guide summary: Observe Redis Enterprise resources and database perfomance indicators. type: integration -weight: 45 +weight: 75 tocEmbedHeaders: true --- diff --git a/content/operate/rs/monitoring/prometheus_and_grafana.md b/content/operate/rs/monitoring/prometheus_and_grafana.md deleted file mode 100644 index 428656fc7b..0000000000 --- a/content/operate/rs/monitoring/prometheus_and_grafana.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -LinkTitle: Get started -Title: Get started with monitoring Redis Enterprise Software -alwaysopen: false -categories: -- docs -- integrate -- rs -description: Use Prometheus and Grafana to collect and visualize Redis Enterprise Software metrics. -group: observability -summary: You can use Prometheus and Grafana to collect and visualize your Redis Enterprise - Software metrics. -type: integration -weight: 5 -tocEmbedHeaders: true ---- - -{{}} diff --git a/content/operate/rs/monitoring/v1_monitoring.md b/content/operate/rs/monitoring/v1_monitoring.md index 646aa614db..fa52f58874 100644 --- a/content/operate/rs/monitoring/v1_monitoring.md +++ b/content/operate/rs/monitoring/v1_monitoring.md @@ -8,7 +8,7 @@ categories: - kubernetes description: Monitor Redis Enterprise Software clusters and databases using internal monitoring systems and external monitoring tools. hideListLinks: true -linkTitle: Monitoring v1 +linkTitle: Monitoring v1 (deprecated) weight: 50 --- @@ -36,7 +36,7 @@ The current monitoring system, which is deprecated as of Redis Enterprise Softwa - v1 Prometheus scraping endpoint: - - Redis Enterprise Software exposes a legacy `/prometheus_metrics` endpoint to integrate with external observability platforms like [Prometheus and Grafana]({{}}). + - Redis Enterprise Software exposes a legacy `/prometheus_metrics` endpoint to integrate with external observability platforms like [Prometheus and Grafana]({{}}). - This endpoint fetches data from the internal storage, providing basic monitoring integration. @@ -68,11 +68,11 @@ This modern monitoring stack introduces: We recommend migrating to the metrics stream engine for enhanced accuracy, scalability, and future-proof observability. -If you are already using the existing scraping endpoint for integration, follow [this guide]({{}}) 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. +If you are already using the existing scraping endpoint for integration, follow [this guide]({{}}) 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]({{}}), some internal cluster manager alerts were deprecated in favor of external monitoring solutions. See the [alerts transition plan]({{}}) for guidance. +As part of Redis Enterprise Software's transition to the [new metrics stream engine]({{}}), some internal cluster manager alerts were deprecated in favor of external monitoring solutions. See the [alerts transition plan]({{}}) for guidance. ## Cluster manager metrics diff --git a/content/operate/rs/references/alerts/alerts-v1-to-v2.md b/content/operate/rs/references/alerts/alerts-v1-to-v2.md index adba9f1404..c1662b2108 100644 --- a/content/operate/rs/references/alerts/alerts-v1-to-v2.md +++ b/content/operate/rs/references/alerts/alerts-v1-to-v2.md @@ -14,10 +14,4 @@ As Redis Enterprise Software transitions from the [deprecated monitoring system] 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 | `sum by(db, cluster) (redis_server_used_memory) / sum by(db, cluster) (redis_server_maxmemory) > 0.8` | Redis server memory usage exceeds 80% | -| NodeMemoryAlert | `(node_memory_MemTotal_bytes - node_memory_MemAvailable_bytes) / node_memory_MemTotal_bytes > 0.7` | Node memory usage exceeds 70% | -| NodeFreeFlashAlert | `(node_available_flash_bytes - node_bigstore_free_bytes) / node_available_flash_bytes > 0.7` | Node flash storage usage exceeds 70% | -| NodeEphemeralStorageAlert | `(node_ephemeral_storage_avail_bytes - node_ephemeral_storage_free_bytes) / node_ephemeral_storage_avail_bytes > 0.7` | Node ephemeral storage usage exceeds 70% | -| NodePersistentStorageAlert | `(node_persistent_storage_avail_bytes - node_persistent_storage_free_bytes) / node_persistent_storage_avail_bytes > 0.7` | Node persistent storage usage exceeds 70% | +{{}} \ No newline at end of file diff --git a/content/operate/rs/references/metrics/_index.md b/content/operate/rs/references/metrics/_index.md index 173ebf938c..6c2b08137a 100644 --- a/content/operate/rs/references/metrics/_index.md +++ b/content/operate/rs/references/metrics/_index.md @@ -16,6 +16,8 @@ weight: $weight In the Redis Enterprise Cluster Manager UI, you can see real-time performance metrics for clusters, nodes, databases, and shards, and configure alerts that send notifications based on alert parameters. Select the **Metrics** tab to view the metrics for each component. For more information, see [Monitoring with metrics and alerts]({{< relref "/operate/rs/monitoring" >}}). +{{The database metrics page.}} + See the following topics for metrics definitions: - [Database operations]({{< relref "/operate/rs/references/metrics/database-operations" >}}) for database metrics - [Resource usage]({{< relref "/operate/rs/references/metrics/resource-usage" >}}) for resource and database usage metrics @@ -26,7 +28,7 @@ See the following topics for metrics definitions: To collect and display metrics data from your databases and other cluster components, you can connect your [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) server to your Redis Enterprise Software cluster. We recommend you use Prometheus and Grafana to view metrics history and trends. -See [Prometheus integration]({{< relref "/operate/rs/monitoring/prometheus_and_grafana" >}}) to learn how to connect Prometheus and Grafana to your Redis Enterprise database. +See [Prometheus integration]({{< relref "/operate/rs/monitoring/get-started" >}}) to learn how to connect Prometheus and Grafana to your Redis Enterprise database. The new metrics stream engine that exposes the v2 Prometheus scraping endpoint at `https://:8070/v2` is generally available as of Redis Enterprise Software version 8.0. This new engine exports all time-series metrics to external monitoring tools such as Grafana, DataDog, NewRelic, and Dynatrace using Prometheus. @@ -45,7 +47,7 @@ If you are already using the existing scraping endpoint for integration, follow ### Shard limit -Metrics information is not shown for clusters with more than 128 shards. For large clusters, we recommend you use [Prometheus and Grafana]({{< relref "/operate/rs/monitoring/prometheus_and_grafana" >}}) to view metrics. +Metrics information is not shown for clusters with more than 128 shards. For large clusters, we recommend you use [Prometheus and Grafana]({{< relref "/operate/rs/monitoring/get-started" >}}) to view metrics. ### Metrics not shown during shard migration diff --git a/content/operate/rs/references/metrics/auto-tiering.md b/content/operate/rs/references/metrics/auto-tiering.md index 5f99520d2e..6953ee791e 100644 --- a/content/operate/rs/references/metrics/auto-tiering.md +++ b/content/operate/rs/references/metrics/auto-tiering.md @@ -10,7 +10,9 @@ linkTitle: Redis Flex and Auto Tiering weight: $weight --- -These metrics are additional metrics for [Redis Flex and Auto Tiering ]({{< relref "/operate/rs/databases/flash" >}}) databases. +The following additional metrics for [Redis Flex and Auto Tiering ]({{< relref "/operate/rs/databases/flash" >}}) databases are available in the Redis Enterprise Cluster Manager UI. + +{{The database metrics page.}} #### % Values in RAM diff --git a/content/operate/rs/references/metrics/database-operations.md b/content/operate/rs/references/metrics/database-operations.md index eeed1776e2..c83a308293 100644 --- a/content/operate/rs/references/metrics/database-operations.md +++ b/content/operate/rs/references/metrics/database-operations.md @@ -11,6 +11,10 @@ linkTitle: Database operations weight: $weight --- +The following metrics are available in the Redis Enterprise Cluster Manager UI. + +{{The database metrics page.}} + ## Evicted objects/sec Number of objects evicted from the database per second. diff --git a/content/operate/rs/references/metrics/prometheus-metrics-v1-to-v2.md b/content/operate/rs/references/metrics/prometheus-metrics-v1-to-v2.md index 122e02eb0e..dd7cbcd08d 100644 --- a/content/operate/rs/references/metrics/prometheus-metrics-v1-to-v2.md +++ b/content/operate/rs/references/metrics/prometheus-metrics-v1-to-v2.md @@ -14,7 +14,7 @@ weight: 49 tocEmbedHeaders: true --- -You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{}}) to create dashboards for important metrics. +You can integrate Redis Enterprise Software with Prometheus and tools such as [Grafana]({{}}), [Datadog]({{}}), [Dynatrace]({{}}), or [New Relic]({{}}) to create dashboards for important metrics. As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. diff --git a/content/operate/rs/references/metrics/prometheus-metrics-v1.md b/content/operate/rs/references/metrics/prometheus-metrics-v1.md index d70e3c6c69..5c3c068b48 100644 --- a/content/operate/rs/references/metrics/prometheus-metrics-v1.md +++ b/content/operate/rs/references/metrics/prometheus-metrics-v1.md @@ -14,7 +14,7 @@ weight: 48 tocEmbedHeaders: true --- -You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{}}) to create dashboards for important metrics. +You can integrate Redis Enterprise Software with Prometheus and tools such as [Grafana]({{}}), [Datadog]({{}}), [Dynatrace]({{}}), or [New Relic]({{}}) to create dashboards for important metrics. 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]({{}}). diff --git a/content/operate/rs/references/metrics/prometheus-metrics-v2.md b/content/operate/rs/references/metrics/prometheus-metrics-v2.md index 599944df36..69b9290d13 100644 --- a/content/operate/rs/references/metrics/prometheus-metrics-v2.md +++ b/content/operate/rs/references/metrics/prometheus-metrics-v2.md @@ -14,7 +14,7 @@ weight: 50 tocEmbedHeaders: true --- -You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{}}) to create dashboards for important metrics. +You can integrate Redis Enterprise Software with Prometheus and tools such as [Grafana]({{}}), [Datadog]({{}}), [Dynatrace]({{}}), or [New Relic]({{}}) to create dashboards for important metrics. The v2 metrics in the following tables are available as of Redis Enterprise Software version 7.8.0. For help transitioning from v1 metrics to v2 PromQL, see [Prometheus v1 metrics and equivalent v2 PromQL]({{}}). diff --git a/content/operate/rs/references/metrics/resource-usage.md b/content/operate/rs/references/metrics/resource-usage.md index d60af1aa0a..de5e368e0c 100644 --- a/content/operate/rs/references/metrics/resource-usage.md +++ b/content/operate/rs/references/metrics/resource-usage.md @@ -10,6 +10,8 @@ linkTitle: Resource usage weight: $weight --- +The following metrics are available in the Redis Enterprise Cluster Manager UI. + ## Connections Number of connections to the database. diff --git a/content/operate/rs/references/rest-api/objects/statistics/_index.md b/content/operate/rs/references/rest-api/objects/statistics/_index.md index 5afc5fe05f..7f87256576 100644 --- a/content/operate/rs/references/rest-api/objects/statistics/_index.md +++ b/content/operate/rs/references/rest-api/objects/statistics/_index.md @@ -11,6 +11,10 @@ linkTitle: statistics weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + ## Statistics overview Clusters, databases, nodes, and shards collect various statistics at regular time intervals. View the statistics for these objects using `GET stats` requests to their respective endpoints: diff --git a/content/operate/rs/references/rest-api/objects/statistics/cluster-metrics.md b/content/operate/rs/references/rest-api/objects/statistics/cluster-metrics.md index 85211e93ab..ba24da7895 100644 --- a/content/operate/rs/references/rest-api/objects/statistics/cluster-metrics.md +++ b/content/operate/rs/references/rest-api/objects/statistics/cluster-metrics.md @@ -11,6 +11,10 @@ linkTitle: cluster metrics weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Metric name | Type | Description | |-------------|------|-------------| | available_flash | float | Sum of available flash in all nodes (bytes) | diff --git a/content/operate/rs/references/rest-api/objects/statistics/db-metrics.md b/content/operate/rs/references/rest-api/objects/statistics/db-metrics.md index c4b6bb35ac..38bec4350b 100644 --- a/content/operate/rs/references/rest-api/objects/statistics/db-metrics.md +++ b/content/operate/rs/references/rest-api/objects/statistics/db-metrics.md @@ -11,6 +11,10 @@ linkTitle: DB metrics weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Metric name | Type | Description | |-------------|------|-------------| | avg_latency | float | Average latency of operations on the DB (microseconds). Only returned when there is traffic. | diff --git a/content/operate/rs/references/rest-api/objects/statistics/node-metrics.md b/content/operate/rs/references/rest-api/objects/statistics/node-metrics.md index 362d3c9c74..7afefd9eb0 100644 --- a/content/operate/rs/references/rest-api/objects/statistics/node-metrics.md +++ b/content/operate/rs/references/rest-api/objects/statistics/node-metrics.md @@ -11,6 +11,10 @@ linkTitle: node metrics weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Metric name | Type | Description | |-------------|------|-------------| | available_flash | float | Available flash on the node (bytes) | diff --git a/content/operate/rs/references/rest-api/objects/statistics/shard-metrics.md b/content/operate/rs/references/rest-api/objects/statistics/shard-metrics.md index 484ee1b021..4d896acb10 100644 --- a/content/operate/rs/references/rest-api/objects/statistics/shard-metrics.md +++ b/content/operate/rs/references/rest-api/objects/statistics/shard-metrics.md @@ -11,6 +11,10 @@ linkTitle: shard metrics weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Metric name | Type | Description | |-------------|------|-------------| | aof_rewrite_inprog | float | The number of simultaneous AOF rewrites that are in progress | diff --git a/content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md b/content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md index 8e389873dc..14b1b3356a 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md @@ -12,6 +12,10 @@ linkTitle: stats weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-all-bdbs-stats) | `/v1/bdbs/stats` | Get stats for all databases | diff --git a/content/operate/rs/references/rest-api/requests/cluster/stats/_index.md b/content/operate/rs/references/rest-api/requests/cluster/stats/_index.md index c500ef9887..c38f242f3d 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/cluster/stats/_index.md @@ -12,6 +12,10 @@ linkTitle: stats weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-cluster-stats) | `/v1/cluster/stats` | Get cluster stats | diff --git a/content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md b/content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md index 74bd7208e7..34ba20ef95 100644 --- a/content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md @@ -12,6 +12,10 @@ linkTitle: endpoints/stats weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-endpoints-stats) | `/v1/endpoints/stats` | Get stats for all endpoints | diff --git a/content/operate/rs/references/rest-api/requests/nodes/stats/_index.md b/content/operate/rs/references/rest-api/requests/nodes/stats/_index.md index 92484bac33..cdcc03bf0f 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/nodes/stats/_index.md @@ -12,6 +12,10 @@ linkTitle: stats weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-all-nodes-stats) | `/v1/nodes/stats` | Get stats for all nodes | diff --git a/content/operate/rs/references/rest-api/requests/shards/stats/_index.md b/content/operate/rs/references/rest-api/requests/shards/stats/_index.md index 045b9eacbf..7fff5f7a6a 100644 --- a/content/operate/rs/references/rest-api/requests/shards/stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/shards/stats/_index.md @@ -12,6 +12,10 @@ linkTitle: stats weight: $weight --- +{{}} +The v1 statistics REST API endpoints are deprecated as of Redis Enterprise Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +{{}} + | Method | Path | Description | |--------|------|-------------| | [GET](#get-all-shards-stats) | `/v1/shards/stats` | Get stats for all shards | diff --git a/content/operate/rs/release-notes/rs-8-0-releases/_index.md b/content/operate/rs/release-notes/rs-8-0-releases/_index.md index 3753f7f009..73c593b2fe 100644 --- a/content/operate/rs/release-notes/rs-8-0-releases/_index.md +++ b/content/operate/rs/release-notes/rs-8-0-releases/_index.md @@ -153,7 +153,7 @@ See [Ports and port ranges used by Redis Enterprise Software]({{}}) is deprecated. We recommend transitioning to the new [metrics stream engine]({{}}) for improved performance, enhanced integration capabilities, and modernized metrics streaming. -V1 Prometheus metrics are deprecated but still available. To transition to the new metrics stream engine, either migrate your existing dashboards using [this guide]({{}}) or use [new preconfigured dashboards]({{}}). +V1 Prometheus metrics are deprecated but still available. To transition to the new metrics stream engine, either migrate your existing dashboards using [this guide]({{}}) or use [new preconfigured dashboards]({{}}). 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]({{}}) for guidance. diff --git a/content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-2-17.md b/content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-2-17.md index 7c415b4e9d..ecc764b801 100644 --- a/content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-2-17.md +++ b/content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-2-17.md @@ -156,7 +156,7 @@ The [metrics stream engine]({{}}). -- To transition to the metrics stream engine, either migrate your existing dashboards using [Prometheus v1 metrics and equivalent v2 PromQL]({{}}) or use [new preconfigured dashboards]({{}}). +- To transition to the metrics stream engine, either migrate your existing dashboards using [Prometheus v1 metrics and equivalent v2 PromQL]({{}}) or use [new preconfigured dashboards]({{}}). - 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]({{}}) for guidance. @@ -464,7 +464,7 @@ See [Ports and port ranges used by Redis Enterprise Software]({{}}) is deprecated. We recommend transitioning to the new [metrics stream engine]({{}}) for improved performance, enhanced integration capabilities, and modernized metrics streaming. -V1 Prometheus metrics are deprecated but still available. To transition to the new metrics stream engine, either migrate your existing dashboards using [this guide]({{}}) or use [new preconfigured dashboards]({{}}). +V1 Prometheus metrics are deprecated but still available. To transition to the new metrics stream engine, either migrate your existing dashboards using [this guide]({{}}) or use [new preconfigured dashboards]({{}}). 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]({{}}) for guidance. diff --git a/static/images/rs/screenshots/metrics/db-metrics.png b/static/images/rs/screenshots/metrics/db-metrics.png new file mode 100644 index 0000000000..e8808efd58 Binary files /dev/null and b/static/images/rs/screenshots/metrics/db-metrics.png differ diff --git a/static/images/rs/screenshots/metrics/flash-db-metrics.png b/static/images/rs/screenshots/metrics/flash-db-metrics.png new file mode 100644 index 0000000000..b624ac2266 Binary files /dev/null and b/static/images/rs/screenshots/metrics/flash-db-metrics.png differ