Code

control: Documented some B-Ds and collectd-core suggestions.
[pkg-collectd.git] / debian / collectd.conf
1 # Config file for collectd(1).
2 #
3 # Some plugins need additional configuration and are disabled by default.
4 # Please read collectd.conf(5) for details.
5 #
6 # You should also read /usr/share/doc/collectd-core/README.Debian.plugins
7 # before enabling any more plugins.
9 #Hostname "localhost"
10 FQDNLookup true
11 #BaseDir "/var/lib/collectd"
12 #PluginDir "/usr/lib/collectd"
13 #TypesDB "/usr/share/collectd/types.db" "/etc/collectd/my_types.db"
14 #Interval 10
15 #ReadThreads 5
17 #LoadPlugin logfile
18 LoadPlugin syslog
20 #<Plugin logfile>
21 #       LogLevel "info"
22 #       File STDOUT
23 #       Timestamp true
24 #</Plugin>
26 <Plugin syslog>
27         LogLevel info
28 </Plugin>
30 #LoadPlugin apache
31 #LoadPlugin apcups
32 #LoadPlugin ascent
33 LoadPlugin battery
34 #LoadPlugin bind
35 #LoadPlugin conntrack
36 LoadPlugin cpu
37 #LoadPlugin cpufreq
38 #LoadPlugin csv
39 #LoadPlugin curl
40 #LoadPlugin curl_json
41 #LoadPlugin dbi
42 LoadPlugin df
43 LoadPlugin disk
44 #LoadPlugin dns
45 #LoadPlugin email
46 LoadPlugin entropy
47 #LoadPlugin exec
48 #LoadPlugin filecount
49 #LoadPlugin fscache
50 #LoadPlugin gmond
51 #LoadPlugin hddtemp
52 LoadPlugin interface
53 #LoadPlugin ipmi
54 #LoadPlugin iptables
55 #LoadPlugin ipvs
56 LoadPlugin irq
57 #LoadPlugin java
58 #LoadPlugin libvirt
59 LoadPlugin load
60 #LoadPlugin madwifi
61 #LoadPlugin mbmon
62 #LoadPlugin memcachec
63 #LoadPlugin memcached
64 LoadPlugin memory
65 #LoadPlugin multimeter
66 #LoadPlugin mysql
67 #LoadPlugin netlink
68 #LoadPlugin network
69 #LoadPlugin nfs
70 #LoadPlugin nginx
71 #LoadPlugin notify_desktop
72 #LoadPlugin notify_email
73 #LoadPlugin ntpd
74 #LoadPlugin nut
75 #LoadPlugin olsrd
76 #LoadPlugin openvpn
77 #LoadPlugin perl
78 #LoadPlugin ping
79 #LoadPlugin postgresql
80 #LoadPlugin powerdns
81 LoadPlugin processes
82 #LoadPlugin protocols
83 LoadPlugin rrdtool
84 #LoadPlugin sensors
85 #LoadPlugin serial
86 #LoadPlugin snmp
87 LoadPlugin swap
88 #LoadPlugin table
89 #LoadPlugin tail
90 #LoadPlugin tcpconns
91 #LoadPlugin teamspeak2
92 #LoadPlugin ted
93 #LoadPlugin thermal
94 #LoadPlugin unixsock
95 #LoadPlugin uptime
96 LoadPlugin users
97 #LoadPlugin uuid
98 #LoadPlugin vmem
99 #LoadPlugin vserver
100 #LoadPlugin wireless
101 #LoadPlugin write_http
103 #<Plugin apache>
104 #       <Instance "foo">
105 #               URL "http://localhost/server-status?auto"
106 #               User "www-user"
107 #               Password "secret"
108 #               VerifyPeer false
109 #               VerifyHost false
110 #               CACert "/etc/ssl/ca.crt"
111 #               Server "apache"
112 #       </Instance>
114 #       <Instance "bar">
115 #               URL "http://some.domain.tld/status?auto"
116 #               Host "some.domain.tld"
117 #               Server "lighttpd"
118 #       </Instance>
119 #</Plugin>
121 #<Plugin apcups>
122 #       Host "localhost"
123 #       Port "3551"
124 #</Plugin>
126 #<Plugin ascent>
127 #       URL "http://localhost/ascent/status/"
128 #       User "www-user"
129 #       Password "secret"
130 #       VerifyPeer false
131 #       VerifyHost false
132 #       CACert "/etc/ssl/ca.crt"
133 #</Plugin>
135 #<Plugin "bind">
136 #       URL "http://localhost:8053/"
138 #       OpCodes true
139 #       QTypes true
140 #       ServerStats true
141 #       ZoneMaintStats true
142 #       ResolverStats false
143 #       MemoryStats true
145 #       <View "_default">
146 #               QTypes true
147 #               ResolverStats true
148 #               CacheRRSets true
150 #               Zone "127.in-addr.arpa/IN"
151 #       </View>
152 #</Plugin>
154 #<Plugin csv>
155 #       DataDir "/var/lib/collectd/csv"
156 #       StoreRates false
157 #</Plugin>
159 #<Plugin curl>
160 #       <Page "stock_quotes">
161 #               URL "http://finance.google.com/finance?q=NYSE%3AAMD"
162 #               User "foo"
163 #               Password "bar"
164 #               VerifyPeer false
165 #               VerifyHost false
166 #               CACert "/etc/ssl/ca.crt"
167 #               <Match>
168 #                       Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
169 #                       DSType "GaugeAverage"
170 #                       Type "stock_value"
171 #                       Instance "AMD"
172 #               </Match>
173 #       </Page>
174 #</Plugin>
176 #<Plugin curl_json>
177 ## See: http://wiki.apache.org/couchdb/Runtime_Statistics
178 #  <URL "http://localhost:5984/_stats">
179 #    Instance "httpd"
180 #    <Key "httpd/requests/count">
181 #      Type "http_requests"
182 #    </Key>
184 #    <Key "httpd_request_methods/*/count">
185 #      Type "http_request_methods"
186 #    </Key>
188 #    <Key "httpd_status_codes/*/count">
189 #      Type "http_response_codes"
190 #    </Key>
191 #  </URL>
192 ## Database status metrics:
193 #  <URL "http://localhost:5984/_all_dbs">
194 #    Instance "dbs"
195 #    <Key "*/doc_count">
196 #      Type "gauge"
197 #    </Key>
198 #    <Key "*/doc_del_count">
199 #      Type "counter"
200 #    </Key>
201 #    <Key "*/disk_size">
202 #      Type "bytes"
203 #    </Key>
204 #  </URL>
205 #</Plugin>
207 #<Plugin dbi>
208 #       <Query "num_of_customers">
209 #               Statement "SELECT 'customers' AS c_key, COUNT(*) AS c_value \
210 #                               FROM customers_tbl"
211 #               MinVersion 40102
212 #               MaxVersion 50042
213 #               <Result>
214 #                       Type "gauge"
215 #                       InstancePrefix "customer"
216 #                       InstancesFrom "c_key"
217 #                       ValuesFrom "c_value"
218 #               </Result>
219 #       </Query>
221 #       <Database "customers_db">
222 #               Driver "mysql"
223 #               DriverOption "host" "localhost"
224 #               DriverOption "username" "collectd"
225 #               DriverOption "password" "secret"
226 #               DriverOption "dbname" "custdb0"
227 #               SelectDB "custdb0"
228 #               Query "num_of_customers"
229 #               Query "..."
230 #       </Database>
231 #</Plugin>
233 #<Plugin df>
234 #       Device "/dev/sda1"
235 #       Device "192.168.0.2:/mnt/nfs"
236 #       MountPoint "/home"
237 #       FSType "ext3"
238 #       IgnoreSelected false
239 #       ReportByDevice false
240 #</Plugin>
242 #<Plugin disk>
243 #       Disk "hda"
244 #       Disk "/sda[23]/"
245 #       IgnoreSelected false
246 #</Plugin>
248 #<Plugin dns>
249 #       Interface "eth0"
250 #       IgnoreSource "192.168.0.1"
251 #       SelectNumericQueryTypes false
252 #</Plugin>
254 #<Plugin email>
255 #       SocketFile "/var/run/collectd-email"
256 #       SocketGroup "collectd"
257 #       SocketPerms "0770"
258 #       MaxConns 5
259 #</Plugin>
261 #<Plugin exec>
262 #       Exec user "/path/to/exec"
263 #       Exec "user:group" "/path/to/exec"
264 #       NotificationExec user "/path/to/exec"
265 #</Plugin>
267 #<Plugin filecount>
268 #       <Directory "/path/to/dir">
269 #               Instance "foodir"
270 #               Name "*.conf"
271 #               MTime "-5m"
272 #               Size "+10k"
273 #               Recursive true
274 #       </Directory>
275 #</Plugin>
277 #<Plugin gmond>
278 #       MCReceiveFrom "239.2.11.71" "8649"
280 #       <Metric "swap_total">
281 #               Type "swap"
282 #               TypeInstance "total"
283 #               DataSource "value"
284 #       </Metric>
286 #       <Metric "swap_free">
287 #               Type "swap"
288 #               TypeInstance "free"
289 #               DataSource "value"
290 #       </Metric>
291 #</Plugin>
293 #<Plugin hddtemp>
294 #       Host "127.0.0.1"
295 #       Port 7634
296 #       TranslateDevicename false
297 #</Plugin>
299 #<Plugin interface>
300 #       Interface "eth0"
301 #       IgnoreSelected false
302 #</Plugin>
304 #<Plugin ipmi>
305 #       Sensor "some_sensor"
306 #       Sensor "another_one"
307 #       IgnoreSelected false
308 #       NotifySensorAdd false
309 #       NotifySensorRemove true
310 #       NotifySensorNotPresent false
311 #</Plugin>
313 #<Plugin iptables>
314 #       Chain "table" "chain"
315 #</Plugin>
317 #<Plugin irq>
318 #       Irq 7
319 #       Irq 8
320 #       Irq 9
321 #       IgnoreSelected true
322 #</Plugin>
324 #<Plugin java>
325 #       JVMArg "-verbose:jni"
327 #       LoadPlugin "org.collectd.java.GenericJMX"
328 #       <Plugin "GenericJMX">
329 #               # See /usr/share/doc/collectd/examples/GenericJMX.conf
330 #               # for an example config.
331 #       </Plugin>
332 #</Plugin>
334 #<Plugin libvirt>
335 #       Connection "xen:///"
336 #       RefreshInterval 60
337 #       Domain "name"
338 #       BlockDevice "name:device"
339 #       InterfaceDevice "name:device"
340 #       IgnoreSelected false
341 #       HostnameFormat name
342 #</Plugin>
344 #<Plugin madwifi>
345 #       Interface "wlan0"
346 #       IgnoreSelected false
347 #       Source "SysFS"
348 #       WatchSet "None"
349 #       WatchAdd "node_octets"
350 #       WatchAdd "node_rssi"
351 #       WatchAdd "is_rx_acl"
352 #       WatchAdd "is_scan_active"
353 #</Plugin>
355 #<Plugin mbmon>
356 #       Host "127.0.0.1"
357 #       Port 411
358 #</Plugin>
360 #<Plugin memcachec>
361 #       <Page "plugin_instance">
362 #               Server "localhost"
363 #               Key "page_key"
364 #               <Match>
365 #                       Regex "(\\d+) bytes sent"
366 #                       DSType CounterAdd
367 #                       Type "ipt_octets"
368 #                       Instance "type_instance"
369 #               </Match>
370 #       </Page>
371 #</Plugin>
373 #<Plugin memcached>
374 #       Socket "/var/run/memcached.sock"
375 # or:
376 #       Host "127.0.0.1"
377 #       Port "11211"
378 #</Plugin>
380 #<Plugin mysql>
381 #       <Database db_name>
382 #               Host "database.serv.er"
383 #               Port "3306"
384 #               User "db_user"
385 #               Password "secret"
386 #               Database "db_name"
387 #               MasterStats true
388 #       </Database>
390 #       <Database db_name2>
391 #               Host "localhost"
392 #               Socket "/var/run/mysql/mysqld.sock"
393 #               SlaveStats true
394 #               SlaveNotifications true
395 #       </Database>
396 #</Plugin>
398 #<Plugin netlink>
399 #       Interface "All"
400 #       VerboseInterface "All"
401 #       QDisc "eth0" "pfifo_fast-1:0"
402 #       Class "ppp0" "htb-1:10"
403 #       Filter "ppp0" "u32-1:0"
404 #       IgnoreSelected false
405 #</Plugin>
407 #<Plugin network>
408 #       # client setup:
409 #       Server "ff18::efc0:4a42" "25826"
410 #       <Server "239.192.74.66" "25826">
411 #               SecurityLevel Encrypt
412 #               Username "user"
413 #               Password "secret"
414 #       </Server>
415 #       TimeToLive "128"
417 #       # server setup:
418 #       Listen "ff18::efc0:4a42" "25826"
419 #       <Listen "239.192.74.66" "25826">
420 #               SecurityLevel Sign
421 #               AuthFile "/etc/collectd/passwd"
422 #       </Listen>
423 #       MaxPacketSize 1024
425 #       # proxy setup (client and server as above):
426 #       Forward false
427 #</Plugin>
429 #<Plugin nginx>
430 #       URL "http://localhost/status?auto"
431 #       User "www-user"
432 #       Password "secret"
433 #       VerifyPeer false
434 #       VerifyHost false
435 #       CACert "/etc/ssl/ca.crt"
436 #</Plugin>
438 #<Plugin notify_desktop>
439 #       OkayTimeout 1000
440 #       WarningTimeout 5000
441 #       FailureTimeout 0
442 #</Plugin>
444 #<Plugin notify_email>
445 #       SMTPServer "localhost"
446 #       SMTPPort 25
447 #       SMTPUser "my-username"
448 #       SMTPPassword "my-password"
449 #       From "collectd@main0server.com"
450 #       # <WARNING/FAILURE/OK> on <hostname>.
451 #       # Beware! Do not use not more than two placeholders (%)!
452 #       Subject "[collectd] %s on %s!"
453 #       Recipient "email1@domain1.net"
454 #       Recipient "email2@domain2.com"
455 #</Plugin>
457 #<Plugin ntpd>
458 #       Host "localhost"
459 #       Port 123
460 #       ReverseLookups false
461 #</Plugin>
463 #<Plugin nut>
464 #       UPS "upsname@hostname:port"
465 #</Plugin>
467 #<Plugin olsrd>
468 #       Host "127.0.0.1"
469 #       Port "2006"
470 #       CollectLinks "Summary"
471 #       CollectRoutes "Summary"
472 #       CollectTopology "Summary"
473 #</Plugin>
475 #<Plugin openvpn>
476 #       StatusFile "/etc/openvpn/openvpn-status.log"
477 #</Plugin>
479 #<Plugin perl>
480 #       IncludeDir "/my/include/path"
481 #       BaseName "Collectd::Plugin"
482 #       EnableDebugger ""
483 #       LoadPlugin "foo"
484 #       LoadPlugin "bar"
486 #       <Plugin foo>
487 #               Foo "Bar"
488 #               Qux "Baz"
489 #       </Plugin>
490 #</Plugin>
492 #<Plugin ping>
493 #       Host "host.foo.bar"
494 #       Host "host.baz.qux"
495 #       Interval 1.0
496 #       Timeout 0.9
497 #       TTL 255
498 #</Plugin>
500 #<Plugin postgresql>
501 #       <Query magic>
502 #               Statement "SELECT magic FROM wizard WHERE host = $1;"
503 #               Param hostname
505 #               <Result>
506 #                       Type gauge
507 #                       InstancePrefix "magic"
508 #                       ValuesFrom "magic"
509 #               </Result>
510 #       </Query>
512 #       <Query rt36_tickets>
513 #               Statement "SELECT COUNT(type) AS count, type \
514 #                                 FROM (SELECT CASE \
515 #                                              WHEN resolved = 'epoch' THEN 'open' \
516 #                                              ELSE 'resolved' END AS type \
517 #                                              FROM tickets) type \
518 #                                 GROUP BY type;"
520 #               <Result>
521 #                       Type counter
522 #                       InstancePrefix "rt36_tickets"
523 #                       InstancesFrom "type"
524 #                       ValuesFrom "count"
525 #               </Result>
526 #       </Query>
528 #       <Database foo>
529 #               Host "hostname"
530 #               Port 5432
531 #               User "username"
532 #               Password "secret"
534 #               SSLMode "prefer"
535 #               KRBSrvName "kerberos_service_name"
537 #               Query magic
538 #       </Database>
540 #       <Database bar>
541 #               Service "service_name"
543 #               Query backend # predefined
544 #               Query rt36_tickets
545 #       </Database>
546 #</Plugin>
548 #<Plugin powerdns>
549 #       <Server "server_name">
550 #               Collect "latency"
551 #               Collect "udp-answers" "udp-queries"
552 #               Socket "/var/run/pdns.controlsocket"
553 #       </Server>
554 #       <Recursor "recursor_name">
555 #               Collect "questions"
556 #               Collect "cache-hits" "cache-misses"
557 #               Socket "/var/run/pdns_recursor.controlsocket"
558 #       </Recursor>
559 #       LocalSocket "/opt/collectd/var/run/collectd-powerdns"
560 #</Plugin>
562 #<Plugin processes>
563 #       Process "name"
564 #       ProcessMatch "foobar" "/usr/bin/perl foobar\\.pl.*"
565 #</Plugin>
567 #<Plugin protocols>
568 #       Value "/^Tcp:/"
569 #       IgnoreSelected false
570 #</Plugin>
572 <Plugin rrdtool>
573         DataDir "/var/lib/collectd/rrd"
574 #       CacheTimeout 120
575 #       CacheFlush 900
576 #       WritesPerSecond 30
577 #       RandomTimeout 0
579 # The following settings are rather advanced
580 # and should usually not be touched:
581 #       StepSize 10
582 #       HeartBeat 20
583 #       RRARows 1200
584 #       RRATimespan 158112000
585 #       XFF 0.1
586 </Plugin>
588 #<Plugin sensors>
589 #       Sensor "it8712-isa-0290/temperature-temp1"
590 #       Sensor "it8712-isa-0290/fanspeed-fan3"
591 #       Sensor "it8712-isa-0290/voltage-in8"
592 #       IgnoreSelected false
593 #</Plugin>
595 # See /usr/share/doc/collectd/examples/snmp-data.conf.gz for a
596 # comprehensive sample configuration.
597 #<Plugin snmp>
598 #       <Data "powerplus_voltge_input">
599 #               Type "voltage"
600 #               Table false
601 #               Instance "input_line1"
602 #               Scale 0.1
603 #               Values "SNMPv2-SMI::enterprises.6050.5.4.1.1.2.1"
604 #       </Data>
605 #       <Data "hr_users">
606 #               Type "users"
607 #               Table false
608 #               Instance ""
609 #               Shift -1
610 #               Values "HOST-RESOURCES-MIB::hrSystemNumUsers.0"
611 #       </Data>
612 #       <Data "std_traffic">
613 #               Type "if_octets"
614 #               Table true
615 #               InstancePrefix "traffic"
616 #               Instance "IF-MIB::ifDescr"
617 #               Values "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
618 #       </Data>
620 #       <Host "some.switch.mydomain.org">
621 #               Address "192.168.0.2"
622 #               Version 1
623 #               Community "community_string"
624 #               Collect "std_traffic"
625 #               Inverval 120
626 #       </Host>
627 #       <Host "some.server.mydomain.org">
628 #               Address "192.168.0.42"
629 #               Version 2
630 #               Community "another_string"
631 #               Collect "std_traffic" "hr_users"
632 #       </Host>
633 #       <Host "some.ups.mydomain.org">
634 #               Address "192.168.0.3"
635 #               Version 1
636 #               Community "more_communities"
637 #               Collect "powerplus_voltge_input"
638 #               Interval 300
639 #       </Host>
640 #</Plugin>
642 #<Plugin table>
643 #       <Table "/proc/slabinfo">
644 #               Instance "slabinfo"
645 #               Separator " "
646 #               <Result>
647 #                       Type gauge
648 #                       InstancePrefix "active_objs"
649 #                       InstancesFrom 0
650 #                       ValuesFrom 1
651 #               </Result>
652 #               <Result>
653 #                       Type gauge
654 #                       InstancePrefix "objperslab"
655 #                       InstancesFrom 0
656 #                       ValuesFrom 4
657 #               </Result>
658 #       </Table>
659 #</Plugin>
661 #<Plugin "tail">
662 #       <File "/var/log/exim4/mainlog">
663 #               Instance "exim"
664 #               <Match>
665 #                       Regex "S=([1-9][0-9]*)"
666 #                       DSType "CounterAdd"
667 #                       Type "ipt_bytes"
668 #                       Instance "total"
669 #               </Match>
670 #               <Match>
671 #                       Regex "\\<R=local_user\\>"
672 #                       DSType "CounterInc"
673 #                       Type "counter"
674 #                       Instance "local_user"
675 #               </Match>
676 #       </File>
677 #</Plugin>
679 #<Plugin tcpconns>
680 #       ListeningPorts false
681 #       LocalPort "25"
682 #       RemotePort "25"
683 #</Plugin>
685 #<Plugin teamspeak2>
686 #       Host "127.0.0.1"
687 #       Port "51234"
688 #       Server "8767"
689 #</Plugin>
691 #<Plugin ted>
692 #       Device "/dev/ttyUSB0"
693 #       Retries 0
694 #</Plugin>
696 #<Plugin thermal>
697 #       ForceUseProcfs false
698 #       Device "THRM"
699 #       IgnoreSelected false
700 #</Plugin>
702 #<Plugin unixsock>
703 #       SocketFile "/var/run/collectd-unixsock"
704 #       SocketGroup "collectd"
705 #       SocketPerms "0660"
706 #</Plugin>
708 #<Plugin uuid>
709 #       UUIDFile "/etc/uuid"
710 #</Plugin>
712 #<Plugin vmem>
713 #       Verbose false
714 #</Plugin>
716 #<Plugin write_http>
717 #       <URL "http://example.com/collectd-post">
718 #               User "collectd"
719 #               Password "secret"
720 #       </URL>
721 #</Plugin>
723 Include "/etc/collectd/filters.conf"
724 Include "/etc/collectd/thresholds.conf"