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 and 64E<nbsp>bit values) and
4246 floating point values (two registers interpreted as IEEE floats in big endian
4247 notation).
4248
4249 B<Synopsis:>
4250
4251  <Data "voltage-input-1">
4252    RegisterBase 0
4253    RegisterType float
4254    RegisterCmd ReadHolding
4255    Type voltage
4256    Instance "input-1"
4257    #Scale 1.0
4258    #Shift 0.0
4259  </Data>
4260
4261  <Data "voltage-input-2">
4262    RegisterBase 2
4263    RegisterType float
4264    RegisterCmd ReadHolding
4265    Type voltage
4266    Instance "input-2"
4267  </Data>
4268
4269  <Data "supply-temperature-1">
4270    RegisterBase 0
4271    RegisterType Int16
4272    RegisterCmd ReadHolding
4273    Type temperature
4274    Instance "temp-1"
4275  </Data>
4276
4277  <Host "modbus.example.com">
4278    Address "192.168.0.42"
4279    Port    "502"
4280    Interval 60
4281
4282    <Slave 1>
4283      Instance "power-supply"
4284      Collect  "voltage-input-1"
4285      Collect  "voltage-input-2"
4286    </Slave>
4287  </Host>
4288
4289  <Host "localhost">
4290    Device "/dev/ttyUSB0"
4291    Baudrate 38400
4292    Interval 20
4293
4294    <Slave 1>
4295      Instance "temperature"
4296      Collect  "supply-temperature-1"
4297    </Slave>
4298  </Host>
4299
4300 =over 4
4301
4302 =item E<lt>B<Data> I<Name>E<gt> blocks
4303
4304 Data blocks define a mapping between register numbers and the "types" used by
4305 I<collectd>.
4306
4307 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4308
4309 =over 4
4310
4311 =item B<RegisterBase> I<Number>
4312
4313 Configures the base register to read from the device. If the option
4314 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4315 register will be read (the register number is increased by one).
4316
4317 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4318
4319 Specifies what kind of data is returned by the device. This defaults to
4320 B<Uint16>.  If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4321 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4322 and B<RegisterBase+1> will be read and the data is combined into one
4323 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4324 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4325 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4326 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4327 registers are swapped with the most significant 16E<nbsp>bits in
4328 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4329 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4330 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4331 B<RegisterBase+3> will be read and the data combined into one
4332 64E<nbsp>value.
4333
4334 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4335
4336 Specifies register type to be collected from device. Works only with libmodbus
4337 2.9.2 or higher. Defaults to B<ReadHolding>.
4338
4339 =item B<Type> I<Type>
4340
4341 Specifies the "type" (data set) to use when dispatching the value to
4342 I<collectd>. Currently, only data sets with exactly one data source are
4343 supported.
4344
4345 =item B<Instance> I<Instance>
4346
4347 Sets the type instance to use when dispatching the value to I<Instance>. If
4348 unset, an empty string (no type instance) is used.
4349
4350 =item B<Scale> I<Value>
4351
4352 The values taken from device are multiplied by I<Value>. The field is optional
4353 and the default is B<1.0>.
4354
4355 =item B<Shift> I<Value>
4356
4357 I<Value> is added to values from device after they have been multiplied by
4358 B<Scale> value. The field is optional and the default value is B<0.0>.
4359
4360 =back
4361
4362 =item E<lt>B<Host> I<Name>E<gt> blocks
4363
4364 Host blocks are used to specify to which hosts to connect and what data to read
4365 from their "slaves". The string argument I<Name> is used as hostname when
4366 dispatching the values to I<collectd>.
4367
4368 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4369
4370 =over 4
4371
4372 =item B<Address> I<Hostname>
4373
4374 For Modbus/TCP, specifies the node name (the actual network address) used to
4375 connect to the host. This may be an IP address or a hostname. Please note that
4376 the used I<libmodbus> library only supports IPv4 at the moment.
4377
4378 =item B<Port> I<Service>
4379
4380 for Modbus/TCP, specifies the port used to connect to the host. The port can
4381 either be given as a number or as a service name. Please note that the
4382 I<Service> argument must be a string, even if ports are given in their numerical
4383 form. Defaults to "502".
4384
4385 =item B<Device> I<Devicenode>
4386
4387 For Modbus/RTU, specifies the path to the serial device being used.
4388
4389 =item B<Baudrate> I<Baudrate>
4390
4391 For Modbus/RTU, specifies the baud rate of the serial device.
4392 Note, connections currently support only 8/N/1.
4393
4394 =item B<Interval> I<Interval>
4395
4396 Sets the interval (in seconds) in which the values will be collected from this
4397 host. By default the global B<Interval> setting will be used.
4398
4399 =item E<lt>B<Slave> I<ID>E<gt>
4400
4401 Over each connection, multiple Modbus devices may be reached. The slave ID
4402 is used to specify which device should be addressed. For each device you want
4403 to query, one B<Slave> block must be given.
4404
4405 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4406
4407 =over 4
4408
4409 =item B<Instance> I<Instance>
4410
4411 Specify the plugin instance to use when dispatching the values to I<collectd>.
4412 By default "slave_I<ID>" is used.
4413
4414 =item B<Collect> I<DataName>
4415
4416 Specifies which data to retrieve from the device. I<DataName> must be the same
4417 string as the I<Name> argument passed to a B<Data> block. You can specify this
4418 option multiple times to collect more than one value from a slave. At least one
4419 B<Collect> option is mandatory.
4420
4421 =back
4422
4423 =back
4424
4425 =back
4426
4427 =head2 Plugin C<mqtt>
4428
4429 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4430 values from MQTT (B<Subscribe> blocks).
4431
4432 B<Synopsis:>
4433
4434  <Plugin mqtt>
4435    <Publish "name">
4436      Host "mqtt.example.com"
4437      Prefix "collectd"
4438    </Publish>
4439    <Subscribe "name">
4440      Host "mqtt.example.com"
4441      Topic "collectd/#"
4442    </Subscribe>
4443  </Plugin>
4444
4445 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4446 configuring the sending and receiving direction respectively. The plugin will
4447 register a write callback named C<mqtt/I<name>> where I<name> is the string
4448 argument given to the B<Publish> block. Both types of blocks share many but not
4449 all of the following options. If an option is valid in only one of the blocks,
4450 it will be mentioned explicitly.
4451
4452 B<Options:>
4453
4454 =over 4
4455
4456 =item B<Host> I<Hostname>
4457
4458 Hostname of the MQTT broker to connect to.
4459
4460 =item B<Port> I<Service>
4461
4462 Port number or service name of the MQTT broker to connect to.
4463
4464 =item B<User> I<UserName>
4465
4466 Username used when authenticating to the MQTT broker.
4467
4468 =item B<Password> I<Password>
4469
4470 Password used when authenticating to the MQTT broker.
4471
4472 =item B<ClientId> I<ClientId>
4473
4474 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4475
4476 =item B<QoS> [B<0>-B<2>]
4477
4478 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4479
4480 =over 4
4481
4482 =item B<0>
4483
4484 At most once
4485
4486 =item B<1>
4487
4488 At least once
4489
4490 =item B<2>
4491
4492 Exactly once
4493
4494 =back
4495
4496 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4497 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4498 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4499 on a message is larger than the maximum accepted QoS of a subscriber, the
4500 message's QoS will be downgraded.
4501
4502 =item B<Prefix> I<Prefix> (Publish only)
4503
4504 This plugin will use one topic per I<value list> which will looks like a path.
4505 I<Prefix> is used as the first path element and defaults to B<collectd>.
4506
4507 An example topic name would be:
4508
4509  collectd/cpu-0/cpu-user
4510
4511 =item B<Retain> B<false>|B<true> (Publish only)
4512
4513 Controls whether the MQTT broker will retain (keep a copy of) the last message
4514 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4515
4516 =item B<StoreRates> B<true>|B<false> (Publish only)
4517
4518 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4519 before sending. Defaults to B<true>.
4520
4521 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4522
4523 Controls whether the MQTT "cleans" the session up after the subscriber
4524 disconnects or if it maintains the subscriber's subscriptions and all messages
4525 that arrive while the subscriber is disconnected. Defaults to B<true>.
4526
4527 =item B<Topic> I<TopicName> (Subscribe only)
4528
4529 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4530 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4531 the B<collectd> branch.
4532
4533 =item B<CACert> I<file>
4534
4535 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4536 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4537 port of the MQTT broker.
4538 This option enables the use of TLS.
4539
4540 =item B<CertificateFile> I<file>
4541
4542 Path to the PEM-encoded certificate file to use as client certificate when
4543 connecting to the MQTT broker.
4544 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4545
4546 =item B<CertificateKeyFile> I<file>
4547
4548 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4549 Only valid if B<CACert> and B<CertificateFile> are also set.
4550
4551 =item B<TLSProtocol> I<protocol>
4552
4553 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4554 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4555 version is used which depends on the version of OpenSSL the Mosquitto library
4556 was linked against.
4557 Only valid if B<CACert> is set.
4558
4559 =item B<CipherSuite> I<ciphersuite>
4560
4561 A string describing the ciphers available for use. See L<ciphers(1)> and the
4562 C<openssl ciphers> utility for more information. If unset, the default ciphers
4563 will be used.
4564 Only valid if B<CACert> is set.
4565
4566 =back
4567
4568 =head2 Plugin C<mysql>
4569
4570 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4571 one or more databases when started and keeps the connection up as long as
4572 possible. When the connection is interrupted for whatever reason it will try
4573 to re-connect. The plugin will complain loudly in case anything goes wrong.
4574
4575 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4576 and collects information about MySQL network traffic, executed statements,
4577 requests, the query cache and threads by evaluating the
4578 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4579 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4580 Status Variables> for an explanation of these values.
4581
4582 Optionally, master and slave statistics may be collected in a MySQL
4583 replication setup. In that case, information about the synchronization state
4584 of the nodes are collected by evaluating the C<Position> return value of the
4585 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4586 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4587 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4588 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4589 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4590
4591 Synopsis:
4592
4593   <Plugin mysql>
4594     <Database foo>
4595       Host "hostname"
4596       User "username"
4597       Password "password"
4598       Port "3306"
4599       MasterStats true
4600       ConnectTimeout 10
4601       SSLKey "/path/to/key.pem"
4602       SSLCert "/path/to/cert.pem"
4603       SSLCA "/path/to/ca.pem"
4604       SSLCAPath "/path/to/cas/"
4605       SSLCipher "DHE-RSA-AES256-SHA"
4606     </Database>
4607
4608     <Database bar>
4609       Alias "squeeze"
4610       Host "localhost"
4611       Socket "/var/run/mysql/mysqld.sock"
4612       SlaveStats true
4613       SlaveNotifications true
4614     </Database>
4615
4616    <Database galera>
4617       Alias "galera"
4618       Host "localhost"
4619       Socket "/var/run/mysql/mysqld.sock"
4620       WsrepStats true
4621    </Database>
4622   </Plugin>
4623
4624 A B<Database> block defines one connection to a MySQL database. It accepts a
4625 single argument which specifies the name of the database. None of the other
4626 options are required. MySQL will use default values as documented in the
4627 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4628 B<MySQL reference manual>.
4629
4630 =over 4
4631
4632 =item B<Alias> I<Alias>
4633
4634 Alias to use as sender instead of hostname when reporting. This may be useful
4635 when having cryptic hostnames.
4636
4637 =item B<Host> I<Hostname>
4638
4639 Hostname of the database server. Defaults to B<localhost>.
4640
4641 =item B<User> I<Username>
4642
4643 Username to use when connecting to the database. The user does not have to be
4644 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4645 unless you want to collectd replication statistics (see B<MasterStats> and
4646 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4647 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4648
4649 =item B<Password> I<Password>
4650
4651 Password needed to log into the database.
4652
4653 =item B<Database> I<Database>
4654
4655 Select this database. Defaults to I<no database> which is a perfectly reasonable
4656 option for what this plugin does.
4657
4658 =item B<Port> I<Port>
4659
4660 TCP-port to connect to. The port must be specified in its numeric form, but it
4661 must be passed as a string nonetheless. For example:
4662
4663   Port "3306"
4664
4665 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4666 See the documentation for the C<mysql_real_connect> function for details.
4667
4668 =item B<Socket> I<Socket>
4669
4670 Specifies the path to the UNIX domain socket of the MySQL server. This option
4671 only has any effect, if B<Host> is set to B<localhost> (the default).
4672 Otherwise, use the B<Port> option above. See the documentation for the
4673 C<mysql_real_connect> function for details.
4674
4675 =item B<InnodbStats> I<true|false>
4676
4677 If enabled, metrics about the InnoDB storage engine are collected.
4678 Disabled by default.
4679
4680 =item B<MasterStats> I<true|false>
4681
4682 =item B<SlaveStats> I<true|false>
4683
4684 Enable the collection of master / slave statistics in a replication setup. In
4685 order to be able to get access to these statistics, the user needs special
4686 privileges. See the B<User> documentation above. Defaults to B<false>.
4687
4688 =item B<SlaveNotifications> I<true|false>
4689
4690 If enabled, the plugin sends a notification if the replication slave I/O and /
4691 or SQL threads are not running. Defaults to B<false>.
4692
4693 =item B<WsrepStats> I<true|false>
4694
4695  Enable the collection of wsrep plugin statistics, used in Master-Master
4696  replication setups like in MySQL Galera/Percona XtraDB Cluster.
4697  User needs only privileges to execute 'SHOW GLOBAL STATUS'
4698
4699 =item B<ConnectTimeout> I<Seconds>
4700
4701 Sets the connect timeout for the MySQL client.
4702
4703 =item B<SSLKey> I<Path>
4704
4705 If provided, the X509 key in PEM format.
4706
4707 =item B<SSLCert> I<Path>
4708
4709 If provided, the X509 cert in PEM format.
4710
4711 =item B<SSLCA> I<Path>
4712
4713 If provided, the CA file in PEM format (check OpenSSL docs).
4714
4715 =item B<SSLCAPath> I<Path>
4716
4717 If provided, the CA directory (check OpenSSL docs).
4718
4719 =item B<SSLCipher> I<String>
4720
4721 If provided, the SSL cipher to use.
4722
4723 =back
4724
4725 =head2 Plugin C<netapp>
4726
4727 The netapp plugin can collect various performance and capacity information
4728 from a NetApp filer using the NetApp API.
4729
4730 Please note that NetApp has a wide line of products and a lot of different
4731 software versions for each of these products. This plugin was developed for a
4732 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4733 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4734 model and software version but it is very hard to test this.
4735 If you have used this plugin with other models and/or software version, feel
4736 free to send us a mail to tell us about the results, even if it's just a short
4737 "It works".
4738
4739 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4740 basic authentication.
4741
4742 B<Do not use a regular user for this!> Create a special collectd user with just
4743 the minimum of capabilities needed. The user only needs the "login-http-admin"
4744 capability as well as a few more depending on which data will be collected.
4745 Required capabilities are documented below.
4746
4747 =head3 Synopsis
4748
4749  <Plugin "netapp">
4750    <Host "netapp1.example.com">
4751     Protocol      "https"
4752     Address       "10.0.0.1"
4753     Port          443
4754     User          "username"
4755     Password      "aef4Aebe"
4756     Interval      30
4757
4758     <WAFL>
4759       Interval 30
4760       GetNameCache   true
4761       GetDirCache    true
4762       GetBufferCache true
4763       GetInodeCache  true
4764     </WAFL>
4765
4766     <Disks>
4767       Interval 30
4768       GetBusy true
4769     </Disks>
4770
4771     <VolumePerf>
4772       Interval 30
4773       GetIO      "volume0"
4774       IgnoreSelectedIO      false
4775       GetOps     "volume0"
4776       IgnoreSelectedOps     false
4777       GetLatency "volume0"
4778       IgnoreSelectedLatency false
4779     </VolumePerf>
4780
4781     <VolumeUsage>
4782       Interval 30
4783       GetCapacity "vol0"
4784       GetCapacity "vol1"
4785       IgnoreSelectedCapacity false
4786       GetSnapshot "vol1"
4787       GetSnapshot "vol3"
4788       IgnoreSelectedSnapshot false
4789     </VolumeUsage>
4790
4791     <Quota>
4792       Interval 60
4793     </Quota>
4794
4795     <Snapvault>
4796       Interval 30
4797     </Snapvault>
4798
4799     <System>
4800       Interval 30
4801       GetCPULoad     true
4802       GetInterfaces  true
4803       GetDiskOps     true
4804       GetDiskIO      true
4805     </System>
4806
4807     <VFiler vfilerA>
4808       Interval 60
4809
4810       SnapVault true
4811       # ...
4812     </VFiler>
4813    </Host>
4814  </Plugin>
4815
4816 The netapp plugin accepts the following configuration options:
4817
4818 =over 4
4819
4820 =item B<Host> I<Name>
4821
4822 A host block defines one NetApp filer. It will appear in collectd with the name
4823 you specify here which does not have to be its real name nor its hostname (see
4824 the B<Address> option below).
4825
4826 =item B<VFiler> I<Name>
4827
4828 A B<VFiler> block may only be used inside a host block. It accepts all the
4829 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4830 will execute all NetApp API commands in the context of the specified
4831 VFiler(R). It will appear in collectd with the name you specify here which
4832 does not have to be its real name. The VFiler name may be specified using the
4833 B<VFilerName> option. If this is not specified, it will default to the name
4834 you specify here.
4835
4836 The VFiler block inherits all connection related settings from the surrounding
4837 B<Host> block (which appear before the B<VFiler> block) but they may be
4838 overwritten inside the B<VFiler> block.
4839
4840 This feature is useful, for example, when using a VFiler as SnapVault target
4841 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4842 available in the host filer (vfiler0) but only in the respective VFiler
4843 context.
4844
4845 =item B<Protocol> B<httpd>|B<http>
4846
4847 The protocol collectd will use to query this host.
4848
4849 Optional
4850
4851 Type: string
4852
4853 Default: https
4854
4855 Valid options: http, https
4856
4857 =item B<Address> I<Address>
4858
4859 The hostname or IP address of the host.
4860
4861 Optional
4862
4863 Type: string
4864
4865 Default: The "host" block's name.
4866
4867 =item B<Port> I<Port>
4868
4869 The TCP port to connect to on the host.
4870
4871 Optional
4872
4873 Type: integer
4874
4875 Default: 80 for protocol "http", 443 for protocol "https"
4876
4877 =item B<User> I<User>
4878
4879 =item B<Password> I<Password>
4880
4881 The username and password to use to login to the NetApp.
4882
4883 Mandatory
4884
4885 Type: string
4886
4887 =item B<VFilerName> I<Name>
4888
4889 The name of the VFiler in which context to execute API commands. If not
4890 specified, the name provided to the B<VFiler> block will be used instead.
4891
4892 Optional
4893
4894 Type: string
4895
4896 Default: name of the B<VFiler> block
4897
4898 B<Note:> This option may only be used inside B<VFiler> blocks.
4899
4900 =item B<Interval> I<Interval>
4901
4902 B<TODO>
4903
4904 =back
4905
4906 The following options decide what kind of data will be collected. You can
4907 either use them as a block and fine tune various parameters inside this block,
4908 use them as a single statement to just accept all default values, or omit it to
4909 not collect any data.
4910
4911 The following options are valid inside all blocks:
4912
4913 =over 4
4914
4915 =item B<Interval> I<Seconds>
4916
4917 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4918 host specific setting.
4919
4920 =back
4921
4922 =head3 The System block
4923
4924 This will collect various performance data about the whole system.
4925
4926 B<Note:> To get this data the collectd user needs the
4927 "api-perf-object-get-instances" capability.
4928
4929 =over 4
4930
4931 =item B<Interval> I<Seconds>
4932
4933 Collect disk statistics every I<Seconds> seconds.
4934
4935 =item B<GetCPULoad> B<true>|B<false>
4936
4937 If you set this option to true the current CPU usage will be read. This will be
4938 the average usage between all CPUs in your NetApp without any information about
4939 individual CPUs.
4940
4941 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4942 returns in the "CPU" field.
4943
4944 Optional
4945
4946 Type: boolean
4947
4948 Default: true
4949
4950 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4951
4952 =item B<GetInterfaces> B<true>|B<false>
4953
4954 If you set this option to true the current traffic of the network interfaces
4955 will be read. This will be the total traffic over all interfaces of your NetApp
4956 without any information about individual interfaces.
4957
4958 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4959 in the "Net kB/s" field.
4960
4961 B<Or is it?>
4962
4963 Optional
4964
4965 Type: boolean
4966
4967 Default: true
4968
4969 Result: One value list of type "if_octects".
4970
4971 =item B<GetDiskIO> B<true>|B<false>
4972
4973 If you set this option to true the current IO throughput will be read. This
4974 will be the total IO of your NetApp without any information about individual
4975 disks, volumes or aggregates.
4976
4977 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4978 in the "DiskE<nbsp>kB/s" field.
4979
4980 Optional
4981
4982 Type: boolean
4983
4984 Default: true
4985
4986 Result: One value list of type "disk_octets".
4987
4988 =item B<GetDiskOps> B<true>|B<false>
4989
4990 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4991 iSCSI, etc. operations will be read. This will be the total number of
4992 operations on your NetApp without any information about individual volumes or
4993 aggregates.
4994
4995 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4996 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4997
4998 Optional
4999
5000 Type: boolean
5001
5002 Default: true
5003
5004 Result: A variable number of value lists of type "disk_ops_complex". Each type
5005 of operation will result in one value list with the name of the operation as
5006 type instance.
5007
5008 =back
5009
5010 =head3 The WAFL block
5011
5012 This will collect various performance data about the WAFL file system. At the
5013 moment this just means cache performance.
5014
5015 B<Note:> To get this data the collectd user needs the
5016 "api-perf-object-get-instances" capability.
5017
5018 B<Note:> The interface to get these values is classified as "Diagnostics" by
5019 NetApp. This means that it is not guaranteed to be stable even between minor
5020 releases.
5021
5022 =over 4
5023
5024 =item B<Interval> I<Seconds>
5025
5026 Collect disk statistics every I<Seconds> seconds.
5027
5028 =item B<GetNameCache> B<true>|B<false>
5029
5030 Optional
5031
5032 Type: boolean
5033
5034 Default: true
5035
5036 Result: One value list of type "cache_ratio" and type instance
5037 "name_cache_hit".
5038
5039 =item B<GetDirCache> B<true>|B<false>
5040
5041 Optional
5042
5043 Type: boolean
5044
5045 Default: true
5046
5047 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5048
5049 =item B<GetInodeCache> B<true>|B<false>
5050
5051 Optional
5052
5053 Type: boolean
5054
5055 Default: true
5056
5057 Result: One value list of type "cache_ratio" and type instance
5058 "inode_cache_hit".
5059
5060 =item B<GetBufferCache> B<true>|B<false>
5061
5062 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5063 in the "Cache hit" field.
5064
5065 Optional
5066
5067 Type: boolean
5068
5069 Default: true
5070
5071 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5072
5073 =back
5074
5075 =head3 The Disks block
5076
5077 This will collect performance data about the individual disks in the NetApp.
5078
5079 B<Note:> To get this data the collectd user needs the
5080 "api-perf-object-get-instances" capability.
5081
5082 =over 4
5083
5084 =item B<Interval> I<Seconds>
5085
5086 Collect disk statistics every I<Seconds> seconds.
5087
5088 =item B<GetBusy> B<true>|B<false>
5089
5090 If you set this option to true the busy time of all disks will be calculated
5091 and the value of the busiest disk in the system will be written.
5092
5093 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5094 in the "Disk util" field. Probably.
5095
5096 Optional
5097
5098 Type: boolean
5099
5100 Default: true
5101
5102 Result: One value list of type "percent" and type instance "disk_busy".
5103
5104 =back
5105
5106 =head3 The VolumePerf block
5107
5108 This will collect various performance data about the individual volumes.
5109
5110 You can select which data to collect about which volume using the following
5111 options. They follow the standard ignorelist semantic.
5112
5113 B<Note:> To get this data the collectd user needs the
5114 I<api-perf-object-get-instances> capability.
5115
5116 =over 4
5117
5118 =item B<Interval> I<Seconds>
5119
5120 Collect volume performance data every I<Seconds> seconds.
5121
5122 =item B<GetIO> I<Volume>
5123
5124 =item B<GetOps> I<Volume>
5125
5126 =item B<GetLatency> I<Volume>
5127
5128 Select the given volume for IO, operations or latency statistics collection.
5129 The argument is the name of the volume without the C</vol/> prefix.
5130
5131 Since the standard ignorelist functionality is used here, you can use a string
5132 starting and ending with a slash to specify regular expression matching: To
5133 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5134 expression:
5135
5136   GetIO "/^vol[027]$/"
5137
5138 If no regular expression is specified, an exact match is required. Both,
5139 regular and exact matching are case sensitive.
5140
5141 If no volume was specified at all for either of the three options, that data
5142 will be collected for all available volumes.
5143
5144 See F</"IGNORELISTS"> for details.
5145
5146 =item B<IgnoreSelectedIO> B<true>|B<false>
5147
5148 =item B<IgnoreSelectedOps> B<true>|B<false>
5149
5150 =item B<IgnoreSelectedLatency> B<true>|B<false>
5151
5152 When set to B<true>, the volumes selected for IO, operations or latency
5153 statistics collection will be ignored and the data will be collected for all
5154 other volumes.
5155
5156 When set to B<false>, data will only be collected for the specified volumes and
5157 all other volumes will be ignored.
5158
5159 If no volumes have been specified with the above B<Get*> options, all volumes
5160 will be collected regardless of the B<IgnoreSelected*> option.
5161
5162 Defaults to B<false>
5163
5164 =back
5165
5166 =head3 The VolumeUsage block
5167
5168 This will collect capacity data about the individual volumes.
5169
5170 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5171 capability.
5172
5173 =over 4
5174
5175 =item B<Interval> I<Seconds>
5176
5177 Collect volume usage statistics every I<Seconds> seconds.
5178
5179 =item B<GetCapacity> I<VolumeName>
5180
5181 The current capacity of the volume will be collected. This will result in two
5182 to four value lists, depending on the configuration of the volume. All data
5183 sources are of type "df_complex" with the name of the volume as
5184 plugin_instance.
5185
5186 There will be type_instances "used" and "free" for the number of used and
5187 available bytes on the volume.  If the volume has some space reserved for
5188 snapshots, a type_instance "snap_reserved" will be available.  If the volume
5189 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5190 number of bytes saved by the SIS feature.
5191
5192 B<Note:> The current NetApp API has a bug that results in this value being
5193 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5194 number which works most of the time.  If you see strange values here, bug
5195 NetApp support to fix this.
5196
5197 Repeat this option to specify multiple volumes.
5198
5199 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5200
5201 Specify whether to collect only the volumes selected by the B<GetCapacity>
5202 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5203 B<false>. However, if no B<GetCapacity> option is specified at all, all
5204 capacities will be selected anyway.
5205
5206 =item B<GetSnapshot> I<VolumeName>
5207
5208 Select volumes from which to collect snapshot information.
5209
5210 Usually, the space used for snapshots is included in the space reported as
5211 "used". If snapshot information is collected as well, the space used for
5212 snapshots is subtracted from the used space.
5213
5214 To make things even more interesting, it is possible to reserve space to be
5215 used for snapshots. If the space required for snapshots is less than that
5216 reserved space, there is "reserved free" and "reserved used" space in addition
5217 to "free" and "used". If the space required for snapshots exceeds the reserved
5218 space, that part allocated in the normal space is subtracted from the "used"
5219 space again.
5220
5221 Repeat this option to specify multiple volumes.
5222
5223 =item B<IgnoreSelectedSnapshot>
5224
5225 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5226 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5227 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5228 capacities will be selected anyway.
5229
5230 =back
5231
5232 =head3 The Quota block
5233
5234 This will collect (tree) quota statistics (used disk space and number of used
5235 files). This mechanism is useful to get usage information for single qtrees.
5236 In case the quotas are not used for any other purpose, an entry similar to the
5237 following in C</etc/quotas> would be sufficient:
5238
5239   /vol/volA/some_qtree tree - - - - -
5240
5241 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5242
5243 =over 4
5244
5245 =item B<Interval> I<Seconds>
5246
5247 Collect SnapVault(R) statistics every I<Seconds> seconds.
5248
5249 =back
5250
5251 =head3 The SnapVault block
5252
5253 This will collect statistics about the time and traffic of SnapVault(R)
5254 transfers.
5255
5256 =over 4
5257
5258 =item B<Interval> I<Seconds>
5259
5260 Collect SnapVault(R) statistics every I<Seconds> seconds.
5261
5262 =back
5263
5264 =head2 Plugin C<netlink>
5265
5266 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5267 statistics of various interface and routing aspects.
5268
5269 =over 4
5270
5271 =item B<Interface> I<Interface>
5272
5273 =item B<VerboseInterface> I<Interface>
5274
5275 Instruct the plugin to collect interface statistics. This is basically the same
5276 as the statistics provided by the C<interface> plugin (see above) but
5277 potentially much more detailed.
5278
5279 When configuring with B<Interface> only the basic statistics will be collected,
5280 namely octets, packets, and errors. These statistics are collected by
5281 the C<interface> plugin, too, so using both at the same time is no benefit.
5282
5283 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5284 so that no data needs to be collected twice if you use the C<interface> plugin.
5285 This includes dropped packets, received multicast packets, collisions and a
5286 whole zoo of differentiated RX and TX errors. You can try the following command
5287 to get an idea of what awaits you:
5288
5289   ip -s -s link list
5290
5291 If I<Interface> is B<All>, all interfaces will be selected.
5292
5293 =item B<QDisc> I<Interface> [I<QDisc>]
5294
5295 =item B<Class> I<Interface> [I<Class>]
5296
5297 =item B<Filter> I<Interface> [I<Filter>]
5298
5299 Collect the octets and packets that pass a certain qdisc, class or filter.
5300
5301 QDiscs and classes are identified by their type and handle (or classid).
5302 Filters don't necessarily have a handle, therefore the parent's handle is used.
5303 The notation used in collectd differs from that used in tc(1) in that it
5304 doesn't skip the major or minor number if it's zero and doesn't print special
5305 ids by their name. So, for example, a qdisc may be identified by
5306 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5307 thus not displayed by tc(1).
5308
5309 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5310 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5311 associated with that interface will be collected.
5312
5313 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5314 used. This may lead to problems when more than one filter is attached to a
5315 qdisc or class. This isn't nice, but we don't know how this could be done any
5316 better. If you have a idea, please don't hesitate to tell us.
5317
5318 As with the B<Interface> option you can specify B<All> as the interface,
5319 meaning all interfaces.
5320
5321 Here are some examples to help you understand the above text more easily:
5322
5323   <Plugin netlink>
5324     VerboseInterface "All"
5325     QDisc "eth0" "pfifo_fast-1:0"
5326     QDisc "ppp0"
5327     Class "ppp0" "htb-1:10"
5328     Filter "ppp0" "u32-1:0"
5329   </Plugin>
5330
5331 See F</"IGNORELISTS"> for details.
5332
5333 =item B<IgnoreSelected>
5334
5335 The behavior is the same as with all other similar plugins: If nothing is
5336 selected at all, everything is collected. If some things are selected using the
5337 options described above, only these statistics are collected. If you set
5338 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5339 specified statistics will not be collected.
5340
5341 =back
5342
5343 =head2 Plugin C<network>
5344
5345 The Network plugin sends data to a remote instance of collectd, receives data
5346 from a remote instance, or both at the same time. Data which has been received
5347 from the network is usually not transmitted again, but this can be activated, see
5348 the B<Forward> option below.
5349
5350 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5351 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5352
5353 Both, B<Server> and B<Listen> can be used as single option or as block. When
5354 used as block, given options are valid for this socket only. The following
5355 example will export the metrics twice: Once to an "internal" server (without
5356 encryption and signing) and one to an external server (with cryptographic
5357 signature):
5358
5359  <Plugin "network">
5360    # Export to an internal server
5361    # (demonstrates usage without additional options)
5362    Server "collectd.internal.tld"
5363
5364    # Export to an external server
5365    # (demonstrates usage with signature options)
5366    <Server "collectd.external.tld">
5367      SecurityLevel "sign"
5368      Username "myhostname"
5369      Password "ohl0eQue"
5370    </Server>
5371  </Plugin>
5372
5373 =over 4
5374
5375 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5376
5377 The B<Server> statement/block sets the server to send datagrams to. The
5378 statement may occur multiple times to send each datagram to multiple
5379 destinations.
5380
5381 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5382 optional second argument specifies a port number or a service name. If not
5383 given, the default, B<25826>, is used.
5384
5385 The following options are recognized within B<Server> blocks:
5386
5387 =over 4
5388
5389 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5390
5391 Set the security you require for network communication. When the security level
5392 has been set to B<Encrypt>, data sent over the network will be encrypted using
5393 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5394 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5395 authentication code. When set to B<None>, data is sent without any security.
5396
5397 This feature is only available if the I<network> plugin was linked with
5398 I<libgcrypt>.
5399
5400 =item B<Username> I<Username>
5401
5402 Sets the username to transmit. This is used by the server to lookup the
5403 password. See B<AuthFile> below. All security levels except B<None> require
5404 this setting.
5405
5406 This feature is only available if the I<network> plugin was linked with
5407 I<libgcrypt>.
5408
5409 =item B<Password> I<Password>
5410
5411 Sets a password (shared secret) for this socket. All security levels except
5412 B<None> require this setting.
5413
5414 This feature is only available if the I<network> plugin was linked with
5415 I<libgcrypt>.
5416
5417 =item B<Interface> I<Interface name>
5418
5419 Set the outgoing interface for IP packets. This applies at least
5420 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5421 undefined or a non-existent interface name is specified, the default
5422 behavior is to let the kernel choose the appropriate interface. Be warned
5423 that the manual selection of an interface for unicast traffic is only
5424 necessary in rare cases.
5425
5426 =item B<ResolveInterval> I<Seconds>
5427
5428 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5429 useful to force a regular DNS lookup to support a high availability setup. If
5430 not specified, re-resolves are never attempted.
5431
5432 =back
5433
5434 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5435
5436 The B<Listen> statement sets the interfaces to bind to. When multiple
5437 statements are found the daemon will bind to multiple interfaces.
5438
5439 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5440 the argument is a multicast address the daemon will join that multicast group.
5441 The optional second argument specifies a port number or a service name. If not
5442 given, the default, B<25826>, is used.
5443
5444 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5445
5446 =over 4
5447
5448 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5449
5450 Set the security you require for network communication. When the security level
5451 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5452 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5453 signed and encrypted data is accepted. When set to B<None>, all data will be
5454 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5455 decrypted if possible.
5456
5457 This feature is only available if the I<network> plugin was linked with
5458 I<libgcrypt>.
5459
5460 =item B<AuthFile> I<Filename>
5461
5462 Sets a file in which usernames are mapped to passwords. These passwords are
5463 used to verify signatures and to decrypt encrypted network packets. If
5464 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5465 verified and encrypted packets are decrypted. Otherwise, signed data is
5466 accepted without checking the signature and encrypted data cannot be decrypted.
5467 For the other security levels this option is mandatory.
5468
5469 The file format is very simple: Each line consists of a username followed by a
5470 colon and any number of spaces followed by the password. To demonstrate, an
5471 example file could look like this:
5472
5473   user0: foo
5474   user1: bar
5475
5476 Each time a packet is received, the modification time of the file is checked
5477 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5478 the file is being read, it is locked using L<fcntl(2)>.
5479
5480 =item B<Interface> I<Interface name>
5481
5482 Set the incoming interface for IP packets explicitly. This applies at least
5483 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5484 undefined or a non-existent interface name is specified, the default
5485 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5486 traffic gets only accepted, if it arrives on the given interface.
5487
5488 =back
5489
5490 =item B<TimeToLive> I<1-255>
5491
5492 Set the time-to-live of sent packets. This applies to all, unicast and
5493 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5494 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5495 operating systems.
5496
5497 =item B<MaxPacketSize> I<1024-65535>
5498
5499 Set the maximum size for datagrams received over the network. Packets larger
5500 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5501 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5502 UDP.
5503
5504 On the server side, this limit should be set to the largest value used on
5505 I<any> client. Likewise, the value on the client must not be larger than the
5506 value on the server, or data will be lost.
5507
5508 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5509 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5510 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5511 server.
5512
5513 =item B<Forward> I<true|false>
5514
5515 If set to I<true>, write packets that were received via the network plugin to
5516 the sending sockets. This should only be activated when the B<Listen>- and
5517 B<Server>-statements differ. Otherwise packets may be send multiple times to
5518 the same multicast group. While this results in more network traffic than
5519 necessary it's not a huge problem since the plugin has a duplicate detection,
5520 so the values will not loop.
5521
5522 =item B<ReportStats> B<true>|B<false>
5523
5524 The network plugin cannot only receive and send statistics, it can also create
5525 statistics about itself. Collectd data included the number of received and
5526 sent octets and packets, the length of the receive queue and the number of
5527 values handled. When set to B<true>, the I<Network plugin> will make these
5528 statistics available. Defaults to B<false>.
5529
5530 =back
5531
5532 =head2 Plugin C<nfs>
5533
5534 The I<nfs plugin> collects information about the usage of the Network File
5535 System (NFS). It counts the number of procedure calls for each procedure,
5536 grouped by version and whether the system runs as server or client.
5537
5538 It is possibly to omit metrics for a specific NFS version by setting one or
5539 more of the following options to B<false> (all of them default to B<true>).
5540
5541 =over 4
5542
5543 =item B<ReportV2> B<true>|B<false>
5544
5545 =item B<ReportV3> B<true>|B<false>
5546
5547 =item B<ReportV4> B<true>|B<false>
5548
5549 =back
5550
5551 =head2 Plugin C<nginx>
5552
5553 This plugin collects the number of connections and requests handled by the
5554 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5555 queries the page provided by the C<ngx_http_stub_status_module> module, which
5556 isn't compiled by default. Please refer to
5557 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5558 how to compile and configure nginx and this module.
5559
5560 The following options are accepted by the C<nginx plugin>:
5561
5562 =over 4
5563
5564 =item B<URL> I<http://host/nginx_status>
5565
5566 Sets the URL of the C<ngx_http_stub_status_module> output.
5567
5568 =item B<User> I<Username>
5569
5570 Optional user name needed for authentication.
5571
5572 =item B<Password> I<Password>
5573
5574 Optional password needed for authentication.
5575
5576 =item B<VerifyPeer> B<true|false>
5577
5578 Enable or disable peer SSL certificate verification. See
5579 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5580
5581 =item B<VerifyHost> B<true|false>
5582
5583 Enable or disable peer host name verification. If enabled, the plugin checks
5584 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5585 certificate matches the host name provided by the B<URL> option. If this
5586 identity check fails, the connection is aborted. Obviously, only works when
5587 connecting to a SSL enabled server. Enabled by default.
5588
5589 =item B<CACert> I<File>
5590
5591 File that holds one or more SSL certificates. If you want to use HTTPS you will
5592 possibly need this option. What CA certificates come bundled with C<libcurl>
5593 and are checked by default depends on the distribution you use.
5594
5595 =item B<Timeout> I<Milliseconds>
5596
5597 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5598 milliseconds. By default, the configured B<Interval> is used to set the
5599 timeout.
5600
5601 =back
5602
5603 =head2 Plugin C<notify_desktop>
5604
5605 This plugin sends a desktop notification to a notification daemon, as defined
5606 in the Desktop Notification Specification. To actually display the
5607 notifications, B<notification-daemon> is required and B<collectd> has to be
5608 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5609 environment variables have to be set correctly) and the D-Bus message bus.
5610
5611 The Desktop Notification Specification can be found at
5612 L<http://www.galago-project.org/specs/notification/>.
5613
5614 =over 4
5615
5616 =item B<OkayTimeout> I<timeout>
5617
5618 =item B<WarningTimeout> I<timeout>
5619
5620 =item B<FailureTimeout> I<timeout>
5621
5622 Set the I<timeout>, in milliseconds, after which to expire the notification
5623 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5624 been specified, the displayed notification will not be closed at all - the
5625 user has to do so herself. These options default to 5000. If a negative number
5626 has been specified, the default is used as well.
5627
5628 =back
5629
5630 =head2 Plugin C<notify_email>
5631
5632 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5633 configured email address.
5634
5635 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5636
5637 Available configuration options:
5638
5639 =over 4
5640
5641 =item B<From> I<Address>
5642
5643 Email address from which the emails should appear to come from.
5644
5645 Default: C<root@localhost>
5646
5647 =item B<Recipient> I<Address>
5648
5649 Configures the email address(es) to which the notifications should be mailed.
5650 May be repeated to send notifications to multiple addresses.
5651
5652 At least one B<Recipient> must be present for the plugin to work correctly.
5653
5654 =item B<SMTPServer> I<Hostname>
5655
5656 Hostname of the SMTP server to connect to.
5657
5658 Default: C<localhost>
5659
5660 =item B<SMTPPort> I<Port>
5661
5662 TCP port to connect to.
5663
5664 Default: C<25>
5665
5666 =item B<SMTPUser> I<Username>
5667
5668 Username for ASMTP authentication. Optional.
5669
5670 =item B<SMTPPassword> I<Password>
5671
5672 Password for ASMTP authentication. Optional.
5673
5674 =item B<Subject> I<Subject>
5675
5676 Subject-template to use when sending emails. There must be exactly two
5677 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5678 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5679 with the hostname.
5680
5681 Default: C<Collectd notify: %s@%s>
5682
5683 =back
5684
5685 =head2 Plugin C<notify_nagios>
5686
5687 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5688 a I<passive service check result>.
5689
5690 Available configuration options:
5691
5692 =over 4
5693
5694 =item B<CommandFile> I<Path>
5695
5696 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5697
5698 =back
5699
5700 =head2 Plugin C<ntpd>
5701
5702 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5703 dispersion.
5704
5705 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5706 the wire - using B<mode 7> specific requests. This mode is deprecated with
5707 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5708 correctly with them, the ntp daemon must be explicitly configured to
5709 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5710 manual page for details.
5711
5712 Available configuration options for the C<ntpd> plugin:
5713
5714 =over 4
5715
5716 =item B<Host> I<Hostname>
5717
5718 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5719
5720 =item B<Port> I<Port>
5721
5722 UDP-Port to connect to. Defaults to B<123>.
5723
5724 =item B<ReverseLookups> B<true>|B<false>
5725
5726 Sets whether or not to perform reverse lookups on peers. Since the name or
5727 IP-address may be used in a filename it is recommended to disable reverse
5728 lookups. The default is to do reverse lookups to preserve backwards
5729 compatibility, though.
5730
5731 =item B<IncludeUnitID> B<true>|B<false>
5732
5733 When a peer is a refclock, include the unit ID in the I<type instance>.
5734 Defaults to B<false> for backward compatibility.
5735
5736 If two refclock peers use the same driver and this is B<false>, the plugin will
5737 try to write simultaneous measurements from both to the same type instance.
5738 This will result in error messages in the log and only one set of measurements
5739 making it through.
5740
5741 =back
5742
5743 =head2 Plugin C<nut>
5744
5745 =over 4
5746
5747 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5748
5749 Add a UPS to collect data from. The format is identical to the one accepted by
5750 L<upsc(8)>.
5751
5752 =item B<ForceSSL> B<true>|B<false>
5753
5754 Stops connections from falling back to unsecured if an SSL connection
5755 cannot be established. Defaults to false if undeclared.
5756
5757 =item B<VerifyPeer> I<true>|I<false>
5758
5759 If set to true, requires a CAPath be provided. Will use the CAPath to find
5760 certificates to use as Trusted Certificates to validate a upsd server certificate.
5761 If validation of the upsd server certificate fails, the connection will not be
5762 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5763 will override and set ForceSSL to true.
5764
5765 =item B<CAPath> I/path/to/certs/folder
5766
5767 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5768 The folder pointed at must contain certificate(s) named according to their hash.
5769 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5770 occur because two different certs have the same hash value, Y can be  incremented
5771 in order to avoid conflict. To create a symbolic link to a certificate the following
5772 command can be used from within the directory where the cert resides:
5773
5774 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5775
5776 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5777 generate links like the one described above for ALL certs in a given folder.
5778 Example usage:
5779 C<c_rehash /path/to/certs/folder>
5780
5781 =item B<ConnectTimeout> I<Milliseconds>
5782
5783 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5784 By default, the configured B<Interval> is used to set the timeout.
5785
5786 =back
5787
5788 =head2 Plugin C<olsrd>
5789
5790 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5791 the Optimized Link State Routing daemon and reads information about the current
5792 state of the meshed network.
5793
5794 The following configuration options are understood:
5795
5796 =over 4
5797
5798 =item B<Host> I<Host>
5799
5800 Connect to I<Host>. Defaults to B<"localhost">.
5801
5802 =item B<Port> I<Port>
5803
5804 Specifies the port to connect to. This must be a string, even if you give the
5805 port as a number rather than a service name. Defaults to B<"2006">.
5806
5807 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5808
5809 Specifies what information to collect about links, i.E<nbsp>e. direct
5810 connections of the daemon queried. If set to B<No>, no information is
5811 collected. If set to B<Summary>, the number of links and the average of all
5812 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5813 If set to B<Detail> LQ and NLQ are collected per link.
5814
5815 Defaults to B<Detail>.
5816
5817 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5818
5819 Specifies what information to collect about routes of the daemon queried. If
5820 set to B<No>, no information is collected. If set to B<Summary>, the number of
5821 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5822 metric and ETX are collected per route.
5823
5824 Defaults to B<Summary>.
5825
5826 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5827
5828 Specifies what information to collect about the global topology. If set to
5829 B<No>, no information is collected. If set to B<Summary>, the number of links
5830 in the entire topology and the average I<link quality> (LQ) is calculated.
5831 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5832
5833 Defaults to B<Summary>.
5834
5835 =back
5836
5837 =head2 Plugin C<onewire>
5838
5839 B<EXPERIMENTAL!> See notes below.
5840
5841 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5842 L<http://owfs.org/> to read sensors connected via the onewire bus.
5843
5844 It can be used in two possible modes - standard or advanced.
5845
5846 In the standard mode only temperature sensors (sensors with the family code
5847 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5848 other sensors you would like to have included, please send a sort request to
5849 the mailing list. You can select sensors to be read or to be ignored depending
5850 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5851 walked and all sensors are read.
5852
5853 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5854 experimental, below.
5855
5856 In the advanced mode you can configure any sensor to be read (only numerical
5857 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5858 In this mode you have to list all the sensors. Neither default bus walk nor
5859 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5860 the path automatically and should produce compatible structure with the "standard"
5861 mode (basically the path is expected as for example
5862 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5863 "F10FCA000800" and the rest after the slash is considered the type - here
5864 "temperature").
5865 There are two advantages to this mode - you can access virtually any sensor
5866 (not just temperature), select whether to use cached or directly read values
5867 and it is slighlty faster. The downside is more complex configuration.
5868
5869 The two modes are distinguished automatically by the format of the address.
5870 It is not possible to mix the two modes. Once a full path is detected in any
5871 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5872 (and as standard addresses will fail parsing they will be ignored).
5873
5874 =over 4
5875
5876 =item B<Device> I<Device>
5877
5878 Sets the device to read the values from. This can either be a "real" hardware
5879 device, such as a serial port or an USB port, or the address of the
5880 L<owserver(1)> socket, usually B<localhost:4304>.
5881
5882 Though the documentation claims to automatically recognize the given address
5883 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5884 with that version, the following configuration worked for us:
5885
5886   <Plugin onewire>
5887     Device "-s localhost:4304"
5888   </Plugin>
5889
5890 This directive is B<required> and does not have a default value.
5891
5892 =item B<Sensor> I<Sensor>
5893
5894 In the standard mode selects sensors to collect or to ignore
5895 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5896 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5897 and B<not> include the leading C<10.> family byte and point.
5898 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5899 sensors (see above) are read.
5900
5901 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5902 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5903 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5904
5905 As there can be multiple devices on the bus you can list multiple sensor (use
5906 multiple B<Sensor> elements).
5907
5908 See F</"IGNORELISTS"> for details.
5909
5910 =item B<IgnoreSelected> I<true>|I<false>
5911
5912 If no configuration is given, the B<onewire> plugin will collect data from all
5913 sensors found. This may not be practical, especially if sensors are added and
5914 removed regularly. Sometimes, however, it's easier/preferred to collect only
5915 specific sensors or all sensors I<except> a few specified ones. This option
5916 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5917 B<Sensor> is inverted: All selected interfaces are ignored and all other
5918 interfaces are collected.
5919
5920 Used only in the standard mode - see above.
5921
5922 =item B<Interval> I<Seconds>
5923
5924 Sets the interval in which all sensors should be read. If not specified, the
5925 global B<Interval> setting is used.
5926
5927 =back
5928
5929 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5930 work with big setups. It works with one sensor being attached to one
5931 controller, but as soon as you throw in a couple more senors and maybe a hub
5932 or two, reading all values will take more than ten seconds (the default
5933 interval). We will probably add some separate thread for reading the sensors
5934 and some cache or something like that, but it's not done yet. We will try to
5935 maintain backwards compatibility in the future, but we can't promise. So in
5936 short: If it works for you: Great! But keep in mind that the config I<might>
5937 change, though this is unlikely. Oh, and if you want to help improving this
5938 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5939
5940 =head2 Plugin C<openldap>
5941
5942 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5943 server correctly. The backend database C<monitor> needs to be loaded and
5944 working. See slapd-monitor(5) for the details.
5945
5946 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5947 blocks. Each block requires one string argument as the instance name. For
5948 example:
5949
5950  <Plugin "openldap">
5951    <Instance "foo">
5952      URL "ldap://localhost/"
5953    </Instance>
5954    <Instance "bar">
5955      URL "ldaps://localhost/"
5956    </Instance>
5957  </Plugin>
5958
5959 The instance name will be used as the I<plugin instance>. To emulate the old
5960 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5961 plugin to work correctly, each instance name must be unique. This is not
5962 enforced by the plugin and it is your responsibility to ensure it is.
5963
5964 The following options are accepted within each B<Instance> block:
5965
5966 =over 4
5967
5968 =item B<URL> I<ldap://host/binddn>
5969
5970 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5971 I<mandatory>.
5972
5973 =item B<BindDN> I<BindDN>
5974
5975 Name in the form of an LDAP distinguished name intended to be used for
5976 authentication. Defaults to empty string to establish an anonymous authorization.
5977
5978 =item B<Password> I<Password>
5979
5980 Password for simple bind authentication. If this option is not set,
5981 unauthenticated bind operation is used.
5982
5983 =item B<StartTLS> B<true|false>
5984
5985 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5986 Disabled by default.
5987
5988 =item B<VerifyHost> B<true|false>
5989
5990 Enables or disables peer host name verification. If enabled, the plugin checks
5991 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5992 certificate matches the host name provided by the B<URL> option. If this
5993 identity check fails, the connection is aborted. Enabled by default.
5994
5995 =item B<CACert> I<File>
5996
5997 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5998 may possibly need this option. What CA certificates are checked by default
5999 depends on the distribution you use and can be changed with the usual ldap
6000 client configuration mechanisms. See ldap.conf(5) for the details.
6001
6002 =item B<Timeout> I<Seconds>
6003
6004 Sets the timeout value for ldap operations, in seconds. By default, the
6005 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6006 (infinite timeout).
6007
6008 =item B<Version> I<Version>
6009
6010 An integer which sets the LDAP protocol version number to use when connecting
6011 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6012
6013 =back
6014
6015 =head2 Plugin C<openvpn>
6016
6017 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6018 traffic statistics about connected clients.
6019
6020 To set up OpenVPN to write to the status file periodically, use the
6021 B<--status> option of OpenVPN.
6022
6023 So, in a nutshell you need:
6024
6025   openvpn $OTHER_OPTIONS \
6026     --status "/var/run/openvpn-status" 10
6027
6028 Available options:
6029
6030 =over 4
6031
6032 =item B<StatusFile> I<File>
6033
6034 Specifies the location of the status file.
6035
6036 =item B<ImprovedNamingSchema> B<true>|B<false>
6037
6038 When enabled, the filename of the status file will be used as plugin instance
6039 and the client's "common name" will be used as type instance. This is required
6040 when reading multiple status files. Enabling this option is recommended, but to
6041 maintain backwards compatibility this option is disabled by default.
6042
6043 =item B<CollectCompression> B<true>|B<false>
6044
6045 Sets whether or not statistics about the compression used by OpenVPN should be
6046 collected. This information is only available in I<single> mode. Enabled by
6047 default.
6048
6049 =item B<CollectIndividualUsers> B<true>|B<false>
6050
6051 Sets whether or not traffic information is collected for each connected client
6052 individually. If set to false, currently no traffic data is collected at all
6053 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6054
6055 =item B<CollectUserCount> B<true>|B<false>
6056
6057 When enabled, the number of currently connected clients or users is collected.
6058 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6059 can be configured independently from that option. Defaults to B<false>.
6060
6061 =back
6062
6063 =head2 Plugin C<oracle>
6064
6065 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6066 Oracle® Database and lets you execute SQL statements there. It is very similar
6067 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6068 plugin's documentation above for details.
6069
6070   <Plugin oracle>
6071     <Query "out_of_stock">
6072       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6073       <Result>
6074         Type "gauge"
6075         # InstancePrefix "foo"
6076         InstancesFrom "category"
6077         ValuesFrom "value"
6078       </Result>
6079     </Query>
6080     <Database "product_information">
6081       #Plugin "warehouse"
6082       ConnectID "db01"
6083       Username "oracle"
6084       Password "secret"
6085       Query "out_of_stock"
6086     </Database>
6087   </Plugin>
6088
6089 =head3 B<Query> blocks
6090
6091 The Query blocks are handled identically to the Query blocks of the "dbi"
6092 plugin. Please see its documentation above for details on how to specify
6093 queries.
6094
6095 =head3 B<Database> blocks
6096
6097 Database blocks define a connection to a database and which queries should be
6098 sent to that database. Each database needs a "name" as string argument in the
6099 starting tag of the block. This name will be used as "PluginInstance" in the
6100 values submitted to the daemon. Other than that, that name is not used.
6101
6102 =over 4
6103
6104 =item B<Plugin> I<Plugin>
6105
6106 Use I<Plugin> as the plugin name when submitting query results from
6107 this B<Database>. Defaults to C<oracle>.
6108
6109 =item B<ConnectID> I<ID>
6110
6111 Defines the "database alias" or "service name" to connect to. Usually, these
6112 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6113
6114 =item B<Host> I<Host>
6115
6116 Hostname to use when dispatching values for this database. Defaults to using
6117 the global hostname of the I<collectd> instance.
6118
6119 =item B<Username> I<Username>
6120
6121 Username used for authentication.
6122
6123 =item B<Password> I<Password>
6124
6125 Password used for authentication.
6126
6127 =item B<Query> I<QueryName>
6128
6129 Associates the query named I<QueryName> with this database connection. The
6130 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6131 blocks you want to refer to must be placed above the database block you want to
6132 refer to them from.
6133
6134 =back
6135
6136 =head2 Plugin C<ovs_events>
6137
6138 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6139 connected interfaces, dispatches the values to collectd and sends the
6140 notification whenever the link state change occurs. This plugin uses OVS
6141 database to get a link state change notification.
6142
6143 B<Synopsis:>
6144
6145  <Plugin "ovs_events">
6146    Port 6640
6147    Address "127.0.0.1"
6148    Socket "/var/run/openvswitch/db.sock"
6149    Interfaces "br0" "veth0"
6150    SendNotification true
6151    DispatchValues false
6152  </Plugin>
6153
6154 The plugin provides the following configuration options:
6155
6156 =over 4
6157
6158 =item B<Address> I<node>
6159
6160 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6161 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6162 option. See L<ovsdb-server(1)> for more details. The option may be either
6163 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6164 format. Defaults to C<localhost>.
6165
6166 =item B<Port> I<service>
6167
6168 TCP-port to connect to. Either a service name or a port number may be given.
6169 Defaults to B<6640>.
6170
6171 =item B<Socket> I<path>
6172
6173 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6174 plugin. To enable the interface, the OVS DB daemon should be running with
6175 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6176 option is set, B<Address> and B<Port> options are ignored.
6177
6178 =item B<Interfaces> [I<ifname> ...]
6179
6180 List of interface names to be monitored by this plugin. If this option is not
6181 specified or is empty then all OVS connected interfaces on all bridges are
6182 monitored.
6183
6184 Default: empty (all interfaces on all bridges are monitored)
6185
6186 =item B<SendNotification> I<true|false>
6187
6188 If set to true, OVS link notifications (interface status and OVS DB connection
6189 terminate) are sent to collectd. Default value is true.
6190
6191 =item B<DispatchValues> I<true|false>
6192
6193 Dispatch the OVS DB interface link status value with configured plugin interval.
6194 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6195 options are false, no OVS information will be provided by the plugin.
6196
6197 =back
6198
6199 B<Note:> By default, the global interval setting is used within which to
6200 retrieve the OVS link status. To configure a plugin-specific interval, please
6201 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6202 simple divide the time by 1000 for example if the desired interval is 50ms, set
6203 interval to 0.05.
6204
6205 =head2 Plugin C<ovs_stats>
6206
6207 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6208 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6209 statistics from OVSDB
6210
6211 B<Synopsis:>
6212
6213  <Plugin "ovs_stats">
6214    Port 6640
6215    Address "127.0.0.1"
6216    Socket "/var/run/openvswitch/db.sock"
6217    Bridges "br0" "br_ext"
6218  </Plugin>
6219
6220 The plugin provides the following configuration options:
6221
6222 =over 4
6223
6224 =item B<Address> I<node>
6225
6226 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6227 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6228 option. See L<ovsdb-server(1)> for more details. The option may be either
6229 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6230 format. Defaults to C<localhost>.
6231
6232 =item B<Port> I<service>
6233
6234 TCP-port to connect to. Either a service name or a port number may be given.
6235 Defaults to B<6640>.
6236
6237 =item B<Socket> I<path>
6238
6239 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6240 plugin. To enable the interface, the OVS DB daemon should be running with
6241 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6242 option is set, B<Address> and B<Port> options are ignored.
6243
6244 =item B<Bridges> [I<brname> ...]
6245
6246 List of OVS bridge names to be monitored by this plugin. If this option is
6247 omitted or is empty then all OVS bridges will be monitored.
6248
6249 Default: empty (monitor all bridges)
6250
6251 =back
6252
6253 =head2 Plugin C<perl>
6254
6255 This plugin embeds a Perl-interpreter into collectd and provides an interface
6256 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6257
6258 =head2 Plugin C<pinba>
6259
6260 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6261 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6262 PHP-based webpage has been delivered, the extension will send a UDP packet
6263 containing timing information, peak memory usage and so on. The plugin will
6264 wait for such packets, parse them and account the provided information, which
6265 is then dispatched to the daemon once per interval.
6266
6267 Synopsis:
6268
6269  <Plugin pinba>
6270    Address "::0"
6271    Port "30002"
6272    # Overall statistics for the website.
6273    <View "www-total">
6274      Server "www.example.com"
6275    </View>
6276    # Statistics for www-a only
6277    <View "www-a">
6278      Host "www-a.example.com"
6279      Server "www.example.com"
6280    </View>
6281    # Statistics for www-b only
6282    <View "www-b">
6283      Host "www-b.example.com"
6284      Server "www.example.com"
6285    </View>
6286  </Plugin>
6287
6288 The plugin provides the following configuration options:
6289
6290 =over 4
6291
6292 =item B<Address> I<Node>
6293
6294 Configures the address used to open a listening socket. By default, plugin will
6295 bind to the I<any> address C<::0>.
6296
6297 =item B<Port> I<Service>
6298
6299 Configures the port (service) to bind to. By default the default Pinba port
6300 "30002" will be used. The option accepts service names in addition to port
6301 numbers and thus requires a I<string> argument.
6302
6303 =item E<lt>B<View> I<Name>E<gt> block
6304
6305 The packets sent by the Pinba extension include the hostname of the server, the
6306 server name (the name of the virtual host) and the script that was executed.
6307 Using B<View> blocks it is possible to separate the data into multiple groups
6308 to get more meaningful statistics. Each packet is added to all matching groups,
6309 so that a packet may be accounted for more than once.
6310
6311 =over 4
6312
6313 =item B<Host> I<Host>
6314
6315 Matches the hostname of the system the webserver / script is running on. This
6316 will contain the result of the L<gethostname(2)> system call. If not
6317 configured, all hostnames will be accepted.
6318
6319 =item B<Server> I<Server>
6320
6321 Matches the name of the I<virtual host>, i.e. the contents of the
6322 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6323 server names will be accepted.
6324
6325 =item B<Script> I<Script>
6326
6327 Matches the name of the I<script name>, i.e. the contents of the
6328 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6329 script names will be accepted.
6330
6331 =back
6332
6333 =back
6334
6335 =head2 Plugin C<ping>
6336
6337 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6338 configured hosts periodically and measures the network latency. Whenever the
6339 C<read> function of the plugin is called, it submits the average latency, the
6340 standard deviation and the drop rate for each host.
6341
6342 Available configuration options:
6343
6344 =over 4
6345
6346 =item B<Host> I<IP-address>
6347
6348 Host to ping periodically. This option may be repeated several times to ping
6349 multiple hosts.
6350
6351 =item B<Interval> I<Seconds>
6352
6353 Sets the interval in which to send ICMP echo packets to the configured hosts.
6354 This is B<not> the interval in which metrics are read from the plugin but the
6355 interval in which the hosts are "pinged". Therefore, the setting here should be
6356 smaller than or equal to the global B<Interval> setting. Fractional times, such
6357 as "1.24" are allowed.
6358
6359 Default: B<1.0>
6360
6361 =item B<Timeout> I<Seconds>
6362
6363 Time to wait for a response from the host to which an ICMP packet had been
6364 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6365 to be down or the packet to be dropped. This setting must be smaller than the
6366 B<Interval> setting above for the plugin to work correctly. Fractional
6367 arguments are accepted.
6368
6369 Default: B<0.9>
6370
6371 =item B<TTL> I<0-255>
6372
6373 Sets the Time-To-Live of generated ICMP packets.
6374
6375 =item B<Size> I<size>
6376
6377 Sets the size of the data payload in ICMP packet to specified I<size> (it
6378 will be filled with regular ASCII pattern). If not set, default 56 byte
6379 long string is used so that the packet size of an ICMPv4 packet is exactly
6380 64 bytes, similar to the behaviour of normal ping(1) command.
6381
6382 =item B<SourceAddress> I<host>
6383
6384 Sets the source address to use. I<host> may either be a numerical network
6385 address or a network hostname.
6386
6387 =item B<AddressFamily> I<af>
6388
6389 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6390 option will be ignored if you set a B<SourceAddress>.
6391
6392 =item B<Device> I<name>
6393
6394 Sets the outgoing network device to be used. I<name> has to specify an
6395 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6396 operating systems.
6397
6398 =item B<MaxMissed> I<Packets>
6399
6400 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6401 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6402
6403 Default: B<-1> (disabled)
6404
6405 =back
6406
6407 =head2 Plugin C<postgresql>
6408
6409 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6410 keeps a persistent connection to all configured databases and tries to
6411 reconnect if the connection has been interrupted. A database is configured by
6412 specifying a B<Database> block as described below. The default statistics are
6413 collected from PostgreSQL's B<statistics collector> which thus has to be
6414 enabled for this plugin to work correctly. This should usually be the case by
6415 default. See the section "The Statistics Collector" of the B<PostgreSQL
6416 Documentation> for details.
6417
6418 By specifying custom database queries using a B<Query> block as described
6419 below, you may collect any data that is available from some PostgreSQL
6420 database. This way, you are able to access statistics of external daemons
6421 which are available in a PostgreSQL database or use future or special
6422 statistics provided by PostgreSQL without the need to upgrade your collectd
6423 installation.
6424
6425 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6426 PostgreSQL databases as well. This has been implemented in a generic way. You
6427 need to specify an SQL statement which will then be executed by collectd in
6428 order to write the data (see below for details). The benefit of that approach
6429 is that there is no fixed database layout. Rather, the layout may be optimized
6430 for the current setup.
6431
6432 The B<PostgreSQL Documentation> manual can be found at
6433 L<http://www.postgresql.org/docs/manuals/>.
6434
6435   <Plugin postgresql>
6436     <Query magic>
6437       Statement "SELECT magic FROM wizard WHERE host = $1;"
6438       Param hostname
6439       <Result>
6440         Type gauge
6441         InstancePrefix "magic"
6442         ValuesFrom magic
6443       </Result>
6444     </Query>
6445
6446     <Query rt36_tickets>
6447       Statement "SELECT COUNT(type) AS count, type \
6448                         FROM (SELECT CASE \
6449                                      WHEN resolved = 'epoch' THEN 'open' \
6450                                      ELSE 'resolved' END AS type \
6451                                      FROM tickets) type \
6452                         GROUP BY type;"
6453       <Result>
6454         Type counter
6455         InstancePrefix "rt36_tickets"
6456         InstancesFrom "type"
6457         ValuesFrom "count"
6458       </Result>
6459     </Query>
6460
6461     <Writer sqlstore>
6462       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6463       StoreRates true
6464     </Writer>
6465
6466     <Database foo>
6467       Plugin "kingdom"
6468       Host "hostname"
6469       Port "5432"
6470       User "username"
6471       Password "secret"
6472       SSLMode "prefer"
6473       KRBSrvName "kerberos_service_name"
6474       Query magic
6475     </Database>
6476
6477     <Database bar>
6478       Interval 300
6479       Service "service_name"
6480       Query backends # predefined
6481       Query rt36_tickets
6482     </Database>
6483
6484     <Database qux>
6485       # ...
6486       Writer sqlstore
6487       CommitInterval 10
6488     </Database>
6489   </Plugin>
6490
6491 The B<Query> block defines one database query which may later be used by a
6492 database definition. It accepts a single mandatory argument which specifies
6493 the name of the query. The names of all queries have to be unique (see the
6494 B<MinVersion> and B<MaxVersion> options below for an exception to this
6495 rule).
6496
6497 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6498 B<Result> blocks may be used to extract multiple values from a single query.
6499
6500 The following configuration options are available to define the query:
6501
6502 =over 4
6503
6504 =item B<Statement> I<sql query statement>
6505
6506 Specify the I<sql query statement> which the plugin should execute. The string
6507 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6508 first, second, etc. parameter. The value of the parameters is specified by the
6509 B<Param> configuration option - see below for details. To include a literal
6510 B<$> character followed by a number, surround it with single quotes (B<'>).
6511
6512 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6513 allowed. Note, however, that only a single command may be used. Semicolons are
6514 allowed as long as a single non-empty command has been specified only.
6515
6516 The returned lines will be handled separately one after another.
6517
6518 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6519
6520 Specify the parameters which should be passed to the SQL query. The parameters
6521 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6522 they appear in the configuration file. The value of the parameter is
6523 determined depending on the value of the B<Param> option as follows:
6524
6525 =over 4
6526
6527 =item I<hostname>
6528
6529 The configured hostname of the database connection. If a UNIX domain socket is
6530 used, the parameter expands to "localhost".
6531
6532 =item I<database>
6533
6534 The name of the database of the current connection.
6535
6536 =item I<instance>
6537
6538 The name of the database plugin instance. See the B<Instance> option of the
6539 database specification below for details.
6540
6541 =item I<username>
6542
6543 The username used to connect to the database.
6544
6545 =item I<interval>
6546
6547 The interval with which this database is queried (as specified by the database
6548 specific or global B<Interval> options).
6549
6550 =back
6551
6552 Please note that parameters are only supported by PostgreSQL's protocol
6553 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6554
6555 =item B<PluginInstanceFrom> I<column>
6556
6557 Specify how to create the "PluginInstance" for reporting this query results.
6558 Only one column is supported. You may concatenate fields and string values in
6559 the query statement to get the required results.
6560
6561 =item B<MinVersion> I<version>
6562
6563 =item B<MaxVersion> I<version>
6564
6565 Specify the minimum or maximum version of PostgreSQL that this query should be
6566 used with. Some statistics might only be available with certain versions of
6567 PostgreSQL. This allows you to specify multiple queries with the same name but
6568 which apply to different versions, thus allowing you to use the same
6569 configuration in a heterogeneous environment.
6570
6571 The I<version> has to be specified as the concatenation of the major, minor
6572 and patch-level versions, each represented as two-decimal-digit numbers. For
6573 example, version 8.2.3 will become 80203.
6574
6575 =back
6576
6577 The B<Result> block defines how to handle the values returned from the query.
6578 It defines which column holds which value and how to dispatch that value to
6579 the daemon.
6580
6581 =over 4
6582
6583 =item B<Type> I<type>
6584
6585 The I<type> name to be used when dispatching the values. The type describes
6586 how to handle the data and where to store it. See L<types.db(5)> for more
6587 details on types and their configuration. The number and type of values (as
6588 selected by the B<ValuesFrom> option) has to match the type of the given name.
6589
6590 This option is mandatory.
6591
6592 =item B<InstancePrefix> I<prefix>
6593
6594 =item B<InstancesFrom> I<column0> [I<column1> ...]
6595
6596 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6597 B<InstancePrefix> defines a static prefix that will be prepended to all type
6598 instances. B<InstancesFrom> defines the column names whose values will be used
6599 to create the type instance. Multiple values will be joined together using the
6600 hyphen (C<->) as separation character.
6601
6602 The plugin itself does not check whether or not all built instances are
6603 different. It is your responsibility to assure that each is unique.
6604
6605 Both options are optional. If none is specified, the type instance will be
6606 empty.
6607
6608 =item B<ValuesFrom> I<column0> [I<column1> ...]
6609
6610 Names the columns whose content is used as the actual data for the data sets
6611 that are dispatched to the daemon. How many such columns you need is
6612 determined by the B<Type> setting as explained above. If you specify too many
6613 or not enough columns, the plugin will complain about that and no data will be
6614 submitted to the daemon.
6615
6616 The actual data type, as seen by PostgreSQL, is not that important as long as
6617 it represents numbers. The plugin will automatically cast the values to the
6618 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6619 L<strtod(3)> functions, so anything supported by those functions is supported
6620 by the plugin as well.
6621
6622 This option is required inside a B<Result> block and may be specified multiple
6623 times. If multiple B<ValuesFrom> options are specified, the columns are read
6624 in the given order.
6625
6626 =back
6627
6628 The following predefined queries are available (the definitions can be found
6629 in the F<postgresql_default.conf> file which, by default, is available at
6630 C<I<prefix>/share/collectd/>):
6631
6632 =over 4
6633
6634 =item B<backends>
6635
6636 This query collects the number of backends, i.E<nbsp>e. the number of
6637 connected clients.
6638
6639 =item B<transactions>
6640
6641 This query collects the numbers of committed and rolled-back transactions of
6642 the user tables.
6643
6644 =item B<queries>
6645
6646 This query collects the numbers of various table modifications (i.E<nbsp>e.
6647 insertions, updates, deletions) of the user tables.
6648
6649 =item B<query_plans>
6650
6651 This query collects the numbers of various table scans and returned tuples of
6652 the user tables.
6653
6654 =item B<table_states>
6655
6656 This query collects the numbers of live and dead rows in the user tables.
6657
6658 =item B<disk_io>
6659
6660 This query collects disk block access counts for user tables.
6661
6662 =item B<disk_usage>
6663
6664 This query collects the on-disk size of the database in bytes.
6665
6666 =back
6667
6668 In addition, the following detailed queries are available by default. Please
6669 note that each of those queries collects information B<by table>, thus,
6670 potentially producing B<a lot> of data. For details see the description of the
6671 non-by_table queries above.
6672
6673 =over 4
6674
6675 =item B<queries_by_table>
6676
6677 =item B<query_plans_by_table>
6678
6679 =item B<table_states_by_table>
6680
6681 =item B<disk_io_by_table>
6682
6683 =back
6684
6685 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6686 mandatory argument specifying the name of the writer. This will then be used
6687 in the B<Database> specification in order to activate the writer instance. The
6688 names of all writers have to be unique. The following options may be
6689 specified:
6690
6691 =over 4
6692
6693 =item B<Statement> I<sql statement>
6694
6695 This mandatory option specifies the SQL statement that will be executed for
6696 each submitted value. A single SQL statement is allowed only. Anything after
6697 the first semicolon will be ignored.
6698
6699 Nine parameters will be passed to the statement and should be specified as
6700 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6701 values are made available through those parameters:
6702
6703 =over 4
6704
6705 =item B<$1>
6706
6707 The timestamp of the queried value as an RFC 3339-formatted local time.
6708
6709 =item B<$2>
6710
6711 The hostname of the queried value.
6712
6713 =item B<$3>
6714
6715 The plugin name of the queried value.
6716
6717 =item B<$4>
6718
6719 The plugin instance of the queried value. This value may be B<NULL> if there
6720 is no plugin instance.
6721
6722 =item B<$5>
6723
6724 The type of the queried value (cf. L<types.db(5)>).
6725
6726 =item B<$6>
6727
6728 The type instance of the queried value. This value may be B<NULL> if there is
6729 no type instance.
6730
6731 =item B<$7>
6732
6733 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6734 sources of the submitted value-list).
6735
6736 =item B<$8>
6737
6738 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6739 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6740 B<StoreRates> is enabled (which is the default, see below), all types will be
6741 C<gauge>.
6742
6743 =item B<$9>
6744
6745 An array of the submitted values. The dimensions of the value name and value
6746 arrays match.
6747
6748 =back
6749
6750 In general, it is advisable to create and call a custom function in the
6751 PostgreSQL database for this purpose. Any procedural language supported by
6752 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6753 for details).
6754
6755 =item B<StoreRates> B<false>|B<true>
6756
6757 If set to B<true> (the default), convert counter values to rates. If set to
6758 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6759 number.
6760
6761 =back
6762
6763 The B<Database> block defines one PostgreSQL database for which to collect
6764 statistics. It accepts a single mandatory argument which specifies the
6765 database name. None of the other options are required. PostgreSQL will use
6766 default values as documented in the section "CONNECTING TO A DATABASE" in the
6767 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6768 the user collectd is run as and special environment variables. See the manpage
6769 for details.
6770
6771 =over 4
6772
6773 =item B<Interval> I<seconds>
6774
6775 Specify the interval with which the database should be queried. The default is
6776 to use the global B<Interval> setting.
6777
6778 =item B<CommitInterval> I<seconds>
6779
6780 This option may be used for database connections which have "writers" assigned
6781 (see above). If specified, it causes a writer to put several updates into a
6782 single transaction. This transaction will last for the specified amount of
6783 time. By default, each update will be executed in a separate transaction. Each
6784 transaction generates a fair amount of overhead which can, thus, be reduced by
6785 activating this option. The draw-back is, that data covering the specified
6786 amount of time will be lost, for example, if a single statement within the
6787 transaction fails or if the database server crashes.
6788
6789 =item B<Plugin> I<Plugin>
6790
6791 Use I<Plugin> as the plugin name when submitting query results from
6792 this B<Database>. Defaults to C<postgresql>.
6793
6794 =item B<Instance> I<name>
6795
6796 Specify the plugin instance name that should be used instead of the database
6797 name (which is the default, if this option has not been specified). This
6798 allows one to query multiple databases of the same name on the same host (e.g.
6799 when running multiple database server versions in parallel).
6800 The plugin instance name can also be set from the query result using
6801 the B<PluginInstanceFrom> option in B<Query> block.
6802
6803 =item B<Host> I<hostname>
6804
6805 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6806 value begins with a slash, it is interpreted as the directory name in which to
6807 look for the UNIX domain socket.
6808
6809 This option is also used to determine the hostname that is associated with a
6810 collected data set. If it has been omitted or either begins with with a slash
6811 or equals B<localhost> it will be replaced with the global hostname definition
6812 of collectd. Any other value will be passed literally to collectd when
6813 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6814
6815 =item B<Port> I<port>
6816
6817 Specify the TCP port or the local UNIX domain socket file extension of the
6818 server.
6819
6820 =item B<User> I<username>
6821
6822 Specify the username to be used when connecting to the server.
6823
6824 =item B<Password> I<password>
6825
6826 Specify the password to be used when connecting to the server.
6827
6828 =item B<ExpireDelay> I<delay>
6829
6830 Skip expired values in query output.
6831
6832 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6833
6834 Specify whether to use an SSL connection when contacting the server. The
6835 following modes are supported:
6836
6837 =over 4
6838
6839 =item I<disable>
6840
6841 Do not use SSL at all.
6842
6843 =item I<allow>
6844
6845 First, try to connect without using SSL. If that fails, try using SSL.
6846
6847 =item I<prefer> (default)
6848
6849 First, try to connect using SSL. If that fails, try without using SSL.
6850
6851 =item I<require>
6852
6853 Use SSL only.
6854
6855 =back
6856
6857 =item B<Instance> I<name>
6858
6859 Specify the plugin instance name that should be used instead of the database
6860 name (which is the default, if this option has not been specified). This
6861 allows one to query multiple databases of the same name on the same host (e.g.
6862 when running multiple database server versions in parallel).
6863
6864 =item B<KRBSrvName> I<kerberos_service_name>
6865
6866 Specify the Kerberos service name to use when authenticating with Kerberos 5
6867 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6868 B<PostgreSQL Documentation> for details.
6869
6870 =item B<Service> I<service_name>
6871
6872 Specify the PostgreSQL service name to use for additional parameters. That
6873 service has to be defined in F<pg_service.conf> and holds additional
6874 connection parameters. See the section "The Connection Service File" in the
6875 B<PostgreSQL Documentation> for details.
6876
6877 =item B<Query> I<query>
6878
6879 Specifies a I<query> which should be executed in the context of the database
6880 connection. This may be any of the predefined or user-defined queries. If no
6881 such option is given, it defaults to "backends", "transactions", "queries",
6882 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6883 has been specified). Else, the specified queries are used only.
6884
6885 =item B<Writer> I<writer>
6886
6887 Assigns the specified I<writer> backend to the database connection. This
6888 causes all collected data to be send to the database using the settings
6889 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6890 below for details on how to selectively send data to certain plugins).
6891
6892 Each writer will register a flush callback which may be used when having long
6893 transactions enabled (see the B<CommitInterval> option above). When issuing
6894 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6895 transaction will be committed right away. Two different kinds of flush
6896 callbacks are available with the C<postgresql> plugin:
6897
6898 =over 4
6899
6900 =item B<postgresql>
6901
6902 Flush all writer backends.
6903
6904 =item B<postgresql->I<database>
6905
6906 Flush all writers of the specified I<database> only.
6907
6908 =back
6909
6910 =back
6911
6912 =head2 Plugin C<powerdns>
6913
6914 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6915 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6916 values, many of which are probably meaningless to most users, but may be useful
6917 for some. So you may chose which values to collect, but if you don't, some
6918 reasonable defaults will be collected.
6919
6920   <Plugin "powerdns">
6921     <Server "server_name">
6922       Collect "latency"
6923       Collect "udp-answers" "udp-queries"
6924       Socket "/var/run/pdns.controlsocket"
6925     </Server>
6926     <Recursor "recursor_name">
6927       Collect "questions"
6928       Collect "cache-hits" "cache-misses"
6929       Socket "/var/run/pdns_recursor.controlsocket"
6930     </Recursor>
6931     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6932   </Plugin>
6933
6934 =over 4
6935
6936 =item B<Server> and B<Recursor> block
6937
6938 The B<Server> block defines one authoritative server to query, the B<Recursor>
6939 does the same for an recursing server. The possible options in both blocks are
6940 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6941 and is required.
6942
6943 =over 4
6944
6945 =item B<Collect> I<Field>
6946
6947 Using the B<Collect> statement you can select which values to collect. Here,
6948 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6949 C<dlg-only-drops>, C<answers10-100>.
6950
6951 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6952 When querying the server a C<SHOW *> command is issued in any case, because
6953 that's the only way of getting multiple values out of the server at once.
6954 collectd then picks out the values you have selected. When querying the
6955 recursor, a command is generated to query exactly these values. So if you
6956 specify invalid fields when querying the recursor, a syntax error may be
6957 returned by the daemon and collectd may not collect any values at all.
6958
6959 If no B<Collect> statement is given, the following B<Server> values will be
6960 collected:
6961
6962 =over 4
6963
6964 =item latency
6965
6966 =item packetcache-hit
6967
6968 =item packetcache-miss
6969
6970 =item packetcache-size
6971
6972 =item query-cache-hit
6973
6974 =item query-cache-miss
6975
6976 =item recursing-answers
6977
6978 =item recursing-questions
6979
6980 =item tcp-answers
6981
6982 =item tcp-queries
6983
6984 =item udp-answers
6985
6986 =item udp-queries
6987
6988 =back
6989
6990 The following B<Recursor> values will be collected by default:
6991
6992 =over 4
6993
6994 =item noerror-answers
6995
6996 =item nxdomain-answers
6997
6998 =item servfail-answers
6999
7000 =item sys-msec
7001
7002 =item user-msec
7003
7004 =item qa-latency
7005
7006 =item cache-entries
7007
7008 =item cache-hits
7009
7010 =item cache-misses
7011
7012 =item questions
7013
7014 =back
7015
7016 Please note that up to that point collectd doesn't know what values are
7017 available on the server and values that are added do not need a change of the
7018 mechanism so far. However, the values must be mapped to collectd's naming
7019 scheme, which is done using a lookup table that lists all known values. If
7020 values are added in the future and collectd does not know about them, you will
7021 get an error much like this:
7022
7023   powerdns plugin: submit: Not found in lookup table: foobar = 42
7024
7025 In this case please file a bug report with the collectd team.
7026
7027 =item B<Socket> I<Path>
7028
7029 Configures the path to the UNIX domain socket to be used when connecting to the
7030 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7031 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7032 will be used for the recursor.
7033
7034 =back
7035
7036 =item B<LocalSocket> I<Path>
7037
7038 Querying the recursor is done using UDP. When using UDP over UNIX domain
7039 sockets, the client socket needs a name in the file system, too. You can set
7040 this local name to I<Path> using the B<LocalSocket> option. The default is
7041 C<I<prefix>/var/run/collectd-powerdns>.
7042
7043 =back
7044
7045 =head2 Plugin C<processes>
7046
7047 Collects information about processes of local system.
7048
7049 By default, with no process matches configured, only general statistics is
7050 collected: the number of processes in each state and fork rate.
7051
7052 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7053 These may also be a block in which further options may be specified.
7054
7055 The statistics collected for matched processes are:
7056  - size of the resident segment size (RSS)
7057  - user- and system-time used
7058  - number of processes
7059  - number of threads
7060  - number of open files (under Linux)
7061  - number of memory mapped files (under Linux)
7062  - io data (where available)
7063  - context switches (under Linux)
7064  - minor and major pagefaults
7065  - Delay Accounting information (Linux only, requires libmnl)
7066
7067 B<Synopsis:>
7068
7069  <Plugin processes>
7070    CollectFileDescriptor  true
7071    CollectContextSwitch   true
7072    CollectDelayAccounting false
7073    Process "name"
7074    ProcessMatch "name" "regex"
7075    <Process "collectd">
7076      CollectFileDescriptor  false
7077      CollectContextSwitch   false
7078      CollectDelayAccounting true
7079    </Process>
7080    <ProcessMatch "name" "regex">
7081      CollectFileDescriptor false
7082      CollectContextSwitch true
7083    </ProcessMatch>
7084  </Plugin>
7085
7086 =over 4
7087
7088 =item B<Process> I<Name>
7089
7090 Select more detailed statistics of processes matching this name.
7091
7092 Some platforms have a limit on the length of process names.
7093 I<Name> must stay below this limit.
7094
7095 =item B<ProcessMatch> I<name> I<regex>
7096
7097 Select more detailed statistics of processes matching the specified I<regex>
7098 (see L<regex(7)> for details). The statistics of all matching processes are
7099 summed up and dispatched to the daemon using the specified I<name> as an
7100 identifier. This allows one to "group" several processes together.
7101 I<name> must not contain slashes.
7102
7103 =item B<CollectContextSwitch> I<Boolean>
7104
7105 Collect the number of context switches for matched processes.
7106 Disabled by default.
7107
7108 =item B<CollectDelayAccounting> I<Boolean>
7109
7110 If enabled, collect Linux Delay Accounding information for matching processes.
7111 Delay Accounting provides the time processes wait for the CPU to become
7112 available, for I/O operations to finish, for pages to be swapped in and for
7113 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7114 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7115 Disabled by default.
7116
7117 This option is only available on Linux, requires the C<libmnl> library and
7118 requires the C<CAP_NET_ADMIN> capability at runtime.
7119
7120 =item B<CollectFileDescriptor> I<Boolean>
7121
7122 Collect number of file descriptors of matched processes.
7123 Disabled by default.
7124
7125 =item B<CollectMemoryMaps> I<Boolean>
7126
7127 Collect the number of memory mapped files of the process.
7128 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7129 the Linux kernel.
7130
7131 =back
7132
7133 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7134 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7135 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7136 reporting the corresponding processes only. Outside of B<Process> and
7137 B<ProcessMatch> blocks these options set the default value for subsequent
7138 matches.
7139
7140 =head2 Plugin C<protocols>
7141
7142 Collects a lot of information about various network protocols, such as I<IP>,
7143 I<TCP>, I<UDP>, etc.
7144
7145 Available configuration options:
7146
7147 =over 4
7148
7149 =item B<Value> I<Selector>
7150
7151 Selects whether or not to select a specific value. The string being matched is
7152 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7153 plugin instance and I<ValueName> will be used as type instance. An example of
7154 the string being used would be C<Tcp:RetransSegs>.
7155
7156 You can use regular expressions to match a large number of values with just one
7157 configuration option. To select all "extended" I<TCP> values, you could use the
7158 following statement:
7159
7160   Value "/^TcpExt:/"
7161
7162 Whether only matched values are selected or all matched values are ignored
7163 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7164 If no value is configured at all, all values will be selected.
7165
7166 See F</"IGNORELISTS"> for details.
7167
7168 =item B<IgnoreSelected> B<true>|B<false>
7169
7170 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7171 matching values will be ignored.
7172
7173 =back
7174
7175 =head2 Plugin C<python>
7176
7177 This plugin embeds a Python-interpreter into collectd and provides an interface
7178 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7179
7180 =head2 Plugin C<routeros>
7181
7182 The C<routeros> plugin connects to a device running I<RouterOS>, the
7183 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7184 I<librouteros> to connect and reads information about the interfaces and
7185 wireless connections of the device. The configuration supports querying
7186 multiple routers:
7187
7188   <Plugin "routeros">
7189     <Router>
7190       Host "router0.example.com"
7191       User "collectd"
7192       Password "secr3t"
7193       CollectInterface true
7194       CollectCPULoad true
7195       CollectMemory true
7196     </Router>
7197     <Router>
7198       Host "router1.example.com"
7199       User "collectd"
7200       Password "5ecret"
7201       CollectInterface true
7202       CollectRegistrationTable true
7203       CollectDF true
7204       CollectDisk true
7205     </Router>
7206   </Plugin>
7207
7208 As you can see above, the configuration of the I<routeros> plugin consists of
7209 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7210 options are understood:
7211
7212 =over 4
7213
7214 =item B<Host> I<Host>
7215
7216 Hostname or IP-address of the router to connect to.
7217
7218 =item B<Port> I<Port>
7219
7220 Port name or port number used when connecting. If left unspecified, the default
7221 will be chosen by I<librouteros>, currently "8728". This option expects a
7222 string argument, even when a numeric port number is given.
7223
7224 =item B<User> I<User>
7225
7226 Use the user name I<User> to authenticate. Defaults to "admin".
7227
7228 =item B<Password> I<Password>
7229
7230 Set the password used to authenticate.
7231
7232 =item B<CollectInterface> B<true>|B<false>
7233
7234 When set to B<true>, interface statistics will be collected for all interfaces
7235 present on the device. Defaults to B<false>.
7236
7237 =item B<CollectRegistrationTable> B<true>|B<false>
7238
7239 When set to B<true>, information about wireless LAN connections will be
7240 collected. Defaults to B<false>.
7241
7242 =item B<CollectCPULoad> B<true>|B<false>
7243
7244 When set to B<true>, information about the CPU usage will be collected. The
7245 number is a dimensionless value where zero indicates no CPU usage at all.
7246 Defaults to B<false>.
7247
7248 =item B<CollectMemory> B<true>|B<false>
7249
7250 When enabled, the amount of used and free memory will be collected. How used
7251 memory is calculated is unknown, for example whether or not caches are counted
7252 as used space.
7253 Defaults to B<false>.
7254
7255 =item B<CollectDF> B<true>|B<false>
7256
7257 When enabled, the amount of used and free disk space will be collected.
7258 Defaults to B<false>.
7259
7260 =item B<CollectDisk> B<true>|B<false>
7261
7262 When enabled, the number of sectors written and bad blocks will be collected.
7263 Defaults to B<false>.
7264
7265 =back
7266
7267 =head2 Plugin C<redis>
7268
7269 The I<Redis plugin> connects to one or more Redis servers and gathers
7270 information about each server's state. For each server there is a I<Node> block
7271 which configures the connection parameters for this node.
7272
7273   <Plugin redis>
7274     <Node "example">
7275         Host "localhost"
7276         Port "6379"
7277         Timeout 2000
7278         <Query "LLEN myqueue">
7279           Type "queue_length"
7280           Instance "myqueue"
7281         <Query>
7282     </Node>
7283   </Plugin>
7284
7285 The information shown in the synopsis above is the I<default configuration>
7286 which is used by the plugin if no configuration is present.
7287
7288 =over 4
7289
7290 =item B<Node> I<Nodename>
7291
7292 The B<Node> block identifies a new Redis node, that is a new Redis instance
7293 running in an specified host and port. The name for node is a canonical
7294 identifier which is used as I<plugin instance>. It is limited to
7295 64E<nbsp>characters in length.
7296
7297 =item B<Host> I<Hostname>
7298
7299 The B<Host> option is the hostname or IP-address where the Redis instance is
7300 running on.
7301
7302 =item B<Port> I<Port>
7303
7304 The B<Port> option is the TCP port on which the Redis instance accepts
7305 connections. Either a service name of a port number may be given. Please note
7306 that numerical port numbers must be given as a string, too.
7307
7308 =item B<Password> I<Password>
7309
7310 Use I<Password> to authenticate when connecting to I<Redis>.
7311
7312 =item B<Timeout> I<Milliseconds>
7313
7314 The B<Timeout> option set the socket timeout for node response. Since the Redis
7315 read function is blocking, you should keep this value as low as possible. Keep
7316 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
7317 than B<Interval> defined globally.
7318
7319 =item B<Query> I<Querystring>
7320
7321 The B<Query> block identifies a query to execute against the redis server.
7322 There may be an arbitrary number of queries to execute.
7323
7324 =item B<Type> I<Collectd type>
7325
7326 Within a query definition, a valid collectd type to use as when submitting
7327 the result of the query. When not supplied, will default to B<gauge>.
7328
7329 =item B<Instance> I<Type instance>
7330
7331 Within a query definition, an optional type instance to use when submitting
7332 the result of the query. When not supplied will default to the escaped
7333 command, up to 64 chars.
7334
7335 =back
7336
7337 =head2 Plugin C<rrdcached>
7338
7339 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7340 to store values to RRD files in an efficient manner. The combination of the
7341 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7342 way the C<rrdtool> plugin works (see below). The added abstraction layer
7343 provides a number of benefits, though: Because the cache is not within
7344 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7345 restarted. This results in much shorter (if any) gaps in graphs, especially
7346 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7347 daemon so that it can flush values to disk automatically when needed. This
7348 allows one to integrate automated flushing of values into graphing solutions
7349 much more easily.
7350
7351 There are disadvantages, though: The daemon may reside on a different host, so
7352 it may not be possible for C<collectd> to create the appropriate RRD files
7353 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7354 different base directory, so relative paths may do weird stuff if you're not
7355 careful.
7356
7357 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7358 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7359 setting should be set to an absolute path, so that a changed base directory
7360 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7361
7362 =over 4
7363
7364 =item B<DaemonAddress> I<Address>
7365
7366 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7367 library. See L<rrdcached(1)> for details. Example:
7368
7369   <Plugin "rrdcached">
7370     DaemonAddress "unix:/var/run/rrdcached.sock"
7371   </Plugin>
7372
7373 =item B<DataDir> I<Directory>
7374
7375 Set the base directory in which the RRD files reside. If this is a relative
7376 path, it is relative to the working base directory of the C<rrdcached> daemon!
7377 Use of an absolute path is recommended.
7378
7379 =item B<CreateFiles> B<true>|B<false>
7380
7381 Enables or disables the creation of RRD files. If the daemon is not running
7382 locally, or B<DataDir> is set to a relative path, this will not work as
7383 expected. Default is B<true>.
7384
7385 =item B<CreateFilesAsync> B<false>|B<true>
7386
7387 When enabled, new RRD files are enabled asynchronously, using a separate thread
7388 that runs in the background. This prevents writes to block, which is a problem
7389 especially when many hundreds of files need to be created at once. However,
7390 since the purpose of creating the files asynchronously is I<not> to block until
7391 the file is available, values before the file is available will be discarded.
7392 When disabled (the default) files are created synchronously, blocking for a
7393 short while, while the file is being written.
7394
7395 =item B<StepSize> I<Seconds>
7396
7397 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7398 this setting is unset and the stepsize is set to the interval in which the data
7399 is collected. Do not use this option unless you absolutely have to for some
7400 reason. Setting this option may cause problems with the C<snmp plugin>, the
7401 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7402
7403 =item B<HeartBeat> I<Seconds>
7404
7405 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7406 in which case the heartbeat is set to twice the B<StepSize> which should equal
7407 the interval in which data is collected. Do not set this option unless you have
7408 a very good reason to do so.
7409
7410 =item B<RRARows> I<NumRows>
7411
7412 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7413 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7414 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7415 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7416 week, one month, and one year.
7417
7418 So for each timespan, it calculates how many PDPs need to be consolidated into
7419 one CDP by calculating:
7420   number of PDPs = timespan / (stepsize * rrarows)
7421
7422 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7423 default is 1200.
7424
7425 =item B<RRATimespan> I<Seconds>
7426
7427 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7428 more then one RRA. If this option is never used, the built-in default of (3600,
7429 86400, 604800, 2678400, 31622400) is used.
7430
7431 For more information on how RRA-sizes are calculated see B<RRARows> above.
7432
7433 =item B<XFF> I<Factor>
7434
7435 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7436 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7437 one (exclusive).
7438
7439 =item B<CollectStatistics> B<false>|B<true>
7440
7441 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7442 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7443
7444 Statistics are read via I<rrdcached>s socket using the STATS command.
7445 See L<rrdcached(1)> for details.
7446
7447 =back
7448
7449 =head2 Plugin C<rrdtool>
7450
7451 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7452 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7453 using these settings. If you don't want to dive into the depths of RRDtool, you
7454 can safely ignore these settings.
7455
7456 =over 4
7457
7458 =item B<DataDir> I<Directory>
7459
7460 Set the directory to store RRD files under. By default RRD files are generated
7461 beneath the daemon's working directory, i.e. the B<BaseDir>.
7462
7463 =item B<CreateFilesAsync> B<false>|B<true>
7464
7465 When enabled, new RRD files are enabled asynchronously, using a separate thread
7466 that runs in the background. This prevents writes to block, which is a problem
7467 especially when many hundreds of files need to be created at once. However,
7468 since the purpose of creating the files asynchronously is I<not> to block until
7469 the file is available, values before the file is available will be discarded.
7470 When disabled (the default) files are created synchronously, blocking for a
7471 short while, while the file is being written.
7472
7473 =item B<StepSize> I<Seconds>
7474
7475 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7476 this setting is unset and the stepsize is set to the interval in which the data
7477 is collected. Do not use this option unless you absolutely have to for some
7478 reason. Setting this option may cause problems with the C<snmp plugin>, the
7479 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7480
7481 =item B<HeartBeat> I<Seconds>
7482
7483 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7484 in which case the heartbeat is set to twice the B<StepSize> which should equal
7485 the interval in which data is collected. Do not set this option unless you have
7486 a very good reason to do so.
7487
7488 =item B<RRARows> I<NumRows>
7489
7490 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7491 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7492 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7493 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7494 week, one month, and one year.
7495
7496 So for each timespan, it calculates how many PDPs need to be consolidated into
7497 one CDP by calculating:
7498   number of PDPs = timespan / (stepsize * rrarows)
7499
7500 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7501 default is 1200.
7502
7503 =item B<RRATimespan> I<Seconds>
7504
7505 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7506 more then one RRA. If this option is never used, the built-in default of (3600,
7507 86400, 604800, 2678400, 31622400) is used.
7508
7509 For more information on how RRA-sizes are calculated see B<RRARows> above.
7510
7511 =item B<XFF> I<Factor>
7512
7513 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7514 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7515 one (exclusive).
7516
7517 =item B<CacheFlush> I<Seconds>
7518
7519 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7520 it writes all values for a certain RRD-file if the oldest value is older than
7521 (or equal to) the number of seconds specified by B<CacheTimeout>.
7522 That check happens on new values arriwal. If some RRD-file is not updated
7523 anymore for some reason (the computer was shut down, the network is broken,
7524 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7525 every I<Seconds> seconds the entire cache is searched for entries older than
7526 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7527 disk. Since scanning the entire cache is kind of expensive and does nothing
7528 under normal circumstances, this value should not be too small. 900 seconds
7529 might be a good value, though setting this to 7200 seconds doesn't normally
7530 do much harm either.
7531
7532 Defaults to 10x B<CacheTimeout>.
7533 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7534 above default is used.
7535
7536 =item B<CacheTimeout> I<Seconds>
7537
7538 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7539 save values in a cache, as described above. Writing multiple values at once
7540 reduces IO-operations and thus lessens the load produced by updating the files.
7541 The trade off is that the graphs kind of "drag behind" and that more memory is
7542 used.
7543
7544 =item B<WritesPerSecond> I<Updates>
7545
7546 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7547 will run serious performance problems. The B<CacheFlush> setting and the
7548 internal update queue assert that collectd continues to work just fine even
7549 under heavy load, but the system may become very unresponsive and slow. This is
7550 a problem especially if you create graphs from the RRD files on the same
7551 machine, for example using the C<graph.cgi> script included in the
7552 C<contrib/collection3/> directory.
7553
7554 This setting is designed for very large setups. Setting this option to a value
7555 between 25 and 80 updates per second, depending on your hardware, will leave
7556 the server responsive enough to draw graphs even while all the cached values
7557 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7558 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7559 written as fast as possible, so that web frontends have up to date data when
7560 generating graphs.
7561
7562 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7563 updates per second, writing all values to disk will take approximately
7564 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7565 "collection3" you'll end up with a responsive and fast system, up to date
7566 graphs and basically a "backup" of your values every hour.
7567
7568 =item B<RandomTimeout> I<Seconds>
7569
7570 When set, the actual timeout for each value is chosen randomly between
7571 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7572 intention is to avoid high load situations that appear when many values timeout
7573 at the same time. This is especially a problem shortly after the daemon starts,
7574 because all values were added to the internal cache at roughly the same time.
7575
7576 =back
7577
7578 =head2 Plugin C<sensors>
7579
7580 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7581 that all the needed modules have to be loaded and lm_sensors has to be
7582 configured (most likely by editing F</etc/sensors.conf>. Read
7583 L<sensors.conf(5)> for details.
7584
7585 The B<lm_sensors> homepage can be found at
7586 L<http://secure.netroedge.com/~lm78/>.
7587
7588 =over 4
7589
7590 =item B<SensorConfigFile> I<File>
7591
7592 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7593 the library's default will be used.
7594
7595 =item B<Sensor> I<chip-bus-address/type-feature>
7596
7597 Selects the name of the sensor which you want to collect or ignore, depending
7598 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7599 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7600 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7601
7602 See F</"IGNORELISTS"> for details.
7603
7604 =item B<IgnoreSelected> I<true>|I<false>
7605
7606 If no configuration if given, the B<sensors>-plugin will collect data from all
7607 sensors. This may not be practical, especially for uninteresting sensors.
7608 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7609 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7610 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7611 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7612 and all other sensors are collected.
7613
7614 =item B<UseLabels> I<true>|I<false>
7615
7616 Configures how sensor readings are reported. When set to I<true>, sensor
7617 readings are reported using their descriptive label (e.g. "VCore"). When set to
7618 I<false> (the default) the sensor name is used ("in0").
7619
7620 =back
7621
7622 =head2 Plugin C<sigrok>
7623
7624 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7625 supported by the L<sigrok|http://sigrok.org/> project.
7626
7627 B<Synopsis>
7628
7629  <Plugin sigrok>
7630    LogLevel 3
7631    <Device "AC Voltage">
7632       Driver "fluke-dmm"
7633       MinimumInterval 10
7634       Conn "/dev/ttyUSB2"
7635    </Device>
7636    <Device "Sound Level">
7637       Driver "cem-dt-885x"
7638       Conn "/dev/ttyUSB1"
7639    </Device>
7640  </Plugin>
7641
7642 =over 4
7643
7644 =item B<LogLevel> B<0-5>
7645
7646 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7647 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7648 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7649 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7650 their level, are always submitted to I<collectd> at its INFO log level.
7651
7652 =item E<lt>B<Device> I<Name>E<gt>
7653
7654 A sigrok-supported device, uniquely identified by this section's options. The
7655 I<Name> is passed to I<collectd> as the I<plugin instance>.
7656
7657 =item B<Driver> I<DriverName>
7658
7659 The sigrok driver to use for this device.
7660
7661 =item B<Conn> I<ConnectionSpec>
7662
7663 If the device cannot be auto-discovered, or more than one might be discovered
7664 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7665 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7666 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7667 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7668 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7669
7670 =item B<SerialComm> I<SerialSpec>
7671
7672 For serial devices with non-standard port settings, this option can be used
7673 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7674 This should not be necessary; drivers know how to communicate with devices they
7675 support.
7676
7677 =item B<MinimumInterval> I<Seconds>
7678
7679 Specifies the minimum time between measurement dispatches to I<collectd>, in
7680 seconds. Since some I<sigrok> supported devices can acquire measurements many
7681 times per second, it may be necessary to throttle these. For example, the
7682 I<RRD plugin> cannot process writes more than once per second.
7683
7684 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7685 device are always dispatched to I<collectd>. When throttled, unused
7686 measurements are discarded.
7687
7688 =back
7689
7690 =head2 Plugin C<smart>
7691
7692 The C<smart> plugin collects SMART information from physical
7693 disks. Values collectd include temperature, power cycle count, poweron
7694 time and bad sectors. Also, all SMART attributes are collected along
7695 with the normalized current value, the worst value, the threshold and
7696 a human readable value.
7697
7698 Using the following two options you can ignore some disks or configure the
7699 collection only of specific disks.
7700
7701 =over 4
7702
7703 =item B<Disk> I<Name>
7704
7705 Select the disk I<Name>. Whether it is collected or ignored depends on the
7706 B<IgnoreSelected> setting, see below. As with other plugins that use the
7707 daemon's ignorelist functionality, a string that starts and ends with a slash
7708 is interpreted as a regular expression. Examples:
7709
7710   Disk "sdd"
7711   Disk "/hda[34]/"
7712
7713 See F</"IGNORELISTS"> for details.
7714
7715 =item B<IgnoreSelected> B<true>|B<false>
7716
7717 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7718 statements, are ignored or if all other disks are ignored. The behavior
7719 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7720 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7721 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7722 is set to B<true>, all disks are collected B<except> the ones matched.
7723
7724 =item B<IgnoreSleepMode> B<true>|B<false>
7725
7726 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7727 This option disables the sleep mode check and allows the plugin to collect data
7728 from these disks anyway. This is useful in cases where libatasmart mistakenly
7729 reports disks as asleep because it has not been updated to incorporate support
7730 for newer idle states in the ATA spec.
7731
7732 =item B<UseSerial> B<true>|B<false>
7733
7734 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7735 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7736 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7737 storing data. This ensures that the data for a given disk will be kept together
7738 even if the kernel name changes.
7739
7740 =back
7741
7742 =head2 Plugin C<snmp>
7743
7744 Since the configuration of the C<snmp plugin> is a little more complicated than
7745 other plugins, its documentation has been moved to an own manpage,
7746 L<collectd-snmp(5)>. Please see there for details.
7747
7748 =head2 Plugin C<snmp_agent>
7749
7750 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7751 from SNMP master agent and returns the data collected by read plugins.
7752 The I<snmp_agent> plugin handles requests only for OIDs specified in
7753 configuration file. To handle SNMP queries the plugin gets data from collectd
7754 and translates requested values from collectd's internal format to SNMP format.
7755 This plugin is a generic plugin and cannot work without configuration.
7756 For more details on AgentX subagent see
7757 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7758
7759 B<Synopsis:>
7760
7761   <Plugin snmp_agent>
7762     <Data "memAvailReal">
7763       Plugin "memory"
7764       #PluginInstance "some"
7765       Type "memory"
7766       TypeInstance "free"
7767       OIDs "1.3.6.1.4.1.2021.4.6.0"
7768     </Data>
7769     <Table "ifTable">
7770       IndexOID "IF-MIB::ifIndex"
7771       SizeOID "IF-MIB::ifNumber"
7772       <Data "ifDescr">
7773         Instance true
7774         Plugin "interface"
7775         OIDs "IF-MIB::ifDescr"
7776       </Data>
7777       <Data "ifOctets">
7778         Plugin "interface"
7779         Type "if_octets"
7780         TypeInstance ""
7781         OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7782       </Data>
7783     </Table>
7784   </Plugin>
7785
7786 There are two types of blocks that can be contained in the
7787 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7788
7789 =head3 The B<Data> block
7790
7791 The B<Data> block defines a list OIDs that are to be handled. This block can
7792 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7793 block it reperesents table OIDs.
7794 The following options can be set:
7795
7796 =over 4
7797
7798 =item B<Instance> I<true|false>
7799
7800 When B<Instance> is set to B<true>, the value for requested OID is copied from
7801 plugin instance field of corresponding collectd value. If B<Data> block defines
7802 scalar data type B<Instance> has no effect and can be omitted.
7803
7804 =item B<Plugin> I<String>
7805
7806 Read plugin name whose collected data will be mapped to specified OIDs.
7807
7808 =item B<PluginInstance> I<String>
7809
7810 Read plugin instance whose collected data will be mapped to specified OIDs.
7811 The field is optional and by default there is no plugin instance check.
7812 Allowed only if B<Data> block defines scalar data type.
7813
7814 =item B<Type> I<String>
7815
7816 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7817 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7818
7819 =item B<TypeInstance> I<String>
7820
7821 Collectd's type-instance that is to be used for specified OID.
7822
7823 =item B<OIDs> I<OID> [I<OID> ...]
7824
7825 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7826 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7827 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7828 configured should correspond to number of values in specified B<Type>.
7829 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7830 "rx" and "tx" values of "if_octets" type.
7831
7832 =item B<Scale> I<Value>
7833
7834 The values taken from collectd are multiplied by I<Value>. The field is optional
7835 and the default is B<1.0>.
7836
7837 =item B<Shift> I<Value>
7838
7839 I<Value> is added to values from collectd after they have been multiplied by
7840 B<Scale> value. The field is optional and the default value is B<0.0>.
7841
7842 =back
7843
7844 =head3 The B<Table> block
7845
7846 The B<Table> block defines a collection of B<Data> blocks that belong to one
7847 snmp table. In addition to multiple B<Data> blocks the following options can be
7848 set:
7849
7850 =over 4
7851
7852 =item B<IndexOID> I<OID>
7853
7854 OID that is handled by the plugin and is mapped to numerical index value that is
7855 generated by the plugin for each table record.
7856
7857 =item B<SizeOID> I<OID>
7858
7859 OID that is handled by the plugin. Returned value is the number of records in
7860 the table. The field is optional.
7861
7862 =back
7863
7864 =head2 Plugin C<statsd>
7865
7866 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7867 protocol and dispatches rates or other aggregates of these numbers
7868 periodically.
7869
7870 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7871 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7872 C<objects> respectively.
7873
7874 The following configuration options are valid:
7875
7876 =over 4
7877
7878 =item B<Host> I<Host>
7879
7880 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7881 "any" address, i.e. accept packets sent to any of the hosts addresses.
7882
7883 =item B<Port> I<Port>
7884
7885 UDP port to listen to. This can be either a service name or a port number.
7886 Defaults to C<8125>.
7887
7888 =item B<DeleteCounters> B<false>|B<true>
7889
7890 =item B<DeleteTimers> B<false>|B<true>
7891
7892 =item B<DeleteGauges> B<false>|B<true>
7893
7894 =item B<DeleteSets> B<false>|B<true>
7895
7896 These options control what happens if metrics are not updated in an interval.
7897 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7898 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7899 are unchanged. If set to B<True>, the such metrics are not dispatched and
7900 removed from the internal cache.
7901
7902 =item B<CounterSum> B<false>|B<true>
7903
7904 When enabled, creates a C<count> metric which reports the change since the last
7905 read. This option primarily exists for compatibility with the I<statsd>
7906 implementation by Etsy.
7907
7908 =item B<TimerPercentile> I<Percent>
7909
7910 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7911 that I<Percent> of all reported timers are smaller than or equal to the
7912 computed latency. This is useful for cutting off the long tail latency, as it's
7913 often done in I<Service Level Agreements> (SLAs).
7914
7915 Different percentiles can be calculated by setting this option several times.
7916 If none are specified, no percentiles are calculated / dispatched.
7917
7918 =item B<TimerLower> B<false>|B<true>
7919
7920 =item B<TimerUpper> B<false>|B<true>
7921
7922 =item B<TimerSum> B<false>|B<true>
7923
7924 =item B<TimerCount> B<false>|B<true>
7925
7926 Calculate and dispatch various values out of I<Timer> metrics received during
7927 an interval. If set to B<False>, the default, these values aren't calculated /
7928 dispatched.
7929
7930 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
7931
7932 =back
7933
7934 =head2 Plugin C<swap>
7935
7936 The I<Swap plugin> collects information about used and available swap space. On
7937 I<Linux> and I<Solaris>, the following options are available:
7938
7939 =over 4
7940
7941 =item B<ReportByDevice> B<false>|B<true>
7942
7943 Configures how to report physical swap devices. If set to B<false> (the
7944 default), the summary over all swap devices is reported only, i.e. the globally
7945 used and available space over all devices. If B<true> is configured, the used
7946 and available space of each device will be reported separately.
7947
7948 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7949 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7950
7951 =item B<ReportBytes> B<false>|B<true>
7952
7953 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7954 I<swap I/O> is reported in pages. This option is available under Linux only.
7955
7956 =item B<ValuesAbsolute> B<true>|B<false>
7957
7958 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7959 available and used. Defaults to B<true>.
7960
7961 =item B<ValuesPercentage> B<false>|B<true>
7962
7963 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7964 available and free. Defaults to B<false>.
7965
7966 This is useful for deploying I<collectd> in a heterogeneous environment, where
7967 swap sizes differ and you want to specify generic thresholds or similar.
7968
7969 =item B<ReportIO> B<true>|B<false>
7970
7971 Enables or disables reporting swap IO. Defaults to B<true>.
7972
7973 This is useful for the cases when swap IO is not neccessary, is not available,
7974 or is not reliable.
7975
7976 =back
7977
7978 =head2 Plugin C<syslog>
7979
7980 =over 4
7981
7982 =item B<LogLevel> B<debug|info|notice|warning|err>
7983
7984 Sets the log-level. If, for example, set to B<notice>, then all events with
7985 severity B<notice>, B<warning>, or B<err> will be submitted to the
7986 syslog-daemon.
7987
7988 Please note that B<debug> is only available if collectd has been compiled with
7989 debugging support.
7990
7991 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7992
7993 Controls which notifications should be sent to syslog. The default behaviour is
7994 not to send any. Less severe notifications always imply logging more severe
7995 notifications: Setting this to B<OKAY> means all notifications will be sent to
7996 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7997 notifications but will dismiss B<OKAY> notifications. Setting this option to
7998 B<FAILURE> will only send failures to syslog.
7999
8000 =back
8001
8002 =head2 Plugin C<table>
8003
8004 The C<table plugin> provides generic means to parse tabular data and dispatch
8005 user specified values. Values are selected based on column numbers. For
8006 example, this plugin may be used to get values from the Linux L<proc(5)>
8007 filesystem or CSV (comma separated values) files.
8008
8009   <Plugin table>
8010     <Table "/proc/slabinfo">
8011       #Plugin "slab"
8012       Instance "slabinfo"
8013       Separator " "
8014       <Result>
8015         Type gauge
8016         InstancePrefix "active_objs"
8017         InstancesFrom 0
8018         ValuesFrom 1
8019       </Result>
8020       <Result>
8021         Type gauge
8022         InstancePrefix "objperslab"
8023         InstancesFrom 0
8024         ValuesFrom 4
8025       </Result>
8026     </Table>
8027   </Plugin>
8028
8029 The configuration consists of one or more B<Table> blocks, each of which
8030 configures one file to parse. Within each B<Table> block, there are one or
8031 more B<Result> blocks, which configure which data to select and how to
8032 interpret it.
8033
8034 The following options are available inside a B<Table> block:
8035
8036 =over 4
8037
8038 =item B<Plugin> I<Plugin>
8039
8040 If specified, I<Plugin> is used as the plugin name when submitting values.
8041 Defaults to B<table>.
8042
8043 =item B<Instance> I<instance>
8044
8045 If specified, I<instance> is used as the plugin instance. If omitted, the
8046 filename of the table is used instead, with all special characters replaced
8047 with an underscore (C<_>).
8048
8049 =item B<Separator> I<string>
8050
8051 Any character of I<string> is interpreted as a delimiter between the different
8052 columns of the table. A sequence of two or more contiguous delimiters in the
8053 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8054 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8055 of a table - see its documentation for more details. This option is mandatory.
8056
8057 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8058 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8059 required because of collectd's config parsing.
8060
8061 =back
8062
8063 The following options are available inside a B<Result> block:
8064
8065 =over 4
8066
8067 =item B<Type> I<type>
8068
8069 Sets the type used to dispatch the values to the daemon. Detailed information
8070 about types and their configuration can be found in L<types.db(5)>. This
8071 option is mandatory.
8072
8073 =item B<InstancePrefix> I<prefix>
8074
8075 If specified, prepend I<prefix> to the type instance. If omitted, only the
8076 B<InstancesFrom> option is considered for the type instance.
8077
8078 =item B<InstancesFrom> I<column0> [I<column1> ...]
8079
8080 If specified, the content of the given columns (identified by the column
8081 number starting at zero) will be used to create the type instance for each
8082 row. Multiple values (and the instance prefix) will be joined together with
8083 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8084 option is considered for the type instance.
8085
8086 The plugin itself does not check whether or not all built instances are
8087 different. It’s your responsibility to assure that each is unique. This is
8088 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8089 sure that the table only contains one row.
8090
8091 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8092 will be empty.
8093
8094 =item B<ValuesFrom> I<column0> [I<column1> ...]
8095
8096 Specifies the columns (identified by the column numbers starting at zero)
8097 whose content is used as the actual data for the data sets that are dispatched
8098 to the daemon. How many such columns you need is determined by the B<Type>
8099 setting above. If you specify too many or not enough columns, the plugin will
8100 complain about that and no data will be submitted to the daemon. The plugin
8101 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8102 respectively, so anything supported by those functions is supported by the
8103 plugin as well. This option is mandatory.
8104
8105 =back
8106
8107 =head2 Plugin C<tail>
8108
8109 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8110 each line and dispatches found values. What is matched can be configured by the
8111 user using (extended) regular expressions, as described in L<regex(7)>.
8112
8113   <Plugin "tail">
8114     <File "/var/log/exim4/mainlog">
8115       Plugin "mail"
8116       Instance "exim"
8117       Interval 60
8118       <Match>
8119         Regex "S=([1-9][0-9]*)"
8120         DSType "CounterAdd"
8121         Type "ipt_bytes"
8122         Instance "total"
8123       </Match>
8124       <Match>
8125         Regex "\\<R=local_user\\>"
8126         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8127         DSType "CounterInc"
8128         Type "counter"
8129         Instance "local_user"
8130       </Match>
8131       <Match>
8132         Regex "l=([0-9]*\\.[0-9]*)"
8133         <DSType "Distribution">
8134           Percentile 99
8135           Bucket 0 100
8136           #BucketType "bucket"
8137         </DSType>
8138         Type "latency"
8139         Instance "foo"
8140       </Match>
8141     </File>
8142   </Plugin>
8143
8144 The config consists of one or more B<File> blocks, each of which configures one
8145 logfile to parse. Within each B<File> block, there are one or more B<Match>
8146 blocks, which configure a regular expression to search for.
8147
8148 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8149 the plugin name and instance respectively. So in the above example the plugin name
8150 C<mail-exim> would be used.
8151
8152 These options are applied for all B<Match> blocks that B<follow> it, until the
8153 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8154 instances from one logfile, handy when parsing syslog and the like.
8155
8156 The B<Interval> option allows you to define the length of time between reads. If
8157 this is not set, the default Interval will be used.
8158
8159 Each B<Match> block has the following options to describe how the match should
8160 be performed:
8161
8162 =over 4
8163
8164 =item B<Regex> I<regex>
8165
8166 Sets the regular expression to use for matching against a line. The first
8167 subexpression has to match something that can be turned into a number by
8168 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8169 below. Because B<extended> regular expressions are used, you do not need to use
8170 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8171 collectd's config parsing you need to escape backslashes, though. So if you
8172 want to match literal parentheses you need to do the following:
8173
8174   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8175
8176 =item B<ExcludeRegex> I<regex>
8177
8178 Sets an optional regular expression to use for excluding lines from the match.
8179 An example which excludes all connections from localhost from the match:
8180
8181   ExcludeRegex "127\\.0\\.0\\.1"
8182
8183 =item B<DSType> I<Type>
8184
8185 Sets how the values are cumulated. I<Type> is one of:
8186
8187 =over 4
8188
8189 =item B<GaugeAverage>
8190
8191 Calculate the average.
8192
8193 =item B<GaugeMin>
8194
8195 Use the smallest number only.
8196
8197 =item B<GaugeMax>
8198
8199 Use the greatest number only.
8200
8201 =item B<GaugeLast>
8202
8203 Use the last number found.
8204
8205 =item B<GaugePersist>
8206
8207 Use the last number found. The number is not reset at the end of an interval.
8208 It is continously reported until another number is matched. This is intended
8209 for cases in which only state changes are reported, for example a thermometer
8210 that only reports the temperature when it changes.
8211
8212 =item B<CounterSet>
8213
8214 =item B<DeriveSet>
8215
8216 =item B<AbsoluteSet>
8217
8218 The matched number is a counter. Simply I<sets> the internal counter to this
8219 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8220
8221 =item B<GaugeAdd>
8222
8223 =item B<CounterAdd>
8224
8225 =item B<DeriveAdd>
8226
8227 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8228 matched number may be negative, which will effectively subtract from the
8229 internal counter.
8230
8231 =item B<GaugeInc>
8232
8233 =item B<CounterInc>
8234
8235 =item B<DeriveInc>
8236
8237 Increase the internal counter by one. These B<DSType> are the only ones that do
8238 not use the matched subexpression, but simply count the number of matched
8239 lines. Thus, you may use a regular expression without submatch in this case.
8240
8241 =item B<Distribution>
8242
8243 Type to do calculations based on the distribution of values, primarily
8244 calculating percentiles. This is primarily geared towards latency, but can be
8245 used for other metrics as well. The range of values tracked with this setting
8246 must be in the range (0–2^34) and can be fractional. Please note that neither
8247 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8248 distribution.
8249
8250 This option must be used together with the B<Percentile> and/or B<Bucket>
8251 options.
8252
8253 B<Synopsis:>
8254
8255   <DSType "Distribution">
8256     Percentile 99
8257     Bucket 0 100
8258     BucketType "bucket"
8259   </DSType>
8260
8261 =over 4
8262
8263 =item B<Percentile> I<Percent>
8264
8265 Calculate and dispatch the configured percentile, i.e. compute the value, so
8266 that I<Percent> of all matched values are smaller than or equal to the computed
8267 latency.
8268
8269 Metrics are reported with the I<type> B<Type> (the value of the above option)
8270 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8271
8272 This option may be repeated to calculate more than one percentile.
8273
8274 =item B<Bucket> I<lower_bound> I<upper_bound>
8275
8276 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8277 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8278 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8279 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8280 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8281 lower/upper bound.
8282
8283 To export the entire (0–inf) range without overlap, use the upper bound of the
8284 previous range as the lower bound of the following range. In other words, use
8285 the following schema:
8286
8287   Bucket   0   1
8288   Bucket   1   2
8289   Bucket   2   5
8290   Bucket   5  10
8291   Bucket  10  20
8292   Bucket  20  50
8293   Bucket  50   0
8294
8295 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8296 by default) and the I<type instance>
8297 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8298
8299 This option may be repeated to calculate more than one rate.
8300
8301 =item B<BucketType> I<Type>
8302
8303 Sets the type used to dispatch B<Bucket> metrics.
8304 Optional, by default C<bucket> will be used.
8305
8306 =back
8307
8308 =back
8309
8310 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8311 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8312 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8313 B<Derive*> types interpret the submatch as a signed integer using
8314 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8315 and it may be omitted in this case.
8316
8317 =item B<Type> I<Type>
8318
8319 Sets the type used to dispatch this value. Detailed information about types and
8320 their configuration can be found in L<types.db(5)>.
8321
8322 =item B<Instance> I<TypeInstance>
8323
8324 This optional setting sets the type instance to use.
8325
8326 =back
8327
8328 =head2 Plugin C<tail_csv>
8329
8330 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8331 written by I<Snort>.
8332
8333 B<Synopsis:>
8334
8335  <Plugin "tail_csv">
8336    <Metric "snort-dropped">
8337        Type "percent"
8338        Instance "dropped"
8339        Index 1
8340    </Metric>
8341    <File "/var/log/snort/snort.stats">
8342        Plugin "snortstats"
8343        Instance "eth0"
8344        Interval 600
8345        Collect "snort-dropped"
8346    </File>
8347  </Plugin>
8348
8349 The configuration consists of one or more B<Metric> blocks that define an index
8350 into the line of the CSV file and how this value is mapped to I<collectd's>
8351 internal representation. These are followed by one or more B<Instance> blocks
8352 which configure which file to read, in which interval and which metrics to
8353 extract.
8354
8355 =over 4
8356
8357 =item E<lt>B<Metric> I<Name>E<gt>
8358
8359 The B<Metric> block configures a new metric to be extracted from the statistics
8360 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8361 only used inside the B<Instance> blocks to refer to this block, so you can use
8362 one B<Metric> block for multiple CSV files.
8363
8364 =over 4
8365
8366 =item B<Type> I<Type>
8367
8368 Configures which I<Type> to use when dispatching this metric. Types are defined
8369 in the L<types.db(5)> file, see the appropriate manual page for more
8370 information on specifying types. Only types with a single I<data source> are
8371 supported by the I<tail_csv plugin>. The information whether the value is an
8372 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8373 I<Type's> definition.
8374
8375 =item B<Instance> I<TypeInstance>
8376
8377 If set, I<TypeInstance> is used to populate the type instance field of the
8378 created value lists. Otherwise, no type instance is used.
8379
8380 =item B<ValueFrom> I<Index>
8381
8382 Configure to read the value from the field with the zero-based index I<Index>.
8383 If the value is parsed as signed integer, unsigned integer or double depends on
8384 the B<Type> setting, see above.
8385
8386 =back
8387
8388 =item E<lt>B<File> I<Path>E<gt>
8389
8390 Each B<File> block represents one CSV file to read. There must be at least one
8391 I<File> block but there can be multiple if you have multiple CSV files.
8392
8393 =over 4
8394
8395 =item B<Plugin> I<Plugin>
8396
8397 Use I<Plugin> as the plugin name when submitting values.
8398 Defaults to C<tail_csv>.
8399
8400 =item B<Instance> I<PluginInstance>
8401
8402 Sets the I<plugin instance> used when dispatching the values.
8403
8404 =item B<Collect> I<Metric>
8405
8406 Specifies which I<Metric> to collect. This option must be specified at least
8407 once, and you can use this option multiple times to specify more than one
8408 metric to be extracted from this statistic file.
8409
8410 =item B<Interval> I<Seconds>
8411
8412 Configures the interval in which to read values from this instance / file.
8413 Defaults to the plugin's default interval.
8414
8415 =item B<TimeFrom> I<Index>
8416
8417 Rather than using the local time when dispatching a value, read the timestamp
8418 from the field with the zero-based index I<Index>. The value is interpreted as
8419 seconds since epoch. The value is parsed as a double and may be factional.
8420
8421 =back
8422
8423 =back
8424
8425 =head2 Plugin C<teamspeak2>
8426
8427 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8428 polls interesting global and virtual server data. The plugin can query only one
8429 physical server but unlimited virtual servers. You can use the following
8430 options to configure it:
8431
8432 =over 4
8433
8434 =item B<Host> I<hostname/ip>
8435
8436 The hostname or ip which identifies the physical server.
8437 Default: 127.0.0.1
8438
8439 =item B<Port> I<port>
8440
8441 The query port of the physical server. This needs to be a string.
8442 Default: "51234"
8443
8444 =item B<Server> I<port>
8445
8446 This option has to be added once for every virtual server the plugin should
8447 query. If you want to query the virtual server on port 8767 this is what the
8448 option would look like:
8449
8450   Server "8767"
8451
8452 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8453 use quotes around it! If no such statement is given only global information
8454 will be collected.
8455
8456 =back
8457
8458 =head2 Plugin C<ted>
8459
8460 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8461 measure power consumption. These devices are usually connected to a serial
8462 (RS232) or USB port. The plugin opens a configured device and tries to read the
8463 current energy readings. For more information on TED, visit
8464 L<http://www.theenergydetective.com/>.
8465
8466 Available configuration options:
8467
8468 =over 4
8469
8470 =item B<Device> I<Path>
8471
8472 Path to the device on which TED is connected. collectd will need read and write
8473 permissions on that file.
8474
8475 Default: B</dev/ttyUSB0>
8476
8477 =item B<Retries> I<Num>
8478
8479 Apparently reading from TED is not that reliable. You can therefore configure a
8480 number of retries here. You only configure the I<retries> here, to if you
8481 specify zero, one reading will be performed (but no retries if that fails); if
8482 you specify three, a maximum of four readings are performed. Negative values
8483 are illegal.
8484
8485 Default: B<0>
8486
8487 =back
8488
8489 =head2 Plugin C<tcpconns>
8490
8491 The C<tcpconns plugin> counts the number of currently established TCP
8492 connections based on the local port and/or the remote port. Since there may be
8493 a lot of connections the default if to count all connections with a local port,
8494 for which a listening socket is opened. You can use the following options to
8495 fine-tune the ports you are interested in:
8496
8497 =over 4
8498
8499 =item B<ListeningPorts> I<true>|I<false>
8500
8501 If this option is set to I<true>, statistics for all local ports for which a
8502 listening socket exists are collected. The default depends on B<LocalPort> and
8503 B<RemotePort> (see below): If no port at all is specifically selected, the
8504 default is to collect listening ports. If specific ports (no matter if local or
8505 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8506 the selected ports will be collected unless this option is set to I<true>
8507 specifically.
8508
8509 =item B<LocalPort> I<Port>
8510
8511 Count the connections to a specific local port. This can be used to see how
8512 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8513 You have to specify the port in numeric form, so for the mailserver example
8514 you'd need to set B<25>.
8515
8516 =item B<RemotePort> I<Port>
8517
8518 Count the connections to a specific remote port. This is useful to see how
8519 much a remote service is used. This is most useful if you want to know how many
8520 connections a local service has opened to remote services, e.E<nbsp>g. how many
8521 connections a mail server or news server has to other mail or news servers, or
8522 how many connections a web proxy holds to web servers. You have to give the
8523 port in numeric form.
8524
8525 =item B<AllPortsSummary> I<true>|I<false>
8526
8527 If this option is set to I<true> a summary of statistics from all connections
8528 are collected. This option defaults to I<false>.
8529
8530 =back
8531
8532 =head2 Plugin C<thermal>
8533
8534 =over 4
8535
8536 =item B<ForceUseProcfs> I<true>|I<false>
8537
8538 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8539 C<sysfs> interface. If that is not available, the plugin falls back to the
8540 C<procfs> interface. By setting this option to I<true>, you can force the
8541 plugin to use the latter. This option defaults to I<false>.
8542
8543 =item B<Device> I<Device>
8544
8545 Selects the name of the thermal device that you want to collect or ignore,
8546 depending on the value of the B<IgnoreSelected> option. This option may be
8547 used multiple times to specify a list of devices.
8548
8549 See F</"IGNORELISTS"> for details.
8550
8551 =item B<IgnoreSelected> I<true>|I<false>
8552
8553 Invert the selection: If set to true, all devices B<except> the ones that
8554 match the device names specified by the B<Device> option are collected. By
8555 default only selected devices are collected if a selection is made. If no
8556 selection is configured at all, B<all> devices are selected.
8557
8558 =back
8559
8560 =head2 Plugin C<threshold>
8561
8562 The I<Threshold plugin> checks values collected or received by I<collectd>
8563 against a configurable I<threshold> and issues I<notifications> if values are
8564 out of bounds.
8565
8566 Documentation for this plugin is available in the L<collectd-threshold(5)>
8567 manual page.
8568
8569 =head2 Plugin C<tokyotyrant>
8570
8571 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8572 couple metrics: number of records, and database size on disk.
8573
8574 =over 4
8575
8576 =item B<Host> I<Hostname/IP>
8577
8578 The hostname or IP which identifies the server.
8579 Default: B<127.0.0.1>
8580
8581 =item B<Port> I<Service/Port>
8582
8583 The query port of the server. This needs to be a string, even if the port is
8584 given in its numeric form.
8585 Default: B<1978>
8586
8587 =back
8588
8589 =head2 Plugin C<turbostat>
8590
8591 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8592 Intel processors by using I<Model Specific Registers>.
8593
8594 =over 4
8595
8596 =item B<CoreCstates> I<Bitmask(Integer)>
8597
8598 Bit mask of the list of core C-states supported by the processor.
8599 This option should only be used if the automated detection fails.
8600 Default value extracted from the CPU model and family.
8601
8602 Currently supported C-states (by this plugin): 3, 6, 7
8603
8604 B<Example:>
8605
8606   All states (3, 6 and 7):
8607   (1<<3) + (1<<6) + (1<<7) = 392
8608
8609 =item B<PackageCstates> I<Bitmask(Integer)>
8610
8611 Bit mask of the list of packages C-states supported by the processor. This
8612 option should only be used if the automated detection fails. Default value
8613 extracted from the CPU model and family.
8614
8615 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8616
8617 B<Example:>
8618
8619   States 2, 3, 6 and 7:
8620   (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8621
8622 =item B<SystemManagementInterrupt> I<true>|I<false>
8623
8624 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8625 This option should only be used if the automated detection fails or if you want
8626 to disable this feature.
8627
8628 =item B<DigitalTemperatureSensor> I<true>|I<false>
8629
8630 Boolean enabling the collection of the temperature of each core. This option
8631 should only be used if the automated detection fails or if you want to disable
8632 this feature.
8633
8634 =item B<TCCActivationTemp> I<Temperature>
8635
8636 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8637 temperature is used when collecting the temperature of cores or packages. This
8638 option should only be used if the automated detection fails. Default value
8639 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8640
8641 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8642
8643 Bit mask of the list of elements to be thermally monitored. This option should
8644 only be used if the automated detection fails or if you want to disable some
8645 collections. The different bits of this bit mask accepted by this plugin are:
8646
8647 =over 4
8648
8649 =item 0 ('1'): Package
8650
8651 =item 1 ('2'): DRAM
8652
8653 =item 2 ('4'): Cores
8654
8655 =item 3 ('8'): Embedded graphic device
8656
8657 =back
8658
8659 =item B<LogicalCoreNames> I<true>|I<false>
8660
8661 Boolean enabling the use of logical core numbering for per core statistics.
8662 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8663 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8664 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8665 more than one, where I<n> is the n-th core of package I<m>.
8666
8667 =back
8668
8669 =head2 Plugin C<unixsock>
8670
8671 =over 4
8672
8673 =item B<SocketFile> I<Path>
8674
8675 Sets the socket-file which is to be created.
8676
8677 =item B<SocketGroup> I<Group>
8678
8679 If running as root change the group of the UNIX-socket after it has been
8680 created. Defaults to B<collectd>.
8681
8682 =item B<SocketPerms> I<Permissions>
8683
8684 Change the file permissions of the UNIX-socket after it has been created. The
8685 permissions must be given as a numeric, octal value as you would pass to
8686 L<chmod(1)>. Defaults to B<0770>.
8687
8688 =item B<DeleteSocket> B<false>|B<true>
8689
8690 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8691 with the given name already exists. If I<collectd> crashes a socket file may be
8692 left over, preventing the daemon from opening a new socket when restarted.
8693 Since this is potentially dangerous, this defaults to B<false>.
8694
8695 =back
8696
8697 =head2 Plugin C<uuid>
8698
8699 This plugin, if loaded, causes the Hostname to be taken from the machine's
8700 UUID. The UUID is a universally unique designation for the machine, usually
8701 taken from the machine's BIOS. This is most useful if the machine is running in
8702 a virtual environment such as Xen, in which case the UUID is preserved across
8703 shutdowns and migration.
8704
8705 The following methods are used to find the machine's UUID, in order:
8706
8707 =over 4
8708
8709 =item *
8710
8711 Check I</etc/uuid> (or I<UUIDFile>).
8712
8713 =item *
8714
8715 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8716 present.
8717
8718 =item *
8719
8720 Check for UUID from C<dmidecode> / SMBIOS.
8721
8722 =item *
8723
8724 Check for UUID from Xen hypervisor.
8725
8726 =back
8727
8728 If no UUID can be found then the hostname is not modified.
8729
8730 =over 4
8731
8732 =item B<UUIDFile> I<Path>
8733
8734 Take the UUID from the given file (default I</etc/uuid>).
8735
8736 =back
8737
8738 =head2 Plugin C<varnish>
8739
8740 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8741 It collects a subset of the values displayed by L<varnishstat(1)>, and
8742 organizes them in categories which can be enabled or disabled. Currently only
8743 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8744 meaning of each metric can be found in L<varnish-counters(7)>.
8745
8746 Synopsis:
8747
8748  <Plugin "varnish">
8749    <Instance "example">
8750      CollectBackend     true
8751      CollectBan         false
8752      CollectCache       true
8753      CollectConnections true
8754      CollectDirectorDNS false
8755      CollectESI         false
8756      CollectFetch       false
8757      CollectHCB         false
8758      CollectObjects     false
8759      CollectPurge       false
8760      CollectSession     false
8761      CollectSHM         true
8762      CollectSMA         false
8763      CollectSMS         false
8764      CollectSM          false
8765      CollectStruct      false
8766      CollectTotals      false
8767      CollectUptime      false
8768      CollectVCL         false
8769      CollectVSM         false
8770      CollectWorkers     false
8771      CollectLock        false
8772      CollectMempool     false
8773      CollectManagement  false
8774      CollectSMF         false
8775      CollectVBE         false
8776      CollectMSE         false
8777    </Instance>
8778  </Plugin>
8779
8780 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8781 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8782 will collectd statistics from the default "varnishd" instance (this should work
8783 fine in most cases).
8784
8785 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8786
8787 =over 4
8788
8789 =item B<CollectBackend> B<true>|B<false>
8790
8791 Back-end connection statistics, such as successful, reused,
8792 and closed connections. True by default.
8793
8794 =item B<CollectBan> B<true>|B<false>
8795
8796 Statistics about ban operations, such as number of bans added, retired, and
8797 number of objects tested against ban operations. Only available with Varnish
8798 3.x and above. False by default.
8799
8800 =item B<CollectCache> B<true>|B<false>
8801
8802 Cache hits and misses. True by default.
8803
8804 =item B<CollectConnections> B<true>|B<false>
8805
8806 Number of client connections received, accepted and dropped. True by default.
8807
8808 =item B<CollectDirectorDNS> B<true>|B<false>
8809
8810 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8811 default.
8812
8813 =item B<CollectESI> B<true>|B<false>
8814
8815 Edge Side Includes (ESI) parse statistics. False by default.
8816
8817 =item B<CollectFetch> B<true>|B<false>
8818
8819 Statistics about fetches (HTTP requests sent to the backend). False by default.
8820
8821 =item B<CollectHCB> B<true>|B<false>
8822
8823 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8824 divided into locked and unlocked look-ups. False by default.
8825
8826 =item B<CollectObjects> B<true>|B<false>
8827
8828 Statistics on cached objects: number of objects expired, nuked (prematurely
8829 expired), saved, moved, etc. False by default.
8830
8831 =item B<CollectPurge> B<true>|B<false>
8832
8833 Statistics about purge operations, such as number of purges added, retired, and
8834 number of objects tested against purge operations. Only available with Varnish
8835 2.x. False by default.
8836
8837 =item B<CollectSession> B<true>|B<false>
8838
8839 Client session statistics. Number of past and current sessions, session herd and
8840 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8841 metrics found in the Connections and Threads sections with previous versions of
8842 Varnish have been moved here.
8843
8844 =item B<CollectSHM> B<true>|B<false>
8845
8846 Statistics about the shared memory log, a memory region to store
8847 log messages which is flushed to disk when full. True by default.
8848
8849 =item B<CollectSMA> B<true>|B<false>
8850
8851 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8852 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8853 only the one used by the Varnish instance. Only available with Varnish 2.x.
8854 False by default.
8855
8856 =item B<CollectSMS> B<true>|B<false>
8857
8858 synth (synthetic content) storage statistics. This storage
8859 component is used internally only. False by default.
8860
8861 =item B<CollectSM> B<true>|B<false>
8862
8863 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8864 in varnish 4.x. use CollectSMF.
8865 False by default.
8866
8867 =item B<CollectStruct> B<true>|B<false>
8868
8869 Current varnish internal state statistics. Number of current sessions, objects
8870 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8871 default.
8872
8873 =item B<CollectTotals> B<true>|B<false>
8874
8875 Collects overview counters, such as the number of sessions created,
8876 the number of requests and bytes transferred. False by default.
8877
8878 =item B<CollectUptime> B<true>|B<false>
8879
8880 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8881
8882 =item B<CollectVCL> B<true>|B<false>
8883
8884 Number of total (available + discarded) VCL (config files). False by default.
8885
8886 =item B<CollectVSM> B<true>|B<false>
8887
8888 Collect statistics about Varnish's shared memory usage (used by the logging and
8889 statistics subsystems). Only available with Varnish 4.x. False by default.
8890
8891 =item B<CollectWorkers> B<true>|B<false>
8892
8893 Collect statistics about worker threads. False by default.
8894
8895 =item B<CollectVBE> B<true>|B<false>
8896
8897 Backend counters. Only available with Varnish 4.x. False by default.
8898
8899 =item B<CollectSMF> B<true>|B<false>
8900
8901 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8902 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
8903 instance. Used to be called SM in Varnish 2.x. False by default.
8904
8905 =item B<CollectManagement> B<true>|B<false>
8906
8907 Management process counters. Only available with Varnish 4.x. False by default.
8908
8909 =item B<CollectLock> B<true>|B<false>
8910
8911 Lock counters. Only available with Varnish 4.x. False by default.
8912
8913 =item B<CollectMempool> B<true>|B<false>
8914
8915 Memory pool counters. Only available with Varnish 4.x. False by default.
8916
8917 =item B<CollectMSE> B<true>|B<false>
8918
8919 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
8920 Varnish, replacing the traditional malloc and file storages. Only available
8921 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
8922 one used by the Varnish instance. False by default.
8923
8924 =back
8925
8926 =head2 Plugin C<virt>
8927
8928 This plugin allows CPU, disk, network load and other metrics to be collected for
8929 virtualized guests on the machine. The statistics are collected through libvirt
8930 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8931 installing any additional software on guests, especially I<collectd>, which runs
8932 only on the host system.
8933
8934 Only I<Connection> is required.
8935
8936 =over 4
8937
8938 =item B<Connection> I<uri>
8939
8940 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8941
8942  Connection "xen:///"
8943
8944 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8945
8946 =item B<RefreshInterval> I<seconds>
8947
8948 Refresh the list of domains and devices every I<seconds>. The default is 60
8949 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8950 the list of domains and devices to be refreshed on every iteration.
8951
8952 Refreshing the devices in particular is quite a costly operation, so if your
8953 virtualization setup is static you might consider increasing this. If this
8954 option is set to 0, refreshing is disabled completely.
8955
8956 =item B<Domain> I<name>
8957
8958 =item B<BlockDevice> I<name:dev>
8959
8960 =item B<InterfaceDevice> I<name:dev>
8961
8962 =item B<IgnoreSelected> B<true>|B<false>
8963
8964 Select which domains and devices are collected.
8965
8966 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8967 disk/network devices are collected.
8968
8969 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8970 domains and disk/network devices are ignored, while the rest are collected.
8971
8972 The domain name and device names may use a regular expression, if the name is
8973 surrounded by I</.../> and collectd was compiled with support for regexps.
8974
8975 The default is to collect statistics for all domains and all their devices.
8976
8977 Example:
8978
8979  BlockDevice "/:hdb/"
8980  IgnoreSelected "true"
8981
8982 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8983 will be collected.
8984
8985 =item B<BlockDeviceFormat> B<target>|B<source>
8986
8987 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8988 seen by the guest will be used for reporting metrics.
8989 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8990 domain.
8991
8992 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8993 using the path of the source, e.g. an image file.
8994 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8995 domain.
8996
8997 B<Example:>
8998
8999 If the domain XML have the following device defined:
9000
9001   <disk type='block' device='disk'>
9002     <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9003     <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9004     <target dev='sda' bus='scsi'/>
9005     <boot order='2'/>
9006     <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9007   </disk>
9008
9009 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9010 to C<sda>.
9011 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9012 to C<var_lib_libvirt_images_image1.qcow2>.
9013
9014 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9015
9016 The B<BlockDeviceFormatBasename> controls whether the full path or the
9017 L<basename(1)> of the source is being used as the I<type instance> when
9018 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9019
9020 B<Example:>
9021
9022 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9023 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9024 be set to C<var_lib_libvirt_images_image1.qcow2>.
9025 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9026 set to C<image1.qcow2>.
9027
9028 =item B<HostnameFormat> B<name|uuid|hostname|...>
9029
9030 When the virt plugin logs data, it sets the hostname of the collected data
9031 according to this setting. The default is to use the guest name as provided by
9032 the hypervisor, which is equal to setting B<name>.
9033
9034 B<uuid> means use the guest's UUID. This is useful if you want to track the
9035 same guest across migrations.
9036
9037 B<hostname> means to use the global B<Hostname> setting, which is probably not
9038 useful on its own because all guests will appear to have the same name.
9039
9040 You can also specify combinations of these fields. For example B<name uuid>
9041 means to concatenate the guest name and UUID (with a literal colon character
9042 between, thus I<"foo:1234-1234-1234-1234">).
9043
9044 At the moment of writing (collectd-5.5), hostname string is limited to 62
9045 characters. In case when combination of fields exceeds 62 characters,
9046 hostname will be truncated without a warning.
9047
9048 =item B<InterfaceFormat> B<name>|B<address>
9049
9050 When the virt plugin logs interface data, it sets the name of the collected
9051 data according to this setting. The default is to use the path as provided by
9052 the hypervisor (the "dev" property of the target node), which is equal to
9053 setting B<name>.
9054
9055 B<address> means use the interface's mac address. This is useful since the
9056 interface path might change between reboots of a guest or across migrations.
9057
9058 =item B<PluginInstanceFormat> B<name|uuid|none>
9059
9060 When the virt plugin logs data, it sets the plugin_instance of the collected
9061 data according to this setting. The default is to not set the plugin_instance.
9062
9063 B<name> means use the guest's name as provided by the hypervisor.
9064 B<uuid> means use the guest's UUID.
9065
9066 You can also specify combinations of the B<name> and B<uuid> fields.
9067 For example B<name uuid> means to concatenate the guest name and UUID
9068 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9069
9070 =item B<Instances> B<integer>
9071
9072 How many read instances you want to use for this plugin. The default is one,
9073 and the sensible setting is a multiple of the B<ReadThreads> value.
9074 If you are not sure, just use the default setting.
9075
9076 =item B<ExtraStats> B<string>
9077
9078 Report additional extra statistics. The default is no extra statistics, preserving
9079 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9080 allows the plugin to reported more detailed statistics about the behaviour of
9081 Virtual Machines. The argument is a space-separated list of selectors.
9082
9083 Currently supported selectors are:
9084
9085 =over 4
9086
9087 =item B<cpu_util>: report CPU utilization per domain in percentage.
9088
9089 =item B<disk>: report extra statistics like number of flush operations and total
9090 service time for read, write and flush operations. Requires libvirt API version
9091 I<0.9.5> or later.
9092
9093 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9094 I<0.9.10> or later.
9095
9096 =item B<domain_state>: report domain state and reason in human-readable format as
9097 a notification. If libvirt API version I<0.9.2> or later is available, domain
9098 reason will be included in notification.
9099
9100 =item B<fs_info>: report file system information as a notification. Requires
9101 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9102 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9103 version supports retrieving  file system information.
9104
9105 =item B<job_stats_background>: report statistics about progress of a background
9106 job on a domain. Only one type of job statistics can be collected at the same time.
9107 Requires libvirt API version I<1.2.9> or later.
9108
9109 =item B<job_stats_completed>: report statistics about a recently completed job on
9110 a domain. Only one type of job statistics can be collected at the same time.
9111 Requires libvirt API version I<1.2.9> or later.
9112
9113 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9114 Requires libvirt API version I<0.9.11> or later.
9115
9116 =item B<perf>: report performance monitoring events. To collect performance
9117 metrics they must be enabled for domain and supported by the platform. Requires
9118 libvirt API version I<1.3.3> or later.
9119 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9120
9121 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9122
9123 =back
9124
9125 =item B<PersistentNotification> B<true>|B<false>
9126 Override default configuration to only send notifications when there is a change
9127 in the lifecycle state of a domain. When set to true notifications will be sent
9128 for every read cycle. Default is false. Does not affect the stats being
9129 dispatched.
9130
9131 =back
9132
9133 =head2 Plugin C<vmem>
9134
9135 The C<vmem> plugin collects information about the usage of virtual memory.
9136 Since the statistics provided by the Linux kernel are very detailed, they are
9137 collected very detailed. However, to get all the details, you have to switch
9138 them on manually. Most people just want an overview over, such as the number of
9139 pages read from swap space.
9140
9141 =over 4
9142
9143 =item B<Verbose> B<true>|B<false>
9144
9145 Enables verbose collection of information. This will start collecting page
9146 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9147 Part of these statistics are collected on a "per zone" basis.
9148
9149 =back
9150
9151 =head2 Plugin C<vserver>
9152
9153 This plugin doesn't have any options. B<VServer> support is only available for
9154 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9155 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9156 need to apply the patches and compile your own kernel, which will then provide
9157 the F</proc/virtual> filesystem that is required by this plugin.
9158
9159 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9160
9161 B<Note>: The traffic collected by this plugin accounts for the amount of
9162 traffic passing a socket which might be a lot less than the actual on-wire
9163 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9164 collect on-wire traffic you could, for example, use the logging facilities of
9165 iptables to feed data for the guest IPs into the iptables plugin.
9166
9167 =head2 Plugin C<write_graphite>
9168
9169 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9170 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9171 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9172 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9173 of at most 1428 bytes to minimize the number of network packets.
9174
9175 Synopsis:
9176
9177  <Plugin write_graphite>
9178    <Node "example">
9179      Host "localhost"
9180      Port "2003"
9181      Protocol "tcp"
9182      LogSendErrors true
9183      Prefix "collectd"
9184    </Node>
9185  </Plugin>
9186
9187 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9188 blocks. Inside the B<Node> blocks, the following options are recognized:
9189
9190 =over 4
9191
9192 =item B<Host> I<Address>
9193
9194 Hostname or address to connect to. Defaults to C<localhost>.
9195
9196 =item B<Port> I<Service>
9197
9198 Service name or port number to connect to. Defaults to C<2003>.
9199
9200 =item B<Protocol> I<String>
9201
9202 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9203
9204 =item B<ReconnectInterval> I<Seconds>
9205
9206 When set to non-zero, forces the connection to the Graphite backend to be
9207 closed and re-opend periodically. This behavior is desirable in environments
9208 where the connection to the Graphite backend is done through load balancers,
9209 for example. When set to zero, the default, the connetion is kept open for as
9210 long as possible.
9211
9212 =item B<LogSendErrors> B<false>|B<true>
9213
9214 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9215 If set to B<false>, it will not log the errors. This is especially useful when
9216 using Protocol UDP since many times we want to use the "fire-and-forget"
9217 approach and logging errors fills syslog with unneeded messages.
9218
9219 =item B<Prefix> I<String>
9220
9221 When set, I<String> is added in front of the host name. Dots and whitespace are
9222 I<not> escaped in this string (see B<EscapeCharacter> below).
9223
9224 =item B<Postfix> I<String>
9225
9226 When set, I<String> is appended to the host name. Dots and whitespace are
9227 I<not> escaped in this string (see B<EscapeCharacter> below).
9228
9229 =item B<EscapeCharacter> I<Char>
9230
9231 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9232 in the identifier. The B<EscapeCharacter> option determines which character
9233 dots, whitespace and control characters are replaced with. Defaults to
9234 underscore (C<_>).
9235
9236 =item B<StoreRates> B<false>|B<true>
9237
9238 If set to B<true> (the default), convert counter values to rates. If set to
9239 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9240 number.
9241
9242 =item B<SeparateInstances> B<false>|B<true>
9243
9244 If set to B<true>, the plugin instance and type instance will be in their own
9245 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9246 default), the plugin and plugin instance (and likewise the type and type
9247 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9248
9249 =item B<AlwaysAppendDS> B<false>|B<true>
9250
9251 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9252 identifier. If set to B<false> (the default), this is only done when there is
9253 more than one DS.
9254
9255 =item B<PreserveSeparator> B<false>|B<true>
9256
9257 If set to B<false> (the default) the C<.> (dot) character is replaced with
9258 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9259 is preserved, i.e. passed through.
9260
9261 =item B<DropDuplicateFields> B<false>|B<true>
9262
9263 If set to B<true>, detect and remove duplicate components in Graphite metric
9264 names. For example, the metric name  C<host.load.load.shortterm> will
9265 be shortened to C<host.load.shortterm>.
9266
9267 =back
9268
9269 =head2 Plugin C<write_log>
9270
9271 The C<write_log> plugin writes metrics as INFO log messages.
9272
9273 This plugin supports two output formats: I<Graphite> and I<JSON>.
9274
9275 Synopsis:
9276
9277  <Plugin write_log>
9278    Format Graphite
9279  </Plugin>
9280
9281 =over 4
9282
9283 =item B<Format> I<Format>
9284
9285 The output format to use. Can be one of C<Graphite> or C<JSON>.
9286
9287 =back
9288
9289 =head2 Plugin C<write_tsdb>
9290
9291 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9292 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9293 state daemon that ingests metrics and stores them in HBase. The plugin uses
9294 I<TCP> over the "line based" protocol with a default port 4242. The data will
9295 be sent in blocks of at most 1428 bytes to minimize the number of network
9296 packets.
9297
9298 Synopsis:
9299
9300  <Plugin write_tsdb>
9301    ResolveInterval 60
9302    ResolveJitter 60
9303    <Node "example">
9304      Host "tsd-1.my.domain"
9305      Port "4242"
9306      HostTags "status=production"
9307    </Node>
9308  </Plugin>
9309
9310 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9311 blocks and global directives.
9312
9313 Global directives are:
9314
9315 =over 4
9316
9317 =item B<ResolveInterval> I<seconds>
9318
9319 =item B<ResolveJitter> I<seconds>
9320
9321 When I<collectd> connects to a TSDB node, it will request the hostname from
9322 DNS. This can become a problem if the TSDB node is unavailable or badly
9323 configured because collectd will request DNS in order to reconnect for every
9324 metric, which can flood your DNS. So you can cache the last value for
9325 I<ResolveInterval> seconds.
9326 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9327
9328 You can also define a jitter, a random interval to wait in addition to
9329 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9330 hostname at the same time when the connection fails.
9331 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9332
9333 B<Note:> If the DNS resolution has already been successful when the socket
9334 closes, the plugin will try to reconnect immediately with the cached
9335 information. DNS is queried only when the socket is closed for a longer than
9336 I<ResolveInterval> + I<ResolveJitter> seconds.
9337
9338 =back
9339
9340 Inside the B<Node> blocks, the following options are recognized:
9341
9342 =over 4
9343
9344 =item B<Host> I<Address>
9345
9346 Hostname or address to connect to. Defaults to C<localhost>.
9347
9348 =item B<Port> I<Service>
9349
9350 Service name or port number to connect to. Defaults to C<4242>.
9351
9352
9353 =item B<HostTags> I<String>
9354
9355 When set, I<HostTags> is added to the end of the metric. It is intended to be
9356 used for name=value pairs that the TSD will tag the metric with. Dots and
9357 whitespace are I<not> escaped in this string.
9358
9359 =item B<StoreRates> B<false>|B<true>
9360
9361 If set to B<true>, convert counter values to rates. If set to B<false>
9362 (the default) counter values are stored as is, as an increasing
9363 integer number.
9364
9365 =item B<AlwaysAppendDS> B<false>|B<true>
9366
9367 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9368 identifier. If set to B<false> (the default), this is only done when there is
9369 more than one DS.
9370
9371 =back
9372
9373 =head2 Plugin C<write_mongodb>
9374
9375 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9376 NoSQL database.
9377
9378 B<Synopsis:>
9379
9380  <Plugin "write_mongodb">
9381    <Node "default">
9382      Host "localhost"
9383      Port "27017"
9384      Timeout 1000
9385      StoreRates true
9386    </Node>
9387  </Plugin>
9388
9389 The plugin can send values to multiple instances of I<MongoDB> by specifying
9390 one B<Node> block for each instance. Within the B<Node> blocks, the following
9391 options are available:
9392
9393 =over 4
9394
9395 =item B<Host> I<Address>
9396
9397 Hostname or address to connect to. Defaults to C<localhost>.
9398
9399 =item B<Port> I<Service>
9400
9401 Service name or port number to connect to. Defaults to C<27017>.
9402
9403 =item B<Timeout> I<Milliseconds>
9404
9405 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9406 Setting this option to zero means no timeout, which is the default.
9407
9408 =item B<StoreRates> B<false>|B<true>
9409
9410 If set to B<true> (the default), convert counter values to rates. If set to
9411 B<false> counter values are stored as is, i.e. as an increasing integer
9412 number.
9413
9414 =item B<Database> I<Database>
9415
9416 =item B<User> I<User>
9417
9418 =item B<Password> I<Password>
9419
9420 Sets the information used when authenticating to a I<MongoDB> database. The
9421 fields are optional (in which case no authentication is attempted), but if you
9422 want to use authentication all three fields must be set.
9423
9424 =back
9425
9426 =head2 Plugin C<write_prometheus>
9427
9428 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9429 using I<Prometheus>.
9430
9431 B<Options:>
9432
9433 =over 4
9434
9435 =item B<Port> I<Port>
9436
9437 Port the embedded webserver should listen on. Defaults to B<9103>.
9438
9439 =item B<StalenessDelta> I<Seconds>
9440
9441 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9442 hasn't seen any update for it. This value must match the setting in Prometheus.
9443 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9444
9445 B<Background:>
9446
9447 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9448 which time a metric without updates is considered "stale". This setting
9449 effectively puts an upper limit on the interval in which metrics are reported.
9450
9451 When the I<write_prometheus plugin> encounters a metric with an interval
9452 exceeding this limit, it will inform you, the user, and provide the metric to
9453 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9454 metric "fresh" each time it is scraped, with the time of the scrape being
9455 considered the time of the update. The result is that there appear more
9456 datapoints in I<Prometheus> than were actually created, but at least the metric
9457 doesn't disappear periodically.
9458
9459 =back
9460
9461 =head2 Plugin C<write_http>
9462
9463 This output plugin submits values to an HTTP server using POST requests and
9464 encoding metrics with JSON or using the C<PUTVAL> command described in
9465 L<collectd-unixsock(5)>.
9466
9467 Synopsis:
9468
9469  <Plugin "write_http">
9470    <Node "example">
9471      URL "http://example.com/post-collectd"
9472      User "collectd"
9473      Password "weCh3ik0"
9474      Format JSON
9475    </Node>
9476  </Plugin>
9477
9478 The plugin can send values to multiple HTTP servers by specifying one
9479 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9480 block, the following options are available:
9481
9482 =over 4
9483
9484 =item B<URL> I<URL>
9485
9486 URL to which the values are submitted to. Mandatory.
9487
9488 =item B<User> I<Username>
9489
9490 Optional user name needed for authentication.
9491
9492 =item B<Password> I<Password>
9493
9494 Optional password needed for authentication.
9495
9496 =item B<VerifyPeer> B<true>|B<false>
9497
9498 Enable or disable peer SSL certificate verification. See
9499 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9500
9501 =item B<VerifyHost> B<true|false>
9502
9503 Enable or disable peer host name verification. If enabled, the plugin checks if
9504 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9505 matches the host name provided by the B<URL> option. If this identity check
9506 fails, the connection is aborted. Obviously, only works when connecting to a
9507 SSL enabled server. Enabled by default.
9508
9509 =item B<CACert> I<File>
9510
9511 File that holds one or more SSL certificates. If you want to use HTTPS you will
9512 possibly need this option. What CA certificates come bundled with C<libcurl>
9513 and are checked by default depends on the distribution you use.
9514
9515 =item B<CAPath> I<Directory>
9516
9517 Directory holding one or more CA certificate files. You can use this if for
9518 some reason all the needed CA certificates aren't in the same file and can't be
9519 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9520 OpenSSL.
9521
9522 =item B<ClientKey> I<File>
9523
9524 File that holds the private key in PEM format to be used for certificate-based
9525 authentication.
9526
9527 =item B<ClientCert> I<File>
9528
9529 File that holds the SSL certificate to be used for certificate-based
9530 authentication.
9531
9532 =item B<ClientKeyPass> I<Password>
9533
9534 Password required to load the private key in B<ClientKey>.
9535
9536 =item B<Header> I<Header>
9537
9538 A HTTP header to add to the request.  Multiple headers are added if this option is specified more than once.  Example:
9539
9540   Header "X-Custom-Header: custom_value"
9541
9542 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9543
9544 Define which SSL protocol version must be used. By default C<libcurl> will
9545 attempt to figure out the remote SSL protocol version. See
9546 L<curl_easy_setopt(3)> for more details.
9547
9548 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9549
9550 Format of the output to generate. If set to B<Command>, will create output that
9551 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9552 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9553 , will create output in the KairosDB format.
9554
9555 Defaults to B<Command>.
9556
9557 =item B<Attribute> I<String> I<String>
9558
9559 Only available for the KAIROSDB output format.
9560
9561 Consider the two given strings to be the key and value of an additional tag for
9562 each metric being sent out.
9563
9564 You can add multiple B<Attribute>.
9565
9566 =item B<TTL> I<Int>
9567
9568 Only available for the KAIROSDB output format.
9569
9570 Sets the Cassandra ttl for the data points.
9571
9572 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9573
9574 =item B<Prefix> I<String>
9575
9576 Only available for the KAIROSDB output format.
9577
9578 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9579
9580 =item B<Metrics> B<true>|B<false>
9581
9582 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9583
9584 =item B<Notifications> B<false>|B<true>
9585
9586 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9587
9588 =item B<StoreRates> B<true|false>
9589
9590 If set to B<true>, convert counter values to rates. If set to B<false> (the
9591 default) counter values are stored as is, i.e. as an increasing integer number.
9592
9593 =item B<BufferSize> I<Bytes>
9594
9595 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9596 requests will be generated, but more metrics will be batched / metrics are
9597 cached for longer before being sent, introducing additional delay until they
9598 are available on the server side. I<Bytes> must be at least 1024 and cannot
9599 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9600 Defaults to C<4096>.
9601
9602 =item B<LowSpeedLimit> I<Bytes per Second>
9603
9604 Sets the minimal transfer rate in I<Bytes per Second> below which the
9605 connection with the HTTP server will be considered too slow and aborted. All
9606 the data submitted over this connection will probably be lost. Defaults to 0,
9607 which means no minimum transfer rate is enforced.
9608
9609 =item B<Timeout> I<Timeout>
9610
9611 Sets the maximum time in milliseconds given for HTTP POST operations to
9612 complete. When this limit is reached, the POST operation will be aborted, and
9613 all the data in the current send buffer will probably be lost. Defaults to 0,
9614 which means the connection never times out.
9615
9616 =item B<LogHttpError> B<false>|B<true>
9617
9618 Enables printing of HTTP error code to log. Turned off by default.
9619
9620 The C<write_http> plugin regularly submits the collected values to the HTTP
9621 server. How frequently this happens depends on how much data you are collecting
9622 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9623 slightly below this interval, which you can estimate by monitoring the network
9624 traffic between collectd and the HTTP server.
9625
9626 =back
9627
9628 =head2 Plugin C<write_kafka>
9629
9630 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9631 queue.
9632 Synopsis:
9633
9634  <Plugin "write_kafka">
9635    Property "metadata.broker.list" "broker1:9092,broker2:9092"
9636    <Topic "collectd">
9637      Format JSON
9638    </Topic>
9639  </Plugin>
9640
9641 The following options are understood by the I<write_kafka plugin>:
9642
9643 =over 4
9644
9645 =item E<lt>B<Topic> I<Name>E<gt>
9646
9647 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9648 is given a unique I<Name> and specifies one kafka producer.
9649 Inside the B<Topic> block, the following per-topic options are
9650 understood:
9651
9652 =over 4
9653
9654 =item B<Property> I<String> I<String>
9655
9656 Configure the named property for the current topic. Properties are
9657 forwarded to the kafka producer library B<librdkafka>.
9658
9659 =item B<Key> I<String>
9660
9661 Use the specified string as a partitioning key for the topic. Kafka breaks
9662 topic into partitions and guarantees that for a given topology, the same
9663 consumer will be used for a specific key. The special (case insensitive)
9664 string B<Random> can be used to specify that an arbitrary partition should
9665 be used.
9666
9667 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9668
9669 Selects the format in which messages are sent to the broker. If set to
9670 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9671 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9672
9673 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9674 an easy and straight forward exchange format.
9675
9676 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9677 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9678
9679 =item B<StoreRates> B<true>|B<false>
9680
9681 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9682 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9683 default), no conversion is performed. Otherwise the conversion is performed
9684 using the internal value cache.
9685
9686 Please note that currently this option is only used if the B<Format> option has
9687 been set to B<JSON>.
9688
9689 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9690
9691 A prefix can be added in the metric name when outputting in the I<Graphite>
9692 format. It's added before the I<Host> name.
9693 Metric name will be
9694 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>>
9695
9696 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9697
9698 A postfix can be added in the metric name when outputting in the I<Graphite>
9699 format. It's added after the I<Host> name.
9700 Metric name will be
9701 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>>
9702
9703 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9704
9705 Specify a character to replace dots (.) in the host part of the metric name.
9706 In I<Graphite> metric name, dots are used as separators between different
9707 metric parts (host, plugin, type).
9708 Default is C<_> (I<Underscore>).
9709
9710 =item B<GraphiteSeparateInstances> B<false>|B<true>
9711
9712 If set to B<true>, the plugin instance and type instance will be in their own
9713 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9714 default), the plugin and plugin instance (and likewise the type and type
9715 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9716
9717 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9718
9719 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9720 identifier. If set to B<false> (the default), this is only done when there is
9721 more than one DS.
9722
9723 =item B<GraphitePreserveSeparator> B<false>|B<true>
9724
9725 If set to B<false> (the default) the C<.> (dot) character is replaced with
9726 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9727 is preserved, i.e. passed through.
9728
9729 =item B<StoreRates> B<true>|B<false>
9730
9731 If set to B<true> (the default), convert counter values to rates. If set to
9732 B<false> counter values are stored as is, i.e. as an increasing integer number.
9733
9734 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9735 converted values will have "rate" appended to the data source type, e.g.
9736 C<ds_type:derive:rate>.
9737
9738 =back
9739
9740 =item B<Property> I<String> I<String>
9741
9742 Configure the kafka producer through properties, you almost always will
9743 want to set B<metadata.broker.list> to your Kafka broker list.
9744
9745 =back
9746
9747 =head2 Plugin C<write_redis>
9748
9749 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9750
9751 Synopsis:
9752
9753   <Plugin "write_redis">
9754     <Node "example">
9755         Host "localhost"
9756         Port "6379"
9757         Timeout 1000
9758         Prefix "collectd/"
9759         Database 1
9760         MaxSetSize -1
9761         MaxSetDuration -1
9762         StoreRates true
9763     </Node>
9764   </Plugin>
9765
9766 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9767 the timestamp as the score. Retrieving a date range can then be done using the
9768 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9769 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9770 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9771 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9772 with the B<Database> parameter (default is C<0>). See
9773 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9774 details.
9775
9776 The information shown in the synopsis above is the I<default configuration>
9777 which is used by the plugin if no configuration is present.
9778
9779 The plugin can send values to multiple instances of I<Redis> by specifying
9780 one B<Node> block for each instance. Within the B<Node> blocks, the following
9781 options are available:
9782
9783 =over 4
9784
9785 =item B<Node> I<Nodename>
9786
9787 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9788 instance running on a specified host and port. The node name is a
9789 canonical identifier which is used as I<plugin instance>. It is limited to
9790 51E<nbsp>characters in length.
9791
9792 =item B<Host> I<Hostname>
9793
9794 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9795 running on.
9796
9797 =item B<Port> I<Port>
9798
9799 The B<Port> option is the TCP port on which the Redis instance accepts
9800 connections. Either a service name of a port number may be given. Please note
9801 that numerical port numbers must be given as a string, too.
9802
9803 =item B<Timeout> I<Milliseconds>
9804
9805 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9806
9807 =item B<Prefix> I<Prefix>
9808
9809 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9810 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9811 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9812 is recommended but not required to include a trailing slash in I<Prefix>.
9813
9814 =item B<Database> I<Index>
9815
9816 This index selects the redis database to use for writing operations. Defaults
9817 to C<0>.
9818
9819 =item B<MaxSetSize> I<Items>
9820
9821 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9822 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9823
9824 =item B<MaxSetDuration> I<Seconds>
9825
9826 The B<MaxSetDuration> option limits the duration of items that the
9827 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9828 is the default behavior.
9829
9830 =item B<StoreRates> B<true>|B<false>
9831
9832 If set to B<true> (the default), convert counter values to rates. If set to
9833 B<false> counter values are stored as is, i.e. as an increasing integer number.
9834
9835 =back
9836
9837 =head2 Plugin C<write_riemann>
9838
9839 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9840 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9841 I<Riemann> using UDP packets.
9842
9843 Synopsis:
9844
9845  <Plugin "write_riemann">
9846    <Node "example">
9847      Host "localhost"
9848      Port "5555"
9849      Protocol UDP
9850      StoreRates true
9851      AlwaysAppendDS false
9852      TTLFactor 2.0
9853    </Node>
9854    Tag "foobar"
9855    Attribute "foo" "bar"
9856  </Plugin>
9857
9858 The following options are understood by the I<write_riemann plugin>:
9859
9860 =over 4
9861
9862 =item E<lt>B<Node> I<Name>E<gt>
9863
9864 The plugin's configuration consists of one or more B<Node> blocks. Each block
9865 is given a unique I<Name> and specifies one connection to an instance of
9866 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9867 understood:
9868
9869 =over 4
9870
9871 =item B<Host> I<Address>
9872
9873 Hostname or address to connect to. Defaults to C<localhost>.
9874
9875 =item B<Port> I<Service>
9876
9877 Service name or port number to connect to. Defaults to C<5555>.
9878
9879 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9880
9881 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9882 B<TCP>.
9883
9884 =item B<TLSCertFile> I<Path>
9885
9886 When using the B<TLS> protocol, path to a PEM certificate to present
9887 to remote host.
9888
9889 =item B<TLSCAFile> I<Path>
9890
9891 When using the B<TLS> protocol, path to a PEM CA certificate to
9892 use to validate the remote hosts's identity.
9893
9894 =item B<TLSKeyFile> I<Path>
9895
9896 When using the B<TLS> protocol, path to a PEM private key associated
9897 with the certificate defined by B<TLSCertFile>.
9898
9899 =item B<Batch> B<true>|B<false>
9900
9901 If set to B<true> and B<Protocol> is set to B<TCP>,
9902 events will be batched in memory and flushed at
9903 regular intervals or when B<BatchMaxSize> is exceeded.
9904
9905 Notifications are not batched and sent as soon as possible.
9906
9907 When enabled, it can occur that events get processed by the Riemann server
9908 close to or after their expiration time. Tune the B<TTLFactor> and
9909 B<BatchMaxSize> settings according to the amount of values collected, if this
9910 is an issue.
9911
9912 Defaults to true
9913
9914 =item B<BatchMaxSize> I<size>
9915
9916 Maximum payload size for a riemann packet. Defaults to 8192
9917
9918 =item B<BatchFlushTimeout> I<seconds>
9919
9920 Maximum amount of seconds to wait in between to batch flushes.
9921 No timeout by default.
9922
9923 =item B<StoreRates> B<true>|B<false>
9924
9925 If set to B<true> (the default), convert counter values to rates. If set to
9926 B<false> counter values are stored as is, i.e. as an increasing integer number.
9927
9928 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9929 converted values will have "rate" appended to the data source type, e.g.
9930 C<ds_type:derive:rate>.
9931
9932 =item B<AlwaysAppendDS> B<false>|B<true>
9933
9934 If set to B<true>, append the name of the I<Data Source> (DS) to the
9935 "service", i.e. the field that, together with the "host" field, uniquely
9936 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9937 only done when there is more than one DS.
9938
9939 =item B<TTLFactor> I<Factor>
9940
9941 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9942 event is considered active. I<collectd> populates this field based on the
9943 metrics interval setting. This setting controls the factor with which the
9944 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9945 know exactly what you're doing, you should only increase this setting from its
9946 default value.
9947
9948 =item B<Notifications> B<false>|B<true>
9949
9950 If set to B<true>, create riemann events for notifications. This is B<true>
9951 by default. When processing thresholds from write_riemann, it might prove
9952 useful to avoid getting notification events.
9953
9954 =item B<CheckThresholds> B<false>|B<true>
9955
9956 If set to B<true>, attach state to events based on thresholds defined
9957 in the B<Threshold> plugin. Defaults to B<false>.
9958
9959 =item B<EventServicePrefix> I<String>
9960
9961 Add the given string as a prefix to the event service name.
9962 If B<EventServicePrefix> not set or set to an empty string (""),
9963 no prefix will be used.
9964
9965 =back
9966
9967 =item B<Tag> I<String>
9968
9969 Add the given string as an additional tag to the metric being sent to
9970 I<Riemann>.
9971
9972 =item B<Attribute> I<String> I<String>
9973
9974 Consider the two given strings to be the key and value of an additional
9975 attribute for each metric being sent out to I<Riemann>.
9976
9977 =back
9978
9979 =head2 Plugin C<write_sensu>
9980
9981 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9982 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9983 a local I<Sensu> client using a TCP socket.
9984
9985 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9986 parameter so it is not possible to use one collectd instance as a gateway for
9987 others. Each collectd host must pair with one I<Sensu> client.
9988
9989 Synopsis:
9990
9991  <Plugin "write_sensu">
9992    <Node "example">
9993      Host "localhost"
9994      Port "3030"
9995      StoreRates true
9996      AlwaysAppendDS false
9997      MetricHandler "influx"
9998      MetricHandler "default"
9999      NotificationHandler "flapjack"
10000      NotificationHandler "howling_monkey"
10001      Notifications true
10002    </Node>
10003    Tag "foobar"
10004    Attribute "foo" "bar"
10005  </Plugin>
10006
10007 The following options are understood by the I<write_sensu plugin>:
10008
10009 =over 4
10010
10011 =item E<lt>B<Node> I<Name>E<gt>
10012
10013 The plugin's configuration consists of one or more B<Node> blocks. Each block
10014 is given a unique I<Name> and specifies one connection to an instance of
10015 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10016 understood:
10017
10018 =over 4
10019
10020 =item B<Host> I<Address>
10021
10022 Hostname or address to connect to. Defaults to C<localhost>.
10023
10024 =item B<Port> I<Service>
10025
10026 Service name or port number to connect to. Defaults to C<3030>.
10027
10028 =item B<StoreRates> B<true>|B<false>
10029
10030 If set to B<true> (the default), convert counter values to rates. If set to
10031 B<false> counter values are stored as is, i.e. as an increasing integer number.
10032
10033 This will be reflected in the C<collectd_data_source_type> tag: If
10034 B<StoreRates> is enabled, converted values will have "rate" appended to the
10035 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
10036
10037 =item B<AlwaysAppendDS> B<false>|B<true>
10038
10039 If set the B<true>, append the name of the I<Data Source> (DS) to the
10040 "service", i.e. the field that, together with the "host" field, uniquely
10041 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10042 only done when there is more than one DS.
10043
10044 =item B<Notifications> B<false>|B<true>
10045
10046 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10047 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10048
10049 =item B<Metrics> B<false>|B<true>
10050
10051 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10052 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10053
10054
10055 =item B<Separator> I<String>
10056
10057 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10058
10059 =item B<MetricHandler> I<String>
10060
10061 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10062 several of them, one per line. Defaults to no handler.
10063
10064 =item B<NotificationHandler> I<String>
10065
10066 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10067 add several of them, one per line. Defaults to no handler.
10068
10069 =item B<EventServicePrefix> I<String>
10070
10071 Add the given string as a prefix to the event service name.
10072 If B<EventServicePrefix> not set or set to an empty string (""),
10073 no prefix will be used.
10074
10075 =back
10076
10077 =item B<Tag> I<String>
10078
10079 Add the given string as an additional tag to the metric being sent to
10080 I<Sensu>.
10081
10082 =item B<Attribute> I<String> I<String>
10083
10084 Consider the two given strings to be the key and value of an additional
10085 attribute for each metric being sent out to I<Sensu>.
10086
10087 =back
10088
10089 =head2 Plugin C<xencpu>
10090
10091 This plugin collects metrics of hardware CPU load for machine running Xen
10092 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10093 Result is reported using the C<percent> type, for each CPU (core).
10094
10095 This plugin doesn't have any options (yet).
10096
10097 =head2 Plugin C<zookeeper>
10098
10099 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10100 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
10101 client port.
10102
10103 B<Synopsis:>
10104
10105  <Plugin "zookeeper">
10106    Host "127.0.0.1"
10107    Port "2181"
10108  </Plugin>
10109
10110 =over 4
10111
10112 =item B<Host> I<Address>
10113
10114 Hostname or address to connect to. Defaults to C<localhost>.
10115
10116 =item B<Port> I<Service>
10117
10118 Service name or port number to connect to. Defaults to C<2181>.
10119
10120 =back
10121
10122 =head1 THRESHOLD CONFIGURATION
10123
10124 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10125 we mean that the values are not only stored or sent somewhere, but that they
10126 are judged and, if a problem is recognized, acted upon. The only action
10127 collectd takes itself is to generate and dispatch a "notification". Plugins can
10128 register to receive notifications and perform appropriate further actions.
10129
10130 Since systems and what you expect them to do differ a lot, you can configure
10131 B<thresholds> for your values freely. This gives you a lot of flexibility but
10132 also a lot of responsibility.
10133
10134 Every time a value is out of range a notification is dispatched. This means
10135 that the idle percentage of your CPU needs to be less then the configured
10136 threshold only once for a notification to be generated. There's no such thing
10137 as a moving average or similar - at least not now.
10138
10139 Also, all values that match a threshold are considered to be relevant or
10140 "interesting". As a consequence collectd will issue a notification if they are
10141 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10142 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10143 "2" (the default) and some hosts sends it's CPU statistics to the server every
10144 60 seconds, a notification will be dispatched after about 120 seconds. It may
10145 take a little longer because the timeout is checked only once each B<Interval>
10146 on the server.
10147
10148 When a value comes within range again or is received after it was missing, an
10149 "OKAY-notification" is dispatched.
10150
10151 Here is a configuration example to get you started. Read below for more
10152 information.
10153
10154  <Plugin threshold>
10155    <Type "foo">
10156      WarningMin    0.00
10157      WarningMax 1000.00
10158      FailureMin    0.00
10159      FailureMax 1200.00
10160      Invert false
10161      Instance "bar"
10162    </Type>
10163
10164    <Plugin "interface">
10165      Instance "eth0"
10166      <Type "if_octets">
10167        FailureMax 10000000
10168        DataSource "rx"
10169      </Type>
10170    </Plugin>
10171
10172    <Host "hostname">
10173      <Type "cpu">
10174        Instance "idle"
10175        FailureMin 10
10176      </Type>
10177
10178      <Plugin "memory">
10179        <Type "memory">
10180          Instance "cached"
10181          WarningMin 100000000
10182        </Type>
10183      </Plugin>
10184    </Host>
10185  </Plugin>
10186
10187 There are basically two types of configuration statements: The C<Host>,
10188 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10189 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10190 C<Instance> option. You can combine the block by nesting the blocks, though
10191 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10192 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10193 C<Type> may not contain other blocks. If multiple blocks apply to the same
10194 value the most specific block is used.
10195
10196 The other statements specify the threshold to configure. They B<must> be
10197 included in a C<Type> block. Currently the following statements are recognized:
10198
10199 =over 4
10200
10201 =item B<FailureMax> I<Value>
10202
10203 =item B<WarningMax> I<Value>
10204
10205 Sets the upper bound of acceptable values. If unset defaults to positive
10206 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10207 will be created. If the value is greater than B<WarningMax> but less than (or
10208 equal to) B<FailureMax> a B<WARNING> notification will be created.
10209
10210 =item B<FailureMin> I<Value>
10211
10212 =item B<WarningMin> I<Value>
10213
10214 Sets the lower bound of acceptable values. If unset defaults to negative
10215 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10216 be created. If the value is less than B<WarningMin> but greater than (or equal
10217 to) B<FailureMin> a B<WARNING> notification will be created.
10218
10219 =item B<DataSource> I<DSName>
10220
10221 Some data sets have more than one "data source". Interesting examples are the
10222 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10223 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10224 system load data set, C<load>, even has three data sources: C<shortterm>,
10225 C<midterm>, and C<longterm>.
10226
10227 Normally, all data sources are checked against a configured threshold. If this
10228 is undesirable, or if you want to specify different limits for each data
10229 source, you can use the B<DataSource> option to have a threshold apply only to
10230 one data source.
10231
10232 =item B<Invert> B<true>|B<false>
10233
10234 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10235 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10236 B<WarningMax>) are not okay. Defaults to B<false>.
10237
10238 =item B<Persist> B<true>|B<false>
10239
10240 Sets how often notifications are generated. If set to B<true> one notification
10241 will be generated for each value that is out of the acceptable range. If set to
10242 B<false> (the default) then a notification is only generated if a value is out
10243 of range but the previous value was okay.
10244
10245 This applies to missing values, too: If set to B<true> a notification about a
10246 missing value is generated once every B<Interval> seconds. If set to B<false>
10247 only one such notification is generated until the value appears again.
10248
10249 =item B<Percentage> B<true>|B<false>
10250
10251 If set to B<true>, the minimum and maximum values given are interpreted as
10252 percentage value, relative to the other data sources. This is helpful for
10253 example for the "df" type, where you may want to issue a warning when less than
10254 5E<nbsp>% of the total space is available. Defaults to B<false>.
10255
10256 =item B<Hits> I<Number>
10257
10258 Delay creating the notification until the threshold has been passed I<Number>
10259 times. When a notification has been generated, or when a subsequent value is
10260 inside the threshold, the counter is reset. If, for example, a value is
10261 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10262 will be dispatched at most once every 30E<nbsp>seconds.
10263
10264 This is useful when short bursts are not a problem. If, for example, 100% CPU
10265 usage for up to a minute is normal (and data is collected every
10266 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10267
10268 =item B<Hysteresis> I<Number>
10269
10270 When set to non-zero, a hysteresis value is applied when checking minimum and
10271 maximum bounds. This is useful for values that increase slowly and fluctuate a
10272 bit while doing so. When these values come close to the threshold, they may
10273 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10274
10275 If, for example, the threshold is configures as
10276
10277   WarningMax 100.0
10278   Hysteresis 1.0
10279
10280 then a I<Warning> notification is created when the value exceeds I<101> and the
10281 corresponding I<Okay> notification is only created once the value falls below
10282 I<99>, thus avoiding the "flapping".
10283
10284 =back
10285
10286 =head1 FILTER CONFIGURATION
10287
10288 Starting with collectd 4.6 there is a powerful filtering infrastructure
10289 implemented in the daemon. The concept has mostly been copied from
10290 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10291 terminology, so that users that are familiar with iptables feel right at home.
10292
10293 =head2 Terminology
10294
10295 The following are the terms used in the remainder of the filter configuration
10296 documentation. For an ASCII-art schema of the mechanism, see
10297 L<"General structure"> below.
10298
10299 =over 4
10300
10301 =item B<Match>
10302
10303 A I<match> is a criteria to select specific values. Examples are, of course, the
10304 name of the value or it's current value.
10305
10306 Matches are implemented in plugins which you have to load prior to using the
10307 match. The name of such plugins starts with the "match_" prefix.
10308
10309 =item B<Target>
10310
10311 A I<target> is some action that is to be performed with data. Such actions
10312 could, for example, be to change part of the value's identifier or to ignore
10313 the value completely.
10314
10315 Some of these targets are built into the daemon, see L<"Built-in targets">
10316 below. Other targets are implemented in plugins which you have to load prior to
10317 using the target. The name of such plugins starts with the "target_" prefix.
10318
10319 =item B<Rule>
10320
10321 The combination of any number of matches and at least one target is called a
10322 I<rule>. The target actions will be performed for all values for which B<all>
10323 matches apply. If the rule does not have any matches associated with it, the
10324 target action will be performed for all values.
10325
10326 =item B<Chain>
10327
10328 A I<chain> is a list of rules and possibly default targets. The rules are tried
10329 in order and if one matches, the associated target will be called. If a value
10330 is handled by a rule, it depends on the target whether or not any subsequent
10331 rules are considered or if traversal of the chain is aborted, see
10332 L<"Flow control"> below. After all rules have been checked, the default targets
10333 will be executed.
10334
10335 =back
10336
10337 =head2 General structure
10338
10339 The following shows the resulting structure:
10340
10341  +---------+
10342  ! Chain   !
10343  +---------+
10344       !
10345       V
10346  +---------+  +---------+  +---------+  +---------+
10347  ! Rule    !->! Match   !->! Match   !->! Target  !
10348  +---------+  +---------+  +---------+  +---------+
10349       !
10350       V
10351  +---------+  +---------+  +---------+
10352  ! Rule    !->! Target  !->! Target  !
10353  +---------+  +---------+  +---------+
10354       !
10355       V
10356       :
10357       :
10358       !
10359       V
10360  +---------+  +---------+  +---------+
10361  ! Rule    !->! Match   !->! Target  !
10362  +---------+  +---------+  +---------+
10363       !
10364       V
10365  +---------+
10366  ! Default !
10367  ! Target  !
10368  +---------+
10369
10370 =head2 Flow control
10371
10372 There are four ways to control which way a value takes through the filter
10373 mechanism:
10374
10375 =over 4
10376
10377 =item B<jump>
10378
10379 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10380 process the value with another chain. When the called chain finishes, usually
10381 the next target or rule after the jump is executed.
10382
10383 =item B<stop>
10384
10385 The stop condition, signaled for example by the built-in target B<stop>, causes
10386 all processing of the value to be stopped immediately.
10387
10388 =item B<return>
10389
10390 Causes processing in the current chain to be aborted, but processing of the
10391 value generally will continue. This means that if the chain was called via
10392 B<Jump>, the next target or rule after the jump will be executed. If the chain
10393 was not called by another chain, control will be returned to the daemon and it
10394 may pass the value to another chain.
10395
10396 =item B<continue>
10397
10398 Most targets will signal the B<continue> condition, meaning that processing
10399 should continue normally. There is no special built-in target for this
10400 condition.
10401
10402 =back
10403
10404 =head2 Synopsis
10405
10406 The configuration reflects this structure directly:
10407
10408  PostCacheChain "PostCache"
10409  <Chain "PostCache">
10410    <Rule "ignore_mysql_show">
10411      <Match "regex">
10412        Plugin "^mysql$"
10413        Type "^mysql_command$"
10414        TypeInstance "^show_"
10415      </Match>
10416      <Target "stop">
10417      </Target>
10418    </Rule>
10419    <Target "write">
10420      Plugin "rrdtool"
10421    </Target>
10422  </Chain>
10423
10424 The above configuration example will ignore all values where the plugin field
10425 is "mysql", the type is "mysql_command" and the type instance begins with
10426 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10427 default target of the chain. Since this chain is run after the value has been
10428 added to the cache, the MySQL C<show_*> command statistics will be available
10429 via the C<unixsock> plugin.
10430
10431 =head2 List of configuration options
10432
10433 =over 4
10434
10435 =item B<PreCacheChain> I<ChainName>
10436
10437 =item B<PostCacheChain> I<ChainName>
10438
10439 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10440 argument is the name of a I<chain> that should be executed before and/or after
10441 the values have been added to the cache.
10442
10443 To understand the implications, it's important you know what is going on inside
10444 I<collectd>. The following diagram shows how values are passed from the
10445 read-plugins to the write-plugins:
10446
10447    +---------------+
10448    !  Read-Plugin  !
10449    +-------+-------+
10450            !
10451  + - - - - V - - - - +
10452  : +---------------+ :
10453  : !   Pre-Cache   ! :
10454  : !     Chain     ! :
10455  : +-------+-------+ :
10456  :         !         :
10457  :         V         :
10458  : +-------+-------+ :  +---------------+
10459  : !     Cache     !--->!  Value Cache  !
10460  : !     insert    ! :  +---+---+-------+
10461  : +-------+-------+ :      !   !
10462  :         !   ,------------'   !
10463  :         V   V     :          V
10464  : +-------+---+---+ :  +-------+-------+
10465  : !  Post-Cache   +--->! Write-Plugins !
10466  : !     Chain     ! :  +---------------+
10467  : +---------------+ :
10468  :                   :
10469  :  dispatch values  :
10470  + - - - - - - - - - +
10471
10472 After the values are passed from the "read" plugins to the dispatch functions,
10473 the pre-cache chain is run first. The values are added to the internal cache
10474 afterwards. The post-cache chain is run after the values have been added to the
10475 cache. So why is it such a huge deal if chains are run before or after the
10476 values have been added to this cache?
10477
10478 Targets that change the identifier of a value list should be executed before
10479 the values are added to the cache, so that the name in the cache matches the
10480 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10481 this cache to receive a list of all available values. If you change the
10482 identifier after the value list has been added to the cache, this may easily
10483 lead to confusion, but it's not forbidden of course.
10484
10485 The cache is also used to convert counter values to rates. These rates are, for
10486 example, used by the C<value> match (see below). If you use the rate stored in
10487 the cache B<before> the new value is added, you will use the old, B<previous>
10488 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10489 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10490 command.
10491
10492 Last but not last, the B<stop> target makes a difference: If the pre-cache
10493 chain returns the stop condition, the value will not be added to the cache and
10494 the post-cache chain will not be run.
10495
10496 =item B<Chain> I<Name>
10497
10498 Adds a new chain with a certain name. This name can be used to refer to a
10499 specific chain, for example to jump to it.
10500
10501 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10502
10503 =item B<Rule> [I<Name>]
10504
10505 Adds a new rule to the current chain. The name of the rule is optional and
10506 currently has no meaning for the daemon.
10507
10508 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10509 must be at least one B<Target> block.
10510
10511 =item B<Match> I<Name>
10512
10513 Adds a match to a B<Rule> block. The name specifies what kind of match should
10514 be performed. Available matches depend on the plugins that have been loaded.
10515
10516 The arguments inside the B<Match> block are passed to the plugin implementing
10517 the match, so which arguments are valid here depends on the plugin being used.
10518 If you do not need any to pass any arguments to a match, you can use the
10519 shorter syntax:
10520
10521  Match "foobar"
10522
10523 Which is equivalent to:
10524
10525  <Match "foobar">
10526  </Match>
10527
10528 =item B<Target> I<Name>
10529
10530 Add a target to a rule or a default target to a chain. The name specifies what
10531 kind of target is to be added. Which targets are available depends on the
10532 plugins being loaded.
10533
10534 The arguments inside the B<Target> block are passed to the plugin implementing
10535 the target, so which arguments are valid here depends on the plugin being used.
10536 If you do not need any to pass any arguments to a target, you can use the
10537 shorter syntax:
10538
10539  Target "stop"
10540
10541 This is the same as writing:
10542
10543  <Target "stop">
10544  </Target>
10545
10546 =back
10547
10548 =head2 Built-in targets
10549
10550 The following targets are built into the core daemon and therefore need no
10551 plugins to be loaded:
10552
10553 =over 4
10554
10555 =item B<return>
10556
10557 Signals the "return" condition, see the L<"Flow control"> section above. This
10558 causes the current chain to stop processing the value and returns control to
10559 the calling chain. The calling chain will continue processing targets and rules
10560 just after the B<jump> target (see below). This is very similar to the
10561 B<RETURN> target of iptables, see L<iptables(8)>.
10562
10563 This target does not have any options.
10564
10565 Example:
10566
10567  Target "return"
10568
10569 =item B<stop>
10570
10571 Signals the "stop" condition, see the L<"Flow control"> section above. This
10572 causes processing of the value to be aborted immediately. This is similar to
10573 the B<DROP> target of iptables, see L<iptables(8)>.
10574
10575 This target does not have any options.
10576
10577 Example:
10578
10579  Target "stop"
10580
10581 =item B<write>
10582
10583 Sends the value to "write" plugins.
10584
10585 Available options:
10586
10587 =over 4
10588
10589 =item B<Plugin> I<Name>
10590
10591 Name of the write plugin to which the data should be sent. This option may be
10592 given multiple times to send the data to more than one write plugin. If the
10593 plugin supports multiple instances, the plugin's instance(s) must also be
10594 specified.
10595
10596 =back
10597
10598 If no plugin is explicitly specified, the values will be sent to all available
10599 write plugins.
10600
10601 Single-instance plugin example:
10602
10603  <Target "write">
10604    Plugin "rrdtool"
10605  </Target>
10606
10607 Multi-instance plugin example:
10608
10609  <Plugin "write_graphite">
10610    <Node "foo">
10611    ...
10612    </Node>
10613    <Node "bar">
10614    ...
10615    </Node>
10616  </Plugin>
10617   ...
10618  <Target "write">
10619    Plugin "write_graphite/foo"
10620  </Target>
10621
10622 =item B<jump>
10623
10624 Starts processing the rules of another chain, see L<"Flow control"> above. If
10625 the end of that chain is reached, or a stop condition is encountered,
10626 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10627 next target or the next rule. This is similar to the B<-j> command line option
10628 of iptables, see L<iptables(8)>.
10629
10630 Available options:
10631
10632 =over 4
10633
10634 =item B<Chain> I<Name>
10635
10636 Jumps to the chain I<Name>. This argument is required and may appear only once.
10637
10638 =back
10639
10640 Example:
10641
10642  <Target "jump">
10643    Chain "foobar"
10644  </Target>
10645
10646 =back
10647
10648 =head2 Available matches
10649
10650 =over 4
10651
10652 =item B<regex>
10653
10654 Matches a value using regular expressions.
10655
10656 Available options:
10657
10658 =over 4
10659
10660 =item B<Host> I<Regex>
10661
10662 =item B<Plugin> I<Regex>
10663
10664 =item B<PluginInstance> I<Regex>
10665
10666 =item B<Type> I<Regex>
10667
10668 =item B<TypeInstance> I<Regex>
10669
10670 =item B<MetaData> I<String> I<Regex>
10671
10672 Match values where the given regular expressions match the various fields of
10673 the identifier of a value. If multiple regular expressions are given, B<all>
10674 regexen must match for a value to match.
10675
10676 =item B<Invert> B<false>|B<true>
10677
10678 When set to B<true>, the result of the match is inverted, i.e. all value lists
10679 where all regular expressions apply are not matched, all other value lists are
10680 matched. Defaults to B<false>.
10681
10682 =back
10683
10684 Example:
10685
10686  <Match "regex">
10687    Host "customer[0-9]+"
10688    Plugin "^foobar$"
10689  </Match>
10690
10691 =item B<timediff>
10692
10693 Matches values that have a time which differs from the time on the server.
10694
10695 This match is mainly intended for servers that receive values over the
10696 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10697 is very sensitive to the timestamp used when updating the RRD files. In
10698 particular, the time must be ever increasing. If a misbehaving client sends one
10699 packet with a timestamp far in the future, all further packets with a correct
10700 time will be ignored because of that one packet. What's worse, such corrupted
10701 RRD files are hard to fix.
10702
10703 This match lets one match all values B<outside> a specified time range
10704 (relative to the server's time), so you can use the B<stop> target (see below)
10705 to ignore the value, for example.
10706
10707 Available options:
10708
10709 =over 4
10710
10711 =item B<Future> I<Seconds>
10712
10713 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10714 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10715 non-zero.
10716
10717 =item B<Past> I<Seconds>
10718
10719 Matches all values that are I<behind> of the server's time by I<Seconds> or
10720 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10721 non-zero.
10722
10723 =back
10724
10725 Example:
10726
10727  <Match "timediff">
10728    Future  300
10729    Past   3600
10730  </Match>
10731
10732 This example matches all values that are five minutes or more ahead of the
10733 server or one hour (or more) lagging behind.
10734
10735 =item B<value>
10736
10737 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10738 values. If a data-set consists of more than one data-source, all data-sources
10739 must match the specified ranges for a positive match.
10740
10741 Available options:
10742
10743 =over 4
10744
10745 =item B<Min> I<Value>
10746
10747 Sets the smallest value which still results in a match. If unset, behaves like
10748 negative infinity.
10749
10750 =item B<Max> I<Value>
10751
10752 Sets the largest value which still results in a match. If unset, behaves like
10753 positive infinity.
10754
10755 =item B<Invert> B<true>|B<false>
10756
10757 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10758 no-match is returned and vice versa. Please note that the B<Invert> setting
10759 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10760 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10761
10762 =item B<DataSource> I<DSName> [I<DSName> ...]
10763
10764 Select one or more of the data sources. If no data source is configured, all
10765 data sources will be checked. If the type handled by the match does not have a
10766 data source of the specified name(s), this will always result in no match
10767 (independent of the B<Invert> setting).
10768
10769 =item B<Satisfy> B<Any>|B<All>
10770
10771 Specifies how checking with several data sources is performed. If set to
10772 B<Any>, the match succeeds if one of the data sources is in the configured
10773 range. If set to B<All> the match only succeeds if all data sources are within
10774 the configured range. Default is B<All>.
10775
10776 Usually B<All> is used for positive matches, B<Any> is used for negative
10777 matches. This means that with B<All> you usually check that all values are in a
10778 "good" range, while with B<Any> you check if any value is within a "bad" range
10779 (or outside the "good" range).
10780
10781 =back
10782
10783 Either B<Min> or B<Max>, but not both, may be unset.
10784
10785 Example:
10786
10787  # Match all values smaller than or equal to 100. Matches only if all data
10788  # sources are below 100.
10789  <Match "value">
10790    Max 100
10791    Satisfy "All"
10792  </Match>
10793
10794  # Match if the value of any data source is outside the range of 0 - 100.
10795  <Match "value">
10796    Min   0
10797    Max 100
10798    Invert true
10799    Satisfy "Any"
10800  </Match>
10801
10802 =item B<empty_counter>
10803
10804 Matches all values with one or more data sources of type B<COUNTER> and where
10805 all counter values are zero. These counters usually I<never> increased since
10806 they started existing (and are therefore uninteresting), or got reset recently
10807 or overflowed and you had really, I<really> bad luck.
10808
10809 Please keep in mind that ignoring such counters can result in confusing
10810 behavior: Counters which hardly ever increase will be zero for long periods of
10811 time. If the counter is reset for some reason (machine or service restarted,
10812 usually), the graph will be empty (NAN) for a long time. People may not
10813 understand why.
10814
10815 =item B<hashed>
10816
10817 Calculates a hash value of the host name and matches values according to that
10818 hash value. This makes it possible to divide all hosts into groups and match
10819 only values that are in a specific group. The intended use is in load
10820 balancing, where you want to handle only part of all data and leave the rest
10821 for other servers.
10822
10823 The hashing function used tries to distribute the hosts evenly. First, it
10824 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10825
10826   hash_value = 0;
10827   for (i = 0; host[i] != 0; i++)
10828     hash_value = (hash_value * 251) + host[i];
10829
10830 The constant 251 is a prime number which is supposed to make this hash value
10831 more random. The code then checks the group for this host according to the
10832 I<Total> and I<Match> arguments:
10833
10834   if ((hash_value % Total) == Match)
10835     matches;
10836   else
10837     does not match;
10838
10839 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10840 groups), then the least significant bit of the hash value will be the XOR of
10841 all least significant bits in the host name. One consequence is that when you
10842 have two hosts, "server0.example.com" and "server1.example.com", where the host
10843 name differs in one digit only and the digits differ by one, those hosts will
10844 never end up in the same group.
10845
10846 Available options:
10847
10848 =over 4
10849
10850 =item B<Match> I<Match> I<Total>
10851
10852 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10853 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10854 be smaller than I<Total>. I<Total> must be at least one, although only values
10855 greater than one really do make any sense.
10856
10857 You can repeat this option to match multiple groups, for example:
10858
10859   Match 3 7
10860   Match 5 7
10861
10862 The above config will divide the data into seven groups and match groups three
10863 and five. One use would be to keep every value on two hosts so that if one
10864 fails the missing data can later be reconstructed from the second host.
10865
10866 =back
10867
10868 Example:
10869
10870  # Operate on the pre-cache chain, so that ignored values are not even in the
10871  # global cache.
10872  <Chain "PreCache">
10873    <Rule>
10874      <Match "hashed">
10875        # Divide all received hosts in seven groups and accept all hosts in
10876        # group three.
10877        Match 3 7
10878      </Match>
10879      # If matched: Return and continue.
10880      Target "return"
10881    </Rule>
10882    # If not matched: Return and stop.
10883    Target "stop"
10884  </Chain>
10885
10886 =back
10887
10888 =head2 Available targets
10889
10890 =over 4
10891
10892 =item B<notification>
10893
10894 Creates and dispatches a notification.
10895
10896 Available options:
10897
10898 =over 4
10899
10900 =item B<Message> I<String>
10901
10902 This required option sets the message of the notification. The following
10903 placeholders will be replaced by an appropriate value:
10904
10905 =over 4
10906
10907 =item B<%{host}>
10908
10909 =item B<%{plugin}>
10910
10911 =item B<%{plugin_instance}>
10912
10913 =item B<%{type}>
10914
10915 =item B<%{type_instance}>
10916
10917 These placeholders are replaced by the identifier field of the same name.
10918
10919 =item B<%{ds:>I<name>B<}>
10920
10921 These placeholders are replaced by a (hopefully) human readable representation
10922 of the current rate of this data source. If you changed the instance name
10923 (using the B<set> or B<replace> targets, see below), it may not be possible to
10924 convert counter values to rates.
10925
10926 =back
10927
10928 Please note that these placeholders are B<case sensitive>!
10929
10930 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10931
10932 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10933 used.
10934
10935 =back
10936
10937 Example:
10938
10939   <Target "notification">
10940     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10941     Severity "WARNING"
10942   </Target>
10943
10944 =item B<replace>
10945
10946 Replaces parts of the identifier using regular expressions.
10947
10948 Available options:
10949
10950 =over 4
10951
10952 =item B<Host> I<Regex> I<Replacement>
10953
10954 =item B<Plugin> I<Regex> I<Replacement>
10955
10956 =item B<PluginInstance> I<Regex> I<Replacement>
10957
10958 =item B<TypeInstance> I<Regex> I<Replacement>
10959
10960 =item B<MetaData> I<String> I<Regex> I<Replacement>
10961
10962 =item B<DeleteMetaData> I<String> I<Regex>
10963
10964 Match the appropriate field with the given regular expression I<Regex>. If the
10965 regular expression matches, that part that matches is replaced with
10966 I<Replacement>. If multiple places of the input buffer match a given regular
10967 expression, only the first occurrence will be replaced.
10968
10969 You can specify each option multiple times to use multiple regular expressions
10970 one after another.
10971
10972 =back
10973
10974 Example:
10975
10976  <Target "replace">
10977    # Replace "example.net" with "example.com"
10978    Host "\\<example.net\\>" "example.com"
10979
10980    # Strip "www." from hostnames
10981    Host "\\<www\\." ""
10982  </Target>
10983
10984 =item B<set>
10985
10986 Sets part of the identifier of a value to a given string.
10987
10988 Available options:
10989
10990 =over 4
10991
10992 =item B<Host> I<String>
10993
10994 =item B<Plugin> I<String>
10995
10996 =item B<PluginInstance> I<String>
10997
10998 =item B<TypeInstance> I<String>
10999
11000 =item B<MetaData> I<String> I<String>
11001
11002 Set the appropriate field to the given string. The strings for plugin instance,
11003 type instance, and meta data may be empty, the strings for host and plugin may
11004 not be empty. It's currently not possible to set the type of a value this way.
11005
11006 The following placeholders will be replaced by an appropriate value:
11007
11008 =over 4
11009
11010 =item B<%{host}>
11011
11012 =item B<%{plugin}>
11013
11014 =item B<%{plugin_instance}>
11015
11016 =item B<%{type}>
11017
11018 =item B<%{type_instance}>
11019
11020 These placeholders are replaced by the identifier field of the same name.
11021
11022 =item B<%{meta:>I<name>B<}>
11023
11024 These placeholders are replaced by the meta data value with the given name.
11025
11026 =back
11027
11028 Please note that these placeholders are B<case sensitive>!
11029
11030 =item B<DeleteMetaData> I<String>
11031
11032 Delete the named meta data field.
11033
11034 =back
11035
11036 Example:
11037
11038  <Target "set">
11039    PluginInstance "coretemp"
11040    TypeInstance "core3"
11041  </Target>
11042
11043 =back
11044
11045 =head2 Backwards compatibility
11046
11047 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11048 B<Chain> block, it will behave as it used to. This is equivalent to the
11049 following configuration:
11050
11051  <Chain "PostCache">
11052    Target "write"
11053  </Chain>
11054
11055 If you specify a B<PostCacheChain>, the B<write> target will not be added
11056 anywhere and you will have to make sure that it is called where appropriate. We
11057 suggest to add the above snippet as default target to your "PostCache" chain.
11058
11059 =head2 Examples
11060
11061 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11062 be an FQDN.
11063
11064  <Chain "PreCache">
11065    <Rule "no_fqdn">
11066      <Match "regex">
11067        Host "^[^\.]*$"
11068      </Match>
11069      Target "stop"
11070    </Rule>
11071    Target "write"
11072  </Chain>
11073
11074 =head1 IGNORELISTS
11075
11076 B<Ignorelists> are a generic framework to either ignore some metrics or report
11077 specific metircs only. Plugins usually provide one or more options to specify
11078 the items (mounts points, devices, ...) and the boolean option
11079 C<IgnoreSelected>.
11080
11081 =over 4
11082
11083 =item B<Select> I<String>
11084
11085 Selects the item I<String>. This option often has a plugin specific name, e.g.
11086 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11087 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11088 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11089
11090 By default, this option is doing a case-sensitive full-string match. The
11091 following config will match C<foo>, but not C<Foo>:
11092
11093   Select "foo"
11094
11095 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11096 I<regular expression>. For example, so match all item starting with C<foo>, use
11097 could use the following syntax:
11098
11099   Select "/^foo/"
11100
11101 The regular expression is I<not> anchored, i.e. the following config will match
11102 C<foobar>, C<barfoo> and C<AfooZ>:
11103
11104   Select "/foo/"
11105
11106 The B<Select> option may be repeated to select multiple items.
11107
11108 =item B<IgnoreSelected> B<true>|B<false>
11109
11110 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11111 collected. If set to B<false>, matching metrics are I<collected> and all other
11112 metrics are ignored.
11113
11114 =back
11115
11116 =head1 SEE ALSO
11117
11118 L<collectd(1)>,
11119 L<collectd-exec(5)>,
11120 L<collectd-perl(5)>,
11121 L<collectd-unixsock(5)>,
11122 L<types.db(5)>,
11123 L<hddtemp(8)>,
11124 L<iptables(8)>,
11125 L<kstat(3KSTAT)>,
11126 L<mbmon(1)>,
11127 L<psql(1)>,
11128 L<regex(7)>,
11129 L<rrdtool(1)>,
11130 L<sensors(1)>
11131
11132 =head1 AUTHOR
11133
11134 Florian Forster E<lt>octo@collectd.orgE<gt>
11135
11136 =cut