# Redis DB Monitoring # Introducción Plugin para la monitorización de Redis database. Obtención de métricas de rendimiento. Revisado en Enero de 2019 # Matriz de compatibilidad Desarrollado contra Redis DB 3.2.12 # Prerequisitos Se requiere conexión con el servicio Tentacle asociado a su servidor de Pandora FMS (para ejecuciones locales del plugin) bajo las siguiente condicion: - Si tiene as\_server\_plugin habilitado. El despliegue de este plugin por binarios no requiere ningún requisito especial. En caso de no estar compilado requiere de las siguiente librerias de perl: - PandoraFMS::PluginTools.pm - Redis - Data::Dumper Puede descargar la última versión de PandoraFMS::PluginTools.pm: [https://github.com/pandorafms/pandorafms/blob/develop/pandora\_server/lib/PandoraFMS/PluginTools.pm](https://github.com/pandorafms/pandorafms/blob/develop/pandora_server/lib/PandoraFMS/PluginTools.pm) # Configuración El fichero de configuración del plugin se divide en lineas: **Configuraciones generales del plugin** ``` #================================================================ # Plugin options #================================================================ server=192.168.80.199:6379 password=pandora_redis as_agent_plugin=1 as_server_plugin=0 agent_name=RedisDB temp=/tmp/ mode=tentacle tentacle_ip=127.0.0.1 tentacle_port=41121 metrics=all debug=0 ``` **server** Dirección del servidor redis. **password** Contraseña para autenticarse si está habilitada la autenticación en el servidor Redis. **metrics** Métricas a obtener con el plugin (all || server || clients || memory || persistence || stats || replication || cpu || commandstats || cluster || keyspace ) **as\_agent\_plugin** Utilizar el plugin en en modo de agente **as\_server\_plugin** Utilizar el plugin en modo servidor **\[agent\_name\]** Nombre de agente (as\_server\_plugin) **\[temp\]** Directorio temporal para almacenar el xml (local) **\[mode\]** Modo de transferencia (tentacle/local) **\[tentacle\_ip\]** Ip del servidor tentacle **tentacle\_port** Puerto del servidor tentacle **debug** Modo debug # Ejecución manual Para ejecutar el plugin configure el archivo de configuración según las instrucciones precedentes. Ejecución del plugin: Versión binaria: ``` ./redis_monitor.64 redis_config.conf ``` Versión código sin librerías desplegadas: ``` perl -I PandoraFMS redis_monitor.pl redis_config.conf ``` Donde, PandoraFMS es un directorio que contiene la librería PluginTools.pm # Módulos generados por el plugin La ejecución estándar de este plugin devolverá los siguientes módulos por defecto (con todos los bloques opcionales habilitados): **Monitorización:** Server: - redis\_version: Version of the Redis server - redis\_git\_sha1: Git SHA1 - redis\_git\_dirty: Git dirty flag - redis\_build\_id: The build id - redis\_mode: The server's mode ("standalone", "sentinel" or "cluster") - os: Operating system hosting the Redis server - arch\_bits: Architecture (32 or 64 bits) - multiplexing\_api: Event loop mechanism used by Redis - atomicvar\_api: Atomicvar API used by Redis - gcc\_version: Version of the GCC compiler used to compile the Redis server - process\_id: PID of the server process - run\_id: Random value identifying the Redis server (to be used by Sentinel and Cluster) - tcp\_port: TCP/IP listen port - uptime\_in\_seconds: Number of seconds since Redis server start - uptime\_in\_days: Same value expressed in days - hz: The server's frequency setting - lru\_clock: Clock incrementing every minute, for LRU management - executable: The path to the server's executable - config\_file: The path to the config file Clients: - connected\_clients: Number of client connections (excluding connections from replicas) - client\_longest\_output\_list: longest output list among current client connections - client\_biggest\_input\_buf: biggest input buffer among current client connections - blocked\_clients: Number of clients pending on a blocking call (BLPOP, BRPOP, BRPOPLPUSH) Memory: - used\_memory: Total number of bytes allocated by Redis using its allocator (either standard **libc**, **jemalloc**, or an alternative allocator such as [**tcmalloc**](http://code.google.com/p/google-perftools/)) - used\_memory\_human: Human readable representation of previous value - used\_memory\_rss: Number of bytes that Redis allocated as seen by the operating system (a.k.a resident set size). This is the number reported by tools such as top(1) and ps(1) - used\_memory\_rss\_human: Human readable representation of previous value - - used\_memory\_peak: Peak memory consumed by Redis (in bytes) - used\_memory\_peak\_human: Human readable representation of previous value - used\_memory\_peak\_perc: The percentage of used\_memory\_peak out ofused\_memory - used\_memory\_overhead: The sum in bytes of all overheads that the server allocated for managing its internal data structures - used\_memory\_startup: Initial amount of memory consumed by Redis at startup in bytes - used\_memory\_dataset: The size in bytes of the dataset (used\_memory\_overhead subtracted from used\_memory) - used\_memory\_dataset\_perc: The percentage of used\_memory\_datasetout of the net memory usage (used\_memory minus used\_memory\_startup) - total\_system\_memory: The total amount of memory that the Redis host has - total\_system\_memory\_human: Human readable representation of previous value - used\_memory\_lua: Number of bytes used by the Lua engine - used\_memory\_lua\_human: Human readable representation of previous value - maxmemory: The value of the maxmemory configuration directive - maxmemory\_human: Human readable representation of previous value - maxmemory\_policy: The value of the maxmemory-policy configuration directive - mem\_fragmentation\_ratio: Ratio between used\_memory\_rss and used\_memory - mem\_allocator: Memory allocator, chosen at compile time - active\_defrag\_running: Flag indicating if active defragmentation is active - lazyfree\_pending\_objects: The number of objects waiting to be freed (as a result of calling [UNLINK](https://redis.io/commands/unlink), or [FLUSHDB](https://redis.io/commands/flushdb) and [FLUSHALL](https://redis.io/commands/flushall) with the **ASYNC** option) Persistence: - loading: Flag indicating if the load of a dump file is on-going - rdb\_changes\_since\_last\_save: Number of changes since the last dump - rdb\_bgsave\_in\_progress: Flag indicating a RDB save is on-going - rdb\_last\_save\_time: Epoch-based timestamp of last successful RDB save - rdb\_last\_bgsave\_status: Status of the last RDB save operation - rdb\_last\_bgsave\_time\_sec: Duration of the last RDB save operation in seconds - rdb\_current\_bgsave\_time\_sec: Duration of the on-going RDB save operation if any - rdb\_last\_cow\_size: The size in bytes of copy-on-write allocations during the last RBD save operation - aof\_enabled: Flag indicating AOF logging is activated - aof\_rewrite\_in\_progress: Flag indicating a AOF rewrite operation is on-going - aof\_rewrite\_scheduled: Flag indicating an AOF rewrite operation will be scheduled once the on-going RDB save is complete. - aof\_last\_rewrite\_time\_sec: Duration of the last AOF rewrite operation in seconds - aof\_current\_rewrite\_time\_sec: Duration of the on-going AOF rewrite operation if any - aof\_last\_bgrewrite\_status: Status of the last AOF rewrite operation - aof\_last\_write\_status: Status of the last write operation to the AOF - aof\_last\_cow\_size: The size in bytes of copy-on-write allocations during the last AOF rewrite operation If AOF is activated, these additional fields will be added: - aof\_current\_size: AOF current file size - aof\_base\_size: AOF file size on latest startup or rewrite - aof\_pending\_rewrite: Flag indicating an AOF rewrite operation will be scheduled once the on-going RDB save is complete. - aof\_buffer\_length: Size of the AOF buffer - aof\_rewrite\_buffer\_length: Size of the AOF rewrite buffer - aof\_pending\_bio\_fsync: Number of fsync pending jobs in background I/O queue - aof\_delayed\_fsync: Delayed fsync counter If a load operation is on-going, these additional fields will be added: - loading\_start\_time: Epoch-based timestamp of the start of the load operation - loading\_total\_bytes: Total file size - loading\_loaded\_bytes: Number of bytes already loaded - loading\_loaded\_perc: Same value expressed as a percentage - loading\_eta\_seconds: ETA in seconds for the load to be complete Stats: - total\_connections\_received: Total number of connections accepted by the server - total\_commands\_processed: Total number of commands processed by the server - instantaneous\_ops\_per\_sec: Number of commands processed per second - total\_net\_input\_bytes: The total number of bytes read from the network - total\_net\_output\_bytes: The total number of bytes written to the network - instantaneous\_input\_kbps: The network's read rate per second in KB/sec - instantaneous\_output\_kbps: The network's write rate per second in KB/sec - rejected\_connections: Number of connections rejected because ofmaxclients limit - sync\_full: The number of full resyncs with replicas - sync\_partial\_ok: The number of accepted partial resync requests - sync\_partial\_err: The number of denied partial resync requests - expired\_keys: Total number of key expiration events - evicted\_keys: Number of evicted keys due to maxmemory limit - keyspace\_hits: Number of successful lookup of keys in the main dictionary - keyspace\_misses: Number of failed lookup of keys in the main dictionary - pubsub\_channels: Global number of pub/sub channels with client subscriptions - pubsub\_patterns: Global number of pub/sub pattern with client subscriptions - latest\_fork\_usec: Duration of the latest fork operation in microseconds - migrate\_cached\_sockets: The number of sockets open for [MIGRATE](https://redis.io/commands/migrate)purposes - slave\_expires\_tracked\_keys: The number of keys tracked for expiry purposes (applicable only to writable replicas) - active\_defrag\_hits: Number of value reallocations performed by active the defragmentation process - active\_defrag\_misses: Number of aborted value reallocations started by the active defragmentation process - active\_defrag\_key\_hits: Number of keys that were actively defragmented - active\_defrag\_key\_misses: Number of keys that were skipped by the active defragmentation process Replication: - role: Value is "master" if the instance is replica of no one, or "slave" if the instance is a replica of some master instance. Note that a replica can be master of another replica (chained replication). - master\_replid: The replication ID of the Redis server. - master\_replid2: The secondary replication ID, used for PSYNC after a failover. - master\_repl\_offset: The server's current replication offset - second\_repl\_offset: The offset up to which replication IDs are accepted - repl\_backlog\_active: Flag indicating replication backlog is active - repl\_backlog\_size: Total size in bytes of the replication backlog buffer - repl\_backlog\_first\_byte\_offset: The master offset of the replication backlog buffer - repl\_backlog\_histlen: Size in bytes of the data in the replication backlog buffer If the instance is a replica, these additional fields are provided: - master\_host: Host or IP address of the master - master\_port: Master listening TCP port - master\_link\_status: Status of the link (up/down) - master\_last\_io\_seconds\_ago: Number of seconds since the last interaction with master - master\_sync\_in\_progress: Indicate the master is syncing to the replica - slave\_repl\_offset: The replication offset of the replica instance - slave\_priority: The priority of the instance as a candidate for failover - slave\_read\_only: Flag indicating if the replica is read-only If a SYNC operation is on-going, these additional fields are provided: - master\_sync\_left\_bytes: Number of bytes left before syncing is complete - master\_sync\_last\_io\_seconds\_ago: Number of seconds since last transfer I/O during a SYNC operation If the link between master and replica is down, an additional field is provided: - master\_link\_down\_since\_seconds: Number of seconds since the link is down The following field is always provided: - connected\_slaves: Number of connected replicas If the server is configured with the min-slaves-to-write (or starting with Redis 5 with the min-replicas-to-write) directive, an additional field is provided: - min\_slaves\_good\_slaves: Number of replicas currently considered good For each replica, the following line is added: - slaveXXX: id, IP address, port, state, offset, lag CPU: - used\_cpu\_sys: System CPU consumed by the Redis server - used\_cpu\_user:User CPU consumed by the Redis server - used\_cpu\_sys\_children: System CPU consumed by the background processes - used\_cpu\_user\_children: User CPU consumed by the background processes Comandstats: - cmdstat\_XXX: calls=XXX,usec=XXX,usec\_per\_call=XXX Cluster - cluster\_enabled: Indicate Redis cluster is enabled Keyspace: dbXXX: keys=XXX,expires=XXX