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