Code

add missing examples to configuration file
[pkg-collectd.git] / debian / collectd.conf
index 9b6acea671c57ddd8e9f43ad8073f12276a097b6..2c91a5bab94370a2afcdde79f60a20cb7c00c16c 100644 (file)
@@ -18,6 +18,20 @@ FQDNLookup true
 #PluginDir "/usr/lib/collectd"
 #TypesDB "/usr/share/collectd/types.db" "/etc/collectd/my_types.db"
 
+#----------------------------------------------------------------------------#
+# When enabled, plugins are loaded automatically with the default options    #
+# when an appropriate <Plugin ...> block is encountered.                     #
+# Disabled by default.                                                       #
+#----------------------------------------------------------------------------#
+#AutoLoadPlugin false
+
+#----------------------------------------------------------------------------#
+# When enabled, internal statistics are collected, using "collectd" as the   #
+# plugin name.                                                               #
+# Disabled by default.                                                       #
+#----------------------------------------------------------------------------#
+#CollectInternalStats false
+
 #----------------------------------------------------------------------------#
 # Interval at which to query values. This may be overwritten on a per-plugin #
 # base by using the 'Interval' option of the LoadPlugin block:               #
@@ -27,8 +41,15 @@ FQDNLookup true
 #----------------------------------------------------------------------------#
 #Interval 10
 
-#Timeout 2
-#ReadThreads 5
+#MaxReadInterval 86400
+#Timeout         2
+#ReadThreads     5
+#WriteThreads    5
+
+# Limit the size of the write queue. Default is no limit. Setting up a limit
+# is recommended for servers handling a high volume of traffic.
+#WriteQueueLimitHigh 1000000
+#WriteQueueLimitLow   800000
 
 ##############################################################################
 # Logging                                                                    #
@@ -40,6 +61,7 @@ FQDNLookup true
 
 #LoadPlugin logfile
 LoadPlugin syslog
+#LoadPlugin log_logstash
 
 #<Plugin logfile>
 #      LogLevel "info"
@@ -52,6 +74,11 @@ LoadPlugin syslog
        LogLevel info
 </Plugin>
 
+#<Plugin log_logstash>
+#      LogLevel info
+#      File "/var/log/collectd.json.log"
+#</Plugin>
+
 ##############################################################################
 # LoadPlugin section                                                         #
 #----------------------------------------------------------------------------#
@@ -63,8 +90,11 @@ LoadPlugin syslog
 #LoadPlugin apache
 #LoadPlugin apcups
 #LoadPlugin ascent
+#LoadPlugin barometer
 LoadPlugin battery
 #LoadPlugin bind
+#LoadPlugin ceph
+#LoadPlugin cgroups
 #LoadPlugin conntrack
 #LoadPlugin contextswitch
 LoadPlugin cpu
@@ -77,28 +107,32 @@ LoadPlugin cpu
 LoadPlugin df
 LoadPlugin disk
 #LoadPlugin dns
+#LoadPlugin drbd
 #LoadPlugin email
 LoadPlugin entropy
 #LoadPlugin ethstat
 #LoadPlugin exec
+#LoadPlugin fhcount
 #LoadPlugin filecount
 #LoadPlugin fscache
 #LoadPlugin gmond
 #LoadPlugin hddtemp
 LoadPlugin interface
+#LoadPlugin ipc
 #LoadPlugin ipmi
 #LoadPlugin iptables
 #LoadPlugin ipvs
 LoadPlugin irq
 #LoadPlugin java
-#LoadPlugin libvirt
 LoadPlugin load
+#LoadPlugin lvm
 #LoadPlugin madwifi
 #LoadPlugin mbmon
 #LoadPlugin md
 #LoadPlugin memcachec
 #LoadPlugin memcached
 LoadPlugin memory
+#LoadPlugin modbus
 #LoadPlugin multimeter
 #LoadPlugin mysql
 #LoadPlugin netlink
@@ -111,43 +145,55 @@ LoadPlugin memory
 #LoadPlugin numa
 #LoadPlugin nut
 #LoadPlugin olsrd
