blob: 7d9a732ad095e7856454762d649d3426782005a3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
|
# Disclaimer
Every module should be compatible with python2 and python3.
All third party libraries should be installed system-wide or in `python_modules` directory.
Module configurations are written in YAML and **pyYAML is required**.
Every configuration file must have one of two formats:
- Configuration for only one job:
```yaml
update_every : 2 # update frequency
retries : 1 # how many failures in update() is tolerated
priority : 20000 # where it is shown on dashboard
other_var1 : bla # variables passed to module
other_var2 : alb
```
- Configuration for many jobs (ex. mysql):
```yaml
# module defaults:
update_every : 2
retries : 1
priority : 20000
local: # job name
update_every : 5 # job update frequency
other_var1 : some_val # module specific variable
other_job:
priority : 5 # job position on dashboard
retries : 20 # job retries
other_var2 : val # module specific variable
```
`update_every`, `retries`, and `priority` are always optional.
---
The following python.d modules are supported:
# apache
This module will monitor one or more apache servers depending on configuration.
**Requirements:**
* apache with enabled `mod_status`
It produces the following charts:
1. **Requests** in requests/s
* requests
2. **Connections**
* connections
3. **Async Connections**
* keepalive
* closing
* writing
4. **Bandwidth** in kilobytes/s
* sent
5. **Workers**
* idle
* busy
6. **Lifetime Avg. Requests/s** in requests/s
* requests_sec
7. **Lifetime Avg. Bandwidth/s** in kilobytes/s
* size_sec
8. **Lifetime Avg. Response Size** in bytes/request
* size_req
### configuration
Needs only `url` to server's `server-status?auto`
Here is an example for 2 servers:
```yaml
update_every : 10
priority : 90100
local:
url : 'http://localhost/server-status?auto'
retries : 20
remote:
url : 'http://www.apache.org/server-status?auto'
update_every : 5
retries : 4
```
Without configuration, module attempts to connect to `http://localhost/server-status?auto`
---
# apache_cache
Module monitors apache mod_cache log and produces only one chart:
**cached responses** in percent cached
* hit
* miss
* other
### configuration
Sample:
```yaml
update_every : 10
priority : 120000
retries : 5
log_path : '/var/log/apache2/cache.log'
```
If no configuration is given, module will attempt to read log file at `/var/log/apache2/cache.log`
---
# cpufreq
Module shows current cpu frequency by looking at appropriate files in /sys/devices
**Requirement:**
Processor which presents data scaling frequency data
It produces one chart with multiple lines (one line per core).
### configuration
Sample:
```yaml
sys_dir: "/sys/devices"
```
If no configuration is given, module will search for `scaling_cur_freq` files in `/sys/devices` directory.
Directory is also prefixed with `NETDATA_HOST_PREFIX` if specified.
---
# dovecot
This module provides statistics information from dovecot server.
Statistics are taken from dovecot socket by executing `EXPORT global` command.
More information about dovecot stats can be found on [project wiki page.](http://wiki2.dovecot.org/Statistics)
**Requirement:**
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
2. **logins**
* logins
3. **commands** - number of IMAP commands
* commands
4. **Faults**
* minor
* major
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
11. **attempts** - authorization attemts
* success
* failure
12. **cache** - cached authorization hits
* hit
* miss
### configuration
Sample:
```yaml
localtcpip:
name : 'local'
host : '127.0.0.1'
port : 24242
localsocket:
name : 'local'
socket : '/var/run/dovecot/stats'
```
If no configuration is given, module will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`
---
# exim
Simple module executing `exim -bpc` to grab exim queue.
This command can take a lot of time to finish its execution thus it is not recommended to run it every second.
It produces only one chart:
1. **Exim Queue Emails**
* emails
Configuration is not needed.
---
# freeradius
Uses the `radclient` command to provide freeradius statistics. It is not recommended to run it every second.
It produces:
1. **Authentication counters:**
* access-accepts
* access-rejects
* auth-dropped-requests
* auth-duplicate-requests
* auth-invalid-requests
* auth-malformed-requests
* auth-unknown-types
2. **Accounting counters:** [optional]
* accounting-requests
* accounting-responses
* acct-dropped-requests
* acct-duplicate-requests
* acct-invalid-requests
* acct-malformed-requests
* acct-unknown-types
3. **Proxy authentication counters:** [optional]
* proxy-access-accepts
* proxy-access-rejects
* proxy-auth-dropped-requests
* proxy-auth-duplicate-requests
* proxy-auth-invalid-requests
* proxy-auth-malformed-requests
* proxy-auth-unknown-types
4. **Proxy accounting counters:** [optional]
* proxy-accounting-requests
* proxy-accounting-responses
* proxy-acct-dropped-requests
* proxy-acct-duplicate-requests
* proxy-acct-invalid-requests
* proxy-acct-malformed-requests
* proxy-acct-unknown-typesa
### configuration
Sample:
```yaml
local:
host : 'localhost'
port : '18121'
secret : 'adminsecret'
acct : False # Freeradius accounting statistics.
proxy_auth : False # Freeradius proxy authentication statistics.
proxy_acct : False # Freeradius proxy accounting statistics.
```
**Freeradius server configuration:**
The configuration for the status server is automatically created in the sites-available directory.
By default, server is enabled and can be queried from every client.
FreeRADIUS will only respond to status-server messages, if the status-server virtual server has been enabled.
To do this, create a link from the sites-enabled directory to the status file in the sites-available directory:
* cd sites-enabled
* ln -s ../sites-available/status status
and restart/reload your FREERADIUS server.
---
# hddtemp
Module monitors disk temperatures from one or more hddtemp daemons.
**Requirement:**
Running `hddtemp` in daemonized mode with access on tcp port
It produces one chart **Temperature** with dynamic number of dimensions (one per disk)
### configuration
Sample:
```yaml
update_every: 3
host: "127.0.0.1"
port: 7634
```
If no configuration is given, module will attempt to connect to hddtemp daemon on `127.0.0.1:7634` address
---
# IPFS
Module monitors [IPFS](https://ipfs.io) basic information.
1. **Bandwidth** in kbits/s
* in
* out
2. **Peers**
* peers
### configuration
Only url to IPFS server is needed.
Sample:
```yaml
localhost:
name : 'local'
url : 'http://localhost:5001'
```
---
# memcached
Memcached monitoring module. Data grabbed from [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
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.
---
# mysql
Module monitors one or more mysql servers
**Requirements:**
* python library [MySQLdb](https://github.com/PyMySQL/mysqlclient-python) (faster) or [PyMySQL](https://github.com/PyMySQL/PyMySQL) (slower)
It will produce following charts (if data is available):
1. **Bandwidth** in kbps
* in
* out
2. **Queries** in queries/sec
* queries
* questions
* slow queries
3. **Operations** in operations/sec
* opened tables
* flush
* commit
* delete
* prepare
* read first
* read key
* read next
* read prev
* read random
* read random next
* rollback
* save point
|