redis
Introduction
Redis is an open-source, in-memory data structure store, commonly used as a cache or message broker. It provides fast access to data through key-value pairs and supports various data structures like strings, hashes, lists, sets, and more.
Getting Started
Compatibility
The Redis O11ySource is compatible with all versions greater than or equal to Redis 6.0.16.
Data Collection Method
vuSmartMaps collects health and performance data for Redis using VuNet's Healthbeat agent. This agent collects data based on the source configuration.
Prerequisites
Dependent Configuration
To configure this O11ySource, create a 'credential' of type 'user' under the 'Definition' tab.
Inputs for Configuring Data Source
- Host: Enter the Redis server IPv4 address, FQDN (e.g., redis01.example.com), or localhost. This value is used to uniquely identify the server entry.
- Port Number: Enter the TCP port where Redis is listening. Default is 6379.
- Cluster ID: Enter a unique cluster name/ID for grouping servers in dashboards (e.g., prod-redis-cluster-1).
- Period [in seconds]: Metric collection interval in seconds. Data is collected once per interval. Allowed range: 60–3000 seconds.
- Authentication Type: Select how to authenticate to Redis: No Authentication, Basic (username + password), or Password only.
- Credential: Select a saved username/password credential from Definitions. Shown only when Authentication Type = Basic.
- Password: Enter the Redis password used for authentication. Shown only when Authentication Type = Password only.
Firewall Requirement
To collect data from this O11ySource, ensure the following ports are opened:
| Source IP | Destination IP | Destination Port | Protocol | Direction |
|---|---|---|---|---|
| IP address of the Redis server | vuSmartMaps Data Collector End Point | 9094* | TCP | Inbound |
*Before providing the firewall requirements, please update the port based on the customer environment.
Configuring the Target
Healthbeat agent should be installed and running in the server where Redis is installed.
Configuration Steps
- Enable the Redis O11ySource.
- Select the Sources tab and press the
+button to add a new Redis host to be monitored. - Set up metrics configurations. Afterwards, select
Save and Continueto proceed with downloading the Healthbeat agent. - The following packages will be available for download based on the OS:
- *Download <OS> Healthbeat Installation Binary - Downloads the full Healthbeat package with required configurations for a fresh installation
- *Download <OS> Healthbeat Update Configuration Binary - Downloads the agent configuration package to update an existing Healthbeat installation
- Download the agent installation or update package, then click
Finishto close the data source window.
Metrics Collected
| Name | Description | Data Type |
|---|---|---|
| @timestamp | Timestamp of the event | String |
| timestamp | Precise timestamp of the event | DateTime64 |
| beat_hostname | Hostname of the beat collector | LowCardinality(String) |
| ecs_version | ECS version used | LowCardinality(String) |
| event_dataset | Event dataset name | LowCardinality(String) |
| event_duration | Duration of the event in milliseconds | UInt32 |
| event_module | Event module name | LowCardinality(String) |
| host | Host identifier | LowCardinality(String) |
| host_info_architecture | Host architecture | LowCardinality(String) |
| host_info_containerized | Whether host is containerized | Bool |
| host_info_hostname | Host hostname | LowCardinality(String) |
| host_info_id | Host unique ID | String |
| host_info_name | Host name | LowCardinality(String) |
| host_info_os_codename | OS codename | LowCardinality(String) |
| host_info_os_family | OS family | LowCardinality(String) |
| host_info_os_kernel | OS kernel version | LowCardinality(String) |
| host_info_os_name | OS name | LowCardinality(String) |
| host_info_os_platform | OS platform | LowCardinality(String) |
| host_info_os_type | OS type | LowCardinality(String) |
| host_info_os_version | OS version | LowCardinality(String) |
| metricset_name | Name of the metricset | LowCardinality(String) |
| metricset_period | Metricset collection period in seconds | UInt32 |
| os_full | Full OS description | LowCardinality(String) |
| period | Collection period in seconds | Float32 |
| process_pid | Process ID of Redis | UInt32 |
| redis_info_clients_blocked | Number of blocked clients | UInt32 |
| redis_info_clients_connected | Number of connected clients | UInt32 |
| redis_info_clients_max_input_buffer | Max client input buffer size | UInt32 |
| redis_info_clients_max_output_buffer | Max client output buffer size | UInt32 |
| redis_info_cluster_enabled | Whether cluster is enabled | Bool |
| redis_info_commandstats_command_calls | Number of command calls | UInt32 |
| redis_info_commandstats_command_usec | Total microseconds for commands | UInt64 |
| redis_info_commandstats_command_usec_per_call | Microseconds per command call | Float32 |
| redis_info_commandstats_get_calls | Number of GET command calls | UInt32 |
| redis_info_commandstats_get_usec | Total microseconds for GET commands | UInt64 |
| redis_info_commandstats_get_usec_per_call | Microseconds per GET call | Float32 |
| redis_info_commandstats_info_calls | Number of INFO command calls | UInt32 |
| redis_info_commandstats_info_usec | Total microseconds for INFO commands | UInt64 |
| redis_info_commandstats_info_usec_per_call | Microseconds per INFO call | Float32 |
| redis_info_commandstats_ping_calls | Number of PING command calls | UInt32 |
| redis_info_commandstats_ping_usec | Total microseconds for PING commands | UInt64 |
| redis_info_commandstats_ping_usec_per_call | Microseconds per PING call | Float32 |
| redis_info_commandstats_strlen_calls | Number of STRLEN command calls | UInt32 |
| redis_info_commandstats_strlen_usec | Total microseconds for STRLEN commands | UInt64 |
| redis_info_commandstats_strlen_usec_per_call | Microseconds per STRLEN call | Float32 |
| redis_info_commandstats_scan_calls | Number of SCAN command calls | UInt32 |
| redis_info_commandstats_scan_usec | Total microseconds for SCAN commands | UInt64 |
| redis_info_commandstats_scan_usec_per_call | Microseconds per SCAN call | Float32 |
| redis_info_commandstats_type_calls | Number of TYPE command calls | UInt32 |
| redis_info_commandstats_type_usec | Total microseconds for TYPE commands | UInt64 |
| redis_info_commandstats_type_usec_per_call | Microseconds per TYPE call | Float32 |
| redis_info_commandstats_ttl_calls | Number of TTL command calls | UInt32 |
| redis_info_commandstats_ttl_usec | Total microseconds for TTL commands | UInt64 |
| redis_info_commandstats_ttl_usec_per_call | Microseconds per TTL call | Float32 |
| redis_info_commandstats_select_calls | Number of SELECT command calls | UInt32 |
| redis_info_commandstats_select_usec | Total microseconds for SELECT commands | UInt64 |
| redis_info_commandstats_select_usec_per_call | Microseconds per SELECT call | Float32 |
| redis_info_commandstats_slowlog_calls | Number of SLOWLOG command calls | UInt32 |
| redis_info_commandstats_slowlog_usec | Total microseconds for SLOWLOG commands | UInt64 |
| redis_info_commandstats_slowlog_usec_per_call | Microseconds per SLOWLOG call | Float32 |
| redis_info_cpu_used_sys | System CPU used by Redis | Float32 |
| redis_info_cpu_used_sys_children | System CPU used by children | Float32 |
| redis_info_cpu_used_user | User CPU used by Redis | Float32 |
| redis_info_cpu_used_user_children | User CPU used by children | Float32 |
| redis_info_memory_active_defrag_is_running | Whether active defrag is running | Bool |
| redis_info_memory_allocator | Memory allocator used | LowCardinality(String) |
| redis_info_memory_allocator_stats_active | Active memory allocated | UInt32 |
| redis_info_memory_allocator_stats_allocated | Total memory allocated | UInt32 |
| redis_info_memory_allocator_stats_fragmentation_bytes | Memory fragmentation in bytes | UInt32 |
| redis_info_memory_allocator_stats_fragmentation_ratio | Memory fragmentation ratio | Float32 |
| redis_info_memory_allocator_stats_resident | Resident memory size | UInt32 |
| redis_info_memory_allocator_stats_rss_bytes | RSS memory in bytes | UInt32 |
| redis_info_memory_allocator_stats_rss_ratio | RSS memory ratio | Float32 |
| redis_info_memory_fragmentation_bytes | Total memory fragmentation bytes | UInt32 |
| redis_info_memory_fragmentation_ratio | Total memory fragmentation ratio | Float32 |
| redis_info_memory_max_policy | Memory eviction policy | LowCardinality(String) |
| redis_info_memory_max_value | Maximum memory value | UInt32 |
| redis_info_memory_used_dataset | Memory used by dataset | UInt32 |
| redis_info_memory_used_lua | Memory used by Lua | UInt32 |
| redis_info_memory_used_peak | Peak memory used | UInt32 |
| redis_info_memory_used_rss | Resident Set Size memory | UInt32 |
| redis_info_memory_used_value | Memory used value | UInt32 |
| redis_info_persistence_aof_bgrewrite_last_status | Last AOF rewrite status | LowCardinality(String) |
| redis_info_persistence_aof_buffer | AOF buffer status | String |
| redis_info_persistence_aof_copy_on_write_last_size | Last AOF copy-on-write size | UInt32 |
| redis_info_persistence_aof_enabled | Whether AOF is enabled | Bool |
| redis_info_persistence_aof_fsync | AOF fsync policy | String |
| redis_info_persistence_aof_rewrite_buffer | AOF rewrite buffer status | String |
| redis_info_persistence_aof_rewrite_current_time_sec | Current AOF rewrite time in seconds | Int32 |
| redis_info_persistence_aof_rewrite_in_progress | Whether AOF rewrite is in progress | Bool |
| redis_info_persistence_aof_rewrite_last_time_sec | Last AOF rewrite time in seconds | Int32 |
| redis_info_persistence_aof_rewrite_scheduled | Whether AOF rewrite is scheduled | Bool |
| redis_info_persistence_aof_size | AOF size | String |
| redis_info_persistence_aof_write_last_status | Last AOF write status | LowCardinality(String) |
| redis_info_persistence_loading | Whether loading is in progress | Bool |
| redis_info_persistence_rdb_bgsave_current_time_sec | Current RDB save time in seconds | Int32 |
| redis_info_persistence_rdb_bgsave_in_progress | Whether RDB save is in progress | Bool |
| redis_info_persistence_rdb_bgsave_last_status | Last RDB save status | LowCardinality(String) |
| redis_info_persistence_rdb_bgsave_last_time_sec | Last RDB save time in seconds | Int32 |
| redis_info_persistence_rdb_copy_on_write_last_size | Last RDB copy-on-write size | UInt32 |
| redis_info_persistence_rdb_last_save_changes_since | Changes since last RDB save | UInt32 |
| redis_info_persistence_rdb_last_save_time | Timestamp of last RDB save | UInt64 |
| redis_info_replication_backlog_active | Active replication backlog | UInt32 |
| redis_info_replication_backlog_first_byte_offset | First byte offset in backlog | Int32 |
| redis_info_replication_backlog_histlen | Replication backlog history length | UInt32 |
| redis_info_replication_backlog_size | Replication backlog size | UInt32 |
| redis_info_replication_connected_slaves | Number of connected slaves | UInt16 |
| redis_info_replication_master_last_io_seconds_ago | Seconds since last IO with master | UInt32 |
| redis_info_replication_master_link_status | Master link status | LowCardinality(String) |
| redis_info_replication_master_offset | Master replication offset | Int32 |
| redis_info_replication_master_second_offset | Master second replication offset | Int32 |
| redis_info_replication_master_sync_in_progress | Whether master sync is in progress | Bool |
| redis_info_replication_role | Replication role (master/slave) | LowCardinality(String) |
| redis_info_replication_slave_is_readonly | Whether slave is read-only | Bool |
| redis_info_replication_slave_offset | Slave replication offset | Int32 |
| redis_info_replication_slave_priority | Slave priority | UInt32 |
| redis_info_server_arch_bits | Server architecture bits | LowCardinality(String) |
| redis_info_server_build_id | Server build ID | String |
| redis_info_server_config_file | Server config file path | LowCardinality(String) |
| redis_info_server_gcc_version | GCC version used | LowCardinality(String) |
| redis_info_server_git_dirty | Git dirty flag | LowCardinality(String) |
| redis_info_server_git_sha1 | Git SHA1 hash | LowCardinality(String) |
| redis_info_server_hz | Server frequency in Hz | UInt8 |
| redis_info_server_lru_clock | Server LRU clock | UInt32 |
| redis_info_server_mode | Server mode | LowCardinality(String) |
| redis_info_server_multiplexing_api | Multiplexing API used | LowCardinality(String) |
| redis_info_server_run_id | Server run ID | String |
| redis_info_server_tcp_port | Server TCP port | UInt16 |
| redis_info_server_uptime | Server uptime in seconds | UInt32 |
| redis_info_slowlog_count | Number of slowlog entries | UInt32 |
| redis_info_stats_active_defrag_hits | Active defragmentation hits | UInt32 |
| redis_info_stats_active_defrag_key_hits | Active defragmentation key hits | UInt32 |
| redis_info_stats_active_defrag_key_misses | Active defragmentation key misses | UInt32 |
| redis_info_stats_active_defrag_misses | Active defragmentation misses | UInt32 |
| redis_info_stats_commands_processed | Total commands processed | UInt32 |
| redis_info_stats_commands_processed_diff | Commands processed difference since last interval | UInt32 |
| redis_info_stats_commands_processed_rate | Commands processed per second | Float32 |
| redis_info_stats_connections_received | Total connections received | UInt32 |
| redis_info_stats_connections_received_diff | Connections received difference since last interval | UInt32 |
| redis_info_stats_connections_received_rate | Connections received per second | Float32 |
| redis_info_stats_connections_rejected | Total connections rejected | UInt32 |
| redis_info_stats_connections_rejected_diff | Connections rejected difference since last interval | UInt32 |
| redis_info_stats_connections_rejected_rate | Connections rejected per second | Float32 |
| redis_info_stats_instantaneous_input_kbps | Instantaneous input KB/s | Float32 |
| redis_info_stats_instantaneous_ops_per_sec | Instantaneous operations per second | UInt32 |
| redis_info_stats_instantaneous_output_kbps | Instantaneous output KB/s | Float32 |
| redis_info_stats_keys_evicted | Total keys evicted | UInt32 |
| redis_info_stats_keys_evicted_diff | Keys evicted difference since last interval | UInt32 |
| redis_info_stats_keys_evicted_rate | Keys evicted per second | Float32 |
| redis_info_stats_keys_expired | Total keys expired | UInt32 |
| redis_info_stats_keyspace_hits | Keyspace hits | UInt32 |
| redis_info_stats_keyspace_misses | Keyspace misses | UInt32 |
| redis_info_stats_latest_fork_usec | Latest fork time in microseconds | UInt64 |
| redis_info_stats_migrate_cached_sockets | Migrate cached sockets | UInt32 |
| redis_info_stats_net_input_bytes | Total network input bytes | UInt32 |
| redis_info_stats_net_output_bytes | Total network output bytes | UInt32 |
| redis_info_stats_pubsub_channels | Pub/Sub channels | UInt32 |
| redis_info_stats_pubsub_patterns | Pub/Sub patterns | UInt32 |
| redis_info_stats_slave_expires_tracked_keys | Slave expires tracked keys | UInt32 |
| redis_info_stats_sync_full | Full syncs | UInt32 |
| redis_info_stats_sync_partial_err | Partial sync errors | UInt32 |
| redis_info_stats_sync_partial_ok | Partial sync successes | UInt32 |
| service_address | Service address | LowCardinality(String) |
| service_type | Service type | LowCardinality(String) |
| service_version | Service version | LowCardinality(String) |
| target | Target identifier | LowCardinality(String) |
| type | Event type | LowCardinality(String) |
| host_ip | Host IP address | String |
| cluster_id | Cluster ID | String |
| redis_keyspace_avg_ttl | Average TTL of keys in keyspace in milliseconds | UInt32 |
| redis_keyspace_expires | Number of keys with expiration in keyspace | UInt32 |
| redis_keyspace_keys | Total number of keys in keyspace | UInt32 |
| redis_keyspace_id | Keyspace identifier | String |
| redis_key_expire_ttl | Time remaining until key expiration in seconds | Int32 |
| redis_key_id | Key unique identifier | String |
| redis_key_length | Length/size of the key value | UInt32 |
| redis_key_name | Key name | String |
| redis_key_type | Data type of the key | LowCardinality(String) |