+#LoadPlugin onewire
+#LoadPlugin openldap
 #LoadPlugin openvpn
-#<LoadPlugin perl>
-#      Globals true
-#</LoadPlugin>
+#LoadPlugin perl
 #LoadPlugin pinba
 #LoadPlugin ping
 #LoadPlugin postgresql
 #LoadPlugin powerdns
 LoadPlugin processes
 #LoadPlugin protocols
-#<LoadPlugin python>
-#      Globals true
-#</LoadPlugin>
+#LoadPlugin python
+#LoadPlugin redis
 #LoadPlugin rrdcached
 LoadPlugin rrdtool
 #LoadPlugin sensors
 #LoadPlugin serial
+#LoadPlugin sigrok
+#LoadPlugin smart
 #LoadPlugin snmp
+#LoadPlugin statsd
 LoadPlugin swap
 #LoadPlugin table
 #LoadPlugin tail
+#LoadPlugin tail_csv
 #LoadPlugin tcpconns
 #LoadPlugin teamspeak2
 #LoadPlugin ted
 #LoadPlugin thermal
 #LoadPlugin tokyotyrant
+#LoadPlugin turbostat
 #LoadPlugin unixsock
 #LoadPlugin uptime
 LoadPlugin users
 #LoadPlugin uuid
 #LoadPlugin varnish
+#LoadPlugin virt
 #LoadPlugin vmem
 #LoadPlugin vserver
 #LoadPlugin wireless
 #LoadPlugin write_graphite
 #LoadPlugin write_http
-#LoadPlugin write_mongodb
+#LoadPlugin write_kafka
+#LoadPlugin write_log
+#LoadPlugin write_redis
+#LoadPlugin write_riemann
+#LoadPlugin write_sensu
+#LoadPlugin write_tsdb
+#LoadPlugin zfs_arc
+#LoadPlugin zookeeper
 
 ##############################################################################
 # Plugin configuration                                                       #
@@ -156,14 +202,17 @@ LoadPlugin users
 # ription of those options is available in the collectd.conf(5) manual page. #
 ##############################################################################
 
-#<Plugin "aggregation">
+#<Plugin aggregation>
 #      <Aggregation>
 #              #Host "unspecified"
 #              Plugin "cpu"
-#              #PluginInstance "unspecified"
+#              PluginInstance "/[0,2,4,6,8]$/"
 #              Type "cpu"
 #              #TypeInstance "unspecified"
 #
+#              SetPlugin "cpu"
+#              SetPluginInstance "even-%{aggregation}"
+#
 #              GroupBy "Host"
 #              GroupBy "TypeInstance"
 #
@@ -187,6 +236,7 @@ LoadPlugin users
 #              RoutingKey "collectd"
 #              Persistent false
 #              StoreRates false
+#              ConnectionRetryDelay 0
 #      </Publish>
 #</Plugin>
 
@@ -211,6 +261,7 @@ LoadPlugin users
 #<Plugin apcups>
 #      Host "localhost"
 #      Port "3551"
+#      ReportSeconds true
 #</Plugin>
 
 #<Plugin ascent>
@@ -222,7 +273,22 @@ LoadPlugin users
 #      CACert "/etc/ssl/ca.crt"
 #</Plugin>
 
-#<Plugin "bind">
+#<Plugin barometer>
+#      Device            "/dev/i2c-0";
+#      Oversampling      512
+#      PressureOffset    0.0
+#      TemperatureOffset 0.0
+#      Normalization     2
+#      Altitude          238.0
+#      TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
+#</Plugin>
+
+#<Plugin battery>
+#      ValuesPercentage false
+#      ReportDegraded false
+#</Plugin>
+
+#<Plugin bind>
 #      URL "http://localhost:8053/"
 #
 #      ParseTime false
@@ -243,6 +309,34 @@ LoadPlugin users
 #      </View>
 #</Plugin>
 
