github.com/netdata/go.d.plugin@v0.58.1/modules/redis/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-redis 5 plugin_name: go.d.plugin 6 module_name: redis 7 monitored_instance: 8 name: Redis 9 link: https://redis.com/ 10 categories: 11 - data-collection.database-servers 12 icon_filename: redis.svg 13 related_resources: 14 integrations: 15 list: 16 - plugin_name: apps.plugin 17 module_name: apps 18 - plugin_name: cgroups.plugin 19 module_name: cgroups 20 alternative_monitored_instances: [] 21 info_provided_to_referring_integrations: 22 description: "" 23 keywords: 24 - redis 25 - databases 26 most_popular: true 27 overview: 28 data_collection: 29 metrics_description: | 30 This collector monitors the health and performance of Redis servers and collects general statistics, CPU and memory consumption, replication information, command statistics, and more. 31 method_description: | 32 It connects to the Redis instance via a TCP or UNIX socket and executes the following commands: 33 34 - [INFO ALL](https://redis.io/commands/info) 35 - [PING](https://redis.io/commands/ping/) 36 default_behavior: 37 auto_detection: 38 description: | 39 By default, it detects instances running on localhost by attempting to connect using known Redis TCP and UNIX sockets: 40 41 - 127.0.0.1:6379 42 - /tmp/redis.sock 43 - /var/run/redis/redis.sock 44 - /var/lib/redis/redis.sock 45 limits: 46 description: "" 47 performance_impact: 48 description: "" 49 additional_permissions: 50 description: "" 51 multi_instance: true 52 supported_platforms: 53 include: [] 54 exclude: [] 55 setup: 56 prerequisites: 57 list: [] 58 configuration: 59 file: 60 name: go.d/redis.conf 61 options: 62 description: | 63 The following options can be defined globally: update_every, autodetection_retry. 64 folding: 65 title: Config options 66 enabled: true 67 list: 68 - name: update_every 69 description: Data collection frequency. 70 default_value: 5 71 required: false 72 - name: autodetection_retry 73 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 74 default_value: 0 75 required: false 76 - name: address 77 description: Redis server address. 78 default_value: redis://@localhost:6379 79 required: true 80 details: | 81 There are two connection types: by tcp socket and by unix socket. 82 83 - Tcp connection: `redis://<user>:<password>@<host>:<port>/<db_number>` 84 - Unix connection: `unix://<user>:<password>@</path/to/redis.sock>?db=<db_number>` 85 - name: timeout 86 description: Dial (establishing new connections), read (socket reads) and write (socket writes) timeout in seconds. 87 default_value: 1 88 required: false 89 - name: username 90 description: Username used for authentication. 91 default_value: "" 92 required: false 93 - name: password 94 description: Password used for authentication. 95 default_value: "" 96 required: false 97 - name: tls_skip_verify 98 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 99 default_value: false 100 required: false 101 - name: tls_ca 102 description: Certificate authority that client use when verifying server certificates. 103 default_value: "" 104 required: false 105 - name: tls_cert 106 description: Client tls certificate. 107 default_value: "" 108 required: false 109 - name: tls_key 110 description: Client tls key. 111 default_value: "" 112 required: false 113 examples: 114 folding: 115 title: Config 116 enabled: true 117 list: 118 - name: TCP socket 119 description: An example configuration. 120 config: | 121 jobs: 122 - name: local 123 address: 'redis://@127.0.0.1:6379' 124 - name: Unix socket 125 description: An example configuration. 126 config: | 127 jobs: 128 - name: local 129 address: 'unix://@/tmp/redis.sock' 130 - name: TCP socket with password 131 description: An example configuration. 132 config: | 133 jobs: 134 - name: local 135 address: 'redis://:password@127.0.0.1:6379' 136 - name: Multi-instance 137 description: | 138 > **Note**: When you define multiple jobs, their names must be unique. 139 140 Local and remote instances. 141 config: | 142 jobs: 143 - name: local 144 address: 'redis://:password@127.0.0.1:6379' 145 146 - name: remote 147 address: 'redis://user:password@203.0.113.0:6379' 148 troubleshooting: 149 problems: 150 list: [] 151 alerts: 152 - name: redis_connections_rejected 153 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/redis.conf 154 metric: redis.connections 155 info: connections rejected because of maxclients limit in the last minute 156 - name: redis_bgsave_slow 157 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/redis.conf 158 metric: redis.bgsave_now 159 info: duration of the on-going RDB save operation 160 - name: redis_bgsave_broken 161 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/redis.conf 162 metric: redis.bgsave_health 163 info: 'status of the last RDB save operation (0: ok, 1: error)' 164 - name: redis_master_link_down 165 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/redis.conf 166 metric: redis.master_link_down_since_time 167 info: time elapsed since the link between master and slave is down 168 metrics: 169 folding: 170 title: Metrics 171 enabled: false 172 description: "" 173 availability: [] 174 scopes: 175 - name: global 176 description: These metrics refer to the entire monitored application. 177 labels: [] 178 metrics: 179 - name: redis.connections 180 description: Accepted and rejected (maxclients limit) connections 181 unit: connections/s 182 chart_type: line 183 dimensions: 184 - name: accepted 185 - name: rejected 186 - name: redis.clients 187 description: Clients 188 unit: clients 189 chart_type: line 190 dimensions: 191 - name: connected 192 - name: blocked 193 - name: tracking 194 - name: in_timeout_table 195 - name: redis.ping_latency 196 description: Ping latency 197 unit: seconds 198 chart_type: area 199 dimensions: 200 - name: min 201 - name: max 202 - name: avg 203 - name: redis.commands 204 description: Processed commands 205 unit: commands/s 206 chart_type: line 207 dimensions: 208 - name: processes 209 - name: redis.keyspace_lookup_hit_rate 210 description: Keys lookup hit rate 211 unit: percentage 212 chart_type: line 213 dimensions: 214 - name: lookup_hit_rate 215 - name: redis.memory 216 description: Memory usage 217 unit: bytes 218 chart_type: area 219 dimensions: 220 - name: max 221 - name: used 222 - name: rss 223 - name: peak 224 - name: dataset 225 - name: lua 226 - name: scripts 227 - name: redis.mem_fragmentation_ratio 228 description: Ratio between used_memory_rss and used_memory 229 unit: ratio 230 chart_type: line 231 dimensions: 232 - name: mem_fragmentation 233 - name: redis.key_eviction_events 234 description: Evicted keys due to maxmemory limit 235 unit: keys/s 236 chart_type: line 237 dimensions: 238 - name: evicted 239 - name: redis.net 240 description: Bandwidth 241 unit: kilobits/s 242 chart_type: area 243 dimensions: 244 - name: received 245 - name: sent 246 - name: redis.rdb_changes 247 description: Operations that produced changes since the last SAVE or BGSAVE 248 unit: operations 249 chart_type: line 250 dimensions: 251 - name: changes 252 - name: redis.bgsave_now 253 description: Duration of the on-going RDB save operation if any 254 unit: seconds 255 chart_type: line 256 dimensions: 257 - name: current_bgsave_time 258 - name: redis.bgsave_health 259 description: 'Status of the last RDB save operation (0: ok, 1: err)' 260 unit: status 261 chart_type: line 262 dimensions: 263 - name: last_bgsave 264 - name: redis.bgsave_last_rdb_save_since_time 265 description: Time elapsed since the last successful RDB save 266 unit: seconds 267 chart_type: line 268 dimensions: 269 - name: last_bgsave_time 270 - name: redis.aof_file_size 271 description: AOF file size 272 unit: bytes 273 chart_type: line 274 dimensions: 275 - name: current 276 - name: base 277 - name: redis.commands_calls 278 description: Calls per command 279 unit: calls 280 chart_type: stacked 281 dimensions: 282 - name: a dimension per command 283 - name: redis.commands_usec 284 description: Total CPU time consumed by the commands 285 unit: microseconds 286 chart_type: stacked 287 dimensions: 288 - name: a dimension per command 289 - name: redis.commands_usec_per_sec 290 description: Average CPU consumed per command execution 291 unit: microseconds/s 292 chart_type: stacked 293 dimensions: 294 - name: a dimension per command 295 - name: redis.key_expiration_events 296 description: Expired keys 297 unit: keys/s 298 chart_type: line 299 dimensions: 300 - name: expired 301 - name: redis.database_keys 302 description: Keys per database 303 unit: keys 304 chart_type: line 305 dimensions: 306 - name: a dimension per database 307 - name: redis.database_expires_keys 308 description: Keys with an expiration per database 309 unit: keys 310 chart_type: line 311 dimensions: 312 - name: a dimension per database 313 - name: redis.connected_replicas 314 description: Connected replicas 315 unit: replicas 316 chart_type: line 317 dimensions: 318 - name: connected 319 - name: redis.master_link_status 320 description: Master link status 321 unit: status 322 chart_type: line 323 dimensions: 324 - name: up 325 - name: down 326 - name: redis.master_last_io_since_time 327 description: Time elapsed since the last interaction with master 328 unit: seconds 329 chart_type: line 330 dimensions: 331 - name: time 332 - name: redis.master_link_down_since_time 333 description: Time elapsed since the link between master and slave is down 334 unit: seconds 335 chart_type: line 336 dimensions: 337 - name: time 338 - name: redis.uptime 339 description: Uptime 340 unit: seconds 341 chart_type: line 342 dimensions: 343 - name: uptime