3 Every module should be compatible with python2 and python3.
4 All third party libraries should be installed system-wide or in `python_modules` directory.
5 Module configurations are written in YAML and **pyYAML is required**.
7 Every configuration file must have one of two formats:
9 - Configuration for only one job:
12 update_every : 2 # update frequency
13 retries : 1 # how many failures in update() is tolerated
14 priority : 20000 # where it is shown on dashboard
16 other_var1 : bla # variables passed to module
20 - Configuration for many jobs (ex. mysql):
29 update_every : 5 # job update frequency
30 other_var1 : some_val # module specific variable
33 priority : 5 # job position on dashboard
34 retries : 20 # job retries
35 other_var2 : val # module specific variable
38 `update_every`, `retries`, and `priority` are always optional.
42 The following python.d modules are supported:
46 This module will monitor one or more apache servers depending on configuration.
49 * apache with enabled `mod_status`
51 It produces the following charts:
53 1. **Requests** in requests/s
59 3. **Async Connections**
64 4. **Bandwidth** in kilobytes/s
71 6. **Lifetime Avg. Requests/s** in requests/s
74 7. **Lifetime Avg. Bandwidth/s** in kilobytes/s
77 8. **Lifetime Avg. Response Size** in bytes/request
82 Needs only `url` to server's `server-status?auto`
84 Here is an example for 2 servers:
91 url : 'http://localhost/server-status?auto'
95 url : 'http://www.apache.org/server-status?auto'
100 Without configuration, module attempts to connect to `http://localhost/server-status?auto`
106 Module monitors apache mod_cache log and produces only one chart:
108 **cached responses** in percent cached
121 log_path : '/var/log/apache2/cache.log'
124 If no configuration is given, module will attempt to read log file at `/var/log/apache2/cache.log`
130 Module parses bind dump file to collect real-time performance metrics
133 * Version of bind must be 9.6 +
134 * Netdata must have permissions to run `rndc status`
138 1. **Name server statistics**
151 2. **Incoming queries**
172 3. **Outgoing queries**
173 * Same as Incoming queries
182 named_stats_path : '/var/log/bind/named.stats'
185 If no configuration is given, module will attempt to read named.stats file at `/var/log/bind/named.stats`
191 This module shows the current CPU frequency as set by the cpufreq kernel
195 You need to have `CONFIG_CPU_FREQ` and (optionally) `CONFIG_CPU_FREQ_STAT`
196 enabled in your kernel.
198 This module tries to read from one of two possible locations. On
199 initialization, it tries to read the `time_in_state` files provided by
200 cpufreq\_stats. If this file does not exist, or doesn't contain valid data, it
201 falls back to using the more inaccurate `scaling_cur_freq` file (which only
202 represents the **current** CPU frequency, and doesn't account for any state
203 changes which happen between updates).
205 It produces one chart with multiple lines (one line per core).
212 sys_dir: "/sys/devices"
215 If no configuration is given, module will search for cpufreq files in `/sys/devices` directory.
216 Directory is also prefixed with `NETDATA_HOST_PREFIX` if specified.
222 This module monitors the usage of CPU idle states.
225 Your kernel needs to have `CONFIG_CPU_IDLE` enabled.
227 It produces one stacked chart per CPU, showing the percentage of time spent in
234 This module provides statistics information from dovecot server.
235 Statistics are taken from dovecot socket by executing `EXPORT global` command.
236 More information about dovecot stats can be found on [project wiki page.](http://wiki2.dovecot.org/Statistics)
239 Dovecot unix socket with R/W permissions for user netdata or dovecot with configured TCP/IP socket.
241 Module gives information with following charts:
249 3. **commands** - number of IMAP commands
256 5. **Context Switches**
260 6. **disk** in bytes/s
264 7. **bytes** in bytes/s
268 8. **number of syscalls** in syscalls/s
272 9. **lookups** - number of lookups per second
276 10. **hits** - number of cache hits
279 11. **attempts** - authorization attemts
283 12. **cache** - cached authorization hits
299 socket : '/var/run/dovecot/stats'
302 If no configuration is given, module will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`
308 Simple module executing `exim -bpc` to grab exim queue.
309 This command can take a lot of time to finish its execution thus it is not recommended to run it every second.
311 It produces only one chart:
313 1. **Exim Queue Emails**
316 Configuration is not needed.
322 Module monitor fail2ban log file to show all bans for all active jails
325 * fail2ban.log file MUST BE readable by netdata (A good idea is to add **create 0640 root netdata** to fail2ban conf at logrotate.d)
327 It produces one chart with multiple lines (one line per jail)
335 log_path: '/var/log/fail2ban.log'
336 conf_path: '/etc/fail2ban/jail.local'
337 exclude: 'dropbear apache'
339 If no configuration is given, module will attempt to read log file at `/var/log/fail2ban.log` and conf file at `/etc/fail2ban/jail.local`.
340 If conf file is not found default jail is `ssh`.
346 Uses the `radclient` command to provide freeradius statistics. It is not recommended to run it every second.
350 1. **Authentication counters:**
353 * auth-dropped-requests
354 * auth-duplicate-requests
355 * auth-invalid-requests
356 * auth-malformed-requests
359 2. **Accounting counters:** [optional]
360 * accounting-requests
361 * accounting-responses
362 * acct-dropped-requests
363 * acct-duplicate-requests
364 * acct-invalid-requests
365 * acct-malformed-requests
368 3. **Proxy authentication counters:** [optional]
369 * proxy-access-accepts
370 * proxy-access-rejects
371 * proxy-auth-dropped-requests
372 * proxy-auth-duplicate-requests
373 * proxy-auth-invalid-requests
374 * proxy-auth-malformed-requests
375 * proxy-auth-unknown-types
377 4. **Proxy accounting counters:** [optional]
378 * proxy-accounting-requests
379 * proxy-accounting-responses
380 * proxy-acct-dropped-requests
381 * proxy-acct-duplicate-requests
382 * proxy-acct-invalid-requests
383 * proxy-acct-malformed-requests
384 * proxy-acct-unknown-typesa
395 secret : 'adminsecret'
396 acct : False # Freeradius accounting statistics.
397 proxy_auth : False # Freeradius proxy authentication statistics.
398 proxy_acct : False # Freeradius proxy accounting statistics.
401 **Freeradius server configuration:**
403 The configuration for the status server is automatically created in the sites-available directory.
404 By default, server is enabled and can be queried from every client.
405 FreeRADIUS will only respond to status-server messages, if the status-server virtual server has been enabled.
407 To do this, create a link from the sites-enabled directory to the status file in the sites-available directory:
409 * ln -s ../sites-available/status status
411 and restart/reload your FREERADIUS server.
417 Module monitors frontend and backend metrics such as bytes in, bytes out, sessions current, sessions in queue current.
418 And health metrics such as backend servers status (server check should be used).
420 Plugin can obtain data from url **OR** unix socket.
423 Socket MUST be readable AND writable by netdata user.
427 1. **Frontend** family charts
431 * Sessions in queue current
433 2. **Backend** family charts
437 * Sessions in queue current
440 * number of failed servers for every backend (in DOWN state)
449 user : 'username' # ONLY IF stats auth is used
450 pass : 'password' # # ONLY IF stats auth is used
451 url : 'http://ip.address:port/url;csv;norefresh'
458 socket : 'path/to/haproxy/sock'
461 If no configuration is given, module will fail to run.
467 Module monitors disk temperatures from one or more hddtemp daemons.
470 Running `hddtemp` in daemonized mode with access on tcp port
472 It produces one chart **Temperature** with dynamic number of dimensions (one per disk)
484 If no configuration is given, module will attempt to connect to hddtemp daemon on `127.0.0.1:7634` address
490 Module monitors [IPFS](https://ipfs.io) basic information.
492 1. **Bandwidth** in kbits/s
501 Only url to IPFS server is needed.
508 url : 'http://localhost:5001'
515 Module monitor leases database to show all active leases for given pools.
518 * dhcpd leases file MUST BE readable by netdata
519 * pools MUST BE in CIDR format
523 1. **Pools utilization** Aggregate chart for all pools.
524 * utilization in percent
527 * leases (overall number of leases for all pools)
529 3. **Active leases** for every pools
530 * leases (number of active leases in pool)
539 leases_path : '/var/lib/dhcp/dhcpd.leases'
540 pools : '192.168.3.0/24 192.168.4.0/24 192.168.5.0/24'
543 In case of python2 you need to install `py2-ipaddress` to make plugin work.
544 The module will not work If no configuration is given.
551 Module monitor /proc/mdstat
555 1. **Health** Number of failed disks in every array (aggregate chart).
558 * total (number of devices array ideally would have)
559 * inuse (number of devices currently are in use)
561 3. **Current status**
563 * recovery in percent
567 4. **Operation status** (if resync/recovery/reshape/check is active)
569 * speed in megabytes/s
572 No configuration is needed.
578 Memcached monitoring module. Data grabbed from [stats interface](https://github.com/memcached/memcached/wiki/Commands#stats).
580 1. **Network** in kilobytes/s
584 2. **Connections** per second
589 3. **Items** in cluster
593 4. **Evicted and Reclaimed** items
597 5. **GET** requests/s
601 6. **GET rate** rate in requests/s
604 7. **SET rate** rate in requests/s
607 8. **DELETE** requests/s
611 9. **CAS** requests/s
616 10. **Increment** requests/s
620 11. **Decrement** requests/s
624 12. **Touch** requests/s
628 13. **Touch rate** rate in requests/s
642 If no configuration is given, module will attempt to connect to memcached instance on `127.0.0.1:11211` address.
648 Module monitors one or more mysql servers
651 * python library [MySQLdb](https://github.com/PyMySQL/mysqlclient-python) (faster) or [PyMySQL](https://github.com/PyMySQL/PyMySQL) (slower)
653 It will produce following charts (if data is available):
655 1. **Bandwidth** in kbps
659 2. **Queries** in queries/sec
664 3. **Operations** in operations/sec
681 4. **Table Locks** in locks/sec
685 5. **Select Issues** in issues/sec
692 6. **Sort Issues** in issues/sec
699 You can provide, per server, the following:
701 1. username which have access to database (deafults to 'root')
702 2. password (defaults to none)
703 3. mysql my.cnf configuration file
704 4. mysql socket (optional)
705 5. mysql host (ip or hostname)
706 6. mysql port (defaults to 3306)
708 Here is an example for 3 servers:
716 'my.cnf' : '/etc/mysql/my.cnf'
721 pass : 'blablablabla'
722 socket : '/var/run/mysqld/mysqld.sock'
733 If no configuration is given, module will attempt to connect to mysql server via unix socket at `/var/run/mysqld/mysqld.sock` without password and with username `root`
739 This module will monitor one or more nginx servers depending on configuration. Servers can be either local or remote.
742 * nginx with configured 'ngx_http_stub_status_module'
743 * 'location /stub_status'
745 Example nginx configuration can be found in 'python.d/nginx.conf'
747 It produces following charts:
749 1. **Active Connections**
752 2. **Requests** in requests/s
755 3. **Active Connections by Status**
760 4. **Connections Rate** in connections/s
766 Needs only `url` to server's `stub_status`
768 Here is an example for local server:
775 url : 'http://localhost/stub_status'
779 Without configuration, module attempts to connect to `http://localhost/stub_status`
785 Module monitors nginx access log and produces only one chart:
787 1. **nginx status codes** in requests/s
795 Sample for two vhosts:
799 path: '/var/log/nginx/access-A.log'
803 path: '/var/log/nginx/access-B.log'
806 When no configuration file is found, module tries to parse `/var/log/nginx/access.log` file.
812 Module monitor openvpn-status log file.
816 * If you are running multiple OpenVPN instances out of the same directory, MAKE SURE TO EDIT DIRECTIVES which create output files
817 so that multiple instances do not overwrite each other's output files.
819 * Make sure NETDATA USER CAN READ openvpn-status.log
821 * Update_every interval MUST MATCH interval on which OpenVPN writes operational status to log file.
825 1. **Users** OpenVPN active users
828 2. **Traffic** OpenVPN overall bandwidth usage in kilobit/s
838 log_path : '/var/log/openvpn-status.log'
845 This module will monitor one or more php-fpm instances depending on configuration.
848 * php-fpm with enabled `status` page
849 * access to `status` page via web server
851 It produces following charts:
853 1. **Active Connections**
858 2. **Requests** in requests/s
867 Needs only `url` to server's `status`
869 Here is an example for local instance:
876 url : 'http://localhost/status'
880 Without configuration, module attempts to connect to `http://localhost/status`
886 Simple module executing `postfix -p` to grab postfix queue.
888 It produces only two charts:
890 1. **Postfix Queue Emails**
893 2. **Postfix Queue Emails Size** in KB
896 Configuration is not needed.
902 Get INFO data from redis instance.
904 Following charts are drawn:
906 1. **Operations** per second
909 2. **Hit rate** in percent
912 3. **Memory utilization** in kilobytes
917 * lines are creates dynamically based on how many databases are there
931 socket : '/var/lib/redis/redis.sock'
939 When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:6379`.
945 System sensors information.
947 Charts are created dynamically.
951 For detailed configuration information please read [`sensors.conf`](https://github.com/firehol/netdata/blob/master/conf.d/python.d/sensors.conf) file.
957 This module will monitor one or more squid instances depending on configuration.
959 It produces following charts:
961 1. **Client Bandwidth** in kilobits/s
966 2. **Client Requests** in requests/s
971 3. **Server Bandwidth** in kilobits/s
975 4. **Server Requests** in requests/s
985 request : 'cache_object://localhost:3128/counters'
990 Without any configuration module will try to autodetect where squid presents its `counters` data
996 Present tomcat containers memory utilization.
1000 1. **Requests** per second
1003 2. **Volume** in KB/s
1010 4. **JVM Free Memory** in MB
1018 url : 'http://127.0.0.1:8080/manager/status?XML=true'
1019 user : 'tomcat_username'
1020 pass : 'secret_tomcat_password'
1023 Without configuration, module attempts to connect to `http://localhost:8080/manager/status?XML=true`, without any credentials.
1024 So it will probably fail.
1030 Module uses the `varnishstat` command to provide varnish cache statistics.
1034 1. **Client metrics**
1037 * good client requests received
1039 2. **All history hit rate ratio**
1040 * cache hits in percent
1041 * cache miss in percent
1042 * cache hits for pass percent
1044 3. **Curent poll hit rate ratio**
1045 * cache hits in percent
1046 * cache miss in percent
1047 * cache hits for pass percent
1049 4. **Thread-related metrics** (only for varnish version 4+)
1050 * total number of threads
1052 * threads creation failed
1054 * length os session queue
1055 * sessions queued for thread
1057 5. **Backend health**
1058 * backend conn. success
1059 * backend conn. not attempted
1060 * backend conn. too many
1061 * backend conn. failures
1062 * backend conn. reuses
1063 * backend conn. recycles
1064 * backend conn. retry
1065 * backend requests made
1068 * memory available in megabytes
1069 * memory allocated in megabytes
1071 7. **Problems summary**
1073 * session accept failures
1074 * session pipe overflow
1075 * backend conn. not attempted
1076 * fetch failed (all causes)
1077 * backend conn. too many
1080 * length of session queue
1081 * HTTP header overflows
1083 * ESI parse warnings
1086 * varnish instance uptime in seconds
1090 No configuration is needed.