+#<Plugin ceph>
+#      LongRunAvgLatency false
+#      ConvertSpecialMetricTypes true
+#      <Daemon "osd.0">
+#              SocketPath "/var/run/ceph/ceph-osd.0.asok"
+#      </Daemon>
+#      <Daemon "osd.1">
+#              SocketPath "/var/run/ceph/ceph-osd.1.asok"
+#      </Daemon>
+#      <Daemon "mon.a">
+#              SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
+#      </Daemon>
+#      <Daemon "mds.a">
+#              SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
+#      </Daemon>
+#</Plugin>
+
+#<Plugin cgroups>
+#      CGroup "libvirt"
+#      IgnoreSelected false
+#</Plugin>
+
+#<Plugin cpu>
+#      ReportByCpu true
+#      ReportByState true
+#      ValuesPercentage false
+#</Plugin>
+
 #<Plugin csv>
 #      DataDir "/var/lib/collectd/csv"
 #      StoreRates false
@@ -253,10 +347,15 @@ LoadPlugin users
 #              URL "http://finance.google.com/finance?q=NYSE%3AAMD"
 #              User "foo"
 #              Password "bar"
-#              VerifyPeer false
-#              VerifyHost false
-#              CACert "/etc/ssl/ca.crt"
+#              Digest false
+#              VerifyPeer true
+#              VerifyHost true
+#              CACert "/path/to/ca.crt"
+#              Header "X-Custom-Header: foobar"
+#              Post "foo=bar"
+#
 #              MeasureResponseTime false
+#              MeasureResponseCode false
 #              <Match>
 #                      Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
 #                      DSType "GaugeAverage"
@@ -297,15 +396,18 @@ LoadPlugin users
 #  </URL>
 #</Plugin>
 
-#<Plugin "curl_xml">
+#<Plugin curl_xml>
 #      <URL "http://localhost/stats.xml">
 #              Host "my_host"
 #              Instance "some_instance"
 #              User "collectd"
 #              Password "thaiNg0I"
+#              Digest false
 #              VerifyPeer true
 #              VerifyHost true
 #              CACert "/path/to/ca.crt"
+#              Header "X-Custom-Header: foobar"
+#              Post "foo=bar"
 #
 #              <XPath "table[@id=\"magic_level\"]/tr">
 #                      Type "magic_level"
@@ -339,6 +441,7 @@ LoadPlugin users
 #              SelectDB "custdb0"
 #              Query "num_of_customers"
 #              Query "..."
+#              Host "..."
 #      </Database>
 #</Plugin>
 
@@ -362,14 +465,18 @@ LoadPlugin users
        IgnoreSelected true
 
 #      ReportByDevice false
-#      ReportReserved false
 #      ReportInodes false
+
+#      ValuesAbsolute true
+#      ValuesPercentage false
 </Plugin>
 
 #<Plugin disk>
 #      Disk "hda"
 #      Disk "/sda[23]/"
 #      IgnoreSelected false
+#      UseBSDName false
+#      UdevNameAttr "DEVNAME"
 #</Plugin>
 
 #<Plugin dns>
@@ -398,6 +505,11 @@ LoadPlugin users
 #      NotificationExec user "/path/to/exec"
 #</Plugin>
 
+#<Plugin fhcount>
+#      ValuesAbsolute true
+#      ValuesPercentage false
+#</Plugin>
+
 #<Plugin filecount>
 #      <Directory "/path/to/dir">
 #              Instance "foodir"
@@ -446,6 +558,7 @@ LoadPlugin users
 
 #<Plugin iptables>
 #      Chain "table" "chain"
+#      Chain6 "table" "chain"
 #</Plugin>
 
 #<Plugin irq>
@@ -466,15 +579,8 @@ LoadPlugin users
 #      </Plugin>
 #</Plugin>
 
-#<Plugin libvirt>
-#      Connection "xen:///"
-#      RefreshInterval 60
-#      Domain "name"
-#      BlockDevice "name:device"
-#      InterfaceDevice "name:device"
-#      IgnoreSelected false
-#      HostnameFormat name
-#      InterfaceFormat name
+#<Plugin load>
+#      ReportRelative true
 #</Plugin>
 
 #<Plugin madwifi>
@@ -521,6 +627,32 @@ LoadPlugin users
 #      </Instance>
 #</Plugin>
 
