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 Module monitor elasticsearch performance and health metrics
311 * python `requests` package.
313 You need to install it manually. (python-requests or python3-requests depending on the version of python).
318 1. **Search performance** charts:
319 * Number of queries, fetches
320 * Time spent on queries, fetches
321 * Query and fetch latency
323 2. **Indexing performance** charts:
324 * Number of documents indexed, index refreshes, flushes
325 * Time spent on indexing, refreshing, flushing
326 * Indexing and flushing latency
328 3. **Memory usage and garbace collection** charts:
329 * JVM heap currently in use, commited
330 * Count of garbage collections
331 * Time spent on garbage collections
333 4. **Host metrics** charts:
334 * Available file descriptors in percent
335 * Opened HTTP connections
336 * Cluster communication transport metrics
338 5. **Queues and rejections** charts:
339 * Number of queued/rejected threads in thread pool
341 6. **Fielddata cache** charts:
342 * Fielddata cache size
343 * Fielddata evictions and circuit breaker tripped count
345 7. **Cluster health API** charts:
347 * Nodes and tasks statistics
350 8. **Cluster stats API** charts:
352 * Query cache statistics
355 * Indices and shards statistics
363 host : 'ipaddress' # Server ip address or hostname
364 port : 'password' # Port on which elasticsearch listed
365 cluster_health : True/False # Calls to cluster health elasticsearch API. Enabled by default.
366 cluster_stats : True/False # Calls to cluster stats elasticsearch API. Enabled by default.
369 If no configuration is given, module will fail to run.
375 Simple module executing `exim -bpc` to grab exim queue.
376 This command can take a lot of time to finish its execution thus it is not recommended to run it every second.
378 It produces only one chart:
380 1. **Exim Queue Emails**
383 Configuration is not needed.
389 Module monitor fail2ban log file to show all bans for all active jails
392 * fail2ban.log file MUST BE readable by netdata (A good idea is to add **create 0640 root netdata** to fail2ban conf at logrotate.d)
394 It produces one chart with multiple lines (one line per jail)
402 log_path: '/var/log/fail2ban.log'
403 conf_path: '/etc/fail2ban/jail.local'
404 exclude: 'dropbear apache'
406 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`.
407 If conf file is not found default jail is `ssh`.
413 Uses the `radclient` command to provide freeradius statistics. It is not recommended to run it every second.
417 1. **Authentication counters:**
420 * auth-dropped-requests
421 * auth-duplicate-requests
422 * auth-invalid-requests
423 * auth-malformed-requests
426 2. **Accounting counters:** [optional]
427 * accounting-requests
428 * accounting-responses
429 * acct-dropped-requests
430 * acct-duplicate-requests
431 * acct-invalid-requests
432 * acct-malformed-requests
435 3. **Proxy authentication counters:** [optional]
436 * proxy-access-accepts
437 * proxy-access-rejects
438 * proxy-auth-dropped-requests
439 * proxy-auth-duplicate-requests
440 * proxy-auth-invalid-requests
441 * proxy-auth-malformed-requests
442 * proxy-auth-unknown-types
444 4. **Proxy accounting counters:** [optional]
445 * proxy-accounting-requests
446 * proxy-accounting-responses
447 * proxy-acct-dropped-requests
448 * proxy-acct-duplicate-requests
449 * proxy-acct-invalid-requests
450 * proxy-acct-malformed-requests
451 * proxy-acct-unknown-typesa
462 secret : 'adminsecret'
463 acct : False # Freeradius accounting statistics.
464 proxy_auth : False # Freeradius proxy authentication statistics.
465 proxy_acct : False # Freeradius proxy accounting statistics.
468 **Freeradius server configuration:**
470 The configuration for the status server is automatically created in the sites-available directory.
471 By default, server is enabled and can be queried from every client.
472 FreeRADIUS will only respond to status-server messages, if the status-server virtual server has been enabled.
474 To do this, create a link from the sites-enabled directory to the status file in the sites-available directory:
476 * ln -s ../sites-available/status status
478 and restart/reload your FREERADIUS server.
484 Module monitors frontend and backend metrics such as bytes in, bytes out, sessions current, sessions in queue current.
485 And health metrics such as backend servers status (server check should be used).
487 Plugin can obtain data from url **OR** unix socket.
490 Socket MUST be readable AND writable by netdata user.
494 1. **Frontend** family charts
498 * Sessions in queue current
500 2. **Backend** family charts
504 * Sessions in queue current
507 * number of failed servers for every backend (in DOWN state)
516 user : 'username' # ONLY IF stats auth is used
517 pass : 'password' # # ONLY IF stats auth is used
518 url : 'http://ip.address:port/url;csv;norefresh'
525 socket : 'path/to/haproxy/sock'
528 If no configuration is given, module will fail to run.
534 Module monitors disk temperatures from one or more hddtemp daemons.
537 Running `hddtemp` in daemonized mode with access on tcp port
539 It produces one chart **Temperature** with dynamic number of dimensions (one per disk)
551 If no configuration is given, module will attempt to connect to hddtemp daemon on `127.0.0.1:7634` address
557 Module monitors [IPFS](https://ipfs.io) basic information.
559 1. **Bandwidth** in kbits/s
568 Only url to IPFS server is needed.
575 url : 'http://localhost:5001'
582 Module monitor leases database to show all active leases for given pools.
585 * dhcpd leases file MUST BE readable by netdata
586 * pools MUST BE in CIDR format
590 1. **Pools utilization** Aggregate chart for all pools.
591 * utilization in percent
594 * leases (overall number of leases for all pools)
596 3. **Active leases** for every pools
597 * leases (number of active leases in pool)
606 leases_path : '/var/lib/dhcp/dhcpd.leases'
607 pools : '192.168.3.0/24 192.168.4.0/24 192.168.5.0/24'
610 In case of python2 you need to install `py2-ipaddress` to make plugin work.
611 The module will not work If no configuration is given.
618 Module monitor /proc/mdstat
622 1. **Health** Number of failed disks in every array (aggregate chart).
625 * total (number of devices array ideally would have)
626 * inuse (number of devices currently are in use)
628 3. **Current status**
630 * recovery in percent
634 4. **Operation status** (if resync/recovery/reshape/check is active)
636 * speed in megabytes/s
639 No configuration is needed.
645 Memcached monitoring module. Data grabbed from [stats interface](https://github.com/memcached/memcached/wiki/Commands#stats).
647 1. **Network** in kilobytes/s
651 2. **Connections** per second
656 3. **Items** in cluster
660 4. **Evicted and Reclaimed** items
664 5. **GET** requests/s
668 6. **GET rate** rate in requests/s
671 7. **SET rate** rate in requests/s
674 8. **DELETE** requests/s
678 9. **CAS** requests/s
683 10. **Increment** requests/s
687 11. **Decrement** requests/s
691 12. **Touch** requests/s
695 13. **Touch rate** rate in requests/s
709 If no configuration is given, module will attempt to connect to memcached instance on `127.0.0.1:11211` address.
715 Module monitors one or more mysql servers
718 * python library [MySQLdb](https://github.com/PyMySQL/mysqlclient-python) (faster) or [PyMySQL](https://github.com/PyMySQL/PyMySQL) (slower)
720 It will produce following charts (if data is available):
722 1. **Bandwidth** in kbps
726 2. **Queries** in queries/sec
731 3. **Operations** in operations/sec
748 4. **Table Locks** in locks/sec
752 5. **Select Issues** in issues/sec
759 6. **Sort Issues** in issues/sec
766 You can provide, per server, the following:
768 1. username which have access to database (deafults to 'root')
769 2. password (defaults to none)
770 3. mysql my.cnf configuration file
771 4. mysql socket (optional)
772 5. mysql host (ip or hostname)
773 6. mysql port (defaults to 3306)
775 Here is an example for 3 servers:
783 'my.cnf' : '/etc/mysql/my.cnf'
788 pass : 'blablablabla'
789 socket : '/var/run/mysqld/mysqld.sock'
800 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`
806 This module will monitor one or more nginx servers depending on configuration. Servers can be either local or remote.
809 * nginx with configured 'ngx_http_stub_status_module'
810 * 'location /stub_status'
812 Example nginx configuration can be found in 'python.d/nginx.conf'
814 It produces following charts:
816 1. **Active Connections**
819 2. **Requests** in requests/s
822 3. **Active Connections by Status**
827 4. **Connections Rate** in connections/s
833 Needs only `url` to server's `stub_status`
835 Here is an example for local server:
842 url : 'http://localhost/stub_status'
846 Without configuration, module attempts to connect to `http://localhost/stub_status`
852 Module monitors nginx access log and produces only one chart:
854 1. **nginx status codes** in requests/s
862 Sample for two vhosts:
866 path: '/var/log/nginx/access-A.log'
870 path: '/var/log/nginx/access-B.log'
873 When no configuration file is found, module tries to parse `/var/log/nginx/access.log` file.
879 Module monitor openvpn-status log file.
883 * If you are running multiple OpenVPN instances out of the same directory, MAKE SURE TO EDIT DIRECTIVES which create output files
884 so that multiple instances do not overwrite each other's output files.
886 * Make sure NETDATA USER CAN READ openvpn-status.log
888 * Update_every interval MUST MATCH interval on which OpenVPN writes operational status to log file.
892 1. **Users** OpenVPN active users
895 2. **Traffic** OpenVPN overall bandwidth usage in kilobit/s
905 log_path : '/var/log/openvpn-status.log'
912 This module will monitor one or more php-fpm instances depending on configuration.
915 * php-fpm with enabled `status` page
916 * access to `status` page via web server
918 It produces following charts:
920 1. **Active Connections**
925 2. **Requests** in requests/s
934 Needs only `url` to server's `status`
936 Here is an example for local instance:
943 url : 'http://localhost/status'
947 Without configuration, module attempts to connect to `http://localhost/status`
953 Simple module executing `postfix -p` to grab postfix queue.
955 It produces only two charts:
957 1. **Postfix Queue Emails**
960 2. **Postfix Queue Emails Size** in KB
963 Configuration is not needed.
969 Get INFO data from redis instance.
971 Following charts are drawn:
973 1. **Operations** per second
976 2. **Hit rate** in percent
979 3. **Memory utilization** in kilobytes
984 * lines are creates dynamically based on how many databases are there
998 socket : '/var/lib/redis/redis.sock'
1006 When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:6379`.
1012 System sensors information.
1014 Charts are created dynamically.
1018 For detailed configuration information please read [`sensors.conf`](https://github.com/firehol/netdata/blob/master/conf.d/python.d/sensors.conf) file.
1024 This module will monitor one or more squid instances depending on configuration.
1026 It produces following charts:
1028 1. **Client Bandwidth** in kilobits/s
1033 2. **Client Requests** in requests/s
1038 3. **Server Bandwidth** in kilobits/s
1042 4. **Server Requests** in requests/s
1052 request : 'cache_object://localhost:3128/counters'
1057 Without any configuration module will try to autodetect where squid presents its `counters` data
1063 Present tomcat containers memory utilization.
1067 1. **Requests** per second
1070 2. **Volume** in KB/s
1077 4. **JVM Free Memory** in MB
1085 url : 'http://127.0.0.1:8080/manager/status?XML=true'
1086 user : 'tomcat_username'
1087 pass : 'secret_tomcat_password'
1090 Without configuration, module attempts to connect to `http://localhost:8080/manager/status?XML=true`, without any credentials.
1091 So it will probably fail.
1097 Module uses the `varnishstat` command to provide varnish cache statistics.
1101 1. **Client metrics**
1104 * good client requests received
1106 2. **All history hit rate ratio**
1107 * cache hits in percent
1108 * cache miss in percent
1109 * cache hits for pass percent
1111 3. **Curent poll hit rate ratio**
1112 * cache hits in percent
1113 * cache miss in percent
1114 * cache hits for pass percent
1116 4. **Thread-related metrics** (only for varnish version 4+)
1117 * total number of threads
1119 * threads creation failed
1121 * length os session queue
1122 * sessions queued for thread
1124 5. **Backend health**
1125 * backend conn. success
1126 * backend conn. not attempted
1127 * backend conn. too many
1128 * backend conn. failures
1129 * backend conn. reuses
1130 * backend conn. recycles
1131 * backend conn. retry
1132 * backend requests made
1135 * memory available in megabytes
1136 * memory allocated in megabytes
1138 7. **Problems summary**
1140 * session accept failures
1141 * session pipe overflow
1142 * backend conn. not attempted
1143 * fetch failed (all causes)
1144 * backend conn. too many
1147 * length of session queue
1148 * HTTP header overflows
1150 * ESI parse warnings
1153 * varnish instance uptime in seconds
1157 No configuration is needed.