summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/memcached/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/memcached/README.md')
-rw-r--r--collectors/python.d.plugin/memcached/README.md99
1 files changed, 99 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/memcached/README.md b/collectors/python.d.plugin/memcached/README.md
new file mode 100644
index 0000000..19139ee
--- /dev/null
+++ b/collectors/python.d.plugin/memcached/README.md
@@ -0,0 +1,99 @@
+<!--
+title: "Memcached monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/memcached/README.md
+sidebar_label: "Memcached"
+-->
+
+# Memcached monitoring with Netdata
+
+Collects memory-caching system performance metrics. It reads server response to stats command ([stats interface](https://github.com/memcached/memcached/wiki/Commands#stats)).
+
+
+1. **Network** in kilobytes/s
+
+ - read
+ - written
+
+2. **Connections** per second
+
+ - current
+ - rejected
+ - total
+
+3. **Items** in cluster
+
+ - current
+ - total
+
+4. **Evicted and Reclaimed** items
+
+ - evicted
+ - reclaimed
+
+5. **GET** requests/s
+
+ - hits
+ - misses
+
+6. **GET rate** rate in requests/s
+
+ - rate
+
+7. **SET rate** rate in requests/s
+
+ - rate
+
+8. **DELETE** requests/s
+
+ - hits
+ - misses
+
+9. **CAS** requests/s
+
+ - hits
+ - misses
+ - bad value
+
+10. **Increment** requests/s
+
+ - hits
+ - misses
+
+11. **Decrement** requests/s
+
+ - hits
+ - misses
+
+12. **Touch** requests/s
+
+ - hits
+ - misses
+
+13. **Touch rate** rate in requests/s
+
+ - rate
+
+## Configuration
+
+Edit the `python.d/memcached.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/memcached.conf
+```
+
+Sample:
+
+```yaml
+localtcpip:
+ name : 'local'
+ host : '127.0.0.1'
+ port : 24242
+```
+
+If no configuration is given, module will attempt to connect to memcached instance on `127.0.0.1:11211` address.
+
+---
+
+