﻿---
title: Redis Enterprise
description: Redis Enterprise integration provides monitoring of redis cluster. Monitoring is done via prometheus exported port of redis enterprise cluster. Once a...
url: https://www.elastic.co/docs/reference/integrations/redisenterprise
---

# Redis Enterprise


|                                                                                                                                     |                                                         |
|-------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| **Version**Version                                                                                                                  | 0.12.0 `product: beta` ([View all](#changelog)View all) |
| **Subscription level**Subscription level[What's this?](https://www.elastic.co/subscriptions)What's this?                            | Basic                                                   |
| **Level of support**Level of support[What's this?](https://www.elastic.co/docs/reference/integrations/level-of-support)What's this? | Elastic                                                 |
| **Ingestion method(s)**Ingestion method(s)                                                                                          | Prometheus                                              |

Redis Enterprise integration provides monitoring of [redis](https://redis.com/) cluster. Monitoring is done via prometheus exported port of redis enterprise cluster. Once a redis enterprise [cluster](https://redis.com/redis-enterprise/technology/redis-enterprise-cluster-architecture/) is installed, prometheus port is available for monitoring. The url of the host:port(8070) needs to be passed to the hosts in the settings.

## Compatibility

Tested with Redis Enterprise v7.2.4.

# Metrics


## Node Metrics

Captures all the node specific exported metrics, matching pattern **"node_*"**
<dropdown title="Example">

  ```json
  {
      "@timestamp": "2023-10-27T08:01:51.865Z",
      "agent": {
          "ephemeral_id": "cc4072b4-71a6-40be-ad91-7245b283f11d",
          "id": "8412e9e5-6fd3-4587-bc60-1fba76200570",
          "name": "docker-fleet-agent",
          "type": "metricbeat",
          "version": "8.10.4"
      },
      "data_stream": {
          "dataset": "redisenterprise.node",
          "namespace": "default",
          "type": "metrics"
      },
      "ecs": {
          "version": "8.11.0"
      },
      "elastic_agent": {
          "id": "8412e9e5-6fd3-4587-bc60-1fba76200570",
          "snapshot": false,
          "version": "8.10.4"
      },
      "event": {
          "agent_id_status": "verified",
          "dataset": "redisenterprise.node",
          "duration": 240631792,
          "ingested": "2023-10-27T08:01:52Z",
          "module": "prometheus"
      },
      "host": {
          "architecture": "aarch64",
          "containerized": false,
          "hostname": "docker-fleet-agent",
          "id": "5bf910baf91142d6b435357818c88ef5",
          "ip": [
              "172.19.0.7"
          ],
          "mac": [
              "02-42-AC-13-00-07"
          ],
          "name": "docker-fleet-agent",
          "os": {
              "codename": "focal",
              "family": "debian",
              "kernel": "5.10.104-linuxkit",
              "name": "Ubuntu",
              "platform": "ubuntu",
              "type": "linux",
              "version": "20.04.6 LTS (Focal Fossa)"
          }
      },
      "metricset": {
          "name": "collector",
          "period": 10000
      },
      "redisenterprise": {
          "node": {
              "available_memory": {
                  "value": 146729029.556
              },
              "conns": {
                  "value": 0
              },
              "cpu_idle": {
                  "value": 0.7493333333333334
              },
              "cpu_idle_max": {
                  "value": 0.751
              },
              "cpu_iowait_min": {
                  "value": 0.001
              },
              "cpu_irqs_min": {
                  "value": 0.003
              },
              "cpu_nice": {
                  "value": 0
              },
              "cpu_nice_min": {
                  "value": 0
              },
              "cpu_steal_max": {
                  "value": 0
              },
              "cpu_steal_median": {
                  "value": 0
              },
              "cpu_steal_min": {
                  "value": 0
              },
              "cpu_system": {
                  "value": 0.03566666666666667
              },
              "cpu_system_max": {
                  "value": 0.037
              },
              "cpu_system_median": {
                  "value": 0.036
              },
              "cpu_system_min": {
                  "value": 0.034
              },
              "cpu_user": {
                  "value": 0.19533333333333336
              },
              "cpu_user_max": {
                  "value": 0.199
              },
              "cpu_user_median": {
                  "value": 0.195
              },
              "cpu_user_min": {
                  "value": 0.192
              },
              "cur_aof_rewrites": {
                  "value": 0
              },
              "egress_bytes": {
                  "value": 1342.5556666666669
              },
              "egress_bytes_median": {
                  "value": 1569.778
              },
              "egress_bytes_min": {
                  "value": 885.889
              },
              "ephemeral_storage_avail": {
                  "value": 50210169287.111
              },
              "free_memory": {
                  "value": 257662065.778
              },
              "ingress_bytes": {
                  "value": 258.815
              },
              "ingress_bytes_min": {
                  "value": 242
              },
              "labels": {
                  "cluster": "cluster.local",
                  "instance": "host.docker.internal:8070",
                  "job": "prometheus",
                  "node": "1"
              },
              "persistent_storage_avail": {
                  "value": 50210169287.111
              },
              "persistent_storage_free": {
                  "value": 53426885063.111
              },
              "total_req": {
                  "value": 0
              }
          }
      },
      "service": {
          "address": "https://host.docker.internal:8070/metrics",
          "type": "prometheus"
      }
  }
  ```
</dropdown>

**ECS Field Reference**
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
<dropdown title="Exported fields">


  | Field                                    | Description                                                                                                                                                                                               | Type             | Metric Type |
  |------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------|
  | @timestamp                               | Event timestamp.                                                                                                                                                                                          | date             |             |
  | agent.id                                 | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id.                                                                                                                | keyword          |             |
  | cloud.account.id                         | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.                        | keyword          |             |
  | cloud.availability_zone                  | Availability zone in which this host, resource, or service is located.                                                                                                                                    | keyword          |             |
  | cloud.instance.id                        | Instance ID of the host machine.                                                                                                                                                                          | keyword          |             |
  | cloud.provider                           | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.                                                                                                                          | keyword          |             |
  | cloud.region                             | Region in which this host, resource, or service is located.                                                                                                                                               | keyword          |             |
  | container.id                             | Unique container id.                                                                                                                                                                                      | keyword          |             |
  | data_stream.dataset                      | Data stream dataset.                                                                                                                                                                                      | constant_keyword |             |
  | data_stream.namespace                    | Data stream namespace.                                                                                                                                                                                    | constant_keyword |             |
  | data_stream.type                         | Data stream type.                                                                                                                                                                                         | constant_keyword |             |
  | event.dataset                            | Event dataset                                                                                                                                                                                             | constant_keyword |             |
  | event.module                             | Event module                                                                                                                                                                                              | constant_keyword |             |
  | host.name                                | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword          |             |
  | redisenterprise.node.*.value             | Node metrics.                                                                                                                                                                                             | object           | gauge       |
  | redisenterprise.node.labels.addr         | Network address or IP address of the node.                                                                                                                                                                | keyword          |             |
  | redisenterprise.node.labels.cluster      | name of the cluster to which the node belongs.                                                                                                                                                            | keyword          |             |
  | redisenterprise.node.labels.cnm_version  | Version of the Redis Enterprise cluster node management software that the node is running.                                                                                                                | keyword          |             |
  | redisenterprise.node.labels.instance     | The <host>:<port> or network address or endpoint of the Redis Enterprise node.                                                                                                                            | keyword          |             |
  | redisenterprise.node.labels.job          | Configured job name like prometheus.                                                                                                                                                                      | keyword          |             |
  | redisenterprise.node.labels.logical_name | Logical name or role of the node within the cluster.                                                                                                                                                      | keyword          |             |
  | redisenterprise.node.labels.node         | Specific node within the cluster                                                                                                                                                                          | keyword          |             |
  | redisenterprise.node.labels.path         | Specifies the file path to the certificate file associated with the node and role.                                                                                                                        | keyword          |             |
  | service.address                          | Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets).                                                  | keyword          |             |
</dropdown>


## Proxy Metrics

Captures all the proxy specific exported metrics, matching pattern **"listener_*"**
<dropdown title="Example">

  ```json
  {
      "@timestamp": "2023-10-27T09:02:20.616Z",
      "agent": {
          "ephemeral_id": "d53c023d-a17d-40d1-b9bc-4850df49633a",
          "id": "e275fc30-5606-41f2-a4f9-c30819350b25",
          "name": "docker-fleet-agent",
          "type": "metricbeat",
          "version": "8.10.4"
      },
      "data_stream": {
          "dataset": "redisenterprise.proxy",
          "namespace": "default",
          "type": "metrics"
      },
      "ecs": {
          "version": "8.11.0"
      },
      "elastic_agent": {
          "id": "e275fc30-5606-41f2-a4f9-c30819350b25",
          "snapshot": false,
          "version": "8.10.4"
      },
      "event": {
          "agent_id_status": "verified",
          "dataset": "redisenterprise.proxy",
          "duration": 395309250,
          "ingested": "2023-10-27T09:02:21Z",
          "module": "prometheus"
      },
      "host": {
          "architecture": "aarch64",
          "containerized": false,
          "hostname": "docker-fleet-agent",
          "id": "5bf910baf91142d6b435357818c88ef5",
          "ip": [
              "172.22.0.7"
          ],
          "mac": [
              "02-42-AC-16-00-07"
          ],
          "name": "docker-fleet-agent",
          "os": {
              "codename": "focal",
              "family": "debian",
              "kernel": "5.10.104-linuxkit",
              "name": "Ubuntu",
              "platform": "ubuntu",
              "type": "linux",
              "version": "20.04.6 LTS (Focal Fossa)"
          }
      },
      "metricset": {
          "name": "collector",
          "period": 10000
      },
      "redisenterprise": {
          "proxy": {
              "labels": {
                  "bdb": "1",
                  "cluster": "cluster.local",
                  "endpoint": "1:1",
                  "instance": "host.docker.internal:8070",
                  "job": "prometheus",
                  "node": "1",
                  "port": "12000",
                  "proxy": "1:1:1"
              },
              "listener_acc_latency": {
                  "counter": 0
              },
              "listener_acc_latency_max": {
                  "counter": 0
              },
              "listener_acc_other_latency": {
                  "counter": 0
              },
              "listener_acc_other_latency_max": {
                  "counter": 0
              },
              "listener_acc_read_latency": {
                  "counter": 0
              },
              "listener_acc_read_latency_max": {
                  "counter": 0
              },
              "listener_acc_write_latency": {
                  "counter": 0
              },
              "listener_acc_write_latency_max": {
                  "counter": 0
              },
              "listener_auth_cmds": {
                  "counter": 0
              },
              "listener_auth_cmds_max": {
                  "counter": 0
              },
              "listener_auth_errors": {
                  "counter": 0
              },
              "listener_auth_errors_max": {
                  "counter": 0
              },
              "listener_cmd_flush": {
                  "counter": 0
              },
              "listener_cmd_flush_max": {
                  "counter": 0
              },
              "listener_cmd_get": {
                  "counter": 0
              },
              "listener_cmd_get_max": {
                  "counter": 0
              },
              "listener_cmd_set": {
                  "counter": 0
              },
              "listener_cmd_set_max": {
                  "counter": 0
              },
              "listener_cmd_touch": {
                  "counter": 0
              },
              "listener_cmd_touch_max": {
                  "counter": 0
              },
              "listener_conns": {
                  "counter": 0
              },
              "listener_egress_bytes": {
                  "counter": 0
              },
              "listener_egress_bytes_max": {
                  "counter": 0
              },
              "listener_ingress_bytes": {
                  "counter": 0
              },
              "listener_ingress_bytes_max": {
                  "counter": 0
              },
              "listener_last_req_time": {
                  "counter": 0
              },
              "listener_last_res_time": {
                  "counter": 0
              },
              "listener_max_connections_exceeded": {
                  "counter": 0
              },
              "listener_max_connections_exceeded_max": {
                  "counter": 0
              },
              "listener_monitor_sessions_count": {
                  "counter": 0
              },
              "listener_other_req": {
                  "counter": 0
              },
              "listener_other_req_max": {
                  "counter": 0
              },
              "listener_other_res": {
                  "counter": 0
              },
              "listener_other_res_max": {
                  "counter": 0
              },
              "listener_other_started_res": {
                  "counter": 0
              },
              "listener_other_started_res_max": {
                  "counter": 0
              },
              "listener_read_req": {
                  "counter": 0
              },
              "listener_read_req_max": {
                  "counter": 0
              },
              "listener_read_res": {
                  "counter": 0
              },
              "listener_read_res_max": {
                  "counter": 0
              },
              "listener_read_started_res": {
                  "counter": 0
              },
              "listener_read_started_res_max": {
                  "counter": 0
              },
              "listener_resp2_clients": {
                  "counter": 0
              },
              "listener_resp2_clients_max": {
                  "counter": 0
              },
              "listener_resp3_clients": {
                  "counter": 0
              },
              "listener_resp3_clients_max": {
                  "counter": 0
              },
              "listener_sconn_hello_failed": {
                  "counter": 0
              },
              "listener_sconn_hello_failed_max": {
                  "counter": 0
              },
              "listener_sconn_hello_setresp": {
                  "counter": 0
              },
              "listener_sconn_hello_setresp_max": {
                  "counter": 0
              },
              "listener_sconn_hello_setuser": {
                  "counter": 0
              },
              "listener_sconn_hello_setuser_max": {
                  "counter": 0
              },
              "listener_total_connections_received": {
                  "counter": 0
              },
              "listener_total_connections_received_max": {
                  "counter": 0
              },
              "listener_total_req": {
                  "counter": 0
              },
              "listener_total_req_max": {
                  "counter": 0
              },
              "listener_total_res": {
                  "counter": 0
              },
              "listener_total_res_max": {
                  "counter": 0
              },
              "listener_total_started_res": {
                  "counter": 0
              },
              "listener_total_started_res_max": {
                  "counter": 0
              },
              "listener_write_req": {
                  "counter": 0
              },
              "listener_write_req_max": {
                  "counter": 0
              },
              "listener_write_res": {
                  "counter": 0
              },
              "listener_write_res_max": {
                  "counter": 0
              },
              "listener_write_started_res": {
                  "counter": 0
              },
              "listener_write_started_res_max": {
                  "counter": 0
              }
          }
      },
      "service": {
          "address": "https://host.docker.internal:8070/metrics",
          "type": "prometheus"
      }
  }
  ```
</dropdown>

**ECS Field Reference**
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
<dropdown title="Exported fields">


  | Field                                 | Description                                                                                                                                                                                               | Type             | Metric Type |
  |---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------|
  | @timestamp                            | Event timestamp.                                                                                                                                                                                          | date             |             |
  | agent.id                              | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id.                                                                                                                | keyword          |             |
  | cloud.account.id                      | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.                        | keyword          |             |
  | cloud.availability_zone               | Availability zone in which this host, resource, or service is located.                                                                                                                                    | keyword          |             |
  | cloud.instance.id                     | Instance ID of the host machine.                                                                                                                                                                          | keyword          |             |
  | cloud.provider                        | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.                                                                                                                          | keyword          |             |
  | cloud.region                          | Region in which this host, resource, or service is located.                                                                                                                                               | keyword          |             |
  | container.id                          | Unique container id.                                                                                                                                                                                      | keyword          |             |
  | data_stream.dataset                   | Data stream dataset.                                                                                                                                                                                      | constant_keyword |             |
  | data_stream.namespace                 | Data stream namespace.                                                                                                                                                                                    | constant_keyword |             |
  | data_stream.type                      | Data stream type.                                                                                                                                                                                         | constant_keyword |             |
  | event.dataset                         | Event dataset                                                                                                                                                                                             | constant_keyword |             |
  | event.module                          | Event module                                                                                                                                                                                              | constant_keyword |             |
  | host.name                             | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword          |             |
  | redisenterprise.proxy.*.counter       | Proxy metrics.                                                                                                                                                                                            | object           | counter     |
  | redisenterprise.proxy.labels.bdb      | Managed database, indicating which database is being referred to.                                                                                                                                         | keyword          |             |
  | redisenterprise.proxy.labels.cluster  | Cluster name.                                                                                                                                                                                             | keyword          |             |
  | redisenterprise.proxy.labels.endpoint | Endpoint id.                                                                                                                                                                                              | keyword          |             |
  | redisenterprise.proxy.labels.instance | Host address of cluster's instance expressed in the form of an IP:PORT.                                                                                                                                   | keyword          |             |
  | redisenterprise.proxy.labels.job      | Type of the job.                                                                                                                                                                                          | keyword          |             |
  | redisenterprise.proxy.labels.node     | The node that is being monitored.                                                                                                                                                                         | keyword          |             |
  | redisenterprise.proxy.labels.port     | The port number to connect to the database.                                                                                                                                                               | keyword          |             |
  | redisenterprise.proxy.labels.proxy    | Proxy that is bound to the database..                                                                                                                                                                     | keyword          |             |
  | service.address                       | Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets).                                                  | keyword          |             |
</dropdown>


## Screenshots

This integration includes one or more Kibana dashboards that visualizes the data collected by the integration. The screenshots below illustrate how the ingested data is displayed.
<carousel>

  ![kibana redis enterprise](https://epr.elastic.co/package/redisenterprise/0.12.0/img/redisenterprise-dashboard.png)
</carousel>


## Changelog

<dropdown title="Changelog">


  | Version          | Details                                                                                                                                                                                                                                                                                                                                                                                  | Kibana version(s) |
  |------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
  | **0.12.0**0.12.0 | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/12468)View pull request)Add support for Kibana `9.0.0`.                                                                                                                                                                                                                                     |                   |
  | **0.11.0**0.11.0 | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/10411)View pull request)Add processor support for node and proxy data streams.                                                                                                                                                                                                              |                   |
  | **0.10.0**0.10.0 | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/10162)View pull request)ECS version updated to 8.11.0. Update the kibana constraint to ^8.13.0. Modified the field definitions to remove ECS fields made redundant by the ecs@mappings component template.                                                                                  |                   |
  | **0.9.1**0.9.1   | **Bug fix**Bug fix ([View pull request](https://github.com/elastic/integrations/pull/9464)View pull request)Fix intervals in the visualizations of the Overview dashboard.                                                                                                                                                                                                               |                   |
  | **0.9.0**0.9.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/8584)View pull request)Enable time series data streams for the metrics datasets. This dramatically reduces storage for metrics and is expected to progressively improve query performance. For more details, see https://www.elastic.co/guide/en/elasticsearch/reference/current/tsds.html. |                   |
  | **0.8.4**0.8.4   | **Bug fix**Bug fix ([View pull request](https://github.com/elastic/integrations/pull/8586)View pull request)Update aggregator function to fix a visualisation error.                                                                                                                                                                                                                     |                   |
  | **0.8.3**0.8.3   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/8539)View pull request)Add `metric_type` mapping for the fields of `proxy` datastream.                                                                                                                                                                                                      |                   |
  | **0.8.2**0.8.2   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/8148)View pull request)Add dimension fields to proxy datastream for TSDB support.                                                                                                                                                                                                           |                   |
  | **0.8.1**0.8.1   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/8133)View pull request)Add `metric_type` mapping for the fields of `node` datastream.                                                                                                                                                                                                       |                   |
  | **0.8.0**0.8.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/8091)View pull request)Add dimension fields to node datastream for TSDB support.                                                                                                                                                                                                            |                   |
  | **0.7.0**0.7.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/8213)View pull request)Enable use_types flag for node and proxy datastreams.                                                                                                                                                                                                                |                   |
  | **0.6.0**0.6.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/8203)View pull request)Update the package format_version to 3.0.0.                                                                                                                                                                                                                          |                   |
  | **0.5.0**0.5.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/6298)View pull request)Rename ownership from obs-service-integrations to obs-infraobs-integrations                                                                                                                                                                                          |                   |
  | **0.4.1**0.4.1   | **Bug fix**Bug fix ([View pull request](https://github.com/elastic/integrations/pull/5737)View pull request)Add description for visualizations.                                                                                                                                                                                                                                          |                   |
  | **0.4.0**0.4.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/5678)View pull request)Migrate visualizations to lens.                                                                                                                                                                                                                                      |                   |
  | **0.3.1**0.3.1   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/5123)View pull request)Added categories and/or subcategories.                                                                                                                                                                                                                               |                   |
  | **0.3.0**0.3.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/5041)View pull request)Update ECS version to 8.5.1                                                                                                                                                                                                                                          |                   |
  | **0.2.0**0.2.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/4485)View pull request)Added infrastructure category.                                                                                                                                                                                                                                       |                   |
  | **0.1.1**0.1.1   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/3617)View pull request)Minor changes                                                                                                                                                                                                                                                        |                   |
  | **0.1.0**0.1.0   | **Enhancement**Enhancement ([View pull request](https://github.com/elastic/integrations/pull/3617)View pull request)Initial working of the package                                                                                                                                                                                                                                       |                   |
</dropdown>
