src/collectd.conf.pod

   1 =encoding UTF-8
   2
   3 =head1 NAME
   4
   5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
   6
   7 =head1 SYNOPSIS
   8
   9   BaseDir "/var/lib/collectd"
  10   PIDFile "/run/collectd.pid"
  11   Interval 10.0
  12
  13   LoadPlugin cpu
  14   LoadPlugin load
  15
  16   <LoadPlugin df>
  17     Interval 3600
  18   </LoadPlugin>
  19   <Plugin df>
  20     ValuesPercentage true
  21   </Plugin>
  22
  23   LoadPlugin ping
  24   <Plugin ping>
  25     Host "example.org"
  26     Host "provider.net"
  27   </Plugin>
  28
  29 =head1 DESCRIPTION
  30
  31 This config file controls how the system statistics collection daemon
  32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
  33 controls which plugins to load. These plugins ultimately define collectd's
  34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
  35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
  36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
  37
  38 The syntax of this config file is similar to the config file of the famous
  39 I<Apache> webserver. Each line contains either an option (a key and a list of
  40 one or more values) or a section-start or -end. Empty lines and everything
  41 after a non-quoted hash-symbol (C<#>) are ignored. I<Keys> are unquoted
  42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
  43 character. Keys are handled case insensitive by I<collectd> itself and all
  44 plugins included with it. I<Values> can either be an I<unquoted string>, a
  45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
  46 expression. I<Unquoted strings> consist of only alphanumeric characters and
  47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
  48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
  49 to include double quotes as part of the string. I<Numbers> can be specified in
  50 decimal and floating point format (using a dot C<.> as decimal separator),
  51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
  52 I<Boolean> values are either B<true> or B<false>.
  53
  54 Lines may be wrapped by using C<\> as the last character before the newline.
  55 This allows long lines to be split into multiple lines. Quoted strings may be
  56 wrapped as well. However, those are treated special in that whitespace at the
  57 beginning of the following lines will be ignored, which allows for nicely
  58 indenting the wrapped lines.
  59
  60 The configuration is read and processed in order, i.e. from top to bottom. So
  61 the plugins are loaded in the order listed in this config file. It is a good
  62 idea to load any logging plugins first in order to catch messages from plugins
  63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
  64 B<LoadPlugin> option I<must> occur I<before> the appropriate
  65 C<E<lt>B<Plugin> ...E<gt>> block.
  66
  67 =head1 GLOBAL OPTIONS
  68
  69 =over 4
  70
  71 =item B<BaseDir> I<Directory>
  72
  73 Sets the base directory. This is the directory beneath which all RRD-files are
  74 created. Possibly more subdirectories are created. This is also the working
  75 directory for the daemon.
  76
  77 =item B<LoadPlugin> I<Plugin>
  78
  79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
  80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
  81 I<collectd> will be mostly useless.
  82
  83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
  84 effect. This is useful when you want to split up the configuration into smaller
  85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
  86 block I<and> the appropriate B<LoadPlugin> statement. The downside is that if
  87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
  88 different intervals, only one of them (the first one encountered) will take
  89 effect and all others will be silently ignored.
  90
  91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
  92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
  93 statement looks like this:
  94
  95  LoadPlugin "cpu"
  96
  97 Options inside a B<LoadPlugin> block can override default settings and
  98 influence the way plugins are loaded, e.g.:
  99
 100  <LoadPlugin perl>
 101    Interval 60
 102  </LoadPlugin>
 103
 104 The following options are valid inside B<LoadPlugin> blocks:
 105
 106 =over 4
 107
 108 =item B<Globals> B<true|false>
 109
 110 If enabled, collectd will export all global symbols of the plugin (and of all
 111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
 112 available for resolving unresolved symbols in subsequently loaded plugins if
 113 that is supported by your system.
 114
 115 This is useful (or possibly even required), e.g., when loading a plugin that
 116 embeds some scripting language into the daemon (e.g. the I<Perl> and
 117 I<Python plugins>). Scripting languages usually provide means to load
 118 extensions written in C. Those extensions require symbols provided by the
 119 interpreter, which is loaded as a dependency of the respective collectd plugin.
 120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
 121 L<collectd-python(5)>) for details.
 122
 123 By default, this is disabled. As a special exception, if the plugin name is
 124 either C<perl> or C<python>, the default is changed to enabled in order to keep
 125 the average user from ever having to deal with this low level linking stuff.
 126
 127 =item B<Interval> I<Seconds>
 128
 129 Sets a plugin-specific interval for collecting metrics. This overrides the
 130 global B<Interval> setting. If a plugin provides its own support for specifying
 131 an interval, that setting will take precedence.
 132
 133 =item B<FlushInterval> I<Seconds>
 134
 135 Specifies the interval, in seconds, to call the flush callback if it's
 136 defined in this plugin. By default, this is disabled.
 137
 138 =item B<FlushTimeout> I<Seconds>
 139
 140 Specifies the value of the timeout argument of the flush callback.
 141
 142 =back
 143
 144 =item B<AutoLoadPlugin> B<false>|B<true>
 145
 146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
 147 using the B<LoadPlugin> statement documented above. If a
 148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
 149 handling callback for this plugin has been registered, a warning is logged and
 150 the block is ignored.
 151
 152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
 153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
 154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
 155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
 156
 157 =item B<CollectInternalStats> B<false>|B<true>
 158
 159 When set to B<true>, various statistics about the I<collectd> daemon will be
 160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
 161
 162 The following metrics are reported:
 163
 164 =over 4
 165
 166 =item C<collectd-write_queue/queue_length>
 167
 168 The number of metrics currently in the write queue. You can limit the queue
 169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
 170
 171 =item C<collectd-write_queue/derive-dropped>
 172
 173 The number of metrics dropped due to a queue length limitation.
 174 If this value is non-zero, your system can't handle all incoming metrics and
 175 protects itself against overload by dropping metrics.
 176
 177 =item C<collectd-cache/cache_size>
 178
 179 The number of elements in the metric cache (the cache you can interact with
 180 using L<collectd-unixsock(5)>).
 181
 182 =back
 183
 184 =item B<Include> I<Path> [I<pattern>]
 185
 186 If I<Path> points to a file, includes that file. If I<Path> points to a
 187 directory, recursively includes all files within that directory and its
 188 subdirectories. If the C<wordexp> function is available on your system,
 189 shell-like wildcards are expanded before files are included. This means you can
 190 use statements like the following:
 191
 192   Include "/etc/collectd.d/*.conf"
 193
 194 Starting with version 5.3, this may also be a block in which further options
 195 affecting the behavior of B<Include> may be specified. The following option is
 196 currently allowed:
 197
 198   <Include "/etc/collectd.d">
 199     Filter "*.conf"
 200   </Include>
 201
 202 =over 4
 203
 204 =item B<Filter> I<pattern>
 205
 206 If the C<fnmatch> function is available on your system, a shell-like wildcard
 207 I<pattern> may be specified to filter which files to include. This may be used
 208 in combination with recursively including a directory to easily be able to
 209 arbitrarily mix configuration files and other documents (e.g. README files).
 210 The given example is similar to the first example above but includes all files
 211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
 212
 213 =back
 214
 215 If more than one file is included by a single B<Include> option, the files
 216 will be included in lexicographical order (as defined by the C<strcmp>
 217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
 218 order in which the files are loaded.
 219
 220 To prevent loops and shooting yourself in the foot in interesting ways the
 221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
 222 most uses. Since symlinks are followed it is still possible to crash the daemon
 223 by looping symlinks. In our opinion significant stupidity should result in an
 224 appropriate amount of pain.
 225
 226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
 227 file, but you cannot include files from within blocks.
 228
 229 =item B<PIDFile> I<File>
 230
 231 Sets where to write the PID file to. This file is overwritten when it exists
 232 and deleted when the program is stopped. Some init-scripts might override this
 233 setting using the B<-P> command-line option.
 234
 235 =item B<PluginDir> I<Directory>
 236
 237 Path to the plugins (shared objects) of collectd.
 238
 239 =item B<TypesDB> I<File> [I<File> ...]
 240
 241 Set one or more files that contain the data-set descriptions. See
 242 L<types.db(5)> for a description of the format of this file.
 243
 244 If this option is not specified, a default file is read. If you need to define
 245 custom types in addition to the types defined in the default file, you need to
 246 explicitly load both. In other words, if the B<TypesDB> option is encountered
 247 the default behavior is disabled and if you need the default types you have to
 248 also explicitly load them.
 249
 250 =item B<Interval> I<Seconds>
 251
 252 Configures the interval in which to query the read plugins. Obviously smaller
 253 values lead to a higher system load produced by collectd, while higher values
 254 lead to more coarse statistics.
 255
 256 B<Warning:> You should set this once and then never touch it again. If you do,
 257 I<you will have to delete all your RRD files> or know some serious RRDtool
 258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
 259
 260 =item B<MaxReadInterval> I<Seconds>
 261
 262 A read plugin doubles the interval between queries after each failed attempt
 263 to get data.
 264
 265 This options limits the maximum value of the interval. The default value is
 266 B<86400>.
 267
 268 =item B<Timeout> I<Iterations>
 269
 270 Consider a value list "missing" when no update has been read or received for
 271 I<Iterations> iterations. By default, I<collectd> considers a value list
 272 missing when no update has been received for twice the update interval. Since
 273 this setting uses iterations, the maximum allowed time without update depends
 274 on the I<Interval> information contained in each value list. This is used in
 275 the I<Threshold> configuration to dispatch notifications about missing values,
 276 see L<collectd-threshold(5)> for details.
 277
 278 =item B<ReadThreads> I<Num>
 279
 280 Number of threads to start for reading plugins. The default value is B<5>, but
 281 you may want to increase this if you have more than five plugins that take a
 282 long time to read. Mostly those are plugins that do network-IO. Setting this to
 283 a value higher than the number of registered read callbacks is not recommended.
 284
 285 =item B<WriteThreads> I<Num>
 286
 287 Number of threads to start for dispatching value lists to write plugins. The
 288 default value is B<5>, but you may want to increase this if you have more than
 289 five plugins that may take relatively long to write to.
 290
 291 =item B<WriteQueueLimitHigh> I<HighNum>
 292
 293 =item B<WriteQueueLimitLow> I<LowNum>
 294
 295 Metrics are read by the I<read threads> and then put into a queue to be handled
 296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
 297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
 298 running into memory issues in such a case, you can limit the size of this
 299 queue.
 300
 301 By default, there is no limit and memory may grow indefinitely. This is most
 302 likely not an issue for clients, i.e. instances that only handle the local
 303 metrics. For servers it is recommended to set this to a non-zero value, though.
 304
 305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
 306 Each of them takes a numerical argument which is the number of metrics in the
 307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
 308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
 309 I<will> be enqueued. If the number of metrics currently in the queue is between
 310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
 311 proportional to the number of metrics in the queue (i.e. it increases linearly
 312 until it reaches 100%.)
 313
 314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
 315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
 316
 317 If you do not want to randomly drop values when the queue size is between
 318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
 319 to the same value.
 320
 321 Enabling the B<CollectInternalStats> option is of great help to figure out the
 322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
 323
 324 =item B<Hostname> I<Name>
 325
 326 Sets the hostname that identifies a host. If you omit this setting, the
 327 hostname will be determined using the L<gethostname(2)> system call.
 328
 329 =item B<FQDNLookup> B<true|false>
 330
 331 If B<Hostname> is determined automatically this setting controls whether or not
 332 the daemon should try to figure out the "fully qualified domain name", FQDN.
 333 This is done using a lookup of the name returned by C<gethostname>. This option
 334 is enabled by default.
 335
 336 =item B<PreCacheChain> I<ChainName>
 337
 338 =item B<PostCacheChain> I<ChainName>
 339
 340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
 341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
 342 setting change the daemon's behavior.
 343
 344 =back
 345
 346 =head1 PLUGIN OPTIONS
 347
 348 Some plugins may register own options. These options must be enclosed in a
 349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
 350 require external configuration, too. The C<apache plugin>, for example,
 351 required C<mod_status> to be configured in the webserver you're going to
 352 collect data from. These plugins are listed below as well, even if they don't
 353 require any configuration within collectd's configuration file.
 354
 355 A list of all plugins and a short summary for each plugin can be found in the
 356 F<README> file shipped with the sourcecode and hopefully binary packets as
 357 well.
 358
 359 =head2 Plugin C<aggregation>
 360
 361 The I<Aggregation plugin> makes it possible to aggregate several values into
 362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
 363 This can be put to a wide variety of uses, e.g. average and total CPU
 364 statistics for your entire fleet.
 365
 366 The grouping is powerful but, as with many powerful tools, may be a bit
 367 difficult to wrap your head around. The grouping will therefore be
 368 demonstrated using an example: The average and sum of the CPU usage across
 369 all CPUs of each host is to be calculated.
 370
 371 To select all the affected values for our example, set C<Plugin cpu> and
 372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
 373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
 374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
 375 statement.
 376
 377   Plugin "cpu"
 378   Type "cpu"
 379
 380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...)  and
 381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
 382 example, the intention is to have a new value for each host / type instance
 383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
 384 It can be specified multiple times to group by more than one field.
 385
 386   GroupBy "Host"
 387   GroupBy "TypeInstance"
 388
 389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
 390 metrics that differ in the CPU number only will be aggregated. Each
 391 aggregation needs I<at least one> such field, otherwise no aggregation would
 392 take place.
 393
 394 The full example configuration looks like this:
 395
 396  <Plugin "aggregation">
 397    <Aggregation>
 398      Plugin "cpu"
 399      Type "cpu"
 400
 401      GroupBy "Host"
 402      GroupBy "TypeInstance"
 403
 404      CalculateSum true
 405      CalculateAverage true
 406    </Aggregation>
 407  </Plugin>
 408
 409 There are a couple of limitations you should be aware of:
 410
 411 =over 4
 412
 413 =item *
 414
 415 The I<Type> cannot be left unspecified, because it is not reasonable to add
 416 apples to oranges. Also, the internal lookup structure won't work if you try
 417 to group by type.
 418
 419 =item *
 420
 421 There must be at least one unspecified, ungrouped field. Otherwise nothing
 422 will be aggregated.
 423
 424 =back
 425
 426 As you can see in the example above, each aggregation has its own
 427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
 428 blocks may match the same values, i.e. one value list can update multiple
 429 aggregations. The following options are valid inside B<Aggregation> blocks:
 430
 431 =over 4
 432
 433 =item B<Host> I<Host>
 434
 435 =item B<Plugin> I<Plugin>
 436
 437 =item B<PluginInstance> I<PluginInstance>
 438
 439 =item B<Type> I<Type>
 440
 441 =item B<TypeInstance> I<TypeInstance>
 442
 443 Selects the value lists to be added to this aggregation. B<Type> must be a
 444 valid data set name, see L<types.db(5)> for details.
 445
 446 If the string starts with and ends with a slash (C</>), the string is
 447 interpreted as a I<regular expression>. The regex flavor used are POSIX
 448 extended regular expressions as described in L<regex(7)>. Example usage:
 449
 450  Host "/^db[0-9]\\.example\\.com$/"
 451
 452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
 453
 454 Group valued by the specified field. The B<GroupBy> option may be repeated to
 455 group by multiple fields.
 456
 457 =item B<SetHost> I<Host>
 458
 459 =item B<SetPlugin> I<Plugin>
 460
 461 =item B<SetPluginInstance> I<PluginInstance>
 462
 463 =item B<SetTypeInstance> I<TypeInstance>
 464
 465 Sets the appropriate part of the identifier to the provided string.
 466
 467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
 468 will be replaced with the aggregation function, e.g. "average". Not including
 469 the placeholder will result in duplication warnings and/or messed up values if
 470 more than one aggregation function are enabled.
 471
 472 The following example calculates the average usage of all "even" CPUs:
 473
 474  <Plugin "aggregation">
 475    <Aggregation>
 476      Plugin "cpu"
 477      PluginInstance "/[0,2,4,6,8]$/"
 478      Type "cpu"
 479
 480      SetPlugin "cpu"
 481      SetPluginInstance "even-%{aggregation}"
 482
 483      GroupBy "Host"
 484      GroupBy "TypeInstance"
 485
 486      CalculateAverage true
 487    </Aggregation>
 488  </Plugin>
 489
 490 This will create the files:
 491
 492 =over 4
 493
 494 =item *
 495
 496 foo.example.com/cpu-even-average/cpu-idle
 497
 498 =item *
 499
 500 foo.example.com/cpu-even-average/cpu-system
 501
 502 =item *
 503
 504 foo.example.com/cpu-even-average/cpu-user
 505
 506 =item *
 507
 508 ...
 509
 510 =back
 511
 512 =item B<CalculateNum> B<true>|B<false>
 513
 514 =item B<CalculateSum> B<true>|B<false>
 515
 516 =item B<CalculateAverage> B<true>|B<false>
 517
 518 =item B<CalculateMinimum> B<true>|B<false>
 519
 520 =item B<CalculateMaximum> B<true>|B<false>
 521
 522 =item B<CalculateStddev> B<true>|B<false>
 523
 524 Boolean options for enabling calculation of the number of value lists, their
 525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
 526 are disabled by default.
 527
 528 =back
 529
 530 =head2 Plugin C<amqp>
 531
 532 The I<AMQP plugin> can be used to communicate with other instances of
 533 I<collectd> or third party applications using an AMQP 0.9.1 message broker.
 534 Values are sent to or received from the broker, which handles routing,
 535 queueing and possibly filtering out messages.
 536
 537 B<Synopsis:>
 538
 539  <Plugin "amqp">
 540    # Send values to an AMQP broker
 541    <Publish "some_name">
 542      Host "localhost"
 543      Port "5672"
 544      VHost "/"
 545      User "guest"
 546      Password "guest"
 547      Exchange "amq.fanout"
 548  #   ExchangeType "fanout"
 549  #   RoutingKey "collectd"
 550  #   Persistent false
 551  #   ConnectionRetryDelay 0
 552  #   Format "command"
 553  #   StoreRates false
 554  #   GraphitePrefix "collectd."
 555  #   GraphiteEscapeChar "_"
 556  #   GraphiteSeparateInstances false
 557  #   GraphiteAlwaysAppendDS false
 558  #   GraphitePreserveSeparator false
 559    </Publish>
 560
 561    # Receive values from an AMQP broker
 562    <Subscribe "some_name">
 563      Host "localhost"
 564      Port "5672"
 565      VHost "/"
 566      User "guest"
 567      Password "guest"
 568      Exchange "amq.fanout"
 569  #   ExchangeType "fanout"
 570  #   Queue "queue_name"
 571  #   QueueDurable false
 572  #   QueueAutoDelete true
 573  #   RoutingKey "collectd.#"
 574  #   ConnectionRetryDelay 0
 575    </Subscribe>
 576  </Plugin>
 577
 578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
 579 blocks, which configure sending and receiving of values respectively. The two
 580 blocks are very similar, so unless otherwise noted, an option can be used in
 581 either block. The name given in the blocks starting tag is only used for
 582 reporting messages, but may be used to support I<flushing> of certain
 583 I<Publish> blocks in the future.
 584
 585 =over 4
 586
 587 =item B<Host> I<Host>
 588
 589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
 590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
 591
 592 =item B<Port> I<Port>
 593
 594 Service name or port number on which the AMQP broker accepts connections. This
 595 argument must be a string, even if the numeric form is used. Defaults to
 596 "5672".
 597
 598 =item B<VHost> I<VHost>
 599
 600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
 601
 602 =item B<User> I<User>
 603
 604 =item B<Password> I<Password>
 605
 606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
 607 is used.
 608
 609 =item B<Exchange> I<Exchange>
 610
 611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
 612 By default, "amq.fanout" will be used.
 613
 614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
 615 the given exchange and the I<queue> is created, using the I<routing key> if
 616 configured. See the B<Queue> and B<RoutingKey> options below.
 617
 618 =item B<ExchangeType> I<Type>
 619
 620 If given, the plugin will try to create the configured I<exchange> with this
 621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
 622 be bound to this exchange.
 623
 624 =item B<Queue> I<Queue> (Subscribe only)
 625
 626 Configures the I<queue> name to subscribe to. If no queue name was configured
 627 explicitly, a unique queue name will be created by the broker.
 628
 629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
 630
 631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
 632 or transient (will disappear if the AMQP broker is restarted). Defaults to
 633 "false".
 634
 635 This option should be used in conjunction with the I<Persistent> option on the
 636 publish side.
 637
 638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
 639
 640 Defines if the I<queue> subscribed to will be deleted once the last consumer
 641 unsubscribes. Defaults to "true".
 642
 643 =item B<RoutingKey> I<Key>
 644
 645 In I<Publish> blocks, this configures the routing key to set on all outgoing
 646 messages. If not given, the routing key will be computed from the I<identifier>
 647 of the value. The host, plugin, type and the two instances are concatenated
 648 together using dots as the separator and all containing dots replaced with
 649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
 650 possible to receive only specific values using a "topic" exchange.
 651
 652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
 653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
 654 used to filter messages when using a "topic" exchange. If you're only
 655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
 656 for example.
 657
 658 =item B<Persistent> B<true>|B<false> (Publish only)
 659
 660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
 661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
 662 default), the I<transient> delivery mode will be used, i.e. messages may be
 663 lost due to high load, overflowing queues or similar issues.
 664
 665 =item B<ConnectionRetryDelay> I<Delay>
 666
 667 When the connection to the AMQP broker is lost, defines the time in seconds to
 668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
 669 attempt to reconnect at each read interval (in Subscribe mode) or each time
 670 values are ready for submission (in Publish mode).
 671
 672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
 673
 674 Selects the format in which messages are sent to the broker. If set to
 675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
 676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
 677 case, the C<Content-Type> header field will be set to C<text/collectd>.
 678
 679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
 680 an easy and straight forward exchange format. The C<Content-Type> header field
 681 will be set to C<application/json>.
 682
 683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
 684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
 685 C<text/graphite>.
 686
 687 A subscribing client I<should> use the C<Content-Type> header field to
 688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
 689 only decode the B<Command> format.
 690
 691 =item B<StoreRates> B<true>|B<false> (Publish only)
 692
 693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
 694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
 695 default), no conversion is performed. Otherwise the conversion is performed
 696 using the internal value cache.
 697
 698 Please note that currently this option is only used if the B<Format> option has
 699 been set to B<JSON>.
 700
 701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
 702
 703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
 704 It's added before the I<Host> name.
 705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 706
 707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
 708
 709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
 710 It's added after the I<Host> name.
 711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 712
 713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
 714
 715 Specify a character to replace dots (.) in the host part of the metric name.
 716 In I<Graphite> metric name, dots are used as separators between different
 717 metric parts (host, plugin, type).
 718 Default is "_" (I<Underscore>).
 719
 720 =item B<GraphiteSeparateInstances> B<true>|B<false>
 721
 722 If set to B<true>, the plugin instance and type instance will be in their own
 723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
 724 default), the plugin and plugin instance (and likewise the type and type
 725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
 726
 727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
 728
 729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
 730 identifier. If set to B<false> (the default), this is only done when there is
 731 more than one DS.
 732
 733 =item B<GraphitePreserveSeparator> B<false>|B<true>
 734
 735 If set to B<false> (the default) the C<.> (dot) character is replaced with
 736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
 737 is preserved, i.e. passed through.
 738
 739 =back
 740
 741 =head2 Plugin C<amqp1>
 742
 743 The I<AMQP1 plugin> can be used to communicate with other instances of
 744 I<collectd> or third party applications using an AMQP 1.0 message
 745 intermediary. Metric values or notifications are sent to the
 746 messaging intermediary which may handle direct messaging or
 747 queue based transfer.
 748
 749 B<Synopsis:>
 750
 751  <Plugin "amqp1">
 752    # Send values to an AMQP 1.0 intermediary
 753   <Transport "name">
 754     Host "localhost"
 755     Port "5672"
 756     User "guest"
 757     Password "guest"
 758     Address "collectd"
 759 #    RetryDelay 1
 760     <Instance "some_name">
 761         Format "command"
 762         PreSettle false
 763         Notify false
 764  #      StoreRates false
 765  #      GraphitePrefix "collectd."
 766  #      GraphiteEscapeChar "_"
 767  #      GraphiteSeparateInstances false
 768  #      GraphiteAlwaysAppendDS false
 769  #      GraphitePreserveSeparator false
 770     </Instance>
 771   </Transport>
 772  </Plugin>
 773
 774 The plugin's configuration consists of a I<Transport> that configures
 775 communications to the AMQP 1.0 messaging bus and one or more I<Instance>
 776 corresponding to metric or event publishers to the messaging system.
 777
 778 The address in the I<Transport> block concatenated with the name given in the
 779 I<Instance> block starting tag will be used as the send-to address for
 780 communications over the messaging link.
 781
 782 The following options are accepted within each I<Transport> block:
 783
 784 =over 4
 785
 786 =item B<Host> I<Host>
 787
 788 Hostname or IP-address of the AMQP 1.0 intermediary. Defaults to the
 789 default behavior of the underlying communications library,
 790 I<libqpid-proton>, which is "localhost".
 791
 792 =item B<Port> I<Port>
 793
 794 Service name or port number on which the AMQP 1.0 intermediary accepts
 795 connections. This argument must be a string, even if the numeric form
 796 is used. Defaults to "5672".
 797
 798 =item B<User> I<User>
 799
 800 =item B<Password> I<Password>
 801
 802 Credentials used to authenticate to the AMQP 1.0 intermediary. By
 803 default "guest"/"guest" is used.
 804
 805 =item B<Address> I<Address>
 806
 807 This option specifies the prefix for the send-to value in the message.
 808 By default, "collectd" will be used.
 809
 810 =item B<RetryDelay> I<RetryDelay>
 811
 812 When the AMQP1 connection is lost, defines the time in seconds to wait
 813 before attempting to reconnect. Defaults to 1, which implies attempt
 814 to reconnect at 1 second intervals.
 815
 816 =back
 817
 818 The following options are accepted within each I<Instance> block:
 819
 820 =over 4
 821
 822 =item B<Format> B<Command>|B<JSON>|B<Graphite>
 823
 824 Selects the format in which messages are sent to the intermediary. If set to
 825 B<Command> (the default), values are sent as C<PUTVAL> commands which are
 826 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
 827 case, the C<Content-Type> header field will be set to C<text/collectd>.
 828
 829 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
 830 an easy and straight forward exchange format. The C<Content-Type> header field
 831 will be set to C<application/json>.
 832
 833 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
 834 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
 835 C<text/graphite>.
 836
 837 A subscribing client I<should> use the C<Content-Type> header field to
 838 determine how to decode the values.
 839
 840 =item B<PreSettle> B<true>|B<false>
 841
 842 If set to B<false> (the default), the plugin will wait for a message
 843 acknowledgement from the messaging bus before sending the next
 844 message. This indicates transfer of ownership to the messaging
 845 system. If set to B<true>, the plugin will not wait for a message
 846 acknowledgement and the message may be dropped prior to transfer of
 847 ownership.
 848
 849 =item B<Notify> B<true>|B<false>
 850
 851 If set to B<false> (the default), the plugin will service the
 852 instance write call back as a value list. If set to B<true> the
 853 plugin will service the instance as a write notification callback
 854 for alert formatting.
 855
 856 =item B<StoreRates> B<true>|B<false>
 857
 858 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
 859 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
 860 default), no conversion is performed. Otherwise the conversion is performed
 861 using the internal value cache.
 862
 863 Please note that currently this option is only used if the B<Format> option has
 864 been set to B<JSON>.
 865
 866 =item B<GraphitePrefix>
 867
 868 A prefix can be added in the metric name when outputting in the I<Graphite> format.
 869 It's added before the I<Host> name.
 870 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 871
 872 =item B<GraphitePostfix>
 873
 874 A postfix can be added in the metric name when outputting in the I<Graphite> format.
 875 It's added after the I<Host> name.
 876 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 877
 878 =item B<GraphiteEscapeChar>
 879
 880 Specify a character to replace dots (.) in the host part of the metric name.
 881 In I<Graphite> metric name, dots are used as separators between different
 882 metric parts (host, plugin, type).
 883 Default is "_" (I<Underscore>).
 884
 885 =item B<GraphiteSeparateInstances> B<true>|B<false>
 886
 887 If set to B<true>, the plugin instance and type instance will be in their own
 888 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
 889 default), the plugin and plugin instance (and likewise the type and type
 890 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
 891
 892 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
 893
 894 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
 895 identifier. If set to B<false> (the default), this is only done when there is
 896 more than one DS.
 897
 898 =item B<GraphitePreserveSeparator> B<false>|B<true>
 899
 900 If set to B<false> (the default) the C<.> (dot) character is replaced with
 901 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
 902 is preserved, i.e. passed through.
 903
 904 =back
 905
 906 =head2 Plugin C<apache>
 907
 908 To configure the C<apache>-plugin you first need to configure the Apache
 909 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
 910 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
 911 the following snipped to base your Apache config upon:
 912
 913   ExtendedStatus on
 914   <IfModule mod_status.c>
 915     <Location /mod_status>
 916       SetHandler server-status
 917     </Location>
 918   </IfModule>
 919
 920 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
 921 also supported. It introduces a new field, called C<BusyServers>, to count the
 922 number of currently connected clients. This field is also supported.
 923
 924 The configuration of the I<Apache> plugin consists of one or more
 925 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
 926 as the instance name. For example:
 927
 928  <Plugin "apache">
 929    <Instance "www1">
 930      URL "http://www1.example.com/mod_status?auto"
 931    </Instance>
 932    <Instance "www2">
 933      URL "http://www2.example.com/mod_status?auto"
 934    </Instance>
 935  </Plugin>
 936
 937 The instance name will be used as the I<plugin instance>. To emulate the old
 938 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
 939 plugin to work correctly, each instance name must be unique. This is not
 940 enforced by the plugin and it is your responsibility to ensure it.
 941
 942 The following options are accepted within each I<Instance> block:
 943
 944 =over 4
 945
 946 =item B<URL> I<http://host/mod_status?auto>
 947
 948 Sets the URL of the C<mod_status> output. This needs to be the output generated
 949 by C<ExtendedStatus on> and it needs to be the machine readable output
 950 generated by appending the C<?auto> argument. This option is I<mandatory>.
 951
 952 =item B<User> I<Username>
 953
 954 Optional user name needed for authentication.
 955
 956 =item B<Password> I<Password>
 957
 958 Optional password needed for authentication.
 959
 960 =item B<VerifyPeer> B<true|false>
 961
 962 Enable or disable peer SSL certificate verification. See
 963 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
 964
 965 =item B<VerifyHost> B<true|false>
 966
 967 Enable or disable peer host name verification. If enabled, the plugin checks
 968 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
 969 certificate matches the host name provided by the B<URL> option. If this
 970 identity check fails, the connection is aborted. Obviously, only works when
 971 connecting to a SSL enabled server. Enabled by default.
 972
 973 =item B<CACert> I<File>
 974
 975 File that holds one or more SSL certificates. If you want to use HTTPS you will
 976 possibly need this option. What CA certificates come bundled with C<libcurl>
 977 and are checked by default depends on the distribution you use.
 978
 979 =item B<SSLCiphers> I<list of ciphers>
 980
 981 Specifies which ciphers to use in the connection. The list of ciphers
 982 must specify valid ciphers. See
 983 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
 984
 985 =item B<Timeout> I<Milliseconds>
 986
 987 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
 988 milliseconds. By default, the configured B<Interval> is used to set the
 989 timeout.
 990
 991 =back
 992
 993 =head2 Plugin C<apcups>
 994
 995 =over 4
 996
 997 =item B<Host> I<Hostname>
 998
 999 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
1000 that IPv6 support has been disabled unless someone can confirm or decline that
1001 B<apcupsd> can handle it.
1002
1003 =item B<Port> I<Port>
1004
1005 TCP-Port to connect to. Defaults to B<3551>.
1006
1007 =item B<ReportSeconds> B<true>|B<false>
1008
1009 If set to B<true>, the time reported in the C<timeleft> metric will be
1010 converted to seconds. This is the recommended setting. If set to B<false>, the
1011 default for backwards compatibility, the time will be reported in minutes.
1012
1013 =item B<PersistentConnection> B<true>|B<false>
1014
1015 The plugin is designed to keep the connection to I<apcupsd> open between reads.
1016 If plugin poll interval is greater than 15 seconds (hardcoded socket close
1017 timeout in I<apcupsd> NIS), then this option is B<false> by default.
1018
1019 You can instruct the plugin to close the connection after each read by setting
1020 this option to B<false> or force keeping the connection by setting it to B<true>.
1021
1022 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
1023 the plugin will try to detect this problem and switch to an open-read-close mode.
1024
1025 =back
1026
1027 =head2 Plugin C<aquaero>
1028
1029 This plugin collects the value of the available sensors in an
1030 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
1031 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
1032 connection for monitoring and configuration. The board can handle multiple
1033 temperature sensors, fans, water pumps and water level sensors and adjust the
1034 output settings such as fan voltage or power used by the water pump based on
1035 the available inputs using a configurable controller included in the board.
1036 This plugin collects all the available inputs as well as some of the output
1037 values chosen by this controller. The plugin is based on the I<libaquaero5>
1038 library provided by I<aquatools-ng>.
1039
1040 =over 4
1041
1042 =item B<Device> I<DevicePath>
1043
1044 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
1045 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
1046 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
1047
1048 =back
1049
1050 =head2 Plugin C<ascent>
1051
1052 This plugin collects information about an Ascent server, a free server for the
1053 "World of Warcraft" game. This plugin gathers the information by fetching the
1054 XML status page using C<libcurl> and parses it using C<libxml2>.
1055
1056 The configuration options are the same as for the C<apache> plugin above:
1057
1058 =over 4
1059
1060 =item B<URL> I<http://localhost/ascent/status/>
1061
1062 Sets the URL of the XML status output.
1063
1064 =item B<User> I<Username>
1065
1066 Optional user name needed for authentication.
1067
1068 =item B<Password> I<Password>
1069
1070 Optional password needed for authentication.
1071
1072 =item B<VerifyPeer> B<true|false>
1073
1074 Enable or disable peer SSL certificate verification. See
1075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1076
1077 =item B<VerifyHost> B<true|false>
1078
1079 Enable or disable peer host name verification. If enabled, the plugin checks
1080 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1081 certificate matches the host name provided by the B<URL> option. If this
1082 identity check fails, the connection is aborted. Obviously, only works when
1083 connecting to a SSL enabled server. Enabled by default.
1084
1085 =item B<CACert> I<File>
1086
1087 File that holds one or more SSL certificates. If you want to use HTTPS you will
1088 possibly need this option. What CA certificates come bundled with C<libcurl>
1089 and are checked by default depends on the distribution you use.
1090
1091 =item B<Timeout> I<Milliseconds>
1092
1093 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1094 milliseconds. By default, the configured B<Interval> is used to set the
1095 timeout.
1096
1097 =back
1098
1099 =head2 Plugin C<barometer>
1100
1101 This plugin reads absolute air pressure using digital barometer sensor on a I2C
1102 bus. Supported sensors are:
1103
1104 =over 5
1105
1106 =item I<MPL115A2> from Freescale,
1107 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
1108
1109
1110 =item I<MPL3115> from Freescale
1111 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
1112
1113
1114 =item I<BMP085> from Bosch Sensortec
1115
1116 =back
1117
1118 The sensor type - one of the above - is detected automatically by the plugin
1119 and indicated in the plugin_instance (you will see subdirectory
1120 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
1121 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
1122 (only one sensor can be used by the plugin).
1123
1124 The plugin provides absolute barometric pressure, air pressure reduced to sea
1125 level (several possible approximations) and as an auxiliary value also internal
1126 sensor temperature. It uses (expects/provides) typical metric units - pressure
1127 in [hPa], temperature in [C], altitude in [m].
1128
1129 It was developed and tested under Linux only. The only platform dependency is
1130 the standard Linux i2c-dev interface (the particular bus driver has to
1131 support the SM Bus command subset).
1132
1133 The reduction or normalization to mean sea level pressure requires (depending
1134 on selected method/approximation) also altitude and reference to temperature
1135 sensor(s).  When multiple temperature sensors are configured the minimum of
1136 their values is always used (expecting that the warmer ones are affected by
1137 e.g. direct sun light at that moment).
1138
1139 Synopsis:
1140
1141   <Plugin "barometer">
1142      Device            "/dev/i2c-0";
1143      Oversampling      512
1144      PressureOffset    0.0
1145      TemperatureOffset 0.0
1146      Normalization     2
1147      Altitude          238.0
1148      TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
1149   </Plugin>
1150
1151 =over 4
1152
1153 =item B<Device> I<device>
1154
1155 The only mandatory configuration parameter.
1156
1157 Device name of the I2C bus to which the sensor is connected. Note that
1158 typically you need to have loaded the i2c-dev module.
1159 Using i2c-tools you can check/list i2c buses available on your system by:
1160
1161   i2cdetect -l
1162
1163 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1164
1165   i2cdetect -y -a 0
1166
1167 This way you should be able to verify that the pressure sensor (either type) is
1168 connected and detected on address 0x60.
1169
1170 =item B<Oversampling> I<value>
1171
1172 Optional parameter controlling the oversampling/accuracy. Default value
1173 is 1 providing fastest and least accurate reading.
1174
1175 For I<MPL115> this is the size of the averaging window. To filter out sensor
1176 noise a simple averaging using floating window of this configurable size is
1177 used. The plugin will use average of the last C<value> measurements (value of 1
1178 means no averaging).  Minimal size is 1, maximal 1024.
1179
1180 For I<MPL3115> this is the oversampling value. The actual oversampling is
1181 performed by the sensor and the higher value the higher accuracy and longer
1182 conversion time (although nothing to worry about in the collectd context).
1183 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1184 adjusted by the plugin to the closest supported one.
1185
1186 For I<BMP085> this is the oversampling value. The actual oversampling is
1187 performed by the sensor and the higher value the higher accuracy and longer
1188 conversion time (although nothing to worry about in the collectd context).
1189 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1190 the closest supported one.
1191
1192 =item B<PressureOffset> I<offset>
1193
1194 Optional parameter for MPL3115 only.
1195
1196 You can further calibrate the sensor by supplying pressure and/or temperature
1197 offsets.  This is added to the measured/caclulated value (i.e. if the measured
1198 value is too high then use negative offset).
1199 In hPa, default is 0.0.
1200
1201 =item B<TemperatureOffset> I<offset>
1202
1203 Optional parameter for MPL3115 only.
1204
1205 You can further calibrate the sensor by supplying pressure and/or temperature
1206 offsets.  This is added to the measured/caclulated value (i.e. if the measured
1207 value is too high then use negative offset).
1208 In C, default is 0.0.
1209
1210 =item B<Normalization> I<method>
1211
1212 Optional parameter, default value is 0.
1213
1214 Normalization method - what approximation/model is used to compute the mean sea
1215 level pressure from the air absolute pressure.
1216
1217 Supported values of the C<method> (integer between from 0 to 2) are:
1218
1219 =over 5
1220
1221 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1222        do not need to configure C<Altitude> or C<TemperatureSensor>.
1223
1224 =item B<1> - international formula for conversion ,
1225 See
1226 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1227 For this method you have to configure C<Altitude> but do not need
1228 C<TemperatureSensor> (uses fixed global temperature average instead).
1229
1230 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1231 Meteorological Service).
1232 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1233 For this method you have to configure both  C<Altitude> and
1234 C<TemperatureSensor>.
1235
1236 =back
1237
1238
1239 =item B<Altitude> I<altitude>
1240
1241 The altitude (in meters) of the location where you meassure the pressure.
1242
1243 =item B<TemperatureSensor> I<reference>
1244
1245 Temperature sensor(s) which should be used as a reference when normalizing the
1246 pressure using C<Normalization> method 2.
1247 When specified more sensors a minimum is found and used each time.  The
1248 temperature reading directly from this pressure sensor/plugin is typically not
1249 suitable as the pressure sensor will be probably inside while we want outside
1250 temperature.  The collectd reference name is something like
1251 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1252 (<type_instance> is usually omitted when there is just single value type). Or
1253 you can figure it out from the path of the output data files.
1254
1255 =back
1256
1257 =head2 Plugin C<battery>
1258
1259 The I<battery plugin> reports the remaining capacity, power and voltage of
1260 laptop batteries.
1261
1262 =over 4
1263
1264 =item B<ValuesPercentage> B<false>|B<true>
1265
1266 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1267 capacity remaining". Otherwise the capacity is stored as reported by the
1268 battery, most likely in "Wh". This option does not work with all input methods,
1269 in particular when only C</proc/pmu> is available on an old Linux system.
1270 Defaults to B<false>.
1271
1272 =item B<ReportDegraded> B<false>|B<true>
1273
1274 Typical laptop batteries degrade over time, meaning the capacity decreases with
1275 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1276 "last full capacity" and used to determine that a battery is "fully charged".
1277
1278 When this option is set to B<false>, the default, the I<battery plugin> will
1279 only report the remaining capacity. If the B<ValuesPercentage> option is
1280 enabled, the relative remaining capacity is calculated as the ratio of the
1281 "remaining capacity" and the "last full capacity". This is what most tools,
1282 such as the status bar of desktop environments, also do.
1283
1284 When set to B<true>, the battery plugin will report three values: B<charged>
1285 (remaining capacity), B<discharged> (difference between "last full capacity"
1286 and "remaining capacity") and B<degraded> (difference between "design capacity"
1287 and "last full capacity").
1288
1289 =item B<QueryStateFS> B<false>|B<true>
1290
1291 When set to B<true>, the battery plugin will only read statistics
1292 related to battery performance as exposed by StateFS at
1293 /run/state. StateFS is used in Mer-based Sailfish OS, for
1294 example.
1295
1296 =back
1297
1298 =head2 Plugin C<bind>
1299
1300 Starting with BIND 9.5.0, the most widely used DNS server software provides
1301 extensive statistics about queries, responses and lots of other information.
1302 The bind plugin retrieves this information that's encoded in XML and provided
1303 via HTTP and submits the values to collectd.
1304
1305 To use this plugin, you first need to tell BIND to make this information
1306 available. This is done with the C<statistics-channels> configuration option:
1307
1308  statistics-channels {
1309    inet localhost port 8053;
1310  };
1311
1312 The configuration follows the grouping that can be seen when looking at the
1313 data with an XSLT compatible viewer, such as a modern web browser. It's
1314 probably a good idea to make yourself familiar with the provided values, so you
1315 can understand what the collected statistics actually mean.
1316
1317 Synopsis:
1318
1319  <Plugin "bind">
1320    URL "http://localhost:8053/"
1321    ParseTime       false
1322    OpCodes         true
1323    QTypes          true
1324
1325    ServerStats     true
1326    ZoneMaintStats  true
1327    ResolverStats   false
1328    MemoryStats     true
1329
1330    <View "_default">
1331      QTypes        true
1332      ResolverStats true
1333      CacheRRSets   true
1334
1335      Zone "127.in-addr.arpa/IN"
1336    </View>
1337  </Plugin>
1338
1339 The bind plugin accepts the following configuration options:
1340
1341 =over 4
1342
1343 =item B<URL> I<URL>
1344
1345 URL from which to retrieve the XML data. If not specified,
1346 C<http://localhost:8053/> will be used.
1347
1348 =item B<ParseTime> B<true>|B<false>
1349
1350 When set to B<true>, the time provided by BIND will be parsed and used to
1351 dispatch the values. When set to B<false>, the local time source is queried.
1352
1353 This setting is set to B<true> by default for backwards compatibility; setting
1354 this to B<false> is I<recommended> to avoid problems with timezones and
1355 localization.
1356
1357 =item B<OpCodes> B<true>|B<false>
1358
1359 When enabled, statistics about the I<"OpCodes">, for example the number of
1360 C<QUERY> packets, are collected.
1361
1362 Default: Enabled.
1363
1364 =item B<QTypes> B<true>|B<false>
1365
1366 When enabled, the number of I<incoming> queries by query types (for example
1367 C<A>, C<MX>, C<AAAA>) is collected.
1368
1369 Default: Enabled.
1370
1371 =item B<ServerStats> B<true>|B<false>
1372
1373 Collect global server statistics, such as requests received over IPv4 and IPv6,
1374 successful queries, and failed updates.
1375
1376 Default: Enabled.
1377
1378 =item B<ZoneMaintStats> B<true>|B<false>
1379
1380 Collect zone maintenance statistics, mostly information about notifications
1381 (zone updates) and zone transfers.
1382
1383 Default: Enabled.
1384
1385 =item B<ResolverStats> B<true>|B<false>
1386
1387 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1388 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1389 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1390 default. Use the B<ResolverStats> option within a B<View "_default"> block
1391 instead for the same functionality.
1392
1393 Default: Disabled.
1394
1395 =item B<MemoryStats>
1396
1397 Collect global memory statistics.
1398
1399 Default: Enabled.
1400
1401 =item B<Timeout> I<Milliseconds>
1402
1403 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1404 milliseconds. By default, the configured B<Interval> is used to set the
1405 timeout.
1406
1407 =item B<View> I<Name>
1408
1409 Collect statistics about a specific I<"view">. BIND can behave different,
1410 mostly depending on the source IP-address of the request. These different
1411 configurations are called "views". If you don't use this feature, you most
1412 likely are only interested in the C<_default> view.
1413
1414 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1415 information you want to collect about a view. If no B<View> block is
1416 configured, no detailed view statistics will be collected.
1417
1418 =over 4
1419
1420 =item B<QTypes> B<true>|B<false>
1421
1422 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1423 C<MX>) is collected.
1424
1425 Default: Enabled.
1426
1427 =item B<ResolverStats> B<true>|B<false>
1428
1429 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1430 (e.E<nbsp>g. queries over IPv4, lame servers).
1431
1432 Default: Enabled.
1433
1434 =item B<CacheRRSets> B<true>|B<false>
1435
1436 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1437 type is collected. Negative entries (queries which resulted in an error, for
1438 example names that do not exist) are reported with a leading exclamation mark,
1439 e.E<nbsp>g. "!A".
1440
1441 Default: Enabled.
1442
1443 =item B<Zone> I<Name>
1444
1445 When given, collect detailed information about the given zone in the view. The
1446 information collected if very similar to the global B<ServerStats> information
1447 (see above).
1448
1449 You can repeat this option to collect detailed information about multiple
1450 zones.
1451
1452 By default no detailed zone information is collected.
1453
1454 =back
1455
1456 =back
1457
1458 =head2 Plugin C<ceph>
1459
1460 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1461 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1462
1463 A separate B<Daemon> block must be configured for each ceph daemon to be
1464 monitored. The following example will read daemon statistics from four
1465 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1466
1467   <Plugin ceph>
1468     LongRunAvgLatency false
1469     ConvertSpecialMetricTypes true
1470     <Daemon "osd.0">
1471       SocketPath "/var/run/ceph/ceph-osd.0.asok"
1472     </Daemon>
1473     <Daemon "osd.1">
1474       SocketPath "/var/run/ceph/ceph-osd.1.asok"
1475     </Daemon>
1476     <Daemon "mon.a">
1477       SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1478     </Daemon>
1479     <Daemon "mds.a">
1480       SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1481     </Daemon>
1482   </Plugin>
1483
1484 The ceph plugin accepts the following configuration options:
1485
1486 =over 4
1487
1488 =item B<LongRunAvgLatency> B<true>|B<false>
1489
1490 If enabled, latency values(sum,count pairs) are calculated as the long run
1491 average - average since the ceph daemon was started = (sum / count).
1492 When disabled, latency values are calculated as the average since the last
1493 collection = (sum_now - sum_last) / (count_now - count_last).
1494
1495 Default: Disabled
1496
1497 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1498
1499 If enabled, special metrics (metrics that differ in type from similar counters)
1500 are converted to the type of those similar counters. This currently only
1501 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1502 ceph schema reports this metric type as a sum,count pair while similar counters
1503 are treated as derive types. When converted, the sum is used as the counter
1504 value and is treated as a derive type.
1505 When disabled, all metrics are treated as the types received from the ceph schema.
1506
1507 Default: Enabled
1508
1509 =back
1510
1511 Each B<Daemon> block must have a string argument for the plugin instance name.
1512 A B<SocketPath> is also required for each B<Daemon> block:
1513
1514 =over 4
1515
1516 =item B<Daemon> I<DaemonName>
1517
1518 Name to be used as the instance name for this daemon.
1519
1520 =item B<SocketPath> I<SocketPath>
1521
1522 Specifies the path to the UNIX admin socket of the ceph daemon.
1523
1524 =back
1525
1526 =head2 Plugin C<cgroups>
1527
1528 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1529 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1530 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1531
1532 =over 4
1533
1534 =item B<CGroup> I<Directory>
1535
1536 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1537 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1538 see below.
1539
1540 See F</"IGNORELISTS"> for details.
1541
1542 =item B<IgnoreSelected> B<true>|B<false>
1543
1544 Invert the selection: If set to true, all cgroups I<except> the ones that
1545 match any one of the criteria are collected. By default only selected
1546 cgroups are collected if a selection is made. If no selection is configured
1547 at all, B<all> cgroups are selected.
1548
1549 =back
1550
1551 =head2 Plugin C<chrony>
1552
1553 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1554 skew and per-peer stratum.
1555
1556 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1557 on the wire.
1558
1559 Available configuration options for the C<chrony> plugin:
1560
1561 =over 4
1562
1563 =item B<Host> I<Hostname>
1564
1565 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1566
1567 =item B<Port> I<Port>
1568
1569 UDP-Port to connect to. Defaults to B<323>.
1570
1571 =item B<Timeout> I<Timeout>
1572
1573 Connection timeout in seconds. Defaults to B<2>.
1574
1575 =back
1576
1577 =head2 Plugin C<conntrack>
1578
1579 This plugin collects IP conntrack statistics.
1580
1581 =over 4
1582
1583 =item B<OldFiles>
1584
1585 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1586 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1587
1588 =back
1589
1590 =head2 Plugin C<cpu>
1591
1592 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1593 as Jiffies, using the C<cpu> type. Two aggregations are available:
1594
1595 =over 4
1596
1597 =item *
1598
1599 Sum, per-state, over all CPUs installed in the system; and
1600
1601 =item *
1602
1603 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1604
1605 =back
1606
1607 The two aggregations can be combined, leading to I<collectd> only emitting a
1608 single "active" metric for the entire system. As soon as one of these
1609 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1610 rather than Jiffies. In addition, you can request individual, per-state,
1611 per-CPU metrics to be reported as percentage.
1612
1613 The following configuration options are available:
1614
1615 =over 4
1616
1617 =item B<ReportByState> B<true>|B<false>
1618
1619 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1620 "user" and "idle".
1621 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1622 "active" metric.
1623
1624 =item B<ReportByCpu> B<true>|B<false>
1625
1626 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1627 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1628 global sum of CPU states is emitted.
1629
1630 =item B<ValuesPercentage> B<false>|B<true>
1631
1632 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1633 are set to B<true>. In this case, by default, metrics will be reported as
1634 Jiffies. By setting this option to B<true>, you can request percentage values
1635 in the un-aggregated (per-CPU, per-state) mode as well.
1636
1637 =item B<ReportNumCpu> B<false>|B<true>
1638
1639 When set to B<true>, reports the number of available CPUs.
1640 Defaults to B<false>.
1641
1642 =item B<ReportGuestState> B<false>|B<true>
1643
1644 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1645 Defaults to B<false>.
1646
1647 =item B<SubtractGuestState> B<false>|B<true>
1648
1649 This option is only considered when B<ReportGuestState> is set to B<true>.
1650 "guest" and "guest_nice" are included in respectively "user" and "nice".
1651 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1652 will be subtracted from "nice".
1653 Defaults to B<true>.
1654
1655 =back
1656
1657 =head2 Plugin C<cpufreq>
1658
1659 This plugin doesn't have any options. It reads
1660 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1661 installed) to get the current CPU frequency. If this file does not exist make
1662 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1663 installed and an "cpu governor" (that's a kernel module) is loaded.
1664
1665 =head2 Plugin C<cpusleep>
1666
1667 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1668 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1669 BOOTTIME clock increments while device is suspended and MONOTONIC
1670 clock does not, the derivative of the difference between these clocks
1671 gives the relative amount of time the device has spent in suspend
1672 state. The recorded value is in milliseconds of sleep per seconds of
1673 wall clock.
1674
1675 =head2 Plugin C<csv>
1676
1677 =over 4
1678
1679 =item B<DataDir> I<Directory>
1680
1681 Set the directory to store CSV-files under. Per default CSV-files are generated
1682 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1683 The special strings B<stdout> and B<stderr> can be used to write to the standard
1684 output and standard error channels, respectively. This, of course, only makes
1685 much sense when collectd is running in foreground- or non-daemon-mode.
1686
1687 =item B<StoreRates> B<true|false>
1688
1689 If set to B<true>, convert counter values to rates. If set to B<false> (the
1690 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1691 number.
1692
1693 =back
1694
1695 =head2 cURL Statistics
1696
1697 All cURL-based plugins support collection of generic, request-based
1698 statistics. These are disabled by default and can be enabled selectively for
1699 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1700 the documentation of those plugins for specific information. This section
1701 describes the available metrics that can be configured for each plugin. All
1702 options are disabled by default.
1703
1704 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1705
1706 =over 4
1707
1708 =item B<TotalTime> B<true|false>
1709
1710 Total time of the transfer, including name resolving, TCP connect, etc.
1711
1712 =item B<NamelookupTime> B<true|false>
1713
1714 Time it took from the start until name resolving was completed.
1715
1716 =item B<ConnectTime> B<true|false>
1717
1718 Time it took from the start until the connect to the remote host (or proxy)
1719 was completed.
1720
1721 =item B<AppconnectTime> B<true|false>
1722
1723 Time it took from the start until the SSL/SSH connect/handshake to the remote
1724 host was completed.
1725
1726 =item B<PretransferTime> B<true|false>
1727
1728 Time it took from the start until just before the transfer begins.
1729
1730 =item B<StarttransferTime> B<true|false>
1731
1732 Time it took from the start until the first byte was received.
1733
1734 =item B<RedirectTime> B<true|false>
1735
1736 Time it took for all redirection steps include name lookup, connect,
1737 pre-transfer and transfer before final transaction was started.
1738
1739 =item B<RedirectCount> B<true|false>
1740
1741 The total number of redirections that were actually followed.
1742
1743 =item B<SizeUpload> B<true|false>
1744
1745 The total amount of bytes that were uploaded.
1746
1747 =item B<SizeDownload> B<true|false>
1748
1749 The total amount of bytes that were downloaded.
1750
1751 =item B<SpeedDownload> B<true|false>
1752
1753 The average download speed that curl measured for the complete download.
1754
1755 =item B<SpeedUpload> B<true|false>
1756
1757 The average upload speed that curl measured for the complete upload.
1758
1759 =item B<HeaderSize> B<true|false>
1760
1761 The total size of all the headers received.
1762
1763 =item B<RequestSize> B<true|false>
1764
1765 The total size of the issued requests.
1766
1767 =item B<ContentLengthDownload> B<true|false>
1768
1769 The content-length of the download.
1770
1771 =item B<ContentLengthUpload> B<true|false>
1772
1773 The specified size of the upload.
1774
1775 =item B<NumConnects> B<true|false>
1776
1777 The number of new connections that were created to achieve the transfer.
1778
1779 =back
1780
1781 =head2 Plugin C<curl>
1782
1783 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1784 and the match infrastructure (the same code used by the tail plugin) to use
1785 regular expressions with the received data.
1786
1787 The following example will read the current value of AMD stock from Google's
1788 finance page and dispatch the value to collectd.
1789
1790   <Plugin curl>
1791     <Page "stock_quotes">
1792       Plugin "quotes"
1793       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1794       User "foo"
1795       Password "bar"
1796       Digest false
1797       VerifyPeer true
1798       VerifyHost true
1799       CACert "/path/to/ca.crt"
1800       Header "X-Custom-Header: foobar"
1801       Post "foo=bar"
1802
1803       MeasureResponseTime false
1804       MeasureResponseCode false
1805
1806       <Match>
1807         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1808         DSType "GaugeAverage"
1809         # Note: `stock_value' is not a standard type.
1810         Type "stock_value"
1811         Instance "AMD"
1812       </Match>
1813     </Page>
1814   </Plugin>
1815
1816 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1817 a web page and one or more "matches" to be performed on the returned data. The
1818 string argument to the B<Page> block is used as plugin instance.
1819
1820 The following options are valid within B<Page> blocks:
1821
1822 =over 4
1823
1824 =item B<Plugin> I<Plugin>
1825
1826 Use I<Plugin> as the plugin name when submitting values.
1827 Defaults to C<curl>.
1828
1829 =item B<URL> I<URL>
1830
1831 URL of the web site to retrieve. Since a regular expression will be used to
1832 extract information from this data, non-binary data is a big plus here ;)
1833
1834 =item B<User> I<Name>
1835
1836 Username to use if authorization is required to read the page.
1837
1838 =item B<Password> I<Password>
1839
1840 Password to use if authorization is required to read the page.
1841
1842 =item B<Digest> B<true>|B<false>
1843
1844 Enable HTTP digest authentication.
1845
1846 =item B<VerifyPeer> B<true>|B<false>
1847
1848 Enable or disable peer SSL certificate verification. See
1849 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1850
1851 =item B<VerifyHost> B<true>|B<false>
1852
1853 Enable or disable peer host name verification. If enabled, the plugin checks if
1854 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1855 matches the host name provided by the B<URL> option. If this identity check
1856 fails, the connection is aborted. Obviously, only works when connecting to a
1857 SSL enabled server. Enabled by default.
1858
1859 =item B<CACert> I<file>
1860
1861 File that holds one or more SSL certificates. If you want to use HTTPS you will
1862 possibly need this option. What CA certificates come bundled with C<libcurl>
1863 and are checked by default depends on the distribution you use.
1864
1865 =item B<Header> I<Header>
1866
1867 A HTTP header to add to the request. Multiple headers are added if this option
1868 is specified more than once.
1869
1870 =item B<Post> I<Body>
1871
1872 Specifies that the HTTP operation should be a POST instead of a GET. The
1873 complete data to be posted is given as the argument.  This option will usually
1874 need to be accompanied by a B<Header> option to set an appropriate
1875 C<Content-Type> for the post body (e.g. to
1876 C<application/x-www-form-urlencoded>).
1877
1878 =item B<MeasureResponseTime> B<true>|B<false>
1879
1880 Measure response time for the request. If this setting is enabled, B<Match>
1881 blocks (see below) are optional. Disabled by default.
1882
1883 Beware that requests will get aborted if they take too long to complete. Adjust
1884 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1885 requests.
1886
1887 This option is similar to enabling the B<TotalTime> statistic but it's
1888 measured by collectd instead of cURL.
1889
1890 =item B<MeasureResponseCode> B<true>|B<false>
1891
1892 Measure response code for the request. If this setting is enabled, B<Match>
1893 blocks (see below) are optional. Disabled by default.
1894
1895 =item B<E<lt>StatisticsE<gt>>
1896
1897 One B<Statistics> block can be used to specify cURL statistics to be collected
1898 for each request to the remote web site. See the section "cURL Statistics"
1899 above for details. If this setting is enabled, B<Match> blocks (see below) are
1900 optional.
1901
1902 =item B<E<lt>MatchE<gt>>
1903
1904 One or more B<Match> blocks that define how to match information in the data
1905 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1906 used by the C<tail> plugin, so please see the documentation of the C<tail>
1907 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1908 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1909 optional.
1910
1911 =item B<Timeout> I<Milliseconds>
1912
1913 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1914 milliseconds. By default, the configured B<Interval> is used to set the
1915 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1916 indefinitely. This legacy behaviour can be achieved by setting the value of
1917 B<Timeout> to 0.
1918
1919 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1920 network connection will stall one read thread. Adjust the B<ReadThreads> global
1921 setting accordingly to prevent this from blocking other plugins.
1922
1923 =back
1924
1925 =head2 Plugin C<curl_json>
1926
1927 The B<curl_json plugin> collects values from JSON data to be parsed by
1928 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1929 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1930 unix socket. The former can be used, for example, to collect values
1931 from CouchDB documents (which are stored JSON notation), and the
1932 latter to collect values from a uWSGI stats socket.
1933
1934 The following example will collect several values from the built-in
1935 C<_stats> runtime statistics module of I<CouchDB>
1936 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1937
1938   <Plugin curl_json>
1939     <URL "http://localhost:5984/_stats">
1940       Instance "httpd"
1941       <Key "httpd/requests/count">
1942         Type "http_requests"
1943       </Key>
1944
1945       <Key "httpd_request_methods/*/count">
1946         Type "http_request_methods"
1947       </Key>
1948
1949       <Key "httpd_status_codes/*/count">
1950         Type "http_response_codes"
1951       </Key>
1952     </URL>
1953   </Plugin>
1954
1955 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1956
1957   <Plugin curl_json>
1958     <Sock "/var/run/uwsgi.stats.sock">
1959       Instance "uwsgi"
1960       <Key "workers/*/requests">
1961         Type "http_requests"
1962       </Key>
1963
1964       <Key "workers/*/apps/*/requests">
1965         Type "http_requests"
1966       </Key>
1967     </Sock>
1968   </Plugin>
1969
1970 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1971 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1972 blocks defining a unix socket to read JSON from directly.  Each of
1973 these blocks may have one or more B<Key> blocks.
1974
1975 The B<Key> string argument must be in a path format. Each component is
1976 used to match the key from a JSON map or the index of an JSON
1977 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1978 values for all map keys or array indices will be collectd.
1979
1980 The following options are valid within B<URL> blocks:
1981
1982 =over 4
1983
1984 =item B<Host> I<Name>
1985
1986 Use I<Name> as the host name when submitting values. Defaults to the global
1987 host name setting.
1988
1989 =item B<Plugin> I<Plugin>
1990
1991 Use I<Plugin> as the plugin name when submitting values.
1992 Defaults to C<curl_json>.
1993
1994 =item B<Instance> I<Instance>
1995
1996 Sets the plugin instance to I<Instance>.
1997
1998 =item B<Interval> I<Interval>
1999
2000 Sets the interval (in seconds) in which the values will be collected from this
2001 URL. By default the global B<Interval> setting will be used.
2002
2003 =item B<User> I<Name>
2004
2005 =item B<Password> I<Password>
2006
2007 =item B<Digest> B<true>|B<false>
2008
2009 =item B<VerifyPeer> B<true>|B<false>
2010
2011 =item B<VerifyHost> B<true>|B<false>
2012
2013 =item B<CACert> I<file>
2014
2015 =item B<Header> I<Header>
2016
2017 =item B<Post> I<Body>
2018
2019 =item B<Timeout> I<Milliseconds>
2020
2021 These options behave exactly equivalent to the appropriate options of the
2022 I<cURL> plugin. Please see there for a detailed description.
2023
2024 =item B<E<lt>StatisticsE<gt>>
2025
2026 One B<Statistics> block can be used to specify cURL statistics to be collected
2027 for each request to the remote URL. See the section "cURL Statistics" above
2028 for details.
2029
2030 =back
2031
2032 The following options are valid within B<Key> blocks:
2033
2034 =over 4
2035
2036 =item B<Type> I<Type>
2037
2038 Sets the type used to dispatch the values to the daemon. Detailed information
2039 about types and their configuration can be found in L<types.db(5)>. This
2040 option is mandatory.
2041
2042 =item B<Instance> I<Instance>
2043
2044 Type-instance to use. Defaults to the current map key or current string array element value.
2045
2046 =back
2047
2048 =head2 Plugin C<curl_xml>
2049
2050 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2051 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2052
2053  <Plugin "curl_xml">
2054    <URL "http://localhost/stats.xml">
2055      Host "my_host"
2056      #Plugin "curl_xml"
2057      Instance "some_instance"
2058      User "collectd"
2059      Password "thaiNg0I"
2060      VerifyPeer true
2061      VerifyHost true
2062      CACert "/path/to/ca.crt"
2063      Header "X-Custom-Header: foobar"
2064      Post "foo=bar"
2065
2066      <XPath "table[@id=\"magic_level\"]/tr">
2067        Type "magic_level"
2068        #InstancePrefix "prefix-"
2069        InstanceFrom "td[1]"
2070        #PluginInstanceFrom "td[1]"
2071        ValuesFrom "td[2]/span[@class=\"level\"]"
2072      </XPath>
2073    </URL>
2074  </Plugin>
2075
2076 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2077 URL to be fetched using libcurl. Within each B<URL> block there are
2078 options which specify the connection parameters, for example authentication
2079 information, and one or more B<XPath> blocks.
2080
2081 Each B<XPath> block specifies how to get one type of information. The
2082 string argument must be a valid XPath expression which returns a list
2083 of "base elements". One value is dispatched for each "base element". The
2084 I<type instance> and values are looked up using further I<XPath> expressions
2085 that should be relative to the base element.
2086
2087 Within the B<URL> block the following options are accepted:
2088
2089 =over 4
2090
2091 =item B<Host> I<Name>
2092
2093 Use I<Name> as the host name when submitting values. Defaults to the global
2094 host name setting.
2095
2096 =item B<Plugin> I<Plugin>
2097
2098 Use I<Plugin> as the plugin name when submitting values.
2099 Defaults to 'curl_xml'.
2100
2101 =item B<Instance> I<Instance>
2102
2103 Use I<Instance> as the plugin instance when submitting values.
2104 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2105 Defaults to an empty string (no plugin instance).
2106
2107 =item B<Namespace> I<Prefix> I<URL>
2108
2109 If an XPath expression references namespaces, they must be specified
2110 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2111 I<URL> is the "namespace name", an URI reference uniquely identifying the
2112 namespace. The option can be repeated to register multiple namespaces.
2113
2114 Examples:
2115
2116   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2117   Namespace "m" "http://www.w3.org/1998/Math/MathML"
2118
2119 =item B<User> I<User>
2120
2121 =item B<Password> I<Password>
2122
2123 =item B<Digest> B<true>|B<false>
2124
2125 =item B<VerifyPeer> B<true>|B<false>
2126
2127 =item B<VerifyHost> B<true>|B<false>
2128
2129 =item B<CACert> I<CA Cert File>
2130
2131 =item B<Header> I<Header>
2132
2133 =item B<Post> I<Body>
2134
2135 =item B<Timeout> I<Milliseconds>
2136
2137 These options behave exactly equivalent to the appropriate options of the
2138 I<cURL plugin>. Please see there for a detailed description.
2139
2140 =item B<E<lt>StatisticsE<gt>>
2141
2142 One B<Statistics> block can be used to specify cURL statistics to be collected
2143 for each request to the remote URL. See the section "cURL Statistics" above
2144 for details.
2145
2146 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2147
2148 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2149 B<XPath> block specifies how to get one type of information. The string
2150 argument must be a valid XPath expression which returns a list of "base
2151 elements". One value is dispatched for each "base element".
2152
2153 Within the B<XPath> block the following options are accepted:
2154
2155 =over 4
2156
2157 =item B<Type> I<Type>
2158
2159 Specifies the I<Type> used for submitting patches. This determines the number
2160 of values that are required / expected and whether the strings are parsed as
2161 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2162 This option is required.
2163
2164 =item B<InstancePrefix> I<InstancePrefix>
2165
2166 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2167 concatenated together without any separator.
2168 This option is optional.
2169
2170 =item B<InstanceFrom> I<InstanceFrom>
2171
2172 Specifies a XPath expression to use for determining the I<type instance>. The
2173 XPath expression must return exactly one element. The element's value is then
2174 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2175
2176 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2177
2178 Specifies a XPath expression to use for determining the I<plugin instance>. The
2179 XPath expression must return exactly one element. The element's value is then
2180 used as I<plugin instance>.
2181
2182 =back
2183
2184 If the "base XPath expression" (the argument to the B<XPath> block) returns
2185 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2186 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2187
2188 =over 4
2189
2190 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2191
2192 Specifies one or more XPath expression to use for reading the values. The
2193 number of XPath expressions must match the number of data sources in the
2194 I<type> specified with B<Type> (see above). Each XPath expression must return
2195 exactly one element. The element's value is then parsed as a number and used as
2196 value for the appropriate value in the value list dispatched to the daemon.
2197 This option is required.
2198
2199 =back
2200
2201 =back
2202
2203 =head2 Plugin C<dbi>
2204
2205 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2206 connect to various databases, execute I<SQL> statements and read back the
2207 results. I<dbi> is an acronym for "database interface" in case you were
2208 wondering about the name. You can configure how each column is to be
2209 interpreted and the plugin will generate one or more data sets from each row
2210 returned according to these rules.
2211
2212 Because the plugin is very generic, the configuration is a little more complex
2213 than those of other plugins. It usually looks something like this:
2214
2215   <Plugin dbi>
2216     <Query "out_of_stock">
2217       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2218       # Use with MySQL 5.0.0 or later
2219       MinVersion 50000
2220       <Result>
2221         Type "gauge"
2222         InstancePrefix "out_of_stock"
2223         InstancesFrom "category"
2224         ValuesFrom "value"
2225       </Result>
2226     </Query>
2227     <Database "product_information">
2228       #Plugin "warehouse"
2229       Driver "mysql"
2230       Interval 120
2231       DriverOption "host" "localhost"
2232       DriverOption "username" "collectd"
2233       DriverOption "password" "aZo6daiw"
2234       DriverOption "dbname" "prod_info"
2235       SelectDB "prod_info"
2236       Query "out_of_stock"
2237     </Database>
2238   </Plugin>
2239
2240 The configuration above defines one query with one result and one database. The
2241 query is then linked to the database with the B<Query> option I<within> the
2242 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2243 and you can also use the B<Include> statement to split up the configuration
2244 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2245 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2246 top to bottom!
2247
2248 The following is a complete list of options:
2249
2250 =head3 B<Query> blocks
2251
2252 Query blocks define I<SQL> statements and how the returned data should be
2253 interpreted. They are identified by the name that is given in the opening line
2254 of the block. Thus the name needs to be unique. Other than that, the name is
2255 not used in collectd.
2256
2257 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2258 define which column holds which value or instance information. You can use
2259 multiple B<Result> blocks to create multiple values from one returned row. This
2260 is especially useful, when queries take a long time and sending almost the same
2261 query again and again is not desirable.
2262
2263 Example:
2264
2265   <Query "environment">
2266     Statement "select station, temperature, humidity from environment"
2267     <Result>
2268       Type "temperature"
2269       # InstancePrefix "foo"
2270       InstancesFrom "station"
2271       ValuesFrom "temperature"
2272     </Result>
2273     <Result>
2274       Type "humidity"
2275       InstancesFrom "station"
2276       ValuesFrom "humidity"
2277     </Result>
2278   </Query>
2279
2280 The following options are accepted:
2281
2282 =over 4
2283
2284 =item B<Statement> I<SQL>
2285
2286 Sets the statement that should be executed on the server. This is B<not>
2287 interpreted by collectd, but simply passed to the database server. Therefore,
2288 the SQL dialect that's used depends on the server collectd is connected to.
2289
2290 The query has to return at least two columns, one for the instance and one
2291 value. You cannot omit the instance, even if the statement is guaranteed to
2292 always return exactly one line. In that case, you can usually specify something
2293 like this:
2294
2295   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2296
2297 (That works with MySQL but may not be valid SQL according to the spec. If you
2298 use a more strict database server, you may have to select from a dummy table or
2299 something.)
2300
2301 Please note that some databases, for example B<Oracle>, will fail if you
2302 include a semicolon at the end of the statement.
2303
2304 =item B<MinVersion> I<Version>
2305
2306 =item B<MaxVersion> I<Value>
2307
2308 Only use this query for the specified database version. You can use these
2309 options to provide multiple queries with the same name but with a slightly
2310 different syntax. The plugin will use only those queries, where the specified
2311 minimum and maximum versions fit the version of the database in use.
2312
2313 The database version is determined by C<dbi_conn_get_engine_version>, see the
2314 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2315 for details. Basically, each part of the version is assumed to be in the range
2316 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2317 "40102", version "5.0.42" becomes "50042".
2318
2319 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2320 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2321 happen. Don't to it! A valid example would be something along these lines:
2322
2323   MinVersion 40000
2324   MaxVersion 49999
2325   ...
2326   MinVersion 50000
2327   MaxVersion 50099
2328   ...
2329   MinVersion 50100
2330   # No maximum
2331
2332 In the above example, there are three ranges that don't overlap. The last one
2333 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2334 before "4.0.0" are not specified.
2335
2336 =item B<Type> I<Type>
2337
2338 The B<type> that's used for each line returned. See L<types.db(5)> for more
2339 details on how types are defined. In short: A type is a predefined layout of
2340 data and the number of values and type of values has to match the type
2341 definition.
2342
2343 If you specify "temperature" here, you need exactly one gauge column. If you
2344 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2345 setting below.
2346
2347 There must be exactly one B<Type> option inside each B<Result> block.
2348
2349 =item B<InstancePrefix> I<prefix>
2350
2351 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2352 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2353 all strings returned in the appropriate columns are concatenated together,
2354 separated by dashes I<("-")>.
2355
2356 =item B<InstancesFrom> I<column0> [I<column1> ...]
2357
2358 Specifies the columns whose values will be used to create the "type-instance"
2359 for each row. If you specify more than one column, the value of all columns
2360 will be joined together with dashes I<("-")> as separation characters.
2361
2362 The plugin itself does not check whether or not all built instances are
2363 different. It's your responsibility to assure that each is unique. This is
2364 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2365 sure that only one row is returned in this case.
2366
2367 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2368 will be empty.
2369
2370 =item B<ValuesFrom> I<column0> [I<column1> ...]
2371
2372 Names the columns whose content is used as the actual data for the data sets
2373 that are dispatched to the daemon. How many such columns you need is determined
2374 by the B<Type> setting above. If you specify too many or not enough columns,
2375 the plugin will complain about that and no data will be submitted to the
2376 daemon.
2377
2378 The actual data type in the columns is not that important. The plugin will
2379 automatically cast the values to the right type if it know how to do that. So
2380 it should be able to handle integer an floating point types, as well as strings
2381 (if they include a number at the beginning).
2382
2383 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2384
2385 =item B<MetadataFrom> [I<column0> I<column1> ...]
2386
2387 Names the columns whose content is used as metadata for the data sets
2388 that are dispatched to the daemon.
2389
2390 The actual data type in the columns is not that important. The plugin will
2391 automatically cast the values to the right type if it know how to do that. So
2392 it should be able to handle integer an floating point types, as well as strings
2393 (if they include a number at the beginning).
2394
2395 =back
2396
2397 =head3 B<Database> blocks
2398
2399 Database blocks define a connection to a database and which queries should be
2400 sent to that database. Since the used "dbi" library can handle a wide variety
2401 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2402 documentationE<nbsp>- we stick as close to the terminology used there.
2403
2404 Each database needs a "name" as string argument in the starting tag of the
2405 block. This name will be used as "PluginInstance" in the values submitted to
2406 the daemon. Other than that, that name is not used.
2407
2408 =over 4
2409
2410 =item B<Plugin> I<Plugin>
2411
2412 Use I<Plugin> as the plugin name when submitting query results from
2413 this B<Database>. Defaults to C<dbi>.
2414
2415 =item B<Interval> I<Interval>
2416
2417 Sets the interval (in seconds) in which the values will be collected from this
2418 database. By default the global B<Interval> setting will be used.
2419
2420 =item B<Driver> I<Driver>
2421
2422 Specifies the driver to use to connect to the database. In many cases those
2423 drivers are named after the database they can connect to, but this is not a
2424 technical necessity. These drivers are sometimes referred to as "DBD",
2425 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2426 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2427 project at L<http://libdbi-drivers.sourceforge.net/>.
2428
2429 You need to give the driver name as expected by the "dbi" library here. You
2430 should be able to find that in the documentation for each driver. If you
2431 mistype the driver name, the plugin will dump a list of all known driver names
2432 to the log.
2433
2434 =item B<DriverOption> I<Key> I<Value>
2435
2436 Sets driver-specific options. What option a driver supports can be found in the
2437 documentation for each driver, somewhere at
2438 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2439 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2440
2441 DBDs can register two types of options: String options and numeric options. The
2442 plugin will use the C<dbi_conn_set_option> function when the configuration
2443 provides a string and the C<dbi_conn_require_option_numeric> function when the
2444 configuration provides a number. So these two lines will actually result in
2445 different calls being used:
2446
2447   DriverOption "Port" 1234      # numeric
2448   DriverOption "Port" "1234"    # string
2449
2450 Unfortunately, drivers are not too keen to report errors when an unknown option
2451 is passed to them, so invalid settings here may go unnoticed. This is not the
2452 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2453 the driver. If a driver complains about an option, the plugin will dump a
2454 complete list of all options understood by that driver to the log. There is no
2455 way to programmatically find out if an option expects a string or a numeric
2456 argument, so you will have to refer to the appropriate DBD's documentation to
2457 find this out. Sorry.
2458
2459 =item B<SelectDB> I<Database>
2460
2461 In some cases, the database name you connect with is not the database name you
2462 want to use for querying data. If this option is set, the plugin will "select"
2463 (switch to) that database after the connection is established.
2464
2465 =item B<Query> I<QueryName>
2466
2467 Associates the query named I<QueryName> with this database connection. The
2468 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2469 blocks you want to refer to must be placed above the database block you want to
2470 refer to them from.
2471
2472 =item B<Host> I<Hostname>
2473
2474 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2475 values. Defaults to the global hostname setting.
2476
2477 =back
2478
2479 =head2 Plugin C<df>
2480
2481 =over 4
2482
2483 =item B<Device> I<Device>
2484
2485 Select partitions based on the devicename.
2486
2487 See F</"IGNORELISTS"> for details.
2488
2489 =item B<MountPoint> I<Directory>
2490
2491 Select partitions based on the mountpoint.
2492
2493 See F</"IGNORELISTS"> for details.
2494
2495 =item B<FSType> I<FSType>
2496
2497 Select partitions based on the filesystem type.
2498
2499 See F</"IGNORELISTS"> for details.
2500
2501 =item B<IgnoreSelected> B<true>|B<false>
2502
2503 Invert the selection: If set to true, all partitions B<except> the ones that
2504 match any one of the criteria are collected. By default only selected
2505 partitions are collected if a selection is made. If no selection is configured
2506 at all, B<all> partitions are selected.
2507
2508 =item B<ReportByDevice> B<true>|B<false>
2509
2510 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2511 (the default), it will report a disk as "root", but with it I<true>, it will be
2512 "sda1" (or whichever).
2513
2514 =item B<ReportInodes> B<true>|B<false>
2515
2516 Enables or disables reporting of free, reserved and used inodes. Defaults to
2517 inode collection being disabled.
2518
2519 Enable this option if inodes are a scarce resource for you, usually because
2520 many small files are stored on the disk. This is a usual scenario for mail
2521 transfer agents and web caches.
2522
2523 =item B<ValuesAbsolute> B<true>|B<false>
2524
2525 Enables or disables reporting of free and used disk space in 1K-blocks.
2526 Defaults to B<true>.
2527
2528 =item B<ValuesPercentage> B<false>|B<true>
2529
2530 Enables or disables reporting of free and used disk space in percentage.
2531 Defaults to B<false>.
2532
2533 This is useful for deploying I<collectd> on the cloud, where machines with
2534 different disk size may exist. Then it is more practical to configure
2535 thresholds based on relative disk size.
2536
2537 =back
2538
2539 =head2 Plugin C<disk>
2540
2541 The C<disk> plugin collects information about the usage of physical disks and
2542 logical disks (partitions). Values collected are the number of octets written
2543 to and read from a disk or partition, the number of read/write operations
2544 issued to the disk and a rather complex "time" it took for these commands to be
2545 issued.
2546
2547 Using the following two options you can ignore some disks or configure the
2548 collection only of specific disks.
2549
2550 =over 4
2551
2552 =item B<Disk> I<Name>
2553
2554 Select the disk I<Name>. Whether it is collected or ignored depends on the
2555 B<IgnoreSelected> setting, see below. As with other plugins that use the
2556 daemon's ignorelist functionality, a string that starts and ends with a slash
2557 is interpreted as a regular expression. Examples:
2558
2559   Disk "sdd"
2560   Disk "/hda[34]/"
2561
2562 See F</"IGNORELISTS"> for details.
2563
2564 =item B<IgnoreSelected> B<true>|B<false>
2565
2566 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2567 statements, are ignored or if all other disks are ignored. The behavior
2568 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2569 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2570 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2571 is set to B<true>, all disks are collected B<except> the ones matched.
2572
2573 =item B<UseBSDName> B<true>|B<false>
2574
2575 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2576 default major/minor numbers. Requires collectd to be built with Apple's
2577 IOKitLib support.
2578
2579 =item B<UdevNameAttr> I<Attribute>
2580
2581 Attempt to override disk instance name with the value of a specified udev
2582 attribute when built with B<libudev>.  If the attribute is not defined for the
2583 given device, the default name is used. Example:
2584
2585   UdevNameAttr "DM_NAME"
2586
2587 =back
2588
2589 =head2 Plugin C<dns>
2590
2591 =over 4
2592
2593 =item B<Interface> I<Interface>
2594
2595 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2596 option sets the interface that should be used. If this option is not set, or
2597 set to "any", the plugin will try to get packets from B<all> interfaces. This
2598 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2599
2600 =item B<IgnoreSource> I<IP-address>
2601
2602 Ignore packets that originate from this address.
2603
2604 =item B<SelectNumericQueryTypes> B<true>|B<false>
2605
2606 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2607
2608 =back
2609
2610 =head2 Plugin C<dpdkevents>
2611
2612 The I<dpdkevents plugin> collects events from DPDK such as link status of
2613 network ports and Keep Alive status of DPDK logical cores.
2614 In order to get Keep Alive events following requirements must be met:
2615 - DPDK >= 16.07
2616 - support for Keep Alive implemented in DPDK application. More details can
2617 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2618
2619 B<Synopsis:>
2620
2621  <Plugin "dpdkevents">
2622    <EAL>
2623      Coremask "0x1"
2624      MemoryChannels "4"
2625      FilePrefix "rte"
2626    </EAL>
2627    <Event "link_status">
2628      SendEventsOnUpdate true
2629      EnabledPortMask 0xffff
2630      PortName "interface1"
2631      PortName "interface2"
2632      SendNotification false
2633    </Event>
2634    <Event "keep_alive">
2635      SendEventsOnUpdate true
2636      LCoreMask "0xf"
2637      KeepAliveShmName "/dpdk_keepalive_shm_name"
2638      SendNotification false
2639    </Event>
2640  </Plugin>
2641
2642 B<Options:>
2643
2644
2645 =head3 The EAL block
2646
2647 =over 4
2648
2649 =item B<Coremask> I<Mask>
2650
2651 =item B<Memorychannels> I<Channels>
2652
2653 Number of memory channels per processor socket.
2654
2655 =item B<FilePrefix> I<File>
2656
2657 The prefix text used for hugepage filenames. The filename will be set to
2658 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2659
2660 =back
2661
2662 =head3 The Event block
2663
2664 The B<Event> block defines configuration for specific event. It accepts a
2665 single argument which specifies the name of the event.
2666
2667 =head4 Link Status event
2668
2669 =over 4
2670
2671 =item B<SendEventOnUpdate> I<true|false>
2672
2673 If set to true link status value will be dispatched only when it is
2674 different from previously read value. This is an optional argument - default
2675 value is true.
2676
2677 =item B<EnabledPortMask> I<Mask>
2678
2679 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2680 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2681 that all ports will be enabled. This is an optional argument - by default
2682 all ports are enabled.
2683
2684 =item B<PortName> I<Name>
2685
2686 A string containing an optional name for the enabled DPDK ports. Each PortName
2687 option should contain only one port name; specify as many PortName options as
2688 desired. Default naming convention will be used if PortName is blank. If there
2689 are less PortName options than there are enabled ports, the default naming
2690 convention will be used for the additional ports.
2691
2692 =item B<SendNotification> I<true|false>
2693
2694 If set to true, link status notifications are sent, instead of link status
2695 being collected as a statistic. This is an optional argument - default
2696 value is false.
2697
2698 =back
2699
2700 =head4 Keep Alive event
2701
2702 =over 4
2703
2704 =item B<SendEventOnUpdate> I<true|false>
2705
2706 If set to true keep alive value will be dispatched only when it is
2707 different from previously read value. This is an optional argument - default
2708 value is true.
2709
2710 =item B<LCoreMask> I<Mask>
2711
2712 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2713
2714 =item B<KeepAliveShmName> I<Name>
2715
2716 Shared memory name identifier that is used by secondary process to monitor
2717 the keep alive cores state.
2718
2719 =item B<SendNotification> I<true|false>
2720
2721 If set to true, keep alive notifications are sent, instead of keep alive
2722 information being collected as a statistic. This is an optional
2723 argument - default value is false.
2724
2725 =back
2726
2727 =head2 Plugin C<dpdkstat>
2728
2729 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2730 extended NIC stats API in DPDK.
2731
2732 B<Synopsis:>
2733
2734  <Plugin "dpdkstat">
2735    <EAL>
2736      Coremask "0x4"
2737      MemoryChannels "4"
2738      FilePrefix "rte"
2739      SocketMemory "1024"
2740      LogLevel "7"
2741      RteDriverLibPath "/usr/lib/dpdk-pmd"
2742    </EAL>
2743    SharedMemObj "dpdk_collectd_stats_0"
2744    EnabledPortMask 0xffff
2745    PortName "interface1"
2746    PortName "interface2"
2747  </Plugin>
2748
2749 B<Options:>
2750
2751 =head3 The EAL block
2752
2753 =over 4
2754
2755 =item B<Coremask> I<Mask>
2756
2757 A string containing an hexadecimal bit mask of the cores to run on. Note that
2758 core numbering can change between platforms and should be determined beforehand.
2759
2760 =item B<Memorychannels> I<Channels>
2761
2762 A string containing a number of memory channels per processor socket.
2763
2764 =item B<FilePrefix> I<File>
2765
2766 The prefix text used for hugepage filenames. The filename will be set to
2767 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2768
2769 =item B<SocketMemory> I<MB>
2770
2771 A string containing amount of Memory to allocate from hugepages on specific
2772 sockets in MB. This is an optional value.
2773
2774 =item B<LogLevel> I<LogLevel_number>
2775
2776 A string containing log level number. This parameter is optional.
2777 If parameter is not present then default value "7" - (INFO) is used.
2778 Value "8" - (DEBUG) can be set to enable debug traces.
2779
2780 =item B<RteDriverLibPath> I<Path>
2781
2782 A string containing path to shared pmd driver lib or path to directory,
2783 where shared pmd driver libs are available. This parameter is optional.
2784 This parameter enable loading of shared pmd driver libs from defined path.
2785 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2786 or    "/usr/lib/dpdk-pmd"
2787
2788 =back
2789
2790 =over 3
2791
2792 =item B<SharedMemObj> I<Mask>
2793
2794 A string containing the name of the shared memory object that should be used to
2795 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2796 Defaults to dpdk_collectd_stats if no other value is configured.
2797
2798 =item B<EnabledPortMask> I<Mask>
2799
2800 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2801 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2802 that all ports will be enabled. This is an optional argument - default
2803 is all ports enabled.
2804
2805 =item B<PortName> I<Name>
2806
2807 A string containing an optional name for the enabled DPDK ports. Each PortName
2808 option should contain only one port name; specify as many PortName options as
2809 desired. Default naming convention will be used if PortName is blank. If there
2810 are less PortName options than there are enabled ports, the default naming
2811 convention will be used for the additional ports.
2812
2813 =back
2814
2815 =head2 Plugin C<email>
2816
2817 =over 4
2818
2819 =item B<SocketFile> I<Path>
2820
2821 Sets the socket-file which is to be created.
2822
2823 =item B<SocketGroup> I<Group>
2824
2825 If running as root change the group of the UNIX-socket after it has been
2826 created. Defaults to B<collectd>.
2827
2828 =item B<SocketPerms> I<Permissions>
2829
2830 Change the file permissions of the UNIX-socket after it has been created. The
2831 permissions must be given as a numeric, octal value as you would pass to
2832 L<chmod(1)>. Defaults to B<0770>.
2833
2834 =item B<MaxConns> I<Number>
2835
2836 Sets the maximum number of connections that can be handled in parallel. Since
2837 this many threads will be started immediately setting this to a very high
2838 value will waste valuable resources. Defaults to B<5> and will be forced to be
2839 at most B<16384> to prevent typos and dumb mistakes.
2840
2841 =back
2842
2843 =head2 Plugin C<ethstat>
2844
2845 The I<ethstat plugin> collects information about network interface cards (NICs)
2846 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2847
2848 B<Synopsis:>
2849
2850  <Plugin "ethstat">
2851    Interface "eth0"
2852    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2853    Map "multicast" "if_multicast"
2854  </Plugin>
2855
2856 B<Options:>
2857
2858 =over 4
2859
2860 =item B<Interface> I<Name>
2861
2862 Collect statistical information about interface I<Name>.
2863
2864 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2865
2866 By default, the plugin will submit values as type C<derive> and I<type
2867 instance> set to I<Name>, the name of the metric as reported by the driver. If
2868 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2869 I<TypeInstance> will be used.
2870
2871 =item B<MappedOnly> B<true>|B<false>
2872
2873 When set to B<true>, only metrics that can be mapped to a I<type> will be
2874 collected, all other metrics will be ignored. Defaults to B<false>.
2875
2876 =back
2877
2878 =head2 Plugin C<exec>
2879
2880 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2881 contains valuable information on when the executable is executed and the
2882 output that is expected from it.
2883
2884 =over 4
2885
2886 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2887
2888 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2889
2890 Execute the executable I<Executable> as user I<User>. If the user name is
2891 followed by a colon and a group name, the effective group is set to that group.
2892 The real group and saved-set group will be set to the default group of that
2893 user. If no group is given the effective group ID will be the same as the real
2894 group ID.
2895
2896 Please note that in order to change the user and/or group the daemon needs
2897 superuser privileges. If the daemon is run as an unprivileged user you must
2898 specify the same user/group here. If the daemon is run with superuser
2899 privileges, you must supply a non-root user here.
2900
2901 The executable may be followed by optional arguments that are passed to the
2902 program. Please note that due to the configuration parsing numbers and boolean
2903 values may be changed. If you want to be absolutely sure that something is
2904 passed as-is please enclose it in quotes.
2905
2906 The B<Exec> and B<NotificationExec> statements change the semantics of the
2907 programs executed, i.E<nbsp>e. the data passed to them and the response
2908 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2909
2910 =back
2911
2912 =head2 Plugin C<fhcount>
2913
2914 The C<fhcount> plugin provides statistics about used, unused and total number of
2915 file handles on Linux.
2916
2917 The I<fhcount plugin> provides the following configuration options:
2918
2919 =over 4
2920
2921 =item B<ValuesAbsolute> B<true>|B<false>
2922
2923 Enables or disables reporting of file handles usage in absolute numbers,
2924 e.g. file handles used. Defaults to B<true>.
2925
2926 =item B<ValuesPercentage> B<false>|B<true>
2927
2928 Enables or disables reporting of file handles usage in percentages, e.g.
2929 percent of file handles used. Defaults to B<false>.
2930
2931 =back
2932
2933 =head2 Plugin C<filecount>
2934
2935 The C<filecount> plugin counts the number of files in a certain directory (and
2936 its subdirectories) and their combined size. The configuration is very straight
2937 forward:
2938
2939   <Plugin "filecount">
2940     <Directory "/var/qmail/queue/mess">
2941       Instance "qmail-message"
2942     </Directory>
2943     <Directory "/var/qmail/queue/todo">
2944       Instance "qmail-todo"
2945     </Directory>
2946     <Directory "/var/lib/php5">
2947       Instance "php5-sessions"
2948       Name "sess_*"
2949     </Directory>
2950   </Plugin>
2951
2952 The example above counts the number of files in QMail's queue directories and
2953 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2954 QMail has not yet looked at, the "message" queue holds the messages that were
2955 classified into "local" and "remote".
2956
2957 As you can see, the configuration consists of one or more C<Directory> blocks,
2958 each of which specifies a directory in which to count the files. Within those
2959 blocks, the following options are recognized:
2960
2961 =over 4
2962
2963 =item B<Plugin> I<Plugin>
2964
2965 Use I<Plugin> as the plugin name when submitting values.
2966 Defaults to B<filecount>.
2967
2968 =item B<Instance> I<Instance>
2969
2970 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2971 the directory name with all slashes replaced by underscores and all leading
2972 underscores removed. Empty value is allowed.
2973
2974 =item B<Name> I<Pattern>
2975
2976 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2977 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2978 against the pattern, not the entire path. In case this makes it easier for you:
2979 This option has been named after the B<-name> parameter to L<find(1)>.
2980
2981 =item B<MTime> I<Age>
2982
2983 Count only files of a specific age: If I<Age> is greater than zero, only files
2984 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2985 a negative number, this is inversed. For example, if B<-60> is specified, only
2986 files that have been modified in the last minute will be counted.
2987
2988 The number can also be followed by a "multiplier" to easily specify a larger
2989 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2990 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2991 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2992 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2993 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2994 B<"12h">.
2995
2996 =item B<Size> I<Size>
2997
2998 Count only files of a specific size. When I<Size> is a positive number, only
2999 files that are at least this big are counted. If I<Size> is a negative number,
3000 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3001 I<Size> are counted.
3002
3003 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3004 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3005 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3006 note that there are 1000 bytes in a kilobyte, not 1024.
3007
3008 =item B<Recursive> I<true>|I<false>
3009
3010 Controls whether or not to recurse into subdirectories. Enabled by default.
3011
3012 =item B<IncludeHidden> I<true>|I<false>
3013
3014 Controls whether or not to include "hidden" files and directories in the count.
3015 "Hidden" files and directories are those, whose name begins with a dot.
3016 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3017
3018 =item B<RegularOnly> I<true>|I<false>
3019
3020 Controls whether or not to include only regular files in the count.
3021 Defaults to I<true>, i.e. by default non regular files are ignored.
3022
3023 =item B<FilesSizeType> I<Type>
3024
3025 Sets the type used to dispatch files combined size. Empty value ("") disables
3026 reporting. Defaults to B<bytes>.
3027
3028 =item B<FilesCountType> I<Type>
3029
3030 Sets the type used to dispatch number of files. Empty value ("") disables
3031 reporting. Defaults to B<files>.
3032
3033 =item B<TypeInstance> I<Instance>
3034
3035 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3036 (no plugin instance).
3037
3038 =back
3039
3040 =head2 Plugin C<GenericJMX>
3041
3042 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3043 L<collectd-java(5)>.
3044
3045 =head2 Plugin C<gmond>
3046
3047 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3048 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3049 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3050
3051 Synopsis:
3052
3053  <Plugin "gmond">
3054    MCReceiveFrom "239.2.11.71" "8649"
3055    <Metric "swap_total">
3056      Type "swap"
3057      TypeInstance "total"
3058      DataSource "value"
3059    </Metric>
3060    <Metric "swap_free">
3061      Type "swap"
3062      TypeInstance "free"
3063      DataSource "value"
3064    </Metric>
3065  </Plugin>
3066
3067 The following metrics are built-in:
3068
3069 =over 4
3070
3071 =item *
3072
3073 load_one, load_five, load_fifteen
3074
3075 =item *
3076
3077 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3078
3079 =item *
3080
3081 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3082
3083 =item *
3084
3085 bytes_in, bytes_out
3086
3087 =item *
3088
3089 pkts_in, pkts_out
3090
3091 =back
3092
3093 Available configuration options:
3094
3095 =over 4
3096
3097 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3098
3099 Sets sets the multicast group and UDP port to which to subscribe.
3100
3101 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3102
3103 =item E<lt>B<Metric> I<Name>E<gt>
3104
3105 These blocks add a new metric conversion to the internal table. I<Name>, the
3106 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3107
3108 =over 4
3109
3110 =item B<Type> I<Type>
3111
3112 Type to map this metric to. Required.
3113
3114 =item B<TypeInstance> I<Instance>
3115
3116 Type-instance to use. Optional.
3117
3118 =item B<DataSource> I<Name>
3119
3120 Data source to map this metric to. If the configured type has exactly one data
3121 source, this is optional. Otherwise the option is required.
3122
3123 =back
3124
3125 =back
3126
3127 =head2 Plugin C<gps>
3128
3129 The C<gps plugin> connects to gpsd on the host machine.
3130 The host, port, timeout and pause are configurable.
3131
3132 This is useful if you run an NTP server using a GPS for source and you want to
3133 monitor it.
3134
3135 Mind your GPS must send $--GSA for having the data reported!
3136
3137 The following elements are collected:
3138
3139 =over 4
3140
3141 =item B<satellites>
3142
3143 Number of satellites used for fix (type instance "used") and in view (type
3144 instance "visible"). 0 means no GPS satellites are visible.
3145
3146 =item B<dilution_of_precision>
3147
3148 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3149 It should be between 0 and 3.
3150 Look at the documentation of your GPS to know more.
3151
3152 =back
3153
3154 Synopsis:
3155
3156  LoadPlugin gps
3157  <Plugin "gps">
3158    # Connect to localhost on gpsd regular port:
3159    Host "127.0.0.1"
3160    Port "2947"
3161    # 15 ms timeout
3162    Timeout 0.015
3163    # PauseConnect of 5 sec. between connection attempts.
3164    PauseConnect 5
3165  </Plugin>
3166
3167 Available configuration options:
3168
3169 =over 4
3170
3171 =item B<Host> I<Host>
3172
3173 The host on which gpsd daemon runs. Defaults to B<localhost>.
3174
3175 =item B<Port> I<Port>
3176
3177 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3178
3179 =item B<Timeout> I<Seconds>
3180
3181 Timeout in seconds (default 0.015 sec).
3182
3183 The GPS data stream is fetch by the plugin form the daemon.
3184 It waits for data to be available, if none arrives it times out
3185 and loop for another reading.
3186 Mind to put a low value gpsd expects value in the micro-seconds area
3187 (recommended is 500 us) since the waiting function is blocking.
3188 Value must be between 500 us and 5 sec., if outside that range the
3189 default value is applied.
3190
3191 This only applies from gpsd release-2.95.
3192
3193 =item B<PauseConnect> I<Seconds>
3194
3195 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3196
3197 =back
3198
3199 =head2 Plugin C<grpc>
3200
3201 The I<grpc> plugin provides an RPC interface to submit values to or query
3202 values from collectd based on the open source gRPC framework. It exposes an
3203 end-point for dispatching values to the daemon.
3204
3205 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3206
3207 =over 4
3208
3209 =item B<Server> I<Host> I<Port>
3210
3211 The B<Server> statement sets the address of a server to which to send metrics
3212 via the C<DispatchValues> function.
3213
3214 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3215
3216 Optionally, B<Server> may be specified as a configuration block which supports
3217 the following options:
3218
3219 =over 4
3220
3221 =item B<EnableSSL> B<false>|B<true>
3222
3223 Whether to require SSL for outgoing connections. Default: false.
3224
3225 =item B<SSLCACertificateFile> I<Filename>
3226
3227 =item B<SSLCertificateFile> I<Filename>
3228
3229 =item B<SSLCertificateKeyFile> I<Filename>
3230
3231 Filenames specifying SSL certificate and key material to be used with SSL
3232 connections.
3233
3234 =back
3235
3236 =item B<Listen> I<Host> I<Port>
3237
3238 The B<Listen> statement sets the network address to bind to. When multiple
3239 statements are specified, the daemon will bind to all of them. If none are
3240 specified, it defaults to B<0.0.0.0:50051>.
3241
3242 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3243
3244 Optionally, B<Listen> may be specified as a configuration block which
3245 supports the following options:
3246
3247 =over 4
3248
3249 =item B<EnableSSL> I<true>|I<false>
3250
3251 Whether to enable SSL for incoming connections. Default: false.
3252
3253 =item B<SSLCACertificateFile> I<Filename>
3254
3255 =item B<SSLCertificateFile> I<Filename>
3256
3257 =item B<SSLCertificateKeyFile> I<Filename>
3258
3259 Filenames specifying SSL certificate and key material to be used with SSL
3260 connections.
3261
3262 =item B<VerifyPeer> B<true>|B<false>
3263
3264 When enabled, a valid client certificate is required to connect to the server.
3265 When disabled, a client certifiacte is not requested and any unsolicited client
3266 certificate is accepted.
3267 Enabled by default.
3268
3269 =back
3270
3271 =back
3272
3273 =head2 Plugin C<hddtemp>
3274
3275 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3276 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3277 default values, see below. C<hddtemp> has to be running to work correctly. If
3278 C<hddtemp> is not running timeouts may appear which may interfere with other
3279 statistics..
3280
3281 The B<hddtemp> homepage can be found at
3282 L<http://www.guzu.net/linux/hddtemp.php>.
3283
3284 =over 4
3285
3286 =item B<Host> I<Hostname>
3287
3288 Hostname to connect to. Defaults to B<127.0.0.1>.
3289
3290 =item B<Port> I<Port>
3291
3292 TCP-Port to connect to. Defaults to B<7634>.
3293
3294 =back
3295
3296 =head2 Plugin C<hugepages>
3297
3298 To collect B<hugepages> information, collectd reads directories
3299 "/sys/devices/system/node/*/hugepages" and
3300 "/sys/kernel/mm/hugepages".
3301 Reading of these directories can be disabled by the following
3302 options (default is enabled).
3303
3304 =over 4
3305
3306 =item B<ReportPerNodeHP> B<true>|B<false>
3307
3308 If enabled, information will be collected from the hugepage
3309 counters in "/sys/devices/system/node/*/hugepages".
3310 This is used to check the per-node hugepage statistics on
3311 a NUMA system.
3312
3313 =item B<ReportRootHP> B<true>|B<false>
3314
3315 If enabled, information will be collected from the hugepage
3316 counters in "/sys/kernel/mm/hugepages".
3317 This can be used on both NUMA and non-NUMA systems to check
3318 the overall hugepage statistics.
3319
3320 =item B<ValuesPages> B<true>|B<false>
3321
3322 Whether to report hugepages metrics in number of pages.
3323 Defaults to B<true>.
3324
3325 =item B<ValuesBytes> B<false>|B<true>
3326
3327 Whether to report hugepages metrics in bytes.
3328 Defaults to B<false>.
3329
3330 =item B<ValuesPercentage> B<false>|B<true>
3331
3332 Whether to report hugepages metrics as percentage.
3333 Defaults to B<false>.
3334
3335 =back
3336
3337 =head2 Plugin C<intel_pmu>
3338
3339 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3340 Linux perf interface. All events are reported on a per core basis.
3341
3342 B<Synopsis:>
3343
3344   <Plugin intel_pmu>
3345     ReportHardwareCacheEvents true
3346     ReportKernelPMUEvents true
3347     ReportSoftwareEvents true
3348     EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3349     HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3350     Cores "0-3" "4,6" "[12-15]"
3351   </Plugin>
3352
3353 B<Options:>
3354
3355 =over 4
3356
3357 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3358
3359 Enable or disable measuring of hardware CPU cache events:
3360   - L1-dcache-loads
3361   - L1-dcache-load-misses
3362   - L1-dcache-stores
3363   - L1-dcache-store-misses
3364   - L1-dcache-prefetches
3365   - L1-dcache-prefetch-misses
3366   - L1-icache-loads
3367   - L1-icache-load-misses
3368   - L1-icache-prefetches
3369   - L1-icache-prefetch-misses
3370   - LLC-loads
3371   - LLC-load-misses
3372   - LLC-stores
3373   - LLC-store-misses
3374   - LLC-prefetches
3375   - LLC-prefetch-misses
3376   - dTLB-loads
3377   - dTLB-load-misses
3378   - dTLB-stores
3379   - dTLB-store-misses
3380   - dTLB-prefetches
3381   - dTLB-prefetch-misses
3382   - iTLB-loads
3383   - iTLB-load-misses
3384   - branch-loads
3385   - branch-load-misses
3386
3387 =item B<ReportKernelPMUEvents> B<false>|B<true>
3388
3389 Enable or disable measuring of the following events:
3390   - cpu-cycles
3391   - instructions
3392   - cache-references
3393   - cache-misses
3394   - branches
3395   - branch-misses
3396   - bus-cycles
3397
3398 =item B<ReportSoftwareEvents> B<false>|B<true>
3399
3400 Enable or disable measuring of software events provided by kernel:
3401   - cpu-clock
3402   - task-clock
3403   - context-switches
3404   - cpu-migrations
3405   - page-faults
3406   - minor-faults
3407   - major-faults
3408   - alignment-faults
3409   - emulation-faults
3410
3411 =item B<EventList> I<filename>
3412
3413 JSON performance counter event list file name. To be able to monitor all Intel
3414 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3415 event_download.py script to download event list for current CPU.
3416
3417 =item B<HardwareEvents> I<events>
3418
3419 This field is a list of event names or groups of comma separated event names.
3420 This option requires B<EventList> option to be configured.
3421
3422 =item B<Cores> I<cores groups>
3423
3424 All events are reported on a per core basis. Monitoring of the events can be
3425 configured for a group of cores (aggregated statistics). This field defines
3426 groups of cores on which to monitor supported events. The field is represented
3427 as list of strings with core group values. Each string represents a list of
3428 cores in a group. If a group is enclosed in square brackets each core is added
3429 individually to a separate group (that is statistics are not aggregated).
3430 Allowed formats are:
3431     0,1,2,3
3432     0-10,20-18
3433     1,3,5-8,10,0x10-12
3434     [4-15,32-63]
3435
3436 If an empty string is provided as value for this field default cores
3437 configuration is applied - that is separate group is created for each core.
3438
3439 =back
3440
3441 =head2 Plugin C<intel_rdt>
3442
3443 The I<intel_rdt> plugin collects information provided by monitoring features of
3444 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3445 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3446 information about utilization of shared resources. CMT monitors last level cache
3447 occupancy (LLC). MBM supports two types of events reporting local and remote
3448 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3449 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3450 reports the bandwidth of accessing the remote socket. Also this technology
3451 allows to monitor instructions per clock (IPC).
3452 Monitor events are hardware dependant. Monitoring capabilities are detected on
3453 plugin initialization and only supported events are monitored.
3454
3455 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3456 require an additional capability to be enabled if collectd is run as a service.
3457 Please refer to I<contrib/systemd.collectd.service> file for more details.
3458
3459 B<Synopsis:>
3460
3461   <Plugin "intel_rdt">
3462     Cores "0-2" "3,4,6" "8-10,15"
3463   </Plugin>
3464
3465 B<Options:>
3466
3467 =over 4
3468
3469 =item B<Interval> I<seconds>
3470
3471 The interval within which to retrieve statistics on monitored events in seconds.
3472 For milliseconds divide the time by 1000 for example if the desired interval
3473 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3474 recommended to set interval higher than 1 sec.
3475
3476 =item B<Cores> I<cores groups>
3477
3478 All events are reported on a per core basis. Monitoring of the events can be
3479 configured for group of cores (aggregated statistics). This field defines groups
3480 of cores on which to monitor supported events. The field is represented as list
3481 of strings with core group values. Each string represents a list of cores in a
3482 group. Allowed formats are:
3483     0,1,2,3
3484     0-10,20-18
3485     1,3,5-8,10,0x10-12
3486
3487 If an empty string is provided as value for this field default cores
3488 configuration is applied - a separate group is created for each core.
3489
3490 =back
3491
3492 B<Note:> By default global interval is used to retrieve statistics on monitored
3493 events. To configure a plugin specific interval use B<Interval> option of the
3494 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3495 example if the desired interval is 50ms, set interval to 0.05.
3496 Due to limited capacity of counters it is not recommended to set interval higher
3497 than 1 sec.
3498
3499 =head2 Plugin C<interface>
3500
3501 =over 4
3502
3503 =item B<Interface> I<Interface>
3504
3505 Select this interface. By default these interfaces will then be collected. For
3506 a more detailed description see B<IgnoreSelected> below.
3507
3508 See F</"IGNORELISTS"> for details.
3509
3510 =item B<IgnoreSelected> I<true>|I<false>
3511
3512 If no configuration is given, the B<interface>-plugin will collect data from
3513 all interfaces. This may not be practical, especially for loopback- and
3514 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3515 interfaces you're interested in. Sometimes, however, it's easier/preferred
3516 to collect all interfaces I<except> a few ones. This option enables you to
3517 do that: By setting B<IgnoreSelected> to I<true> the effect of
3518 B<Interface> is inverted: All selected interfaces are ignored and all
3519 other interfaces are collected.
3520
3521 It is possible to use regular expressions to match interface names, if the
3522 name is surrounded by I</.../> and collectd was compiled with support for
3523 regexps. This is useful if there's a need to collect (or ignore) data
3524 for a group of interfaces that are similarly named, without the need to
3525 explicitly list all of them (especially useful if the list is dynamic).
3526 Example:
3527
3528  Interface "lo"
3529  Interface "/^veth/"
3530  Interface "/^tun[0-9]+/"
3531  IgnoreSelected "true"
3532
3533 This will ignore the loopback interface, all interfaces with names starting
3534 with I<veth> and all interfaces with names starting with I<tun> followed by
3535 at least one digit.
3536
3537 =item B<ReportInactive> I<true>|I<false>
3538
3539 When set to I<false>, only interfaces with non-zero traffic will be
3540 reported. Note that the check is done by looking into whether a
3541 package was sent at any time from boot and the corresponding counter
3542 is non-zero. So, if the interface has been sending data in the past
3543 since boot, but not during the reported time-interval, it will still
3544 be reported.
3545
3546 The default value is I<true> and results in collection of the data
3547 from all interfaces that are selected by B<Interface> and
3548 B<IgnoreSelected> options.
3549
3550 =item B<UniqueName> I<true>|I<false>
3551
3552 Interface name is not unique on Solaris (KSTAT), interface name is unique
3553 only within a module/instance. Following tuple is considered unique:
3554    (ks_module, ks_instance, ks_name)
3555 If this option is set to true, interface name contains above three fields
3556 separated by an underscore. For more info on KSTAT, visit
3557 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3558
3559 This option is only available on Solaris.
3560
3561 =back
3562
3563 =head2 Plugin C<ipmi>
3564
3565 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3566 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3567
3568 The plugin configuration consists of one or more B<Instance> blocks which
3569 specify one I<ipmi> connection each. Each block requires one unique string
3570 argument as the instance name. If instances are not configured, an instance with
3571 the default option values will be created.
3572
3573 For backwards compatibility, any option other than B<Instance> block will trigger
3574 legacy config handling and it will be treated as an option within B<Instance>
3575 block. This support will go away in the next major version of Collectd.
3576
3577 Within the B<Instance> blocks, the following options are allowed:
3578
3579 =over 4
3580
3581 =item B<Address> I<Address>
3582
3583 Hostname or IP to connect to. If not specified, plugin will try to connect to
3584 local management controller (BMC).
3585
3586 =item B<Username> I<Username>
3587
3588 =item B<Password> I<Password>
3589
3590 The username and the password to use for the connection to remote BMC.
3591
3592 =item B<AuthType> I<MD5>|I<rmcp+>
3593
3594 Forces the authentication type to use for the connection to remote BMC.
3595 By default most secure type is seleted.
3596
3597 =item B<Host> I<Hostname>
3598
3599 Sets the B<host> field of dispatched values. Defaults to the global hostname
3600 setting.
3601
3602 =item B<Sensor> I<Sensor>
3603
3604 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3605
3606 See F</"IGNORELISTS"> for details.
3607
3608 =item B<IgnoreSelected> I<true>|I<false>
3609
3610 If no configuration if given, the B<ipmi> plugin will collect data from all
3611 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3612 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3613 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3614 all other sensors are collected.
3615
3616 =item B<NotifySensorAdd> I<true>|I<false>
3617
3618 If a sensor appears after initialization time of a minute a notification
3619 is sent.
3620
3621 =item B<NotifySensorRemove> I<true>|I<false>
3622
3623 If a sensor disappears a notification is sent.
3624
3625 =item B<NotifySensorNotPresent> I<true>|I<false>
3626
3627 If you have for example dual power supply and one of them is (un)plugged then
3628 a notification is sent.
3629
3630 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3631
3632 If a IPMI connection state changes after initialization time of a minute
3633 a notification is sent. Defaults to B<false>.
3634
3635 =item B<SELEnabled> I<true>|I<false>
3636
3637 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3638 and discrete events. When event is received the notification is sent.
3639 Defaults to B<false>.
3640
3641 =item B<SELClearEvent> I<true>|I<false>
3642
3643 If SEL clear event is enabled, plugin will delete event from SEL list after
3644 it is received and successfully handled. In this case other tools that are
3645 subscribed for SEL events will receive an empty event.
3646 Defaults to B<false>.
3647
3648 =back
3649
3650 =head2 Plugin C<iptables>
3651
3652 =over 4
3653
3654 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3655
3656 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3657
3658 Select the iptables/ip6tables filter rules to count packets and bytes from.
3659
3660 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3661 of all rules which have a comment-match. The comment is then used as
3662 type-instance.
3663
3664 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3665 the I<n>th rule will be collected. Again, the comment (or the number) will be
3666 used as the type-instance.
3667
3668 If I<Name> is supplied, it will be used as the type-instance instead of the
3669 comment or the number.
3670
3671 =back
3672
3673 =head2 Plugin C<irq>
3674
3675 =over 4
3676
3677 =item B<Irq> I<Irq>
3678
3679 Select this irq. By default these irqs will then be collected. For a more
3680 detailed description see B<IgnoreSelected> below.
3681
3682 See F</"IGNORELISTS"> for details.
3683
3684 =item B<IgnoreSelected> I<true>|I<false>
3685
3686 If no configuration if given, the B<irq>-plugin will collect data from all
3687 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3688 can use the B<Irq>-option to pick the interrupt you're interested in.
3689 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3690 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3691 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3692 and all other interrupts are collected.
3693
3694 =back
3695
3696 =head2 Plugin C<java>
3697
3698 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3699 This section only discusses the syntax and semantic of the configuration
3700 options. For more in-depth information on the I<Java> plugin, please read
3701 L<collectd-java(5)>.
3702
3703 Synopsis:
3704
3705  <Plugin "java">
3706    JVMArg "-verbose:jni"
3707    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3708    LoadPlugin "org.collectd.java.Foobar"
3709    <Plugin "org.collectd.java.Foobar">
3710      # To be parsed by the plugin
3711    </Plugin>
3712  </Plugin>
3713
3714 Available configuration options:
3715
3716 =over 4
3717
3718 =item B<JVMArg> I<Argument>
3719
3720 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3721 exactly the way the arguments to the I<java> binary on the command line work.
3722 Execute C<javaE<nbsp>--help> for details.
3723
3724 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3725 any other options! When another option is found, the JVM will be started and
3726 later options will have to be ignored!
3727
3728 =item B<LoadPlugin> I<JavaClass>
3729
3730 Instantiates a new I<JavaClass> object. The constructor of this object very
3731 likely then registers one or more callback methods with the server.
3732
3733 See L<collectd-java(5)> for details.
3734
3735 When the first such option is found, the virtual machine (JVM) is created. This
3736 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3737 B<LoadPlugin> options!
3738
3739 =item B<Plugin> I<Name>
3740
3741 The entire block is passed to the Java plugin as an
3742 I<org.collectd.api.OConfigItem> object.
3743
3744 For this to work, the plugin has to register a configuration callback first,
3745 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3746 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3747 depends on the (Java) plugin registering the callback and is completely
3748 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3749
3750 =back
3751
3752 =head2 Plugin C<load>
3753
3754 The I<Load plugin> collects the system load. These numbers give a rough overview
3755 over the utilization of a machine. The system load is defined as the number of
3756 runnable tasks in the run-queue and is provided by many operating systems as a
3757 one, five or fifteen minute average.
3758
3759 The following configuration options are available:
3760
3761 =over 4
3762
3763 =item B<ReportRelative> B<false>|B<true>
3764
3765 When enabled, system load divided by number of available CPU cores is reported
3766 for intervals 1 min, 5 min and 15 min. Defaults to false.
3767
3768 =back
3769
3770
3771 =head2 Plugin C<logfile>
3772
3773 =over 4
3774
3775 =item B<LogLevel> B<debug|info|notice|warning|err>
3776
3777 Sets the log-level. If, for example, set to B<notice>, then all events with
3778 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3779
3780 Please note that B<debug> is only available if collectd has been compiled with
3781 debugging support.
3782
3783 =item B<File> I<File>
3784
3785 Sets the file to write log messages to. The special strings B<stdout> and
3786 B<stderr> can be used to write to the standard output and standard error
3787 channels, respectively. This, of course, only makes much sense when I<collectd>
3788 is running in foreground- or non-daemon-mode.
3789
3790 =item B<Timestamp> B<true>|B<false>
3791
3792 Prefix all lines printed by the current time. Defaults to B<true>.
3793
3794 =item B<PrintSeverity> B<true>|B<false>
3795
3796 When enabled, all lines are prefixed by the severity of the log message, for
3797 example "warning". Defaults to B<false>.
3798
3799 =back
3800
3801 B<Note>: There is no need to notify the daemon after moving or removing the
3802 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3803 for each line it writes.
3804
3805 =head2 Plugin C<log_logstash>
3806
3807 The I<log logstash plugin> behaves like the logfile plugin but formats
3808 messages as JSON events for logstash to parse and input.
3809
3810 =over 4
3811
3812 =item B<LogLevel> B<debug|info|notice|warning|err>
3813
3814 Sets the log-level. If, for example, set to B<notice>, then all events with
3815 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3816
3817 Please note that B<debug> is only available if collectd has been compiled with
3818 debugging support.
3819
3820 =item B<File> I<File>
3821
3822 Sets the file to write log messages to. The special strings B<stdout> and
3823 B<stderr> can be used to write to the standard output and standard error
3824 channels, respectively. This, of course, only makes much sense when I<collectd>
3825 is running in foreground- or non-daemon-mode.
3826
3827 =back
3828
3829 B<Note>: There is no need to notify the daemon after moving or removing the
3830 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3831 for each line it writes.
3832
3833 =head2 Plugin C<lpar>
3834
3835 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3836 virtualization technique for IBM POWER processors. It takes into account CPU
3837 time stolen from or donated to a partition, in addition to the usual user,
3838 system, I/O statistics.
3839
3840 The following configuration options are available:
3841
3842 =over 4
3843
3844 =item B<CpuPoolStats> B<false>|B<true>
3845
3846 When enabled, statistics about the processor pool are read, too. The partition
3847 needs to have pool authority in order to be able to acquire this information.
3848 Defaults to false.
3849
3850 =item B<ReportBySerial> B<false>|B<true>
3851
3852 If enabled, the serial of the physical machine the partition is currently
3853 running on is reported as I<hostname> and the logical hostname of the machine
3854 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3855 used (just like other plugins) and the I<plugin instance> will be empty.
3856 Defaults to false.
3857
3858 =back
3859
3860 =head2 Plugin C<lua>
3861
3862 This plugin embeds a Lua interpreter into collectd and provides an interface
3863 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3864
3865
3866 =head2 Plugin C<mbmon>
3867
3868 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3869
3870 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3871 B<Host> and B<Port> options can be used to change these values, see below.
3872 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3873 timeouts may appear which may interfere with other statistics..
3874
3875 C<mbmon> must be run with the -r option ("print TAG and Value format");
3876 Debian's F</etc/init.d/mbmon> script already does this, other people
3877 will need to ensure that this is the case.
3878
3879 =over 4
3880
3881 =item B<Host> I<Hostname>
3882
3883 Hostname to connect to. Defaults to B<127.0.0.1>.
3884
3885 =item B<Port> I<Port>
3886
3887 TCP-Port to connect to. Defaults to B<411>.
3888
3889 =back
3890
3891 =head2 Plugin C<mcelog>
3892
3893 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3894
3895 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3896 mcelog server is running. When the server is running, the plugin will tail the
3897 specified logfile to retrieve machine check exception information and send a
3898 notification with the details from the logfile. The plugin will use the mcelog
3899 client protocol to retrieve memory related machine check exceptions. Note that
3900 for memory exceptions, notifications are only sent when there is a change in
3901 the number of corrected/uncorrected memory errors.
3902
3903 =head3 The Memory block
3904
3905 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3906 exclusive.
3907
3908 =over 3
3909
3910 =item B<McelogClientSocket> I<Path>
3911 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3912 Defaults to B<"/var/run/mcelog-client">.
3913
3914 =item B<PersistentNotification> B<true>|B<false>
3915 Override default configuration to only send notifications when sent when there
3916 is a change in the number of corrected/uncorrected memory errors. When set to
3917 true notifications will be sent for every read cycle. Default is false. Does
3918 not affect the stats being dispatched.
3919
3920 =back
3921
3922 =over 4
3923
3924 =item B<McelogLogfile> I<Path>
3925
3926 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3927 cannot be used in conjunction with the memory block options, they are mutually
3928 exclusive.
3929
3930 =back
3931
3932 =head2 Plugin C<md>
3933
3934 The C<md plugin> collects information from Linux Software-RAID devices (md).
3935
3936 All reported values are of the type C<md_disks>. Reported type instances are
3937 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3938 I<missing> (physically absent) disks.
3939
3940 =over 4
3941
3942 =item B<Device> I<Device>
3943
3944 Select md devices based on device name. The I<device name> is the basename of
3945 the device, i.e. the name of the block device without the leading C</dev/>.
3946 See B<IgnoreSelected> for more details.
3947
3948 See F</"IGNORELISTS"> for details.
3949
3950 =item B<IgnoreSelected> B<true>|B<false>
3951
3952 Invert device selection: If set to B<true>, all md devices B<except> those
3953 listed using B<Device> are collected. If B<false> (the default), only those
3954 listed are collected. If no configuration is given, the B<md> plugin will
3955 collect data from all md devices.
3956
3957 =back
3958
3959 =head2 Plugin C<memcachec>
3960
3961 The C<memcachec plugin> connects to a memcached server, queries one or more
3962 given I<pages> and parses the returned data according to user specification.
3963 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3964 plugins.
3965
3966 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3967 library. Please note that there is another library with a very similar name,
3968 libmemcache (notice the missing `d'), which is not applicable.
3969
3970 Synopsis of the configuration:
3971
3972  <Plugin "memcachec">
3973    <Page "plugin_instance">
3974      Server "localhost"
3975      Key "page_key"
3976      Plugin "plugin_name"
3977      <Match>
3978        Regex "(\\d+) bytes sent"
3979        DSType CounterAdd
3980        Type "ipt_octets"
3981        Instance "type_instance"
3982      </Match>
3983    </Page>
3984  </Plugin>
3985
3986 The configuration options are:
3987
3988 =over 4
3989
3990 =item E<lt>B<Page> I<Name>E<gt>
3991
3992 Each B<Page> block defines one I<page> to be queried from the memcached server.
3993 The block requires one string argument which is used as I<plugin instance>.
3994
3995 =item B<Server> I<Address>
3996
3997 Sets the server address to connect to when querying the page. Must be inside a
3998 B<Page> block.
3999
4000 =item B<Key> I<Key>
4001
4002 When connected to the memcached server, asks for the page I<Key>.
4003
4004 =item B<Plugin> I<Plugin>
4005
4006 Use I<Plugin> as the plugin name when submitting values.
4007 Defaults to C<memcachec>.
4008
4009 =item E<lt>B<Match>E<gt>
4010
4011 Match blocks define which strings to look for and how matches substrings are
4012 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4013
4014 =back
4015
4016 =head2 Plugin C<memcached>
4017
4018 The B<memcached plugin> connects to a memcached server and queries statistics
4019 about cache utilization, memory and bandwidth used.
4020 L<http://memcached.org/>
4021
4022  <Plugin "memcached">
4023    <Instance "name">
4024      #Host "memcache.example.com"
4025      Address "127.0.0.1"
4026      Port 11211
4027    </Instance>
4028  </Plugin>
4029
4030 The plugin configuration consists of one or more B<Instance> blocks which
4031 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4032 following options are allowed:
4033
4034 =over 4
4035
4036 =item B<Host> I<Hostname>
4037
4038 Sets the B<host> field of dispatched values. Defaults to the global hostname
4039 setting.
4040 For backwards compatibility, values are also dispatched with the global
4041 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4042 not set.
4043
4044 =item B<Address> I<Address>
4045
4046 Hostname or IP to connect to. For backwards compatibility, defaults to the
4047 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4048
4049 =item B<Port> I<Port>
4050
4051 TCP port to connect to. Defaults to B<11211>.
4052
4053 =item B<Socket> I<Path>
4054
4055 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4056 setting is given, the B<Address> and B<Port> settings are ignored.
4057
4058 =back
4059
4060 =head2 Plugin C<mic>
4061
4062 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4063 Intel's Many Integrated Core (MIC) systems.
4064
4065 B<Synopsis:>
4066
4067  <Plugin mic>
4068    ShowCPU true
4069    ShowCPUCores true
4070    ShowMemory true
4071
4072    ShowTemperatures true
4073    Temperature vddg
4074    Temperature vddq
4075    IgnoreSelectedTemperature true
4076
4077    ShowPower true
4078    Power total0
4079    Power total1
4080    IgnoreSelectedPower true
4081  </Plugin>
4082
4083 The following options are valid inside the B<PluginE<nbsp>mic> block:
4084
4085 =over 4
4086
4087 =item B<ShowCPU> B<true>|B<false>
4088
4089 If enabled (the default) a sum of the CPU usage across all cores is reported.
4090
4091 =item B<ShowCPUCores> B<true>|B<false>
4092
4093 If enabled (the default) per-core CPU usage is reported.
4094
4095 =item B<ShowMemory> B<true>|B<false>
4096
4097 If enabled (the default) the physical memory usage of the MIC system is
4098 reported.
4099
4100 =item B<ShowTemperatures> B<true>|B<false>
4101
4102 If enabled (the default) various temperatures of the MIC system are reported.
4103
4104 =item B<Temperature> I<Name>
4105
4106 This option controls which temperatures are being reported. Whether matching
4107 temperatures are being ignored or I<only> matching temperatures are reported
4108 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4109 temperatures are reported.
4110
4111 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4112
4113 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4114 (the default) only temperatures matching a B<Temperature> option are reported
4115 or, if no B<Temperature> option is specified, all temperatures are reported. If
4116 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4117 are reported.
4118
4119 Known temperature names are:
4120
4121 =over 4
4122
4123 =item die
4124
4125 Die of the CPU
4126
4127 =item devmem
4128
4129 Device Memory
4130
4131 =item fin
4132
4133 Fan In
4134
4135 =item fout
4136
4137 Fan Out
4138
4139 =item vccp
4140
4141 Voltage ccp
4142
4143 =item vddg
4144
4145 Voltage ddg
4146
4147 =item vddq
4148
4149 Voltage ddq
4150
4151 =back
4152
4153 =item B<ShowPower> B<true>|B<false>
4154
4155 If enabled (the default) various temperatures of the MIC system are reported.
4156
4157 =item B<Power> I<Name>
4158
4159 This option controls which power readings are being reported. Whether matching
4160 power readings are being ignored or I<only> matching power readings are reported
4161 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4162 power readings are reported.
4163
4164 =item B<IgnoreSelectedPower> B<false>|B<true>
4165
4166 Controls the behavior of the B<Power> setting above. If set to B<false>
4167 (the default) only power readings matching a B<Power> option are reported
4168 or, if no B<Power> option is specified, all power readings are reported. If
4169 set to B<true>, matching power readings are I<ignored> and all other power readings
4170 are reported.
4171
4172 Known power names are:
4173
4174 =over 4
4175
4176 =item total0
4177
4178 Total power utilization averaged over Time Window 0 (uWatts).
4179
4180 =item total1
4181
4182 Total power utilization averaged over Time Window 0 (uWatts).
4183
4184 =item inst
4185
4186 Instantaneous power (uWatts).
4187
4188 =item imax
4189
4190 Max instantaneous power (uWatts).
4191
4192 =item pcie
4193
4194 PCI-E connector power (uWatts).
4195
4196 =item c2x3
4197
4198 2x3 connector power (uWatts).
4199
4200 =item c2x4
4201
4202 2x4 connector power (uWatts).
4203
4204 =item vccp
4205
4206 Core rail (uVolts).
4207
4208 =item vddg
4209
4210 Uncore rail (uVolts).
4211
4212 =item vddq
4213
4214 Memory subsystem rail (uVolts).
4215
4216 =back
4217
4218 =back
4219
4220 =head2 Plugin C<memory>
4221
4222 The I<memory plugin> provides the following configuration options:
4223
4224 =over 4
4225
4226 =item B<ValuesAbsolute> B<true>|B<false>
4227
4228 Enables or disables reporting of physical memory usage in absolute numbers,
4229 i.e. bytes. Defaults to B<true>.
4230
4231 =item B<ValuesPercentage> B<false>|B<true>
4232
4233 Enables or disables reporting of physical memory usage in percentages, e.g.
4234 percent of physical memory used. Defaults to B<false>.
4235
4236 This is useful for deploying I<collectd> in a heterogeneous environment in
4237 which the sizes of physical memory vary.
4238
4239 =back
4240
4241 =head2 Plugin C<modbus>
4242
4243 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4244 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4245 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
4246 values (two registers interpreted as IEEE floats in big endian notation).
4247
4248 B<Synopsis:>
4249
4250  <Data "voltage-input-1">
4251    RegisterBase 0
4252    RegisterType float
4253    RegisterCmd ReadHolding
4254    Type voltage
4255    Instance "input-1"
4256  </Data>
4257
4258  <Data "voltage-input-2">
4259    RegisterBase 2
4260    RegisterType float
4261    RegisterCmd ReadHolding
4262    Type voltage
4263    Instance "input-2"
4264  </Data>
4265
4266  <Data "supply-temperature-1">
4267    RegisterBase 0
4268    RegisterType Int16
4269    RegisterCmd ReadHolding
4270    Type temperature
4271    Instance "temp-1"
4272  </Data>
4273
4274  <Host "modbus.example.com">
4275    Address "192.168.0.42"
4276    Port    "502"
4277    Interval 60
4278
4279    <Slave 1>
4280      Instance "power-supply"
4281      Collect  "voltage-input-1"
4282      Collect  "voltage-input-2"
4283    </Slave>
4284  </Host>
4285
4286  <Host "localhost">
4287    Device "/dev/ttyUSB0"
4288    Baudrate 38400
4289    Interval 20
4290
4291    <Slave 1>
4292      Instance "temperature"
4293      Collect  "supply-temperature-1"
4294    </Slave>
4295  </Host>
4296
4297 =over 4
4298
4299 =item E<lt>B<Data> I<Name>E<gt> blocks
4300
4301 Data blocks define a mapping between register numbers and the "types" used by
4302 I<collectd>.
4303
4304 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4305
4306 =over 4
4307
4308 =item B<RegisterBase> I<Number>
4309
4310 Configures the base register to read from the device. If the option
4311 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4312 register will be read (the register number is increased by one).
4313
4314 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4315
4316 Specifies what kind of data is returned by the device. This defaults to
4317 B<Uint16>.  If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4318 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4319 and B<RegisterBase+1> will be read and the data is combined into one
4320 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4321 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4322 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4323 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4324 registers are swapped with the most significant 16E<nbsp>bits in
4325 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4326 B<RegisterBase>.
4327
4328 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4329
4330 Specifies register type to be collected from device. Works only with libmodbus
4331 2.9.2 or higher. Defaults to B<ReadHolding>.
4332
4333 =item B<Type> I<Type>
4334
4335 Specifies the "type" (data set) to use when dispatching the value to
4336 I<collectd>. Currently, only data sets with exactly one data source are
4337 supported.
4338
4339 =item B<Instance> I<Instance>
4340
4341 Sets the type instance to use when dispatching the value to I<collectd>. If
4342 unset, an empty string (no type instance) is used.
4343
4344 =back
4345
4346 =item E<lt>B<Host> I<Name>E<gt> blocks
4347
4348 Host blocks are used to specify to which hosts to connect and what data to read
4349 from their "slaves". The string argument I<Name> is used as hostname when
4350 dispatching the values to I<collectd>.
4351
4352 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4353
4354 =over 4
4355
4356 =item B<Address> I<Hostname>
4357
4358 For Modbus/TCP, specifies the node name (the actual network address) used to
4359 connect to the host. This may be an IP address or a hostname. Please note that
4360 the used I<libmodbus> library only supports IPv4 at the moment.
4361
4362 =item B<Port> I<Service>
4363
4364 for Modbus/TCP, specifies the port used to connect to the host. The port can
4365 either be given as a number or as a service name. Please note that the
4366 I<Service> argument must be a string, even if ports are given in their numerical
4367 form. Defaults to "502".
4368
4369 =item B<Device> I<Devicenode>
4370
4371 For Modbus/RTU, specifies the path to the serial device being used.
4372
4373 =item B<Baudrate> I<Baudrate>
4374
4375 For Modbus/RTU, specifies the baud rate of the serial device.
4376 Note, connections currently support only 8/N/1.
4377
4378 =item B<Interval> I<Interval>
4379
4380 Sets the interval (in seconds) in which the values will be collected from this
4381 host. By default the global B<Interval> setting will be used.
4382
4383 =item E<lt>B<Slave> I<ID>E<gt>
4384
4385 Over each connection, multiple Modbus devices may be reached. The slave ID
4386 is used to specify which device should be addressed. For each device you want
4387 to query, one B<Slave> block must be given.
4388
4389 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4390
4391 =over 4
4392
4393 =item B<Instance> I<Instance>
4394
4395 Specify the plugin instance to use when dispatching the values to I<collectd>.
4396 By default "slave_I<ID>" is used.
4397
4398 =item B<Collect> I<DataName>
4399
4400 Specifies which data to retrieve from the device. I<DataName> must be the same
4401 string as the I<Name> argument passed to a B<Data> block. You can specify this
4402 option multiple times to collect more than one value from a slave. At least one
4403 B<Collect> option is mandatory.
4404
4405 =back
4406
4407 =back
4408
4409 =back
4410
4411 =head2 Plugin C<mqtt>
4412
4413 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4414 values from MQTT (B<Subscribe> blocks).
4415
4416 B<Synopsis:>
4417
4418  <Plugin mqtt>
4419    <Publish "name">
4420      Host "mqtt.example.com"
4421      Prefix "collectd"
4422    </Publish>
4423    <Subscribe "name">
4424      Host "mqtt.example.com"
4425      Topic "collectd/#"
4426    </Subscribe>
4427  </Plugin>
4428
4429 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4430 configuring the sending and receiving direction respectively. The plugin will
4431 register a write callback named C<mqtt/I<name>> where I<name> is the string
4432 argument given to the B<Publish> block. Both types of blocks share many but not
4433 all of the following options. If an option is valid in only one of the blocks,
4434 it will be mentioned explicitly.
4435
4436 B<Options:>
4437
4438 =over 4
4439
4440 =item B<Host> I<Hostname>
4441
4442 Hostname of the MQTT broker to connect to.
4443
4444 =item B<Port> I<Service>
4445
4446 Port number or service name of the MQTT broker to connect to.
4447
4448 =item B<User> I<UserName>
4449
4450 Username used when authenticating to the MQTT broker.
4451
4452 =item B<Password> I<Password>
4453
4454 Password used when authenticating to the MQTT broker.
4455
4456 =item B<ClientId> I<ClientId>
4457
4458 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4459
4460 =item B<QoS> [B<0>-B<2>]
4461
4462 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4463
4464 =over 4
4465
4466 =item B<0>
4467
4468 At most once
4469
4470 =item B<1>
4471
4472 At least once
4473
4474 =item B<2>
4475
4476 Exactly once
4477
4478 =back
4479
4480 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4481 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4482 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4483 on a message is larger than the maximum accepted QoS of a subscriber, the
4484 message's QoS will be downgraded.
4485
4486 =item B<Prefix> I<Prefix> (Publish only)
4487
4488 This plugin will use one topic per I<value list> which will looks like a path.
4489 I<Prefix> is used as the first path element and defaults to B<collectd>.
4490
4491 An example topic name would be:
4492
4493  collectd/cpu-0/cpu-user
4494
4495 =item B<Retain> B<false>|B<true> (Publish only)
4496
4497 Controls whether the MQTT broker will retain (keep a copy of) the last message
4498 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4499
4500 =item B<StoreRates> B<true>|B<false> (Publish only)
4501
4502 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4503 before sending. Defaults to B<true>.
4504
4505 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4506
4507 Controls whether the MQTT "cleans" the session up after the subscriber
4508 disconnects or if it maintains the subscriber's subscriptions and all messages
4509 that arrive while the subscriber is disconnected. Defaults to B<true>.
4510
4511 =item B<Topic> I<TopicName> (Subscribe only)
4512
4513 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4514 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4515 the B<collectd> branch.
4516
4517 =item B<CACert> I<file>
4518
4519 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4520 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4521 port of the MQTT broker.
4522 This option enables the use of TLS.
4523
4524 =item B<CertificateFile> I<file>
4525
4526 Path to the PEM-encoded certificate file to use as client certificate when
4527 connecting to the MQTT broker.
4528 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4529
4530 =item B<CertificateKeyFile> I<file>
4531
4532 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4533 Only valid if B<CACert> and B<CertificateFile> are also set.
4534
4535 =item B<TLSProtocol> I<protocol>
4536
4537 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4538 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4539 version is used which depends on the version of OpenSSL the Mosquitto library
4540 was linked against.
4541 Only valid if B<CACert> is set.
4542
4543 =item B<CipherSuite> I<ciphersuite>
4544
4545 A string describing the ciphers available for use. See L<ciphers(1)> and the
4546 C<openssl ciphers> utility for more information. If unset, the default ciphers
4547 will be used.
4548 Only valid if B<CACert> is set.
4549
4550 =back
4551
4552 =head2 Plugin C<mysql>
4553
4554 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4555 one or more databases when started and keeps the connection up as long as
4556 possible. When the connection is interrupted for whatever reason it will try
4557 to re-connect. The plugin will complain loudly in case anything goes wrong.
4558
4559 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4560 and collects information about MySQL network traffic, executed statements,
4561 requests, the query cache and threads by evaluating the
4562 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4563 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4564 Status Variables> for an explanation of these values.
4565
4566 Optionally, master and slave statistics may be collected in a MySQL
4567 replication setup. In that case, information about the synchronization state
4568 of the nodes are collected by evaluating the C<Position> return value of the
4569 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4570 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4571 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4572 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4573 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4574
4575 Synopsis:
4576
4577   <Plugin mysql>
4578     <Database foo>
4579       Host "hostname"
4580       User "username"
4581       Password "password"
4582       Port "3306"
4583       MasterStats true
4584       ConnectTimeout 10
4585       SSLKey "/path/to/key.pem"
4586       SSLCert "/path/to/cert.pem"
4587       SSLCA "/path/to/ca.pem"
4588       SSLCAPath "/path/to/cas/"
4589       SSLCipher "DHE-RSA-AES256-SHA"
4590     </Database>
4591
4592     <Database bar>
4593       Alias "squeeze"
4594       Host "localhost"
4595       Socket "/var/run/mysql/mysqld.sock"
4596       SlaveStats true
4597       SlaveNotifications true
4598     </Database>
4599
4600    <Database galera>
4601       Alias "galera"
4602       Host "localhost"
4603       Socket "/var/run/mysql/mysqld.sock"
4604       WsrepStats true
4605    </Database>
4606   </Plugin>
4607
4608 A B<Database> block defines one connection to a MySQL database. It accepts a
4609 single argument which specifies the name of the database. None of the other
4610 options are required. MySQL will use default values as documented in the
4611 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4612 B<MySQL reference manual>.
4613
4614 =over 4
4615
4616 =item B<Alias> I<Alias>
4617
4618 Alias to use as sender instead of hostname when reporting. This may be useful
4619 when having cryptic hostnames.
4620
4621 =item B<Host> I<Hostname>
4622
4623 Hostname of the database server. Defaults to B<localhost>.
4624
4625 =item B<User> I<Username>
4626
4627 Username to use when connecting to the database. The user does not have to be
4628 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4629 unless you want to collectd replication statistics (see B<MasterStats> and
4630 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4631 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4632
4633 =item B<Password> I<Password>
4634
4635 Password needed to log into the database.
4636
4637 =item B<Database> I<Database>
4638
4639 Select this database. Defaults to I<no database> which is a perfectly reasonable
4640 option for what this plugin does.
4641
4642 =item B<Port> I<Port>
4643
4644 TCP-port to connect to. The port must be specified in its numeric form, but it
4645 must be passed as a string nonetheless. For example:
4646
4647   Port "3306"
4648
4649 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4650 See the documentation for the C<mysql_real_connect> function for details.
4651
4652 =item B<Socket> I<Socket>
4653
4654 Specifies the path to the UNIX domain socket of the MySQL server. This option
4655 only has any effect, if B<Host> is set to B<localhost> (the default).
4656 Otherwise, use the B<Port> option above. See the documentation for the
4657 C<mysql_real_connect> function for details.
4658
4659 =item B<InnodbStats> I<true|false>
4660
4661 If enabled, metrics about the InnoDB storage engine are collected.
4662 Disabled by default.
4663
4664 =item B<MasterStats> I<true|false>
4665
4666 =item B<SlaveStats> I<true|false>
4667
4668 Enable the collection of master / slave statistics in a replication setup. In
4669 order to be able to get access to these statistics, the user needs special
4670 privileges. See the B<User> documentation above. Defaults to B<false>.
4671
4672 =item B<SlaveNotifications> I<true|false>
4673
4674 If enabled, the plugin sends a notification if the replication slave I/O and /
4675 or SQL threads are not running. Defaults to B<false>.
4676
4677 =item B<WsrepStats> I<true|false>
4678
4679  Enable the collection of wsrep plugin statistics, used in Master-Master
4680  replication setups like in MySQL Galera/Percona XtraDB Cluster.
4681  User needs only privileges to execute 'SHOW GLOBAL STATUS'
4682
4683 =item B<ConnectTimeout> I<Seconds>
4684
4685 Sets the connect timeout for the MySQL client.
4686
4687 =item B<SSLKey> I<Path>
4688
4689 If provided, the X509 key in PEM format.
4690
4691 =item B<SSLCert> I<Path>
4692
4693 If provided, the X509 cert in PEM format.
4694
4695 =item B<SSLCA> I<Path>
4696
4697 If provided, the CA file in PEM format (check OpenSSL docs).
4698
4699 =item B<SSLCAPath> I<Path>
4700
4701 If provided, the CA directory (check OpenSSL docs).
4702
4703 =item B<SSLCipher> I<String>
4704
4705 If provided, the SSL cipher to use.
4706
4707 =back
4708
4709 =head2 Plugin C<netapp>
4710
4711 The netapp plugin can collect various performance and capacity information
4712 from a NetApp filer using the NetApp API.
4713
4714 Please note that NetApp has a wide line of products and a lot of different
4715 software versions for each of these products. This plugin was developed for a
4716 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4717 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4718 model and software version but it is very hard to test this.
4719 If you have used this plugin with other models and/or software version, feel
4720 free to send us a mail to tell us about the results, even if it's just a short
4721 "It works".
4722
4723 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4724 basic authentication.
4725
4726 B<Do not use a regular user for this!> Create a special collectd user with just
4727 the minimum of capabilities needed. The user only needs the "login-http-admin"
4728 capability as well as a few more depending on which data will be collected.
4729 Required capabilities are documented below.
4730
4731 =head3 Synopsis
4732
4733  <Plugin "netapp">
4734    <Host "netapp1.example.com">
4735     Protocol      "https"
4736     Address       "10.0.0.1"
4737     Port          443
4738     User          "username"
4739     Password      "aef4Aebe"
4740     Interval      30
4741
4742     <WAFL>
4743       Interval 30
4744       GetNameCache   true
4745       GetDirCache    true
4746       GetBufferCache true
4747       GetInodeCache  true
4748     </WAFL>
4749
4750     <Disks>
4751       Interval 30
4752       GetBusy true
4753     </Disks>
4754
4755     <VolumePerf>
4756       Interval 30
4757       GetIO      "volume0"
4758       IgnoreSelectedIO      false
4759       GetOps     "volume0"
4760       IgnoreSelectedOps     false
4761       GetLatency "volume0"
4762       IgnoreSelectedLatency false
4763     </VolumePerf>
4764
4765     <VolumeUsage>
4766       Interval 30
4767       GetCapacity "vol0"
4768       GetCapacity "vol1"
4769       IgnoreSelectedCapacity false
4770       GetSnapshot "vol1"
4771       GetSnapshot "vol3"
4772       IgnoreSelectedSnapshot false
4773     </VolumeUsage>
4774
4775     <Quota>
4776       Interval 60
4777     </Quota>
4778
4779     <Snapvault>
4780       Interval 30
4781     </Snapvault>
4782
4783     <System>
4784       Interval 30
4785       GetCPULoad     true
4786       GetInterfaces  true
4787       GetDiskOps     true
4788       GetDiskIO      true
4789     </System>
4790
4791     <VFiler vfilerA>
4792       Interval 60
4793
4794       SnapVault true
4795       # ...
4796     </VFiler>
4797    </Host>
4798  </Plugin>
4799
4800 The netapp plugin accepts the following configuration options:
4801
4802 =over 4
4803
4804 =item B<Host> I<Name>
4805
4806 A host block defines one NetApp filer. It will appear in collectd with the name
4807 you specify here which does not have to be its real name nor its hostname (see
4808 the B<Address> option below).
4809
4810 =item B<VFiler> I<Name>
4811
4812 A B<VFiler> block may only be used inside a host block. It accepts all the
4813 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4814 will execute all NetApp API commands in the context of the specified
4815 VFiler(R). It will appear in collectd with the name you specify here which
4816 does not have to be its real name. The VFiler name may be specified using the
4817 B<VFilerName> option. If this is not specified, it will default to the name
4818 you specify here.
4819
4820 The VFiler block inherits all connection related settings from the surrounding
4821 B<Host> block (which appear before the B<VFiler> block) but they may be
4822 overwritten inside the B<VFiler> block.
4823
4824 This feature is useful, for example, when using a VFiler as SnapVault target
4825 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4826 available in the host filer (vfiler0) but only in the respective VFiler
4827 context.
4828
4829 =item B<Protocol> B<httpd>|B<http>
4830
4831 The protocol collectd will use to query this host.
4832
4833 Optional
4834
4835 Type: string
4836
4837 Default: https
4838
4839 Valid options: http, https
4840
4841 =item B<Address> I<Address>
4842
4843 The hostname or IP address of the host.
4844
4845 Optional
4846
4847 Type: string
4848
4849 Default: The "host" block's name.
4850
4851 =item B<Port> I<Port>
4852
4853 The TCP port to connect to on the host.
4854
4855 Optional
4856
4857 Type: integer
4858
4859 Default: 80 for protocol "http", 443 for protocol "https"
4860
4861 =item B<User> I<User>
4862
4863 =item B<Password> I<Password>
4864
4865 The username and password to use to login to the NetApp.
4866
4867 Mandatory
4868
4869 Type: string
4870
4871 =item B<VFilerName> I<Name>
4872
4873 The name of the VFiler in which context to execute API commands. If not
4874 specified, the name provided to the B<VFiler> block will be used instead.
4875
4876 Optional
4877
4878 Type: string
4879
4880 Default: name of the B<VFiler> block
4881
4882 B<Note:> This option may only be used inside B<VFiler> blocks.
4883
4884 =item B<Interval> I<Interval>
4885
4886 B<TODO>
4887
4888 =back
4889
4890 The following options decide what kind of data will be collected. You can
4891 either use them as a block and fine tune various parameters inside this block,
4892 use them as a single statement to just accept all default values, or omit it to
4893 not collect any data.
4894
4895 The following options are valid inside all blocks:
4896
4897 =over 4
4898
4899 =item B<Interval> I<Seconds>
4900
4901 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4902 host specific setting.
4903
4904 =back
4905
4906 =head3 The System block
4907
4908 This will collect various performance data about the whole system.
4909
4910 B<Note:> To get this data the collectd user needs the
4911 "api-perf-object-get-instances" capability.
4912
4913 =over 4
4914
4915 =item B<Interval> I<Seconds>
4916
4917 Collect disk statistics every I<Seconds> seconds.
4918
4919 =item B<GetCPULoad> B<true>|B<false>
4920
4921 If you set this option to true the current CPU usage will be read. This will be
4922 the average usage between all CPUs in your NetApp without any information about
4923 individual CPUs.
4924
4925 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4926 returns in the "CPU" field.
4927
4928 Optional
4929
4930 Type: boolean
4931
4932 Default: true
4933
4934 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4935
4936 =item B<GetInterfaces> B<true>|B<false>
4937
4938 If you set this option to true the current traffic of the network interfaces
4939 will be read. This will be the total traffic over all interfaces of your NetApp
4940 without any information about individual interfaces.
4941
4942 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4943 in the "Net kB/s" field.
4944
4945 B<Or is it?>
4946
4947 Optional
4948
4949 Type: boolean
4950
4951 Default: true
4952
4953 Result: One value list of type "if_octects".
4954
4955 =item B<GetDiskIO> B<true>|B<false>
4956
4957 If you set this option to true the current IO throughput will be read. This
4958 will be the total IO of your NetApp without any information about individual
4959 disks, volumes or aggregates.
4960
4961 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4962 in the "DiskE<nbsp>kB/s" field.
4963
4964 Optional
4965
4966 Type: boolean
4967
4968 Default: true
4969
4970 Result: One value list of type "disk_octets".
4971
4972 =item B<GetDiskOps> B<true>|B<false>
4973
4974 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4975 iSCSI, etc. operations will be read. This will be the total number of
4976 operations on your NetApp without any information about individual volumes or
4977 aggregates.
4978
4979 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4980 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4981
4982 Optional
4983
4984 Type: boolean
4985
4986 Default: true
4987
4988 Result: A variable number of value lists of type "disk_ops_complex". Each type
4989 of operation will result in one value list with the name of the operation as
4990 type instance.
4991
4992 =back
4993
4994 =head3 The WAFL block
4995
4996 This will collect various performance data about the WAFL file system. At the
4997 moment this just means cache performance.
4998
4999 B<Note:> To get this data the collectd user needs the
5000 "api-perf-object-get-instances" capability.
5001
5002 B<Note:> The interface to get these values is classified as "Diagnostics" by
5003 NetApp. This means that it is not guaranteed to be stable even between minor
5004 releases.
5005
5006 =over 4
5007
5008 =item B<Interval> I<Seconds>
5009
5010 Collect disk statistics every I<Seconds> seconds.
5011
5012 =item B<GetNameCache> B<true>|B<false>
5013
5014 Optional
5015
5016 Type: boolean
5017
5018 Default: true
5019
5020 Result: One value list of type "cache_ratio" and type instance
5021 "name_cache_hit".
5022
5023 =item B<GetDirCache> B<true>|B<false>
5024
5025 Optional
5026
5027 Type: boolean
5028
5029 Default: true
5030
5031 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5032
5033 =item B<GetInodeCache> B<true>|B<false>
5034
5035 Optional
5036
5037 Type: boolean
5038
5039 Default: true
5040
5041 Result: One value list of type "cache_ratio" and type instance
5042 "inode_cache_hit".
5043
5044 =item B<GetBufferCache> B<true>|B<false>
5045
5046 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5047 in the "Cache hit" field.
5048
5049 Optional
5050
5051 Type: boolean
5052
5053 Default: true
5054
5055 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5056
5057 =back
5058
5059 =head3 The Disks block
5060
5061 This will collect performance data about the individual disks in the NetApp.
5062
5063 B<Note:> To get this data the collectd user needs the
5064 "api-perf-object-get-instances" capability.
5065
5066 =over 4
5067
5068 =item B<Interval> I<Seconds>
5069
5070 Collect disk statistics every I<Seconds> seconds.
5071
5072 =item B<GetBusy> B<true>|B<false>
5073
5074 If you set this option to true the busy time of all disks will be calculated
5075 and the value of the busiest disk in the system will be written.
5076
5077 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5078 in the "Disk util" field. Probably.
5079
5080 Optional
5081
5082 Type: boolean
5083
5084 Default: true
5085
5086 Result: One value list of type "percent" and type instance "disk_busy".
5087
5088 =back
5089
5090 =head3 The VolumePerf block
5091
5092 This will collect various performance data about the individual volumes.
5093
5094 You can select which data to collect about which volume using the following
5095 options. They follow the standard ignorelist semantic.
5096
5097 B<Note:> To get this data the collectd user needs the
5098 I<api-perf-object-get-instances> capability.
5099
5100 =over 4
5101
5102 =item B<Interval> I<Seconds>
5103
5104 Collect volume performance data every I<Seconds> seconds.
5105
5106 =item B<GetIO> I<Volume>
5107
5108 =item B<GetOps> I<Volume>
5109
5110 =item B<GetLatency> I<Volume>
5111
5112 Select the given volume for IO, operations or latency statistics collection.
5113 The argument is the name of the volume without the C</vol/> prefix.
5114
5115 Since the standard ignorelist functionality is used here, you can use a string
5116 starting and ending with a slash to specify regular expression matching: To
5117 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5118 expression:
5119
5120   GetIO "/^vol[027]$/"
5121
5122 If no regular expression is specified, an exact match is required. Both,
5123 regular and exact matching are case sensitive.
5124
5125 If no volume was specified at all for either of the three options, that data
5126 will be collected for all available volumes.
5127
5128 See F</"IGNORELISTS"> for details.
5129
5130 =item B<IgnoreSelectedIO> B<true>|B<false>
5131
5132 =item B<IgnoreSelectedOps> B<true>|B<false>
5133
5134 =item B<IgnoreSelectedLatency> B<true>|B<false>
5135
5136 When set to B<true>, the volumes selected for IO, operations or latency
5137 statistics collection will be ignored and the data will be collected for all
5138 other volumes.
5139
5140 When set to B<false>, data will only be collected for the specified volumes and
5141 all other volumes will be ignored.
5142
5143 If no volumes have been specified with the above B<Get*> options, all volumes
5144 will be collected regardless of the B<IgnoreSelected*> option.
5145
5146 Defaults to B<false>
5147
5148 =back
5149
5150 =head3 The VolumeUsage block
5151
5152 This will collect capacity data about the individual volumes.
5153
5154 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5155 capability.
5156
5157 =over 4
5158
5159 =item B<Interval> I<Seconds>
5160
5161 Collect volume usage statistics every I<Seconds> seconds.
5162
5163 =item B<GetCapacity> I<VolumeName>
5164
5165 The current capacity of the volume will be collected. This will result in two
5166 to four value lists, depending on the configuration of the volume. All data
5167 sources are of type "df_complex" with the name of the volume as
5168 plugin_instance.
5169
5170 There will be type_instances "used" and "free" for the number of used and
5171 available bytes on the volume.  If the volume has some space reserved for
5172 snapshots, a type_instance "snap_reserved" will be available.  If the volume
5173 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5174 number of bytes saved by the SIS feature.
5175
5176 B<Note:> The current NetApp API has a bug that results in this value being
5177 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5178 number which works most of the time.  If you see strange values here, bug
5179 NetApp support to fix this.
5180
5181 Repeat this option to specify multiple volumes.
5182
5183 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5184
5185 Specify whether to collect only the volumes selected by the B<GetCapacity>
5186 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5187 B<false>. However, if no B<GetCapacity> option is specified at all, all
5188 capacities will be selected anyway.
5189
5190 =item B<GetSnapshot> I<VolumeName>
5191
5192 Select volumes from which to collect snapshot information.
5193
5194 Usually, the space used for snapshots is included in the space reported as
5195 "used". If snapshot information is collected as well, the space used for
5196 snapshots is subtracted from the used space.
5197
5198 To make things even more interesting, it is possible to reserve space to be
5199 used for snapshots. If the space required for snapshots is less than that
5200 reserved space, there is "reserved free" and "reserved used" space in addition
5201 to "free" and "used". If the space required for snapshots exceeds the reserved
5202 space, that part allocated in the normal space is subtracted from the "used"
5203 space again.
5204
5205 Repeat this option to specify multiple volumes.
5206
5207 =item B<IgnoreSelectedSnapshot>
5208
5209 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5210 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5211 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5212 capacities will be selected anyway.
5213
5214 =back
5215
5216 =head3 The Quota block
5217
5218 This will collect (tree) quota statistics (used disk space and number of used
5219 files). This mechanism is useful to get usage information for single qtrees.
5220 In case the quotas are not used for any other purpose, an entry similar to the
5221 following in C</etc/quotas> would be sufficient:
5222
5223   /vol/volA/some_qtree tree - - - - -
5224
5225 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5226
5227 =over 4
5228
5229 =item B<Interval> I<Seconds>
5230
5231 Collect SnapVault(R) statistics every I<Seconds> seconds.
5232
5233 =back
5234
5235 =head3 The SnapVault block
5236
5237 This will collect statistics about the time and traffic of SnapVault(R)
5238 transfers.
5239
5240 =over 4
5241
5242 =item B<Interval> I<Seconds>
5243
5244 Collect SnapVault(R) statistics every I<Seconds> seconds.
5245
5246 =back
5247
5248 =head2 Plugin C<netlink>
5249
5250 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5251 statistics of various interface and routing aspects.
5252
5253 =over 4
5254
5255 =item B<Interface> I<Interface>
5256
5257 =item B<VerboseInterface> I<Interface>
5258
5259 Instruct the plugin to collect interface statistics. This is basically the same
5260 as the statistics provided by the C<interface> plugin (see above) but
5261 potentially much more detailed.
5262
5263 When configuring with B<Interface> only the basic statistics will be collected,
5264 namely octets, packets, and errors. These statistics are collected by
5265 the C<interface> plugin, too, so using both at the same time is no benefit.
5266
5267 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5268 so that no data needs to be collected twice if you use the C<interface> plugin.
5269 This includes dropped packets, received multicast packets, collisions and a
5270 whole zoo of differentiated RX and TX errors. You can try the following command
5271 to get an idea of what awaits you:
5272
5273   ip -s -s link list
5274
5275 If I<Interface> is B<All>, all interfaces will be selected.
5276
5277 =item B<QDisc> I<Interface> [I<QDisc>]
5278
5279 =item B<Class> I<Interface> [I<Class>]
5280
5281 =item B<Filter> I<Interface> [I<Filter>]
5282
5283 Collect the octets and packets that pass a certain qdisc, class or filter.
5284
5285 QDiscs and classes are identified by their type and handle (or classid).
5286 Filters don't necessarily have a handle, therefore the parent's handle is used.
5287 The notation used in collectd differs from that used in tc(1) in that it
5288 doesn't skip the major or minor number if it's zero and doesn't print special
5289 ids by their name. So, for example, a qdisc may be identified by
5290 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5291 thus not displayed by tc(1).
5292
5293 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5294 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5295 associated with that interface will be collected.
5296
5297 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5298 used. This may lead to problems when more than one filter is attached to a
5299 qdisc or class. This isn't nice, but we don't know how this could be done any
5300 better. If you have a idea, please don't hesitate to tell us.
5301
5302 As with the B<Interface> option you can specify B<All> as the interface,
5303 meaning all interfaces.
5304
5305 Here are some examples to help you understand the above text more easily:
5306
5307   <Plugin netlink>
5308     VerboseInterface "All"
5309     QDisc "eth0" "pfifo_fast-1:0"
5310     QDisc "ppp0"
5311     Class "ppp0" "htb-1:10"
5312     Filter "ppp0" "u32-1:0"
5313   </Plugin>
5314
5315 See F</"IGNORELISTS"> for details.
5316
5317 =item B<IgnoreSelected>
5318
5319 The behavior is the same as with all other similar plugins: If nothing is
5320 selected at all, everything is collected. If some things are selected using the
5321 options described above, only these statistics are collected. If you set
5322 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5323 specified statistics will not be collected.
5324
5325 =back
5326
5327 =head2 Plugin C<network>
5328
5329 The Network plugin sends data to a remote instance of collectd, receives data
5330 from a remote instance, or both at the same time. Data which has been received
5331 from the network is usually not transmitted again, but this can be activated, see
5332 the B<Forward> option below.
5333
5334 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5335 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5336
5337 Both, B<Server> and B<Listen> can be used as single option or as block. When
5338 used as block, given options are valid for this socket only. The following
5339 example will export the metrics twice: Once to an "internal" server (without
5340 encryption and signing) and one to an external server (with cryptographic
5341 signature):
5342
5343  <Plugin "network">
5344    # Export to an internal server
5345    # (demonstrates usage without additional options)
5346    Server "collectd.internal.tld"
5347
5348    # Export to an external server
5349    # (demonstrates usage with signature options)
5350    <Server "collectd.external.tld">
5351      SecurityLevel "sign"
5352      Username "myhostname"
5353      Password "ohl0eQue"
5354    </Server>
5355  </Plugin>
5356
5357 =over 4
5358
5359 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5360
5361 The B<Server> statement/block sets the server to send datagrams to. The
5362 statement may occur multiple times to send each datagram to multiple
5363 destinations.
5364
5365 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5366 optional second argument specifies a port number or a service name. If not
5367 given, the default, B<25826>, is used.
5368
5369 The following options are recognized within B<Server> blocks:
5370
5371 =over 4
5372
5373 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5374
5375 Set the security you require for network communication. When the security level
5376 has been set to B<Encrypt>, data sent over the network will be encrypted using
5377 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5378 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5379 authentication code. When set to B<None>, data is sent without any security.
5380
5381 This feature is only available if the I<network> plugin was linked with
5382 I<libgcrypt>.
5383
5384 =item B<Username> I<Username>
5385
5386 Sets the username to transmit. This is used by the server to lookup the
5387 password. See B<AuthFile> below. All security levels except B<None> require
5388 this setting.
5389
5390 This feature is only available if the I<network> plugin was linked with
5391 I<libgcrypt>.
5392
5393 =item B<Password> I<Password>
5394
5395 Sets a password (shared secret) for this socket. All security levels except
5396 B<None> require this setting.
5397
5398 This feature is only available if the I<network> plugin was linked with
5399 I<libgcrypt>.
5400
5401 =item B<Interface> I<Interface name>
5402
5403 Set the outgoing interface for IP packets. This applies at least
5404 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5405 undefined or a non-existent interface name is specified, the default
5406 behavior is to let the kernel choose the appropriate interface. Be warned
5407 that the manual selection of an interface for unicast traffic is only
5408 necessary in rare cases.
5409
5410 =item B<ResolveInterval> I<Seconds>
5411
5412 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5413 useful to force a regular DNS lookup to support a high availability setup. If
5414 not specified, re-resolves are never attempted.
5415
5416 =back
5417
5418 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5419
5420 The B<Listen> statement sets the interfaces to bind to. When multiple
5421 statements are found the daemon will bind to multiple interfaces.
5422
5423 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5424 the argument is a multicast address the daemon will join that multicast group.
5425 The optional second argument specifies a port number or a service name. If not
5426 given, the default, B<25826>, is used.
5427
5428 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5429
5430 =over 4
5431
5432 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5433
5434 Set the security you require for network communication. When the security level
5435 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5436 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5437 signed and encrypted data is accepted. When set to B<None>, all data will be
5438 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5439 decrypted if possible.
5440
5441 This feature is only available if the I<network> plugin was linked with
5442 I<libgcrypt>.
5443
5444 =item B<AuthFile> I<Filename>
5445
5446 Sets a file in which usernames are mapped to passwords. These passwords are
5447 used to verify signatures and to decrypt encrypted network packets. If
5448 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5449 verified and encrypted packets are decrypted. Otherwise, signed data is
5450 accepted without checking the signature and encrypted data cannot be decrypted.
5451 For the other security levels this option is mandatory.
5452
5453 The file format is very simple: Each line consists of a username followed by a
5454 colon and any number of spaces followed by the password. To demonstrate, an
5455 example file could look like this:
5456
5457   user0: foo
5458   user1: bar
5459
5460 Each time a packet is received, the modification time of the file is checked
5461 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5462 the file is being read, it is locked using L<fcntl(2)>.
5463
5464 =item B<Interface> I<Interface name>
5465
5466 Set the incoming interface for IP packets explicitly. This applies at least
5467 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5468 undefined or a non-existent interface name is specified, the default
5469 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5470 traffic gets only accepted, if it arrives on the given interface.
5471
5472 =back
5473
5474 =item B<TimeToLive> I<1-255>
5475
5476 Set the time-to-live of sent packets. This applies to all, unicast and
5477 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5478 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5479 operating systems.
5480
5481 =item B<MaxPacketSize> I<1024-65535>
5482
5483 Set the maximum size for datagrams received over the network. Packets larger
5484 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5485 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5486 UDP.
5487
5488 On the server side, this limit should be set to the largest value used on
5489 I<any> client. Likewise, the value on the client must not be larger than the
5490 value on the server, or data will be lost.
5491
5492 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5493 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5494 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5495 server.
5496
5497 =item B<Forward> I<true|false>
5498
5499 If set to I<true>, write packets that were received via the network plugin to
5500 the sending sockets. This should only be activated when the B<Listen>- and
5501 B<Server>-statements differ. Otherwise packets may be send multiple times to
5502 the same multicast group. While this results in more network traffic than
5503 necessary it's not a huge problem since the plugin has a duplicate detection,
5504 so the values will not loop.
5505
5506 =item B<ReportStats> B<true>|B<false>
5507
5508 The network plugin cannot only receive and send statistics, it can also create
5509 statistics about itself. Collectd data included the number of received and
5510 sent octets and packets, the length of the receive queue and the number of
5511 values handled. When set to B<true>, the I<Network plugin> will make these
5512 statistics available. Defaults to B<false>.
5513
5514 =back
5515
5516 =head2 Plugin C<nfs>
5517
5518 The I<nfs plugin> collects information about the usage of the Network File
5519 System (NFS). It counts the number of procedure calls for each procedure,
5520 grouped by version and whether the system runs as server or client.
5521
5522 It is possibly to omit metrics for a specific NFS version by setting one or
5523 more of the following options to B<false> (all of them default to B<true>).
5524
5525 =over 4
5526
5527 =item B<ReportV2> B<true>|B<false>
5528
5529 =item B<ReportV3> B<true>|B<false>
5530
5531 =item B<ReportV4> B<true>|B<false>
5532
5533 =back
5534
5535 =head2 Plugin C<nginx>
5536
5537 This plugin collects the number of connections and requests handled by the
5538 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5539 queries the page provided by the C<ngx_http_stub_status_module> module, which
5540 isn't compiled by default. Please refer to
5541 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5542 how to compile and configure nginx and this module.
5543
5544 The following options are accepted by the C<nginx plugin>:
5545
5546 =over 4
5547
5548 =item B<URL> I<http://host/nginx_status>
5549
5550 Sets the URL of the C<ngx_http_stub_status_module> output.
5551
5552 =item B<User> I<Username>
5553
5554 Optional user name needed for authentication.
5555
5556 =item B<Password> I<Password>
5557
5558 Optional password needed for authentication.
5559
5560 =item B<VerifyPeer> B<true|false>
5561
5562 Enable or disable peer SSL certificate verification. See
5563 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5564
5565 =item B<VerifyHost> B<true|false>
5566
5567 Enable or disable peer host name verification. If enabled, the plugin checks
5568 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5569 certificate matches the host name provided by the B<URL> option. If this
5570 identity check fails, the connection is aborted. Obviously, only works when
5571 connecting to a SSL enabled server. Enabled by default.
5572
5573 =item B<CACert> I<File>
5574
5575 File that holds one or more SSL certificates. If you want to use HTTPS you will
5576 possibly need this option. What CA certificates come bundled with C<libcurl>
5577 and are checked by default depends on the distribution you use.
5578
5579 =item B<Timeout> I<Milliseconds>
5580
5581 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5582 milliseconds. By default, the configured B<Interval> is used to set the
5583 timeout.
5584
5585 =back
5586
5587 =head2 Plugin C<notify_desktop>
5588
5589 This plugin sends a desktop notification to a notification daemon, as defined
5590 in the Desktop Notification Specification. To actually display the
5591 notifications, B<notification-daemon> is required and B<collectd> has to be
5592 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5593 environment variables have to be set correctly) and the D-Bus message bus.
5594
5595 The Desktop Notification Specification can be found at
5596 L<http://www.galago-project.org/specs/notification/>.
5597
5598 =over 4
5599
5600 =item B<OkayTimeout> I<timeout>
5601
5602 =item B<WarningTimeout> I<timeout>
5603
5604 =item B<FailureTimeout> I<timeout>
5605
5606 Set the I<timeout>, in milliseconds, after which to expire the notification
5607 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5608 been specified, the displayed notification will not be closed at all - the
5609 user has to do so herself. These options default to 5000. If a negative number
5610 has been specified, the default is used as well.
5611
5612 =back
5613
5614 =head2 Plugin C<notify_email>
5615
5616 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5617 configured email address.
5618
5619 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5620
5621 Available configuration options:
5622
5623 =over 4
5624
5625 =item B<From> I<Address>
5626
5627 Email address from which the emails should appear to come from.
5628
5629 Default: C<root@localhost>
5630
5631 =item B<Recipient> I<Address>
5632
5633 Configures the email address(es) to which the notifications should be mailed.
5634 May be repeated to send notifications to multiple addresses.
5635
5636 At least one B<Recipient> must be present for the plugin to work correctly.
5637
5638 =item B<SMTPServer> I<Hostname>
5639
5640 Hostname of the SMTP server to connect to.
5641
5642 Default: C<localhost>
5643
5644 =item B<SMTPPort> I<Port>
5645
5646 TCP port to connect to.
5647
5648 Default: C<25>
5649
5650 =item B<SMTPUser> I<Username>
5651
5652 Username for ASMTP authentication. Optional.
5653
5654 =item B<SMTPPassword> I<Password>
5655
5656 Password for ASMTP authentication. Optional.
5657
5658 =item B<Subject> I<Subject>
5659
5660 Subject-template to use when sending emails. There must be exactly two
5661 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5662 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5663 with the hostname.
5664
5665 Default: C<Collectd notify: %s@%s>
5666
5667 =back
5668
5669 =head2 Plugin C<notify_nagios>
5670
5671 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5672 a I<passive service check result>.
5673
5674 Available configuration options:
5675
5676 =over 4
5677
5678 =item B<CommandFile> I<Path>
5679
5680 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5681
5682 =back
5683
5684 =head2 Plugin C<ntpd>
5685
5686 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5687 dispersion.
5688
5689 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5690 the wire - using B<mode 7> specific requests. This mode is deprecated with
5691 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5692 correctly with them, the ntp daemon must be explicitly configured to
5693 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5694 manual page for details.
5695
5696 Available configuration options for the C<ntpd> plugin:
5697
5698 =over 4
5699
5700 =item B<Host> I<Hostname>
5701
5702 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5703
5704 =item B<Port> I<Port>
5705
5706 UDP-Port to connect to. Defaults to B<123>.
5707
5708 =item B<ReverseLookups> B<true>|B<false>
5709
5710 Sets whether or not to perform reverse lookups on peers. Since the name or
5711 IP-address may be used in a filename it is recommended to disable reverse
5712 lookups. The default is to do reverse lookups to preserve backwards
5713 compatibility, though.
5714
5715 =item B<IncludeUnitID> B<true>|B<false>
5716
5717 When a peer is a refclock, include the unit ID in the I<type instance>.
5718 Defaults to B<false> for backward compatibility.
5719
5720 If two refclock peers use the same driver and this is B<false>, the plugin will
5721 try to write simultaneous measurements from both to the same type instance.
5722 This will result in error messages in the log and only one set of measurements
5723 making it through.
5724
5725 =back
5726
5727 =head2 Plugin C<nut>
5728
5729 =over 4
5730
5731 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5732
5733 Add a UPS to collect data from. The format is identical to the one accepted by
5734 L<upsc(8)>.
5735
5736 =item B<ForceSSL> B<true>|B<false>
5737
5738 Stops connections from falling back to unsecured if an SSL connection
5739 cannot be established. Defaults to false if undeclared.
5740
5741 =item B<VerifyPeer> I<true>|I<false>
5742
5743 If set to true, requires a CAPath be provided. Will use the CAPath to find
5744 certificates to use as Trusted Certificates to validate a upsd server certificate.
5745 If validation of the upsd server certificate fails, the connection will not be
5746 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5747 will override and set ForceSSL to true.
5748
5749 =item B<CAPath> I/path/to/certs/folder
5750
5751 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5752 The folder pointed at must contain certificate(s) named according to their hash.
5753 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5754 occur because two different certs have the same hash value, Y can be  incremented
5755 in order to avoid conflict. To create a symbolic link to a certificate the following
5756 command can be used from within the directory where the cert resides:
5757
5758 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5759
5760 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5761 generate links like the one described above for ALL certs in a given folder.
5762 Example usage:
5763 C<c_rehash /path/to/certs/folder>
5764
5765 =item B<ConnectTimeout> I<Milliseconds>
5766
5767 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5768 By default, the configured B<Interval> is used to set the timeout.
5769
5770 =back
5771
5772 =head2 Plugin C<olsrd>
5773
5774 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5775 the Optimized Link State Routing daemon and reads information about the current
5776 state of the meshed network.
5777
5778 The following configuration options are understood:
5779
5780 =over 4
5781
5782 =item B<Host> I<Host>
5783
5784 Connect to I<Host>. Defaults to B<"localhost">.
5785
5786 =item B<Port> I<Port>
5787
5788 Specifies the port to connect to. This must be a string, even if you give the
5789 port as a number rather than a service name. Defaults to B<"2006">.
5790
5791 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5792
5793 Specifies what information to collect about links, i.E<nbsp>e. direct
5794 connections of the daemon queried. If set to B<No>, no information is
5795 collected. If set to B<Summary>, the number of links and the average of all
5796 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5797 If set to B<Detail> LQ and NLQ are collected per link.
5798
5799 Defaults to B<Detail>.
5800
5801 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5802
5803 Specifies what information to collect about routes of the daemon queried. If
5804 set to B<No>, no information is collected. If set to B<Summary>, the number of
5805 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5806 metric and ETX are collected per route.
5807
5808 Defaults to B<Summary>.
5809
5810 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5811
5812 Specifies what information to collect about the global topology. If set to
5813 B<No>, no information is collected. If set to B<Summary>, the number of links
5814 in the entire topology and the average I<link quality> (LQ) is calculated.
5815 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5816
5817 Defaults to B<Summary>.
5818
5819 =back
5820
5821 =head2 Plugin C<onewire>
5822
5823 B<EXPERIMENTAL!> See notes below.
5824
5825 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5826 L<http://owfs.org/> to read sensors connected via the onewire bus.
5827
5828 It can be used in two possible modes - standard or advanced.
5829
5830 In the standard mode only temperature sensors (sensors with the family code
5831 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5832 other sensors you would like to have included, please send a sort request to
5833 the mailing list. You can select sensors to be read or to be ignored depending
5834 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5835 walked and all sensors are read.
5836
5837 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5838 experimental, below.
5839
5840 In the advanced mode you can configure any sensor to be read (only numerical
5841 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5842 In this mode you have to list all the sensors. Neither default bus walk nor
5843 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5844 the path automatically and should produce compatible structure with the "standard"
5845 mode (basically the path is expected as for example
5846 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5847 "F10FCA000800" and the rest after the slash is considered the type - here
5848 "temperature").
5849 There are two advantages to this mode - you can access virtually any sensor
5850 (not just temperature), select whether to use cached or directly read values
5851 and it is slighlty faster. The downside is more complex configuration.
5852
5853 The two modes are distinguished automatically by the format of the address.
5854 It is not possible to mix the two modes. Once a full path is detected in any
5855 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5856 (and as standard addresses will fail parsing they will be ignored).
5857
5858 =over 4
5859
5860 =item B<Device> I<Device>
5861
5862 Sets the device to read the values from. This can either be a "real" hardware
5863 device, such as a serial port or an USB port, or the address of the
5864 L<owserver(1)> socket, usually B<localhost:4304>.
5865
5866 Though the documentation claims to automatically recognize the given address
5867 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5868 with that version, the following configuration worked for us:
5869
5870   <Plugin onewire>
5871     Device "-s localhost:4304"
5872   </Plugin>
5873
5874 This directive is B<required> and does not have a default value.
5875
5876 =item B<Sensor> I<Sensor>
5877
5878 In the standard mode selects sensors to collect or to ignore
5879 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5880 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5881 and B<not> include the leading C<10.> family byte and point.
5882 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5883 sensors (see above) are read.
5884
5885 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5886 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5887 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5888
5889 As there can be multiple devices on the bus you can list multiple sensor (use
5890 multiple B<Sensor> elements).
5891
5892 See F</"IGNORELISTS"> for details.
5893
5894 =item B<IgnoreSelected> I<true>|I<false>
5895
5896 If no configuration is given, the B<onewire> plugin will collect data from all
5897 sensors found. This may not be practical, especially if sensors are added and
5898 removed regularly. Sometimes, however, it's easier/preferred to collect only
5899 specific sensors or all sensors I<except> a few specified ones. This option
5900 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5901 B<Sensor> is inverted: All selected interfaces are ignored and all other
5902 interfaces are collected.
5903
5904 Used only in the standard mode - see above.
5905
5906 =item B<Interval> I<Seconds>
5907
5908 Sets the interval in which all sensors should be read. If not specified, the
5909 global B<Interval> setting is used.
5910
5911 =back
5912
5913 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5914 work with big setups. It works with one sensor being attached to one
5915 controller, but as soon as you throw in a couple more senors and maybe a hub
5916 or two, reading all values will take more than ten seconds (the default
5917 interval). We will probably add some separate thread for reading the sensors
5918 and some cache or something like that, but it's not done yet. We will try to
5919 maintain backwards compatibility in the future, but we can't promise. So in
5920 short: If it works for you: Great! But keep in mind that the config I<might>
5921 change, though this is unlikely. Oh, and if you want to help improving this
5922 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5923
5924 =head2 Plugin C<openldap>
5925
5926 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5927 server correctly. The backend database C<monitor> needs to be loaded and
5928 working. See slapd-monitor(5) for the details.
5929
5930 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5931 blocks. Each block requires one string argument as the instance name. For
5932 example:
5933
5934  <Plugin "openldap">
5935    <Instance "foo">
5936      URL "ldap://localhost/"
5937    </Instance>
5938    <Instance "bar">
5939      URL "ldaps://localhost/"
5940    </Instance>
5941  </Plugin>
5942
5943 The instance name will be used as the I<plugin instance>. To emulate the old
5944 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5945 plugin to work correctly, each instance name must be unique. This is not
5946 enforced by the plugin and it is your responsibility to ensure it is.
5947
5948 The following options are accepted within each B<Instance> block:
5949
5950 =over 4
5951
5952 =item B<URL> I<ldap://host/binddn>
5953
5954 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5955 I<mandatory>.
5956
5957 =item B<BindDN> I<BindDN>
5958
5959 Name in the form of an LDAP distinguished name intended to be used for
5960 authentication. Defaults to empty string to establish an anonymous authorization.
5961
5962 =item B<Password> I<Password>
5963
5964 Password for simple bind authentication. If this option is not set,
5965 unauthenticated bind operation is used.
5966
5967 =item B<StartTLS> B<true|false>
5968
5969 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5970 Disabled by default.
5971
5972 =item B<VerifyHost> B<true|false>
5973
5974 Enables or disables peer host name verification. If enabled, the plugin checks
5975 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5976 certificate matches the host name provided by the B<URL> option. If this
5977 identity check fails, the connection is aborted. Enabled by default.
5978
5979 =item B<CACert> I<File>
5980
5981 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5982 may possibly need this option. What CA certificates are checked by default
5983 depends on the distribution you use and can be changed with the usual ldap
5984 client configuration mechanisms. See ldap.conf(5) for the details.
5985
5986 =item B<Timeout> I<Seconds>
5987
5988 Sets the timeout value for ldap operations, in seconds. By default, the
5989 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5990 (infinite timeout).
5991
5992 =item B<Version> I<Version>
5993
5994 An integer which sets the LDAP protocol version number to use when connecting
5995 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5996
5997 =back
5998
5999 =head2 Plugin C<openvpn>
6000
6001 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6002 traffic statistics about connected clients.
6003
6004 To set up OpenVPN to write to the status file periodically, use the
6005 B<--status> option of OpenVPN.
6006
6007 So, in a nutshell you need:
6008
6009   openvpn $OTHER_OPTIONS \
6010     --status "/var/run/openvpn-status" 10
6011
6012 Available options:
6013
6014 =over 4
6015
6016 =item B<StatusFile> I<File>
6017
6018 Specifies the location of the status file.
6019
6020 =item B<ImprovedNamingSchema> B<true>|B<false>
6021
6022 When enabled, the filename of the status file will be used as plugin instance
6023 and the client's "common name" will be used as type instance. This is required
6024 when reading multiple status files. Enabling this option is recommended, but to
6025 maintain backwards compatibility this option is disabled by default.
6026
6027 =item B<CollectCompression> B<true>|B<false>
6028
6029 Sets whether or not statistics about the compression used by OpenVPN should be
6030 collected. This information is only available in I<single> mode. Enabled by
6031 default.
6032
6033 =item B<CollectIndividualUsers> B<true>|B<false>
6034
6035 Sets whether or not traffic information is collected for each connected client
6036 individually. If set to false, currently no traffic data is collected at all
6037 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6038
6039 =item B<CollectUserCount> B<true>|B<false>
6040
6041 When enabled, the number of currently connected clients or users is collected.
6042 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6043 can be configured independently from that option. Defaults to B<false>.
6044
6045 =back
6046
6047 =head2 Plugin C<oracle>
6048
6049 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6050 Oracle® Database and lets you execute SQL statements there. It is very similar
6051 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6052 plugin's documentation above for details.
6053
6054   <Plugin oracle>
6055     <Query "out_of_stock">
6056       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6057       <Result>
6058         Type "gauge"
6059         # InstancePrefix "foo"
6060         InstancesFrom "category"
6061         ValuesFrom "value"
6062       </Result>
6063     </Query>
6064     <Database "product_information">
6065       #Plugin "warehouse"
6066       ConnectID "db01"
6067       Username "oracle"
6068       Password "secret"
6069       Query "out_of_stock"
6070     </Database>
6071   </Plugin>
6072
6073 =head3 B<Query> blocks
6074
6075 The Query blocks are handled identically to the Query blocks of the "dbi"
6076 plugin. Please see its documentation above for details on how to specify
6077 queries.
6078
6079 =head3 B<Database> blocks
6080
6081 Database blocks define a connection to a database and which queries should be
6082 sent to that database. Each database needs a "name" as string argument in the
6083 starting tag of the block. This name will be used as "PluginInstance" in the
6084 values submitted to the daemon. Other than that, that name is not used.
6085
6086 =over 4
6087
6088 =item B<Plugin> I<Plugin>
6089
6090 Use I<Plugin> as the plugin name when submitting query results from
6091 this B<Database>. Defaults to C<oracle>.
6092
6093 =item B<ConnectID> I<ID>
6094
6095 Defines the "database alias" or "service name" to connect to. Usually, these
6096 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6097
6098 =item B<Host> I<Host>
6099
6100 Hostname to use when dispatching values for this database. Defaults to using
6101 the global hostname of the I<collectd> instance.
6102
6103 =item B<Username> I<Username>
6104
6105 Username used for authentication.
6106
6107 =item B<Password> I<Password>
6108
6109 Password used for authentication.
6110
6111 =item B<Query> I<QueryName>
6112
6113 Associates the query named I<QueryName> with this database connection. The
6114 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6115 blocks you want to refer to must be placed above the database block you want to
6116 refer to them from.
6117
6118 =back
6119
6120 =head2 Plugin C<ovs_events>
6121
6122 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6123 connected interfaces, dispatches the values to collectd and sends the
6124 notification whenever the link state change occurs. This plugin uses OVS
6125 database to get a link state change notification.
6126
6127 B<Synopsis:>
6128
6129  <Plugin "ovs_events">
6130    Port 6640
6131    Address "127.0.0.1"
6132    Socket "/var/run/openvswitch/db.sock"
6133    Interfaces "br0" "veth0"
6134    SendNotification true
6135    DispatchValues false
6136  </Plugin>
6137
6138 The plugin provides the following configuration options:
6139
6140 =over 4
6141
6142 =item B<Address> I<node>
6143
6144 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6145 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6146 option. See L<ovsdb-server(1)> for more details. The option may be either
6147 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6148 format. Defaults to C<localhost>.
6149
6150 =item B<Port> I<service>
6151
6152 TCP-port to connect to. Either a service name or a port number may be given.
6153 Defaults to B<6640>.
6154
6155 =item B<Socket> I<path>
6156
6157 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6158 plugin. To enable the interface, the OVS DB daemon should be running with
6159 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6160 option is set, B<Address> and B<Port> options are ignored.
6161
6162 =item B<Interfaces> [I<ifname> ...]
6163
6164 List of interface names to be monitored by this plugin. If this option is not
6165 specified or is empty then all OVS connected interfaces on all bridges are
6166 monitored.
6167
6168 Default: empty (all interfaces on all bridges are monitored)
6169
6170 =item B<SendNotification> I<true|false>
6171
6172 If set to true, OVS link notifications (interface status and OVS DB connection
6173 terminate) are sent to collectd. Default value is true.
6174
6175 =item B<DispatchValues> I<true|false>
6176
6177 Dispatch the OVS DB interface link status value with configured plugin interval.
6178 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6179 options are false, no OVS information will be provided by the plugin.
6180
6181 =back
6182
6183 B<Note:> By default, the global interval setting is used within which to
6184 retrieve the OVS link status. To configure a plugin-specific interval, please
6185 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6186 simple divide the time by 1000 for example if the desired interval is 50ms, set
6187 interval to 0.05.
6188
6189 =head2 Plugin C<ovs_stats>
6190
6191 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6192 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6193 statistics from OVSDB
6194
6195 B<Synopsis:>
6196
6197  <Plugin "ovs_stats">
6198    Port 6640
6199    Address "127.0.0.1"
6200    Socket "/var/run/openvswitch/db.sock"
6201    Bridges "br0" "br_ext"
6202  </Plugin>
6203
6204 The plugin provides the following configuration options:
6205
6206 =over 4
6207
6208 =item B<Address> I<node>
6209
6210 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6211 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6212 option. See L<ovsdb-server(1)> for more details. The option may be either
6213 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6214 format. Defaults to C<localhost>.
6215
6216 =item B<Port> I<service>
6217
6218 TCP-port to connect to. Either a service name or a port number may be given.
6219 Defaults to B<6640>.
6220
6221 =item B<Socket> I<path>
6222
6223 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6224 plugin. To enable the interface, the OVS DB daemon should be running with
6225 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6226 option is set, B<Address> and B<Port> options are ignored.
6227
6228 =item B<Bridges> [I<brname> ...]
6229
6230 List of OVS bridge names to be monitored by this plugin. If this option is
6231 omitted or is empty then all OVS bridges will be monitored.
6232
6233 Default: empty (monitor all bridges)
6234
6235 =back
6236
6237 =head2 Plugin C<perl>
6238
6239 This plugin embeds a Perl-interpreter into collectd and provides an interface
6240 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6241
6242 =head2 Plugin C<pinba>
6243
6244 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6245 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6246 PHP-based webpage has been delivered, the extension will send a UDP packet
6247 containing timing information, peak memory usage and so on. The plugin will
6248 wait for such packets, parse them and account the provided information, which
6249 is then dispatched to the daemon once per interval.
6250
6251 Synopsis:
6252
6253  <Plugin pinba>
6254    Address "::0"
6255    Port "30002"
6256    # Overall statistics for the website.
6257    <View "www-total">
6258      Server "www.example.com"
6259    </View>
6260    # Statistics for www-a only
6261    <View "www-a">
6262      Host "www-a.example.com"
6263      Server "www.example.com"
6264    </View>
6265    # Statistics for www-b only
6266    <View "www-b">
6267      Host "www-b.example.com"
6268      Server "www.example.com"
6269    </View>
6270  </Plugin>
6271
6272 The plugin provides the following configuration options:
6273
6274 =over 4
6275
6276 =item B<Address> I<Node>
6277
6278 Configures the address used to open a listening socket. By default, plugin will
6279 bind to the I<any> address C<::0>.
6280
6281 =item B<Port> I<Service>
6282
6283 Configures the port (service) to bind to. By default the default Pinba port
6284 "30002" will be used. The option accepts service names in addition to port
6285 numbers and thus requires a I<string> argument.
6286
6287 =item E<lt>B<View> I<Name>E<gt> block
6288
6289 The packets sent by the Pinba extension include the hostname of the server, the
6290 server name (the name of the virtual host) and the script that was executed.
6291 Using B<View> blocks it is possible to separate the data into multiple groups
6292 to get more meaningful statistics. Each packet is added to all matching groups,
6293 so that a packet may be accounted for more than once.
6294
6295 =over 4
6296
6297 =item B<Host> I<Host>
6298
6299 Matches the hostname of the system the webserver / script is running on. This
6300 will contain the result of the L<gethostname(2)> system call. If not
6301 configured, all hostnames will be accepted.
6302
6303 =item B<Server> I<Server>
6304
6305 Matches the name of the I<virtual host>, i.e. the contents of the
6306 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6307 server names will be accepted.
6308
6309 =item B<Script> I<Script>
6310
6311 Matches the name of the I<script name>, i.e. the contents of the
6312 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6313 script names will be accepted.
6314
6315 =back
6316
6317 =back
6318
6319 =head2 Plugin C<ping>
6320
6321 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6322 configured hosts periodically and measures the network latency. Whenever the
6323 C<read> function of the plugin is called, it submits the average latency, the
6324 standard deviation and the drop rate for each host.
6325
6326 Available configuration options:
6327
6328 =over 4
6329
6330 =item B<Host> I<IP-address>
6331
6332 Host to ping periodically. This option may be repeated several times to ping
6333 multiple hosts.
6334
6335 =item B<Interval> I<Seconds>
6336
6337 Sets the interval in which to send ICMP echo packets to the configured hosts.
6338 This is B<not> the interval in which metrics are read from the plugin but the
6339 interval in which the hosts are "pinged". Therefore, the setting here should be
6340 smaller than or equal to the global B<Interval> setting. Fractional times, such
6341 as "1.24" are allowed.
6342
6343 Default: B<1.0>
6344
6345 =item B<Timeout> I<Seconds>
6346
6347 Time to wait for a response from the host to which an ICMP packet had been
6348 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6349 to be down or the packet to be dropped. This setting must be smaller than the
6350 B<Interval> setting above for the plugin to work correctly. Fractional
6351 arguments are accepted.
6352
6353 Default: B<0.9>
6354
6355 =item B<TTL> I<0-255>
6356
6357 Sets the Time-To-Live of generated ICMP packets.
6358
6359 =item B<Size> I<size>
6360
6361 Sets the size of the data payload in ICMP packet to specified I<size> (it
6362 will be filled with regular ASCII pattern). If not set, default 56 byte
6363 long string is used so that the packet size of an ICMPv4 packet is exactly
6364 64 bytes, similar to the behaviour of normal ping(1) command.
6365
6366 =item B<SourceAddress> I<host>
6367
6368 Sets the source address to use. I<host> may either be a numerical network
6369 address or a network hostname.
6370
6371 =item B<AddressFamily> I<af>
6372
6373 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6374 option will be ignored if you set a B<SourceAddress>.
6375
6376 =item B<Device> I<name>
6377
6378 Sets the outgoing network device to be used. I<name> has to specify an
6379 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6380 operating systems.
6381
6382 =item B<MaxMissed> I<Packets>
6383
6384 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6385 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6386
6387 Default: B<-1> (disabled)
6388
6389 =back
6390
6391 =head2 Plugin C<postgresql>
6392
6393 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6394 keeps a persistent connection to all configured databases and tries to
6395 reconnect if the connection has been interrupted. A database is configured by
6396 specifying a B<Database> block as described below. The default statistics are
6397 collected from PostgreSQL's B<statistics collector> which thus has to be
6398 enabled for this plugin to work correctly. This should usually be the case by
6399 default. See the section "The Statistics Collector" of the B<PostgreSQL
6400 Documentation> for details.
6401
6402 By specifying custom database queries using a B<Query> block as described
6403 below, you may collect any data that is available from some PostgreSQL
6404 database. This way, you are able to access statistics of external daemons
6405 which are available in a PostgreSQL database or use future or special
6406 statistics provided by PostgreSQL without the need to upgrade your collectd
6407 installation.
6408
6409 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6410 PostgreSQL databases as well. This has been implemented in a generic way. You
6411 need to specify an SQL statement which will then be executed by collectd in
6412 order to write the data (see below for details). The benefit of that approach
6413 is that there is no fixed database layout. Rather, the layout may be optimized
6414 for the current setup.
6415
6416 The B<PostgreSQL Documentation> manual can be found at
6417 L<http://www.postgresql.org/docs/manuals/>.
6418
6419   <Plugin postgresql>
6420     <Query magic>
6421       Statement "SELECT magic FROM wizard WHERE host = $1;"
6422       Param hostname
6423       <Result>
6424         Type gauge
6425         InstancePrefix "magic"
6426         ValuesFrom magic
6427       </Result>
6428     </Query>
6429
6430     <Query rt36_tickets>
6431       Statement "SELECT COUNT(type) AS count, type \
6432                         FROM (SELECT CASE \
6433                                      WHEN resolved = 'epoch' THEN 'open' \
6434                                      ELSE 'resolved' END AS type \
6435                                      FROM tickets) type \
6436                         GROUP BY type;"
6437       <Result>
6438         Type counter
6439         InstancePrefix "rt36_tickets"
6440         InstancesFrom "type"
6441         ValuesFrom "count"
6442       </Result>
6443     </Query>
6444
6445     <Writer sqlstore>
6446       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6447       StoreRates true
6448     </Writer>
6449
6450     <Database foo>
6451       Plugin "kingdom"
6452       Host "hostname"
6453       Port "5432"
6454       User "username"
6455       Password "secret"
6456       SSLMode "prefer"
6457       KRBSrvName "kerberos_service_name"
6458       Query magic
6459     </Database>
6460
6461     <Database bar>
6462       Interval 300
6463       Service "service_name"
6464       Query backends # predefined
6465       Query rt36_tickets
6466     </Database>
6467
6468     <Database qux>
6469       # ...
6470       Writer sqlstore
6471       CommitInterval 10
6472     </Database>
6473   </Plugin>
6474
6475 The B<Query> block defines one database query which may later be used by a
6476 database definition. It accepts a single mandatory argument which specifies
6477 the name of the query. The names of all queries have to be unique (see the
6478 B<MinVersion> and B<MaxVersion> options below for an exception to this
6479 rule).
6480
6481 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6482 B<Result> blocks may be used to extract multiple values from a single query.
6483
6484 The following configuration options are available to define the query:
6485
6486 =over 4
6487
6488 =item B<Statement> I<sql query statement>
6489
6490 Specify the I<sql query statement> which the plugin should execute. The string
6491 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6492 first, second, etc. parameter. The value of the parameters is specified by the
6493 B<Param> configuration option - see below for details. To include a literal
6494 B<$> character followed by a number, surround it with single quotes (B<'>).
6495
6496 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6497 allowed. Note, however, that only a single command may be used. Semicolons are
6498 allowed as long as a single non-empty command has been specified only.
6499
6500 The returned lines will be handled separately one after another.
6501
6502 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6503
6504 Specify the parameters which should be passed to the SQL query. The parameters
6505 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6506 they appear in the configuration file. The value of the parameter is
6507 determined depending on the value of the B<Param> option as follows:
6508
6509 =over 4
6510
6511 =item I<hostname>
6512
6513 The configured hostname of the database connection. If a UNIX domain socket is
6514 used, the parameter expands to "localhost".
6515
6516 =item I<database>
6517
6518 The name of the database of the current connection.
6519
6520 =item I<instance>
6521
6522 The name of the database plugin instance. See the B<Instance> option of the
6523 database specification below for details.
6524
6525 =item I<username>
6526
6527 The username used to connect to the database.
6528
6529 =item I<interval>
6530
6531 The interval with which this database is queried (as specified by the database
6532 specific or global B<Interval> options).
6533
6534 =back
6535
6536 Please note that parameters are only supported by PostgreSQL's protocol
6537 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6538
6539 =item B<PluginInstanceFrom> I<column>
6540
6541 Specify how to create the "PluginInstance" for reporting this query results.
6542 Only one column is supported. You may concatenate fields and string values in
6543 the query statement to get the required results.
6544
6545 =item B<MinVersion> I<version>
6546
6547 =item B<MaxVersion> I<version>
6548
6549 Specify the minimum or maximum version of PostgreSQL that this query should be
6550 used with. Some statistics might only be available with certain versions of
6551 PostgreSQL. This allows you to specify multiple queries with the same name but
6552 which apply to different versions, thus allowing you to use the same
6553 configuration in a heterogeneous environment.
6554
6555 The I<version> has to be specified as the concatenation of the major, minor
6556 and patch-level versions, each represented as two-decimal-digit numbers. For
6557 example, version 8.2.3 will become 80203.
6558
6559 =back
6560
6561 The B<Result> block defines how to handle the values returned from the query.
6562 It defines which column holds which value and how to dispatch that value to
6563 the daemon.
6564
6565 =over 4
6566
6567 =item B<Type> I<type>
6568
6569 The I<type> name to be used when dispatching the values. The type describes
6570 how to handle the data and where to store it. See L<types.db(5)> for more
6571 details on types and their configuration. The number and type of values (as
6572 selected by the B<ValuesFrom> option) has to match the type of the given name.
6573
6574 This option is mandatory.
6575
6576 =item B<InstancePrefix> I<prefix>
6577
6578 =item B<InstancesFrom> I<column0> [I<column1> ...]
6579
6580 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6581 B<InstancePrefix> defines a static prefix that will be prepended to all type
6582 instances. B<InstancesFrom> defines the column names whose values will be used
6583 to create the type instance. Multiple values will be joined together using the
6584 hyphen (C<->) as separation character.
6585
6586 The plugin itself does not check whether or not all built instances are
6587 different. It is your responsibility to assure that each is unique.
6588
6589 Both options are optional. If none is specified, the type instance will be
6590 empty.
6591
6592 =item B<ValuesFrom> I<column0> [I<column1> ...]
6593
6594 Names the columns whose content is used as the actual data for the data sets
6595 that are dispatched to the daemon. How many such columns you need is
6596 determined by the B<Type> setting as explained above. If you specify too many
6597 or not enough columns, the plugin will complain about that and no data will be
6598 submitted to the daemon.
6599
6600 The actual data type, as seen by PostgreSQL, is not that important as long as
6601 it represents numbers. The plugin will automatically cast the values to the
6602 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6603 L<strtod(3)> functions, so anything supported by those functions is supported
6604 by the plugin as well.
6605
6606 This option is required inside a B<Result> block and may be specified multiple
6607 times. If multiple B<ValuesFrom> options are specified, the columns are read
6608 in the given order.
6609
6610 =back
6611
6612 The following predefined queries are available (the definitions can be found
6613 in the F<postgresql_default.conf> file which, by default, is available at
6614 C<I<prefix>/share/collectd/>):
6615
6616 =over 4
6617
6618 =item B<backends>
6619
6620 This query collects the number of backends, i.E<nbsp>e. the number of
6621 connected clients.
6622
6623 =item B<transactions>
6624
6625 This query collects the numbers of committed and rolled-back transactions of
6626 the user tables.
6627
6628 =item B<queries>
6629
6630 This query collects the numbers of various table modifications (i.E<nbsp>e.
6631 insertions, updates, deletions) of the user tables.
6632
6633 =item B<query_plans>
6634
6635 This query collects the numbers of various table scans and returned tuples of
6636 the user tables.
6637
6638 =item B<table_states>
6639
6640 This query collects the numbers of live and dead rows in the user tables.
6641
6642 =item B<disk_io>
6643
6644 This query collects disk block access counts for user tables.
6645
6646 =item B<disk_usage>
6647
6648 This query collects the on-disk size of the database in bytes.
6649
6650 =back
6651
6652 In addition, the following detailed queries are available by default. Please
6653 note that each of those queries collects information B<by table>, thus,
6654 potentially producing B<a lot> of data. For details see the description of the
6655 non-by_table queries above.
6656
6657 =over 4
6658
6659 =item B<queries_by_table>
6660
6661 =item B<query_plans_by_table>
6662
6663 =item B<table_states_by_table>
6664
6665 =item B<disk_io_by_table>
6666
6667 =back
6668
6669 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6670 mandatory argument specifying the name of the writer. This will then be used
6671 in the B<Database> specification in order to activate the writer instance. The
6672 names of all writers have to be unique. The following options may be
6673 specified:
6674
6675 =over 4
6676
6677 =item B<Statement> I<sql statement>
6678
6679 This mandatory option specifies the SQL statement that will be executed for
6680 each submitted value. A single SQL statement is allowed only. Anything after
6681 the first semicolon will be ignored.
6682
6683 Nine parameters will be passed to the statement and should be specified as
6684 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6685 values are made available through those parameters:
6686
6687 =over 4
6688
6689 =item B<$1>
6690
6691 The timestamp of the queried value as an RFC 3339-formatted local time.
6692
6693 =item B<$2>
6694
6695 The hostname of the queried value.
6696
6697 =item B<$3>
6698
6699 The plugin name of the queried value.
6700
6701 =item B<$4>
6702
6703 The plugin instance of the queried value. This value may be B<NULL> if there
6704 is no plugin instance.
6705
6706 =item B<$5>
6707
6708 The type of the queried value (cf. L<types.db(5)>).
6709
6710 =item B<$6>
6711
6712 The type instance of the queried value. This value may be B<NULL> if there is
6713 no type instance.
6714
6715 =item B<$7>
6716
6717 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6718 sources of the submitted value-list).
6719
6720 =item B<$8>
6721
6722 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6723 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6724 B<StoreRates> is enabled (which is the default, see below), all types will be
6725 C<gauge>.
6726
6727 =item B<$9>
6728
6729 An array of the submitted values. The dimensions of the value name and value
6730 arrays match.
6731
6732 =back
6733
6734 In general, it is advisable to create and call a custom function in the
6735 PostgreSQL database for this purpose. Any procedural language supported by
6736 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6737 for details).
6738
6739 =item B<StoreRates> B<false>|B<true>
6740
6741 If set to B<true> (the default), convert counter values to rates. If set to
6742 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6743 number.
6744
6745 =back
6746
6747 The B<Database> block defines one PostgreSQL database for which to collect
6748 statistics. It accepts a single mandatory argument which specifies the
6749 database name. None of the other options are required. PostgreSQL will use
6750 default values as documented in the section "CONNECTING TO A DATABASE" in the
6751 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6752 the user collectd is run as and special environment variables. See the manpage
6753 for details.
6754
6755 =over 4
6756
6757 =item B<Interval> I<seconds>
6758
6759 Specify the interval with which the database should be queried. The default is
6760 to use the global B<Interval> setting.
6761
6762 =item B<CommitInterval> I<seconds>
6763
6764 This option may be used for database connections which have "writers" assigned
6765 (see above). If specified, it causes a writer to put several updates into a
6766 single transaction. This transaction will last for the specified amount of
6767 time. By default, each update will be executed in a separate transaction. Each
6768 transaction generates a fair amount of overhead which can, thus, be reduced by
6769 activating this option. The draw-back is, that data covering the specified
6770 amount of time will be lost, for example, if a single statement within the
6771 transaction fails or if the database server crashes.
6772
6773 =item B<Plugin> I<Plugin>
6774
6775 Use I<Plugin> as the plugin name when submitting query results from
6776 this B<Database>. Defaults to C<postgresql>.
6777
6778 =item B<Instance> I<name>
6779
6780 Specify the plugin instance name that should be used instead of the database
6781 name (which is the default, if this option has not been specified). This
6782 allows one to query multiple databases of the same name on the same host (e.g.
6783 when running multiple database server versions in parallel).
6784 The plugin instance name can also be set from the query result using
6785 the B<PluginInstanceFrom> option in B<Query> block.
6786
6787 =item B<Host> I<hostname>
6788
6789 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6790 value begins with a slash, it is interpreted as the directory name in which to
6791 look for the UNIX domain socket.
6792
6793 This option is also used to determine the hostname that is associated with a
6794 collected data set. If it has been omitted or either begins with with a slash
6795 or equals B<localhost> it will be replaced with the global hostname definition
6796 of collectd. Any other value will be passed literally to collectd when
6797 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6798
6799 =item B<Port> I<port>
6800
6801 Specify the TCP port or the local UNIX domain socket file extension of the
6802 server.
6803
6804 =item B<User> I<username>
6805
6806 Specify the username to be used when connecting to the server.
6807
6808 =item B<Password> I<password>
6809
6810 Specify the password to be used when connecting to the server.
6811
6812 =item B<ExpireDelay> I<delay>
6813
6814 Skip expired values in query output.
6815
6816 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6817
6818 Specify whether to use an SSL connection when contacting the server. The
6819 following modes are supported:
6820
6821 =over 4
6822
6823 =item I<disable>
6824
6825 Do not use SSL at all.
6826
6827 =item I<allow>
6828
6829 First, try to connect without using SSL. If that fails, try using SSL.
6830
6831 =item I<prefer> (default)
6832
6833 First, try to connect using SSL. If that fails, try without using SSL.
6834
6835 =item I<require>
6836
6837 Use SSL only.
6838
6839 =back
6840
6841 =item B<Instance> I<name>
6842
6843 Specify the plugin instance name that should be used instead of the database
6844 name (which is the default, if this option has not been specified). This
6845 allows one to query multiple databases of the same name on the same host (e.g.
6846 when running multiple database server versions in parallel).
6847
6848 =item B<KRBSrvName> I<kerberos_service_name>
6849
6850 Specify the Kerberos service name to use when authenticating with Kerberos 5
6851 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6852 B<PostgreSQL Documentation> for details.
6853
6854 =item B<Service> I<service_name>
6855
6856 Specify the PostgreSQL service name to use for additional parameters. That
6857 service has to be defined in F<pg_service.conf> and holds additional
6858 connection parameters. See the section "The Connection Service File" in the
6859 B<PostgreSQL Documentation> for details.
6860
6861 =item B<Query> I<query>
6862
6863 Specifies a I<query> which should be executed in the context of the database
6864 connection. This may be any of the predefined or user-defined queries. If no
6865 such option is given, it defaults to "backends", "transactions", "queries",
6866 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6867 has been specified). Else, the specified queries are used only.
6868
6869 =item B<Writer> I<writer>
6870
6871 Assigns the specified I<writer> backend to the database connection. This
6872 causes all collected data to be send to the database using the settings
6873 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6874 below for details on how to selectively send data to certain plugins).
6875
6876 Each writer will register a flush callback which may be used when having long
6877 transactions enabled (see the B<CommitInterval> option above). When issuing
6878 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6879 transaction will be committed right away. Two different kinds of flush
6880 callbacks are available with the C<postgresql> plugin:
6881
6882 =over 4
6883
6884 =item B<postgresql>
6885
6886 Flush all writer backends.
6887
6888 =item B<postgresql->I<database>
6889
6890 Flush all writers of the specified I<database> only.
6891
6892 =back
6893
6894 =back
6895
6896 =head2 Plugin C<powerdns>
6897
6898 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6899 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6900 values, many of which are probably meaningless to most users, but may be useful
6901 for some. So you may chose which values to collect, but if you don't, some
6902 reasonable defaults will be collected.
6903
6904   <Plugin "powerdns">
6905     <Server "server_name">
6906       Collect "latency"
6907       Collect "udp-answers" "udp-queries"
6908       Socket "/var/run/pdns.controlsocket"
6909     </Server>
6910     <Recursor "recursor_name">
6911       Collect "questions"
6912       Collect "cache-hits" "cache-misses"
6913       Socket "/var/run/pdns_recursor.controlsocket"
6914     </Recursor>
6915     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6916   </Plugin>
6917
6918 =over 4
6919
6920 =item B<Server> and B<Recursor> block
6921
6922 The B<Server> block defines one authoritative server to query, the B<Recursor>
6923 does the same for an recursing server. The possible options in both blocks are
6924 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6925 and is required.
6926
6927 =over 4
6928
6929 =item B<Collect> I<Field>
6930
6931 Using the B<Collect> statement you can select which values to collect. Here,
6932 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6933 C<dlg-only-drops>, C<answers10-100>.
6934
6935 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6936 When querying the server a C<SHOW *> command is issued in any case, because
6937 that's the only way of getting multiple values out of the server at once.
6938 collectd then picks out the values you have selected. When querying the
6939 recursor, a command is generated to query exactly these values. So if you
6940 specify invalid fields when querying the recursor, a syntax error may be
6941 returned by the daemon and collectd may not collect any values at all.
6942
6943 If no B<Collect> statement is given, the following B<Server> values will be
6944 collected:
6945
6946 =over 4
6947
6948 =item latency
6949
6950 =item packetcache-hit
6951
6952 =item packetcache-miss
6953
6954 =item packetcache-size
6955
6956 =item query-cache-hit
6957
6958 =item query-cache-miss
6959
6960 =item recursing-answers
6961
6962 =item recursing-questions
6963
6964 =item tcp-answers
6965
6966 =item tcp-queries
6967
6968 =item udp-answers
6969
6970 =item udp-queries
6971
6972 =back
6973
6974 The following B<Recursor> values will be collected by default:
6975
6976 =over 4
6977
6978 =item noerror-answers
6979
6980 =item nxdomain-answers
6981
6982 =item servfail-answers
6983
6984 =item sys-msec
6985
6986 =item user-msec
6987
6988 =item qa-latency
6989
6990 =item cache-entries
6991
6992 =item cache-hits
6993
6994 =item cache-misses
6995
6996 =item questions
6997
6998 =back
6999
7000 Please note that up to that point collectd doesn't know what values are
7001 available on the server and values that are added do not need a change of the
7002 mechanism so far. However, the values must be mapped to collectd's naming
7003 scheme, which is done using a lookup table that lists all known values. If
7004 values are added in the future and collectd does not know about them, you will
7005 get an error much like this:
7006
7007   powerdns plugin: submit: Not found in lookup table: foobar = 42
7008
7009 In this case please file a bug report with the collectd team.
7010
7011 =item B<Socket> I<Path>
7012
7013 Configures the path to the UNIX domain socket to be used when connecting to the
7014 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7015 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7016 will be used for the recursor.
7017
7018 =back
7019
7020 =item B<LocalSocket> I<Path>
7021
7022 Querying the recursor is done using UDP. When using UDP over UNIX domain
7023 sockets, the client socket needs a name in the file system, too. You can set
7024 this local name to I<Path> using the B<LocalSocket> option. The default is
7025 C<I<prefix>/var/run/collectd-powerdns>.
7026
7027 =back
7028
7029 =head2 Plugin C<processes>
7030
7031 Collects information about processes of local system.
7032
7033 By default, with no process matches configured, only general statistics is
7034 collected: the number of processes in each state and fork rate.
7035
7036 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7037 These may also be a block in which further options may be specified.
7038
7039 The statistics collected for matched processes are:
7040  - size of the resident segment size (RSS)
7041  - user- and system-time used
7042  - number of processes
7043  - number of threads
7044  - number of open files (under Linux)
7045  - number of memory mapped files (under Linux)
7046  - io data (where available)
7047  - context switches (under Linux)
7048  - minor and major pagefaults
7049  - Delay Accounting information (Linux only, requires libmnl)
7050
7051 B<Synopsis:>
7052
7053  <Plugin processes>
7054    CollectFileDescriptor  true
7055    CollectContextSwitch   true
7056    CollectDelayAccounting false
7057    Process "name"
7058    ProcessMatch "name" "regex"
7059    <Process "collectd">
7060      CollectFileDescriptor  false
7061      CollectContextSwitch   false
7062      CollectDelayAccounting true
7063    </Process>
7064    <ProcessMatch "name" "regex">
7065      CollectFileDescriptor false
7066      CollectContextSwitch true
7067    </ProcessMatch>
7068  </Plugin>
7069
7070 =over 4
7071
7072 =item B<Process> I<Name>
7073
7074 Select more detailed statistics of processes matching this name.
7075
7076 Some platforms have a limit on the length of process names.
7077 I<Name> must stay below this limit.
7078
7079 =item B<ProcessMatch> I<name> I<regex>
7080
7081 Select more detailed statistics of processes matching the specified I<regex>
7082 (see L<regex(7)> for details). The statistics of all matching processes are
7083 summed up and dispatched to the daemon using the specified I<name> as an
7084 identifier. This allows one to "group" several processes together.
7085 I<name> must not contain slashes.
7086
7087 =item B<CollectContextSwitch> I<Boolean>
7088
7089 Collect the number of context switches for matched processes.
7090 Disabled by default.
7091
7092 =item B<CollectDelayAccounting> I<Boolean>
7093
7094 If enabled, collect Linux Delay Accounding information for matching processes.
7095 Delay Accounting provides the time processes wait for the CPU to become
7096 available, for I/O operations to finish, for pages to be swapped in and for
7097 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7098 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7099 Disabled by default.
7100
7101 This option is only available on Linux, requires the C<libmnl> library and
7102 requires the C<CAP_NET_ADMIN> capability at runtime.
7103
7104 =item B<CollectFileDescriptor> I<Boolean>
7105
7106 Collect number of file descriptors of matched processes.
7107 Disabled by default.
7108
7109 =item B<CollectMemoryMaps> I<Boolean>
7110
7111 Collect the number of memory mapped files of the process.
7112 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7113 the Linux kernel.
7114
7115 =back
7116
7117 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7118 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7119 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7120 reporting the corresponding processes only. Outside of B<Process> and
7121 B<ProcessMatch> blocks these options set the default value for subsequent
7122 matches.
7123
7124 =head2 Plugin C<protocols>
7125
7126 Collects a lot of information about various network protocols, such as I<IP>,
7127 I<TCP>, I<UDP>, etc.
7128
7129 Available configuration options:
7130
7131 =over 4
7132
7133 =item B<Value> I<Selector>
7134
7135 Selects whether or not to select a specific value. The string being matched is
7136 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7137 plugin instance and I<ValueName> will be used as type instance. An example of
7138 the string being used would be C<Tcp:RetransSegs>.
7139
7140 You can use regular expressions to match a large number of values with just one
7141 configuration option. To select all "extended" I<TCP> values, you could use the
7142 following statement:
7143
7144   Value "/^TcpExt:/"
7145
7146 Whether only matched values are selected or all matched values are ignored
7147 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7148 If no value is configured at all, all values will be selected.
7149
7150 See F</"IGNORELISTS"> for details.
7151
7152 =item B<IgnoreSelected> B<true>|B<false>
7153
7154 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7155 matching values will be ignored.
7156
7157 =back
7158
7159 =head2 Plugin C<python>
7160
7161 This plugin embeds a Python-interpreter into collectd and provides an interface
7162 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7163
7164 =head2 Plugin C<routeros>
7165
7166 The C<routeros> plugin connects to a device running I<RouterOS>, the
7167 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7168 I<librouteros> to connect and reads information about the interfaces and
7169 wireless connections of the device. The configuration supports querying
7170 multiple routers:
7171
7172   <Plugin "routeros">
7173     <Router>
7174       Host "router0.example.com"
7175       User "collectd"
7176       Password "secr3t"
7177       CollectInterface true
7178       CollectCPULoad true
7179       CollectMemory true
7180     </Router>
7181     <Router>
7182       Host "router1.example.com"
7183       User "collectd"
7184       Password "5ecret"
7185       CollectInterface true
7186       CollectRegistrationTable true
7187       CollectDF true
7188       CollectDisk true
7189     </Router>
7190   </Plugin>
7191
7192 As you can see above, the configuration of the I<routeros> plugin consists of
7193 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7194 options are understood:
7195
7196 =over 4
7197
7198 =item B<Host> I<Host>
7199
7200 Hostname or IP-address of the router to connect to.
7201
7202 =item B<Port> I<Port>
7203
7204 Port name or port number used when connecting. If left unspecified, the default
7205 will be chosen by I<librouteros>, currently "8728". This option expects a
7206 string argument, even when a numeric port number is given.
7207
7208 =item B<User> I<User>
7209
7210 Use the user name I<User> to authenticate. Defaults to "admin".
7211
7212 =item B<Password> I<Password>
7213
7214 Set the password used to authenticate.
7215
7216 =item B<CollectInterface> B<true>|B<false>
7217
7218 When set to B<true>, interface statistics will be collected for all interfaces
7219 present on the device. Defaults to B<false>.
7220
7221 =item B<CollectRegistrationTable> B<true>|B<false>
7222
7223 When set to B<true>, information about wireless LAN connections will be
7224 collected. Defaults to B<false>.
7225
7226 =item B<CollectCPULoad> B<true>|B<false>
7227
7228 When set to B<true>, information about the CPU usage will be collected. The
7229 number is a dimensionless value where zero indicates no CPU usage at all.
7230 Defaults to B<false>.
7231
7232 =item B<CollectMemory> B<true>|B<false>
7233
7234 When enabled, the amount of used and free memory will be collected. How used
7235 memory is calculated is unknown, for example whether or not caches are counted
7236 as used space.
7237 Defaults to B<false>.
7238
7239 =item B<CollectDF> B<true>|B<false>
7240
7241 When enabled, the amount of used and free disk space will be collected.
7242 Defaults to B<false>.
7243
7244 =item B<CollectDisk> B<true>|B<false>
7245
7246 When enabled, the number of sectors written and bad blocks will be collected.
7247 Defaults to B<false>.
7248
7249 =back
7250
7251 =head2 Plugin C<redis>
7252
7253 The I<Redis plugin> connects to one or more Redis servers and gathers
7254 information about each server's state. For each server there is a I<Node> block
7255 which configures the connection parameters for this node.
7256
7257   <Plugin redis>
7258     <Node "example">
7259         Host "localhost"
7260         Port "6379"
7261         Timeout 2000
7262         <Query "LLEN myqueue">
7263           Type "queue_length"
7264           Instance "myqueue"
7265         <Query>
7266     </Node>
7267   </Plugin>
7268
7269 The information shown in the synopsis above is the I<default configuration>
7270 which is used by the plugin if no configuration is present.
7271
7272 =over 4
7273
7274 =item B<Node> I<Nodename>
7275
7276 The B<Node> block identifies a new Redis node, that is a new Redis instance
7277 running in an specified host and port. The name for node is a canonical
7278 identifier which is used as I<plugin instance>. It is limited to
7279 64E<nbsp>characters in length.
7280
7281 =item B<Host> I<Hostname>
7282
7283 The B<Host> option is the hostname or IP-address where the Redis instance is
7284 running on.
7285
7286 =item B<Port> I<Port>
7287
7288 The B<Port> option is the TCP port on which the Redis instance accepts
7289 connections. Either a service name of a port number may be given. Please note
7290 that numerical port numbers must be given as a string, too.
7291
7292 =item B<Password> I<Password>
7293
7294 Use I<Password> to authenticate when connecting to I<Redis>.
7295
7296 =item B<Timeout> I<Milliseconds>
7297
7298 The B<Timeout> option set the socket timeout for node response. Since the Redis
7299 read function is blocking, you should keep this value as low as possible. Keep
7300 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
7301 than B<Interval> defined globally.
7302
7303 =item B<Query> I<Querystring>
7304
7305 The B<Query> block identifies a query to execute against the redis server.
7306 There may be an arbitrary number of queries to execute.
7307
7308 =item B<Type> I<Collectd type>
7309
7310 Within a query definition, a valid collectd type to use as when submitting
7311 the result of the query. When not supplied, will default to B<gauge>.
7312
7313 =item B<Instance> I<Type instance>
7314
7315 Within a query definition, an optional type instance to use when submitting
7316 the result of the query. When not supplied will default to the escaped
7317 command, up to 64 chars.
7318
7319 =back
7320
7321 =head2 Plugin C<rrdcached>
7322
7323 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7324 to store values to RRD files in an efficient manner. The combination of the
7325 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7326 way the C<rrdtool> plugin works (see below). The added abstraction layer
7327 provides a number of benefits, though: Because the cache is not within
7328 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7329 restarted. This results in much shorter (if any) gaps in graphs, especially
7330 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7331 daemon so that it can flush values to disk automatically when needed. This
7332 allows one to integrate automated flushing of values into graphing solutions
7333 much more easily.
7334
7335 There are disadvantages, though: The daemon may reside on a different host, so
7336 it may not be possible for C<collectd> to create the appropriate RRD files
7337 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7338 different base directory, so relative paths may do weird stuff if you're not
7339 careful.
7340
7341 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7342 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7343 setting should be set to an absolute path, so that a changed base directory
7344 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7345
7346 =over 4
7347
7348 =item B<DaemonAddress> I<Address>
7349
7350 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7351 library. See L<rrdcached(1)> for details. Example:
7352
7353   <Plugin "rrdcached">
7354     DaemonAddress "unix:/var/run/rrdcached.sock"
7355   </Plugin>
7356
7357 =item B<DataDir> I<Directory>
7358
7359 Set the base directory in which the RRD files reside. If this is a relative
7360 path, it is relative to the working base directory of the C<rrdcached> daemon!
7361 Use of an absolute path is recommended.
7362
7363 =item B<CreateFiles> B<true>|B<false>
7364
7365 Enables or disables the creation of RRD files. If the daemon is not running
7366 locally, or B<DataDir> is set to a relative path, this will not work as
7367 expected. Default is B<true>.
7368
7369 =item B<CreateFilesAsync> B<false>|B<true>
7370
7371 When enabled, new RRD files are enabled asynchronously, using a separate thread
7372 that runs in the background. This prevents writes to block, which is a problem
7373 especially when many hundreds of files need to be created at once. However,
7374 since the purpose of creating the files asynchronously is I<not> to block until
7375 the file is available, values before the file is available will be discarded.
7376 When disabled (the default) files are created synchronously, blocking for a
7377 short while, while the file is being written.
7378
7379 =item B<StepSize> I<Seconds>
7380
7381 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7382 this setting is unset and the stepsize is set to the interval in which the data
7383 is collected. Do not use this option unless you absolutely have to for some
7384 reason. Setting this option may cause problems with the C<snmp plugin>, the
7385 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7386
7387 =item B<HeartBeat> I<Seconds>
7388
7389 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7390 in which case the heartbeat is set to twice the B<StepSize> which should equal
7391 the interval in which data is collected. Do not set this option unless you have
7392 a very good reason to do so.
7393
7394 =item B<RRARows> I<NumRows>
7395
7396 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7397 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7398 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7399 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7400 week, one month, and one year.
7401
7402 So for each timespan, it calculates how many PDPs need to be consolidated into
7403 one CDP by calculating:
7404   number of PDPs = timespan / (stepsize * rrarows)
7405
7406 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7407 default is 1200.
7408
7409 =item B<RRATimespan> I<Seconds>
7410
7411 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7412 more then one RRA. If this option is never used, the built-in default of (3600,
7413 86400, 604800, 2678400, 31622400) is used.
7414
7415 For more information on how RRA-sizes are calculated see B<RRARows> above.
7416
7417 =item B<XFF> I<Factor>
7418
7419 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7420 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7421 one (exclusive).
7422
7423 =item B<CollectStatistics> B<false>|B<true>
7424
7425 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7426 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7427
7428 Statistics are read via I<rrdcached>s socket using the STATS command.
7429 See L<rrdcached(1)> for details.
7430
7431 =back
7432
7433 =head2 Plugin C<rrdtool>
7434
7435 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7436 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7437 using these settings. If you don't want to dive into the depths of RRDtool, you
7438 can safely ignore these settings.
7439
7440 =over 4
7441
7442 =item B<DataDir> I<Directory>
7443
7444 Set the directory to store RRD files under. By default RRD files are generated
7445 beneath the daemon's working directory, i.e. the B<BaseDir>.
7446
7447 =item B<CreateFilesAsync> B<false>|B<true>
7448
7449 When enabled, new RRD files are enabled asynchronously, using a separate thread
7450 that runs in the background. This prevents writes to block, which is a problem
7451 especially when many hundreds of files need to be created at once. However,
7452 since the purpose of creating the files asynchronously is I<not> to block until
7453 the file is available, values before the file is available will be discarded.
7454 When disabled (the default) files are created synchronously, blocking for a
7455 short while, while the file is being written.
7456
7457 =item B<StepSize> I<Seconds>
7458
7459 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7460 this setting is unset and the stepsize is set to the interval in which the data
7461 is collected. Do not use this option unless you absolutely have to for some
7462 reason. Setting this option may cause problems with the C<snmp plugin>, the
7463 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7464
7465 =item B<HeartBeat> I<Seconds>
7466
7467 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7468 in which case the heartbeat is set to twice the B<StepSize> which should equal
7469 the interval in which data is collected. Do not set this option unless you have
7470 a very good reason to do so.
7471
7472 =item B<RRARows> I<NumRows>
7473
7474 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7475 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7476 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7477 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7478 week, one month, and one year.
7479
7480 So for each timespan, it calculates how many PDPs need to be consolidated into
7481 one CDP by calculating:
7482   number of PDPs = timespan / (stepsize * rrarows)
7483
7484 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7485 default is 1200.
7486
7487 =item B<RRATimespan> I<Seconds>
7488
7489 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7490 more then one RRA. If this option is never used, the built-in default of (3600,
7491 86400, 604800, 2678400, 31622400) is used.
7492
7493 For more information on how RRA-sizes are calculated see B<RRARows> above.
7494
7495 =item B<XFF> I<Factor>
7496
7497 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7498 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7499 one (exclusive).
7500
7501 =item B<CacheFlush> I<Seconds>
7502
7503 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7504 it writes all values for a certain RRD-file if the oldest value is older than
7505 (or equal to) the number of seconds specified by B<CacheTimeout>.
7506 That check happens on new values arriwal. If some RRD-file is not updated
7507 anymore for some reason (the computer was shut down, the network is broken,
7508 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7509 every I<Seconds> seconds the entire cache is searched for entries older than
7510 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7511 disk. Since scanning the entire cache is kind of expensive and does nothing
7512 under normal circumstances, this value should not be too small. 900 seconds
7513 might be a good value, though setting this to 7200 seconds doesn't normally
7514 do much harm either.
7515
7516 Defaults to 10x B<CacheTimeout>.
7517 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7518 above default is used.
7519
7520 =item B<CacheTimeout> I<Seconds>
7521
7522 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7523 save values in a cache, as described above. Writing multiple values at once
7524 reduces IO-operations and thus lessens the load produced by updating the files.
7525 The trade off is that the graphs kind of "drag behind" and that more memory is
7526 used.
7527
7528 =item B<WritesPerSecond> I<Updates>
7529
7530 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7531 will run serious performance problems. The B<CacheFlush> setting and the
7532 internal update queue assert that collectd continues to work just fine even
7533 under heavy load, but the system may become very unresponsive and slow. This is
7534 a problem especially if you create graphs from the RRD files on the same
7535 machine, for example using the C<graph.cgi> script included in the
7536 C<contrib/collection3/> directory.
7537
7538 This setting is designed for very large setups. Setting this option to a value
7539 between 25 and 80 updates per second, depending on your hardware, will leave
7540 the server responsive enough to draw graphs even while all the cached values
7541 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7542 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7543 written as fast as possible, so that web frontends have up to date data when
7544 generating graphs.
7545
7546 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7547 updates per second, writing all values to disk will take approximately
7548 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7549 "collection3" you'll end up with a responsive and fast system, up to date
7550 graphs and basically a "backup" of your values every hour.
7551
7552 =item B<RandomTimeout> I<Seconds>
7553
7554 When set, the actual timeout for each value is chosen randomly between
7555 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7556 intention is to avoid high load situations that appear when many values timeout
7557 at the same time. This is especially a problem shortly after the daemon starts,
7558 because all values were added to the internal cache at roughly the same time.
7559
7560 =back
7561
7562 =head2 Plugin C<sensors>
7563
7564 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7565 that all the needed modules have to be loaded and lm_sensors has to be
7566 configured (most likely by editing F</etc/sensors.conf>. Read
7567 L<sensors.conf(5)> for details.
7568
7569 The B<lm_sensors> homepage can be found at
7570 L<http://secure.netroedge.com/~lm78/>.
7571
7572 =over 4
7573
7574 =item B<SensorConfigFile> I<File>
7575
7576 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7577 the library's default will be used.
7578
7579 =item B<Sensor> I<chip-bus-address/type-feature>
7580
7581 Selects the name of the sensor which you want to collect or ignore, depending
7582 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7583 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7584 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7585
7586 See F</"IGNORELISTS"> for details.
7587
7588 =item B<IgnoreSelected> I<true>|I<false>
7589
7590 If no configuration if given, the B<sensors>-plugin will collect data from all
7591 sensors. This may not be practical, especially for uninteresting sensors.
7592 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7593 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7594 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7595 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7596 and all other sensors are collected.
7597
7598 =item B<UseLabels> I<true>|I<false>
7599
7600 Configures how sensor readings are reported. When set to I<true>, sensor
7601 readings are reported using their descriptive label (e.g. "VCore"). When set to
7602 I<false> (the default) the sensor name is used ("in0").
7603
7604 =back
7605
7606 =head2 Plugin C<sigrok>
7607
7608 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7609 supported by the L<sigrok|http://sigrok.org/> project.
7610
7611 B<Synopsis>
7612
7613  <Plugin sigrok>
7614    LogLevel 3
7615    <Device "AC Voltage">
7616       Driver "fluke-dmm"
7617       MinimumInterval 10
7618       Conn "/dev/ttyUSB2"
7619    </Device>
7620    <Device "Sound Level">
7621       Driver "cem-dt-885x"
7622       Conn "/dev/ttyUSB1"
7623    </Device>
7624  </Plugin>
7625
7626 =over 4
7627
7628 =item B<LogLevel> B<0-5>
7629
7630 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7631 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7632 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7633 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7634 their level, are always submitted to I<collectd> at its INFO log level.
7635
7636 =item E<lt>B<Device> I<Name>E<gt>
7637
7638 A sigrok-supported device, uniquely identified by this section's options. The
7639 I<Name> is passed to I<collectd> as the I<plugin instance>.
7640
7641 =item B<Driver> I<DriverName>
7642
7643 The sigrok driver to use for this device.
7644
7645 =item B<Conn> I<ConnectionSpec>
7646
7647 If the device cannot be auto-discovered, or more than one might be discovered
7648 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7649 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7650 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7651 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7652 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7653
7654 =item B<SerialComm> I<SerialSpec>
7655
7656 For serial devices with non-standard port settings, this option can be used
7657 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7658 This should not be necessary; drivers know how to communicate with devices they
7659 support.
7660
7661 =item B<MinimumInterval> I<Seconds>
7662
7663 Specifies the minimum time between measurement dispatches to I<collectd>, in
7664 seconds. Since some I<sigrok> supported devices can acquire measurements many
7665 times per second, it may be necessary to throttle these. For example, the
7666 I<RRD plugin> cannot process writes more than once per second.
7667
7668 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7669 device are always dispatched to I<collectd>. When throttled, unused
7670 measurements are discarded.
7671
7672 =back
7673
7674 =head2 Plugin C<smart>
7675
7676 The C<smart> plugin collects SMART information from physical
7677 disks. Values collectd include temperature, power cycle count, poweron
7678 time and bad sectors. Also, all SMART attributes are collected along
7679 with the normalized current value, the worst value, the threshold and
7680 a human readable value.
7681
7682 Using the following two options you can ignore some disks or configure the
7683 collection only of specific disks.
7684
7685 =over 4
7686
7687 =item B<Disk> I<Name>
7688
7689 Select the disk I<Name>. Whether it is collected or ignored depends on the
7690 B<IgnoreSelected> setting, see below. As with other plugins that use the
7691 daemon's ignorelist functionality, a string that starts and ends with a slash
7692 is interpreted as a regular expression. Examples:
7693
7694   Disk "sdd"
7695   Disk "/hda[34]/"
7696
7697 See F</"IGNORELISTS"> for details.
7698
7699 =item B<IgnoreSelected> B<true>|B<false>
7700
7701 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7702 statements, are ignored or if all other disks are ignored. The behavior
7703 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7704 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7705 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7706 is set to B<true>, all disks are collected B<except> the ones matched.
7707
7708 =item B<IgnoreSleepMode> B<true>|B<false>
7709
7710 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7711 This option disables the sleep mode check and allows the plugin to collect data
7712 from these disks anyway. This is useful in cases where libatasmart mistakenly
7713 reports disks as asleep because it has not been updated to incorporate support
7714 for newer idle states in the ATA spec.
7715
7716 =item B<UseSerial> B<true>|B<false>
7717
7718 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7719 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7720 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7721 storing data. This ensures that the data for a given disk will be kept together
7722 even if the kernel name changes.
7723
7724 =back
7725
7726 =head2 Plugin C<snmp>
7727
7728 Since the configuration of the C<snmp plugin> is a little more complicated than
7729 other plugins, its documentation has been moved to an own manpage,
7730 L<collectd-snmp(5)>. Please see there for details.
7731
7732 =head2 Plugin C<snmp_agent>
7733
7734 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7735 from SNMP master agent and returns the data collected by read plugins.
7736 The I<snmp_agent> plugin handles requests only for OIDs specified in
7737 configuration file. To handle SNMP queries the plugin gets data from collectd
7738 and translates requested values from collectd's internal format to SNMP format.
7739 This plugin is a generic plugin and cannot work without configuration.
7740 For more details on AgentX subagent see
7741 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7742
7743 B<Synopsis:>
7744
7745   <Plugin snmp_agent>
7746     <Data "memAvailReal">
7747       Plugin "memory"
7748       #PluginInstance "some"
7749       Type "memory"
7750       TypeInstance "free"
7751       OIDs "1.3.6.1.4.1.2021.4.6.0"
7752     </Data>
7753     <Table "ifTable">
7754       IndexOID "IF-MIB::ifIndex"
7755       SizeOID "IF-MIB::ifNumber"
7756       <Data "ifDescr">
7757         Instance true
7758         Plugin "interface"
7759         OIDs "IF-MIB::ifDescr"
7760       </Data>
7761       <Data "ifOctets">
7762         Plugin "interface"
7763         Type "if_octets"
7764         TypeInstance ""
7765         OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7766       </Data>
7767     </Table>
7768   </Plugin>
7769
7770 There are two types of blocks that can be contained in the
7771 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7772
7773 =head3 The B<Data> block
7774
7775 The B<Data> block defines a list OIDs that are to be handled. This block can
7776 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7777 block it reperesents table OIDs.
7778 The following options can be set:
7779
7780 =over 4
7781
7782 =item B<Instance> I<true|false>
7783
7784 When B<Instance> is set to B<true>, the value for requested OID is copied from
7785 plugin instance field of corresponding collectd value. If B<Data> block defines
7786 scalar data type B<Instance> has no effect and can be omitted.
7787
7788 =item B<Plugin> I<String>
7789
7790 Read plugin name whose collected data will be mapped to specified OIDs.
7791
7792 =item B<PluginInstance> I<String>
7793
7794 Read plugin instance whose collected data will be mapped to specified OIDs.
7795 The field is optional and by default there is no plugin instance check.
7796 Allowed only if B<Data> block defines scalar data type.
7797
7798 =item B<Type> I<String>
7799
7800 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7801 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7802
7803 =item B<TypeInstance> I<String>
7804
7805 Collectd's type-instance that is to be used for specified OID.
7806
7807 =item B<OIDs> I<OID> [I<OID> ...]
7808
7809 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7810 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7811 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7812 configured should correspond to number of values in specified B<Type>.
7813 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7814 "rx" and "tx" values of "if_octets" type.
7815
7816 =item B<Scale> I<Value>
7817
7818 The values taken from collectd are multiplied by I<Value>. The field is optional
7819 and the default is B<1.0>.
7820
7821 =item B<Shift> I<Value>
7822
7823 I<Value> is added to values from collectd after they have been multiplied by
7824 B<Scale> value. The field is optional and the default value is B<0.0>.
7825
7826 =back
7827
7828 =head3 The B<Table> block
7829
7830 The B<Table> block defines a collection of B<Data> blocks that belong to one
7831 snmp table. In addition to multiple B<Data> blocks the following options can be
7832 set:
7833
7834 =over 4
7835
7836 =item B<IndexOID> I<OID>
7837
7838 OID that is handled by the plugin and is mapped to numerical index value that is
7839 generated by the plugin for each table record.
7840
7841 =item B<SizeOID> I<OID>
7842
7843 OID that is handled by the plugin. Returned value is the number of records in
7844 the table. The field is optional.
7845
7846 =back
7847
7848 =head2 Plugin C<statsd>
7849
7850 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7851 protocol and dispatches rates or other aggregates of these numbers
7852 periodically.
7853
7854 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7855 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7856 C<objects> respectively.
7857
7858 The following configuration options are valid:
7859
7860 =over 4
7861
7862 =item B<Host> I<Host>
7863
7864 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7865 "any" address, i.e. accept packets sent to any of the hosts addresses.
7866
7867 =item B<Port> I<Port>
7868
7869 UDP port to listen to. This can be either a service name or a port number.
7870 Defaults to C<8125>.
7871
7872 =item B<DeleteCounters> B<false>|B<true>
7873
7874 =item B<DeleteTimers> B<false>|B<true>
7875
7876 =item B<DeleteGauges> B<false>|B<true>
7877
7878 =item B<DeleteSets> B<false>|B<true>
7879
7880 These options control what happens if metrics are not updated in an interval.
7881 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7882 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7883 are unchanged. If set to B<True>, the such metrics are not dispatched and
7884 removed from the internal cache.
7885
7886 =item B<CounterSum> B<false>|B<true>
7887
7888 When enabled, creates a C<count> metric which reports the change since the last
7889 read. This option primarily exists for compatibility with the I<statsd>
7890 implementation by Etsy.
7891
7892 =item B<TimerPercentile> I<Percent>
7893
7894 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7895 that I<Percent> of all reported timers are smaller than or equal to the
7896 computed latency. This is useful for cutting off the long tail latency, as it's
7897 often done in I<Service Level Agreements> (SLAs).
7898
7899 Different percentiles can be calculated by setting this option several times.
7900 If none are specified, no percentiles are calculated / dispatched.
7901
7902 =item B<TimerLower> B<false>|B<true>
7903
7904 =item B<TimerUpper> B<false>|B<true>
7905
7906 =item B<TimerSum> B<false>|B<true>
7907
7908 =item B<TimerCount> B<false>|B<true>
7909
7910 Calculate and dispatch various values out of I<Timer> metrics received during
7911 an interval. If set to B<False>, the default, these values aren't calculated /
7912 dispatched.
7913
7914 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
7915
7916 =back
7917
7918 =head2 Plugin C<swap>
7919
7920 The I<Swap plugin> collects information about used and available swap space. On
7921 I<Linux> and I<Solaris>, the following options are available:
7922
7923 =over 4
7924
7925 =item B<ReportByDevice> B<false>|B<true>
7926
7927 Configures how to report physical swap devices. If set to B<false> (the
7928 default), the summary over all swap devices is reported only, i.e. the globally
7929 used and available space over all devices. If B<true> is configured, the used
7930 and available space of each device will be reported separately.
7931
7932 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7933 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7934
7935 =item B<ReportBytes> B<false>|B<true>
7936
7937 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7938 I<swap I/O> is reported in pages. This option is available under Linux only.
7939
7940 =item B<ValuesAbsolute> B<true>|B<false>
7941
7942 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7943 available and used. Defaults to B<true>.
7944
7945 =item B<ValuesPercentage> B<false>|B<true>
7946
7947 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7948 available and free. Defaults to B<false>.
7949
7950 This is useful for deploying I<collectd> in a heterogeneous environment, where
7951 swap sizes differ and you want to specify generic thresholds or similar.
7952
7953 =item B<ReportIO> B<true>|B<false>
7954
7955 Enables or disables reporting swap IO. Defaults to B<true>.
7956
7957 This is useful for the cases when swap IO is not neccessary, is not available,
7958 or is not reliable.
7959
7960 =back
7961
7962 =head2 Plugin C<syslog>
7963
7964 =over 4
7965
7966 =item B<LogLevel> B<debug|info|notice|warning|err>
7967
7968 Sets the log-level. If, for example, set to B<notice>, then all events with
7969 severity B<notice>, B<warning>, or B<err> will be submitted to the
7970 syslog-daemon.
7971
7972 Please note that B<debug> is only available if collectd has been compiled with
7973 debugging support.
7974
7975 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7976
7977 Controls which notifications should be sent to syslog. The default behaviour is
7978 not to send any. Less severe notifications always imply logging more severe
7979 notifications: Setting this to B<OKAY> means all notifications will be sent to
7980 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7981 notifications but will dismiss B<OKAY> notifications. Setting this option to
7982 B<FAILURE> will only send failures to syslog.
7983
7984 =back
7985
7986 =head2 Plugin C<table>
7987
7988 The C<table plugin> provides generic means to parse tabular data and dispatch
7989 user specified values. Values are selected based on column numbers. For
7990 example, this plugin may be used to get values from the Linux L<proc(5)>
7991 filesystem or CSV (comma separated values) files.
7992
7993   <Plugin table>
7994     <Table "/proc/slabinfo">
7995       #Plugin "slab"
7996       Instance "slabinfo"
7997       Separator " "
7998       <Result>
7999         Type gauge
8000         InstancePrefix "active_objs"
8001         InstancesFrom 0
8002         ValuesFrom 1
8003       </Result>
8004       <Result>
8005         Type gauge
8006         InstancePrefix "objperslab"
8007         InstancesFrom 0
8008         ValuesFrom 4
8009       </Result>
8010     </Table>
8011   </Plugin>
8012
8013 The configuration consists of one or more B<Table> blocks, each of which
8014 configures one file to parse. Within each B<Table> block, there are one or
8015 more B<Result> blocks, which configure which data to select and how to
8016 interpret it.
8017
8018 The following options are available inside a B<Table> block:
8019
8020 =over 4
8021
8022 =item B<Plugin> I<Plugin>
8023
8024 If specified, I<Plugin> is used as the plugin name when submitting values.
8025 Defaults to B<table>.
8026
8027 =item B<Instance> I<instance>
8028
8029 If specified, I<instance> is used as the plugin instance. If omitted, the
8030 filename of the table is used instead, with all special characters replaced
8031 with an underscore (C<_>).
8032
8033 =item B<Separator> I<string>
8034
8035 Any character of I<string> is interpreted as a delimiter between the different
8036 columns of the table. A sequence of two or more contiguous delimiters in the
8037 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8038 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8039 of a table - see its documentation for more details. This option is mandatory.
8040
8041 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8042 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8043 required because of collectd's config parsing.
8044
8045 =back
8046
8047 The following options are available inside a B<Result> block:
8048
8049 =over 4
8050
8051 =item B<Type> I<type>
8052
8053 Sets the type used to dispatch the values to the daemon. Detailed information
8054 about types and their configuration can be found in L<types.db(5)>. This
8055 option is mandatory.
8056
8057 =item B<InstancePrefix> I<prefix>
8058
8059 If specified, prepend I<prefix> to the type instance. If omitted, only the
8060 B<InstancesFrom> option is considered for the type instance.
8061
8062 =item B<InstancesFrom> I<column0> [I<column1> ...]
8063
8064 If specified, the content of the given columns (identified by the column
8065 number starting at zero) will be used to create the type instance for each
8066 row. Multiple values (and the instance prefix) will be joined together with
8067 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8068 option is considered for the type instance.
8069
8070 The plugin itself does not check whether or not all built instances are
8071 different. It’s your responsibility to assure that each is unique. This is
8072 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8073 sure that the table only contains one row.
8074
8075 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8076 will be empty.
8077
8078 =item B<ValuesFrom> I<column0> [I<column1> ...]
8079
8080 Specifies the columns (identified by the column numbers starting at zero)
8081 whose content is used as the actual data for the data sets that are dispatched
8082 to the daemon. How many such columns you need is determined by the B<Type>
8083 setting above. If you specify too many or not enough columns, the plugin will
8084 complain about that and no data will be submitted to the daemon. The plugin
8085 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8086 respectively, so anything supported by those functions is supported by the
8087 plugin as well. This option is mandatory.
8088
8089 =back
8090
8091 =head2 Plugin C<tail>
8092
8093 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8094 each line and dispatches found values. What is matched can be configured by the
8095 user using (extended) regular expressions, as described in L<regex(7)>.
8096
8097   <Plugin "tail">
8098     <File "/var/log/exim4/mainlog">
8099       Plugin "mail"
8100       Instance "exim"
8101       Interval 60
8102       <Match>
8103         Regex "S=([1-9][0-9]*)"
8104         DSType "CounterAdd"
8105         Type "ipt_bytes"
8106         Instance "total"
8107       </Match>
8108       <Match>
8109         Regex "\\<R=local_user\\>"
8110         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8111         DSType "CounterInc"
8112         Type "counter"
8113         Instance "local_user"
8114       </Match>
8115       <Match>
8116         Regex "l=([0-9]*\\.[0-9]*)"
8117         <DSType "Distribution">
8118           Percentile 99
8119           Bucket 0 100
8120           #BucketType "bucket"
8121         </DSType>
8122         Type "latency"
8123         Instance "foo"
8124       </Match>
8125     </File>
8126   </Plugin>
8127
8128 The config consists of one or more B<File> blocks, each of which configures one
8129 logfile to parse. Within each B<File> block, there are one or more B<Match>
8130 blocks, which configure a regular expression to search for.
8131
8132 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8133 the plugin name and instance respectively. So in the above example the plugin name
8134 C<mail-exim> would be used.
8135
8136 These options are applied for all B<Match> blocks that B<follow> it, until the
8137 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8138 instances from one logfile, handy when parsing syslog and the like.
8139
8140 The B<Interval> option allows you to define the length of time between reads. If
8141 this is not set, the default Interval will be used.
8142
8143 Each B<Match> block has the following options to describe how the match should
8144 be performed:
8145
8146 =over 4
8147
8148 =item B<Regex> I<regex>
8149
8150 Sets the regular expression to use for matching against a line. The first
8151 subexpression has to match something that can be turned into a number by
8152 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8153 below. Because B<extended> regular expressions are used, you do not need to use
8154 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8155 collectd's config parsing you need to escape backslashes, though. So if you
8156 want to match literal parentheses you need to do the following:
8157
8158   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8159
8160 =item B<ExcludeRegex> I<regex>
8161
8162 Sets an optional regular expression to use for excluding lines from the match.
8163 An example which excludes all connections from localhost from the match:
8164
8165   ExcludeRegex "127\\.0\\.0\\.1"
8166
8167 =item B<DSType> I<Type>
8168
8169 Sets how the values are cumulated. I<Type> is one of:
8170
8171 =over 4
8172
8173 =item B<GaugeAverage>
8174
8175 Calculate the average.
8176
8177 =item B<GaugeMin>
8178
8179 Use the smallest number only.
8180
8181 =item B<GaugeMax>
8182
8183 Use the greatest number only.
8184
8185 =item B<GaugeLast>
8186
8187 Use the last number found.
8188
8189 =item B<GaugePersist>
8190
8191 Use the last number found. The number is not reset at the end of an interval.
8192 It is continously reported until another number is matched. This is intended
8193 for cases in which only state changes are reported, for example a thermometer
8194 that only reports the temperature when it changes.
8195
8196 =item B<CounterSet>
8197
8198 =item B<DeriveSet>
8199
8200 =item B<AbsoluteSet>
8201
8202 The matched number is a counter. Simply I<sets> the internal counter to this
8203 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8204
8205 =item B<GaugeAdd>
8206
8207 =item B<CounterAdd>
8208
8209 =item B<DeriveAdd>
8210
8211 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8212 matched number may be negative, which will effectively subtract from the
8213 internal counter.
8214
8215 =item B<GaugeInc>
8216
8217 =item B<CounterInc>
8218
8219 =item B<DeriveInc>
8220
8221 Increase the internal counter by one. These B<DSType> are the only ones that do
8222 not use the matched subexpression, but simply count the number of matched
8223 lines. Thus, you may use a regular expression without submatch in this case.
8224
8225 =item B<Distribution>
8226
8227 Type to do calculations based on the distribution of values, primarily
8228 calculating percentiles. This is primarily geared towards latency, but can be
8229 used for other metrics as well. The range of values tracked with this setting
8230 must be in the range (0–2^34) and can be fractional. Please note that neither
8231 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8232 distribution.
8233
8234 This option must be used together with the B<Percentile> and/or B<Bucket>
8235 options.
8236
8237 B<Synopsis:>
8238
8239   <DSType "Distribution">
8240     Percentile 99
8241     Bucket 0 100
8242     BucketType "bucket"
8243   </DSType>
8244
8245 =over 4
8246
8247 =item B<Percentile> I<Percent>
8248
8249 Calculate and dispatch the configured percentile, i.e. compute the value, so
8250 that I<Percent> of all matched values are smaller than or equal to the computed
8251 latency.
8252
8253 Metrics are reported with the I<type> B<Type> (the value of the above option)
8254 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8255
8256 This option may be repeated to calculate more than one percentile.
8257
8258 =item B<Bucket> I<lower_bound> I<upper_bound>
8259
8260 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8261 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8262 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8263 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8264 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8265 lower/upper bound.
8266
8267 To export the entire (0–inf) range without overlap, use the upper bound of the
8268 previous range as the lower bound of the following range. In other words, use
8269 the following schema:
8270
8271   Bucket   0   1
8272   Bucket   1   2
8273   Bucket   2   5
8274   Bucket   5  10
8275   Bucket  10  20
8276   Bucket  20  50
8277   Bucket  50   0
8278
8279 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8280 by default) and the I<type instance>
8281 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8282
8283 This option may be repeated to calculate more than one rate.
8284
8285 =item B<BucketType> I<Type>
8286
8287 Sets the type used to dispatch B<Bucket> metrics.
8288 Optional, by default C<bucket> will be used.
8289
8290 =back
8291
8292 =back
8293
8294 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8295 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8296 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8297 B<Derive*> types interpret the submatch as a signed integer using
8298 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8299 and it may be omitted in this case.
8300
8301 =item B<Type> I<Type>
8302
8303 Sets the type used to dispatch this value. Detailed information about types and
8304 their configuration can be found in L<types.db(5)>.
8305
8306 =item B<Instance> I<TypeInstance>
8307
8308 This optional setting sets the type instance to use.
8309
8310 =back
8311
8312 =head2 Plugin C<tail_csv>
8313
8314 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8315 written by I<Snort>.
8316
8317 B<Synopsis:>
8318
8319  <Plugin "tail_csv">
8320    <Metric "snort-dropped">
8321        Type "percent"
8322        Instance "dropped"
8323        Index 1
8324    </Metric>
8325    <File "/var/log/snort/snort.stats">
8326        Plugin "snortstats"
8327        Instance "eth0"
8328        Interval 600
8329        Collect "snort-dropped"
8330    </File>
8331  </Plugin>
8332
8333 The configuration consists of one or more B<Metric> blocks that define an index
8334 into the line of the CSV file and how this value is mapped to I<collectd's>
8335 internal representation. These are followed by one or more B<Instance> blocks
8336 which configure which file to read, in which interval and which metrics to
8337 extract.
8338
8339 =over 4
8340
8341 =item E<lt>B<Metric> I<Name>E<gt>
8342
8343 The B<Metric> block configures a new metric to be extracted from the statistics
8344 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8345 only used inside the B<Instance> blocks to refer to this block, so you can use
8346 one B<Metric> block for multiple CSV files.
8347
8348 =over 4
8349
8350 =item B<Type> I<Type>
8351
8352 Configures which I<Type> to use when dispatching this metric. Types are defined
8353 in the L<types.db(5)> file, see the appropriate manual page for more
8354 information on specifying types. Only types with a single I<data source> are
8355 supported by the I<tail_csv plugin>. The information whether the value is an
8356 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8357 I<Type's> definition.
8358
8359 =item B<Instance> I<TypeInstance>
8360
8361 If set, I<TypeInstance> is used to populate the type instance field of the
8362 created value lists. Otherwise, no type instance is used.
8363
8364 =item B<ValueFrom> I<Index>
8365
8366 Configure to read the value from the field with the zero-based index I<Index>.
8367 If the value is parsed as signed integer, unsigned integer or double depends on
8368 the B<Type> setting, see above.
8369
8370 =back
8371
8372 =item E<lt>B<File> I<Path>E<gt>
8373
8374 Each B<File> block represents one CSV file to read. There must be at least one
8375 I<File> block but there can be multiple if you have multiple CSV files.
8376
8377 =over 4
8378
8379 =item B<Plugin> I<Plugin>
8380
8381 Use I<Plugin> as the plugin name when submitting values.
8382 Defaults to C<tail_csv>.
8383
8384 =item B<Instance> I<PluginInstance>
8385
8386 Sets the I<plugin instance> used when dispatching the values.
8387
8388 =item B<Collect> I<Metric>
8389
8390 Specifies which I<Metric> to collect. This option must be specified at least
8391 once, and you can use this option multiple times to specify more than one
8392 metric to be extracted from this statistic file.
8393
8394 =item B<Interval> I<Seconds>
8395
8396 Configures the interval in which to read values from this instance / file.
8397 Defaults to the plugin's default interval.
8398
8399 =item B<TimeFrom> I<Index>
8400
8401 Rather than using the local time when dispatching a value, read the timestamp
8402 from the field with the zero-based index I<Index>. The value is interpreted as
8403 seconds since epoch. The value is parsed as a double and may be factional.
8404
8405 =back
8406
8407 =back
8408
8409 =head2 Plugin C<teamspeak2>
8410
8411 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8412 polls interesting global and virtual server data. The plugin can query only one
8413 physical server but unlimited virtual servers. You can use the following
8414 options to configure it:
8415
8416 =over 4
8417
8418 =item B<Host> I<hostname/ip>
8419
8420 The hostname or ip which identifies the physical server.
8421 Default: 127.0.0.1
8422
8423 =item B<Port> I<port>
8424
8425 The query port of the physical server. This needs to be a string.
8426 Default: "51234"
8427
8428 =item B<Server> I<port>
8429
8430 This option has to be added once for every virtual server the plugin should
8431 query. If you want to query the virtual server on port 8767 this is what the
8432 option would look like:
8433
8434   Server "8767"
8435
8436 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8437 use quotes around it! If no such statement is given only global information
8438 will be collected.
8439
8440 =back
8441
8442 =head2 Plugin C<ted>
8443
8444 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8445 measure power consumption. These devices are usually connected to a serial
8446 (RS232) or USB port. The plugin opens a configured device and tries to read the
8447 current energy readings. For more information on TED, visit
8448 L<http://www.theenergydetective.com/>.
8449
8450 Available configuration options:
8451
8452 =over 4
8453
8454 =item B<Device> I<Path>
8455
8456 Path to the device on which TED is connected. collectd will need read and write
8457 permissions on that file.
8458
8459 Default: B</dev/ttyUSB0>
8460
8461 =item B<Retries> I<Num>
8462
8463 Apparently reading from TED is not that reliable. You can therefore configure a
8464 number of retries here. You only configure the I<retries> here, to if you
8465 specify zero, one reading will be performed (but no retries if that fails); if
8466 you specify three, a maximum of four readings are performed. Negative values
8467 are illegal.
8468
8469 Default: B<0>
8470
8471 =back
8472
8473 =head2 Plugin C<tcpconns>
8474
8475 The C<tcpconns plugin> counts the number of currently established TCP
8476 connections based on the local port and/or the remote port. Since there may be
8477 a lot of connections the default if to count all connections with a local port,
8478 for which a listening socket is opened. You can use the following options to
8479 fine-tune the ports you are interested in:
8480
8481 =over 4
8482
8483 =item B<ListeningPorts> I<true>|I<false>
8484
8485 If this option is set to I<true>, statistics for all local ports for which a
8486 listening socket exists are collected. The default depends on B<LocalPort> and
8487 B<RemotePort> (see below): If no port at all is specifically selected, the
8488 default is to collect listening ports. If specific ports (no matter if local or
8489 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8490 the selected ports will be collected unless this option is set to I<true>
8491 specifically.
8492
8493 =item B<LocalPort> I<Port>
8494
8495 Count the connections to a specific local port. This can be used to see how
8496 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8497 You have to specify the port in numeric form, so for the mailserver example
8498 you'd need to set B<25>.
8499
8500 =item B<RemotePort> I<Port>
8501
8502 Count the connections to a specific remote port. This is useful to see how
8503 much a remote service is used. This is most useful if you want to know how many
8504 connections a local service has opened to remote services, e.E<nbsp>g. how many
8505 connections a mail server or news server has to other mail or news servers, or
8506 how many connections a web proxy holds to web servers. You have to give the
8507 port in numeric form.
8508
8509 =item B<AllPortsSummary> I<true>|I<false>
8510
8511 If this option is set to I<true> a summary of statistics from all connections
8512 are collected. This option defaults to I<false>.
8513
8514 =back
8515
8516 =head2 Plugin C<thermal>
8517
8518 =over 4
8519
8520 =item B<ForceUseProcfs> I<true>|I<false>
8521
8522 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8523 C<sysfs> interface. If that is not available, the plugin falls back to the
8524 C<procfs> interface. By setting this option to I<true>, you can force the
8525 plugin to use the latter. This option defaults to I<false>.
8526
8527 =item B<Device> I<Device>
8528
8529 Selects the name of the thermal device that you want to collect or ignore,
8530 depending on the value of the B<IgnoreSelected> option. This option may be
8531 used multiple times to specify a list of devices.
8532
8533 See F</"IGNORELISTS"> for details.
8534
8535 =item B<IgnoreSelected> I<true>|I<false>
8536
8537 Invert the selection: If set to true, all devices B<except> the ones that
8538 match the device names specified by the B<Device> option are collected. By
8539 default only selected devices are collected if a selection is made. If no
8540 selection is configured at all, B<all> devices are selected.
8541
8542 =back
8543
8544 =head2 Plugin C<threshold>
8545
8546 The I<Threshold plugin> checks values collected or received by I<collectd>
8547 against a configurable I<threshold> and issues I<notifications> if values are
8548 out of bounds.
8549
8550 Documentation for this plugin is available in the L<collectd-threshold(5)>
8551 manual page.
8552
8553 =head2 Plugin C<tokyotyrant>
8554
8555 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8556 couple metrics: number of records, and database size on disk.
8557
8558 =over 4
8559
8560 =item B<Host> I<Hostname/IP>
8561
8562 The hostname or IP which identifies the server.
8563 Default: B<127.0.0.1>
8564
8565 =item B<Port> I<Service/Port>
8566
8567 The query port of the server. This needs to be a string, even if the port is
8568 given in its numeric form.
8569 Default: B<1978>
8570
8571 =back
8572
8573 =head2 Plugin C<turbostat>
8574
8575 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8576 Intel processors by using I<Model Specific Registers>.
8577
8578 =over 4
8579
8580 =item B<CoreCstates> I<Bitmask(Integer)>
8581
8582 Bit mask of the list of core C-states supported by the processor.
8583 This option should only be used if the automated detection fails.
8584 Default value extracted from the CPU model and family.
8585
8586 Currently supported C-states (by this plugin): 3, 6, 7
8587
8588 B<Example:>
8589
8590   All states (3, 6 and 7):
8591   (1<<3) + (1<<6) + (1<<7) = 392
8592
8593 =item B<PackageCstates> I<Bitmask(Integer)>
8594
8595 Bit mask of the list of packages C-states supported by the processor. This
8596 option should only be used if the automated detection fails. Default value
8597 extracted from the CPU model and family.
8598
8599 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8600
8601 B<Example:>
8602
8603   States 2, 3, 6 and 7:
8604   (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8605
8606 =item B<SystemManagementInterrupt> I<true>|I<false>
8607
8608 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8609 This option should only be used if the automated detection fails or if you want
8610 to disable this feature.
8611
8612 =item B<DigitalTemperatureSensor> I<true>|I<false>
8613
8614 Boolean enabling the collection of the temperature of each core. This option
8615 should only be used if the automated detection fails or if you want to disable
8616 this feature.
8617
8618 =item B<TCCActivationTemp> I<Temperature>
8619
8620 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8621 temperature is used when collecting the temperature of cores or packages. This
8622 option should only be used if the automated detection fails. Default value
8623 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8624
8625 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8626
8627 Bit mask of the list of elements to be thermally monitored. This option should
8628 only be used if the automated detection fails or if you want to disable some
8629 collections. The different bits of this bit mask accepted by this plugin are:
8630
8631 =over 4
8632
8633 =item 0 ('1'): Package
8634
8635 =item 1 ('2'): DRAM
8636
8637 =item 2 ('4'): Cores
8638
8639 =item 3 ('8'): Embedded graphic device
8640
8641 =back
8642
8643 =item B<LogicalCoreNames> I<true>|I<false>
8644
8645 Boolean enabling the use of logical core numbering for per core statistics.
8646 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8647 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8648 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8649 more than one, where I<n> is the n-th core of package I<m>.
8650
8651 =back
8652
8653 =head2 Plugin C<unixsock>
8654
8655 =over 4
8656
8657 =item B<SocketFile> I<Path>
8658
8659 Sets the socket-file which is to be created.
8660
8661 =item B<SocketGroup> I<Group>
8662
8663 If running as root change the group of the UNIX-socket after it has been
8664 created. Defaults to B<collectd>.
8665
8666 =item B<SocketPerms> I<Permissions>
8667
8668 Change the file permissions of the UNIX-socket after it has been created. The
8669 permissions must be given as a numeric, octal value as you would pass to
8670 L<chmod(1)>. Defaults to B<0770>.
8671
8672 =item B<DeleteSocket> B<false>|B<true>
8673
8674 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8675 with the given name already exists. If I<collectd> crashes a socket file may be
8676 left over, preventing the daemon from opening a new socket when restarted.
8677 Since this is potentially dangerous, this defaults to B<false>.
8678
8679 =back
8680
8681 =head2 Plugin C<uuid>
8682
8683 This plugin, if loaded, causes the Hostname to be taken from the machine's
8684 UUID. The UUID is a universally unique designation for the machine, usually
8685 taken from the machine's BIOS. This is most useful if the machine is running in
8686 a virtual environment such as Xen, in which case the UUID is preserved across
8687 shutdowns and migration.
8688
8689 The following methods are used to find the machine's UUID, in order:
8690
8691 =over 4
8692
8693 =item *
8694
8695 Check I</etc/uuid> (or I<UUIDFile>).
8696
8697 =item *
8698
8699 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8700 present.
8701
8702 =item *
8703
8704 Check for UUID from C<dmidecode> / SMBIOS.
8705
8706 =item *
8707
8708 Check for UUID from Xen hypervisor.
8709
8710 =back
8711
8712 If no UUID can be found then the hostname is not modified.
8713
8714 =over 4
8715
8716 =item B<UUIDFile> I<Path>
8717
8718 Take the UUID from the given file (default I</etc/uuid>).
8719
8720 =back
8721
8722 =head2 Plugin C<varnish>
8723
8724 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8725 It collects a subset of the values displayed by L<varnishstat(1)>, and
8726 organizes them in categories which can be enabled or disabled. Currently only
8727 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8728 meaning of each metric can be found in L<varnish-counters(7)>.
8729
8730 Synopsis:
8731
8732  <Plugin "varnish">
8733    <Instance "example">
8734      CollectBackend     true
8735      CollectBan         false
8736      CollectCache       true
8737      CollectConnections true
8738      CollectDirectorDNS false
8739      CollectESI         false
8740      CollectFetch       false
8741      CollectHCB         false
8742      CollectObjects     false
8743      CollectPurge       false
8744      CollectSession     false
8745      CollectSHM         true
8746      CollectSMA         false
8747      CollectSMS         false
8748      CollectSM          false
8749      CollectStruct      false
8750      CollectTotals      false
8751      CollectUptime      false
8752      CollectVCL         false
8753      CollectVSM         false
8754      CollectWorkers     false
8755      CollectLock        false
8756      CollectMempool     false
8757      CollectManagement  false
8758      CollectSMF         false
8759      CollectVBE         false
8760      CollectMSE         false
8761    </Instance>
8762  </Plugin>
8763
8764 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8765 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8766 will collectd statistics from the default "varnishd" instance (this should work
8767 fine in most cases).
8768
8769 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8770
8771 =over 4
8772
8773 =item B<CollectBackend> B<true>|B<false>
8774
8775 Back-end connection statistics, such as successful, reused,
8776 and closed connections. True by default.
8777
8778 =item B<CollectBan> B<true>|B<false>
8779
8780 Statistics about ban operations, such as number of bans added, retired, and
8781 number of objects tested against ban operations. Only available with Varnish
8782 3.x and above. False by default.
8783
8784 =item B<CollectCache> B<true>|B<false>
8785
8786 Cache hits and misses. True by default.
8787
8788 =item B<CollectConnections> B<true>|B<false>
8789
8790 Number of client connections received, accepted and dropped. True by default.
8791
8792 =item B<CollectDirectorDNS> B<true>|B<false>
8793
8794 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8795 default.
8796
8797 =item B<CollectESI> B<true>|B<false>
8798
8799 Edge Side Includes (ESI) parse statistics. False by default.
8800
8801 =item B<CollectFetch> B<true>|B<false>
8802
8803 Statistics about fetches (HTTP requests sent to the backend). False by default.
8804
8805 =item B<CollectHCB> B<true>|B<false>
8806
8807 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8808 divided into locked and unlocked look-ups. False by default.
8809
8810 =item B<CollectObjects> B<true>|B<false>
8811
8812 Statistics on cached objects: number of objects expired, nuked (prematurely
8813 expired), saved, moved, etc. False by default.
8814
8815 =item B<CollectPurge> B<true>|B<false>
8816
8817 Statistics about purge operations, such as number of purges added, retired, and
8818 number of objects tested against purge operations. Only available with Varnish
8819 2.x. False by default.
8820
8821 =item B<CollectSession> B<true>|B<false>
8822
8823 Client session statistics. Number of past and current sessions, session herd and
8824 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8825 metrics found in the Connections and Threads sections with previous versions of
8826 Varnish have been moved here.
8827
8828 =item B<CollectSHM> B<true>|B<false>
8829
8830 Statistics about the shared memory log, a memory region to store
8831 log messages which is flushed to disk when full. True by default.
8832
8833 =item B<CollectSMA> B<true>|B<false>
8834
8835 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8836 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8837 only the one used by the Varnish instance. Only available with Varnish 2.x.
8838 False by default.
8839
8840 =item B<CollectSMS> B<true>|B<false>
8841
8842 synth (synthetic content) storage statistics. This storage
8843 component is used internally only. False by default.
8844
8845 =item B<CollectSM> B<true>|B<false>
8846
8847 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8848 in varnish 4.x. use CollectSMF.
8849 False by default.
8850
8851 =item B<CollectStruct> B<true>|B<false>
8852
8853 Current varnish internal state statistics. Number of current sessions, objects
8854 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8855 default.
8856
8857 =item B<CollectTotals> B<true>|B<false>
8858
8859 Collects overview counters, such as the number of sessions created,
8860 the number of requests and bytes transferred. False by default.
8861
8862 =item B<CollectUptime> B<true>|B<false>
8863
8864 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8865
8866 =item B<CollectVCL> B<true>|B<false>
8867
8868 Number of total (available + discarded) VCL (config files). False by default.
8869
8870 =item B<CollectVSM> B<true>|B<false>
8871
8872 Collect statistics about Varnish's shared memory usage (used by the logging and
8873 statistics subsystems). Only available with Varnish 4.x. False by default.
8874
8875 =item B<CollectWorkers> B<true>|B<false>
8876
8877 Collect statistics about worker threads. False by default.
8878
8879 =item B<CollectVBE> B<true>|B<false>
8880
8881 Backend counters. Only available with Varnish 4.x. False by default.
8882
8883 =item B<CollectSMF> B<true>|B<false>
8884
8885 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8886 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
8887 instance. Used to be called SM in Varnish 2.x. False by default.
8888
8889 =item B<CollectManagement> B<true>|B<false>
8890
8891 Management process counters. Only available with Varnish 4.x. False by default.
8892
8893 =item B<CollectLock> B<true>|B<false>
8894
8895 Lock counters. Only available with Varnish 4.x. False by default.
8896
8897 =item B<CollectMempool> B<true>|B<false>
8898
8899 Memory pool counters. Only available with Varnish 4.x. False by default.
8900
8901 =item B<CollectMSE> B<true>|B<false>
8902
8903 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
8904 Varnish, replacing the traditional malloc and file storages. Only available
8905 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
8906 one used by the Varnish instance. False by default.
8907
8908 =back
8909
8910 =head2 Plugin C<virt>
8911
8912 This plugin allows CPU, disk, network load and other metrics to be collected for
8913 virtualized guests on the machine. The statistics are collected through libvirt
8914 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8915 installing any additional software on guests, especially I<collectd>, which runs
8916 only on the host system.
8917
8918 Only I<Connection> is required.
8919
8920 =over 4
8921
8922 =item B<Connection> I<uri>
8923
8924 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8925
8926  Connection "xen:///"
8927
8928 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8929
8930 =item B<RefreshInterval> I<seconds>
8931
8932 Refresh the list of domains and devices every I<seconds>. The default is 60
8933 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8934 the list of domains and devices to be refreshed on every iteration.
8935
8936 Refreshing the devices in particular is quite a costly operation, so if your
8937 virtualization setup is static you might consider increasing this. If this
8938 option is set to 0, refreshing is disabled completely.
8939
8940 =item B<Domain> I<name>
8941
8942 =item B<BlockDevice> I<name:dev>
8943
8944 =item B<InterfaceDevice> I<name:dev>
8945
8946 =item B<IgnoreSelected> B<true>|B<false>
8947
8948 Select which domains and devices are collected.
8949
8950 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8951 disk/network devices are collected.
8952
8953 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8954 domains and disk/network devices are ignored, while the rest are collected.
8955
8956 The domain name and device names may use a regular expression, if the name is
8957 surrounded by I</.../> and collectd was compiled with support for regexps.
8958
8959 The default is to collect statistics for all domains and all their devices.
8960
8961 Example:
8962
8963  BlockDevice "/:hdb/"
8964  IgnoreSelected "true"
8965
8966 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8967 will be collected.
8968
8969 =item B<BlockDeviceFormat> B<target>|B<source>
8970
8971 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8972 seen by the guest will be used for reporting metrics.
8973 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8974 domain.
8975
8976 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8977 using the path of the source, e.g. an image file.
8978 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8979 domain.
8980
8981 B<Example:>
8982
8983 If the domain XML have the following device defined:
8984
8985   <disk type='block' device='disk'>
8986     <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8987     <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8988     <target dev='sda' bus='scsi'/>
8989     <boot order='2'/>
8990     <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8991   </disk>
8992
8993 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8994 to C<sda>.
8995 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8996 to C<var_lib_libvirt_images_image1.qcow2>.
8997
8998 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8999
9000 The B<BlockDeviceFormatBasename> controls whether the full path or the
9001 L<basename(1)> of the source is being used as the I<type instance> when
9002 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9003
9004 B<Example:>
9005
9006 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9007 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9008 be set to C<var_lib_libvirt_images_image1.qcow2>.
9009 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9010 set to C<image1.qcow2>.
9011
9012 =item B<HostnameFormat> B<name|uuid|hostname|...>
9013
9014 When the virt plugin logs data, it sets the hostname of the collected data
9015 according to this setting. The default is to use the guest name as provided by
9016 the hypervisor, which is equal to setting B<name>.
9017
9018 B<uuid> means use the guest's UUID. This is useful if you want to track the
9019 same guest across migrations.
9020
9021 B<hostname> means to use the global B<Hostname> setting, which is probably not
9022 useful on its own because all guests will appear to have the same name.
9023
9024 You can also specify combinations of these fields. For example B<name uuid>
9025 means to concatenate the guest name and UUID (with a literal colon character
9026 between, thus I<"foo:1234-1234-1234-1234">).
9027
9028 At the moment of writing (collectd-5.5), hostname string is limited to 62
9029 characters. In case when combination of fields exceeds 62 characters,
9030 hostname will be truncated without a warning.
9031
9032 =item B<InterfaceFormat> B<name>|B<address>
9033
9034 When the virt plugin logs interface data, it sets the name of the collected
9035 data according to this setting. The default is to use the path as provided by
9036 the hypervisor (the "dev" property of the target node), which is equal to
9037 setting B<name>.
9038
9039 B<address> means use the interface's mac address. This is useful since the
9040 interface path might change between reboots of a guest or across migrations.
9041
9042 =item B<PluginInstanceFormat> B<name|uuid|none>
9043
9044 When the virt plugin logs data, it sets the plugin_instance of the collected
9045 data according to this setting. The default is to not set the plugin_instance.
9046
9047 B<name> means use the guest's name as provided by the hypervisor.
9048 B<uuid> means use the guest's UUID.
9049
9050 You can also specify combinations of the B<name> and B<uuid> fields.
9051 For example B<name uuid> means to concatenate the guest name and UUID
9052 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9053
9054 =item B<Instances> B<integer>
9055
9056 How many read instances you want to use for this plugin. The default is one,
9057 and the sensible setting is a multiple of the B<ReadThreads> value.
9058 If you are not sure, just use the default setting.
9059
9060 =item B<ExtraStats> B<string>
9061
9062 Report additional extra statistics. The default is no extra statistics, preserving
9063 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9064 allows the plugin to reported more detailed statistics about the behaviour of
9065 Virtual Machines. The argument is a space-separated list of selectors.
9066
9067 Currently supported selectors are:
9068
9069 =over 4
9070
9071 =item B<cpu_util>: report CPU utilization per domain in percentage.
9072
9073 =item B<disk>: report extra statistics like number of flush operations and total
9074 service time for read, write and flush operations. Requires libvirt API version
9075 I<0.9.5> or later.
9076
9077 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9078 I<0.9.10> or later.
9079
9080 =item B<domain_state>: report domain state and reason in human-readable format as
9081 a notification. If libvirt API version I<0.9.2> or later is available, domain
9082 reason will be included in notification.
9083
9084 =item B<fs_info>: report file system information as a notification. Requires
9085 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9086 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9087 version supports retrieving  file system information.
9088
9089 =item B<job_stats_background>: report statistics about progress of a background
9090 job on a domain. Only one type of job statistics can be collected at the same time.
9091 Requires libvirt API version I<1.2.9> or later.
9092
9093 =item B<job_stats_completed>: report statistics about a recently completed job on
9094 a domain. Only one type of job statistics can be collected at the same time.
9095 Requires libvirt API version I<1.2.9> or later.
9096
9097 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9098 Requires libvirt API version I<0.9.11> or later.
9099
9100 =item B<perf>: report performance monitoring events. To collect performance
9101 metrics they must be enabled for domain and supported by the platform. Requires
9102 libvirt API version I<1.3.3> or later.
9103 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9104
9105 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9106
9107 =back
9108
9109 =item B<PersistentNotification> B<true>|B<false>
9110 Override default configuration to only send notifications when there is a change
9111 in the lifecycle state of a domain. When set to true notifications will be sent
9112 for every read cycle. Default is false. Does not affect the stats being
9113 dispatched.
9114
9115 =back
9116
9117 =head2 Plugin C<vmem>
9118
9119 The C<vmem> plugin collects information about the usage of virtual memory.
9120 Since the statistics provided by the Linux kernel are very detailed, they are
9121 collected very detailed. However, to get all the details, you have to switch
9122 them on manually. Most people just want an overview over, such as the number of
9123 pages read from swap space.
9124
9125 =over 4
9126
9127 =item B<Verbose> B<true>|B<false>
9128
9129 Enables verbose collection of information. This will start collecting page
9130 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9131 Part of these statistics are collected on a "per zone" basis.
9132
9133 =back
9134
9135 =head2 Plugin C<vserver>
9136
9137 This plugin doesn't have any options. B<VServer> support is only available for
9138 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9139 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9140 need to apply the patches and compile your own kernel, which will then provide
9141 the F</proc/virtual> filesystem that is required by this plugin.
9142
9143 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9144
9145 B<Note>: The traffic collected by this plugin accounts for the amount of
9146 traffic passing a socket which might be a lot less than the actual on-wire
9147 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9148 collect on-wire traffic you could, for example, use the logging facilities of
9149 iptables to feed data for the guest IPs into the iptables plugin.
9150
9151 =head2 Plugin C<write_graphite>
9152
9153 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9154 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9155 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9156 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9157 of at most 1428 bytes to minimize the number of network packets.
9158
9159 Synopsis:
9160
9161  <Plugin write_graphite>
9162    <Node "example">
9163      Host "localhost"
9164      Port "2003"
9165      Protocol "tcp"
9166      LogSendErrors true
9167      Prefix "collectd"
9168    </Node>
9169  </Plugin>
9170
9171 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9172 blocks. Inside the B<Node> blocks, the following options are recognized:
9173
9174 =over 4
9175
9176 =item B<Host> I<Address>
9177
9178 Hostname or address to connect to. Defaults to C<localhost>.
9179
9180 =item B<Port> I<Service>
9181
9182 Service name or port number to connect to. Defaults to C<2003>.
9183
9184 =item B<Protocol> I<String>
9185
9186 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9187
9188 =item B<ReconnectInterval> I<Seconds>
9189
9190 When set to non-zero, forces the connection to the Graphite backend to be
9191 closed and re-opend periodically. This behavior is desirable in environments
9192 where the connection to the Graphite backend is done through load balancers,
9193 for example. When set to zero, the default, the connetion is kept open for as
9194 long as possible.
9195
9196 =item B<LogSendErrors> B<false>|B<true>
9197
9198 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9199 If set to B<false>, it will not log the errors. This is especially useful when
9200 using Protocol UDP since many times we want to use the "fire-and-forget"
9201 approach and logging errors fills syslog with unneeded messages.
9202
9203 =item B<Prefix> I<String>
9204
9205 When set, I<String> is added in front of the host name. Dots and whitespace are
9206 I<not> escaped in this string (see B<EscapeCharacter> below).
9207
9208 =item B<Postfix> I<String>
9209
9210 When set, I<String> is appended to the host name. Dots and whitespace are
9211 I<not> escaped in this string (see B<EscapeCharacter> below).
9212
9213 =item B<EscapeCharacter> I<Char>
9214
9215 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9216 in the identifier. The B<EscapeCharacter> option determines which character
9217 dots, whitespace and control characters are replaced with. Defaults to
9218 underscore (C<_>).
9219
9220 =item B<StoreRates> B<false>|B<true>
9221
9222 If set to B<true> (the default), convert counter values to rates. If set to
9223 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9224 number.
9225
9226 =item B<SeparateInstances> B<false>|B<true>
9227
9228 If set to B<true>, the plugin instance and type instance will be in their own
9229 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9230 default), the plugin and plugin instance (and likewise the type and type
9231 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9232
9233 =item B<AlwaysAppendDS> B<false>|B<true>
9234
9235 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9236 identifier. If set to B<false> (the default), this is only done when there is
9237 more than one DS.
9238
9239 =item B<PreserveSeparator> B<false>|B<true>
9240
9241 If set to B<false> (the default) the C<.> (dot) character is replaced with
9242 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9243 is preserved, i.e. passed through.
9244
9245 =item B<DropDuplicateFields> B<false>|B<true>
9246
9247 If set to B<true>, detect and remove duplicate components in Graphite metric
9248 names. For example, the metric name  C<host.load.load.shortterm> will
9249 be shortened to C<host.load.shortterm>.
9250
9251 =back
9252
9253 =head2 Plugin C<write_log>
9254
9255 The C<write_log> plugin writes metrics as INFO log messages.
9256
9257 This plugin supports two output formats: I<Graphite> and I<JSON>.
9258
9259 Synopsis:
9260
9261  <Plugin write_log>
9262    Format Graphite
9263  </Plugin>
9264
9265 =over 4
9266
9267 =item B<Format> I<Format>
9268
9269 The output format to use. Can be one of C<Graphite> or C<JSON>.
9270
9271 =back
9272
9273 =head2 Plugin C<write_tsdb>
9274
9275 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9276 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9277 state daemon that ingests metrics and stores them in HBase. The plugin uses
9278 I<TCP> over the "line based" protocol with a default port 4242. The data will
9279 be sent in blocks of at most 1428 bytes to minimize the number of network
9280 packets.
9281
9282 Synopsis:
9283
9284  <Plugin write_tsdb>
9285    ResolveInterval 60
9286    ResolveJitter 60
9287    <Node "example">
9288      Host "tsd-1.my.domain"
9289      Port "4242"
9290      HostTags "status=production"
9291    </Node>
9292  </Plugin>
9293
9294 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9295 blocks and global directives.
9296
9297 Global directives are:
9298
9299 =over 4
9300
9301 =item B<ResolveInterval> I<seconds>
9302
9303 =item B<ResolveJitter> I<seconds>
9304
9305 When I<collectd> connects to a TSDB node, it will request the hostname from
9306 DNS. This can become a problem if the TSDB node is unavailable or badly
9307 configured because collectd will request DNS in order to reconnect for every
9308 metric, which can flood your DNS. So you can cache the last value for
9309 I<ResolveInterval> seconds.
9310 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9311
9312 You can also define a jitter, a random interval to wait in addition to
9313 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9314 hostname at the same time when the connection fails.
9315 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9316
9317 B<Note:> If the DNS resolution has already been successful when the socket
9318 closes, the plugin will try to reconnect immediately with the cached
9319 information. DNS is queried only when the socket is closed for a longer than
9320 I<ResolveInterval> + I<ResolveJitter> seconds.
9321
9322 =back
9323
9324 Inside the B<Node> blocks, the following options are recognized:
9325
9326 =over 4
9327
9328 =item B<Host> I<Address>
9329
9330 Hostname or address to connect to. Defaults to C<localhost>.
9331
9332 =item B<Port> I<Service>
9333
9334 Service name or port number to connect to. Defaults to C<4242>.
9335
9336
9337 =item B<HostTags> I<String>
9338
9339 When set, I<HostTags> is added to the end of the metric. It is intended to be
9340 used for name=value pairs that the TSD will tag the metric with. Dots and
9341 whitespace are I<not> escaped in this string.
9342
9343 =item B<StoreRates> B<false>|B<true>
9344
9345 If set to B<true>, convert counter values to rates. If set to B<false>
9346 (the default) counter values are stored as is, as an increasing
9347 integer number.
9348
9349 =item B<AlwaysAppendDS> B<false>|B<true>
9350
9351 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9352 identifier. If set to B<false> (the default), this is only done when there is
9353 more than one DS.
9354
9355 =back
9356
9357 =head2 Plugin C<write_mongodb>
9358
9359 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9360 NoSQL database.
9361
9362 B<Synopsis:>
9363
9364  <Plugin "write_mongodb">
9365    <Node "default">
9366      Host "localhost"
9367      Port "27017"
9368      Timeout 1000
9369      StoreRates true
9370    </Node>
9371  </Plugin>
9372
9373 The plugin can send values to multiple instances of I<MongoDB> by specifying
9374 one B<Node> block for each instance. Within the B<Node> blocks, the following
9375 options are available:
9376
9377 =over 4
9378
9379 =item B<Host> I<Address>
9380
9381 Hostname or address to connect to. Defaults to C<localhost>.
9382
9383 =item B<Port> I<Service>
9384
9385 Service name or port number to connect to. Defaults to C<27017>.
9386
9387 =item B<Timeout> I<Milliseconds>
9388
9389 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9390 Setting this option to zero means no timeout, which is the default.
9391
9392 =item B<StoreRates> B<false>|B<true>
9393
9394 If set to B<true> (the default), convert counter values to rates. If set to
9395 B<false> counter values are stored as is, i.e. as an increasing integer
9396 number.
9397
9398 =item B<Database> I<Database>
9399
9400 =item B<User> I<User>
9401
9402 =item B<Password> I<Password>
9403
9404 Sets the information used when authenticating to a I<MongoDB> database. The
9405 fields are optional (in which case no authentication is attempted), but if you
9406 want to use authentication all three fields must be set.
9407
9408 =back
9409
9410 =head2 Plugin C<write_prometheus>
9411
9412 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9413 using I<Prometheus>.
9414
9415 B<Options:>
9416
9417 =over 4
9418
9419 =item B<Port> I<Port>
9420
9421 Port the embedded webserver should listen on. Defaults to B<9103>.
9422
9423 =item B<StalenessDelta> I<Seconds>
9424
9425 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9426 hasn't seen any update for it. This value must match the setting in Prometheus.
9427 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9428
9429 B<Background:>
9430
9431 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9432 which time a metric without updates is considered "stale". This setting
9433 effectively puts an upper limit on the interval in which metrics are reported.
9434
9435 When the I<write_prometheus plugin> encounters a metric with an interval
9436 exceeding this limit, it will inform you, the user, and provide the metric to
9437 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9438 metric "fresh" each time it is scraped, with the time of the scrape being
9439 considered the time of the update. The result is that there appear more
9440 datapoints in I<Prometheus> than were actually created, but at least the metric
9441 doesn't disappear periodically.
9442
9443 =back
9444
9445 =head2 Plugin C<write_http>
9446
9447 This output plugin submits values to an HTTP server using POST requests and
9448 encoding metrics with JSON or using the C<PUTVAL> command described in
9449 L<collectd-unixsock(5)>.
9450
9451 Synopsis:
9452
9453  <Plugin "write_http">
9454    <Node "example">
9455      URL "http://example.com/post-collectd"
9456      User "collectd"
9457      Password "weCh3ik0"
9458      Format JSON
9459    </Node>
9460  </Plugin>
9461
9462 The plugin can send values to multiple HTTP servers by specifying one
9463 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9464 block, the following options are available:
9465
9466 =over 4
9467
9468 =item B<URL> I<URL>
9469
9470 URL to which the values are submitted to. Mandatory.
9471
9472 =item B<User> I<Username>
9473
9474 Optional user name needed for authentication.
9475
9476 =item B<Password> I<Password>
9477
9478 Optional password needed for authentication.
9479
9480 =item B<VerifyPeer> B<true>|B<false>
9481
9482 Enable or disable peer SSL certificate verification. See
9483 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9484
9485 =item B<VerifyHost> B<true|false>
9486
9487 Enable or disable peer host name verification. If enabled, the plugin checks if
9488 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9489 matches the host name provided by the B<URL> option. If this identity check
9490 fails, the connection is aborted. Obviously, only works when connecting to a
9491 SSL enabled server. Enabled by default.
9492
9493 =item B<CACert> I<File>
9494
9495 File that holds one or more SSL certificates. If you want to use HTTPS you will
9496 possibly need this option. What CA certificates come bundled with C<libcurl>
9497 and are checked by default depends on the distribution you use.
9498
9499 =item B<CAPath> I<Directory>
9500
9501 Directory holding one or more CA certificate files. You can use this if for
9502 some reason all the needed CA certificates aren't in the same file and can't be
9503 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9504 OpenSSL.
9505
9506 =item B<ClientKey> I<File>
9507
9508 File that holds the private key in PEM format to be used for certificate-based
9509 authentication.
9510
9511 =item B<ClientCert> I<File>
9512
9513 File that holds the SSL certificate to be used for certificate-based
9514 authentication.
9515
9516 =item B<ClientKeyPass> I<Password>
9517
9518 Password required to load the private key in B<ClientKey>.
9519
9520 =item B<Header> I<Header>
9521
9522 A HTTP header to add to the request.  Multiple headers are added if this option is specified more than once.  Example:
9523
9524   Header "X-Custom-Header: custom_value"
9525
9526 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9527
9528 Define which SSL protocol version must be used. By default C<libcurl> will
9529 attempt to figure out the remote SSL protocol version. See
9530 L<curl_easy_setopt(3)> for more details.
9531
9532 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9533
9534 Format of the output to generate. If set to B<Command>, will create output that
9535 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9536 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9537 , will create output in the KairosDB format.
9538
9539 Defaults to B<Command>.
9540
9541 =item B<Attribute> I<String> I<String>
9542
9543 Only available for the KAIROSDB output format.
9544
9545 Consider the two given strings to be the key and value of an additional tag for
9546 each metric being sent out.
9547
9548 You can add multiple B<Attribute>.
9549
9550 =item B<TTL> I<Int>
9551
9552 Only available for the KAIROSDB output format.
9553
9554 Sets the Cassandra ttl for the data points.
9555
9556 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9557
9558 =item B<Prefix> I<String>
9559
9560 Only available for the KAIROSDB output format.
9561
9562 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9563
9564 =item B<Metrics> B<true>|B<false>
9565
9566 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9567
9568 =item B<Notifications> B<false>|B<true>
9569
9570 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9571
9572 =item B<StoreRates> B<true|false>
9573
9574 If set to B<true>, convert counter values to rates. If set to B<false> (the
9575 default) counter values are stored as is, i.e. as an increasing integer number.
9576
9577 =item B<BufferSize> I<Bytes>
9578
9579 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9580 requests will be generated, but more metrics will be batched / metrics are
9581 cached for longer before being sent, introducing additional delay until they
9582 are available on the server side. I<Bytes> must be at least 1024 and cannot
9583 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9584 Defaults to C<4096>.
9585
9586 =item B<LowSpeedLimit> I<Bytes per Second>
9587
9588 Sets the minimal transfer rate in I<Bytes per Second> below which the
9589 connection with the HTTP server will be considered too slow and aborted. All
9590 the data submitted over this connection will probably be lost. Defaults to 0,
9591 which means no minimum transfer rate is enforced.
9592
9593 =item B<Timeout> I<Timeout>
9594
9595 Sets the maximum time in milliseconds given for HTTP POST operations to
9596 complete. When this limit is reached, the POST operation will be aborted, and
9597 all the data in the current send buffer will probably be lost. Defaults to 0,
9598 which means the connection never times out.
9599
9600 =item B<LogHttpError> B<false>|B<true>
9601
9602 Enables printing of HTTP error code to log. Turned off by default.
9603
9604 The C<write_http> plugin regularly submits the collected values to the HTTP
9605 server. How frequently this happens depends on how much data you are collecting
9606 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9607 slightly below this interval, which you can estimate by monitoring the network
9608 traffic between collectd and the HTTP server.
9609
9610 =back
9611
9612 =head2 Plugin C<write_kafka>
9613
9614 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9615 queue.
9616 Synopsis:
9617
9618  <Plugin "write_kafka">
9619    Property "metadata.broker.list" "broker1:9092,broker2:9092"
9620    <Topic "collectd">
9621      Format JSON
9622    </Topic>
9623  </Plugin>
9624
9625 The following options are understood by the I<write_kafka plugin>:
9626
9627 =over 4
9628
9629 =item E<lt>B<Topic> I<Name>E<gt>
9630
9631 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9632 is given a unique I<Name> and specifies one kafka producer.
9633 Inside the B<Topic> block, the following per-topic options are
9634 understood:
9635
9636 =over 4
9637
9638 =item B<Property> I<String> I<String>
9639
9640 Configure the named property for the current topic. Properties are
9641 forwarded to the kafka producer library B<librdkafka>.
9642
9643 =item B<Key> I<String>
9644
9645 Use the specified string as a partitioning key for the topic. Kafka breaks
9646 topic into partitions and guarantees that for a given topology, the same
9647 consumer will be used for a specific key. The special (case insensitive)
9648 string B<Random> can be used to specify that an arbitrary partition should
9649 be used.
9650
9651 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9652
9653 Selects the format in which messages are sent to the broker. If set to
9654 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9655 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9656
9657 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9658 an easy and straight forward exchange format.
9659
9660 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9661 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9662
9663 =item B<StoreRates> B<true>|B<false>
9664
9665 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9666 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9667 default), no conversion is performed. Otherwise the conversion is performed
9668 using the internal value cache.
9669
9670 Please note that currently this option is only used if the B<Format> option has
9671 been set to B<JSON>.
9672
9673 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9674
9675 A prefix can be added in the metric name when outputting in the I<Graphite>
9676 format. It's added before the I<Host> name.
9677 Metric name will be
9678 C<E<lt>prefixE<gt>E<lt>hostE<gt>E<lt>postfixE<gt>E<lt>pluginE<gt>E<lt>typeE<gt>E<lt>nameE<gt>>
9679
9680 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9681
9682 A postfix can be added in the metric name when outputting in the I<Graphite>
9683 format. It's added after the I<Host> name.
9684 Metric name will be
9685 C<E<lt>prefixE<gt>E<lt>hostE<gt>E<lt>postfixE<gt>E<lt>pluginE<gt>E<lt>typeE<gt>E<lt>nameE<gt>>
9686
9687 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9688
9689 Specify a character to replace dots (.) in the host part of the metric name.
9690 In I<Graphite> metric name, dots are used as separators between different
9691 metric parts (host, plugin, type).
9692 Default is C<_> (I<Underscore>).
9693
9694 =item B<GraphiteSeparateInstances> B<false>|B<true>
9695
9696 If set to B<true>, the plugin instance and type instance will be in their own
9697 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9698 default), the plugin and plugin instance (and likewise the type and type
9699 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9700
9701 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9702
9703 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9704 identifier. If set to B<false> (the default), this is only done when there is
9705 more than one DS.
9706
9707 =item B<GraphitePreserveSeparator> B<false>|B<true>
9708
9709 If set to B<false> (the default) the C<.> (dot) character is replaced with
9710 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9711 is preserved, i.e. passed through.
9712
9713 =item B<StoreRates> B<true>|B<false>
9714
9715 If set to B<true> (the default), convert counter values to rates. If set to
9716 B<false> counter values are stored as is, i.e. as an increasing integer number.
9717
9718 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9719 converted values will have "rate" appended to the data source type, e.g.
9720 C<ds_type:derive:rate>.
9721
9722 =back
9723
9724 =item B<Property> I<String> I<String>
9725
9726 Configure the kafka producer through properties, you almost always will
9727 want to set B<metadata.broker.list> to your Kafka broker list.
9728
9729 =back
9730
9731 =head2 Plugin C<write_redis>
9732
9733 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9734
9735 Synopsis:
9736
9737   <Plugin "write_redis">
9738     <Node "example">
9739         Host "localhost"
9740         Port "6379"
9741         Timeout 1000
9742         Prefix "collectd/"
9743         Database 1
9744         MaxSetSize -1
9745         MaxSetDuration -1
9746         StoreRates true
9747     </Node>
9748   </Plugin>
9749
9750 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9751 the timestamp as the score. Retrieving a date range can then be done using the
9752 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9753 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9754 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9755 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9756 with the B<Database> parameter (default is C<0>). See
9757 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9758 details.
9759
9760 The information shown in the synopsis above is the I<default configuration>
9761 which is used by the plugin if no configuration is present.
9762
9763 The plugin can send values to multiple instances of I<Redis> by specifying
9764 one B<Node> block for each instance. Within the B<Node> blocks, the following
9765 options are available:
9766
9767 =over 4
9768
9769 =item B<Node> I<Nodename>
9770
9771 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9772 instance running on a specified host and port. The node name is a
9773 canonical identifier which is used as I<plugin instance>. It is limited to
9774 51E<nbsp>characters in length.
9775
9776 =item B<Host> I<Hostname>
9777
9778 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9779 running on.
9780
9781 =item B<Port> I<Port>
9782
9783 The B<Port> option is the TCP port on which the Redis instance accepts
9784 connections. Either a service name of a port number may be given. Please note
9785 that numerical port numbers must be given as a string, too.
9786
9787 =item B<Timeout> I<Milliseconds>
9788
9789 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9790
9791 =item B<Prefix> I<Prefix>
9792
9793 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9794 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9795 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9796 is recommended but not required to include a trailing slash in I<Prefix>.
9797
9798 =item B<Database> I<Index>
9799
9800 This index selects the redis database to use for writing operations. Defaults
9801 to C<0>.
9802
9803 =item B<MaxSetSize> I<Items>
9804
9805 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9806 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9807
9808 =item B<MaxSetDuration> I<Seconds>
9809
9810 The B<MaxSetDuration> option limits the duration of items that the
9811 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9812 is the default behavior.
9813
9814 =item B<StoreRates> B<true>|B<false>
9815
9816 If set to B<true> (the default), convert counter values to rates. If set to
9817 B<false> counter values are stored as is, i.e. as an increasing integer number.
9818
9819 =back
9820
9821 =head2 Plugin C<write_riemann>
9822
9823 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9824 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9825 I<Riemann> using UDP packets.
9826
9827 Synopsis:
9828
9829  <Plugin "write_riemann">
9830    <Node "example">
9831      Host "localhost"
9832      Port "5555"
9833      Protocol UDP
9834      StoreRates true
9835      AlwaysAppendDS false
9836      TTLFactor 2.0
9837    </Node>
9838    Tag "foobar"
9839    Attribute "foo" "bar"
9840  </Plugin>
9841
9842 The following options are understood by the I<write_riemann plugin>:
9843
9844 =over 4
9845
9846 =item E<lt>B<Node> I<Name>E<gt>
9847
9848 The plugin's configuration consists of one or more B<Node> blocks. Each block
9849 is given a unique I<Name> and specifies one connection to an instance of
9850 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9851 understood:
9852
9853 =over 4
9854
9855 =item B<Host> I<Address>
9856
9857 Hostname or address to connect to. Defaults to C<localhost>.
9858
9859 =item B<Port> I<Service>
9860
9861 Service name or port number to connect to. Defaults to C<5555>.
9862
9863 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9864
9865 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9866 B<TCP>.
9867
9868 =item B<TLSCertFile> I<Path>
9869
9870 When using the B<TLS> protocol, path to a PEM certificate to present
9871 to remote host.
9872
9873 =item B<TLSCAFile> I<Path>
9874
9875 When using the B<TLS> protocol, path to a PEM CA certificate to
9876 use to validate the remote hosts's identity.
9877
9878 =item B<TLSKeyFile> I<Path>
9879
9880 When using the B<TLS> protocol, path to a PEM private key associated
9881 with the certificate defined by B<TLSCertFile>.
9882
9883 =item B<Batch> B<true>|B<false>
9884
9885 If set to B<true> and B<Protocol> is set to B<TCP>,
9886 events will be batched in memory and flushed at
9887 regular intervals or when B<BatchMaxSize> is exceeded.
9888
9889 Notifications are not batched and sent as soon as possible.
9890
9891 When enabled, it can occur that events get processed by the Riemann server
9892 close to or after their expiration time. Tune the B<TTLFactor> and
9893 B<BatchMaxSize> settings according to the amount of values collected, if this
9894 is an issue.
9895
9896 Defaults to true
9897
9898 =item B<BatchMaxSize> I<size>
9899
9900 Maximum payload size for a riemann packet. Defaults to 8192
9901
9902 =item B<BatchFlushTimeout> I<seconds>
9903
9904 Maximum amount of seconds to wait in between to batch flushes.
9905 No timeout by default.
9906
9907 =item B<StoreRates> B<true>|B<false>
9908
9909 If set to B<true> (the default), convert counter values to rates. If set to
9910 B<false> counter values are stored as is, i.e. as an increasing integer number.
9911
9912 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9913 converted values will have "rate" appended to the data source type, e.g.
9914 C<ds_type:derive:rate>.
9915
9916 =item B<AlwaysAppendDS> B<false>|B<true>
9917
9918 If set to B<true>, append the name of the I<Data Source> (DS) to the
9919 "service", i.e. the field that, together with the "host" field, uniquely
9920 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9921 only done when there is more than one DS.
9922
9923 =item B<TTLFactor> I<Factor>
9924
9925 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9926 event is considered active. I<collectd> populates this field based on the
9927 metrics interval setting. This setting controls the factor with which the
9928 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9929 know exactly what you're doing, you should only increase this setting from its
9930 default value.
9931
9932 =item B<Notifications> B<false>|B<true>
9933
9934 If set to B<true>, create riemann events for notifications. This is B<true>
9935 by default. When processing thresholds from write_riemann, it might prove
9936 useful to avoid getting notification events.
9937
9938 =item B<CheckThresholds> B<false>|B<true>
9939
9940 If set to B<true>, attach state to events based on thresholds defined
9941 in the B<Threshold> plugin. Defaults to B<false>.
9942
9943 =item B<EventServicePrefix> I<String>
9944
9945 Add the given string as a prefix to the event service name.
9946 If B<EventServicePrefix> not set or set to an empty string (""),
9947 no prefix will be used.
9948
9949 =back
9950
9951 =item B<Tag> I<String>
9952
9953 Add the given string as an additional tag to the metric being sent to
9954 I<Riemann>.
9955
9956 =item B<Attribute> I<String> I<String>
9957
9958 Consider the two given strings to be the key and value of an additional
9959 attribute for each metric being sent out to I<Riemann>.
9960
9961 =back
9962
9963 =head2 Plugin C<write_sensu>
9964
9965 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9966 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9967 a local I<Sensu> client using a TCP socket.
9968
9969 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9970 parameter so it is not possible to use one collectd instance as a gateway for
9971 others. Each collectd host must pair with one I<Sensu> client.
9972
9973 Synopsis:
9974
9975  <Plugin "write_sensu">
9976    <Node "example">
9977      Host "localhost"
9978      Port "3030"
9979      StoreRates true
9980      AlwaysAppendDS false
9981      MetricHandler "influx"
9982      MetricHandler "default"
9983      NotificationHandler "flapjack"
9984      NotificationHandler "howling_monkey"
9985      Notifications true
9986    </Node>
9987    Tag "foobar"
9988    Attribute "foo" "bar"
9989  </Plugin>
9990
9991 The following options are understood by the I<write_sensu plugin>:
9992
9993 =over 4
9994
9995 =item E<lt>B<Node> I<Name>E<gt>
9996
9997 The plugin's configuration consists of one or more B<Node> blocks. Each block
9998 is given a unique I<Name> and specifies one connection to an instance of
9999 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10000 understood:
10001
10002 =over 4
10003
10004 =item B<Host> I<Address>
10005
10006 Hostname or address to connect to. Defaults to C<localhost>.
10007
10008 =item B<Port> I<Service>
10009
10010 Service name or port number to connect to. Defaults to C<3030>.
10011
10012 =item B<StoreRates> B<true>|B<false>
10013
10014 If set to B<true> (the default), convert counter values to rates. If set to
10015 B<false> counter values are stored as is, i.e. as an increasing integer number.
10016
10017 This will be reflected in the C<collectd_data_source_type> tag: If
10018 B<StoreRates> is enabled, converted values will have "rate" appended to the
10019 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
10020
10021 =item B<AlwaysAppendDS> B<false>|B<true>
10022
10023 If set the B<true>, append the name of the I<Data Source> (DS) to the
10024 "service", i.e. the field that, together with the "host" field, uniquely
10025 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10026 only done when there is more than one DS.
10027
10028 =item B<Notifications> B<false>|B<true>
10029
10030 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10031 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10032
10033 =item B<Metrics> B<false>|B<true>
10034
10035 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10036 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10037
10038
10039 =item B<Separator> I<String>
10040
10041 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10042
10043 =item B<MetricHandler> I<String>
10044
10045 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10046 several of them, one per line. Defaults to no handler.
10047
10048 =item B<NotificationHandler> I<String>
10049
10050 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10051 add several of them, one per line. Defaults to no handler.
10052
10053 =item B<EventServicePrefix> I<String>
10054
10055 Add the given string as a prefix to the event service name.
10056 If B<EventServicePrefix> not set or set to an empty string (""),
10057 no prefix will be used.
10058
10059 =back
10060
10061 =item B<Tag> I<String>
10062
10063 Add the given string as an additional tag to the metric being sent to
10064 I<Sensu>.
10065
10066 =item B<Attribute> I<String> I<String>
10067
10068 Consider the two given strings to be the key and value of an additional
10069 attribute for each metric being sent out to I<Sensu>.
10070
10071 =back
10072
10073 =head2 Plugin C<xencpu>
10074
10075 This plugin collects metrics of hardware CPU load for machine running Xen
10076 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10077 Result is reported using the C<percent> type, for each CPU (core).
10078
10079 This plugin doesn't have any options (yet).
10080
10081 =head2 Plugin C<zookeeper>
10082
10083 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10084 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
10085 client port.
10086
10087 B<Synopsis:>
10088
10089  <Plugin "zookeeper">
10090    Host "127.0.0.1"
10091    Port "2181"
10092  </Plugin>
10093
10094 =over 4
10095
10096 =item B<Host> I<Address>
10097
10098 Hostname or address to connect to. Defaults to C<localhost>.
10099
10100 =item B<Port> I<Service>
10101
10102 Service name or port number to connect to. Defaults to C<2181>.
10103
10104 =back
10105
10106 =head1 THRESHOLD CONFIGURATION
10107
10108 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10109 we mean that the values are not only stored or sent somewhere, but that they
10110 are judged and, if a problem is recognized, acted upon. The only action
10111 collectd takes itself is to generate and dispatch a "notification". Plugins can
10112 register to receive notifications and perform appropriate further actions.
10113
10114 Since systems and what you expect them to do differ a lot, you can configure
10115 B<thresholds> for your values freely. This gives you a lot of flexibility but
10116 also a lot of responsibility.
10117
10118 Every time a value is out of range a notification is dispatched. This means
10119 that the idle percentage of your CPU needs to be less then the configured
10120 threshold only once for a notification to be generated. There's no such thing
10121 as a moving average or similar - at least not now.
10122
10123 Also, all values that match a threshold are considered to be relevant or
10124 "interesting". As a consequence collectd will issue a notification if they are
10125 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10126 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10127 "2" (the default) and some hosts sends it's CPU statistics to the server every
10128 60 seconds, a notification will be dispatched after about 120 seconds. It may
10129 take a little longer because the timeout is checked only once each B<Interval>
10130 on the server.
10131
10132 When a value comes within range again or is received after it was missing, an
10133 "OKAY-notification" is dispatched.
10134
10135 Here is a configuration example to get you started. Read below for more
10136 information.
10137
10138  <Plugin threshold>
10139    <Type "foo">
10140      WarningMin    0.00
10141      WarningMax 1000.00
10142      FailureMin    0.00
10143      FailureMax 1200.00
10144      Invert false
10145      Instance "bar"
10146    </Type>
10147
10148    <Plugin "interface">
10149      Instance "eth0"
10150      <Type "if_octets">
10151        FailureMax 10000000
10152        DataSource "rx"
10153      </Type>
10154    </Plugin>
10155
10156    <Host "hostname">
10157      <Type "cpu">
10158        Instance "idle"
10159        FailureMin 10
10160      </Type>
10161
10162      <Plugin "memory">
10163        <Type "memory">
10164          Instance "cached"
10165          WarningMin 100000000
10166        </Type>
10167      </Plugin>
10168    </Host>
10169  </Plugin>
10170
10171 There are basically two types of configuration statements: The C<Host>,
10172 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10173 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10174 C<Instance> option. You can combine the block by nesting the blocks, though
10175 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10176 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10177 C<Type> may not contain other blocks. If multiple blocks apply to the same
10178 value the most specific block is used.
10179
10180 The other statements specify the threshold to configure. They B<must> be
10181 included in a C<Type> block. Currently the following statements are recognized:
10182
10183 =over 4
10184
10185 =item B<FailureMax> I<Value>
10186
10187 =item B<WarningMax> I<Value>
10188
10189 Sets the upper bound of acceptable values. If unset defaults to positive
10190 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10191 will be created. If the value is greater than B<WarningMax> but less than (or
10192 equal to) B<FailureMax> a B<WARNING> notification will be created.
10193
10194 =item B<FailureMin> I<Value>
10195
10196 =item B<WarningMin> I<Value>
10197
10198 Sets the lower bound of acceptable values. If unset defaults to negative
10199 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10200 be created. If the value is less than B<WarningMin> but greater than (or equal
10201 to) B<FailureMin> a B<WARNING> notification will be created.
10202
10203 =item B<DataSource> I<DSName>
10204
10205 Some data sets have more than one "data source". Interesting examples are the
10206 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10207 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10208 system load data set, C<load>, even has three data sources: C<shortterm>,
10209 C<midterm>, and C<longterm>.
10210
10211 Normally, all data sources are checked against a configured threshold. If this
10212 is undesirable, or if you want to specify different limits for each data
10213 source, you can use the B<DataSource> option to have a threshold apply only to
10214 one data source.
10215
10216 =item B<Invert> B<true>|B<false>
10217
10218 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10219 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10220 B<WarningMax>) are not okay. Defaults to B<false>.
10221
10222 =item B<Persist> B<true>|B<false>
10223
10224 Sets how often notifications are generated. If set to B<true> one notification
10225 will be generated for each value that is out of the acceptable range. If set to
10226 B<false> (the default) then a notification is only generated if a value is out
10227 of range but the previous value was okay.
10228
10229 This applies to missing values, too: If set to B<true> a notification about a
10230 missing value is generated once every B<Interval> seconds. If set to B<false>
10231 only one such notification is generated until the value appears again.
10232
10233 =item B<Percentage> B<true>|B<false>
10234
10235 If set to B<true>, the minimum and maximum values given are interpreted as
10236 percentage value, relative to the other data sources. This is helpful for
10237 example for the "df" type, where you may want to issue a warning when less than
10238 5E<nbsp>% of the total space is available. Defaults to B<false>.
10239
10240 =item B<Hits> I<Number>
10241
10242 Delay creating the notification until the threshold has been passed I<Number>
10243 times. When a notification has been generated, or when a subsequent value is
10244 inside the threshold, the counter is reset. If, for example, a value is
10245 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10246 will be dispatched at most once every 30E<nbsp>seconds.
10247
10248 This is useful when short bursts are not a problem. If, for example, 100% CPU
10249 usage for up to a minute is normal (and data is collected every
10250 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10251
10252 =item B<Hysteresis> I<Number>
10253
10254 When set to non-zero, a hysteresis value is applied when checking minimum and
10255 maximum bounds. This is useful for values that increase slowly and fluctuate a
10256 bit while doing so. When these values come close to the threshold, they may
10257 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10258
10259 If, for example, the threshold is configures as
10260
10261   WarningMax 100.0
10262   Hysteresis 1.0
10263
10264 then a I<Warning> notification is created when the value exceeds I<101> and the
10265 corresponding I<Okay> notification is only created once the value falls below
10266 I<99>, thus avoiding the "flapping".
10267
10268 =back
10269
10270 =head1 FILTER CONFIGURATION
10271
10272 Starting with collectd 4.6 there is a powerful filtering infrastructure
10273 implemented in the daemon. The concept has mostly been copied from
10274 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10275 terminology, so that users that are familiar with iptables feel right at home.
10276
10277 =head2 Terminology
10278
10279 The following are the terms used in the remainder of the filter configuration
10280 documentation. For an ASCII-art schema of the mechanism, see
10281 L<"General structure"> below.
10282
10283 =over 4
10284
10285 =item B<Match>
10286
10287 A I<match> is a criteria to select specific values. Examples are, of course, the
10288 name of the value or it's current value.
10289
10290 Matches are implemented in plugins which you have to load prior to using the
10291 match. The name of such plugins starts with the "match_" prefix.
10292
10293 =item B<Target>
10294
10295 A I<target> is some action that is to be performed with data. Such actions
10296 could, for example, be to change part of the value's identifier or to ignore
10297 the value completely.
10298
10299 Some of these targets are built into the daemon, see L<"Built-in targets">
10300 below. Other targets are implemented in plugins which you have to load prior to
10301 using the target. The name of such plugins starts with the "target_" prefix.
10302
10303 =item B<Rule>
10304
10305 The combination of any number of matches and at least one target is called a
10306 I<rule>. The target actions will be performed for all values for which B<all>
10307 matches apply. If the rule does not have any matches associated with it, the
10308 target action will be performed for all values.
10309
10310 =item B<Chain>
10311
10312 A I<chain> is a list of rules and possibly default targets. The rules are tried
10313 in order and if one matches, the associated target will be called. If a value
10314 is handled by a rule, it depends on the target whether or not any subsequent
10315 rules are considered or if traversal of the chain is aborted, see
10316 L<"Flow control"> below. After all rules have been checked, the default targets
10317 will be executed.
10318
10319 =back
10320
10321 =head2 General structure
10322
10323 The following shows the resulting structure:
10324
10325  +---------+
10326  ! Chain   !
10327  +---------+
10328       !
10329       V
10330  +---------+  +---------+  +---------+  +---------+
10331  ! Rule    !->! Match   !->! Match   !->! Target  !
10332  +---------+  +---------+  +---------+  +---------+
10333       !
10334       V
10335  +---------+  +---------+  +---------+
10336  ! Rule    !->! Target  !->! Target  !
10337  +---------+  +---------+  +---------+
10338       !
10339       V
10340       :
10341       :
10342       !
10343       V
10344  +---------+  +---------+  +---------+
10345  ! Rule    !->! Match   !->! Target  !
10346  +---------+  +---------+  +---------+
10347       !
10348       V
10349  +---------+
10350  ! Default !
10351  ! Target  !
10352  +---------+
10353
10354 =head2 Flow control
10355
10356 There are four ways to control which way a value takes through the filter
10357 mechanism:
10358
10359 =over 4
10360
10361 =item B<jump>
10362
10363 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10364 process the value with another chain. When the called chain finishes, usually
10365 the next target or rule after the jump is executed.
10366
10367 =item B<stop>
10368
10369 The stop condition, signaled for example by the built-in target B<stop>, causes
10370 all processing of the value to be stopped immediately.
10371
10372 =item B<return>
10373
10374 Causes processing in the current chain to be aborted, but processing of the
10375 value generally will continue. This means that if the chain was called via
10376 B<Jump>, the next target or rule after the jump will be executed. If the chain
10377 was not called by another chain, control will be returned to the daemon and it
10378 may pass the value to another chain.
10379
10380 =item B<continue>
10381
10382 Most targets will signal the B<continue> condition, meaning that processing
10383 should continue normally. There is no special built-in target for this
10384 condition.
10385
10386 =back
10387
10388 =head2 Synopsis
10389
10390 The configuration reflects this structure directly:
10391
10392  PostCacheChain "PostCache"
10393  <Chain "PostCache">
10394    <Rule "ignore_mysql_show">
10395      <Match "regex">
10396        Plugin "^mysql$"
10397        Type "^mysql_command$"
10398        TypeInstance "^show_"
10399      </Match>
10400      <Target "stop">
10401      </Target>
10402    </Rule>
10403    <Target "write">
10404      Plugin "rrdtool"
10405    </Target>
10406  </Chain>
10407
10408 The above configuration example will ignore all values where the plugin field
10409 is "mysql", the type is "mysql_command" and the type instance begins with
10410 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10411 default target of the chain. Since this chain is run after the value has been
10412 added to the cache, the MySQL C<show_*> command statistics will be available
10413 via the C<unixsock> plugin.
10414
10415 =head2 List of configuration options
10416
10417 =over 4
10418
10419 =item B<PreCacheChain> I<ChainName>
10420
10421 =item B<PostCacheChain> I<ChainName>
10422
10423 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10424 argument is the name of a I<chain> that should be executed before and/or after
10425 the values have been added to the cache.
10426
10427 To understand the implications, it's important you know what is going on inside
10428 I<collectd>. The following diagram shows how values are passed from the
10429 read-plugins to the write-plugins:
10430
10431    +---------------+
10432    !  Read-Plugin  !
10433    +-------+-------+
10434            !
10435  + - - - - V - - - - +
10436  : +---------------+ :
10437  : !   Pre-Cache   ! :
10438  : !     Chain     ! :
10439  : +-------+-------+ :
10440  :         !         :
10441  :         V         :
10442  : +-------+-------+ :  +---------------+
10443  : !     Cache     !--->!  Value Cache  !
10444  : !     insert    ! :  +---+---+-------+
10445  : +-------+-------+ :      !   !
10446  :         !   ,------------'   !
10447  :         V   V     :          V
10448  : +-------+---+---+ :  +-------+-------+
10449  : !  Post-Cache   +--->! Write-Plugins !
10450  : !     Chain     ! :  +---------------+
10451  : +---------------+ :
10452  :                   :
10453  :  dispatch values  :
10454  + - - - - - - - - - +
10455
10456 After the values are passed from the "read" plugins to the dispatch functions,
10457 the pre-cache chain is run first. The values are added to the internal cache
10458 afterwards. The post-cache chain is run after the values have been added to the
10459 cache. So why is it such a huge deal if chains are run before or after the
10460 values have been added to this cache?
10461
10462 Targets that change the identifier of a value list should be executed before
10463 the values are added to the cache, so that the name in the cache matches the
10464 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10465 this cache to receive a list of all available values. If you change the
10466 identifier after the value list has been added to the cache, this may easily
10467 lead to confusion, but it's not forbidden of course.
10468
10469 The cache is also used to convert counter values to rates. These rates are, for
10470 example, used by the C<value> match (see below). If you use the rate stored in
10471 the cache B<before> the new value is added, you will use the old, B<previous>
10472 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10473 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10474 command.
10475
10476 Last but not last, the B<stop> target makes a difference: If the pre-cache
10477 chain returns the stop condition, the value will not be added to the cache and
10478 the post-cache chain will not be run.
10479
10480 =item B<Chain> I<Name>
10481
10482 Adds a new chain with a certain name. This name can be used to refer to a
10483 specific chain, for example to jump to it.
10484
10485 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10486
10487 =item B<Rule> [I<Name>]
10488
10489 Adds a new rule to the current chain. The name of the rule is optional and
10490 currently has no meaning for the daemon.
10491
10492 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10493 must be at least one B<Target> block.
10494
10495 =item B<Match> I<Name>
10496
10497 Adds a match to a B<Rule> block. The name specifies what kind of match should
10498 be performed. Available matches depend on the plugins that have been loaded.
10499
10500 The arguments inside the B<Match> block are passed to the plugin implementing
10501 the match, so which arguments are valid here depends on the plugin being used.
10502 If you do not need any to pass any arguments to a match, you can use the
10503 shorter syntax:
10504
10505  Match "foobar"
10506
10507 Which is equivalent to:
10508
10509  <Match "foobar">
10510  </Match>
10511
10512 =item B<Target> I<Name>
10513
10514 Add a target to a rule or a default target to a chain. The name specifies what
10515 kind of target is to be added. Which targets are available depends on the
10516 plugins being loaded.
10517
10518 The arguments inside the B<Target> block are passed to the plugin implementing
10519 the target, so which arguments are valid here depends on the plugin being used.
10520 If you do not need any to pass any arguments to a target, you can use the
10521 shorter syntax:
10522
10523  Target "stop"
10524
10525 This is the same as writing:
10526
10527  <Target "stop">
10528  </Target>
10529
10530 =back
10531
10532 =head2 Built-in targets
10533
10534 The following targets are built into the core daemon and therefore need no
10535 plugins to be loaded:
10536
10537 =over 4
10538
10539 =item B<return>
10540
10541 Signals the "return" condition, see the L<"Flow control"> section above. This
10542 causes the current chain to stop processing the value and returns control to
10543 the calling chain. The calling chain will continue processing targets and rules
10544 just after the B<jump> target (see below). This is very similar to the
10545 B<RETURN> target of iptables, see L<iptables(8)>.
10546
10547 This target does not have any options.
10548
10549 Example:
10550
10551  Target "return"
10552
10553 =item B<stop>
10554
10555 Signals the "stop" condition, see the L<"Flow control"> section above. This
10556 causes processing of the value to be aborted immediately. This is similar to
10557 the B<DROP> target of iptables, see L<iptables(8)>.
10558
10559 This target does not have any options.
10560
10561 Example:
10562
10563  Target "stop"
10564
10565 =item B<write>
10566
10567 Sends the value to "write" plugins.
10568
10569 Available options:
10570
10571 =over 4
10572
10573 =item B<Plugin> I<Name>
10574
10575 Name of the write plugin to which the data should be sent. This option may be
10576 given multiple times to send the data to more than one write plugin. If the
10577 plugin supports multiple instances, the plugin's instance(s) must also be
10578 specified.
10579
10580 =back
10581
10582 If no plugin is explicitly specified, the values will be sent to all available
10583 write plugins.
10584
10585 Single-instance plugin example:
10586
10587  <Target "write">
10588    Plugin "rrdtool"
10589  </Target>
10590
10591 Multi-instance plugin example:
10592
10593  <Plugin "write_graphite">
10594    <Node "foo">
10595    ...
10596    </Node>
10597    <Node "bar">
10598    ...
10599    </Node>
10600  </Plugin>
10601   ...
10602  <Target "write">
10603    Plugin "write_graphite/foo"
10604  </Target>
10605
10606 =item B<jump>
10607
10608 Starts processing the rules of another chain, see L<"Flow control"> above. If
10609 the end of that chain is reached, or a stop condition is encountered,
10610 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10611 next target or the next rule. This is similar to the B<-j> command line option
10612 of iptables, see L<iptables(8)>.
10613
10614 Available options:
10615
10616 =over 4
10617
10618 =item B<Chain> I<Name>
10619
10620 Jumps to the chain I<Name>. This argument is required and may appear only once.
10621
10622 =back
10623
10624 Example:
10625
10626  <Target "jump">
10627    Chain "foobar"
10628  </Target>
10629
10630 =back
10631
10632 =head2 Available matches
10633
10634 =over 4
10635
10636 =item B<regex>
10637
10638 Matches a value using regular expressions.
10639
10640 Available options:
10641
10642 =over 4
10643
10644 =item B<Host> I<Regex>
10645
10646 =item B<Plugin> I<Regex>
10647
10648 =item B<PluginInstance> I<Regex>
10649
10650 =item B<Type> I<Regex>
10651
10652 =item B<TypeInstance> I<Regex>
10653
10654 =item B<MetaData> I<String> I<Regex>
10655
10656 Match values where the given regular expressions match the various fields of
10657 the identifier of a value. If multiple regular expressions are given, B<all>
10658 regexen must match for a value to match.
10659
10660 =item B<Invert> B<false>|B<true>
10661
10662 When set to B<true>, the result of the match is inverted, i.e. all value lists
10663 where all regular expressions apply are not matched, all other value lists are
10664 matched. Defaults to B<false>.
10665
10666 =back
10667
10668 Example:
10669
10670  <Match "regex">
10671    Host "customer[0-9]+"
10672    Plugin "^foobar$"
10673  </Match>
10674
10675 =item B<timediff>
10676
10677 Matches values that have a time which differs from the time on the server.
10678
10679 This match is mainly intended for servers that receive values over the
10680 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10681 is very sensitive to the timestamp used when updating the RRD files. In
10682 particular, the time must be ever increasing. If a misbehaving client sends one
10683 packet with a timestamp far in the future, all further packets with a correct
10684 time will be ignored because of that one packet. What's worse, such corrupted
10685 RRD files are hard to fix.
10686
10687 This match lets one match all values B<outside> a specified time range
10688 (relative to the server's time), so you can use the B<stop> target (see below)
10689 to ignore the value, for example.
10690
10691 Available options:
10692
10693 =over 4
10694
10695 =item B<Future> I<Seconds>
10696
10697 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10698 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10699 non-zero.
10700
10701 =item B<Past> I<Seconds>
10702
10703 Matches all values that are I<behind> of the server's time by I<Seconds> or
10704 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10705 non-zero.
10706
10707 =back
10708
10709 Example:
10710
10711  <Match "timediff">
10712    Future  300
10713    Past   3600
10714  </Match>
10715
10716 This example matches all values that are five minutes or more ahead of the
10717 server or one hour (or more) lagging behind.
10718
10719 =item B<value>
10720
10721 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10722 values. If a data-set consists of more than one data-source, all data-sources
10723 must match the specified ranges for a positive match.
10724
10725 Available options:
10726
10727 =over 4
10728
10729 =item B<Min> I<Value>
10730
10731 Sets the smallest value which still results in a match. If unset, behaves like
10732 negative infinity.
10733
10734 =item B<Max> I<Value>
10735
10736 Sets the largest value which still results in a match. If unset, behaves like
10737 positive infinity.
10738
10739 =item B<Invert> B<true>|B<false>
10740
10741 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10742 no-match is returned and vice versa. Please note that the B<Invert> setting
10743 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10744 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10745
10746 =item B<DataSource> I<DSName> [I<DSName> ...]
10747
10748 Select one or more of the data sources. If no data source is configured, all
10749 data sources will be checked. If the type handled by the match does not have a
10750 data source of the specified name(s), this will always result in no match
10751 (independent of the B<Invert> setting).
10752
10753 =item B<Satisfy> B<Any>|B<All>
10754
10755 Specifies how checking with several data sources is performed. If set to
10756 B<Any>, the match succeeds if one of the data sources is in the configured
10757 range. If set to B<All> the match only succeeds if all data sources are within
10758 the configured range. Default is B<All>.
10759
10760 Usually B<All> is used for positive matches, B<Any> is used for negative
10761 matches. This means that with B<All> you usually check that all values are in a
10762 "good" range, while with B<Any> you check if any value is within a "bad" range
10763 (or outside the "good" range).
10764
10765 =back
10766
10767 Either B<Min> or B<Max>, but not both, may be unset.
10768
10769 Example:
10770
10771  # Match all values smaller than or equal to 100. Matches only if all data
10772  # sources are below 100.
10773  <Match "value">
10774    Max 100
10775    Satisfy "All"
10776  </Match>
10777
10778  # Match if the value of any data source is outside the range of 0 - 100.
10779  <Match "value">
10780    Min   0
10781    Max 100
10782    Invert true
10783    Satisfy "Any"
10784  </Match>
10785
10786 =item B<empty_counter>
10787
10788 Matches all values with one or more data sources of type B<COUNTER> and where
10789 all counter values are zero. These counters usually I<never> increased since
10790 they started existing (and are therefore uninteresting), or got reset recently
10791 or overflowed and you had really, I<really> bad luck.
10792
10793 Please keep in mind that ignoring such counters can result in confusing
10794 behavior: Counters which hardly ever increase will be zero for long periods of
10795 time. If the counter is reset for some reason (machine or service restarted,
10796 usually), the graph will be empty (NAN) for a long time. People may not
10797 understand why.
10798
10799 =item B<hashed>
10800
10801 Calculates a hash value of the host name and matches values according to that
10802 hash value. This makes it possible to divide all hosts into groups and match
10803 only values that are in a specific group. The intended use is in load
10804 balancing, where you want to handle only part of all data and leave the rest
10805 for other servers.
10806
10807 The hashing function used tries to distribute the hosts evenly. First, it
10808 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10809
10810   hash_value = 0;
10811   for (i = 0; host[i] != 0; i++)
10812     hash_value = (hash_value * 251) + host[i];
10813
10814 The constant 251 is a prime number which is supposed to make this hash value
10815 more random. The code then checks the group for this host according to the
10816 I<Total> and I<Match> arguments:
10817
10818   if ((hash_value % Total) == Match)
10819     matches;
10820   else
10821     does not match;
10822
10823 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10824 groups), then the least significant bit of the hash value will be the XOR of
10825 all least significant bits in the host name. One consequence is that when you
10826 have two hosts, "server0.example.com" and "server1.example.com", where the host
10827 name differs in one digit only and the digits differ by one, those hosts will
10828 never end up in the same group.
10829
10830 Available options:
10831
10832 =over 4
10833
10834 =item B<Match> I<Match> I<Total>
10835
10836 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10837 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10838 be smaller than I<Total>. I<Total> must be at least one, although only values
10839 greater than one really do make any sense.
10840
10841 You can repeat this option to match multiple groups, for example:
10842
10843   Match 3 7
10844   Match 5 7
10845
10846 The above config will divide the data into seven groups and match groups three
10847 and five. One use would be to keep every value on two hosts so that if one
10848 fails the missing data can later be reconstructed from the second host.
10849
10850 =back
10851
10852 Example:
10853
10854  # Operate on the pre-cache chain, so that ignored values are not even in the
10855  # global cache.
10856  <Chain "PreCache">
10857    <Rule>
10858      <Match "hashed">
10859        # Divide all received hosts in seven groups and accept all hosts in
10860        # group three.
10861        Match 3 7
10862      </Match>
10863      # If matched: Return and continue.
10864      Target "return"
10865    </Rule>
10866    # If not matched: Return and stop.
10867    Target "stop"
10868  </Chain>
10869
10870 =back
10871
10872 =head2 Available targets
10873
10874 =over 4
10875
10876 =item B<notification>
10877
10878 Creates and dispatches a notification.
10879
10880 Available options:
10881
10882 =over 4
10883
10884 =item B<Message> I<String>
10885
10886 This required option sets the message of the notification. The following
10887 placeholders will be replaced by an appropriate value:
10888
10889 =over 4
10890
10891 =item B<%{host}>
10892
10893 =item B<%{plugin}>
10894
10895 =item B<%{plugin_instance}>
10896
10897 =item B<%{type}>
10898
10899 =item B<%{type_instance}>
10900
10901 These placeholders are replaced by the identifier field of the same name.
10902
10903 =item B<%{ds:>I<name>B<}>
10904
10905 These placeholders are replaced by a (hopefully) human readable representation
10906 of the current rate of this data source. If you changed the instance name
10907 (using the B<set> or B<replace> targets, see below), it may not be possible to
10908 convert counter values to rates.
10909
10910 =back
10911
10912 Please note that these placeholders are B<case sensitive>!
10913
10914 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10915
10916 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10917 used.
10918
10919 =back
10920
10921 Example:
10922
10923   <Target "notification">
10924     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10925     Severity "WARNING"
10926   </Target>
10927
10928 =item B<replace>
10929
10930 Replaces parts of the identifier using regular expressions.
10931
10932 Available options:
10933
10934 =over 4
10935
10936 =item B<Host> I<Regex> I<Replacement>
10937
10938 =item B<Plugin> I<Regex> I<Replacement>
10939
10940 =item B<PluginInstance> I<Regex> I<Replacement>
10941
10942 =item B<TypeInstance> I<Regex> I<Replacement>
10943
10944 =item B<MetaData> I<String> I<Regex> I<Replacement>
10945
10946 =item B<DeleteMetaData> I<String> I<Regex>
10947
10948 Match the appropriate field with the given regular expression I<Regex>. If the
10949 regular expression matches, that part that matches is replaced with
10950 I<Replacement>. If multiple places of the input buffer match a given regular
10951 expression, only the first occurrence will be replaced.
10952
10953 You can specify each option multiple times to use multiple regular expressions
10954 one after another.
10955
10956 =back
10957
10958 Example:
10959
10960  <Target "replace">
10961    # Replace "example.net" with "example.com"
10962    Host "\\<example.net\\>" "example.com"
10963
10964    # Strip "www." from hostnames
10965    Host "\\<www\\." ""
10966  </Target>
10967
10968 =item B<set>
10969
10970 Sets part of the identifier of a value to a given string.
10971
10972 Available options:
10973
10974 =over 4
10975
10976 =item B<Host> I<String>
10977
10978 =item B<Plugin> I<String>
10979
10980 =item B<PluginInstance> I<String>
10981
10982 =item B<TypeInstance> I<String>
10983
10984 =item B<MetaData> I<String> I<String>
10985
10986 Set the appropriate field to the given string. The strings for plugin instance,
10987 type instance, and meta data may be empty, the strings for host and plugin may
10988 not be empty. It's currently not possible to set the type of a value this way.
10989
10990 The following placeholders will be replaced by an appropriate value:
10991
10992 =over 4
10993
10994 =item B<%{host}>
10995
10996 =item B<%{plugin}>
10997
10998 =item B<%{plugin_instance}>
10999
11000 =item B<%{type}>
11001
11002 =item B<%{type_instance}>
11003
11004 These placeholders are replaced by the identifier field of the same name.
11005
11006 =item B<%{meta:>I<name>B<}>
11007
11008 These placeholders are replaced by the meta data value with the given name.
11009
11010 =back
11011
11012 Please note that these placeholders are B<case sensitive>!
11013
11014 =item B<DeleteMetaData> I<String>
11015
11016 Delete the named meta data field.
11017
11018 =back
11019
11020 Example:
11021
11022  <Target "set">
11023    PluginInstance "coretemp"
11024    TypeInstance "core3"
11025  </Target>
11026
11027 =back
11028
11029 =head2 Backwards compatibility
11030
11031 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11032 B<Chain> block, it will behave as it used to. This is equivalent to the
11033 following configuration:
11034
11035  <Chain "PostCache">
11036    Target "write"
11037  </Chain>
11038
11039 If you specify a B<PostCacheChain>, the B<write> target will not be added
11040 anywhere and you will have to make sure that it is called where appropriate. We
11041 suggest to add the above snippet as default target to your "PostCache" chain.
11042
11043 =head2 Examples
11044
11045 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11046 be an FQDN.
11047
11048  <Chain "PreCache">
11049    <Rule "no_fqdn">
11050      <Match "regex">
11051        Host "^[^\.]*$"
11052      </Match>
11053      Target "stop"
11054    </Rule>
11055    Target "write"
11056  </Chain>
11057
11058 =head1 IGNORELISTS
11059
11060 B<Ignorelists> are a generic framework to either ignore some metrics or report
11061 specific metircs only. Plugins usually provide one or more options to specify
11062 the items (mounts points, devices, ...) and the boolean option
11063 C<IgnoreSelected>.
11064
11065 =over 4
11066
11067 =item B<Select> I<String>
11068
11069 Selects the item I<String>. This option often has a plugin specific name, e.g.
11070 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11071 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11072 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11073
11074 By default, this option is doing a case-sensitive full-string match. The
11075 following config will match C<foo>, but not C<Foo>:
11076
11077   Select "foo"
11078
11079 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11080 I<regular expression>. For example, so match all item starting with C<foo>, use
11081 could use the following syntax:
11082
11083   Select "/^foo/"
11084
11085 The regular expression is I<not> anchored, i.e. the following config will match
11086 C<foobar>, C<barfoo> and C<AfooZ>:
11087
11088   Select "/foo/"
11089
11090 The B<Select> option may be repeated to select multiple items.
11091
11092 =item B<IgnoreSelected> B<true>|B<false>
11093
11094 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11095 collected. If set to B<false>, matching metrics are I<collected> and all other
11096 metrics are ignored.
11097
11098 =back
11099
11100 =head1 SEE ALSO
11101
11102 L<collectd(1)>,
11103 L<collectd-exec(5)>,
11104 L<collectd-perl(5)>,
11105 L<collectd-unixsock(5)>,
11106 L<types.db(5)>,
11107 L<hddtemp(8)>,
11108 L<iptables(8)>,
11109 L<kstat(3KSTAT)>,
11110 L<mbmon(1)>,
11111 L<psql(1)>,
11112 L<regex(7)>,
11113 L<rrdtool(1)>,
11114 L<sensors(1)>
11115
11116 =head1 AUTHOR
11117
11118 Florian Forster E<lt>octo@collectd.orgE<gt>
11119
11120 =cut