Skip to content

Redis Integration

Redis protocol datasources related to request/response are available out-of-the-box within the AOC. Please look at pre-canned dashboards for Redis or use the Analytics Sandbox to plot charts without any additional configuration.

In order to access infrastructure datasources, follow the steps listed in the infrastructure integration section below.

Protocol Integration

Attributes

The shared attributes and Redis-specific attributes below can be used in filters and group by operations in analytics within alerts, dashboards, etc.

Metric Description Value / Example
redis.command.name The Redis command name. Eg. Append, Bitcount
redis.error.string Textual description of the error. In this error message: ERROR 1146 (42S02): Table 'test.no_such_table' doesn't exist, error string is Table 'test.no_such_table' doesn't exist
redis.response.status The response status.

Protocol Datasources

Datasource Available Aggregations Unit Description
redis.request_response.latency sum avg min max std_dev millisecond The aggregated latency across all Redis request/response.
redis.request_response.throughput throughput /s The total number of Redis request/response per second.
redis.request_response.count count The total number of Redis request/response.
redis.request.bytes sum avg min max byte The aggregated number of bytes across all Redis requests.
redis.request.bytes.rate rate byte/s The rate of bytes transferred across all Redis requests.
redis.request.count count The total number of Redis requests.
redis.request.packets sum avg min max packet The aggregated number of packets across all Redis requests.
redis.request.packets.rate rate packet/s The rate of packets transferred across all Redis requests.
redis.request.throughput throughput /s The rate of total number of Redis requests.
redis.response.bytes sum avg min max byte The aggregated number of bytes across all Redis responses.
redis.response.bytes.rate rate byte/s The rate of bytes transferred across all Redis responses.
redis.response.count count The total number of Redis responses.
redis.response.packets sum avg min max packet The aggregated number of packets across all Redis responses.
redis.response.packets.rate rate packet/s The rate of packets transferred across all Redis responses.
redis.response.throughput throughput /s The rate of total number of Redis responses.

Infrastructure Integration

Instructions

Follow the installation guide below for your given collector environment.

During installation, use the configuration section below as reference.

After installation, the infrastructure datasources in the table below will be available in the AOC.

Installation Guide

Installing this integration consists of creating a yaml file in the filesystem of your collectors. Click below for instructions on how to do so for your given collectors environment.

Docker

Kubernetes

Mesos-Marathon

Debian

Ubuntu

RHEL/CentOS

Configuration

Edit redisdb.yaml to configure the agent. Please refer redis.yaml for all available configuration options.

    init_config:

    instances:
      - host: localhost
        port: 6379
        db: 0

Infrastructure Datasources

Datasource Available Aggregations Unit Description
redis.aof.buffer_length avg max min sum byte Size of the AOF buffer.
redis.aof.last_rewrite_time avg max min sum second Duration of the last AOF rewrite.
redis.aof.rewrite avg max min sum Flag indicating a AOF rewrite operation is on-going.
redis.aof.size avg max min sum byte AOF current file size (aof_current_size).
redis.clients.biggest_input_buf avg max min sum The biggest input buffer among current client connections.
redis.clients.blocked avg max min sum connection The number of connections waiting on a blocking call.
redis.clients.longest_output_list avg max min sum The longest output list among current client connections.
redis.cpu.sys avg max min sum second System CPU consumed by the Redis server.
redis.cpu.sys_children avg max min sum second System CPU consumed by the background processes.
redis.cpu.user avg max min sum second User CPU consumed by the Redis server.
redis.cpu.user_children avg max min sum second User CPU consumed by the background processes.
redis.expires avg max min sum key The number of keys that have expired.
redis.expires.percent avg max min sum percent Percentage of total keys that have been expired.
redis.info.latency_ms avg max min sum millisecond The latency of the redis INFO command.
redis.key.length avg max min sum The number of elements in a given key, tagged by key, e.g. 'key:mykeyname'. Enable in Agent's redisdb.yaml with the keys option.
redis.keys avg max min sum key The total number of keys.
redis.keys.evicted avg max min sum key The total number of keys evicted due to the maxmemory limit.
redis.keys.expired avg max min sum key The total number of keys expired from the db.
redis.mem.fragmentation_ratio avg max min sum fraction Ratio between used_memory_rss and used_memory.
redis.mem.lua avg max min sum byte Amount of memory used by the Lua engine.
redis.mem.peak avg max min sum byte The peak amount of memory used by Redis.
redis.mem.rss avg max min sum byte Amount of memory that Redis allocated as seen by the os.
redis.mem.used avg max min sum byte Amount of memory allocated by Redis.
redis.net.clients avg max min sum connection The number of connected clients (excluding slaves).
redis.net.commands avg max min sum command The number of commands processed by the server.
redis.net.rejected avg max min sum connection The number of rejected connections.
redis.net.slaves avg max min sum connection The number of connected slaves.
redis.perf.latest_fork_usec avg max min sum microsecond The duration of the latest fork.
redis.persist avg max min sum key The number of keys persisted (redis.keys - redis.expires).
redis.persist.percent avg max min sum percent Percentage of total keys that are persisted.
redis.pubsub.channels avg max min sum The number of active pubsub channels.
redis.pubsub.patterns avg max min sum The number of active pubsub patterns.
redis.rdb.bgsave avg max min sum One if a bgsave is in progress and zero otherwise.
redis.rdb.changes_since_last avg max min sum The number of changes since the last background save.
redis.rdb.last_bgsave_time avg max min sum second Duration of the last bg_save operation.
redis.replication.backlog_histlen avg max min sum byte The amount of data in the backlog sync buffer.
redis.replication.delay avg max min sum offset The replication delay in offsets.
redis.replication.last_io_seconds_ago avg max min sum second Amount of time since the last interaction with master.
redis.replication.master_link_down_since_seconds avg max min sum second Amount of time that the master link has been down.
redis.replication.master_repl_offset avg max min sum offset The replication offset reported by the master.
redis.replication.slave_repl_offset avg max min sum offset The replication offset reported by the slave.
redis.replication.sync avg max min sum One if a sync is in progress and zero otherwise.
redis.replication.sync_left_bytes avg max min sum byte Amount of data left before syncing is complete.
redis.slowlog.micros.95percentile avg max min sum microsecond The 95th percentile of the duration of queries reported in the slow log.