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