+#<Plugin memory>
+#      ValuesAbsolute true
+#      ValuesPercentage false
+#</Plugin>
+
+#<Plugin modbus>
+#      <Data "data_name">
+#              RegisterBase 1234
+#              RegisterCmd ReadHolding
+#              RegisterType float
+#              Type gauge
+#              Instance "..."
+#      </Data>
+#
+#      <Host "name">
+#              Address "addr"
+#              Port "1234"
+#              Interval 60
+#
+#              <Slave 1>
+#                      Instance "foobar" # optional
+#                      Collect "data_name"
+#              </Slave>
+#      </Host>
+#</Plugin>
+
 #<Plugin mysql>
 #      <Database db_name>
 #              Host "database.serv.er"
@@ -529,9 +661,12 @@ LoadPlugin users
 #              Password "secret"
 #              Database "db_name"
 #              MasterStats true
+#              ConnectTimeout 10
+#              InnodbStats true
 #      </Database>
 #
 #      <Database db_name2>
+#              Alias "squeeze"
 #              Host "localhost"
 #              Socket "/var/run/mysql/mysqld.sock"
 #              SlaveStats true
@@ -556,8 +691,9 @@ LoadPlugin users
 #              Username "user"
 #              Password "secret"
 #              Interface "eth0"
+#              ResolveInterval 14400
 #      </Server>
-#      TimeToLive "128"
+#      TimeToLive 128
 #
 #      # server setup:
 #      Listen "ff18::efc0:4a42" "25826"
@@ -566,7 +702,7 @@ LoadPlugin users
 #              AuthFile "/etc/collectd/passwd"
 #              Interface "eth0"
 #      </Listen>
-#      MaxPacketSize 1024
+#      MaxPacketSize 1452
 #
 #      # proxy setup (client and server as above):
 #      Forward true
@@ -625,6 +761,23 @@ LoadPlugin users
 #      CollectTopology "Summary"
 #</Plugin>
 
+#<Plugin onewire>
+#      Device "-s localhost:4304"
+#      Sensor "F10FCA000800"
+#      IgnoreSelected false
+#</Plugin>
+
+#<Plugin openldap>
+#      <Instance "localhost">
+#              URL "ldap://localhost:389"
+#              StartTLS false
+#              VerifyHost true
+#              CACert "/path/to/ca.crt"
+#              Timeout -1
+#              Version 3
+#      </Instance>
+#</Plugin>
+
 #<Plugin openvpn>
 #      StatusFile "/etc/openvpn/openvpn-status.log"
 #      ImprovedNamingSchema false
@@ -764,10 +917,19 @@ LoadPlugin users
 #      </Module>
 #</Plugin>
 
+#<Plugin redis>
+#      <Node example>
+#              Host "redis.example.com"
+#              Port "6379"
+#              Timeout 2000
+#      </Node>
+#</Plugin>
+
 #<Plugin rrdcached>
 #      DaemonAddress "unix:/var/run/rrdcached.sock"
 #      DataDir "/var/lib/rrdcached/db/collectd"
 #      CreateFiles true
+#      CreateFilesAsync false
 #      CollectStatistics true
 #
 # The following settings are rather advanced
@@ -784,6 +946,7 @@ LoadPlugin users
 #      CacheTimeout 120
 #      CacheFlush 900
 #      WritesPerSecond 30
+#      CreateFilesAsync false
 #      RandomTimeout 0
 #
 # The following settings are rather advanced
@@ -803,6 +966,24 @@ LoadPlugin users
 #      IgnoreSelected false
 #</Plugin>
 
+#<Plugin sigrok>
+#      LogLevel 3
+#      <Device "AC Voltage">
+#              Driver "fluke-dmm"
+#              MinimumInterval 10
+#              Conn "/dev/ttyUSB2"
+#      </Device>
+#      <Device "Sound Level">
+#              Driver "cem-dt-885x"
+#              Conn "/dev/ttyUSB1"
+#      </Device>
+#</Plugin>
+
+#<Plugin smart>
+#      Disk "/^[hs]d[a-f][0-9]?$/"
+#      IgnoreSelected false
+#</Plugin>
+
 # See /usr/share/doc/collectd/examples/snmp-data.conf.gz for a
 # comprehensive sample configuration.
 #<Plugin snmp>
