Redis
Official · maintained by Marmotmarmotdata/redis Discover databases from Redis instances
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 +selectIn the UI
Point-and-click, no config file needed.
- 1 Open Runs Create pipeline
- 2 Pick Redis from the plugin list.
- 3 Fill in the wizard, set a schedule, save.
With the CLI
Save a YAML config, then run marmot ingest.
name: my-redis-pipeline
runs:
- redis:
host: "<host>"$ marmot ingest -c ingest.yamlNot using plugins? Other ways to populate Marmot
Configuration
11 top-level fields. * marks required fields.
tags multiselect Tags to apply to discovered assets
external_links object[] External links to show on all assets
name string Display name for the link
icon string Icon identifier for the link
url string URL to the external resource
filter object Filter discovered assets by name (regex)
include multiselect Include patterns for resource names (regex)
exclude multiselect Exclude patterns for resource names (regex)
host string Redis server hostname or IP address
port int Redis server port
- default
- 6379
password password Password for authentication
username string Username for ACL authentication
db int Default database number
- default
- 0
tls bool Enable TLS connection
tls_insecure bool Skip TLS certificate verification
discover_all_databases bool Discover all databases with keys (db0-db15)
- default
- true
Assets emitted
Metadata this plugin attaches to each discovered asset.
Redis Database
RedisDatabaseFieldsRedisDatabaseFields defines metadata fields for Redis databases
host stringRedis server hostname
port intRedis server port
database stringDatabase name (e.g. db0)
redis_version stringRedis server version
role stringReplication role (master/slave)
uptime_seconds stringServer uptime in seconds
connected_clients stringNumber of connected clients
used_memory_human stringHuman-readable used memory
maxmemory_policy stringEviction policy when maxmemory is reached
key_count intNumber of keys in the database
expires_count intNumber of keys with an expiration
avg_ttl_ms intAverage TTL in milliseconds