summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/dovecot
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/dovecot')
-rw-r--r--collectors/python.d.plugin/dovecot/README.md76
1 files changed, 44 insertions, 32 deletions
diff --git a/collectors/python.d.plugin/dovecot/README.md b/collectors/python.d.plugin/dovecot/README.md
index de8788b36..6048f1a63 100644
--- a/collectors/python.d.plugin/dovecot/README.md
+++ b/collectors/python.d.plugin/dovecot/README.md
@@ -9,55 +9,67 @@ Module isn't compatible with new statistic api (v2.3), but you are still able to
by following [upgrading steps.](https://wiki2.dovecot.org/Upgrading/2.3).
**Requirement:**
-Dovecot UNIX socket with R/W permissions for user netdata or Dovecot with configured TCP/IP socket.
+Dovecot UNIX socket with R/W permissions for user `netdata` or Dovecot with configured TCP/IP socket.
Module gives information with following charts:
-1. **sessions**
- * active sessions
+1. **sessions**
-2. **logins**
- * logins
+ - active sessions
-3. **commands** - number of IMAP commands
- * commands
+2. **logins**
-4. **Faults**
- * minor
- * major
+ - logins
-5. **Context Switches**
- * volountary
- * involountary
+3. **commands** - number of IMAP commands
-6. **disk** in bytes/s
- * read
- * write
+ - commands
-7. **bytes** in bytes/s
- * read
- * write
+4. **Faults**
-8. **number of syscalls** in syscalls/s
- * read
- * write
+ - minor
+ - major
-9. **lookups** - number of lookups per second
- * path
- * attr
+5. **Context Switches**
+
+ - volountary
+ - involountary
+
+6. **disk** in bytes/s
+
+ - read
+ - write
+
+7. **bytes** in bytes/s
+
+ - read
+ - write
+
+8. **number of syscalls** in syscalls/s
+
+ - read
+ - write
+
+9. **lookups** - number of lookups per second
+
+ - path
+ - attr
10. **hits** - number of cache hits
- * hits
+
+ - hits
11. **attempts** - authorization attempts
- * success
- * failure
+
+ - success
+ - failure
12. **cache** - cached authorization hits
- * hit
- * miss
-### configuration
+ - hit
+ - miss
+
+## configuration
Sample:
@@ -76,4 +88,4 @@ If no configuration is given, module will attempt to connect to dovecot using un
---
-[![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%2Fdovecot%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![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%2Fdovecot%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)