@@ -850,6 +1031,22 @@ LoadPlugin users
 #      </Host>
 #</Plugin>
 
+#<Plugin statsd>
+#      Host "::"
+#      Port "8125"
+#      DeleteCounters false
+#      DeleteTimers   false
+#      DeleteGauges   false
+#      DeleteSets     false
+#      TimerPercentile 90.0
+#      TimerPercentile 95.0
+#      TimerPercentile 99.0
+#      TimerLower     false
+#      TimerUpper     false
+#      TimerSum       false
+#      TimerCount     false
+#</Plugin>
+
 #<Plugin swap>
 #      ReportByDevice false
 #      ReportBytes true
@@ -874,9 +1071,10 @@ LoadPlugin users
 #      </Table>
 #</Plugin>
 
-#<Plugin "tail">
+#<Plugin tail>
 #      <File "/var/log/exim4/mainlog">
 #              Instance "exim"
+#              Interval 60
 #              <Match>
 #                      Regex "S=([1-9][0-9]*)"
 #                      DSType "CounterAdd"
@@ -893,8 +1091,36 @@ LoadPlugin users
 #      </File>
 #</Plugin>
 
+#<Plugin tail_csv>
+#      <Metric "dropped">
+#              Type "percent"
+#              Instance "dropped"
+#              ValueFrom 1
+#      </Metric>
+#      <Metric "mbps">
+#              Type "bytes"
+#              Instance "wire-realtime"
+#              ValueFrom 2
+#      </Metric>
+#      <Metric "alerts">
+#              Type "alerts_per_second"
+#              ValueFrom 3
+#      </Metric>
+#      <Metric "kpps">
+#              Type "kpackets_wire_per_sec.realtime"
+#              ValueFrom 4
+#      </Metric>
+#      <File "/var/log/snort/snort.stats">
+#              Instance "snort-eth0"
+#              Interval 600
+#              Collect "dropped" "mbps" "alerts" "kpps"
+#              TimeFrom 0
+#      </File>
+#</Plugin>
+
 #<Plugin tcpconns>
 #      ListeningPorts false
+#      AllPortsSummary false
 #      LocalPort "25"
 #      RemotePort "25"
 #</Plugin>
@@ -921,6 +1147,25 @@ LoadPlugin users
 #      Port "1978"
 #</Plugin>
 
+#<Plugin turbostat>
+##     None of the following option should be set manually
+##     This plugin automatically detect most optimal options
+##     Only set values here if:
+##     - The module ask you to
+##     - You want to disable the collection of some data
+##     - Your (intel) CPU is not supported (yet) by the module
+##     - The module generate a lot of errors 'MSR offset 0x... read failed'
+##     In the last two cases, please open a bug request
+#
+#      TCCActivationTemp "100"
+#      CoreCstates "392"
+#      PackageCstates "396"
+#      SystemManagementInterrupt true
+#      DigitalTemperatureSensor true
+#      PackageThermalManagement true
+#      RunningAveragePowerLimit "7"
+#</Plugin>
+
 #<Plugin unixsock>
 #      SocketFile "/var/run/collectd-unixsock"
 #      SocketGroup "collectd"
@@ -934,17 +1179,26 @@ LoadPlugin users
 
 #<Plugin varnish>
 #      <Instance>
-#              CollectCache true
 #              CollectBackend true
+#              CollectBan false           # Varnish 3 and above
+#              CollectCache true
 #              CollectConnections true
-#              CollectSHM true
+#              CollectDirectorDNS false   # Varnish 3 only
 #              CollectESI false
 #              CollectFetch false
 #              CollectHCB false
-#              CollectSMA false
+#              CollectObjects false
+#              CollectPurge false         # Varnish 2 only
+#              CollectSession false
+#              CollectSHM true
+#              CollectSMA false           # Varnish 2 only
 #              CollectSMS false
-#              CollectSM false
+#              CollectSM false            # Varnish 2 only
+#              CollectStruct false
 #              CollectTotals false
