Skip to main content
Version: NG-2.15

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 equal to or greater than 6.1.

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: The IP Address/FQDN of the Redis server.
  • Port: Provide the Redis port details.
  • Authentication Type: Select the type of authentication for Redis.
  • Cluster ID: Provide a unique string to identify the Redis cluster to which the host belongs. A Redis cluster is a set of replicated Redis nodes with master and slave roles. This will help in filtering out dashboards cluster wise.
  • Period: How frequently data is gathered. The period should be between 60 seconds - 3000 seconds.

Firewall Requirement​

To collect data from this O11ySource, ensure the following ports are opened:

Source IPDestination IPDestination PortProtocolDirection
IP address of the server where Redis is installedvuSmartMaps Data Collector End Point9092*TCPInbound

*Before providing the firewall requirements, please update the port based on the customer environment.

Configuring the Target​

Healthbeat 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 instance to be monitored.
  • Add the required details and then click on Next.
  • 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 installationDownload <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 Finish to close the data source window.

Metrics Collected​

NameDescriptionData Type
@timestampThe original timestamp as a string.String
timestampThe timestamp with high precision, including milliseconds.Datetime64
OSThe operating system name.LowCardinality(String)
OwnerThe owner or administrator of the system.LowCardinality(String)
RoleThe role assigned to the host (e.g., database, application server).LowCardinality(String)
beat_hostnameThe hostname where the beat (data shipper) is running.LowCardinality(String)
ecs_versionECS (Elastic Common Schema) version being used.LowCardinality(String)
event_datasetDataset name for the event.LowCardinality(String)
event_durationDuration of the event in milliseconds.UInt32
event_moduleThe module generating the event (e.g., Redis, PostgreSQL).LowCardinality(String)
hostHost identifier or name.LowCardinality(String)
host_info_architectureArchitecture of the host (e.g., x86_64).LowCardinality(String)
host_info_containerizedWhether the host is running inside a container.Bool
host_info_hostnameThe hostname of the machine.LowCardinality(String)
host_info_idA unique identifier for the host.String
host_info_nameThe human-readable name of the host.LowCardinality(String)
host_info_os_codenameCodename of the operating system.LowCardinality(String)
host_info_os_familyFamily of the operating system (e.g., Linux, Windows).LowCardinality(String)
host_info_os_kernelThe kernel version of the operating system.LowCardinality(String)
host_info_os_nameName of the operating system.LowCardinality(String)
host_info_os_platformPlatform of the operating system (e.g., ubuntu, centos).LowCardinality(String)
host_info_os_typeType of the operating system (e.g., system, container).LowCardinality(String)
host_info_os_versionVersion of the operating system.LowCardinality(String)
metricset_nameName of the metricset being collected.LowCardinality(String)
metricset_periodThe interval in milliseconds at which the metricset runs.UInt32
os_fullFull details about the operating system.LowCardinality(String)
periodPeriod in seconds.Float32
process_pidProcess ID of the related process.UInt32
redis_info_clients_blockedNumber of blocked clients in Redis.UInt32
redis_info_clients_connectedNumber of connected clients in Redis.UInt32
redis_info_clients_max_input_bufferMaximum input buffer size for clients in Redis.UInt32
redis_info_clients_max_output_bufferMaximum output buffer size for clients in Redis.UInt32
redis_info_cluster_enabledIndicates if Redis clustering is enabled.Bool
redis_info_commandstats_*Various statistics related to Redis commands (calls, time usage, etc.).Various
redis_info_cpu_*CPU usage statistics for Redis, including system and user time.Various
redis_info_memory_*Memory usage statistics for Redis, including fragmentation and allocation details.Various
redis_info_persistence_*Persistence-related statistics for Redis, including AOF and RDB configurations.Various
redis_info_replication_*Replication-related details for Redis, including slave status and backlog information.Various
redis_info_server_*General server information for Redis, such as version and uptime.Various
redis_info_stats_*Redis performance and usage statistics, such as processed commands and network usage.Various
service_addressThe address of the monitored service.LowCardinality(String)
service_typeType of service being monitored (e.g., Redis, MySQL).LowCardinality(String)
service_versionVersion of the service being monitored.LowCardinality(String)
targetThe target for metrics collection.LowCardinality(String)
typeThe type of data being collected.LowCardinality(String)
fields_host_ipIP address of the host.String
fields_cluster_idIdentifier for the cluster.String
@timestampThe original timestamp as a string.String
timestampHigh-precision timestamp including milliseconds.Datetime64
OSOperating system name (e.g., Linux, Windows).LowCardinality(String)
OwnerOwner or administrator of the system.String
RoleRole assigned to the host (e.g., database, application server).LowCardinality(String)
beat_hostnameHostname of the machine where the beat (data shipper) is running.LowCardinality(String)
ecs_versionVersion of the Elastic Common Schema (ECS) used.LowCardinality(String)
event_datasetDataset associated with the event.LowCardinality(String)
event_durationDuration of the event in milliseconds.UInt32
event_moduleThe module generating the event (e.g., Redis, PostgreSQL).LowCardinality(String)
hostHost identifier or name.LowCardinality(String)
host_info_architectureHost system architecture (e.g., x86_64).LowCardinality(String)
host_info_containerizedWhether the host is running inside a container.Bool
host_info_hostnameHostname of the machine.LowCardinality(String)
host_info_idUnique identifier for the host.String
host_info_nameHuman-readable name of the host.LowCardinality(String)
host_info_os_codenameCodename of the operating system.LowCardinality(String)
host_info_os_familyFamily of the operating system (e.g., Linux, Windows).LowCardinality(String)
host_info_os_kernelKernel version of the operating system.LowCardinality(String)
host_info_os_nameName of the operating system.LowCardinality(String)
host_info_os_platformPlatform of the operating system (e.g., Ubuntu, CentOS).LowCardinality(String)
host_info_os_typeType of the operating system (e.g., system, container).LowCardinality(String)
host_info_os_versionVersion of the operating system.LowCardinality(String)
metricset_nameName of the metricset being collected.LowCardinality(String)
metricset_periodInterval in milliseconds at which the metricset runs.UInt32
periodPeriod in seconds for metrics collection.Float32
service_addressAddress of the service being monitored.LowCardinality(String)
service_typeType of the monitored service (e.g., Redis, MySQL).LowCardinality(String)
targetTarget being monitored for metrics.LowCardinality(String)
typeType of data or event.LowCardinality(String)
redis_keyspace_avg_ttlAverage time-to-live (TTL) for keys in the Redis keyspace.UInt32
redis_keyspace_expiresNumber of keys with expiration set in the Redis keyspace.UInt32
redis_keyspace_keysTotal number of keys in the Redis keyspace.UInt32
redis_keyspace_idIdentifier for the Redis keyspace.String
redis_key_expire_ttlTime-to-live (TTL) for a specific Redis key.Int32
redis_key_idUnique identifier for a Redis key.String
redis_key_lengthLength of the Redis key (e.g., size of list, set, or string).UInt32
redis_key_nameName of the Redis key.String
redis_key_typeType of the Redis key (e.g., string, list, hash).LowCardinality(String)
fields_host_ipIP address of the host machine.String
fields_cluster_idIdentifier for the cluster where the host belongs.String