summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/redis/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/redis/README.md')
-rw-r--r--collectors/python.d.plugin/redis/README.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/redis/README.md b/collectors/python.d.plugin/redis/README.md
new file mode 100644
index 0000000..9fab56c
--- /dev/null
+++ b/collectors/python.d.plugin/redis/README.md
@@ -0,0 +1,64 @@
+<!--
+title: "Redis monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/redis/README.md
+sidebar_label: "Redis"
+-->
+
+# Redis monitoring with Netdata
+
+Monitors database status. It reads server response to `INFO` command.
+
+Following charts are drawn:
+
+1. **Operations** per second
+
+ - operations
+
+2. **Hit rate** in percent
+
+ - rate
+
+3. **Memory utilization** in kilobytes
+
+ - total
+ - lua
+
+4. **Database keys**
+
+ - lines are creates dynamically based on how many databases are there
+
+5. **Clients**
+
+ - connected
+ - blocked
+
+6. **Slaves**
+
+ - connected
+
+## Configuration
+
+Edit the `python.d/redis.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/redis.conf
+```
+
+```yaml
+socket:
+ name : 'local'
+ socket : '/var/lib/redis/redis.sock'
+
+localhost:
+ name : 'local'
+ host : 'localhost'
+ port : 6379
+```
+
+When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:6379`.
+
+---
+
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fredis%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)