+#              CollectUptime false        # Varnish 3 and above
+#              CollectdVCL false
+#              CollectVSM false           # Varnish 4 only
 #              CollectWorkers false
 #      </Instance>
 #
@@ -953,43 +1207,124 @@ LoadPlugin users
 #      </Instance>
 #</Plugin>
 
+#<Plugin virt>
+#      Connection "xen:///"
+#      RefreshInterval 60
+#      Domain "name"
+#      BlockDevice "name:device"
+#      InterfaceDevice "name:device"
+#      IgnoreSelected false
+#      HostnameFormat name
+#      InterfaceFormat name
+#      PluginInstanceFormat name
+#</Plugin>
+
 #<Plugin vmem>
 #      Verbose false
 #</Plugin>
 
 #<Plugin write_graphite>
-#      <Carbon>
+#      <Node "example">
 #              Host "localhost"
 #              Port "2003"
+#              Protocol "tcp"
+#              LogSendErrors true
 #              Prefix "collectd"
 #              Postfix "collectd"
-#              StoreRates false
+#              StoreRates true
 #              AlwaysAppendDS false
 #              EscapeCharacter "_"
-#      </Carbon>
+#      </Node>
 #</Plugin>
 
 #<Plugin write_http>
-#      <URL "http://example.com/collectd-post">
+#      <Node "example">
+#              URL "http://example.com/collectd-post"
 #              User "collectd"
 #              Password "secret"
 #              VerifyPeer true
 #              VerifyHost true
 #              CACert "/etc/ssl/ca.crt"
+#              CAPath "/etc/ssl/certs/"
+#              ClientKey "/etc/ssl/client.pem"
+#              ClientCert "/etc/ssl/client.crt"
+#              ClientKeyPass "secret"
+#              SSLVersion "TLSv1"
 #              Format "Command"
 #              StoreRates false
-#      </URL>
+#              BufferSize 4096
+#              LowSpeedLimit 0
+#              Timeout 0
+#      </Node>
+#</Plugin>
+
+#<Plugin write_kafka>
+#      Property "metadata.broker.list" "localhost:9092"
+#      <Topic "collectd">
+#              Format JSON
+#      </Topic>
 #</Plugin>
 
-#<Plugin write_mongodb>
+#<Plugin write_redis>
 #      <Node "example">
 #              Host "localhost"
-#              Port "27017"
+#              Port "6379"
 #              Timeout 1000
-#              StoreRates false
 #      <Node>
 #</Plugin>
 
-Include "/etc/collectd/filters.conf"
-Include "/etc/collectd/thresholds.conf"
+#<Plugin write_riemann>
+#      <Node "example">
+#              Host "localhost"
+#              Port 5555
+#              Protocol TCP
+#              Batch true
+#              BatchMaxSize 8192
+#              StoreRates true
+#              AlwaysAppendDS false
+#              TTLFactor 2.0
+#              Notifications true
+#              CheckThresholds false
+#              EventServicePrefix ""
+#      </Node>
+#      Tag "foobar"
+#      Attribute "foo" "bar"
+#</Plugin>
+
+#<Plugin write_sensu>
+#      <Node "example">
+#              Host "localhost"
+#              Port 3030
+#              StoreRates true
+#              AlwaysAppendDS false
+#              Notifications true
+#              Metrics true
+#              EventServicePrefix ""
+#              MetricHandler "influx"
+#              MetricHandler "default"
+#              NotificationHandler "flapjack"
+#              NotificationHandler "howling_monkey"
+#      </Node>
+#      Tag "foobar"
+#      Attribute "foo" "bar"
+#</Plugin>
+
+#<Plugin write_tsdb>
+#      <Node>
+#              Host "localhost"
+#              Port "4242"
+#              HostTags "status=production"
+#              StoreRates false
+#              AlwaysAppendDS false
+#      </Node>
+#</Plugin>
+
+#<Plugin zookeeper>
+#      Host "localhost"
+#      Port "2181"
+#</Plugin>
+
+<Include "/etc/collectd/collectd.conf.d">
+       Filter "*.conf"
+</Include>