You are viewing docs on Elastic's new documentation system, currently in technical preview. For all other Elastic docs, visit elastic.co/guide.

Redis Enterprise

Collect metrics from Redis Enterprise Cluster

Version
0.6.0 (View all)
Compatible Kibana version(s)
8.3.0 or higher
Subscription level
Basic

Redis Enterprise integration provides monitoring of redis cluster. Monitoring is done via prometheus exported port of redis enterprise cluster. Once a redis enterprise cluster 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.

Redis Enterpise integration is tested with redislabs/redis:5.2.2-24 version.

Metrics

Node Metrics

Captures all the node specific exported metrics, matching pattern "node_*"

An example event for node looks as following:

{
    "agent": {
        "name": "docker-fleet-agent",
        "id": "56370311-c973-4a5b-b93b-e42fd47da568",
        "ephemeral_id": "5d1146d0-7ec9-44be-baa0-3aefc54e6ffd",
        "type": "metricbeat",
        "version": "8.3.0"
    },
    "elastic_agent": {
        "id": "56370311-c973-4a5b-b93b-e42fd47da568",
        "version": "8.3.0",
        "snapshot": true
    },
    "@timestamp": "2022-07-12T07:33:25.716Z",
    "ecs": {
        "version": "8.5.1"
    },
    "service": {
        "address": "https://host.docker.internal:8070/metrics",
        "type": "prometheus"
    },
    "data_stream": {
        "namespace": "default",
        "type": "metrics",
        "dataset": "redisenterprise.node"
    },
    "host": {
        "hostname": "docker-fleet-agent",
        "os": {
            "kernel": "5.10.104-linuxkit",
            "codename": "focal",
            "name": "Ubuntu",
            "family": "debian",
            "type": "linux",
            "version": "20.04.4 LTS (Focal Fossa)",
            "platform": "ubuntu"
        },
        "ip": [
            "172.21.0.7"
        ],
        "containerized": false,
        "name": "docker-fleet-agent",
        "mac": [
            "02:42:ac:15:00:07"
        ],
        "architecture": "x86_64"
    },
    "redisenterprise": {
        "node": {
            "metrics": {
                "provisional_memory": 7075143156.111,
                "cpu_nice_median": 0,
                "cpu_system_min": 0.081,
                "cpu_irqs_max": 0.003,
                "persistent_storage_free": 224708261372814.22,
                "cpu_user_min": 0.528,
                "egress_bytes_median": 9161.667,
                "cpu_user_median": 0.533,
                "cpu_iowait_median": 0.001,
                "ephemeral_storage_free": 195630087281.778,
                "egress_bytes_min": 620.556,
                "cpu_steal_median": 0,
                "cpu_idle_min": 0.101,
                "cpu_irqs_median": 0.002,
                "ingress_bytes_min": 622.667,
                "provisional_memory_no_overbooking": 7073454693.889,
                "conns": 0,
                "cpu_iowait_max": 0.001,
                "cpu_steal_min": 0,
                "cpu_steal": 0,
                "cpu_iowait": 0.0006666666666666666,
                "cpu_irqs": 0.0023333333333333335,
                "egress_bytes_max": 18004,
                "cpu_user": 0.6206666666666667,
                "free_memory": 10688636245.333,
                "ingress_bytes_max": 1340,
                "available_memory_no_overbooking": 10632216778.889,
                "ingress_bytes_median": 996.444,
                "cpu_idle": 0.2823333333333333,
                "cpu_nice_max": 0,
                "cpu_system": 0.08666666666666667,
                "cpu_idle_median": 0.373,
                "cpu_iowait_min": 0,
                "cpu_nice_min": 0,
                "cur_aof_rewrites": 0,
                "cpu_system_max": 0.092,
                "persistent_storage_avail": 224708261372814.22,
                "cpu_nice": 0,
                "cpu_steal_max": 0,
                "cpu_irqs_min": 0.002,
                "cpu_idle_max": 0.373,
                "available_memory": 10633905241.111,
                "ingress_bytes": 986.3703333333333,
                "ephemeral_storage_avail": 184875945073.778,
                "egress_bytes": 9262.074333333332,
                "cpu_user_max": 0.801,
                "cpu_system_median": 0.087,
                "total_req": 0
            },
            "labels": {
                "cluster": "run1.local",
                "node": "1",
                "instance": "host.docker.internal:8070",
                "job": "prometheus"
            }
        }
    },
    "metricset": {
        "period": 10000,
        "name": "collector"
    },
    "event": {
        "duration": 182194083,
        "agent_id_status": "verified",
        "ingested": "2022-07-12T07:33:26Z",
        "module": "prometheus",
        "dataset": "redisenterprise.node"
    }
}

Exported fields

FieldDescriptionType
@timestamp
Event timestamp.
date
data_stream.dataset
Data stream dataset.
constant_keyword
data_stream.namespace
Data stream namespace.
constant_keyword
data_stream.type
Data stream type.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
event.dataset
Event dataset
constant_keyword
event.module
Event module
constant_keyword
redisenterprise.node.labels.*
Label fields
object
redisenterprise.node.metrics.*
Node prometheus metrics
float
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
service.type
The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch.
keyword

Proxy Metrics

Captures all the proxy specific exported metrics, matching pattern "listener_*"

An example event for proxy looks as following:

