@cryptotaxi247 / netdata-1 / commits / 38e9b5e1c

add readme and change Makefiles

Wing924 committed Feb 26, 2018 at 11:22 UTC 38e9b5e1cfdc8c4b19306c0573ebc4ed1ea21d88
2 files changed +165 -136
conf.d/Makefile.am
+1
@@ -64,6 +64,7 @@ dist_pythonconfig_DATA = \
64 python.d/retroshare.conf \
65 python.d/samba.conf \
66 python.d/sensors.conf \
67 + python.d/springboot.conf \
68 python.d/squid.conf \
69 python.d/smartd_log.conf \
70 python.d/tomcat.conf \
python.d/README.md
+164 -136
@@ -29,7 +29,7 @@ local: # job name
29 update_every : 5 # job update frequency
30 other_var1 : some_val # module specific variable
31
32 -other_job:
32 +other_job:
33 priority : 5 # job position on dashboard
34 retries : 20 # job retries
35 other_var2 : val # module specific variable
@@ -43,7 +43,7 @@ The following python.d modules are supported:
43
44 # apache
45
46 -This module will monitor one or more apache servers depending on configuration.
46 +This module will monitor one or more apache servers depending on configuration.
47
48 **Requirements:**
49 * apache with enabled `mod_status`
@@ -60,20 +60,20 @@ It produces the following charts:
60 * keepalive
61 * closing
62 * writing
63 -
63 +
64 4. **Bandwidth** in kilobytes/s
65 * sent
66 -
66 +
67 5. **Workers**
68 * idle
69 * busy
70 -
70 +
71 6. **Lifetime Avg. Requests/s** in requests/s
72 * requests_sec
73 -
73 +
74 7. **Lifetime Avg. Bandwidth/s** in kilobytes/s
75 * size_sec
76 -
76 +
77 8. **Lifetime Avg. Response Size** in bytes/request
78 * size_req
79
@@ -109,7 +109,7 @@ Module monitors apache mod_cache log and produces only one chart:
109 * hit
110 * miss
111 * other
112 -
112 +
113 ### configuration
114
115 Sample:
@@ -138,14 +138,14 @@ Module provides server and tube level statistics:
138 1. **Cpu usage** in cpu time
139 * user
140 * system
141 -
141 +
142 2. **Jobs rate** in jobs/s
143 * total
144 * timeouts
145 -
145 +
146 3. **Connections rate** in connections/s
147 * connections
148 -
148 +
149 4. **Commands rate** in commands/s
150 * put
151 * peek
@@ -167,27 +167,27 @@ Module provides server and tube level statistics:
167 * list-tube-used
168 * list-tubes-watched
169 * pause-tube
170 -
170 +
171 5. **Current tubes** in tubes
172 * tubes
173 -
173 +
174 6. **Current jobs** in jobs
175 * urgent
176 * ready
177 * reserved
178 * delayed
179 * buried
180 -
180 +
181 7. **Current connections** in connections
182 * written
183 * producers
184 * workers
185 * waiting
186 -
186 +
187 8. **Binlog** in records/s
188 * written
189 * migrated
190 -
190 +
191 9. **Uptime** in seconds
192 * uptime
193
@@ -195,7 +195,7 @@ Module provides server and tube level statistics:
195
196 1. **Jobs rate** in jobs/s
197 * jobs
198 -
198 +
199 2. **Jobs** in jobs
200 * using
201 * ready
@@ -211,12 +211,12 @@ Module provides server and tube level statistics:
211 4. **Commands** in commands/s
212 * deletes
213 * pauses
214 -
214 +
215 5. **Pause** in seconds
216 * since
217 * left
218
219 -
219 +
220 ### configuration
221
222 Sample:
@@ -252,7 +252,7 @@ It produces:
252 * recursion
253 * duplicate
254 * rejections
255 -
255 +
256 2. **Incoming queries**
257 * RESERVED0
258 * A
@@ -273,7 +273,7 @@ It produces:
273 * SPF
274 * ANY
275 * DLV
276 -
276 +
277 3. **Outgoing queries**
278 * Same as Incoming queries
279
@@ -500,13 +500,13 @@ localhost:
500
501 # dovecot
502
503 -This module provides statistics information from dovecot server.
503 +This module provides statistics information from dovecot server.
504 Statistics are taken from dovecot socket by executing `EXPORT global` command.
505 More information about dovecot stats can be found on [project wiki page.](http://wiki2.dovecot.org/Statistics)
506
507 **Requirement:**
508 Dovecot unix socket with R/W permissions for user netdata or dovecot with configured TCP/IP socket.
509 -
509 +
510 Module gives information with following charts:
511
512 1. **sessions**
@@ -515,25 +515,25 @@ Module gives information with following charts:
515 2. **logins**
516 * logins
517
518 -3. **commands** - number of IMAP commands
518 +3. **commands** - number of IMAP commands
519 * commands
520 -
520 +
521 4. **Faults**
522 * minor
523 * major
524 -
525 -5. **Context Switches**
524 +
525 +5. **Context Switches**
526 * volountary
527 * involountary
528 -
528 +
529 6. **disk** in bytes/s
530 * read
531 * write
532 -
532 +
533 7. **bytes** in bytes/s
534 * read
535 * write
536 -
536 +
537 8. **number of syscalls** in syscalls/s
538 * read
539 * write
@@ -542,7 +542,7 @@ Module gives information with following charts:
542 * path
543 * attr
544
545 -10. **hits** - number of cache hits
545 +10. **hits** - number of cache hits
546 * hits
547
548 11. **attempts** - authorization attemts
@@ -552,7 +552,7 @@ Module gives information with following charts:
552 12. **cache** - cached authorization hits
553 * hit
554 * miss
555 -
555 +
556 ### configuration
557
558 Sample:
@@ -594,7 +594,7 @@ It produces:
594 * Time spent on garbage collections
595
596 4. **Host metrics** charts:
597 - * Available file descriptors in percent
597 + * Available file descriptors in percent
598 * Opened HTTP connections
599 * Cluster communication transport metrics
600
@@ -635,7 +635,7 @@ If no configuration is given, module will fail to run.
635
636 # exim
637
638 -Simple module executing `exim -bpc` to grab exim queue.
638 +Simple module executing `exim -bpc` to grab exim queue.
639 This command can take a lot of time to finish its execution thus it is not recommended to run it every second.
640
641 It produces only one chart:
@@ -649,13 +649,13 @@ Configuration is not needed.
649
650 # fail2ban
651
652 -Module monitor fail2ban log file to show all bans for all active jails
652 +Module monitor fail2ban log file to show all bans for all active jails
653
654 **Requirements:**
655 * fail2ban.log file MUST BE readable by netdata (A good idea is to add **create 0640 root netdata** to fail2ban conf at logrotate.d)
656 -
656 +
657 It produces one chart with multiple lines (one line per jail)
658 -
658 +
659 ### configuration
660
661 Sample:
@@ -724,14 +724,14 @@ local:
724 port : '18121'
725 secret : 'adminsecret'
726 acct : False # Freeradius accounting statistics.
727 - proxy_auth : False # Freeradius proxy authentication statistics.
727 + proxy_auth : False # Freeradius proxy authentication statistics.
728 proxy_acct : False # Freeradius proxy accounting statistics.
729 ```
730
731 **Freeradius server configuration:**
732
733 The configuration for the status server is automatically created in the sites-available directory.
734 -By default, server is enabled and can be queried from every client.
734 +By default, server is enabled and can be queried from every client.
735 FreeRADIUS will only respond to status-server messages, if the status-server virtual server has been enabled.
736
737 To do this, create a link from the sites-enabled directory to the status file in the sites-available directory:
@@ -754,30 +754,30 @@ For the memory statistics, it produces the following charts:
754
755 1. **Heap allocations** in kB
756 * alloc: size of objects allocated on the heap
757 - * inuse: size of allocated heap spans
758 -
757 + * inuse: size of allocated heap spans
758 +
759 2. **Stack allocations** in kB
760 * inuse: size of allocated stack spans
761 -
761 +
762 3. **MSpan allocations** in kB
763 * inuse: size of allocated mspan structures
764 -
764 +
765 4. **MCache allocations** in kB
766 * inuse: size of allocated mcache structures
767 -
767 +
768 5. **Virtual memory** in kB
769 * sys: size of reserved virtual address space
770 -
770 +
771 6. **Live objects**
772 * live: number of live objects in memory
773 -
773 +
774 7. **GC pauses average** in ns
775 * avg: average duration of all GC stop-the-world pauses
776 -
776 +
777 ### configuration
778 -
778 +
779 Please see the [wiki page](https://github.com/firehol/netdata/wiki/Monitoring-Go-Applications#using-netdata-go_expvar-module) for detailed info about module configuration.
780 -
780 +
781 ---
782
783 # haproxy
@@ -793,13 +793,13 @@ Socket MUST be readable AND writable by netdata user.
793 It produces:
794
795 1. **Frontend** family charts
796 - * Kilobytes in/s
796 + * Kilobytes in/s
797 * Kilobytes out/s
798 * Sessions current
799 * Sessions in queue current
800
801 2. **Backend** family charts
802 - * Kilobytes in/s
802 + * Kilobytes in/s
803 * Kilobytes out/s
804 * Sessions current
805 * Sessions in queue current
@@ -831,7 +831,7 @@ If no configuration is given, module will fail to run.
831 ---
832
833 # hddtemp
834 -
834 +
835 Module monitors disk temperatures from one or more hddtemp daemons.
836
837 **Requirement:**
@@ -860,13 +860,13 @@ Module monitors [IPFS](https://ipfs.io) basic information.
860 1. **Bandwidth** in kbits/s
861 * in
862 * out
863 -
863 +
864 2. **Peers**
865 * peers
866 -
866 +
867 ### configuration
868
869 -Only url to IPFS server is needed.
869 +Only url to IPFS server is needed.
870
871 Sample:
872
@@ -893,11 +893,11 @@ It produces:
893
894 2. **Total leases**
895 * leases (overall number of leases for all pools)
896 -
896 +
897 3. **Active leases** for every pools
898 * leases (number of active leases in pool)
899
900 -
900 +
901 ### configuration
902
903 Sample:
@@ -921,8 +921,8 @@ Module monitor /proc/mdstat
921 It produces:
922
923 1. **Health** Number of failed disks in every array (aggregate chart).
924 -
925 -2. **Disks stats**
924 +
925 +2. **Disks stats**
926 * total (number of devices array ideally would have)
927 * inuse (number of devices currently are in use)
928
@@ -931,11 +931,11 @@ It produces:
931 * recovery in percent
932 * reshape in percent
933 * check in percent
934 -
934 +
935 4. **Operation status** (if resync/recovery/reshape/check is active)
936 * finish in minutes
937 * speed in megabytes/s
938 -
938 +
939 ### configuration
940 No configuration is needed.
941
@@ -948,20 +948,20 @@ Memcached monitoring module. Data grabbed from [stats interface](https://github.
948 1. **Network** in kilobytes/s
949 * read
950 * written
951 -
951 +
952 2. **Connections** per second
953 * current
954 * rejected
955 * total
956 -
956 +
957 3. **Items** in cluster
958 * current
959 * total
960 -
960 +
961 4. **Evicted and Reclaimed** items
962 * evicted
963 * reclaimed
964 -
964 +
965 5. **GET** requests/s
966 * hits
967 * misses
@@ -971,7 +971,7 @@ Memcached monitoring module. Data grabbed from [stats interface](https://github.
971
972 7. **SET rate** rate in requests/s
973 * rate
974 -
974 +
975 8. **DELETE** requests/s
976 * hits
977 * misses
@@ -980,22 +980,22 @@ Memcached monitoring module. Data grabbed from [stats interface](https://github.
980 * hits
981 * misses
982 * bad value
983 -
983 +
984 10. **Increment** requests/s
985 * hits
986 * misses
987 -
987 +
988 11. **Decrement** requests/s
989 * hits
990 * misses
991 -
991 +
992 12. **Touch** requests/s
993 * hits
994 * misses
995 -
995 +
996 13. **Touch rate** rate in requests/s
997 * rate
998 -
998 +
999 ### configuration
1000
1001 Sample:
@@ -1247,7 +1247,7 @@ If no configuration is given, module will attempt to connect to mysql server via
1247
1248 # nginx
1249
1250 -This module will monitor one or more nginx servers depending on configuration. Servers can be either local or remote.
1250 +This module will monitor one or more nginx servers depending on configuration. Servers can be either local or remote.
1251
1252 **Requirements:**
1253 * nginx with configured 'ngx_http_stub_status_module'
@@ -1267,11 +1267,11 @@ It produces following charts:
1267 * reading
1268 * writing
1269 * waiting
1270 -
1270 +
1271 4. **Connections Rate** in connections/s
1272 * accepts
1273 * handled
1274 -
1274 +
1275 ### configuration
1276
1277 Needs only `url` to server's `stub_status`
@@ -1294,7 +1294,7 @@ Without configuration, module attempts to connect to `http://localhost/stub_stat
1294 # nginx_plus
1295
1296 This module will monitor one or more nginx_plus servers depending on configuration.
1297 -Servers can be either local or remote.
1297 +Servers can be either local or remote.
1298
1299 Example nginx_plus configuration can be found in 'python.d/nginx_plus.conf'
1300
@@ -1309,86 +1309,86 @@ It produces following charts:
1309 3. **Connection Statistics** in connections/s
1310 * accepted
1311 * dropped
1312 -
1312 +
1313 4. **Workers Statistics** in workers
1314 * idle
1315 * active
1316 -
1316 +
1317 5. **SSL Handshakes** in handshakes/s
1318 * successful
1319 * failed
1320 -
1320 +
1321 6. **SSL Session Reuses** in sessions/s
1322 * reused
1323 -
1323 +
1324 7. **SSL Memory Usage** in percent
1325 * usage
1326 -
1326 +
1327 8. **Processes** in processes
1328 * respawned
1329 -
1329 +
1330 For every server zone:
1331
1332 1. **Processing** in requests
1333 * processing
1334 -
1334 +
1335 2. **Requests** in requests/s
1336 * requests
1337 -
1337 +
1338 3. **Responses** in requests/s
1339 * 1xx
1340 * 2xx
1341 * 3xx
1342 * 4xx
1343 * 5xx
1344 -
1344 +
1345 4. **Traffic** in kilobits/s
1346 * received
1347 * sent
1348 -
1348 +
1349 For every upstream:
1350
1351 1. **Peers Requests** in requests/s
1352 * peer name (dimension per peer)
1353 -
1353 +
1354 2. **All Peers Responses** in responses/s
1355 * 1xx
1356 * 2xx
1357 * 3xx
1358 * 4xx
1359 * 5xx
1360 -
1360 +
1361 3. **Peer Responses** in requests/s (for every peer)
1362 * 1xx
1363 * 2xx
1364 * 3xx
1365 * 4xx
1366 * 5xx
1367 -
1367 +
1368 4. **Peers Connections** in active
1369 * peer name (dimension per peer)
1370 -
1370 +
1371 5. **Peers Connections Usage** in percent
1372 * peer name (dimension per peer)
1373 -
1373 +
1374 6. **All Peers Traffic** in KB
1375 * received
1376 * sent
1377 -
1377 +
1378 7. **Peer Traffic** in KB/s (for every peer)
1379 * received
1380 * sent
1381 -
1381 +
1382 8. **Peer Timings** in ms (for every peer)
1383 * header
1384 * response
1385 -
1385 +
1386 9. **Memory Usage** in percent
1387 * usage
1388
1389 10. **Peers Status** in state
1390 * peer name (dimension per peer)
1391 -
1391 +
1392 11. **Peers Total Downtime** in seconds
1393 * peer name (dimension per peer)
1394
@@ -1398,10 +1398,10 @@ For every cache:
1398 * served
1399 * written
1400 * bypass
1401 -
1401 +
1402 2. **Memory Usage** in percent
1403 * usage
1404 -
1404 +
1405 ### configuration
1406
1407 Needs only `url` to server's `status`
@@ -1543,7 +1543,7 @@ If no configuration is given, module will attempt to connect to `ntpd` on `::1:1
1543
1544 # ovpn_status_log
1545
1546 -Module monitor openvpn-status log file.
1546 +Module monitor openvpn-status log file.
1547
1548 **Requirements:**
1549
@@ -1553,16 +1553,16 @@ Module monitor openvpn-status log file.
1553 * Make sure NETDATA USER CAN READ openvpn-status.log
1554
1555 * Update_every interval MUST MATCH interval on which OpenVPN writes operational status to log file.
1556 -
1556 +
1557 It produces:
1558
1559 1. **Users** OpenVPN active users
1560 * users
1561 -
1561 +
1562 2. **Traffic** OpenVPN overall bandwidth usage in kilobit/s
1563 * in
1564 * out
1565 -
1565 +
1566 ### configuration
1567
1568 Sample:
@@ -1576,12 +1576,12 @@ default
1576
1577 # phpfpm
1578
1579 -This module will monitor one or more php-fpm instances depending on configuration.
1579 +This module will monitor one or more php-fpm instances depending on configuration.
1580
1581 **Requirements:**
1582 * php-fpm with enabled `status` page
1583 * access to `status` page via web server
1584 -
1584 +
1585 It produces following charts:
1586
1587 1. **Active Connections**
@@ -1591,15 +1591,15 @@ It produces following charts:
1591
1592 2. **Requests** in requests/s
1593 * requests
1594 -
1594 +
1595 3. **Performance**
1596 * reached
1597 * slow
1598 -
1598 +
1599 ### configuration
1600
1601 Needs only `url` to server's `status`
1602 -
1602 +
1603 Here is an example for local instance:
1604
1605 ```yaml
@@ -1623,7 +1623,7 @@ It produces only two charts:
1623
1624 1. **Postfix Queue Emails**
1625 * emails
1626 -
1626 +
1627 2. **Postfix Queue Emails Size** in KB
1628 * size
1629
@@ -1655,10 +1655,10 @@ Following charts are drawn:
1655 4. **Checkpoints** writes/s
1656 * scheduled
1657 * requested
1658 -
1658 +
1659 5. **Current connections to db** count
1660 * connections
1661 -
1661 +
1662 6. **Tuples returned from db** tuples/s
1663 * sequential
1664 * bitmap
@@ -1679,7 +1679,7 @@ Following charts are drawn:
1679
1680 10. **Locks on db** count per type
1681 * locks
1682 -
1682 +
1683 ### configuration
1684
1685 ```yaml
@@ -1770,7 +1770,7 @@ Following charts are drawn:
1770
1771 6. **Erlang processes**
1772 * used processes
1773 -
1773 +
1774 7. **Erlang run queue**
1775 * Erlang run queue
1776
@@ -1812,16 +1812,16 @@ Following charts are drawn:
1812 * total
1813 * lua
1814
1815 -4. **Database keys**
1815 +4. **Database keys**
1816 * lines are creates dynamically based on how many databases are there
1817 -
1817 +
1818 5. **Clients**
1819 * connected
1820 * blocked
1821 -
1821 +
1822 6. **Slaves**
1823 * connected
1824 -
1824 +
1825 ### configuration
1826
1827 ```yaml
@@ -1919,6 +1919,34 @@ Please join this discussion for help.
1919
1920 ---
1921
1922 +# springboot
1923 +
1924 +This module will monitor one or more Java Spring-boot applications depending on configuration.
1925 +
1926 +It produces following charts:
1927 +
1928 +1. **Response Codes** in requests/s
1929 + * 1xx
1930 + * 2xx
1931 + * 3xx
1932 + * 4xx
1933 + * 5xx
1934 + * others
1935 +
1936 +2. **Threads**
1937 + * daemon
1938 + * total
1939 +
1940 +3. **GC Time** in milliseconds and **GC Operations** in operations/s
1941 + * Copy
1942 + * MarkSweep
1943 + * ...
1944 +
1945 +4. **Heap Mmeory Usage** in KB
1946 + * used
1947 + * committed
1948 +---
1949 +
1950 # squid
1951
1952 This module will monitor one or more squid instances depending on configuration.
@@ -1938,11 +1966,11 @@ It produces following charts:
1966 3. **Server Bandwidth** in kilobits/s
1967 * in
1968 * out
1941 -
1969 +
1970 4. **Server Requests** in requests/s
1971 * requests
1972 * errors
1945 -
1973 +
1974 ### configuration
1975
1976 ```yaml
@@ -1955,7 +1983,7 @@ local:
1983 ```
1984
1985 Without any configuration module will try to autodetect where squid presents its `counters` data
1958 -
1986 +
1987 ---
1988
1989 # smartd_log
@@ -1969,7 +1997,7 @@ It produces following charts (you can add additional attributes in the module co
1997 2. **Start/Stop Count** attribute 4
1998
1999 3. **Reallocated Sectors Count** attribute 5
1972 -
2000 +
2001 4. **Seek Error Rate** attribute 7
2002
2003 5. **Power-On Hours Count** attribute 9
@@ -1981,11 +2009,11 @@ It produces following charts (you can add additional attributes in the module co
2009 8. **Temperature** attribute 194
2010
2011 9. **Current Pending Sectors** attribute 197
1984 -
2012 +
2013 10. **Off-Line Uncorrectable** attribute 198
2014
2015 11. **Write Error Rate** attribute 200
1988 -
2016 +
2017 ### configuration
2018
2019 ```yaml
@@ -1994,7 +2022,7 @@ local:
2022 ```
2023
2024 If no configuration is given, module will attempt to read log files in /var/log/smartd/ directory.
1997 -
2025 +
2026 ---
2027
2028 # tomcat
@@ -2012,10 +2040,10 @@ Charts:
2040 3. **Threads**
2041 * current
2042 * busy
2015 -
2043 +
2044 4. **JVM Free Memory** in MB
2045 * jvm
2018 -
2046 +
2047 ### configuration
2048
2049 ```yaml
@@ -2026,10 +2054,10 @@ localhost:
2054 pass : 'secret_tomcat_password'
2055 ```
2056
2029 -Without configuration, module attempts to connect to `http://localhost:8080/manager/status?XML=true`, without any credentials.
2057 +Without configuration, module attempts to connect to `http://localhost:8080/manager/status?XML=true`, without any credentials.
2058 So it will probably fail.
2059
2032 ----
2060 +---
2061
2062 # varnish cache
2063
@@ -2056,7 +2084,7 @@ It produces:
2084
2085 5. **Expired Objects** in expired/s
2086 * objects
2059 -
2087 +
2088 6. **Least Recently Used Nuked Objects** in nuked/s
2089 * objects
2090
@@ -2068,7 +2096,7 @@ It produces:
2096 * created
2097 * failed
2098 * limited
2071 -
2099 +
2100 9. **Current Queue Length** in requests
2101 * in queue
2102
@@ -2079,22 +2107,22 @@ It produces:
2107 * closed
2108 * resycled
2109 * failed
2082 -
2110 +
2111 10. **Requests To The Backend** in requests/s
2112 * received
2085 -
2113 +
2114 11. **ESI Statistics** in problems/s
2115 * errors
2116 * warnings
2089 -
2117 +
2118 12. **Memory Usage** in MB
2119 * free
2120 * allocated
2093 -
2121 +
2122 13. **Uptime** in seconds
2123 * uptime
2096 -
2097 -
2124 +
2125 +
2126 ### configuration
2127
2128 No configuration is needed.
@@ -2124,7 +2152,7 @@ It produces following charts:
2152 * unmatched (the lines in the log file that are not matched)
2153
2154 3. **Detailed Response Codes** requests/s (number of responses for each response code family individually)
2127 -
2155 +
2156 4. **Bandwidth** KB/s
2157 * received (bandwidth of requests)
2158 * send (bandwidth of responses)
@@ -2146,7 +2174,7 @@ It produces following charts:
2174
2175 11. **All Time Unique Client IPs** unique ips/s (unique client IPs since the last restart of netdata)
2176
2149 -
2177 +
2178 ### configuration
2179
2180 ```yaml
@@ -2164,4 +2192,4 @@ apache_log:
2192
2193 Module has preconfigured jobs for nginx, apache and gunicorn on various distros.
2194
2167 ----
2195 +---