Redis

Experimental

Creates:

Assets

Configure in the UI

This plugin can be configured directly in the Marmot UI with a step-by-step wizard.

View Guide

The Redis plugin discovers logical databases (db0–db15) from Redis instances. It uses the INFO command to collect server metadata and parses the Keyspace section to identify databases that contain keys.

Required Permissions

The connecting user needs permission to run the INFO command. By default all users can run INFO, but if you are using Redis ACLs:

ACL SETUSER marmot_reader on >password ~* &* +info +ping +select

Example Configuration

host: "localhost"
port: 6379
password: "secret"
discover_all_databases: true
filter:
  include:
    - "^db[0-3]$"
tags:
  - "redis"
  - "cache"

Configuration

The following configuration options are available:

Property	Type	Required	Description
db	int	false	Default database number
discover_all_databases	bool	false	Discover all databases with keys (db0-db15)
external_links	[]ExternalLink	false	External links to show on all assets
filter	plugin.Filter	false	Filter databases by name pattern
host	string	false	Redis server hostname or IP address
password	string	false	Password for authentication
port	int	false	Redis server port
tags	TagsConfig	false	Tags to apply to discovered assets
tls	bool	false	Enable TLS connection
tls_insecure	bool	false	Skip TLS certificate verification
username	string	false	Username for ACL authentication

Available Metadata

The following metadata fields are available:

Field	Type	Description
avg_ttl_ms	int64	Average TTL in milliseconds
connected_clients	string	Number of connected clients
database	string	Database name (e.g. db0)
expires_count	int64	Number of keys with an expiration
host	string	Redis server hostname
key_count	int64	Number of keys in the database
maxmemory_policy	string	Eviction policy when maxmemory is reached
port	int	Redis server port
redis_version	string	Redis server version
role	string	Replication role (master/slave)
uptime_seconds	string	Server uptime in seconds
used_memory_human	string	Human-readable used memory