{
    "agent": {
        "name": "docker-fleet-agent",
        "id": "56370311-c973-4a5b-b93b-e42fd47da568",
        "type": "metricbeat",
        "ephemeral_id": "5d1146d0-7ec9-44be-baa0-3aefc54e6ffd",
        "version": "8.3.0"
    },
    "elastic_agent": {
        "id": "56370311-c973-4a5b-b93b-e42fd47da568",
        "version": "8.3.0",
        "snapshot": true
    },
    "@timestamp": "2022-07-12T07:34:55.576Z",
    "ecs": {
        "version": "8.5.1"
    },
    "data_stream": {
        "namespace": "default",
        "type": "metrics",
        "dataset": "redisenterprise.proxy"
    },
    "service": {
        "address": "https://host.docker.internal:8070/metrics",
        "type": "prometheus"
    },
    "host": {
        "hostname": "docker-fleet-agent",
        "os": {
            "kernel": "5.10.104-linuxkit",
            "codename": "focal",
            "name": "Ubuntu",
            "type": "linux",
            "family": "debian",
            "version": "20.04.4 LTS (Focal Fossa)",
            "platform": "ubuntu"
        },
        "containerized": false,
        "ip": [
            "172.21.0.7"
        ],
        "name": "docker-fleet-agent",
        "mac": [
            "02:42:ac:15:00:07"
        ],
        "architecture": "x86_64"
    },
    "redisenterprise": {
        "proxy": {
            "metrics": {
                "listener_egress_bytes": 0,
                "listener_last_req_time": 0,
                "listener_other_res": 0,
                "listener_ingress_bytes_max": 0,
                "listener_total_connections_received_max": 0,
                "listener_other_req": 0,
                "listener_other_res_max": 0,
                "listener_write_req_max": 0,
                "listener_cmd_touch_max": 0,
                "listener_egress_bytes_max": 0,
                "listener_auth_cmds_max": 0,
                "listener_read_res": 0,
                "listener_read_req": 0,
                "listener_max_connections_exceeded_max": 0,
                "listener_total_res": 0,
                "listener_total_req": 0,
                "listener_read_started_res_max": 0,
                "listener_acc_other_latency": 0,
                "listener_cmd_get_max": 0,
                "listener_acc_latency": 0,
                "listener_read_req_max": 0,
                "listener_write_res_max": 0,
                "listener_total_started_res_max": 0,
                "listener_write_started_res_max": 0,
                "listener_total_res_max": 0,
                "listener_write_started_res": 0,
                "listener_write_req": 0,
                "listener_cmd_flush": 0,
                "listener_write_res": 0,
                "listener_cmd_touch": 0,
                "listener_cmd_flush_max": 0,
                "listener_last_res_time": 0,
                "listener_auth_errors_max": 0,
                "listener_acc_read_latency_max": 0,
                "listener_acc_write_latency_max": 0,
                "listener_total_connections_received": 0,
                "listener_conns": 0,
                "listener_total_req_max": 0,
                "listener_acc_write_latency": 0,
                "listener_acc_other_latency_max": 0,
                "listener_read_res_max": 0,
                "listener_monitor_sessions_count": 0,
                "listener_acc_read_latency": 0,
                "listener_cmd_set": 0,
                "listener_other_started_res_max": 0,
                "listener_max_connections_exceeded": 0,
                "listener_ingress_bytes": 0,
                "listener_other_started_res": 0,
                "listener_auth_cmds": 0,
                "listener_read_started_res": 0,
                "listener_cmd_get": 0,
                "listener_other_req_max": 0,
                "listener_auth_errors": 0,
                "listener_total_started_res": 0,
                "listener_cmd_set_max": 0,
                "listener_acc_latency_max": 0
            },
            "labels": {
                "proxy": "1:1:1",
                "bdb": "1",
                "cluster": "run1.local",
                "node": "1",
                "instance": "host.docker.internal:8070",
                "listener": "1:1",
                "job": "prometheus"
            }
        }
    },
    "metricset": {
        "period": 10000,
        "name": "collector"
    },
    "event": {
        "duration": 312732042,
        "agent_id_status": "verified",
        "ingested": "2022-07-12T07:34:56Z",
        "module": "prometheus",
        "dataset": "redisenterprise.proxy"
    }
}

Exported fields

FieldDescriptionType
@timestamp
Event timestamp.
date
data_stream.dataset
Data stream dataset.
constant_keyword
data_stream.namespace
Data stream namespace.
constant_keyword
data_stream.type
Data stream type.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
event.dataset
Event dataset
constant_keyword
event.module
Event module
constant_keyword
redisenterprise.proxy.labels.*
Label fields
object
redisenterprise.proxy.metrics.listener_*
Proxy prometheus metrics
float
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
service.type
The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch.
keyword

Changelog

VersionDetailsKibana version(s)

0.6.0

Enhancement View pull request
Update the package format_version to 3.0.0.

—

0.5.0

Enhancement View pull request
Rename ownership from obs-service-integrations to obs-infraobs-integrations

—

0.4.1

Bug fix View pull request
Add description for visualizations.

—

0.4.0

Enhancement View pull request
Migrate visualizations to lens.

—

0.3.1

Enhancement View pull request
Added categories and/or subcategories.

—

0.3.0

Enhancement View pull request
Update ECS version to 8.5.1

—

0.2.0

Enhancement View pull request
Added infrastructure category.

—

0.1.1

Enhancement View pull request
Minor changes

—

0.1.0

Enhancement View pull request
Initial working of the package

—

On this page