Code

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