Document changes, mostly taken from @vbartoni's original work
[collectd.git] / src / collectd.conf.in
1 #
2 # Config file for collectd(1).
3 # Please read collectd.conf(5) for a list of options.
4 # http://collectd.org/
5 #
6
7 ##############################################################################
8 # Global                                                                     #
9 #----------------------------------------------------------------------------#
10 # Global settings for the daemon.                                            #
11 ##############################################################################
12
13 #Hostname    "localhost"
14 #FQDNLookup   true
15 #BaseDir     "@localstatedir@/lib/@PACKAGE_NAME@"
16 #PIDFile     "@localstatedir@/run/@PACKAGE_NAME@.pid"
17 #PluginDir   "@libdir@/@PACKAGE_NAME@"
18 #TypesDB     "@prefix@/share/@PACKAGE_NAME@/types.db"
19
20 #----------------------------------------------------------------------------#
21 # When enabled, plugins are loaded automatically with the default options    #
22 # when an appropriate <Plugin ...> block is encountered.                     #
23 # Disabled by default.                                                       #
24 #----------------------------------------------------------------------------#
25 #AutoLoadPlugin false
26
27 #----------------------------------------------------------------------------#
28 # Interval at which to query values. This may be overwritten on a per-plugin #
29 # base by using the 'Interval' option of the LoadPlugin block:               #
30 #   <LoadPlugin foo>                                                         #
31 #       Interval 60                                                          #
32 #   </LoadPlugin>                                                            #
33 #----------------------------------------------------------------------------#
34 #Interval     10
35
36 #Timeout      2
37 #ReadThreads  5
38 #WriteThreads 5
39
40 # Limit the size of the write queue. Default is no limit. Setting up a limit is
41 # recommended for servers handling a high volume of traffic.
42 #WriteQueueLimitHigh 1000000
43 #WriteQueueLimitLow   800000
44
45 ##############################################################################
46 # Logging                                                                    #
47 #----------------------------------------------------------------------------#
48 # Plugins which provide logging functions should be loaded first, so log     #
49 # messages generated when loading or configuring other plugins can be        #
50 # accessed.                                                                  #
51 ##############################################################################
52
53 @LOAD_PLUGIN_SYSLOG@LoadPlugin syslog
54 @LOAD_PLUGIN_LOGFILE@LoadPlugin logfile
55
56 #<Plugin logfile>
57 #       LogLevel @DEFAULT_LOG_LEVEL@
58 #       File STDOUT
59 #       Timestamp true
60 #       PrintSeverity false
61 #</Plugin>
62
63 #<Plugin syslog>
64 #       LogLevel @DEFAULT_LOG_LEVEL@
65 #</Plugin>
66
67 ##############################################################################
68 # LoadPlugin section                                                         #
69 #----------------------------------------------------------------------------#
70 # Lines beginning with a single `#' belong to plugins which have been built  #
71 # but are disabled by default.                                               #
72 #                                                                            #
73 # Lines begnning with `##' belong to plugins which have not been built due   #
74 # to missing dependencies or because they have been deactivated explicitly.  #
75 ##############################################################################
76
77 #@BUILD_PLUGIN_AGGREGATION_TRUE@LoadPlugin aggregation
78 #@BUILD_PLUGIN_AMQP_TRUE@LoadPlugin amqp
79 #@BUILD_PLUGIN_APACHE_TRUE@LoadPlugin apache
80 #@BUILD_PLUGIN_APCUPS_TRUE@LoadPlugin apcups
81 #@BUILD_PLUGIN_APPLE_SENSORS_TRUE@LoadPlugin apple_sensors
82 #@BUILD_PLUGIN_AQUAERO_TRUE@LoadPlugin aquaero
83 #@BUILD_PLUGIN_ASCENT_TRUE@LoadPlugin ascent
84 #@BUILD_PLUGIN_BATTERY_TRUE@LoadPlugin battery
85 #@BUILD_PLUGIN_BIND_TRUE@LoadPlugin bind
86 #@BUILD_PLUGIN_CONNTRACK_TRUE@LoadPlugin conntrack
87 #@BUILD_PLUGIN_CONTEXTSWITCH_TRUE@LoadPlugin contextswitch
88 #@BUILD_PLUGIN_CGROUPS_TRUE@LoadPlugin cgroups
89 @BUILD_PLUGIN_CPU_TRUE@@BUILD_PLUGIN_CPU_TRUE@LoadPlugin cpu
90 #@BUILD_PLUGIN_CPUFREQ_TRUE@LoadPlugin cpufreq
91 @LOAD_PLUGIN_CSV@LoadPlugin csv
92 #@BUILD_PLUGIN_CURL_TRUE@LoadPlugin curl
93 #@BUILD_PLUGIN_CURL_JSON_TRUE@LoadPlugin curl_json
94 #@BUILD_PLUGIN_CURL_XML_TRUE@LoadPlugin curl_xml
95 #@BUILD_PLUGIN_DBI_TRUE@LoadPlugin dbi
96 #@BUILD_PLUGIN_DF_TRUE@LoadPlugin df
97 #@BUILD_PLUGIN_DISK_TRUE@LoadPlugin disk
98 #@BUILD_PLUGIN_DNS_TRUE@LoadPlugin dns
99 #@BUILD_PLUGIN_EMAIL_TRUE@LoadPlugin email
100 #@BUILD_PLUGIN_ENTROPY_TRUE@LoadPlugin entropy
101 #@BUILD_PLUGIN_ETHSTAT_TRUE@LoadPlugin ethstat
102 #@BUILD_PLUGIN_EXEC_TRUE@LoadPlugin exec
103 #@BUILD_PLUGIN_FILECOUNT_TRUE@LoadPlugin filecount
104 #@BUILD_PLUGIN_FSCACHE_TRUE@LoadPlugin fscache
105 #@BUILD_PLUGIN_GMOND_TRUE@LoadPlugin gmond
106 #@BUILD_PLUGIN_HDDTEMP_TRUE@LoadPlugin hddtemp
107 @BUILD_PLUGIN_INTERFACE_TRUE@@BUILD_PLUGIN_INTERFACE_TRUE@LoadPlugin interface
108 #@BUILD_PLUGIN_IPTABLES_TRUE@LoadPlugin iptables
109 #@BUILD_PLUGIN_IPMI_TRUE@LoadPlugin ipmi
110 #@BUILD_PLUGIN_IPVS_TRUE@LoadPlugin ipvs
111 #@BUILD_PLUGIN_IRQ_TRUE@LoadPlugin irq
112 #@BUILD_PLUGIN_JAVA_TRUE@LoadPlugin java
113 #@BUILD_PLUGIN_LIBVIRT_TRUE@LoadPlugin libvirt
114 @BUILD_PLUGIN_LOAD_TRUE@@BUILD_PLUGIN_LOAD_TRUE@LoadPlugin load
115 #@BUILD_PLUGIN_LPAR_TRUE@LoadPlugin lpar
116 #@BUILD_PLUGIN_LVM_TRUE@LoadPlugin lvm
117 #@BUILD_PLUGIN_MADWIFI_TRUE@LoadPlugin madwifi
118 #@BUILD_PLUGIN_MBMON_TRUE@LoadPlugin mbmon
119 #@BUILD_PLUGIN_MD_TRUE@LoadPlugin md
120 #@BUILD_PLUGIN_MEMCACHEC_TRUE@LoadPlugin memcachec
121 #@BUILD_PLUGIN_MEMCACHED_TRUE@LoadPlugin memcached
122 @BUILD_PLUGIN_MEMORY_TRUE@@BUILD_PLUGIN_MEMORY_TRUE@LoadPlugin memory
123 #@BUILD_PLUGIN_MODBUS_TRUE@LoadPlugin modbus
124 #@BUILD_PLUGIN_MULTIMETER_TRUE@LoadPlugin multimeter
125 #@BUILD_PLUGIN_MYSQL_TRUE@LoadPlugin mysql
126 #@BUILD_PLUGIN_NETAPP_TRUE@LoadPlugin netapp
127 #@BUILD_PLUGIN_NETLINK_TRUE@LoadPlugin netlink
128 @LOAD_PLUGIN_NETWORK@LoadPlugin network
129 #@BUILD_PLUGIN_NFS_TRUE@LoadPlugin nfs
130 #@BUILD_PLUGIN_NGINX_TRUE@LoadPlugin nginx
131 #@BUILD_PLUGIN_NOTIFY_DESKTOP_TRUE@LoadPlugin notify_desktop
132 #@BUILD_PLUGIN_NOTIFY_EMAIL_TRUE@LoadPlugin notify_email
133 #@BUILD_PLUGIN_NTPD_TRUE@LoadPlugin ntpd
134 #@BUILD_PLUGIN_NUMA_TRUE@LoadPlugin numa
135 #@BUILD_PLUGIN_NUT_TRUE@LoadPlugin nut
136 #@BUILD_PLUGIN_OLSRD_TRUE@LoadPlugin olsrd
137 #@BUILD_PLUGIN_ONEWIRE_TRUE@LoadPlugin onewire
138 #@BUILD_PLUGIN_OPENVPN_TRUE@LoadPlugin openvpn
139 #@BUILD_PLUGIN_ORACLE_TRUE@LoadPlugin oracle
140 #@BUILD_PLUGIN_PERL_TRUE@<LoadPlugin perl>
141 #@BUILD_PLUGIN_PERL_TRUE@  Globals true
142 #@BUILD_PLUGIN_PERL_TRUE@</LoadPlugin>
143 #@BUILD_PLUGIN_PINBA_TRUE@LoadPlugin pinba
144 #@BUILD_PLUGIN_PING_TRUE@LoadPlugin ping
145 #@BUILD_PLUGIN_POSTGRESQL_TRUE@LoadPlugin postgresql
146 #@BUILD_PLUGIN_POWERDNS_TRUE@LoadPlugin powerdns
147 #@BUILD_PLUGIN_PROCESSES_TRUE@LoadPlugin processes
148 #@BUILD_PLUGIN_PROTOCOLS_TRUE@LoadPlugin protocols
149 #@BUILD_PLUGIN_PYTHON_TRUE@<LoadPlugin python>
150 #@BUILD_PLUGIN_PYTHON_TRUE@  Globals true
151 #@BUILD_PLUGIN_PYTHON_TRUE@</LoadPlugin>
152 #@BUILD_PLUGIN_REDIS_TRUE@LoadPlugin redis
153 #@BUILD_PLUGIN_ROUTEROS_TRUE@LoadPlugin routeros
154 #@BUILD_PLUGIN_RRDCACHED_TRUE@LoadPlugin rrdcached
155 @LOAD_PLUGIN_RRDTOOL@LoadPlugin rrdtool
156 #@BUILD_PLUGIN_SENSORS_TRUE@LoadPlugin sensors
157 #@BUILD_PLUGIN_SERIAL_TRUE@LoadPlugin serial
158 #@BUILD_PLUGIN_SIGROK_TRUE@LoadPlugin sigrok
159 #@BUILD_PLUGIN_SNMP_TRUE@LoadPlugin snmp
160 #@BUILD_PLUGIN_STATSD_TRUE@LoadPlugin statsd
161 #@BUILD_PLUGIN_SWAP_TRUE@LoadPlugin swap
162 #@BUILD_PLUGIN_TABLE_TRUE@LoadPlugin table
163 #@BUILD_PLUGIN_TAIL_TRUE@LoadPlugin tail
164 #@BUILD_PLUGIN_TAIL_CSV_TRUE@LoadPlugin tail_csv
165 #@BUILD_PLUGIN_TAPE_TRUE@LoadPlugin tape
166 #@BUILD_PLUGIN_TCPCONNS_TRUE@LoadPlugin tcpconns
167 #@BUILD_PLUGIN_TEAMSPEAK2_TRUE@LoadPlugin teamspeak2
168 #@BUILD_PLUGIN_TED_TRUE@LoadPlugin ted
169 #@BUILD_PLUGIN_THERMAL_TRUE@LoadPlugin thermal
170 #@BUILD_PLUGIN_TOKYOTYRANT_TRUE@LoadPlugin tokyotyrant
171 #@BUILD_PLUGIN_UNIXSOCK_TRUE@LoadPlugin unixsock
172 #@BUILD_PLUGIN_UPTIME_TRUE@LoadPlugin uptime
173 #@BUILD_PLUGIN_USERS_TRUE@LoadPlugin users
174 #@BUILD_PLUGIN_UUID_TRUE@LoadPlugin uuid
175 #@BUILD_PLUGIN_VARNISH_TRUE@LoadPlugin varnish
176 #@BUILD_PLUGIN_MIC_TRUE@LoadPlugin mic
177 #@BUILD_PLUGIN_VMEM_TRUE@LoadPlugin vmem
178 #@BUILD_PLUGIN_VSERVER_TRUE@LoadPlugin vserver
179 #@BUILD_PLUGIN_WIRELESS_TRUE@LoadPlugin wireless
180 #@BUILD_PLUGIN_WRITE_GRAPHITE_TRUE@LoadPlugin write_graphite
181 #@BUILD_PLUGIN_WRITE_HTTP_TRUE@LoadPlugin write_http
182 #@BUILD_PLUGIN_WRITE_MONGODB_TRUE@LoadPlugin write_mongodb
183 #@BUILD_PLUGIN_WRITE_REDIS_TRUE@LoadPlugin write_redis
184 #@BUILD_PLUGIN_WRITE_RIEMANN_TRUE@LoadPlugin write_riemann
185 #@BUILD_PLUGIN_XMMS_TRUE@LoadPlugin xmms
186 #@BUILD_PLUGIN_ZFS_ARC_TRUE@LoadPlugin zfs_arc
187
188 ##############################################################################
189 # Plugin configuration                                                       #
190 #----------------------------------------------------------------------------#
191 # In this section configuration stubs for each plugin are provided. A desc-  #
192 # ription of those options is available in the collectd.conf(5) manual page. #
193 ##############################################################################
194
195 #<Plugin "aggregation">
196 #  <Aggregation>
197 #    #Host "unspecified"
198 #    Plugin "cpu"
199 #    #PluginInstance "unspecified"
200 #    Type "cpu"
201 #    #TypeInstance "unspecified"
202 #
203 #    GroupBy "Host"
204 #    GroupBy "TypeInstance"
205 #
206 #    CalculateNum false
207 #    CalculateSum false
208 #    CalculateAverage true
209 #    CalculateMinimum false
210 #    CalculateMaximum false
211 #    CalculateStddev false
212 #  </Aggregation>
213 #</Plugin>
214
215 #<Plugin "amqp">
216 #  <Publish "name">
217 #    Host "localhost"
218 #    Port "5672"
219 #    VHost "/"
220 #    User "guest"
221 #    Password "guest"
222 #    Exchange "amq.fanout"
223 #    RoutingKey "collectd"
224 #    Persistent false
225 #    StoreRates false
226 #  </Publish>
227 #</Plugin>
228
229 #<Plugin apache>
230 #  <Instance "local">
231 #    URL "http://localhost/status?auto"
232 #    User "www-user"
233 #    Password "secret"
234 #    CACert "/etc/ssl/ca.crt"
235 #  </Instance>
236 #</Plugin>
237
238 #<Plugin apcups>
239 #       Host "localhost"
240 #       Port "3551"
241 #       ReportSeconds true
242 #</Plugin>
243
244 #<Plugin aquaero>
245 #       Device ""
246 #</Plugin>
247
248 #<Plugin ascent>
249 #       URL "http://localhost/ascent/status/"
250 #       User "www-user"
251 #       Password "secret"
252 #       CACert "/etc/ssl/ca.crt"
253 #</Plugin>
254
255 #<Plugin "bind">
256 #  URL "http://localhost:8053/"
257 #  ParseTime       false
258 #  OpCodes         true
259 #  QTypes          true
260 #
261 #  ServerStats     true
262 #  ZoneMaintStats  true
263 #  ResolverStats   false
264 #  MemoryStats     true
265 #
266 #  <View "_default">
267 #    QTypes        true
268 #    ResolverStats true
269 #    CacheRRSets   true
270 #
271 #    Zone "127.in-addr.arpa/IN"
272 #  </View>
273 #</Plugin>
274
275 #<Plugin csv>
276 #       DataDir "@localstatedir@/lib/@PACKAGE_NAME@/csv"
277 #       StoreRates false
278 #</Plugin>
279
280 #<Plugin curl>
281 #  <Page "stock_quotes">
282 #    URL "http://finance.google.com/finance?q=NYSE%3AAMD"
283 #    User "foo"
284 #    Password "bar"
285 #    MeasureResponseTime false
286 #    <Match>
287 #      Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
288 #      DSType "GaugeAverage"
289 #      Type "stock_value"
290 #      Instance "AMD"
291 #    </Match>
292 #  </Page>
293 #</Plugin>
294
295 #<Plugin curl_json>
296 ## See: http://wiki.apache.org/couchdb/Runtime_Statistics
297 #  <URL "http://localhost:5984/_stats">
298 #    Instance "httpd"
299 #    <Key "httpd/requests/count">
300 #      Type "http_requests"
301 #    </Key>
302 #
303 #    <Key "httpd_request_methods/*/count">
304 #      Type "http_request_methods"
305 #    </Key>
306 #
307 #    <Key "httpd_status_codes/*/count">
308 #      Type "http_response_codes"
309 #    </Key>
310 #  </URL>
311 ## Database status metrics:
312 #  <URL "http://localhost:5984/_all_dbs">
313 #    Instance "dbs"
314 #    <Key "*/doc_count">
315 #      Type "gauge"
316 #    </Key>
317 #    <Key "*/doc_del_count">
318 #      Type "counter"
319 #    </Key>
320 #    <Key "*/disk_size">
321 #      Type "bytes"
322 #    </Key>
323 #  </URL>
324 #</Plugin>
325
326 #<Plugin "curl_xml">
327 #  <URL "http://localhost/stats.xml">
328 #    Host "my_host"
329 #    Instance "some_instance"
330 #    User "collectd"
331 #    Password "thaiNg0I"
332 #    VerifyPeer true
333 #    VerifyHost true
334 #    CACert "/path/to/ca.crt"
335 #
336 #    <XPath "table[@id=\"magic_level\"]/tr">
337 #      Type "magic_level"
338 #      #InstancePrefix "prefix-"
339 #      InstanceFrom "td[1]"
340 #      ValuesFrom "td[2]/span[@class=\"level\"]"
341 #    </XPath>
342 #  </URL>
343 #</Plugin>
344
345 #<Plugin dbi>
346 #       <Query "num_of_customers">
347 #               Statement "SELECT 'customers' AS c_key, COUNT(*) AS c_value FROM customers_tbl"
348 #               <Result>
349 #                       Type "gauge"
350 #                       InstancesFrom "c_key"
351 #                       ValuesFrom "c_value"
352 #               </Result>
353 #       </Query>
354 #       <Database "customers_db">
355 #               Driver "mysql"
356 #               DriverOption "host" "localhost"
357 #               DriverOption "username" "collectd"
358 #               DriverOption "password" "AeXohy0O"
359 #               DriverOption "dbname" "custdb0"
360 #               #SelectDB "custdb0"
361 #               Query "num_of_customers"
362 #               #Query "..."
363 #               #Host "..."
364 #       </Database>
365 #</Plugin>
366
367 #<Plugin df>
368 #       Device "/dev/hda1"
369 #       Device "192.168.0.2:/mnt/nfs"
370 #       MountPoint "/home"
371 #       FSType "ext3"
372 #       IgnoreSelected false
373 #       ReportByDevice false
374 #       ReportReserved false
375 #       ReportInodes false
376 #</Plugin>
377
378 #<Plugin disk>
379 #       Disk "/^[hs]d[a-f][0-9]?$/"
380 #       IgnoreSelected false
381 #</Plugin>
382
383 #<Plugin dns>
384 #       Interface "eth0"
385 #       IgnoreSource "192.168.0.1"
386 #       SelectNumericQueryTypes true
387 #</Plugin>
388
389 #<Plugin email>
390 #       SocketFile "@localstatedir@/run/@PACKAGE_NAME@-email"
391 #       SocketGroup "collectd"
392 #       SocketPerms "0770"
393 #       MaxConns 5
394 #</Plugin>
395
396 #<Plugin ethstat>
397 #       Interface "eth0"
398 #       Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
399 #       Map "multicast" "if_multicast"
400 #       MappedOnly false
401 #</Plugin>
402
403 #<Plugin exec>
404 #       Exec "user:group" "/path/to/exec"
405 #       NotificationExec "user:group" "/path/to/exec"
406 #</Plugin>
407
408 #<Plugin filecount>
409 #       <Directory "/path/to/dir">
410 #               Instance "foodir"
411 #               Name "*.conf"
412 #               MTime "-5m"
413 #               Size "+10k"
414 #               Recursive true
415 #               IncludeHidden false
416 #       </Directory>
417 #</Plugin>
418
419 #<Plugin "gmond">
420 #  MCReceiveFrom "239.2.11.71" "8649"
421 #  <Metric "swap_total">
422 #    Type "swap"
423 #    TypeInstance "total"
424 #    DataSource "value"
425 #  </Metric>
426 #  <Metric "swap_free">
427 #    Type "swap"
428 #    TypeInstance "free"
429 #    DataSource "value"
430 #  </Metric>
431 #</Plugin>
432
433 #<Plugin hddtemp>
434 #  Host "127.0.0.1"
435 #  Port "7634"
436 #</Plugin>
437
438 #<Plugin interface>
439 #       Interface "eth0"
440 #       IgnoreSelected false
441 #</Plugin>
442
443 #<Plugin ipmi>
444 #       Sensor "some_sensor"
445 #       Sensor "another_one"
446 #       IgnoreSelected false
447 #       NotifySensorAdd false
448 #       NotifySensorRemove true
449 #       NotifySensorNotPresent false
450 #</Plugin>
451
452 #<Plugin iptables>
453 #       Chain table chain
454 #</Plugin>
455
456 #<Plugin irq>
457 #       Irq 7
458 #       Irq 8
459 #       Irq 9
460 #       IgnoreSelected true
461 #</Plugin>
462
463 #<Plugin "java">
464 #       JVMArg "-verbose:jni"
465 #       JVMArg "-Djava.class.path=@prefix@/share/collectd/java/collectd-api.jar"
466 #
467 #       LoadPlugin "org.collectd.java.Foobar"
468 #       <Plugin "org.collectd.java.Foobar">
469 #         # To be parsed by the plugin
470 #       </Plugin>
471 #</Plugin>
472
473 #<Plugin libvirt>
474 #       Connection "xen:///"
475 #       RefreshInterval 60
476 #       Domain "name"
477 #       BlockDevice "name:device"
478 #       InterfaceDevice "name:device"
479 #       IgnoreSelected false
480 #       HostnameFormat name
481 #       InterfaceFormat name
482 #</Plugin>
483
484 #<Plugin load>
485 #        ReportRelative true
486 #</Plugin>
487
488 #<Plugin lpar>
489 #       CpuPoolStats   false
490 #       ReportBySerial false
491 #</Plugin>
492
493 #<Plugin madwifi>
494 #       Interface "wlan0"
495 #       IgnoreSelected false
496 #       Source "SysFS"
497 #       WatchSet "None"
498 #       WatchAdd "node_octets"
499 #       WatchAdd "node_rssi"
500 #       WatchAdd "is_rx_acl"
501 #       WatchAdd "is_scan_active"
502 #</Plugin>
503
504 #<Plugin mbmon>
505 #       Host "127.0.0.1"
506 #       Port "411"
507 #</Plugin>
508
509 #<Plugin md>
510 #       Device "/dev/md0"
511 #       IgnoreSelected false
512 #</Plugin>
513
514 #<Plugin memcachec>
515 #       <Page "plugin_instance">
516 #               Server "localhost"
517 #               Key "page_key"
518 #               <Match>
519 #                       Regex "(\\d+) bytes sent"
520 #                       ExcludeRegex "<lines to be excluded>"
521 #                       DSType CounterAdd
522 #                       Type "ipt_octets"
523 #                       Instance "type_instance"
524 #               </Match>
525 #       </Page>
526 #</Plugin>
527
528 #<Plugin memcached>
529 #       <Instance "local">
530 #               Host "127.0.0.1"
531 #               Port "11211"
532 #       </Instance>
533 #</Plugin>
534
535 #<Plugin modbus>
536 #       <Data "data_name">
537 #               RegisterBase 1234
538 #               RegisterType float
539 #               Type gauge
540 #               Instance "..."
541 #       </Data>
542 #
543 #       <Host "name">
544 #               Address "addr"
545 #               Port "1234"
546 #               Interval 60
547 #
548 #               <Slave 1>
549 #                       Instance "foobar" # optional
550 #                       Collect "data_name"
551 #               </Slave>
552 #       </Host>
553 #</Plugin>
554
555 #<Plugin mysql>
556 #       <Database db_name>
557 #               Host "database.serv.er"
558 #               User "db_user"
559 #               Password "secret"
560 #               Database "db_name"
561 #               MasterStats true
562 #       </Database>
563 #
564 #       <Database db_name2>
565 #               Host "localhost"
566 #               Socket "/var/run/mysql/mysqld.sock"
567 #               SlaveStats true
568 #               SlaveNotifications true
569 #       </Database>
570 #</Plugin>
571
572 #<Plugin netapp>
573 #       <Host "netapp1.example.com">
574 #               Protocol      "https"
575 #               Address       "10.0.0.1"
576 #               Port          443
577 #               User          "username"
578 #               Password      "aef4Aebe"
579 #               Interval      30
580 #
581 #               <WAFL>
582 #                       Interval 30
583 #                       GetNameCache   true
584 #                       GetDirCache    true
585 #                       GetBufferCache true
586 #                       GetInodeCache  true
587 #               </WAFL>
588 #
589 #               <Disks>
590 #                       Interval 30
591 #                       GetBusy true
592 #               </Disks>
593 #
594 #               <VolumePerf>
595 #                       Interval 30
596 #                       GetIO      "volume0"
597 #                       IgnoreSelectedIO      false
598 #                       GetOps     "volume0"
599 #                       IgnoreSelectedOps     false
600 #                       GetLatency "volume0"
601 #                       IgnoreSelectedLatency false
602 #               </VolumePerf>
603 #
604 #               <VolumeUsage>
605 #                       Interval 30
606 #                       GetCapacity "vol0"
607 #                       GetCapacity "vol1"
608 #                       IgnoreSelectedCapacity false
609 #                       GetSnapshot "vol1"
610 #                       GetSnapshot "vol3"
611 #                       IgnoreSelectedSnapshot false
612 #               </VolumeUsage>
613 #
614 #               <System>
615 #                       Interval 30
616 #                       GetCPULoad     true
617 #                       GetInterfaces  true
618 #                       GetDiskOps     true
619 #                       GetDiskIO      true
620 #               </System>
621 #       </Host>
622 #</Plugin>
623
624 #<Plugin netlink>
625 #       Interface "All"
626 #       VerboseInterface "All"
627 #       QDisc "eth0" "pfifo_fast-1:0"
628 #       Class "ppp0" "htb-1:10"
629 #       Filter "ppp0" "u32-1:0"
630 #       IgnoreSelected false
631 #</Plugin>
632
633 @LOAD_PLUGIN_NETWORK@<Plugin network>
634 #       # client setup:
635 @LOAD_PLUGIN_NETWORK@   Server "ff18::efc0:4a42" "25826"
636 @LOAD_PLUGIN_NETWORK@   <Server "239.192.74.66" "25826">
637 #               SecurityLevel Encrypt
638 #               Username "user"
639 #               Password "secret"
640 #               Interface "eth0"
641 @LOAD_PLUGIN_NETWORK@   </Server>
642 #       TimeToLive "128"
643 #
644 #       # server setup:
645 #       Listen "ff18::efc0:4a42" "25826"
646 #       <Listen "239.192.74.66" "25826">
647 #               SecurityLevel Sign
648 #               AuthFile "/etc/collectd/passwd"
649 #               Interface "eth0"
650 #       </Listen>
651 #       MaxPacketSize 1024
652 #
653 #       # proxy setup (client and server as above):
654 #       Forward true
655 #
656 #       # statistics about the network plugin itself
657 #       ReportStats false
658 #
659 #       # "garbage collection"
660 #       CacheFlush 1800
661 @LOAD_PLUGIN_NETWORK@</Plugin>
662
663 #<Plugin nginx>
664 #       URL "http://localhost/status?auto"
665 #       User "www-user"
666 #       Password "secret"
667 #       CACert "/etc/ssl/ca.crt"
668 #</Plugin>
669
670 #<Plugin notify_desktop>
671 #       OkayTimeout 1000
672 #       WarningTimeout 5000
673 #       FailureTimeout 0
674 #</Plugin>
675
676 #<Plugin notify_email>
677 #       SMTPServer "localhost"
678 #       SMTPPort 25
679 #       SMTPUser "my-username"
680 #       SMTPPassword "my-password"
681 #       From "collectd@main0server.com"
682 #       # <WARNING/FAILURE/OK> on <hostname>. beware! do not use not more than two %s in this string!!!
683 #       Subject "Aaaaaa!! %s on %s!!!!!"
684 #       Recipient "email1@domain1.net"
685 #       Recipient "email2@domain2.com"
686 #</Plugin>
687
688 #<Plugin ntpd>
689 #       Host "localhost"
690 #       Port 123
691 #       ReverseLookups false
692 #       IncludeUnitID true
693 #</Plugin>
694
695 #<Plugin nut>
696 #       UPS "upsname@hostname:port"
697 #</Plugin>
698
699 #<Plugin olsrd>
700 #       Host "127.0.0.1"
701 #       Port "2006"
702 #       CollectLinks "Summary"
703 #       CollectRoutes "Summary"
704 #       CollectTopology "Summary"
705 #</Plugin>
706
707 #<Plugin onewire>
708 #       Device "-s localhost:4304"
709 #       Sensor "F10FCA000800"
710 #       IgnoreSelected false
711 #</Plugin>
712
713 #<Plugin openvpn>
714 #       StatusFile "/etc/openvpn/openvpn-status.log"
715 #       ImprovedNamingSchema false
716 #       CollectCompression true
717 #       CollectIndividualUsers true
718 #       CollectUserCount false
719 #</Plugin>
720
721 #<Plugin oracle>
722 #  <Query "out_of_stock">
723 #    Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
724 #    <Result>
725 #      Type "gauge"
726 #      InstancesFrom "category"
727 #      ValuesFrom "value"
728 #    </Result>
729 #  </Query>
730 #  <Database "product_information">
731 #    ConnectID "db01"
732 #    Username "oracle"
733 #    Password "secret"
734 #    Query "out_of_stock"
735 #  </Database>
736 #</Plugin>
737
738 #<Plugin perl>
739 #       IncludeDir "/my/include/path"
740 #       BaseName "Collectd::Plugins"
741 #       EnableDebugger ""
742 #       LoadPlugin Monitorus
743 #       LoadPlugin OpenVZ
744 #
745 #       <Plugin foo>
746 #               Foo "Bar"
747 #               Qux "Baz"
748 #       </Plugin>
749 #</Plugin>
750
751 #<Plugin pinba>
752 #       Address "::0"
753 #       Port "30002"
754 #       <View "name">
755 #               Host "host name"
756 #               Server "server name"
757 #               Script "script name"
758 #       </View>
759 #</Plugin>
760
761 #<Plugin ping>
762 #       Host "host.foo.bar"
763 #       Interval 1.0
764 #       Timeout 0.9
765 #       TTL 255
766 #       SourceAddress "1.2.3.4"
767 #       Device "eth0"
768 #       MaxMissed -1
769 #</Plugin>
770
771 #<Plugin postgresql>
772 #       <Query magic>
773 #               Statement "SELECT magic FROM wizard WHERE host = $1;"
774 #               Param hostname
775 #               <Result>
776 #                       Type gauge
777 #                       InstancePrefix "magic"
778 #                       ValuesFrom magic
779 #               </Result>
780 #       </Query>
781 #       <Query rt36_tickets>
782 #               Statement "SELECT COUNT(type) AS count, type \
783 #                                 FROM (SELECT CASE \
784 #                                              WHEN resolved = 'epoch' THEN 'open' \
785 #                                              ELSE 'resolved' END AS type \
786 #                                              FROM tickets) type \
787 #                                 GROUP BY type;"
788 #               <Result>
789 #                       Type counter
790 #                       InstancePrefix "rt36_tickets"
791 #                       InstancesFrom "type"
792 #                       ValuesFrom "count"
793 #               </Result>
794 #       </Query>
795 #       <Writer sqlstore>
796 #               # See contrib/postgresql/collectd_insert.sql for details
797 #               Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
798 #               StoreRates true
799 #       </Writer>
800 #       <Database foo>
801 #               Host "hostname"
802 #               Port "5432"
803 #               User "username"
804 #               Password "secret"
805 #               SSLMode "prefer"
806 #               KRBSrvName "kerberos_service_name"
807 #               Query magic
808 #       </Database>
809 #       <Database bar>
810 #               Interval 60
811 #               Service "service_name"
812 #               Query backend # predefined
813 #               Query rt36_tickets
814 #       </Database>
815 #       <Database qux>
816 #               Service "collectd_store"
817 #               Writer sqlstore
818 #               # see collectd.conf(5) for details
819 #               CommitInterval 30
820 #       </Database>
821 #</Plugin>
822
823 #<Plugin powerdns>
824 #  <Server "server_name">
825 #    Collect "latency"
826 #    Collect "udp-answers" "udp-queries"
827 #    Socket "/var/run/pdns.controlsocket"
828 #  </Server>
829 #  <Recursor "recursor_name">
830 #    Collect "questions"
831 #    Collect "cache-hits" "cache-misses"
832 #    Socket "/var/run/pdns_recursor.controlsocket"
833 #  </Recursor>
834 #  LocalSocket "/opt/collectd/var/run/collectd-powerdns"
835 #</Plugin>
836
837 #<Plugin processes>
838 #       Process "name"
839 #</Plugin>
840
841 #<Plugin protocols>
842 #       Value "/^Tcp:/"
843 #       IgnoreSelected false
844 #</Plugin>
845
846 #<Plugin python>
847 #       ModulePath "/path/to/your/python/modules"
848 #       LogTraces true
849 #       Interactive true
850 #       Import "spam"
851 #
852 #       <Module spam>
853 #               spam "wonderful" "lovely"
854 #       </Module>
855 #</Plugin>
856
857 #<Plugin redis>
858 #   <Node example>
859 #      Host "redis.example.com"
860 #      Port "6379"
861 #      Timeout 2000
862 #   </Node>
863 #</Plugin>
864
865 #<Plugin routeros>
866 #       <Router>
867 #               Host "router.example.com"
868 #               Port "8728"
869 #               User "admin"
870 #               Password "dozaiTh4"
871 #               CollectInterface true
872 #               CollectRegistrationTable true
873 #               CollectCPULoad true
874 #               CollectMemory true
875 #               CollectDF true
876 #               CollectDisk true
877 #       </Router>
878 #</Plugin>
879
880 #<Plugin rrdcached>
881 #       DaemonAddress "unix:/tmp/rrdcached.sock"
882 #       DataDir "@localstatedir@/lib/@PACKAGE_NAME@/rrd"
883 #       CreateFiles true
884 #       CreateFilesAsync false
885 #       CollectStatistics true
886 #</Plugin>
887
888 #<Plugin rrdtool>
889 #       DataDir "@localstatedir@/lib/@PACKAGE_NAME@/rrd"
890 #       CreateFilesAsync false
891 #       CacheTimeout 120
892 #       CacheFlush   900
893 #       WritesPerSecond 50
894 #</Plugin>
895
896 #<Plugin sensors>
897 #       SensorConfigFile "/etc/sensors.conf"
898 #       Sensor "it8712-isa-0290/temperature-temp1"
899 #       Sensor "it8712-isa-0290/fanspeed-fan3"
900 #       Sensor "it8712-isa-0290/voltage-in8"
901 #       IgnoreSelected false
902 #</Plugin>
903
904 #<Plugin sigrok>
905 #  LogLevel 3
906 #  <Device "AC Voltage">
907 #    Driver "fluke-dmm"
908 #    MinimumInterval 10
909 #    Conn "/dev/ttyUSB2"
910 #  </Device>
911 #  <Device "Sound Level">
912 #    Driver "cem-dt-885x"
913 #    Conn "/dev/ttyUSB1"
914 #  </Device>
915 #</Plugin>
916
917 #<Plugin snmp>
918 #   <Data "powerplus_voltge_input">
919 #       Type "voltage"
920 #       Table false
921 #       Instance "input_line1"
922 #       Values "SNMPv2-SMI::enterprises.6050.5.4.1.1.2.1"
923 #   </Data>
924 #   <Data "hr_users">
925 #       Type "users"
926 #       Table false
927 #       Instance ""
928 #       Values "HOST-RESOURCES-MIB::hrSystemNumUsers.0"
929 #   </Data>
930 #   <Data "std_traffic">
931 #       Type "if_octets"
932 #       Table true
933 #       Instance "IF-MIB::ifDescr"
934 #       Values "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
935 #   </Data>
936 #
937 #   <Host "some.switch.mydomain.org">
938 #       Address "192.168.0.2"
939 #       Version 1
940 #       Community "community_string"
941 #       Collect "std_traffic"
942 #       Interval 120
943 #   </Host>
944 #   <Host "some.server.mydomain.org">
945 #       Address "192.168.0.42"
946 #       Version 2
947 #       Community "another_string"
948 #       Collect "std_traffic" "hr_users"
949 #   </Host>
950 #   <Host "some.ups.mydomain.org">
951 #       Address "192.168.0.3"
952 #       Version 1
953 #       Community "more_communities"
954 #       Collect "powerplus_voltge_input"
955 #       Interval 300
956 #   </Host>
957 #</Plugin>
958
959 #<Plugin statsd>
960 #  Host "::"
961 #  Port "8125"
962 #  DeleteCounters false
963 #  DeleteTimers   false
964 #  DeleteGauges   false
965 #  DeleteSets     false
966 #  TimerPercentile 90.0
967 #</Plugin>
968
969 #<Plugin "swap">
970 #       ReportByDevice false
971 #       ReportBytes true
972 #</Plugin>
973
974 #<Plugin "table">
975 #       <Table "/proc/slabinfo">
976 #               Instance "slabinfo"
977 #               Separator " "
978 #               <Result>
979 #                       Type gauge
980 #                       InstancePrefix "active_objs"
981 #                       InstancesFrom 0
982 #                       ValuesFrom 1
983 #               </Result>
984 #               <Result>
985 #                       Type gauge
986 #                       InstancePrefix "objperslab"
987 #                       InstancesFrom 0
988 #                       ValuesFrom 4
989 #               </Result>
990 #       </Table>
991 #</Plugin>
992
993 #<Plugin "tail">
994 #  <File "/var/log/exim4/mainlog">
995 #    Instance "exim"
996 #    <Match>
997 #      Regex "S=([1-9][0-9]*)"
998 #      DSType "CounterAdd"
999 #      Type "ipt_bytes"
1000 #      Instance "total"
1001 #    </Match>
1002 #    <Match>
1003 #      Regex "\\<R=local_user\\>"
1004 #      ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
1005 #      DSType "CounterInc"
1006 #      Type "counter"
1007 #      Instance "local_user"
1008 #    </Match>
1009 #  </File>
1010 #</Plugin>
1011
1012 #<Plugin "tail_csv">
1013 #   <Metric "dropped">
1014 #       Type "percent"
1015 #       Instance "dropped"
1016 #       ValueFrom 1
1017 #   </Metric>
1018 #   <Metric "mbps">
1019 #       Type "bytes"
1020 #       Instance "wire-realtime"
1021 #       ValueFrom 2
1022 #   </Metric>
1023 #   <Metric "alerts">
1024 #       Type "alerts_per_second"
1025 #       ValueFrom 3
1026 #   </Metric>
1027 #   <Metric "kpps">
1028 #       Type "kpackets_wire_per_sec.realtime"
1029 #       ValueFrom 4
1030 #   </Metric>
1031 #   <File "/var/log/snort/snort.stats">
1032 #       Instance "snort-eth0"
1033 #       Interval 600
1034 #       Collect "dropped" "mbps" "alerts" "kpps"
1035 #       TimeFrom 0
1036 #   </File>
1037 #</Plugin>
1038
1039 #<Plugin tcpconns>
1040 #       ListeningPorts false
1041 #       LocalPort "25"
1042 #       RemotePort "25"
1043 #</Plugin>
1044
1045 #<Plugin teamspeak2>
1046 #       Host "127.0.0.1"
1047 #       Port "51234"
1048 #       Server "8767"
1049 #</Plugin>
1050
1051 #<Plugin ted>
1052 #       Device "/dev/ttyUSB0"
1053 #       Retries 0
1054 #</Plugin>
1055
1056 #<Plugin thermal>
1057 #       ForceUseProcfs false
1058 #       Device "THRM"
1059 #       IgnoreSelected false
1060 #</Plugin>
1061
1062 #<Plugin tokyotyrant>
1063 #       Host "localhost"
1064 #       Port "1978"
1065 #</Plugin>
1066
1067 #<Plugin unixsock>
1068 #       SocketFile "@prefix@/var/run/@PACKAGE_NAME@-unixsock"
1069 #       SocketGroup "collectd"
1070 #       SocketPerms "0660"
1071 #       DeleteSocket false
1072 #</Plugin>
1073
1074 #<Plugin uuid>
1075 #       UUIDFile "/etc/uuid"
1076 #</Plugin>
1077
1078 #<Plugin mic>
1079 #   ShowCPU true
1080 #   ShowCPUCores true
1081 #   ShowMemory true
1082 #   ShowTemperatures true
1083 ##  Temperature Sensors can be ignored/shown by repeated #Temperature lines, and
1084 ##  then inverted with a IgnoreSelectedTemperature.
1085 ##  Known Temperature sensors: die, devmem, fin, fout, vccp, vddg, vddq
1086 #   Temperature vddg
1087 #   IgnoreSelectedTemperature true
1088 #   ShowPower true
1089 ##  Power Sensors can be ignored/shown by repeated #Power lines, and
1090 ##  then inverted with a IgnoreSelectedTemperature.
1091 ##  Known Temperature sensors: total0, total1, inst, imax, pci3, c2x3, c2x4, vccp, vddg, vddq
1092 #   Power total1
1093 #   IgnoreSelectedPower true
1094 #</Plugin>
1095
1096 #<Plugin varnish>
1097 #   This tag support an argument if you want to
1098 #   monitor the local instance just use </Instance>
1099 #   If you prefer defining another instance you can do
1100 #   so by using <Instance "myinstance">
1101 #   <Instance>
1102 #      CollectCache true
1103 #      CollectBackend true
1104 #      CollectBan false           # Varnish 3 only
1105 #      CollectConnections true
1106 #      CollectDirectorDNS false   # Varnish 3 only
1107 #      CollectSHM true
1108 #      CollectESI false
1109 #      CollectFetch false
1110 #      CollectHCB false
1111 #      CollectObjects false
1112 #      CollectPurge false         # Varnish 2 only
1113 #      CollectSession false
1114 #      CollectSMA false           # Varnish 2 only
1115 #      CollectSMS false
1116 #      CollectSM false            # Varnish 2 only
1117 #      CollectStruct false
1118 #      CollectTotals false
1119 #      CollectUptime false
1120 #      CollectVCL false
1121 #      CollectWorkers false
1122 #   </Instance>
1123 #</Plugin>
1124
1125 #<Plugin vmem>
1126 #       Verbose false
1127 #</Plugin>
1128
1129 #<Plugin write_graphite>
1130 #  <Node "example">
1131 #    Host "localhost"
1132 #    Port "2003"
1133 #    Protocol "udp"
1134 #    LogSendErrors true
1135 #    Prefix "collectd"
1136 #    Postfix "collectd"
1137 #    StoreRates true
1138 #    AlwaysAppendDS false
1139 #    EscapeCharacter "_"
1140 #  </Node>
1141 #</Plugin>
1142
1143 #<Plugin write_http>
1144 #       <URL "http://example.com/collectd-post">
1145 #               User "collectd"
1146 #               Password "weCh3ik0"
1147 #               VerifyPeer true
1148 #               VerifyHost true
1149 #               CACert "/etc/ssl/ca.crt"
1150 #               Format "Command"
1151 #               StoreRates false
1152 #       </URL>
1153 #</Plugin>
1154
1155 #<Plugin write_mongodb>
1156 #       <Node "example">
1157 #               Host "localhost"
1158 #               Port "27017"
1159 #               Timeout 1000
1160 #               StoreRates false
1161 #               Database "auth_db"
1162 #               User "auth_user"
1163 #               Password "auth_passwd"
1164 #       </Node>
1165 #</Plugin>
1166
1167 #<Plugin write_redis>
1168 #       <Node "example">
1169 #               Host "localhost"
1170 #               Port "6379"
1171 #               Timeout 1000
1172 #       </Node>
1173 #</Plugin>
1174
1175 #<Plugin write_riemann>
1176 #       <Node "example">
1177 #               Host "localhost"
1178 #               Port 5555
1179 #               Protocol UDP
1180 #               StoreRates true
1181 #               AlwaysAppendDS false
1182 #       </Node>
1183 #       Tag "foobar"
1184 #       Attribute "foo" "bar"
1185 #</Plugin>
1186
1187 ##############################################################################
1188 # Filter configuration                                                       #
1189 #----------------------------------------------------------------------------#
1190 # The following configures collectd's filtering mechanism. Before changing   #
1191 # anything in this section, please read the `FILTER CONFIGURATION' section   #
1192 # in the collectd.conf(5) manual page.                                       #
1193 ##############################################################################
1194
1195 # Load required matches:
1196 #@BUILD_PLUGIN_MATCH_EMPTY_COUNTER_TRUE@LoadPlugin match_empty_counter
1197 #@BUILD_PLUGIN_MATCH_HASHED_TRUE@LoadPlugin match_hashed
1198 #@BUILD_PLUGIN_MATCH_REGEX_TRUE@LoadPlugin match_regex
1199 #@BUILD_PLUGIN_MATCH_VALUE_TRUE@LoadPlugin match_value
1200 #@BUILD_PLUGIN_MATCH_TIMEDIFF_TRUE@LoadPlugin match_timediff
1201
1202 # Load required targets:
1203 #@BUILD_PLUGIN_TARGET_NOTIFICATION_TRUE@LoadPlugin target_notification
1204 #@BUILD_PLUGIN_TARGET_REPLACE_TRUE@LoadPlugin target_replace
1205 #@BUILD_PLUGIN_TARGET_SCALE_TRUE@LoadPlugin target_scale
1206 #@BUILD_PLUGIN_TARGET_SET_TRUE@LoadPlugin target_set
1207 #@BUILD_PLUGIN_TARGET_V5UPGRADE_TRUE@LoadPlugin target_v5upgrade
1208
1209 #----------------------------------------------------------------------------#
1210 # The following block demonstrates the default behavior if no filtering is   #
1211 # configured at all: All values will be sent to all available write plugins. #
1212 #----------------------------------------------------------------------------#
1213
1214 #<Chain "PostCache">
1215 #  Target "write"
1216 #</Chain>
1217
1218 ##############################################################################
1219 # Threshold configuration                                                    #
1220 #----------------------------------------------------------------------------#
1221 # The following outlines how to configure collectd's threshold checking      #
1222 # plugin. The plugin and possible configuration options are documented in    #
1223 # the collectd-threshold(5) manual page.                                     #
1224 ##############################################################################
1225
1226 #@BUILD_PLUGIN_THRESHOLD_TRUE@LoadPlugin "threshold"
1227 #<Plugin "threshold">
1228 #  <Type "foo">
1229 #    WarningMin    0.00
1230 #    WarningMax 1000.00
1231 #    FailureMin    0.00
1232 #    FailureMax 1200.00
1233 #    Invert false
1234 #    Instance "bar"
1235 #  </Type>
1236 #
1237 #  <Plugin "interface">
1238 #    Instance "eth0"
1239 #    <Type "if_octets">
1240 #      FailureMax 10000000
1241 #      DataSource "rx"
1242 #    </Type>
1243 #  </Plugin>
1244 #
1245 #  <Host "hostname">
1246 #    <Type "cpu">
1247 #      Instance "idle"
1248 #      FailureMin 10
1249 #    </Type>
1250 #
1251 #    <Plugin "memory">
1252 #      <Type "memory">
1253 #        Instance "cached"
1254 #        WarningMin 100000000
1255 #      </Type>
1256 #    </Plugin>
1257 #
1258 #    <Type "load">
1259 #       DataSource "midterm"
1260 #       FailureMax 4
1261 #       Hits 3
1262 #       Hysteresis 3
1263 #    </Type>
1264 #  </Host>
1265 #</Plugin>