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<Interval> I<Interval>
2108
2109 Sets the interval (in seconds) in which the values will be collected from this
2110 URL. By default the global B<Interval> setting will be used.
2111
2112 =item B<Namespace> I<Prefix> I<URL>
2113
2114 If an XPath expression references namespaces, they must be specified
2115 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2116 I<URL> is the "namespace name", an URI reference uniquely identifying the
2117 namespace. The option can be repeated to register multiple namespaces.
2118
2119 Examples:
2120
2121   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2122   Namespace "m" "http://www.w3.org/1998/Math/MathML"
2123
2124 =item B<User> I<User>
2125
2126 =item B<Password> I<Password>
2127
2128 =item B<Digest> B<true>|B<false>
2129
2130 =item B<VerifyPeer> B<true>|B<false>
2131
2132 =item B<VerifyHost> B<true>|B<false>
2133
2134 =item B<CACert> I<CA Cert File>
2135
2136 =item B<Header> I<Header>
2137
2138 =item B<Post> I<Body>
2139
2140 =item B<Timeout> I<Milliseconds>
2141
2142 These options behave exactly equivalent to the appropriate options of the
2143 I<cURL plugin>. Please see there for a detailed description.
2144
2145 =item B<E<lt>StatisticsE<gt>>
2146
2147 One B<Statistics> block can be used to specify cURL statistics to be collected
2148 for each request to the remote URL. See the section "cURL Statistics" above
2149 for details.
2150
2151 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2152
2153 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2154 B<XPath> block specifies how to get one type of information. The string
2155 argument must be a valid XPath expression which returns a list of "base
2156 elements". One value is dispatched for each "base element".
2157
2158 Within the B<XPath> block the following options are accepted:
2159
2160 =over 4
2161
2162 =item B<Type> I<Type>
2163
2164 Specifies the I<Type> used for submitting patches. This determines the number
2165 of values that are required / expected and whether the strings are parsed as
2166 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2167 This option is required.
2168
2169 =item B<InstancePrefix> I<InstancePrefix>
2170
2171 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2172 concatenated together without any separator.
2173 This option is optional.
2174
2175 =item B<InstanceFrom> I<InstanceFrom>
2176
2177 Specifies a XPath expression to use for determining the I<type instance>. The
2178 XPath expression must return exactly one element. The element's value is then
2179 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2180
2181 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2182
2183 Specifies a XPath expression to use for determining the I<plugin instance>. The
2184 XPath expression must return exactly one element. The element's value is then
2185 used as I<plugin instance>.
2186
2187 =back
2188
2189 If the "base XPath expression" (the argument to the B<XPath> block) returns
2190 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2191 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2192
2193 =over 4
2194
2195 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2196
2197 Specifies one or more XPath expression to use for reading the values. The
2198 number of XPath expressions must match the number of data sources in the
2199 I<type> specified with B<Type> (see above). Each XPath expression must return
2200 exactly one element. The element's value is then parsed as a number and used as
2201 value for the appropriate value in the value list dispatched to the daemon.
2202 This option is required.
2203
2204 =back
2205
2206 =back
2207
2208 =head2 Plugin C<dbi>
2209
2210 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2211 connect to various databases, execute I<SQL> statements and read back the
2212 results. I<dbi> is an acronym for "database interface" in case you were
2213 wondering about the name. You can configure how each column is to be
2214 interpreted and the plugin will generate one or more data sets from each row
2215 returned according to these rules.
2216
2217 Because the plugin is very generic, the configuration is a little more complex
2218 than those of other plugins. It usually looks something like this:
2219
2220   <Plugin dbi>
2221     <Query "out_of_stock">
2222       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2223       # Use with MySQL 5.0.0 or later
2224       MinVersion 50000
2225       <Result>
2226         Type "gauge"
2227         InstancePrefix "out_of_stock"
2228         InstancesFrom "category"
2229         ValuesFrom "value"
2230       </Result>
2231     </Query>
2232     <Database "product_information">
2233       #Plugin "warehouse"
2234       Driver "mysql"
2235       Interval 120
2236       DriverOption "host" "localhost"
2237       DriverOption "username" "collectd"
2238       DriverOption "password" "aZo6daiw"
2239       DriverOption "dbname" "prod_info"
2240       SelectDB "prod_info"
2241       Query "out_of_stock"
2242     </Database>
2243   </Plugin>
2244
2245 The configuration above defines one query with one result and one database. The
2246 query is then linked to the database with the B<Query> option I<within> the
2247 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2248 and you can also use the B<Include> statement to split up the configuration
2249 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2250 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2251 top to bottom!
2252
2253 The following is a complete list of options:
2254
2255 =head3 B<Query> blocks
2256
2257 Query blocks define I<SQL> statements and how the returned data should be
2258 interpreted. They are identified by the name that is given in the opening line
2259 of the block. Thus the name needs to be unique. Other than that, the name is
2260 not used in collectd.
2261
2262 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2263 define which column holds which value or instance information. You can use
2264 multiple B<Result> blocks to create multiple values from one returned row. This
2265 is especially useful, when queries take a long time and sending almost the same
2266 query again and again is not desirable.
2267
2268 Example:
2269
2270   <Query "environment">
2271     Statement "select station, temperature, humidity from environment"
2272     <Result>
2273       Type "temperature"
2274       # InstancePrefix "foo"
2275       InstancesFrom "station"
2276       ValuesFrom "temperature"
2277     </Result>
2278     <Result>
2279       Type "humidity"
2280       InstancesFrom "station"
2281       ValuesFrom "humidity"
2282     </Result>
2283   </Query>
2284
2285 The following options are accepted:
2286
2287 =over 4
2288
2289 =item B<Statement> I<SQL>
2290
2291 Sets the statement that should be executed on the server. This is B<not>
2292 interpreted by collectd, but simply passed to the database server. Therefore,
2293 the SQL dialect that's used depends on the server collectd is connected to.
2294
2295 The query has to return at least two columns, one for the instance and one
2296 value. You cannot omit the instance, even if the statement is guaranteed to
2297 always return exactly one line. In that case, you can usually specify something
2298 like this:
2299
2300   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2301
2302 (That works with MySQL but may not be valid SQL according to the spec. If you
2303 use a more strict database server, you may have to select from a dummy table or
2304 something.)
2305
2306 Please note that some databases, for example B<Oracle>, will fail if you
2307 include a semicolon at the end of the statement.
2308
2309 =item B<MinVersion> I<Version>
2310
2311 =item B<MaxVersion> I<Value>
2312
2313 Only use this query for the specified database version. You can use these
2314 options to provide multiple queries with the same name but with a slightly
2315 different syntax. The plugin will use only those queries, where the specified
2316 minimum and maximum versions fit the version of the database in use.
2317
2318 The database version is determined by C<dbi_conn_get_engine_version>, see the
2319 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2320 for details. Basically, each part of the version is assumed to be in the range
2321 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2322 "40102", version "5.0.42" becomes "50042".
2323
2324 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2325 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2326 happen. Don't to it! A valid example would be something along these lines:
2327
2328   MinVersion 40000
2329   MaxVersion 49999
2330   ...
2331   MinVersion 50000
2332   MaxVersion 50099
2333   ...
2334   MinVersion 50100
2335   # No maximum
2336
2337 In the above example, there are three ranges that don't overlap. The last one
2338 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2339 before "4.0.0" are not specified.
2340
2341 =item B<Type> I<Type>
2342
2343 The B<type> that's used for each line returned. See L<types.db(5)> for more
2344 details on how types are defined. In short: A type is a predefined layout of
2345 data and the number of values and type of values has to match the type
2346 definition.
2347
2348 If you specify "temperature" here, you need exactly one gauge column. If you
2349 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2350 setting below.
2351
2352 There must be exactly one B<Type> option inside each B<Result> block.
2353
2354 =item B<InstancePrefix> I<prefix>
2355
2356 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2357 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2358 all strings returned in the appropriate columns are concatenated together,
2359 separated by dashes I<("-")>.
2360
2361 =item B<InstancesFrom> I<column0> [I<column1> ...]
2362
2363 Specifies the columns whose values will be used to create the "type-instance"
2364 for each row. If you specify more than one column, the value of all columns
2365 will be joined together with dashes I<("-")> as separation characters.
2366
2367 The plugin itself does not check whether or not all built instances are
2368 different. It's your responsibility to assure that each is unique. This is
2369 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2370 sure that only one row is returned in this case.
2371
2372 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2373 will be empty.
2374
2375 =item B<ValuesFrom> I<column0> [I<column1> ...]
2376
2377 Names the columns whose content is used as the actual data for the data sets
2378 that are dispatched to the daemon. How many such columns you need is determined
2379 by the B<Type> setting above. If you specify too many or not enough columns,
2380 the plugin will complain about that and no data will be submitted to the
2381 daemon.
2382
2383 The actual data type in the columns is not that important. The plugin will
2384 automatically cast the values to the right type if it know how to do that. So
2385 it should be able to handle integer an floating point types, as well as strings
2386 (if they include a number at the beginning).
2387
2388 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2389
2390 =item B<MetadataFrom> [I<column0> I<column1> ...]
2391
2392 Names the columns whose content is used as metadata for the data sets
2393 that are dispatched to the daemon.
2394
2395 The actual data type in the columns is not that important. The plugin will
2396 automatically cast the values to the right type if it know how to do that. So
2397 it should be able to handle integer an floating point types, as well as strings
2398 (if they include a number at the beginning).
2399
2400 =back
2401
2402 =head3 B<Database> blocks
2403
2404 Database blocks define a connection to a database and which queries should be
2405 sent to that database. Since the used "dbi" library can handle a wide variety
2406 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2407 documentationE<nbsp>- we stick as close to the terminology used there.
2408
2409 Each database needs a "name" as string argument in the starting tag of the
2410 block. This name will be used as "PluginInstance" in the values submitted to
2411 the daemon. Other than that, that name is not used.
2412
2413 =over 4
2414
2415 =item B<Plugin> I<Plugin>
2416
2417 Use I<Plugin> as the plugin name when submitting query results from
2418 this B<Database>. Defaults to C<dbi>.
2419
2420 =item B<Interval> I<Interval>
2421
2422 Sets the interval (in seconds) in which the values will be collected from this
2423 database. By default the global B<Interval> setting will be used.
2424
2425 =item B<Driver> I<Driver>
2426
2427 Specifies the driver to use to connect to the database. In many cases those
2428 drivers are named after the database they can connect to, but this is not a
2429 technical necessity. These drivers are sometimes referred to as "DBD",
2430 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2431 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2432 project at L<http://libdbi-drivers.sourceforge.net/>.
2433
2434 You need to give the driver name as expected by the "dbi" library here. You
2435 should be able to find that in the documentation for each driver. If you
2436 mistype the driver name, the plugin will dump a list of all known driver names
2437 to the log.
2438
2439 =item B<DriverOption> I<Key> I<Value>
2440
2441 Sets driver-specific options. What option a driver supports can be found in the
2442 documentation for each driver, somewhere at
2443 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2444 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2445
2446 DBDs can register two types of options: String options and numeric options. The
2447 plugin will use the C<dbi_conn_set_option> function when the configuration
2448 provides a string and the C<dbi_conn_require_option_numeric> function when the
2449 configuration provides a number. So these two lines will actually result in
2450 different calls being used:
2451
2452   DriverOption "Port" 1234      # numeric
2453   DriverOption "Port" "1234"    # string
2454
2455 Unfortunately, drivers are not too keen to report errors when an unknown option
2456 is passed to them, so invalid settings here may go unnoticed. This is not the
2457 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2458 the driver. If a driver complains about an option, the plugin will dump a
2459 complete list of all options understood by that driver to the log. There is no
2460 way to programmatically find out if an option expects a string or a numeric
2461 argument, so you will have to refer to the appropriate DBD's documentation to
2462 find this out. Sorry.
2463
2464 =item B<SelectDB> I<Database>
2465
2466 In some cases, the database name you connect with is not the database name you
2467 want to use for querying data. If this option is set, the plugin will "select"
2468 (switch to) that database after the connection is established.
2469
2470 =item B<Query> I<QueryName>
2471
2472 Associates the query named I<QueryName> with this database connection. The
2473 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2474 blocks you want to refer to must be placed above the database block you want to
2475 refer to them from.
2476
2477 =item B<Host> I<Hostname>
2478
2479 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2480 values. Defaults to the global hostname setting.
2481
2482 =back
2483
2484 =head2 Plugin C<df>
2485
2486 =over 4
2487
2488 =item B<Device> I<Device>
2489
2490 Select partitions based on the devicename.
2491
2492 See F</"IGNORELISTS"> for details.
2493
2494 =item B<MountPoint> I<Directory>
2495
2496 Select partitions based on the mountpoint.
2497
2498 See F</"IGNORELISTS"> for details.
2499
2500 =item B<FSType> I<FSType>
2501
2502 Select partitions based on the filesystem type.
2503
2504 See F</"IGNORELISTS"> for details.
2505
2506 =item B<IgnoreSelected> B<true>|B<false>
2507
2508 Invert the selection: If set to true, all partitions B<except> the ones that
2509 match any one of the criteria are collected. By default only selected
2510 partitions are collected if a selection is made. If no selection is configured
2511 at all, B<all> partitions are selected.
2512
2513 =item B<ReportByDevice> B<true>|B<false>
2514
2515 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2516 (the default), it will report a disk as "root", but with it I<true>, it will be
2517 "sda1" (or whichever).
2518
2519 =item B<ReportInodes> B<true>|B<false>
2520
2521 Enables or disables reporting of free, reserved and used inodes. Defaults to
2522 inode collection being disabled.
2523
2524 Enable this option if inodes are a scarce resource for you, usually because
2525 many small files are stored on the disk. This is a usual scenario for mail
2526 transfer agents and web caches.
2527
2528 =item B<ValuesAbsolute> B<true>|B<false>
2529
2530 Enables or disables reporting of free and used disk space in 1K-blocks.
2531 Defaults to B<true>.
2532
2533 =item B<ValuesPercentage> B<false>|B<true>
2534
2535 Enables or disables reporting of free and used disk space in percentage.
2536 Defaults to B<false>.
2537
2538 This is useful for deploying I<collectd> on the cloud, where machines with
2539 different disk size may exist. Then it is more practical to configure
2540 thresholds based on relative disk size.
2541
2542 =back
2543
2544 =head2 Plugin C<disk>
2545
2546 The C<disk> plugin collects information about the usage of physical disks and
2547 logical disks (partitions). Values collected are the number of octets written
2548 to and read from a disk or partition, the number of read/write operations
2549 issued to the disk and a rather complex "time" it took for these commands to be
2550 issued.
2551
2552 Using the following two options you can ignore some disks or configure the
2553 collection only of specific disks.
2554
2555 =over 4
2556
2557 =item B<Disk> I<Name>
2558
2559 Select the disk I<Name>. Whether it is collected or ignored depends on the
2560 B<IgnoreSelected> setting, see below. As with other plugins that use the
2561 daemon's ignorelist functionality, a string that starts and ends with a slash
2562 is interpreted as a regular expression. Examples:
2563
2564   Disk "sdd"
2565   Disk "/hda[34]/"
2566
2567 See F</"IGNORELISTS"> for details.
2568
2569 =item B<IgnoreSelected> B<true>|B<false>
2570
2571 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2572 statements, are ignored or if all other disks are ignored. The behavior
2573 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2574 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2575 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2576 is set to B<true>, all disks are collected B<except> the ones matched.
2577
2578 =item B<UseBSDName> B<true>|B<false>
2579
2580 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2581 default major/minor numbers. Requires collectd to be built with Apple's
2582 IOKitLib support.
2583
2584 =item B<UdevNameAttr> I<Attribute>
2585
2586 Attempt to override disk instance name with the value of a specified udev
2587 attribute when built with B<libudev>.  If the attribute is not defined for the
2588 given device, the default name is used. Example:
2589
2590   UdevNameAttr "DM_NAME"
2591
2592 =back
2593
2594 =head2 Plugin C<dns>
2595
2596 =over 4
2597
2598 =item B<Interface> I<Interface>
2599
2600 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2601 option sets the interface that should be used. If this option is not set, or
2602 set to "any", the plugin will try to get packets from B<all> interfaces. This
2603 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2604
2605 =item B<IgnoreSource> I<IP-address>
2606
2607 Ignore packets that originate from this address.
2608
2609 =item B<SelectNumericQueryTypes> B<true>|B<false>
2610
2611 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2612
2613 =back
2614
2615 =head2 Plugin C<dpdkevents>
2616
2617 The I<dpdkevents plugin> collects events from DPDK such as link status of
2618 network ports and Keep Alive status of DPDK logical cores.
2619 In order to get Keep Alive events following requirements must be met:
2620 - DPDK >= 16.07
2621 - support for Keep Alive implemented in DPDK application. More details can
2622 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2623
2624 B<Synopsis:>
2625
2626  <Plugin "dpdkevents">
2627    <EAL>
2628      Coremask "0x1"
2629      MemoryChannels "4"
2630      FilePrefix "rte"
2631    </EAL>
2632    <Event "link_status">
2633      SendEventsOnUpdate true
2634      EnabledPortMask 0xffff
2635      PortName "interface1"
2636      PortName "interface2"
2637      SendNotification false
2638    </Event>
2639    <Event "keep_alive">
2640      SendEventsOnUpdate true
2641      LCoreMask "0xf"
2642      KeepAliveShmName "/dpdk_keepalive_shm_name"
2643      SendNotification false
2644    </Event>
2645  </Plugin>
2646
2647 B<Options:>
2648
2649
2650 =head3 The EAL block
2651
2652 =over 4
2653
2654 =item B<Coremask> I<Mask>
2655
2656 =item B<Memorychannels> I<Channels>
2657
2658 Number of memory channels per processor socket.
2659
2660 =item B<FilePrefix> I<File>
2661
2662 The prefix text used for hugepage filenames. The filename will be set to
2663 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2664
2665 =back
2666
2667 =head3 The Event block
2668
2669 The B<Event> block defines configuration for specific event. It accepts a
2670 single argument which specifies the name of the event.
2671
2672 =head4 Link Status event
2673
2674 =over 4
2675
2676 =item B<SendEventOnUpdate> I<true|false>
2677
2678 If set to true link status value will be dispatched only when it is
2679 different from previously read value. This is an optional argument - default
2680 value is true.
2681
2682 =item B<EnabledPortMask> I<Mask>
2683
2684 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2685 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2686 that all ports will be enabled. This is an optional argument - by default
2687 all ports are enabled.
2688
2689 =item B<PortName> I<Name>
2690
2691 A string containing an optional name for the enabled DPDK ports. Each PortName
2692 option should contain only one port name; specify as many PortName options as
2693 desired. Default naming convention will be used if PortName is blank. If there
2694 are less PortName options than there are enabled ports, the default naming
2695 convention will be used for the additional ports.
2696
2697 =item B<SendNotification> I<true|false>
2698
2699 If set to true, link status notifications are sent, instead of link status
2700 being collected as a statistic. This is an optional argument - default
2701 value is false.
2702
2703 =back
2704
2705 =head4 Keep Alive event
2706
2707 =over 4
2708
2709 =item B<SendEventOnUpdate> I<true|false>
2710
2711 If set to true keep alive value will be dispatched only when it is
2712 different from previously read value. This is an optional argument - default
2713 value is true.
2714
2715 =item B<LCoreMask> I<Mask>
2716
2717 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2718
2719 =item B<KeepAliveShmName> I<Name>
2720
2721 Shared memory name identifier that is used by secondary process to monitor
2722 the keep alive cores state.
2723
2724 =item B<SendNotification> I<true|false>
2725
2726 If set to true, keep alive notifications are sent, instead of keep alive
2727 information being collected as a statistic. This is an optional
2728 argument - default value is false.
2729
2730 =back
2731
2732 =head2 Plugin C<dpdkstat>
2733
2734 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2735 extended NIC stats API in DPDK.
2736
2737 B<Synopsis:>
2738
2739  <Plugin "dpdkstat">
2740    <EAL>
2741      Coremask "0x4"
2742      MemoryChannels "4"
2743      FilePrefix "rte"
2744      SocketMemory "1024"
2745      LogLevel "7"
2746      RteDriverLibPath "/usr/lib/dpdk-pmd"
2747    </EAL>
2748    SharedMemObj "dpdk_collectd_stats_0"
2749    EnabledPortMask 0xffff
2750    PortName "interface1"
2751    PortName "interface2"
2752  </Plugin>
2753
2754 B<Options:>
2755
2756 =head3 The EAL block
2757
2758 =over 4
2759
2760 =item B<Coremask> I<Mask>
2761
2762 A string containing an hexadecimal bit mask of the cores to run on. Note that
2763 core numbering can change between platforms and should be determined beforehand.
2764
2765 =item B<Memorychannels> I<Channels>
2766
2767 A string containing a number of memory channels per processor socket.
2768
2769 =item B<FilePrefix> I<File>
2770
2771 The prefix text used for hugepage filenames. The filename will be set to
2772 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2773
2774 =item B<SocketMemory> I<MB>
2775
2776 A string containing amount of Memory to allocate from hugepages on specific
2777 sockets in MB. This is an optional value.
2778
2779 =item B<LogLevel> I<LogLevel_number>
2780
2781 A string containing log level number. This parameter is optional.
2782 If parameter is not present then default value "7" - (INFO) is used.
2783 Value "8" - (DEBUG) can be set to enable debug traces.
2784
2785 =item B<RteDriverLibPath> I<Path>
2786
2787 A string containing path to shared pmd driver lib or path to directory,
2788 where shared pmd driver libs are available. This parameter is optional.
2789 This parameter enable loading of shared pmd driver libs from defined path.
2790 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2791 or    "/usr/lib/dpdk-pmd"
2792
2793 =back
2794
2795 =over 3
2796
2797 =item B<SharedMemObj> I<Mask>
2798
2799 A string containing the name of the shared memory object that should be used to
2800 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2801 Defaults to dpdk_collectd_stats if no other value is configured.
2802
2803 =item B<EnabledPortMask> I<Mask>
2804
2805 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2806 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2807 that all ports will be enabled. This is an optional argument - default
2808 is all ports enabled.
2809
2810 =item B<PortName> I<Name>
2811
2812 A string containing an optional name for the enabled DPDK ports. Each PortName
2813 option should contain only one port name; specify as many PortName options as
2814 desired. Default naming convention will be used if PortName is blank. If there
2815 are less PortName options than there are enabled ports, the default naming
2816 convention will be used for the additional ports.
2817
2818 =back
2819
2820 =head2 Plugin C<email>
2821
2822 =over 4
2823
2824 =item B<SocketFile> I<Path>
2825
2826 Sets the socket-file which is to be created.
2827
2828 =item B<SocketGroup> I<Group>
2829
2830 If running as root change the group of the UNIX-socket after it has been
2831 created. Defaults to B<collectd>.
2832
2833 =item B<SocketPerms> I<Permissions>
2834
2835 Change the file permissions of the UNIX-socket after it has been created. The
2836 permissions must be given as a numeric, octal value as you would pass to
2837 L<chmod(1)>. Defaults to B<0770>.
2838
2839 =item B<MaxConns> I<Number>
2840
2841 Sets the maximum number of connections that can be handled in parallel. Since
2842 this many threads will be started immediately setting this to a very high
2843 value will waste valuable resources. Defaults to B<5> and will be forced to be
2844 at most B<16384> to prevent typos and dumb mistakes.
2845
2846 =back
2847
2848 =head2 Plugin C<ethstat>
2849
2850 The I<ethstat plugin> collects information about network interface cards (NICs)
2851 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2852
2853 B<Synopsis:>
2854
2855  <Plugin "ethstat">
2856    Interface "eth0"
2857    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2858    Map "multicast" "if_multicast"
2859  </Plugin>
2860
2861 B<Options:>
2862
2863 =over 4
2864
2865 =item B<Interface> I<Name>
2866
2867 Collect statistical information about interface I<Name>.
2868
2869 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2870
2871 By default, the plugin will submit values as type C<derive> and I<type
2872 instance> set to I<Name>, the name of the metric as reported by the driver. If
2873 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2874 I<TypeInstance> will be used.
2875
2876 =item B<MappedOnly> B<true>|B<false>
2877
2878 When set to B<true>, only metrics that can be mapped to a I<type> will be
2879 collected, all other metrics will be ignored. Defaults to B<false>.
2880
2881 =back
2882
2883 =head2 Plugin C<exec>
2884
2885 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2886 contains valuable information on when the executable is executed and the
2887 output that is expected from it.
2888
2889 =over 4
2890
2891 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2892
2893 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2894
2895 Execute the executable I<Executable> as user I<User>. If the user name is
2896 followed by a colon and a group name, the effective group is set to that group.
2897 The real group and saved-set group will be set to the default group of that
2898 user. If no group is given the effective group ID will be the same as the real
2899 group ID.
2900
2901 Please note that in order to change the user and/or group the daemon needs
2902 superuser privileges. If the daemon is run as an unprivileged user you must
2903 specify the same user/group here. If the daemon is run with superuser
2904 privileges, you must supply a non-root user here.
2905
2906 The executable may be followed by optional arguments that are passed to the
2907 program. Please note that due to the configuration parsing numbers and boolean
2908 values may be changed. If you want to be absolutely sure that something is
2909 passed as-is please enclose it in quotes.
2910
2911 The B<Exec> and B<NotificationExec> statements change the semantics of the
2912 programs executed, i.E<nbsp>e. the data passed to them and the response
2913 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2914
2915 =back
2916
2917 =head2 Plugin C<fhcount>
2918
2919 The C<fhcount> plugin provides statistics about used, unused and total number of
2920 file handles on Linux.
2921
2922 The I<fhcount plugin> provides the following configuration options:
2923
2924 =over 4
2925
2926 =item B<ValuesAbsolute> B<true>|B<false>
2927
2928 Enables or disables reporting of file handles usage in absolute numbers,
2929 e.g. file handles used. Defaults to B<true>.
2930
2931 =item B<ValuesPercentage> B<false>|B<true>
2932
2933 Enables or disables reporting of file handles usage in percentages, e.g.
2934 percent of file handles used. Defaults to B<false>.
2935
2936 =back
2937
2938 =head2 Plugin C<filecount>
2939
2940 The C<filecount> plugin counts the number of files in a certain directory (and
2941 its subdirectories) and their combined size. The configuration is very straight
2942 forward:
2943
2944   <Plugin "filecount">
2945     <Directory "/var/qmail/queue/mess">
2946       Instance "qmail-message"
2947     </Directory>
2948     <Directory "/var/qmail/queue/todo">
2949       Instance "qmail-todo"
2950     </Directory>
2951     <Directory "/var/lib/php5">
2952       Instance "php5-sessions"
2953       Name "sess_*"
2954     </Directory>
2955   </Plugin>
2956
2957 The example above counts the number of files in QMail's queue directories and
2958 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2959 QMail has not yet looked at, the "message" queue holds the messages that were
2960 classified into "local" and "remote".
2961
2962 As you can see, the configuration consists of one or more C<Directory> blocks,
2963 each of which specifies a directory in which to count the files. Within those
2964 blocks, the following options are recognized:
2965
2966 =over 4
2967
2968 =item B<Plugin> I<Plugin>
2969
2970 Use I<Plugin> as the plugin name when submitting values.
2971 Defaults to B<filecount>.
2972
2973 =item B<Instance> I<Instance>
2974
2975 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2976 the directory name with all slashes replaced by underscores and all leading
2977 underscores removed. Empty value is allowed.
2978
2979 =item B<Name> I<Pattern>
2980
2981 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2982 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2983 against the pattern, not the entire path. In case this makes it easier for you:
2984 This option has been named after the B<-name> parameter to L<find(1)>.
2985
2986 =item B<MTime> I<Age>
2987
2988 Count only files of a specific age: If I<Age> is greater than zero, only files
2989 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2990 a negative number, this is inversed. For example, if B<-60> is specified, only
2991 files that have been modified in the last minute will be counted.
2992
2993 The number can also be followed by a "multiplier" to easily specify a larger
2994 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2995 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2996 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2997 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2998 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2999 B<"12h">.
3000
3001 =item B<Size> I<Size>
3002
3003 Count only files of a specific size. When I<Size> is a positive number, only
3004 files that are at least this big are counted. If I<Size> is a negative number,
3005 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3006 I<Size> are counted.
3007
3008 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3009 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3010 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3011 note that there are 1000 bytes in a kilobyte, not 1024.
3012
3013 =item B<Recursive> I<true>|I<false>
3014
3015 Controls whether or not to recurse into subdirectories. Enabled by default.
3016
3017 =item B<IncludeHidden> I<true>|I<false>
3018
3019 Controls whether or not to include "hidden" files and directories in the count.
3020 "Hidden" files and directories are those, whose name begins with a dot.
3021 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3022
3023 =item B<RegularOnly> I<true>|I<false>
3024
3025 Controls whether or not to include only regular files in the count.
3026 Defaults to I<true>, i.e. by default non regular files are ignored.
3027
3028 =item B<FilesSizeType> I<Type>
3029
3030 Sets the type used to dispatch files combined size. Empty value ("") disables
3031 reporting. Defaults to B<bytes>.
3032
3033 =item B<FilesCountType> I<Type>
3034
3035 Sets the type used to dispatch number of files. Empty value ("") disables
3036 reporting. Defaults to B<files>.
3037
3038 =item B<TypeInstance> I<Instance>
3039
3040 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3041 (no plugin instance).
3042
3043 =back
3044
3045 =head2 Plugin C<GenericJMX>
3046
3047 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3048 L<collectd-java(5)>.
3049
3050 =head2 Plugin C<gmond>
3051
3052 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3053 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3054 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3055
3056 Synopsis:
3057
3058  <Plugin "gmond">
3059    MCReceiveFrom "239.2.11.71" "8649"
3060    <Metric "swap_total">
3061      Type "swap"
3062      TypeInstance "total"
3063      DataSource "value"
3064    </Metric>
3065    <Metric "swap_free">
3066      Type "swap"
3067      TypeInstance "free"
3068      DataSource "value"
3069    </Metric>
3070  </Plugin>
3071
3072 The following metrics are built-in:
3073
3074 =over 4
3075
3076 =item *
3077
3078 load_one, load_five, load_fifteen
3079
3080 =item *
3081
3082 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3083
3084 =item *
3085
3086 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3087
3088 =item *
3089
3090 bytes_in, bytes_out
3091
3092 =item *
3093
3094 pkts_in, pkts_out
3095
3096 =back
3097
3098 Available configuration options:
3099
3100 =over 4
3101
3102 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3103
3104 Sets sets the multicast group and UDP port to which to subscribe.
3105
3106 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3107
3108 =item E<lt>B<Metric> I<Name>E<gt>
3109
3110 These blocks add a new metric conversion to the internal table. I<Name>, the
3111 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3112
3113 =over 4
3114
3115 =item B<Type> I<Type>
3116
3117 Type to map this metric to. Required.
3118
3119 =item B<TypeInstance> I<Instance>
3120
3121 Type-instance to use. Optional.
3122
3123 =item B<DataSource> I<Name>
3124
3125 Data source to map this metric to. If the configured type has exactly one data
3126 source, this is optional. Otherwise the option is required.
3127
3128 =back
3129
3130 =back
3131
3132 =head2 Plugin C<gps>
3133
3134 The C<gps plugin> connects to gpsd on the host machine.
3135 The host, port, timeout and pause are configurable.
3136
3137 This is useful if you run an NTP server using a GPS for source and you want to
3138 monitor it.
3139
3140 Mind your GPS must send $--GSA for having the data reported!
3141
3142 The following elements are collected:
3143
3144 =over 4
3145
3146 =item B<satellites>
3147
3148 Number of satellites used for fix (type instance "used") and in view (type
3149 instance "visible"). 0 means no GPS satellites are visible.
3150
3151 =item B<dilution_of_precision>
3152
3153 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3154 It should be between 0 and 3.
3155 Look at the documentation of your GPS to know more.
3156
3157 =back
3158
3159 Synopsis:
3160
3161  LoadPlugin gps
3162  <Plugin "gps">
3163    # Connect to localhost on gpsd regular port:
3164    Host "127.0.0.1"
3165    Port "2947"
3166    # 15 ms timeout
3167    Timeout 0.015
3168    # PauseConnect of 5 sec. between connection attempts.
3169    PauseConnect 5
3170  </Plugin>
3171
3172 Available configuration options:
3173
3174 =over 4
3175
3176 =item B<Host> I<Host>
3177
3178 The host on which gpsd daemon runs. Defaults to B<localhost>.
3179
3180 =item B<Port> I<Port>
3181
3182 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3183
3184 =item B<Timeout> I<Seconds>
3185
3186 Timeout in seconds (default 0.015 sec).
3187
3188 The GPS data stream is fetch by the plugin form the daemon.
3189 It waits for data to be available, if none arrives it times out
3190 and loop for another reading.
3191 Mind to put a low value gpsd expects value in the micro-seconds area
3192 (recommended is 500 us) since the waiting function is blocking.
3193 Value must be between 500 us and 5 sec., if outside that range the
3194 default value is applied.
3195
3196 This only applies from gpsd release-2.95.
3197
3198 =item B<PauseConnect> I<Seconds>
3199
3200 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3201
3202 =back
3203
3204 =head2 Plugin C<grpc>
3205
3206 The I<grpc> plugin provides an RPC interface to submit values to or query
3207 values from collectd based on the open source gRPC framework. It exposes an
3208 end-point for dispatching values to the daemon.
3209
3210 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3211
3212 =over 4
3213
3214 =item B<Server> I<Host> I<Port>
3215
3216 The B<Server> statement sets the address of a server to which to send metrics
3217 via the C<DispatchValues> function.
3218
3219 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3220
3221 Optionally, B<Server> may be specified as a configuration block which supports
3222 the following options:
3223
3224 =over 4
3225
3226 =item B<EnableSSL> B<false>|B<true>
3227
3228 Whether to require SSL for outgoing connections. Default: false.
3229
3230 =item B<SSLCACertificateFile> I<Filename>
3231
3232 =item B<SSLCertificateFile> I<Filename>
3233
3234 =item B<SSLCertificateKeyFile> I<Filename>
3235
3236 Filenames specifying SSL certificate and key material to be used with SSL
3237 connections.
3238
3239 =back
3240
3241 =item B<Listen> I<Host> I<Port>
3242
3243 The B<Listen> statement sets the network address to bind to. When multiple
3244 statements are specified, the daemon will bind to all of them. If none are
3245 specified, it defaults to B<0.0.0.0:50051>.
3246
3247 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3248
3249 Optionally, B<Listen> may be specified as a configuration block which
3250 supports the following options:
3251
3252 =over 4
3253
3254 =item B<EnableSSL> I<true>|I<false>
3255
3256 Whether to enable SSL for incoming connections. Default: false.
3257
3258 =item B<SSLCACertificateFile> I<Filename>
3259
3260 =item B<SSLCertificateFile> I<Filename>
3261
3262 =item B<SSLCertificateKeyFile> I<Filename>
3263
3264 Filenames specifying SSL certificate and key material to be used with SSL
3265 connections.
3266
3267 =item B<VerifyPeer> B<true>|B<false>
3268
3269 When enabled, a valid client certificate is required to connect to the server.
3270 When disabled, a client certifiacte is not requested and any unsolicited client
3271 certificate is accepted.
3272 Enabled by default.
3273
3274 =back
3275
3276 =back
3277
3278 =head2 Plugin C<hddtemp>
3279
3280 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3281 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3282 default values, see below. C<hddtemp> has to be running to work correctly. If
3283 C<hddtemp> is not running timeouts may appear which may interfere with other
3284 statistics..
3285
3286 The B<hddtemp> homepage can be found at
3287 L<http://www.guzu.net/linux/hddtemp.php>.
3288
3289 =over 4
3290
3291 =item B<Host> I<Hostname>
3292
3293 Hostname to connect to. Defaults to B<127.0.0.1>.
3294
3295 =item B<Port> I<Port>
3296
3297 TCP-Port to connect to. Defaults to B<7634>.
3298
3299 =back
3300
3301 =head2 Plugin C<hugepages>
3302
3303 To collect B<hugepages> information, collectd reads directories
3304 "/sys/devices/system/node/*/hugepages" and
3305 "/sys/kernel/mm/hugepages".
3306 Reading of these directories can be disabled by the following
3307 options (default is enabled).
3308
3309 =over 4
3310
3311 =item B<ReportPerNodeHP> B<true>|B<false>
3312
3313 If enabled, information will be collected from the hugepage
3314 counters in "/sys/devices/system/node/*/hugepages".
3315 This is used to check the per-node hugepage statistics on
3316 a NUMA system.
3317
3318 =item B<ReportRootHP> B<true>|B<false>
3319
3320 If enabled, information will be collected from the hugepage
3321 counters in "/sys/kernel/mm/hugepages".
3322 This can be used on both NUMA and non-NUMA systems to check
3323 the overall hugepage statistics.
3324
3325 =item B<ValuesPages> B<true>|B<false>
3326
3327 Whether to report hugepages metrics in number of pages.
3328 Defaults to B<true>.
3329
3330 =item B<ValuesBytes> B<false>|B<true>
3331
3332 Whether to report hugepages metrics in bytes.
3333 Defaults to B<false>.
3334
3335 =item B<ValuesPercentage> B<false>|B<true>
3336
3337 Whether to report hugepages metrics as percentage.
3338 Defaults to B<false>.
3339
3340 =back
3341
3342 =head2 Plugin C<intel_pmu>
3343
3344 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3345 Linux perf interface. All events are reported on a per core basis.
3346
3347 B<Synopsis:>
3348
3349   <Plugin intel_pmu>
3350     ReportHardwareCacheEvents true
3351     ReportKernelPMUEvents true
3352     ReportSoftwareEvents true
3353     EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3354     HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3355     Cores "0-3" "4,6" "[12-15]"
3356   </Plugin>
3357
3358 B<Options:>
3359
3360 =over 4
3361
3362 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3363
3364 Enable or disable measuring of hardware CPU cache events:
3365   - L1-dcache-loads
3366   - L1-dcache-load-misses
3367   - L1-dcache-stores
3368   - L1-dcache-store-misses
3369   - L1-dcache-prefetches
3370   - L1-dcache-prefetch-misses
3371   - L1-icache-loads
3372   - L1-icache-load-misses
3373   - L1-icache-prefetches
3374   - L1-icache-prefetch-misses
3375   - LLC-loads
3376   - LLC-load-misses
3377   - LLC-stores
3378   - LLC-store-misses
3379   - LLC-prefetches
3380   - LLC-prefetch-misses
3381   - dTLB-loads
3382   - dTLB-load-misses
3383   - dTLB-stores
3384   - dTLB-store-misses
3385   - dTLB-prefetches
3386   - dTLB-prefetch-misses
3387   - iTLB-loads
3388   - iTLB-load-misses
3389   - branch-loads
3390   - branch-load-misses
3391
3392 =item B<ReportKernelPMUEvents> B<false>|B<true>
3393
3394 Enable or disable measuring of the following events:
3395   - cpu-cycles
3396   - instructions
3397   - cache-references
3398   - cache-misses
3399   - branches
3400   - branch-misses
3401   - bus-cycles
3402
3403 =item B<ReportSoftwareEvents> B<false>|B<true>
3404
3405 Enable or disable measuring of software events provided by kernel:
3406   - cpu-clock
3407   - task-clock
3408   - context-switches
3409   - cpu-migrations
3410   - page-faults
3411   - minor-faults
3412   - major-faults
3413   - alignment-faults
3414   - emulation-faults
3415
3416 =item B<EventList> I<filename>
3417
3418 JSON performance counter event list file name. To be able to monitor all Intel
3419 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3420 event_download.py script to download event list for current CPU.
3421
3422 =item B<HardwareEvents> I<events>
3423
3424 This field is a list of event names or groups of comma separated event names.
3425 This option requires B<EventList> option to be configured.
3426
3427 =item B<Cores> I<cores groups>
3428
3429 All events are reported on a per core basis. Monitoring of the events can be
3430 configured for a group of cores (aggregated statistics). This field defines
3431 groups of cores on which to monitor supported events. The field is represented
3432 as list of strings with core group values. Each string represents a list of
3433 cores in a group. If a group is enclosed in square brackets each core is added
3434 individually to a separate group (that is statistics are not aggregated).
3435 Allowed formats are:
3436     0,1,2,3
3437     0-10,20-18
3438     1,3,5-8,10,0x10-12
3439     [4-15,32-63]
3440
3441 If an empty string is provided as value for this field default cores
3442 configuration is applied - that is separate group is created for each core.
3443
3444 =back
3445
3446 =head2 Plugin C<intel_rdt>
3447
3448 The I<intel_rdt> plugin collects information provided by monitoring features of
3449 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3450 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3451 information about utilization of shared resources. CMT monitors last level cache
3452 occupancy (LLC). MBM supports two types of events reporting local and remote
3453 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3454 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3455 reports the bandwidth of accessing the remote socket. Also this technology
3456 allows to monitor instructions per clock (IPC).
3457 Monitor events are hardware dependant. Monitoring capabilities are detected on
3458 plugin initialization and only supported events are monitored.
3459
3460 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3461 require an additional capability to be enabled if collectd is run as a service.
3462 Please refer to I<contrib/systemd.collectd.service> file for more details.
3463
3464 B<Synopsis:>
3465
3466   <Plugin "intel_rdt">
3467     Cores "0-2" "3,4,6" "8-10,15"
3468   </Plugin>
3469
3470 B<Options:>
3471
3472 =over 4
3473
3474 =item B<Interval> I<seconds>
3475
3476 The interval within which to retrieve statistics on monitored events in seconds.
3477 For milliseconds divide the time by 1000 for example if the desired interval
3478 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3479 recommended to set interval higher than 1 sec.
3480
3481 =item B<Cores> I<cores groups>
3482
3483 All events are reported on a per core basis. Monitoring of the events can be
3484 configured for group of cores (aggregated statistics). This field defines groups
3485 of cores on which to monitor supported events. The field is represented as list
3486 of strings with core group values. Each string represents a list of cores in a
3487 group. Allowed formats are:
3488     0,1,2,3
3489     0-10,20-18
3490     1,3,5-8,10,0x10-12
3491
3492 If an empty string is provided as value for this field default cores
3493 configuration is applied - a separate group is created for each core.
3494
3495 =back
3496
3497 B<Note:> By default global interval is used to retrieve statistics on monitored
3498 events. To configure a plugin specific interval use B<Interval> option of the
3499 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3500 example if the desired interval is 50ms, set interval to 0.05.
3501 Due to limited capacity of counters it is not recommended to set interval higher
3502 than 1 sec.
3503
3504 =head2 Plugin C<interface>
3505
3506 =over 4
3507
3508 =item B<Interface> I<Interface>
3509
3510 Select this interface. By default these interfaces will then be collected. For
3511 a more detailed description see B<IgnoreSelected> below.
3512
3513 See F</"IGNORELISTS"> for details.
3514
3515 =item B<IgnoreSelected> I<true>|I<false>
3516
3517 If no configuration is given, the B<interface>-plugin will collect data from
3518 all interfaces. This may not be practical, especially for loopback- and
3519 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3520 interfaces you're interested in. Sometimes, however, it's easier/preferred
3521 to collect all interfaces I<except> a few ones. This option enables you to
3522 do that: By setting B<IgnoreSelected> to I<true> the effect of
3523 B<Interface> is inverted: All selected interfaces are ignored and all
3524 other interfaces are collected.
3525
3526 It is possible to use regular expressions to match interface names, if the
3527 name is surrounded by I</.../> and collectd was compiled with support for
3528 regexps. This is useful if there's a need to collect (or ignore) data
3529 for a group of interfaces that are similarly named, without the need to
3530 explicitly list all of them (especially useful if the list is dynamic).
3531 Example:
3532
3533  Interface "lo"
3534  Interface "/^veth/"
3535  Interface "/^tun[0-9]+/"
3536  IgnoreSelected "true"
3537
3538 This will ignore the loopback interface, all interfaces with names starting
3539 with I<veth> and all interfaces with names starting with I<tun> followed by
3540 at least one digit.
3541
3542 =item B<ReportInactive> I<true>|I<false>
3543
3544 When set to I<false>, only interfaces with non-zero traffic will be
3545 reported. Note that the check is done by looking into whether a
3546 package was sent at any time from boot and the corresponding counter
3547 is non-zero. So, if the interface has been sending data in the past
3548 since boot, but not during the reported time-interval, it will still
3549 be reported.
3550
3551 The default value is I<true> and results in collection of the data
3552 from all interfaces that are selected by B<Interface> and
3553 B<IgnoreSelected> options.
3554
3555 =item B<UniqueName> I<true>|I<false>
3556
3557 Interface name is not unique on Solaris (KSTAT), interface name is unique
3558 only within a module/instance. Following tuple is considered unique:
3559    (ks_module, ks_instance, ks_name)
3560 If this option is set to true, interface name contains above three fields
3561 separated by an underscore. For more info on KSTAT, visit
3562 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3563
3564 This option is only available on Solaris.
3565
3566 =back
3567
3568 =head2 Plugin C<ipmi>
3569
3570 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3571 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3572
3573 The plugin configuration consists of one or more B<Instance> blocks which
3574 specify one I<ipmi> connection each. Each block requires one unique string
3575 argument as the instance name. If instances are not configured, an instance with
3576 the default option values will be created.
3577
3578 For backwards compatibility, any option other than B<Instance> block will trigger
3579 legacy config handling and it will be treated as an option within B<Instance>
3580 block. This support will go away in the next major version of Collectd.
3581
3582 Within the B<Instance> blocks, the following options are allowed:
3583
3584 =over 4
3585
3586 =item B<Address> I<Address>
3587
3588 Hostname or IP to connect to. If not specified, plugin will try to connect to
3589 local management controller (BMC).
3590
3591 =item B<Username> I<Username>
3592
3593 =item B<Password> I<Password>
3594
3595 The username and the password to use for the connection to remote BMC.
3596
3597 =item B<AuthType> I<MD5>|I<rmcp+>
3598
3599 Forces the authentication type to use for the connection to remote BMC.
3600 By default most secure type is seleted.
3601
3602 =item B<Host> I<Hostname>
3603
3604 Sets the B<host> field of dispatched values. Defaults to the global hostname
3605 setting.
3606
3607 =item B<Sensor> I<Sensor>
3608
3609 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3610
3611 See F</"IGNORELISTS"> for details.
3612
3613 =item B<IgnoreSelected> I<true>|I<false>
3614
3615 If no configuration if given, the B<ipmi> plugin will collect data from all
3616 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3617 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3618 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3619 all other sensors are collected.
3620
3621 =item B<NotifySensorAdd> I<true>|I<false>
3622
3623 If a sensor appears after initialization time of a minute a notification
3624 is sent.
3625
3626 =item B<NotifySensorRemove> I<true>|I<false>
3627
3628 If a sensor disappears a notification is sent.
3629
3630 =item B<NotifySensorNotPresent> I<true>|I<false>
3631
3632 If you have for example dual power supply and one of them is (un)plugged then
3633 a notification is sent.
3634
3635 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3636
3637 If a IPMI connection state changes after initialization time of a minute
3638 a notification is sent. Defaults to B<false>.
3639
3640 =item B<SELEnabled> I<true>|I<false>
3641
3642 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3643 and discrete events. When event is received the notification is sent.
3644 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3645 config options.
3646 Defaults to B<false>.
3647
3648 =item B<SELSensor> I<SELSensor>
3649
3650 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3651
3652 See F</"IGNORELISTS"> for details.
3653
3654 =item B<SELIgnoreSelected> I<true>|I<false>
3655
3656 If no configuration is given, the B<ipmi> plugin will pass events from all
3657 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3658 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3659 sensors are ignored and all events from other sensors are passed.
3660
3661 =item B<SELClearEvent> I<true>|I<false>
3662
3663 If SEL clear event is enabled, plugin will delete event from SEL list after
3664 it is received and successfully handled. In this case other tools that are
3665 subscribed for SEL events will receive an empty event.
3666 Defaults to B<false>.
3667
3668 =back
3669
3670 =head2 Plugin C<iptables>
3671
3672 =over 4
3673
3674 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3675
3676 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3677
3678 Select the iptables/ip6tables filter rules to count packets and bytes from.
3679
3680 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3681 of all rules which have a comment-match. The comment is then used as
3682 type-instance.
3683
3684 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3685 the I<n>th rule will be collected. Again, the comment (or the number) will be
3686 used as the type-instance.
3687
3688 If I<Name> is supplied, it will be used as the type-instance instead of the
3689 comment or the number.
3690
3691 =back
3692
3693 =head2 Plugin C<irq>
3694
3695 =over 4
3696
3697 =item B<Irq> I<Irq>
3698
3699 Select this irq. By default these irqs will then be collected. For a more
3700 detailed description see B<IgnoreSelected> below.
3701
3702 See F</"IGNORELISTS"> for details.
3703
3704 =item B<IgnoreSelected> I<true>|I<false>
3705
3706 If no configuration if given, the B<irq>-plugin will collect data from all
3707 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3708 can use the B<Irq>-option to pick the interrupt you're interested in.
3709 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3710 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3711 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3712 and all other interrupts are collected.
3713
3714 =back
3715
3716 =head2 Plugin C<java>
3717
3718 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3719 This section only discusses the syntax and semantic of the configuration
3720 options. For more in-depth information on the I<Java> plugin, please read
3721 L<collectd-java(5)>.
3722
3723 Synopsis:
3724
3725  <Plugin "java">
3726    JVMArg "-verbose:jni"
3727    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3728    LoadPlugin "org.collectd.java.Foobar"
3729    <Plugin "org.collectd.java.Foobar">
3730      # To be parsed by the plugin
3731    </Plugin>
3732  </Plugin>
3733
3734 Available configuration options:
3735
3736 =over 4
3737
3738 =item B<JVMArg> I<Argument>
3739
3740 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3741 exactly the way the arguments to the I<java> binary on the command line work.
3742 Execute C<javaE<nbsp>--help> for details.
3743
3744 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3745 any other options! When another option is found, the JVM will be started and
3746 later options will have to be ignored!
3747
3748 =item B<LoadPlugin> I<JavaClass>
3749
3750 Instantiates a new I<JavaClass> object. The constructor of this object very
3751 likely then registers one or more callback methods with the server.
3752
3753 See L<collectd-java(5)> for details.
3754
3755 When the first such option is found, the virtual machine (JVM) is created. This
3756 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3757 B<LoadPlugin> options!
3758
3759 =item B<Plugin> I<Name>
3760
3761 The entire block is passed to the Java plugin as an
3762 I<org.collectd.api.OConfigItem> object.
3763
3764 For this to work, the plugin has to register a configuration callback first,
3765 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3766 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3767 depends on the (Java) plugin registering the callback and is completely
3768 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3769
3770 =back
3771
3772 =head2 Plugin C<load>
3773
3774 The I<Load plugin> collects the system load. These numbers give a rough overview
3775 over the utilization of a machine. The system load is defined as the number of
3776 runnable tasks in the run-queue and is provided by many operating systems as a
3777 one, five or fifteen minute average.
3778
3779 The following configuration options are available:
3780
3781 =over 4
3782
3783 =item B<ReportRelative> B<false>|B<true>
3784
3785 When enabled, system load divided by number of available CPU cores is reported
3786 for intervals 1 min, 5 min and 15 min. Defaults to false.
3787
3788 =back
3789
3790
3791 =head2 Plugin C<logfile>
3792
3793 =over 4
3794
3795 =item B<LogLevel> B<debug|info|notice|warning|err>
3796
3797 Sets the log-level. If, for example, set to B<notice>, then all events with
3798 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3799
3800 Please note that B<debug> is only available if collectd has been compiled with
3801 debugging support.
3802
3803 =item B<File> I<File>
3804
3805 Sets the file to write log messages to. The special strings B<stdout> and
3806 B<stderr> can be used to write to the standard output and standard error
3807 channels, respectively. This, of course, only makes much sense when I<collectd>
3808 is running in foreground- or non-daemon-mode.
3809
3810 =item B<Timestamp> B<true>|B<false>
3811
3812 Prefix all lines printed by the current time. Defaults to B<true>.
3813
3814 =item B<PrintSeverity> B<true>|B<false>
3815
3816 When enabled, all lines are prefixed by the severity of the log message, for
3817 example "warning". Defaults to B<false>.
3818
3819 =back
3820
3821 B<Note>: There is no need to notify the daemon after moving or removing the
3822 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3823 for each line it writes.
3824
3825 =head2 Plugin C<log_logstash>
3826
3827 The I<log logstash plugin> behaves like the logfile plugin but formats
3828 messages as JSON events for logstash to parse and input.
3829
3830 =over 4
3831
3832 =item B<LogLevel> B<debug|info|notice|warning|err>
3833
3834 Sets the log-level. If, for example, set to B<notice>, then all events with
3835 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3836
3837 Please note that B<debug> is only available if collectd has been compiled with
3838 debugging support.
3839
3840 =item B<File> I<File>
3841
3842 Sets the file to write log messages to. The special strings B<stdout> and
3843 B<stderr> can be used to write to the standard output and standard error
3844 channels, respectively. This, of course, only makes much sense when I<collectd>
3845 is running in foreground- or non-daemon-mode.
3846
3847 =back
3848
3849 B<Note>: There is no need to notify the daemon after moving or removing the
3850 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3851 for each line it writes.
3852
3853 =head2 Plugin C<lpar>
3854
3855 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3856 virtualization technique for IBM POWER processors. It takes into account CPU
3857 time stolen from or donated to a partition, in addition to the usual user,
3858 system, I/O statistics.
3859
3860 The following configuration options are available:
3861
3862 =over 4
3863
3864 =item B<CpuPoolStats> B<false>|B<true>
3865
3866 When enabled, statistics about the processor pool are read, too. The partition
3867 needs to have pool authority in order to be able to acquire this information.
3868 Defaults to false.
3869
3870 =item B<ReportBySerial> B<false>|B<true>
3871
3872 If enabled, the serial of the physical machine the partition is currently
3873 running on is reported as I<hostname> and the logical hostname of the machine
3874 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3875 used (just like other plugins) and the I<plugin instance> will be empty.
3876 Defaults to false.
3877
3878 =back
3879
3880 =head2 Plugin C<lua>
3881
3882 This plugin embeds a Lua interpreter into collectd and provides an interface
3883 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3884
3885
3886 =head2 Plugin C<mbmon>
3887
3888 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3889
3890 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3891 B<Host> and B<Port> options can be used to change these values, see below.
3892 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3893 timeouts may appear which may interfere with other statistics..
3894
3895 C<mbmon> must be run with the -r option ("print TAG and Value format");
3896 Debian's F</etc/init.d/mbmon> script already does this, other people
3897 will need to ensure that this is the case.
3898
3899 =over 4
3900
3901 =item B<Host> I<Hostname>
3902
3903 Hostname to connect to. Defaults to B<127.0.0.1>.
3904
3905 =item B<Port> I<Port>
3906
3907 TCP-Port to connect to. Defaults to B<411>.
3908
3909 =back
3910
3911 =head2 Plugin C<mcelog>
3912
3913 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3914
3915 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3916 mcelog server is running. When the server is running, the plugin will tail the
3917 specified logfile to retrieve machine check exception information and send a
3918 notification with the details from the logfile. The plugin will use the mcelog
3919 client protocol to retrieve memory related machine check exceptions. Note that
3920 for memory exceptions, notifications are only sent when there is a change in
3921 the number of corrected/uncorrected memory errors.
3922
3923 =head3 The Memory block
3924
3925 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3926 exclusive.
3927
3928 =over 3
3929
3930 =item B<McelogClientSocket> I<Path>
3931 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3932 Defaults to B<"/var/run/mcelog-client">.
3933
3934 =item B<PersistentNotification> B<true>|B<false>
3935 Override default configuration to only send notifications when sent when there
3936 is a change in the number of corrected/uncorrected memory errors. When set to
3937 true notifications will be sent for every read cycle. Default is false. Does
3938 not affect the stats being dispatched.
3939
3940 =back
3941
3942 =over 4
3943
3944 =item B<McelogLogfile> I<Path>
3945
3946 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3947 cannot be used in conjunction with the memory block options, they are mutually
3948 exclusive.
3949
3950 =back
3951
3952 =head2 Plugin C<md>
3953
3954 The C<md plugin> collects information from Linux Software-RAID devices (md).
3955
3956 All reported values are of the type C<md_disks>. Reported type instances are
3957 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3958 I<missing> (physically absent) disks.
3959
3960 =over 4
3961
3962 =item B<Device> I<Device>
3963
3964 Select md devices based on device name. The I<device name> is the basename of
3965 the device, i.e. the name of the block device without the leading C</dev/>.
3966 See B<IgnoreSelected> for more details.
3967
3968 See F</"IGNORELISTS"> for details.
3969
3970 =item B<IgnoreSelected> B<true>|B<false>
3971
3972 Invert device selection: If set to B<true>, all md devices B<except> those
3973 listed using B<Device> are collected. If B<false> (the default), only those
3974 listed are collected. If no configuration is given, the B<md> plugin will
3975 collect data from all md devices.
3976
3977 =back
3978
3979 =head2 Plugin C<memcachec>
3980
3981 The C<memcachec plugin> connects to a memcached server, queries one or more
3982 given I<pages> and parses the returned data according to user specification.
3983 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3984 plugins.
3985
3986 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3987 library. Please note that there is another library with a very similar name,
3988 libmemcache (notice the missing `d'), which is not applicable.
3989
3990 Synopsis of the configuration:
3991
3992  <Plugin "memcachec">
3993    <Page "plugin_instance">
3994      Server "localhost"
3995      Key "page_key"
3996      Plugin "plugin_name"
3997      <Match>
3998        Regex "(\\d+) bytes sent"
3999        DSType CounterAdd
4000        Type "ipt_octets"
4001        Instance "type_instance"
4002      </Match>
4003    </Page>
4004  </Plugin>
4005
4006 The configuration options are:
4007
4008 =over 4
4009
4010 =item E<lt>B<Page> I<Name>E<gt>
4011
4012 Each B<Page> block defines one I<page> to be queried from the memcached server.
4013 The block requires one string argument which is used as I<plugin instance>.
4014
4015 =item B<Server> I<Address>
4016
4017 Sets the server address to connect to when querying the page. Must be inside a
4018 B<Page> block.
4019
4020 =item B<Key> I<Key>
4021
4022 When connected to the memcached server, asks for the page I<Key>.
4023
4024 =item B<Plugin> I<Plugin>
4025
4026 Use I<Plugin> as the plugin name when submitting values.
4027 Defaults to C<memcachec>.
4028
4029 =item E<lt>B<Match>E<gt>
4030
4031 Match blocks define which strings to look for and how matches substrings are
4032 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4033
4034 =back
4035
4036 =head2 Plugin C<memcached>
4037
4038 The B<memcached plugin> connects to a memcached server and queries statistics
4039 about cache utilization, memory and bandwidth used.
4040 L<http://memcached.org/>
4041
4042  <Plugin "memcached">
4043    <Instance "name">
4044      #Host "memcache.example.com"
4045      Address "127.0.0.1"
4046      Port 11211
4047    </Instance>
4048  </Plugin>
4049
4050 The plugin configuration consists of one or more B<Instance> blocks which
4051 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4052 following options are allowed:
4053
4054 =over 4
4055
4056 =item B<Host> I<Hostname>
4057
4058 Sets the B<host> field of dispatched values. Defaults to the global hostname
4059 setting.
4060 For backwards compatibility, values are also dispatched with the global
4061 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4062 not set.
4063
4064 =item B<Address> I<Address>
4065
4066 Hostname or IP to connect to. For backwards compatibility, defaults to the
4067 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4068
4069 =item B<Port> I<Port>
4070
4071 TCP port to connect to. Defaults to B<11211>.
4072
4073 =item B<Socket> I<Path>
4074
4075 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4076 setting is given, the B<Address> and B<Port> settings are ignored.
4077
4078 =back
4079
4080 =head2 Plugin C<mic>
4081
4082 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4083 Intel's Many Integrated Core (MIC) systems.
4084
4085 B<Synopsis:>
4086
4087  <Plugin mic>
4088    ShowCPU true
4089    ShowCPUCores true
4090    ShowMemory true
4091
4092    ShowTemperatures true
4093    Temperature vddg
4094    Temperature vddq
4095    IgnoreSelectedTemperature true
4096
4097    ShowPower true
4098    Power total0
4099    Power total1
4100    IgnoreSelectedPower true
4101  </Plugin>
4102
4103 The following options are valid inside the B<PluginE<nbsp>mic> block:
4104
4105 =over 4
4106
4107 =item B<ShowCPU> B<true>|B<false>
4108
4109 If enabled (the default) a sum of the CPU usage across all cores is reported.
4110
4111 =item B<ShowCPUCores> B<true>|B<false>
4112
4113 If enabled (the default) per-core CPU usage is reported.
4114
4115 =item B<ShowMemory> B<true>|B<false>
4116
4117 If enabled (the default) the physical memory usage of the MIC system is
4118 reported.
4119
4120 =item B<ShowTemperatures> B<true>|B<false>
4121
4122 If enabled (the default) various temperatures of the MIC system are reported.
4123
4124 =item B<Temperature> I<Name>
4125
4126 This option controls which temperatures are being reported. Whether matching
4127 temperatures are being ignored or I<only> matching temperatures are reported
4128 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4129 temperatures are reported.
4130
4131 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4132
4133 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4134 (the default) only temperatures matching a B<Temperature> option are reported
4135 or, if no B<Temperature> option is specified, all temperatures are reported. If
4136 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4137 are reported.
4138
4139 Known temperature names are:
4140
4141 =over 4
4142
4143 =item die
4144
4145 Die of the CPU
4146
4147 =item devmem
4148
4149 Device Memory
4150
4151 =item fin
4152
4153 Fan In
4154
4155 =item fout
4156
4157 Fan Out
4158
4159 =item vccp
4160
4161 Voltage ccp
4162
4163 =item vddg
4164
4165 Voltage ddg
4166
4167 =item vddq
4168
4169 Voltage ddq
4170
4171 =back
4172
4173 =item B<ShowPower> B<true>|B<false>
4174
4175 If enabled (the default) various temperatures of the MIC system are reported.
4176
4177 =item B<Power> I<Name>
4178
4179 This option controls which power readings are being reported. Whether matching
4180 power readings are being ignored or I<only> matching power readings are reported
4181 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4182 power readings are reported.
4183
4184 =item B<IgnoreSelectedPower> B<false>|B<true>
4185
4186 Controls the behavior of the B<Power> setting above. If set to B<false>
4187 (the default) only power readings matching a B<Power> option are reported
4188 or, if no B<Power> option is specified, all power readings are reported. If
4189 set to B<true>, matching power readings are I<ignored> and all other power readings
4190 are reported.
4191
4192 Known power names are:
4193
4194 =over 4
4195
4196 =item total0
4197
4198 Total power utilization averaged over Time Window 0 (uWatts).
4199
4200 =item total1
4201
4202 Total power utilization averaged over Time Window 0 (uWatts).
4203
4204 =item inst
4205
4206 Instantaneous power (uWatts).
4207
4208 =item imax
4209
4210 Max instantaneous power (uWatts).
4211
4212 =item pcie
4213
4214 PCI-E connector power (uWatts).
4215
4216 =item c2x3
4217
4218 2x3 connector power (uWatts).
4219
4220 =item c2x4
4221
4222 2x4 connector power (uWatts).
4223
4224 =item vccp
4225
4226 Core rail (uVolts).
4227
4228 =item vddg
4229
4230 Uncore rail (uVolts).
4231
4232 =item vddq
4233
4234 Memory subsystem rail (uVolts).
4235
4236 =back
4237
4238 =back
4239
4240 =head2 Plugin C<memory>
4241
4242 The I<memory plugin> provides the following configuration options:
4243
4244 =over 4
4245
4246 =item B<ValuesAbsolute> B<true>|B<false>
4247
4248 Enables or disables reporting of physical memory usage in absolute numbers,
4249 i.e. bytes. Defaults to B<true>.
4250
4251 =item B<ValuesPercentage> B<false>|B<true>
4252
4253 Enables or disables reporting of physical memory usage in percentages, e.g.
4254 percent of physical memory used. Defaults to B<false>.
4255
4256 This is useful for deploying I<collectd> in a heterogeneous environment in
4257 which the sizes of physical memory vary.
4258
4259 =back
4260
4261 =head2 Plugin C<modbus>
4262
4263 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4264 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4265 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4266 floating point values (two registers interpreted as IEEE floats in big endian
4267 notation).
4268
4269 B<Synopsis:>
4270
4271  <Data "voltage-input-1">
4272    RegisterBase 0
4273    RegisterType float
4274    RegisterCmd ReadHolding
4275    Type voltage
4276    Instance "input-1"
4277    #Scale 1.0
4278    #Shift 0.0
4279  </Data>
4280
4281  <Data "voltage-input-2">
4282    RegisterBase 2
4283    RegisterType float
4284    RegisterCmd ReadHolding
4285    Type voltage
4286    Instance "input-2"
4287  </Data>
4288
4289  <Data "supply-temperature-1">
4290    RegisterBase 0
4291    RegisterType Int16
4292    RegisterCmd ReadHolding
4293    Type temperature
4294    Instance "temp-1"
4295  </Data>
4296
4297  <Host "modbus.example.com">
4298    Address "192.168.0.42"
4299    Port    "502"
4300    Interval 60
4301
4302    <Slave 1>
4303      Instance "power-supply"
4304      Collect  "voltage-input-1"
4305      Collect  "voltage-input-2"
4306    </Slave>
4307  </Host>
4308
4309  <Host "localhost">
4310    Device "/dev/ttyUSB0"
4311    Baudrate 38400
4312    Interval 20
4313
4314    <Slave 1>
4315      Instance "temperature"
4316      Collect  "supply-temperature-1"
4317    </Slave>
4318  </Host>
4319
4320 =over 4
4321
4322 =item E<lt>B<Data> I<Name>E<gt> blocks
4323
4324 Data blocks define a mapping between register numbers and the "types" used by
4325 I<collectd>.
4326
4327 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4328
4329 =over 4
4330
4331 =item B<RegisterBase> I<Number>
4332
4333 Configures the base register to read from the device. If the option
4334 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4335 register will be read (the register number is increased by one).
4336
4337 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4338
4339 Specifies what kind of data is returned by the device. This defaults to
4340 B<Uint16>.  If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4341 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4342 and B<RegisterBase+1> will be read and the data is combined into one
4343 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4344 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4345 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4346 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4347 registers are swapped with the most significant 16E<nbsp>bits in
4348 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4349 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4350 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4351 B<RegisterBase+3> will be read and the data combined into one
4352 64E<nbsp>value.
4353
4354 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4355
4356 Specifies register type to be collected from device. Works only with libmodbus
4357 2.9.2 or higher. Defaults to B<ReadHolding>.
4358
4359 =item B<Type> I<Type>
4360
4361 Specifies the "type" (data set) to use when dispatching the value to
4362 I<collectd>. Currently, only data sets with exactly one data source are
4363 supported.
4364
4365 =item B<Instance> I<Instance>
4366
4367 Sets the type instance to use when dispatching the value to I<Instance>. If
4368 unset, an empty string (no type instance) is used.
4369
4370 =item B<Scale> I<Value>
4371
4372 The values taken from device are multiplied by I<Value>. The field is optional
4373 and the default is B<1.0>.
4374
4375 =item B<Shift> I<Value>
4376
4377 I<Value> is added to values from device after they have been multiplied by
4378 B<Scale> value. The field is optional and the default value is B<0.0>.
4379
4380 =back
4381
4382 =item E<lt>B<Host> I<Name>E<gt> blocks
4383
4384 Host blocks are used to specify to which hosts to connect and what data to read
4385 from their "slaves". The string argument I<Name> is used as hostname when
4386 dispatching the values to I<collectd>.
4387
4388 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4389
4390 =over 4
4391
4392 =item B<Address> I<Hostname>
4393
4394 For Modbus/TCP, specifies the node name (the actual network address) used to
4395 connect to the host. This may be an IP address or a hostname. Please note that
4396 the used I<libmodbus> library only supports IPv4 at the moment.
4397
4398 =item B<Port> I<Service>
4399
4400 for Modbus/TCP, specifies the port used to connect to the host. The port can
4401 either be given as a number or as a service name. Please note that the
4402 I<Service> argument must be a string, even if ports are given in their numerical
4403 form. Defaults to "502".
4404
4405 =item B<Device> I<Devicenode>
4406
4407 For Modbus/RTU, specifies the path to the serial device being used.
4408
4409 =item B<Baudrate> I<Baudrate>
4410
4411 For Modbus/RTU, specifies the baud rate of the serial device.
4412 Note, connections currently support only 8/N/1.
4413
4414 =item B<Interval> I<Interval>
4415
4416 Sets the interval (in seconds) in which the values will be collected from this
4417 host. By default the global B<Interval> setting will be used.
4418
4419 =item E<lt>B<Slave> I<ID>E<gt>
4420
4421 Over each connection, multiple Modbus devices may be reached. The slave ID
4422 is used to specify which device should be addressed. For each device you want
4423 to query, one B<Slave> block must be given.
4424
4425 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4426
4427 =over 4
4428
4429 =item B<Instance> I<Instance>
4430
4431 Specify the plugin instance to use when dispatching the values to I<collectd>.
4432 By default "slave_I<ID>" is used.
4433
4434 =item B<Collect> I<DataName>
4435
4436 Specifies which data to retrieve from the device. I<DataName> must be the same
4437 string as the I<Name> argument passed to a B<Data> block. You can specify this
4438 option multiple times to collect more than one value from a slave. At least one
4439 B<Collect> option is mandatory.
4440
4441 =back
4442
4443 =back
4444
4445 =back
4446
4447 =head2 Plugin C<mqtt>
4448
4449 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4450 values from MQTT (B<Subscribe> blocks).
4451
4452 B<Synopsis:>
4453
4454  <Plugin mqtt>
4455    <Publish "name">
4456      Host "mqtt.example.com"
4457      Prefix "collectd"
4458    </Publish>
4459    <Subscribe "name">
4460      Host "mqtt.example.com"
4461      Topic "collectd/#"
4462    </Subscribe>
4463  </Plugin>
4464
4465 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4466 configuring the sending and receiving direction respectively. The plugin will
4467 register a write callback named C<mqtt/I<name>> where I<name> is the string
4468 argument given to the B<Publish> block. Both types of blocks share many but not
4469 all of the following options. If an option is valid in only one of the blocks,
4470 it will be mentioned explicitly.
4471
4472 B<Options:>
4473
4474 =over 4
4475
4476 =item B<Host> I<Hostname>
4477
4478 Hostname of the MQTT broker to connect to.
4479
4480 =item B<Port> I<Service>
4481
4482 Port number or service name of the MQTT broker to connect to.
4483
4484 =item B<User> I<UserName>
4485
4486 Username used when authenticating to the MQTT broker.
4487
4488 =item B<Password> I<Password>
4489
4490 Password used when authenticating to the MQTT broker.
4491
4492 =item B<ClientId> I<ClientId>
4493
4494 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4495
4496 =item B<QoS> [B<0>-B<2>]
4497
4498 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4499
4500 =over 4
4501
4502 =item B<0>
4503
4504 At most once
4505
4506 =item B<1>
4507
4508 At least once
4509
4510 =item B<2>
4511
4512 Exactly once
4513
4514 =back
4515
4516 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4517 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4518 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4519 on a message is larger than the maximum accepted QoS of a subscriber, the
4520 message's QoS will be downgraded.
4521
4522 =item B<Prefix> I<Prefix> (Publish only)
4523
4524 This plugin will use one topic per I<value list> which will looks like a path.
4525 I<Prefix> is used as the first path element and defaults to B<collectd>.
4526
4527 An example topic name would be:
4528
4529  collectd/cpu-0/cpu-user
4530
4531 =item B<Retain> B<false>|B<true> (Publish only)
4532
4533 Controls whether the MQTT broker will retain (keep a copy of) the last message
4534 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4535
4536 =item B<StoreRates> B<true>|B<false> (Publish only)
4537
4538 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4539 before sending. Defaults to B<true>.
4540
4541 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4542
4543 Controls whether the MQTT "cleans" the session up after the subscriber
4544 disconnects or if it maintains the subscriber's subscriptions and all messages
4545 that arrive while the subscriber is disconnected. Defaults to B<true>.
4546
4547 =item B<Topic> I<TopicName> (Subscribe only)
4548
4549 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4550 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4551 the B<collectd> branch.
4552
4553 =item B<CACert> I<file>
4554
4555 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4556 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4557 port of the MQTT broker.
4558 This option enables the use of TLS.
4559
4560 =item B<CertificateFile> I<file>
4561
4562 Path to the PEM-encoded certificate file to use as client certificate when
4563 connecting to the MQTT broker.
4564 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4565
4566 =item B<CertificateKeyFile> I<file>
4567
4568 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4569 Only valid if B<CACert> and B<CertificateFile> are also set.
4570
4571 =item B<TLSProtocol> I<protocol>
4572
4573 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4574 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4575 version is used which depends on the version of OpenSSL the Mosquitto library
4576 was linked against.
4577 Only valid if B<CACert> is set.
4578
4579 =item B<CipherSuite> I<ciphersuite>
4580
4581 A string describing the ciphers available for use. See L<ciphers(1)> and the
4582 C<openssl ciphers> utility for more information. If unset, the default ciphers
4583 will be used.
4584 Only valid if B<CACert> is set.
4585
4586 =back
4587
4588 =head2 Plugin C<mysql>
4589
4590 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4591 one or more databases when started and keeps the connection up as long as
4592 possible. When the connection is interrupted for whatever reason it will try
4593 to re-connect. The plugin will complain loudly in case anything goes wrong.
4594
4595 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4596 and collects information about MySQL network traffic, executed statements,
4597 requests, the query cache and threads by evaluating the
4598 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4599 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4600 Status Variables> for an explanation of these values.
4601
4602 Optionally, master and slave statistics may be collected in a MySQL
4603 replication setup. In that case, information about the synchronization state
4604 of the nodes are collected by evaluating the C<Position> return value of the
4605 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4606 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4607 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4608 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4609 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4610
4611 Synopsis:
4612
4613   <Plugin mysql>
4614     <Database foo>
4615       Host "hostname"
4616       User "username"
4617       Password "password"
4618       Port "3306"
4619       MasterStats true
4620       ConnectTimeout 10
4621       SSLKey "/path/to/key.pem"
4622       SSLCert "/path/to/cert.pem"
4623       SSLCA "/path/to/ca.pem"
4624       SSLCAPath "/path/to/cas/"
4625       SSLCipher "DHE-RSA-AES256-SHA"
4626     </Database>
4627
4628     <Database bar>
4629       Alias "squeeze"
4630       Host "localhost"
4631       Socket "/var/run/mysql/mysqld.sock"
4632       SlaveStats true
4633       SlaveNotifications true
4634     </Database>
4635
4636    <Database galera>
4637       Alias "galera"
4638       Host "localhost"
4639       Socket "/var/run/mysql/mysqld.sock"
4640       WsrepStats true
4641    </Database>
4642   </Plugin>
4643
4644 A B<Database> block defines one connection to a MySQL database. It accepts a
4645 single argument which specifies the name of the database. None of the other
4646 options are required. MySQL will use default values as documented in the
4647 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4648 B<MySQL reference manual>.
4649
4650 =over 4
4651
4652 =item B<Alias> I<Alias>
4653
4654 Alias to use as sender instead of hostname when reporting. This may be useful
4655 when having cryptic hostnames.
4656
4657 =item B<Host> I<Hostname>
4658
4659 Hostname of the database server. Defaults to B<localhost>.
4660
4661 =item B<User> I<Username>
4662
4663 Username to use when connecting to the database. The user does not have to be
4664 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4665 unless you want to collectd replication statistics (see B<MasterStats> and
4666 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4667 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4668
4669 =item B<Password> I<Password>
4670
4671 Password needed to log into the database.
4672
4673 =item B<Database> I<Database>
4674
4675 Select this database. Defaults to I<no database> which is a perfectly reasonable
4676 option for what this plugin does.
4677
4678 =item B<Port> I<Port>
4679
4680 TCP-port to connect to. The port must be specified in its numeric form, but it
4681 must be passed as a string nonetheless. For example:
4682
4683   Port "3306"
4684
4685 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4686 See the documentation for the C<mysql_real_connect> function for details.
4687
4688 =item B<Socket> I<Socket>
4689
4690 Specifies the path to the UNIX domain socket of the MySQL server. This option
4691 only has any effect, if B<Host> is set to B<localhost> (the default).
4692 Otherwise, use the B<Port> option above. See the documentation for the
4693 C<mysql_real_connect> function for details.
4694
4695 =item B<InnodbStats> I<true|false>
4696
4697 If enabled, metrics about the InnoDB storage engine are collected.
4698 Disabled by default.
4699
4700 =item B<MasterStats> I<true|false>
4701
4702 =item B<SlaveStats> I<true|false>
4703
4704 Enable the collection of master / slave statistics in a replication setup. In
4705 order to be able to get access to these statistics, the user needs special
4706 privileges. See the B<User> documentation above. Defaults to B<false>.
4707
4708 =item B<SlaveNotifications> I<true|false>
4709
4710 If enabled, the plugin sends a notification if the replication slave I/O and /
4711 or SQL threads are not running. Defaults to B<false>.
4712
4713 =item B<WsrepStats> I<true|false>
4714
4715  Enable the collection of wsrep plugin statistics, used in Master-Master
4716  replication setups like in MySQL Galera/Percona XtraDB Cluster.
4717  User needs only privileges to execute 'SHOW GLOBAL STATUS'
4718
4719 =item B<ConnectTimeout> I<Seconds>
4720
4721 Sets the connect timeout for the MySQL client.
4722
4723 =item B<SSLKey> I<Path>
4724
4725 If provided, the X509 key in PEM format.
4726
4727 =item B<SSLCert> I<Path>
4728
4729 If provided, the X509 cert in PEM format.
4730
4731 =item B<SSLCA> I<Path>
4732
4733 If provided, the CA file in PEM format (check OpenSSL docs).
4734
4735 =item B<SSLCAPath> I<Path>
4736
4737 If provided, the CA directory (check OpenSSL docs).
4738
4739 =item B<SSLCipher> I<String>
4740
4741 If provided, the SSL cipher to use.
4742
4743 =back
4744
4745 =head2 Plugin C<netapp>
4746
4747 The netapp plugin can collect various performance and capacity information
4748 from a NetApp filer using the NetApp API.
4749
4750 Please note that NetApp has a wide line of products and a lot of different
4751 software versions for each of these products. This plugin was developed for a
4752 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4753 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4754 model and software version but it is very hard to test this.
4755 If you have used this plugin with other models and/or software version, feel
4756 free to send us a mail to tell us about the results, even if it's just a short
4757 "It works".
4758
4759 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4760 basic authentication.
4761
4762 B<Do not use a regular user for this!> Create a special collectd user with just
4763 the minimum of capabilities needed. The user only needs the "login-http-admin"
4764 capability as well as a few more depending on which data will be collected.
4765 Required capabilities are documented below.
4766
4767 =head3 Synopsis
4768
4769  <Plugin "netapp">
4770    <Host "netapp1.example.com">
4771     Protocol      "https"
4772     Address       "10.0.0.1"
4773     Port          443
4774     User          "username"
4775     Password      "aef4Aebe"
4776     Interval      30
4777
4778     <WAFL>
4779       Interval 30
4780       GetNameCache   true
4781       GetDirCache    true
4782       GetBufferCache true
4783       GetInodeCache  true
4784     </WAFL>
4785
4786     <Disks>
4787       Interval 30
4788       GetBusy true
4789     </Disks>
4790
4791     <VolumePerf>
4792       Interval 30
4793       GetIO      "volume0"
4794       IgnoreSelectedIO      false
4795       GetOps     "volume0"
4796       IgnoreSelectedOps     false
4797       GetLatency "volume0"
4798       IgnoreSelectedLatency false
4799     </VolumePerf>
4800
4801     <VolumeUsage>
4802       Interval 30
4803       GetCapacity "vol0"
4804       GetCapacity "vol1"
4805       IgnoreSelectedCapacity false
4806       GetSnapshot "vol1"
4807       GetSnapshot "vol3"
4808       IgnoreSelectedSnapshot false
4809     </VolumeUsage>
4810
4811     <Quota>
4812       Interval 60
4813     </Quota>
4814
4815     <Snapvault>
4816       Interval 30
4817     </Snapvault>
4818
4819     <System>
4820       Interval 30
4821       GetCPULoad     true
4822       GetInterfaces  true
4823       GetDiskOps     true
4824       GetDiskIO      true
4825     </System>
4826
4827     <VFiler vfilerA>
4828       Interval 60
4829
4830       SnapVault true
4831       # ...
4832     </VFiler>
4833    </Host>
4834  </Plugin>
4835
4836 The netapp plugin accepts the following configuration options:
4837
4838 =over 4
4839
4840 =item B<Host> I<Name>
4841
4842 A host block defines one NetApp filer. It will appear in collectd with the name
4843 you specify here which does not have to be its real name nor its hostname (see
4844 the B<Address> option below).
4845
4846 =item B<VFiler> I<Name>
4847
4848 A B<VFiler> block may only be used inside a host block. It accepts all the
4849 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4850 will execute all NetApp API commands in the context of the specified
4851 VFiler(R). It will appear in collectd with the name you specify here which
4852 does not have to be its real name. The VFiler name may be specified using the
4853 B<VFilerName> option. If this is not specified, it will default to the name
4854 you specify here.
4855
4856 The VFiler block inherits all connection related settings from the surrounding
4857 B<Host> block (which appear before the B<VFiler> block) but they may be
4858 overwritten inside the B<VFiler> block.
4859
4860 This feature is useful, for example, when using a VFiler as SnapVault target
4861 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4862 available in the host filer (vfiler0) but only in the respective VFiler
4863 context.
4864
4865 =item B<Protocol> B<httpd>|B<http>
4866
4867 The protocol collectd will use to query this host.
4868
4869 Optional
4870
4871 Type: string
4872
4873 Default: https
4874
4875 Valid options: http, https
4876
4877 =item B<Address> I<Address>
4878
4879 The hostname or IP address of the host.
4880
4881 Optional
4882
4883 Type: string
4884
4885 Default: The "host" block's name.
4886
4887 =item B<Port> I<Port>
4888
4889 The TCP port to connect to on the host.
4890
4891 Optional
4892
4893 Type: integer
4894
4895 Default: 80 for protocol "http", 443 for protocol "https"
4896
4897 =item B<User> I<User>
4898
4899 =item B<Password> I<Password>
4900
4901 The username and password to use to login to the NetApp.
4902
4903 Mandatory
4904
4905 Type: string
4906
4907 =item B<VFilerName> I<Name>
4908
4909 The name of the VFiler in which context to execute API commands. If not
4910 specified, the name provided to the B<VFiler> block will be used instead.
4911
4912 Optional
4913
4914 Type: string
4915
4916 Default: name of the B<VFiler> block
4917
4918 B<Note:> This option may only be used inside B<VFiler> blocks.
4919
4920 =item B<Interval> I<Interval>
4921
4922 B<TODO>
4923
4924 =back
4925
4926 The following options decide what kind of data will be collected. You can
4927 either use them as a block and fine tune various parameters inside this block,
4928 use them as a single statement to just accept all default values, or omit it to
4929 not collect any data.
4930
4931 The following options are valid inside all blocks:
4932
4933 =over 4
4934
4935 =item B<Interval> I<Seconds>
4936
4937 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4938 host specific setting.
4939
4940 =back
4941
4942 =head3 The System block
4943
4944 This will collect various performance data about the whole system.
4945
4946 B<Note:> To get this data the collectd user needs the
4947 "api-perf-object-get-instances" capability.
4948
4949 =over 4
4950
4951 =item B<Interval> I<Seconds>
4952
4953 Collect disk statistics every I<Seconds> seconds.
4954
4955 =item B<GetCPULoad> B<true>|B<false>
4956
4957 If you set this option to true the current CPU usage will be read. This will be
4958 the average usage between all CPUs in your NetApp without any information about
4959 individual CPUs.
4960
4961 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4962 returns in the "CPU" field.
4963
4964 Optional
4965
4966 Type: boolean
4967
4968 Default: true
4969
4970 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4971
4972 =item B<GetInterfaces> B<true>|B<false>
4973
4974 If you set this option to true the current traffic of the network interfaces
4975 will be read. This will be the total traffic over all interfaces of your NetApp
4976 without any information about individual interfaces.
4977
4978 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4979 in the "Net kB/s" field.
4980
4981 B<Or is it?>
4982
4983 Optional
4984
4985 Type: boolean
4986
4987 Default: true
4988
4989 Result: One value list of type "if_octects".
4990
4991 =item B<GetDiskIO> B<true>|B<false>
4992
4993 If you set this option to true the current IO throughput will be read. This
4994 will be the total IO of your NetApp without any information about individual
4995 disks, volumes or aggregates.
4996
4997 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4998 in the "DiskE<nbsp>kB/s" field.
4999
5000 Optional
5001
5002 Type: boolean
5003
5004 Default: true
5005
5006 Result: One value list of type "disk_octets".
5007
5008 =item B<GetDiskOps> B<true>|B<false>
5009
5010 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5011 iSCSI, etc. operations will be read. This will be the total number of
5012 operations on your NetApp without any information about individual volumes or
5013 aggregates.
5014
5015 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5016 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5017
5018 Optional
5019
5020 Type: boolean
5021
5022 Default: true
5023
5024 Result: A variable number of value lists of type "disk_ops_complex". Each type
5025 of operation will result in one value list with the name of the operation as
5026 type instance.
5027
5028 =back
5029
5030 =head3 The WAFL block
5031
5032 This will collect various performance data about the WAFL file system. At the
5033 moment this just means cache performance.
5034
5035 B<Note:> To get this data the collectd user needs the
5036 "api-perf-object-get-instances" capability.
5037
5038 B<Note:> The interface to get these values is classified as "Diagnostics" by
5039 NetApp. This means that it is not guaranteed to be stable even between minor
5040 releases.
5041
5042 =over 4
5043
5044 =item B<Interval> I<Seconds>
5045
5046 Collect disk statistics every I<Seconds> seconds.
5047
5048 =item B<GetNameCache> B<true>|B<false>
5049
5050 Optional
5051
5052 Type: boolean
5053
5054 Default: true
5055
5056 Result: One value list of type "cache_ratio" and type instance
5057 "name_cache_hit".
5058
5059 =item B<GetDirCache> B<true>|B<false>
5060
5061 Optional
5062
5063 Type: boolean
5064
5065 Default: true
5066
5067 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5068
5069 =item B<GetInodeCache> B<true>|B<false>
5070
5071 Optional
5072
5073 Type: boolean
5074
5075 Default: true
5076
5077 Result: One value list of type "cache_ratio" and type instance
5078 "inode_cache_hit".
5079
5080 =item B<GetBufferCache> B<true>|B<false>
5081
5082 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5083 in the "Cache hit" field.
5084
5085 Optional
5086
5087 Type: boolean
5088
5089 Default: true
5090
5091 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5092
5093 =back
5094
5095 =head3 The Disks block
5096
5097 This will collect performance data about the individual disks in the NetApp.
5098
5099 B<Note:> To get this data the collectd user needs the
5100 "api-perf-object-get-instances" capability.
5101
5102 =over 4
5103
5104 =item B<Interval> I<Seconds>
5105
5106 Collect disk statistics every I<Seconds> seconds.
5107
5108 =item B<GetBusy> B<true>|B<false>
5109
5110 If you set this option to true the busy time of all disks will be calculated
5111 and the value of the busiest disk in the system will be written.
5112
5113 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5114 in the "Disk util" field. Probably.
5115
5116 Optional
5117
5118 Type: boolean
5119
5120 Default: true
5121
5122 Result: One value list of type "percent" and type instance "disk_busy".
5123
5124 =back
5125
5126 =head3 The VolumePerf block
5127
5128 This will collect various performance data about the individual volumes.
5129
5130 You can select which data to collect about which volume using the following
5131 options. They follow the standard ignorelist semantic.
5132
5133 B<Note:> To get this data the collectd user needs the
5134 I<api-perf-object-get-instances> capability.
5135
5136 =over 4
5137
5138 =item B<Interval> I<Seconds>
5139
5140 Collect volume performance data every I<Seconds> seconds.
5141
5142 =item B<GetIO> I<Volume>
5143
5144 =item B<GetOps> I<Volume>
5145
5146 =item B<GetLatency> I<Volume>
5147
5148 Select the given volume for IO, operations or latency statistics collection.
5149 The argument is the name of the volume without the C</vol/> prefix.
5150
5151 Since the standard ignorelist functionality is used here, you can use a string
5152 starting and ending with a slash to specify regular expression matching: To
5153 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5154 expression:
5155
5156   GetIO "/^vol[027]$/"
5157
5158 If no regular expression is specified, an exact match is required. Both,
5159 regular and exact matching are case sensitive.
5160
5161 If no volume was specified at all for either of the three options, that data
5162 will be collected for all available volumes.
5163
5164 See F</"IGNORELISTS"> for details.
5165
5166 =item B<IgnoreSelectedIO> B<true>|B<false>
5167
5168 =item B<IgnoreSelectedOps> B<true>|B<false>
5169
5170 =item B<IgnoreSelectedLatency> B<true>|B<false>
5171
5172 When set to B<true>, the volumes selected for IO, operations or latency
5173 statistics collection will be ignored and the data will be collected for all
5174 other volumes.
5175
5176 When set to B<false>, data will only be collected for the specified volumes and
5177 all other volumes will be ignored.
5178
5179 If no volumes have been specified with the above B<Get*> options, all volumes
5180 will be collected regardless of the B<IgnoreSelected*> option.
5181
5182 Defaults to B<false>
5183
5184 =back
5185
5186 =head3 The VolumeUsage block
5187
5188 This will collect capacity data about the individual volumes.
5189
5190 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5191 capability.
5192
5193 =over 4
5194
5195 =item B<Interval> I<Seconds>
5196
5197 Collect volume usage statistics every I<Seconds> seconds.
5198
5199 =item B<GetCapacity> I<VolumeName>
5200
5201 The current capacity of the volume will be collected. This will result in two
5202 to four value lists, depending on the configuration of the volume. All data
5203 sources are of type "df_complex" with the name of the volume as
5204 plugin_instance.
5205
5206 There will be type_instances "used" and "free" for the number of used and
5207 available bytes on the volume.  If the volume has some space reserved for
5208 snapshots, a type_instance "snap_reserved" will be available.  If the volume
5209 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5210 number of bytes saved by the SIS feature.
5211
5212 B<Note:> The current NetApp API has a bug that results in this value being
5213 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5214 number which works most of the time.  If you see strange values here, bug
5215 NetApp support to fix this.
5216
5217 Repeat this option to specify multiple volumes.
5218
5219 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5220
5221 Specify whether to collect only the volumes selected by the B<GetCapacity>
5222 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5223 B<false>. However, if no B<GetCapacity> option is specified at all, all
5224 capacities will be selected anyway.
5225
5226 =item B<GetSnapshot> I<VolumeName>
5227
5228 Select volumes from which to collect snapshot information.
5229
5230 Usually, the space used for snapshots is included in the space reported as
5231 "used". If snapshot information is collected as well, the space used for
5232 snapshots is subtracted from the used space.
5233
5234 To make things even more interesting, it is possible to reserve space to be
5235 used for snapshots. If the space required for snapshots is less than that
5236 reserved space, there is "reserved free" and "reserved used" space in addition
5237 to "free" and "used". If the space required for snapshots exceeds the reserved
5238 space, that part allocated in the normal space is subtracted from the "used"
5239 space again.
5240
5241 Repeat this option to specify multiple volumes.
5242
5243 =item B<IgnoreSelectedSnapshot>
5244
5245 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5246 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5247 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5248 capacities will be selected anyway.
5249
5250 =back
5251
5252 =head3 The Quota block
5253
5254 This will collect (tree) quota statistics (used disk space and number of used
5255 files). This mechanism is useful to get usage information for single qtrees.
5256 In case the quotas are not used for any other purpose, an entry similar to the
5257 following in C</etc/quotas> would be sufficient:
5258
5259   /vol/volA/some_qtree tree - - - - -
5260
5261 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5262
5263 =over 4
5264
5265 =item B<Interval> I<Seconds>
5266
5267 Collect SnapVault(R) statistics every I<Seconds> seconds.
5268
5269 =back
5270
5271 =head3 The SnapVault block
5272
5273 This will collect statistics about the time and traffic of SnapVault(R)
5274 transfers.
5275
5276 =over 4
5277
5278 =item B<Interval> I<Seconds>
5279
5280 Collect SnapVault(R) statistics every I<Seconds> seconds.
5281
5282 =back
5283
5284 =head2 Plugin C<netlink>
5285
5286 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5287 statistics of various interface and routing aspects.
5288
5289 =over 4
5290
5291 =item B<Interface> I<Interface>
5292
5293 =item B<VerboseInterface> I<Interface>
5294
5295 Instruct the plugin to collect interface statistics. This is basically the same
5296 as the statistics provided by the C<interface> plugin (see above) but
5297 potentially much more detailed.
5298
5299 When configuring with B<Interface> only the basic statistics will be collected,
5300 namely octets, packets, and errors. These statistics are collected by
5301 the C<interface> plugin, too, so using both at the same time is no benefit.
5302
5303 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5304 so that no data needs to be collected twice if you use the C<interface> plugin.
5305 This includes dropped packets, received multicast packets, collisions and a
5306 whole zoo of differentiated RX and TX errors. You can try the following command
5307 to get an idea of what awaits you:
5308
5309   ip -s -s link list
5310
5311 If I<Interface> is B<All>, all interfaces will be selected.
5312
5313 =item B<QDisc> I<Interface> [I<QDisc>]
5314
5315 =item B<Class> I<Interface> [I<Class>]
5316
5317 =item B<Filter> I<Interface> [I<Filter>]
5318
5319 Collect the octets and packets that pass a certain qdisc, class or filter.
5320
5321 QDiscs and classes are identified by their type and handle (or classid).
5322 Filters don't necessarily have a handle, therefore the parent's handle is used.
5323 The notation used in collectd differs from that used in tc(1) in that it
5324 doesn't skip the major or minor number if it's zero and doesn't print special
5325 ids by their name. So, for example, a qdisc may be identified by
5326 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5327 thus not displayed by tc(1).
5328
5329 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5330 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5331 associated with that interface will be collected.
5332
5333 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5334 used. This may lead to problems when more than one filter is attached to a
5335 qdisc or class. This isn't nice, but we don't know how this could be done any
5336 better. If you have a idea, please don't hesitate to tell us.
5337
5338 As with the B<Interface> option you can specify B<All> as the interface,
5339 meaning all interfaces.
5340
5341 Here are some examples to help you understand the above text more easily:
5342
5343   <Plugin netlink>
5344     VerboseInterface "All"
5345     QDisc "eth0" "pfifo_fast-1:0"
5346     QDisc "ppp0"
5347     Class "ppp0" "htb-1:10"
5348     Filter "ppp0" "u32-1:0"
5349   </Plugin>
5350
5351 See F</"IGNORELISTS"> for details.
5352
5353 =item B<IgnoreSelected>
5354
5355 The behavior is the same as with all other similar plugins: If nothing is
5356 selected at all, everything is collected. If some things are selected using the
5357 options described above, only these statistics are collected. If you set
5358 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5359 specified statistics will not be collected.
5360
5361 =back
5362
5363 =head2 Plugin C<network>
5364
5365 The Network plugin sends data to a remote instance of collectd, receives data
5366 from a remote instance, or both at the same time. Data which has been received
5367 from the network is usually not transmitted again, but this can be activated, see
5368 the B<Forward> option below.
5369
5370 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5371 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5372
5373 Both, B<Server> and B<Listen> can be used as single option or as block. When
5374 used as block, given options are valid for this socket only. The following
5375 example will export the metrics twice: Once to an "internal" server (without
5376 encryption and signing) and one to an external server (with cryptographic
5377 signature):
5378
5379  <Plugin "network">
5380    # Export to an internal server
5381    # (demonstrates usage without additional options)
5382    Server "collectd.internal.tld"
5383
5384    # Export to an external server
5385    # (demonstrates usage with signature options)
5386    <Server "collectd.external.tld">
5387      SecurityLevel "sign"
5388      Username "myhostname"
5389      Password "ohl0eQue"
5390    </Server>
5391  </Plugin>
5392
5393 =over 4
5394
5395 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5396
5397 The B<Server> statement/block sets the server to send datagrams to. The
5398 statement may occur multiple times to send each datagram to multiple
5399 destinations.
5400
5401 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5402 optional second argument specifies a port number or a service name. If not
5403 given, the default, B<25826>, is used.
5404
5405 The following options are recognized within B<Server> blocks:
5406
5407 =over 4
5408
5409 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5410
5411 Set the security you require for network communication. When the security level
5412 has been set to B<Encrypt>, data sent over the network will be encrypted using
5413 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5414 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5415 authentication code. When set to B<None>, data is sent without any security.
5416
5417 This feature is only available if the I<network> plugin was linked with
5418 I<libgcrypt>.
5419
5420 =item B<Username> I<Username>
5421
5422 Sets the username to transmit. This is used by the server to lookup the
5423 password. See B<AuthFile> below. All security levels except B<None> require
5424 this setting.
5425
5426 This feature is only available if the I<network> plugin was linked with
5427 I<libgcrypt>.
5428
5429 =item B<Password> I<Password>
5430
5431 Sets a password (shared secret) for this socket. All security levels except
5432 B<None> require this setting.
5433
5434 This feature is only available if the I<network> plugin was linked with
5435 I<libgcrypt>.
5436
5437 =item B<Interface> I<Interface name>
5438
5439 Set the outgoing interface for IP packets. This applies at least
5440 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5441 undefined or a non-existent interface name is specified, the default
5442 behavior is to let the kernel choose the appropriate interface. Be warned
5443 that the manual selection of an interface for unicast traffic is only
5444 necessary in rare cases.
5445
5446 =item B<BindAddress> I<IP Address>
5447
5448 Set the outgoing IP address for IP packets. This option can be used instead of
5449 the I<Interface> option to explicitly define the IP address which will be used
5450 to send Packets to the remote server.
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, gathers
7296 information about each server's state and executes user-defined queries.
7297 For each server there is a I<Node> block which configures the connection
7298 parameters and set of user-defined queries for this node.
7299
7300   <Plugin redis>
7301     <Node "example">
7302         Host "localhost"
7303         Port "6379"
7304         Timeout 2000
7305         ReportCommandStats false
7306         ReportCpuUsage true
7307         <Query "LLEN myqueue">
7308           #Database 0
7309           Type "queue_length"
7310           Instance "myqueue"
7311         </Query>
7312     </Node>
7313   </Plugin>
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 128E<nbsp>characters in length.
7323
7324 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7325
7326 =item B<Host> I<Hostname>
7327
7328 The B<Host> option is the hostname or IP-address where the Redis instance is
7329 running on.
7330
7331 =item B<Port> I<Port>
7332
7333 The B<Port> option is the TCP port on which the Redis instance accepts
7334 connections. Either a service name of a port number may be given. Please note
7335 that numerical port numbers must be given as a string, too.
7336
7337 =item B<Password> I<Password>
7338
7339 Use I<Password> to authenticate when connecting to I<Redis>.
7340
7341 =item B<Timeout> I<Milliseconds>
7342
7343 The B<Timeout> option set the socket timeout for node response. Since the Redis
7344 read function is blocking, you should keep this value as low as possible.
7345 It is expected what B<Timeout> values should be lower than B<Interval> defined
7346 globally.
7347
7348 Defaults to 2000 (2 seconds).
7349
7350 =item B<ReportCommandStats> B<false>|B<true>
7351
7352 Enables or disables reporting of statistics based on the command type, including
7353 rate of command calls and average CPU time consumed by command processing.
7354 Defaults to B<false>.
7355
7356 =item B<ReportCpuUsage> B<true>|B<false>
7357
7358 Enables or disables reporting of CPU consumption statistics.
7359 Defaults to B<true>.
7360
7361 =item B<Query> I<Querystring>
7362
7363 The B<Query> block identifies a query to execute against the redis server.
7364 There may be an arbitrary number of queries to execute. Each query should
7365 return single string or integer.
7366
7367 =item B<Type> I<Collectd type>
7368
7369 Within a query definition, a valid I<collectd type> to use as when submitting
7370 the result of the query. When not supplied, will default to B<gauge>.
7371
7372 Currently only types with one datasource are supported.
7373 See L<types.db(5)> for more details on types and their configuration.
7374
7375 =item B<Instance> I<Type instance>
7376
7377 Within a query definition, an optional type instance to use when submitting
7378 the result of the query. When not supplied will default to the escaped
7379 command, up to 128 chars.
7380
7381 =item B<Database> I<Index>
7382
7383 This index selects the Redis logical database to use for query. Defaults
7384 to C<0>.
7385
7386 =back
7387
7388 =head2 Plugin C<rrdcached>
7389
7390 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7391 to store values to RRD files in an efficient manner. The combination of the
7392 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7393 way the C<rrdtool> plugin works (see below). The added abstraction layer
7394 provides a number of benefits, though: Because the cache is not within
7395 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7396 restarted. This results in much shorter (if any) gaps in graphs, especially
7397 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7398 daemon so that it can flush values to disk automatically when needed. This
7399 allows one to integrate automated flushing of values into graphing solutions
7400 much more easily.
7401
7402 There are disadvantages, though: The daemon may reside on a different host, so
7403 it may not be possible for C<collectd> to create the appropriate RRD files
7404 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7405 different base directory, so relative paths may do weird stuff if you're not
7406 careful.
7407
7408 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7409 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7410 setting should be set to an absolute path, so that a changed base directory
7411 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7412
7413 =over 4
7414
7415 =item B<DaemonAddress> I<Address>
7416
7417 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7418 library. See L<rrdcached(1)> for details. Example:
7419
7420   <Plugin "rrdcached">
7421     DaemonAddress "unix:/var/run/rrdcached.sock"
7422   </Plugin>
7423
7424 =item B<DataDir> I<Directory>
7425
7426 Set the base directory in which the RRD files reside. If this is a relative
7427 path, it is relative to the working base directory of the C<rrdcached> daemon!
7428 Use of an absolute path is recommended.
7429
7430 =item B<CreateFiles> B<true>|B<false>
7431
7432 Enables or disables the creation of RRD files. If the daemon is not running
7433 locally, or B<DataDir> is set to a relative path, this will not work as
7434 expected. Default is B<true>.
7435
7436 =item B<CreateFilesAsync> B<false>|B<true>
7437
7438 When enabled, new RRD files are enabled asynchronously, using a separate thread
7439 that runs in the background. This prevents writes to block, which is a problem
7440 especially when many hundreds of files need to be created at once. However,
7441 since the purpose of creating the files asynchronously is I<not> to block until
7442 the file is available, values before the file is available will be discarded.
7443 When disabled (the default) files are created synchronously, blocking for a
7444 short while, while the file is being written.
7445
7446 =item B<StepSize> I<Seconds>
7447
7448 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7449 this setting is unset and the stepsize is set to the interval in which the data
7450 is collected. Do not use this option unless you absolutely have to for some
7451 reason. Setting this option may cause problems with the C<snmp plugin>, the
7452 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7453
7454 =item B<HeartBeat> I<Seconds>
7455
7456 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7457 in which case the heartbeat is set to twice the B<StepSize> which should equal
7458 the interval in which data is collected. Do not set this option unless you have
7459 a very good reason to do so.
7460
7461 =item B<RRARows> I<NumRows>
7462
7463 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7464 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7465 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7466 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7467 week, one month, and one year.
7468
7469 So for each timespan, it calculates how many PDPs need to be consolidated into
7470 one CDP by calculating:
7471   number of PDPs = timespan / (stepsize * rrarows)
7472
7473 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7474 default is 1200.
7475
7476 =item B<RRATimespan> I<Seconds>
7477
7478 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7479 more then one RRA. If this option is never used, the built-in default of (3600,
7480 86400, 604800, 2678400, 31622400) is used.
7481
7482 For more information on how RRA-sizes are calculated see B<RRARows> above.
7483
7484 =item B<XFF> I<Factor>
7485
7486 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7487 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7488 one (exclusive).
7489
7490 =item B<CollectStatistics> B<false>|B<true>
7491
7492 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7493 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7494
7495 Statistics are read via I<rrdcached>s socket using the STATS command.
7496 See L<rrdcached(1)> for details.
7497
7498 =back
7499
7500 =head2 Plugin C<rrdtool>
7501
7502 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7503 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7504 using these settings. If you don't want to dive into the depths of RRDtool, you
7505 can safely ignore these settings.
7506
7507 =over 4
7508
7509 =item B<DataDir> I<Directory>
7510
7511 Set the directory to store RRD files under. By default RRD files are generated
7512 beneath the daemon's working directory, i.e. the B<BaseDir>.
7513
7514 =item B<CreateFilesAsync> B<false>|B<true>
7515
7516 When enabled, new RRD files are enabled asynchronously, using a separate thread
7517 that runs in the background. This prevents writes to block, which is a problem
7518 especially when many hundreds of files need to be created at once. However,
7519 since the purpose of creating the files asynchronously is I<not> to block until
7520 the file is available, values before the file is available will be discarded.
7521 When disabled (the default) files are created synchronously, blocking for a
7522 short while, while the file is being written.
7523
7524 =item B<StepSize> I<Seconds>
7525
7526 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7527 this setting is unset and the stepsize is set to the interval in which the data
7528 is collected. Do not use this option unless you absolutely have to for some
7529 reason. Setting this option may cause problems with the C<snmp plugin>, the
7530 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7531
7532 =item B<HeartBeat> I<Seconds>
7533
7534 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7535 in which case the heartbeat is set to twice the B<StepSize> which should equal
7536 the interval in which data is collected. Do not set this option unless you have
7537 a very good reason to do so.
7538
7539 =item B<RRARows> I<NumRows>
7540
7541 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7542 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7543 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7544 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7545 week, one month, and one year.
7546
7547 So for each timespan, it calculates how many PDPs need to be consolidated into
7548 one CDP by calculating:
7549   number of PDPs = timespan / (stepsize * rrarows)
7550
7551 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7552 default is 1200.
7553
7554 =item B<RRATimespan> I<Seconds>
7555
7556 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7557 more then one RRA. If this option is never used, the built-in default of (3600,
7558 86400, 604800, 2678400, 31622400) is used.
7559
7560 For more information on how RRA-sizes are calculated see B<RRARows> above.
7561
7562 =item B<XFF> I<Factor>
7563
7564 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7565 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7566 one (exclusive).
7567
7568 =item B<CacheFlush> I<Seconds>
7569
7570 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7571 it writes all values for a certain RRD-file if the oldest value is older than
7572 (or equal to) the number of seconds specified by B<CacheTimeout>.
7573 That check happens on new values arriwal. If some RRD-file is not updated
7574 anymore for some reason (the computer was shut down, the network is broken,
7575 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7576 every I<Seconds> seconds the entire cache is searched for entries older than
7577 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7578 disk. Since scanning the entire cache is kind of expensive and does nothing
7579 under normal circumstances, this value should not be too small. 900 seconds
7580 might be a good value, though setting this to 7200 seconds doesn't normally
7581 do much harm either.
7582
7583 Defaults to 10x B<CacheTimeout>.
7584 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7585 above default is used.
7586
7587 =item B<CacheTimeout> I<Seconds>
7588
7589 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7590 save values in a cache, as described above. Writing multiple values at once
7591 reduces IO-operations and thus lessens the load produced by updating the files.
7592 The trade off is that the graphs kind of "drag behind" and that more memory is
7593 used.
7594
7595 =item B<WritesPerSecond> I<Updates>
7596
7597 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7598 will run serious performance problems. The B<CacheFlush> setting and the
7599 internal update queue assert that collectd continues to work just fine even
7600 under heavy load, but the system may become very unresponsive and slow. This is
7601 a problem especially if you create graphs from the RRD files on the same
7602 machine, for example using the C<graph.cgi> script included in the
7603 C<contrib/collection3/> directory.
7604
7605 This setting is designed for very large setups. Setting this option to a value
7606 between 25 and 80 updates per second, depending on your hardware, will leave
7607 the server responsive enough to draw graphs even while all the cached values
7608 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7609 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7610 written as fast as possible, so that web frontends have up to date data when
7611 generating graphs.
7612
7613 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7614 updates per second, writing all values to disk will take approximately
7615 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7616 "collection3" you'll end up with a responsive and fast system, up to date
7617 graphs and basically a "backup" of your values every hour.
7618
7619 =item B<RandomTimeout> I<Seconds>
7620
7621 When set, the actual timeout for each value is chosen randomly between
7622 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7623 intention is to avoid high load situations that appear when many values timeout
7624 at the same time. This is especially a problem shortly after the daemon starts,
7625 because all values were added to the internal cache at roughly the same time.
7626
7627 =back
7628
7629 =head2 Plugin C<sensors>
7630
7631 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7632 that all the needed modules have to be loaded and lm_sensors has to be
7633 configured (most likely by editing F</etc/sensors.conf>. Read
7634 L<sensors.conf(5)> for details.
7635
7636 The B<lm_sensors> homepage can be found at
7637 L<http://secure.netroedge.com/~lm78/>.
7638
7639 =over 4
7640
7641 =item B<SensorConfigFile> I<File>
7642
7643 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7644 the library's default will be used.
7645
7646 =item B<Sensor> I<chip-bus-address/type-feature>
7647
7648 Selects the name of the sensor which you want to collect or ignore, depending
7649 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7650 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7651 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7652
7653 See F</"IGNORELISTS"> for details.
7654
7655 =item B<IgnoreSelected> I<true>|I<false>
7656
7657 If no configuration if given, the B<sensors>-plugin will collect data from all
7658 sensors. This may not be practical, especially for uninteresting sensors.
7659 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7660 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7661 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7662 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7663 and all other sensors are collected.
7664
7665 =item B<UseLabels> I<true>|I<false>
7666
7667 Configures how sensor readings are reported. When set to I<true>, sensor
7668 readings are reported using their descriptive label (e.g. "VCore"). When set to
7669 I<false> (the default) the sensor name is used ("in0").
7670
7671 =back
7672
7673 =head2 Plugin C<sigrok>
7674
7675 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7676 supported by the L<sigrok|http://sigrok.org/> project.
7677
7678 B<Synopsis>
7679
7680  <Plugin sigrok>
7681    LogLevel 3
7682    <Device "AC Voltage">
7683       Driver "fluke-dmm"
7684       MinimumInterval 10
7685       Conn "/dev/ttyUSB2"
7686    </Device>
7687    <Device "Sound Level">
7688       Driver "cem-dt-885x"
7689       Conn "/dev/ttyUSB1"
7690    </Device>
7691  </Plugin>
7692
7693 =over 4
7694
7695 =item B<LogLevel> B<0-5>
7696
7697 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7698 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7699 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7700 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7701 their level, are always submitted to I<collectd> at its INFO log level.
7702
7703 =item E<lt>B<Device> I<Name>E<gt>
7704
7705 A sigrok-supported device, uniquely identified by this section's options. The
7706 I<Name> is passed to I<collectd> as the I<plugin instance>.
7707
7708 =item B<Driver> I<DriverName>
7709
7710 The sigrok driver to use for this device.
7711
7712 =item B<Conn> I<ConnectionSpec>
7713
7714 If the device cannot be auto-discovered, or more than one might be discovered
7715 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7716 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7717 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7718 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7719 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7720
7721 =item B<SerialComm> I<SerialSpec>
7722
7723 For serial devices with non-standard port settings, this option can be used
7724 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7725 This should not be necessary; drivers know how to communicate with devices they
7726 support.
7727
7728 =item B<MinimumInterval> I<Seconds>
7729
7730 Specifies the minimum time between measurement dispatches to I<collectd>, in
7731 seconds. Since some I<sigrok> supported devices can acquire measurements many
7732 times per second, it may be necessary to throttle these. For example, the
7733 I<RRD plugin> cannot process writes more than once per second.
7734
7735 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7736 device are always dispatched to I<collectd>. When throttled, unused
7737 measurements are discarded.
7738
7739 =back
7740
7741 =head2 Plugin C<smart>
7742
7743 The C<smart> plugin collects SMART information from physical
7744 disks. Values collectd include temperature, power cycle count, poweron
7745 time and bad sectors. Also, all SMART attributes are collected along
7746 with the normalized current value, the worst value, the threshold and
7747 a human readable value.
7748
7749 Using the following two options you can ignore some disks or configure the
7750 collection only of specific disks.
7751
7752 =over 4
7753
7754 =item B<Disk> I<Name>
7755
7756 Select the disk I<Name>. Whether it is collected or ignored depends on the
7757 B<IgnoreSelected> setting, see below. As with other plugins that use the
7758 daemon's ignorelist functionality, a string that starts and ends with a slash
7759 is interpreted as a regular expression. Examples:
7760
7761   Disk "sdd"
7762   Disk "/hda[34]/"
7763
7764 See F</"IGNORELISTS"> for details.
7765
7766 =item B<IgnoreSelected> B<true>|B<false>
7767
7768 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7769 statements, are ignored or if all other disks are ignored. The behavior
7770 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7771 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7772 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7773 is set to B<true>, all disks are collected B<except> the ones matched.
7774
7775 =item B<IgnoreSleepMode> B<true>|B<false>
7776
7777 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7778 This option disables the sleep mode check and allows the plugin to collect data
7779 from these disks anyway. This is useful in cases where libatasmart mistakenly
7780 reports disks as asleep because it has not been updated to incorporate support
7781 for newer idle states in the ATA spec.
7782
7783 =item B<UseSerial> B<true>|B<false>
7784
7785 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7786 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7787 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7788 storing data. This ensures that the data for a given disk will be kept together
7789 even if the kernel name changes.
7790
7791 =back
7792
7793 =head2 Plugin C<snmp>
7794
7795 Since the configuration of the C<snmp plugin> is a little more complicated than
7796 other plugins, its documentation has been moved to an own manpage,
7797 L<collectd-snmp(5)>. Please see there for details.
7798
7799 =head2 Plugin C<snmp_agent>
7800
7801 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7802 from SNMP master agent and returns the data collected by read plugins.
7803 The I<snmp_agent> plugin handles requests only for OIDs specified in
7804 configuration file. To handle SNMP queries the plugin gets data from collectd
7805 and translates requested values from collectd's internal format to SNMP format.
7806 This plugin is a generic plugin and cannot work without configuration.
7807 For more details on AgentX subagent see
7808 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7809
7810 B<Synopsis:>
7811
7812   <Plugin snmp_agent>
7813     <Data "memAvailReal">
7814       Plugin "memory"
7815       #PluginInstance "some"
7816       Type "memory"
7817       TypeInstance "free"
7818       OIDs "1.3.6.1.4.1.2021.4.6.0"
7819     </Data>
7820     <Table "ifTable">
7821       IndexOID "IF-MIB::ifIndex"
7822       SizeOID "IF-MIB::ifNumber"
7823       <Data "ifDescr">
7824         <IndexKey>
7825           Source "PluginInstance"
7826         </IndexKey>
7827         Plugin "interface"
7828         OIDs "IF-MIB::ifDescr"
7829       </Data>
7830       <Data "ifOctets">
7831         Plugin "interface"
7832         Type "if_octets"
7833         TypeInstance ""
7834         OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7835       </Data>
7836     </Table>
7837     <Table "CPUAffinityTable">
7838       <Data "DomainName">
7839         <IndexKey>
7840           Source "PluginInstance"
7841         </IndexKey>
7842         Plugin "virt"
7843         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
7844       </Data>
7845       <Data "VCPU">
7846         Plugin "virt"
7847         <IndexKey>
7848           Source "TypeInstance"
7849           Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
7850           Group 1
7851         </IndexKey>
7852         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
7853       </Data>
7854       <Data "CPU">
7855         Plugin "virt"
7856         <IndexKey>
7857           Source "TypeInstance"
7858           Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
7859           Group 1
7860         </IndexKey>
7861         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
7862       </Data>
7863       <Data "CPUAffinity">
7864         Plugin "virt"
7865         Type "cpu_affinity"
7866         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
7867       </Data>
7868     </Table>
7869   </Plugin>
7870
7871 There are two types of blocks that can be contained in the
7872 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7873
7874 =head3 B<Data> block
7875
7876 The B<Data> block defines a list OIDs that are to be handled. This block can
7877 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7878 block it reperesents table OIDs.
7879 The following options can be set:
7880
7881 =over 4
7882
7883 =item B<IndexKey> block
7884
7885 B<IndexKey> block contains all data needed for proper index build of snmp table.
7886 In case more than
7887 one table B<Data> block has B<IndexKey> block present then multiple key index is
7888 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
7889 be omitted.
7890
7891 =over 8
7892
7893 =item B<Source> I<String>
7894
7895 B<Source> can be set to one of the following values: "Hostname", "Plugin",
7896 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
7897 corresponding collectd metric is taken as a SNMP table index.
7898
7899 =item B<Regex> I<String>
7900
7901 B<Regex> option can also be used to parse strings or numbers out of
7902 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
7903 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
7904 as a table index.
7905
7906 =item B<Group> I<Number>
7907
7908 B<Group> number can be specified in case groups are used in regex.
7909
7910 =back
7911
7912 =item B<Plugin> I<String>
7913
7914 Read plugin name whose collected data will be mapped to specified OIDs.
7915
7916 =item B<PluginInstance> I<String>
7917
7918 Read plugin instance whose collected data will be mapped to specified OIDs.
7919 The field is optional and by default there is no plugin instance check.
7920 Allowed only if B<Data> block defines scalar data type.
7921
7922 =item B<Type> I<String>
7923
7924 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7925 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7926
7927 =item B<TypeInstance> I<String>
7928
7929 Collectd's type-instance that is to be used for specified OID.
7930
7931 =item B<OIDs> I<OID> [I<OID> ...]
7932
7933 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7934 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7935 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7936 configured should correspond to number of values in specified B<Type>.
7937 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7938 "rx" and "tx" values of "if_octets" type.
7939
7940 =item B<Scale> I<Value>
7941
7942 The values taken from collectd are multiplied by I<Value>. The field is optional
7943 and the default is B<1.0>.
7944
7945 =item B<Shift> I<Value>
7946
7947 I<Value> is added to values from collectd after they have been multiplied by
7948 B<Scale> value. The field is optional and the default value is B<0.0>.
7949
7950 =back
7951
7952 =head3 The B<Table> block
7953
7954 The B<Table> block defines a collection of B<Data> blocks that belong to one
7955 snmp table. In addition to multiple B<Data> blocks the following options can be
7956 set:
7957
7958 =over 4
7959
7960 =item B<IndexOID> I<OID>
7961
7962 OID that is handled by the plugin and is mapped to numerical index value that is
7963 generated by the plugin for each table record.
7964
7965 =item B<SizeOID> I<OID>
7966
7967 OID that is handled by the plugin. Returned value is the number of records in
7968 the table. The field is optional.
7969
7970 =back
7971
7972 =head2 Plugin C<statsd>
7973
7974 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7975 protocol and dispatches rates or other aggregates of these numbers
7976 periodically.
7977
7978 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7979 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7980 C<objects> respectively.
7981
7982 The following configuration options are valid:
7983
7984 =over 4
7985
7986 =item B<Host> I<Host>
7987
7988 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7989 "any" address, i.e. accept packets sent to any of the hosts addresses.
7990
7991 =item B<Port> I<Port>
7992
7993 UDP port to listen to. This can be either a service name or a port number.
7994 Defaults to C<8125>.
7995
7996 =item B<DeleteCounters> B<false>|B<true>
7997
7998 =item B<DeleteTimers> B<false>|B<true>
7999
8000 =item B<DeleteGauges> B<false>|B<true>
8001
8002 =item B<DeleteSets> B<false>|B<true>
8003
8004 These options control what happens if metrics are not updated in an interval.
8005 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8006 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8007 are unchanged. If set to B<True>, the such metrics are not dispatched and
8008 removed from the internal cache.
8009
8010 =item B<CounterSum> B<false>|B<true>
8011
8012 When enabled, creates a C<count> metric which reports the change since the last
8013 read. This option primarily exists for compatibility with the I<statsd>
8014 implementation by Etsy.
8015
8016 =item B<TimerPercentile> I<Percent>
8017
8018 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8019 that I<Percent> of all reported timers are smaller than or equal to the
8020 computed latency. This is useful for cutting off the long tail latency, as it's
8021 often done in I<Service Level Agreements> (SLAs).
8022
8023 Different percentiles can be calculated by setting this option several times.
8024 If none are specified, no percentiles are calculated / dispatched.
8025
8026 =item B<TimerLower> B<false>|B<true>
8027
8028 =item B<TimerUpper> B<false>|B<true>
8029
8030 =item B<TimerSum> B<false>|B<true>
8031
8032 =item B<TimerCount> B<false>|B<true>
8033
8034 Calculate and dispatch various values out of I<Timer> metrics received during
8035 an interval. If set to B<False>, the default, these values aren't calculated /
8036 dispatched.
8037
8038 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8039
8040 =back
8041
8042 =head2 Plugin C<swap>
8043
8044 The I<Swap plugin> collects information about used and available swap space. On
8045 I<Linux> and I<Solaris>, the following options are available:
8046
8047 =over 4
8048
8049 =item B<ReportByDevice> B<false>|B<true>
8050
8051 Configures how to report physical swap devices. If set to B<false> (the
8052 default), the summary over all swap devices is reported only, i.e. the globally
8053 used and available space over all devices. If B<true> is configured, the used
8054 and available space of each device will be reported separately.
8055
8056 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8057 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8058
8059 =item B<ReportBytes> B<false>|B<true>
8060
8061 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8062 I<swap I/O> is reported in pages. This option is available under Linux only.
8063
8064 =item B<ValuesAbsolute> B<true>|B<false>
8065
8066 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8067 available and used. Defaults to B<true>.
8068
8069 =item B<ValuesPercentage> B<false>|B<true>
8070
8071 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8072 available and free. Defaults to B<false>.
8073
8074 This is useful for deploying I<collectd> in a heterogeneous environment, where
8075 swap sizes differ and you want to specify generic thresholds or similar.
8076
8077 =item B<ReportIO> B<true>|B<false>
8078
8079 Enables or disables reporting swap IO. Defaults to B<true>.
8080
8081 This is useful for the cases when swap IO is not neccessary, is not available,
8082 or is not reliable.
8083
8084 =back
8085
8086 =head2 Plugin C<syslog>
8087
8088 =over 4
8089
8090 =item B<LogLevel> B<debug|info|notice|warning|err>
8091
8092 Sets the log-level. If, for example, set to B<notice>, then all events with
8093 severity B<notice>, B<warning>, or B<err> will be submitted to the
8094 syslog-daemon.
8095
8096 Please note that B<debug> is only available if collectd has been compiled with
8097 debugging support.
8098
8099 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8100
8101 Controls which notifications should be sent to syslog. The default behaviour is
8102 not to send any. Less severe notifications always imply logging more severe
8103 notifications: Setting this to B<OKAY> means all notifications will be sent to
8104 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8105 notifications but will dismiss B<OKAY> notifications. Setting this option to
8106 B<FAILURE> will only send failures to syslog.
8107
8108 =back
8109
8110 =head2 Plugin C<table>
8111
8112 The C<table plugin> provides generic means to parse tabular data and dispatch
8113 user specified values. Values are selected based on column numbers. For
8114 example, this plugin may be used to get values from the Linux L<proc(5)>
8115 filesystem or CSV (comma separated values) files.
8116
8117   <Plugin table>
8118     <Table "/proc/slabinfo">
8119       #Plugin "slab"
8120       Instance "slabinfo"
8121       Separator " "
8122       <Result>
8123         Type gauge
8124         InstancePrefix "active_objs"
8125         InstancesFrom 0
8126         ValuesFrom 1
8127       </Result>
8128       <Result>
8129         Type gauge
8130         InstancePrefix "objperslab"
8131         InstancesFrom 0
8132         ValuesFrom 4
8133       </Result>
8134     </Table>
8135   </Plugin>
8136
8137 The configuration consists of one or more B<Table> blocks, each of which
8138 configures one file to parse. Within each B<Table> block, there are one or
8139 more B<Result> blocks, which configure which data to select and how to
8140 interpret it.
8141
8142 The following options are available inside a B<Table> block:
8143
8144 =over 4
8145
8146 =item B<Plugin> I<Plugin>
8147
8148 If specified, I<Plugin> is used as the plugin name when submitting values.
8149 Defaults to B<table>.
8150
8151 =item B<Instance> I<instance>
8152
8153 If specified, I<instance> is used as the plugin instance. If omitted, the
8154 filename of the table is used instead, with all special characters replaced
8155 with an underscore (C<_>).
8156
8157 =item B<Separator> I<string>
8158
8159 Any character of I<string> is interpreted as a delimiter between the different
8160 columns of the table. A sequence of two or more contiguous delimiters in the
8161 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8162 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8163 of a table - see its documentation for more details. This option is mandatory.
8164
8165 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8166 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8167 required because of collectd's config parsing.
8168
8169 =back
8170
8171 The following options are available inside a B<Result> block:
8172
8173 =over 4
8174
8175 =item B<Type> I<type>
8176
8177 Sets the type used to dispatch the values to the daemon. Detailed information
8178 about types and their configuration can be found in L<types.db(5)>. This
8179 option is mandatory.
8180
8181 =item B<InstancePrefix> I<prefix>
8182
8183 If specified, prepend I<prefix> to the type instance. If omitted, only the
8184 B<InstancesFrom> option is considered for the type instance.
8185
8186 =item B<InstancesFrom> I<column0> [I<column1> ...]
8187
8188 If specified, the content of the given columns (identified by the column
8189 number starting at zero) will be used to create the type instance for each
8190 row. Multiple values (and the instance prefix) will be joined together with
8191 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8192 option is considered for the type instance.
8193
8194 The plugin itself does not check whether or not all built instances are
8195 different. It’s your responsibility to assure that each is unique. This is
8196 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8197 sure that the table only contains one row.
8198
8199 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8200 will be empty.
8201
8202 =item B<ValuesFrom> I<column0> [I<column1> ...]
8203
8204 Specifies the columns (identified by the column numbers starting at zero)
8205 whose content is used as the actual data for the data sets that are dispatched
8206 to the daemon. How many such columns you need is determined by the B<Type>
8207 setting above. If you specify too many or not enough columns, the plugin will
8208 complain about that and no data will be submitted to the daemon. The plugin
8209 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8210 respectively, so anything supported by those functions is supported by the
8211 plugin as well. This option is mandatory.
8212
8213 =back
8214
8215 =head2 Plugin C<tail>
8216
8217 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8218 each line and dispatches found values. What is matched can be configured by the
8219 user using (extended) regular expressions, as described in L<regex(7)>.
8220
8221   <Plugin "tail">
8222     <File "/var/log/exim4/mainlog">
8223       Plugin "mail"
8224       Instance "exim"
8225       Interval 60
8226       <Match>
8227         Regex "S=([1-9][0-9]*)"
8228         DSType "CounterAdd"
8229         Type "ipt_bytes"
8230         Instance "total"
8231       </Match>
8232       <Match>
8233         Regex "\\<R=local_user\\>"
8234         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8235         DSType "CounterInc"
8236         Type "counter"
8237         Instance "local_user"
8238       </Match>
8239       <Match>
8240         Regex "l=([0-9]*\\.[0-9]*)"
8241         <DSType "Distribution">
8242           Percentile 99
8243           Bucket 0 100
8244           #BucketType "bucket"
8245         </DSType>
8246         Type "latency"
8247         Instance "foo"
8248       </Match>
8249     </File>
8250   </Plugin>
8251
8252 The config consists of one or more B<File> blocks, each of which configures one
8253 logfile to parse. Within each B<File> block, there are one or more B<Match>
8254 blocks, which configure a regular expression to search for.
8255
8256 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8257 the plugin name and instance respectively. So in the above example the plugin name
8258 C<mail-exim> would be used.
8259
8260 These options are applied for all B<Match> blocks that B<follow> it, until the
8261 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8262 instances from one logfile, handy when parsing syslog and the like.
8263
8264 The B<Interval> option allows you to define the length of time between reads. If
8265 this is not set, the default Interval will be used.
8266
8267 Each B<Match> block has the following options to describe how the match should
8268 be performed:
8269
8270 =over 4
8271
8272 =item B<Regex> I<regex>
8273
8274 Sets the regular expression to use for matching against a line. The first
8275 subexpression has to match something that can be turned into a number by
8276 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8277 below. Because B<extended> regular expressions are used, you do not need to use
8278 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8279 collectd's config parsing you need to escape backslashes, though. So if you
8280 want to match literal parentheses you need to do the following:
8281
8282   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8283
8284 =item B<ExcludeRegex> I<regex>
8285
8286 Sets an optional regular expression to use for excluding lines from the match.
8287 An example which excludes all connections from localhost from the match:
8288
8289   ExcludeRegex "127\\.0\\.0\\.1"
8290
8291 =item B<DSType> I<Type>
8292
8293 Sets how the values are cumulated. I<Type> is one of:
8294
8295 =over 4
8296
8297 =item B<GaugeAverage>
8298
8299 Calculate the average.
8300
8301 =item B<GaugeMin>
8302
8303 Use the smallest number only.
8304
8305 =item B<GaugeMax>
8306
8307 Use the greatest number only.
8308
8309 =item B<GaugeLast>
8310
8311 Use the last number found.
8312
8313 =item B<GaugePersist>
8314
8315 Use the last number found. The number is not reset at the end of an interval.
8316 It is continously reported until another number is matched. This is intended
8317 for cases in which only state changes are reported, for example a thermometer
8318 that only reports the temperature when it changes.
8319
8320 =item B<CounterSet>
8321
8322 =item B<DeriveSet>
8323
8324 =item B<AbsoluteSet>
8325
8326 The matched number is a counter. Simply I<sets> the internal counter to this
8327 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8328
8329 =item B<GaugeAdd>
8330
8331 =item B<CounterAdd>
8332
8333 =item B<DeriveAdd>
8334
8335 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8336 matched number may be negative, which will effectively subtract from the
8337 internal counter.
8338
8339 =item B<GaugeInc>
8340
8341 =item B<CounterInc>
8342
8343 =item B<DeriveInc>
8344
8345 Increase the internal counter by one. These B<DSType> are the only ones that do
8346 not use the matched subexpression, but simply count the number of matched
8347 lines. Thus, you may use a regular expression without submatch in this case.
8348
8349 =item B<Distribution>
8350
8351 Type to do calculations based on the distribution of values, primarily
8352 calculating percentiles. This is primarily geared towards latency, but can be
8353 used for other metrics as well. The range of values tracked with this setting
8354 must be in the range (0–2^34) and can be fractional. Please note that neither
8355 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8356 distribution.
8357
8358 This option must be used together with the B<Percentile> and/or B<Bucket>
8359 options.
8360
8361 B<Synopsis:>
8362
8363   <DSType "Distribution">
8364     Percentile 99
8365     Bucket 0 100
8366     BucketType "bucket"
8367   </DSType>
8368
8369 =over 4
8370
8371 =item B<Percentile> I<Percent>
8372
8373 Calculate and dispatch the configured percentile, i.e. compute the value, so
8374 that I<Percent> of all matched values are smaller than or equal to the computed
8375 latency.
8376
8377 Metrics are reported with the I<type> B<Type> (the value of the above option)
8378 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8379
8380 This option may be repeated to calculate more than one percentile.
8381
8382 =item B<Bucket> I<lower_bound> I<upper_bound>
8383
8384 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8385 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8386 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8387 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8388 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8389 lower/upper bound.
8390
8391 To export the entire (0–inf) range without overlap, use the upper bound of the
8392 previous range as the lower bound of the following range. In other words, use
8393 the following schema:
8394
8395   Bucket   0   1
8396   Bucket   1   2
8397   Bucket   2   5
8398   Bucket   5  10
8399   Bucket  10  20
8400   Bucket  20  50
8401   Bucket  50   0
8402
8403 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8404 by default) and the I<type instance>
8405 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8406
8407 This option may be repeated to calculate more than one rate.
8408
8409 =item B<BucketType> I<Type>
8410
8411 Sets the type used to dispatch B<Bucket> metrics.
8412 Optional, by default C<bucket> will be used.
8413
8414 =back
8415
8416 =back
8417
8418 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8419 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8420 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8421 B<Derive*> types interpret the submatch as a signed integer using
8422 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8423 and it may be omitted in this case.
8424
8425 =item B<Type> I<Type>
8426
8427 Sets the type used to dispatch this value. Detailed information about types and
8428 their configuration can be found in L<types.db(5)>.
8429
8430 =item B<Instance> I<TypeInstance>
8431
8432 This optional setting sets the type instance to use.
8433
8434 =back
8435
8436 =head2 Plugin C<tail_csv>
8437
8438 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8439 written by I<Snort>.
8440
8441 B<Synopsis:>
8442
8443  <Plugin "tail_csv">
8444    <Metric "snort-dropped">
8445        Type "percent"
8446        Instance "dropped"
8447        Index 1
8448    </Metric>
8449    <File "/var/log/snort/snort.stats">
8450        Plugin "snortstats"
8451        Instance "eth0"
8452        Interval 600
8453        Collect "snort-dropped"
8454    </File>
8455  </Plugin>
8456
8457 The configuration consists of one or more B<Metric> blocks that define an index
8458 into the line of the CSV file and how this value is mapped to I<collectd's>
8459 internal representation. These are followed by one or more B<Instance> blocks
8460 which configure which file to read, in which interval and which metrics to
8461 extract.
8462
8463 =over 4
8464
8465 =item E<lt>B<Metric> I<Name>E<gt>
8466
8467 The B<Metric> block configures a new metric to be extracted from the statistics
8468 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8469 only used inside the B<Instance> blocks to refer to this block, so you can use
8470 one B<Metric> block for multiple CSV files.
8471
8472 =over 4
8473
8474 =item B<Type> I<Type>
8475
8476 Configures which I<Type> to use when dispatching this metric. Types are defined
8477 in the L<types.db(5)> file, see the appropriate manual page for more
8478 information on specifying types. Only types with a single I<data source> are
8479 supported by the I<tail_csv plugin>. The information whether the value is an
8480 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8481 I<Type's> definition.
8482
8483 =item B<Instance> I<TypeInstance>
8484
8485 If set, I<TypeInstance> is used to populate the type instance field of the
8486 created value lists. Otherwise, no type instance is used.
8487
8488 =item B<ValueFrom> I<Index>
8489
8490 Configure to read the value from the field with the zero-based index I<Index>.
8491 If the value is parsed as signed integer, unsigned integer or double depends on
8492 the B<Type> setting, see above.
8493
8494 =back
8495
8496 =item E<lt>B<File> I<Path>E<gt>
8497
8498 Each B<File> block represents one CSV file to read. There must be at least one
8499 I<File> block but there can be multiple if you have multiple CSV files.
8500
8501 =over 4
8502
8503 =item B<Plugin> I<Plugin>
8504
8505 Use I<Plugin> as the plugin name when submitting values.
8506 Defaults to C<tail_csv>.
8507
8508 =item B<Instance> I<PluginInstance>
8509
8510 Sets the I<plugin instance> used when dispatching the values.
8511
8512 =item B<Collect> I<Metric>
8513
8514 Specifies which I<Metric> to collect. This option must be specified at least
8515 once, and you can use this option multiple times to specify more than one
8516 metric to be extracted from this statistic file.
8517
8518 =item B<Interval> I<Seconds>
8519
8520 Configures the interval in which to read values from this instance / file.
8521 Defaults to the plugin's default interval.
8522
8523 =item B<TimeFrom> I<Index>
8524
8525 Rather than using the local time when dispatching a value, read the timestamp
8526 from the field with the zero-based index I<Index>. The value is interpreted as
8527 seconds since epoch. The value is parsed as a double and may be factional.
8528
8529 =back
8530
8531 =back
8532
8533 =head2 Plugin C<teamspeak2>
8534
8535 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8536 polls interesting global and virtual server data. The plugin can query only one
8537 physical server but unlimited virtual servers. You can use the following
8538 options to configure it:
8539
8540 =over 4
8541
8542 =item B<Host> I<hostname/ip>
8543
8544 The hostname or ip which identifies the physical server.
8545 Default: 127.0.0.1
8546
8547 =item B<Port> I<port>
8548
8549 The query port of the physical server. This needs to be a string.
8550 Default: "51234"
8551
8552 =item B<Server> I<port>
8553
8554 This option has to be added once for every virtual server the plugin should
8555 query. If you want to query the virtual server on port 8767 this is what the
8556 option would look like:
8557
8558   Server "8767"
8559
8560 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8561 use quotes around it! If no such statement is given only global information
8562 will be collected.
8563
8564 =back
8565
8566 =head2 Plugin C<ted>
8567
8568 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8569 measure power consumption. These devices are usually connected to a serial
8570 (RS232) or USB port. The plugin opens a configured device and tries to read the
8571 current energy readings. For more information on TED, visit
8572 L<http://www.theenergydetective.com/>.
8573
8574 Available configuration options:
8575
8576 =over 4
8577
8578 =item B<Device> I<Path>
8579
8580 Path to the device on which TED is connected. collectd will need read and write
8581 permissions on that file.
8582
8583 Default: B</dev/ttyUSB0>
8584
8585 =item B<Retries> I<Num>
8586
8587 Apparently reading from TED is not that reliable. You can therefore configure a
8588 number of retries here. You only configure the I<retries> here, to if you
8589 specify zero, one reading will be performed (but no retries if that fails); if
8590 you specify three, a maximum of four readings are performed. Negative values
8591 are illegal.
8592
8593 Default: B<0>
8594
8595 =back
8596
8597 =head2 Plugin C<tcpconns>
8598
8599 The C<tcpconns plugin> counts the number of currently established TCP
8600 connections based on the local port and/or the remote port. Since there may be
8601 a lot of connections the default if to count all connections with a local port,
8602 for which a listening socket is opened. You can use the following options to
8603 fine-tune the ports you are interested in:
8604
8605 =over 4
8606
8607 =item B<ListeningPorts> I<true>|I<false>
8608
8609 If this option is set to I<true>, statistics for all local ports for which a
8610 listening socket exists are collected. The default depends on B<LocalPort> and
8611 B<RemotePort> (see below): If no port at all is specifically selected, the
8612 default is to collect listening ports. If specific ports (no matter if local or
8613 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8614 the selected ports will be collected unless this option is set to I<true>
8615 specifically.
8616
8617 =item B<LocalPort> I<Port>
8618
8619 Count the connections to a specific local port. This can be used to see how
8620 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8621 You have to specify the port in numeric form, so for the mailserver example
8622 you'd need to set B<25>.
8623
8624 =item B<RemotePort> I<Port>
8625
8626 Count the connections to a specific remote port. This is useful to see how
8627 much a remote service is used. This is most useful if you want to know how many
8628 connections a local service has opened to remote services, e.E<nbsp>g. how many
8629 connections a mail server or news server has to other mail or news servers, or
8630 how many connections a web proxy holds to web servers. You have to give the
8631 port in numeric form.
8632
8633 =item B<AllPortsSummary> I<true>|I<false>
8634
8635 If this option is set to I<true> a summary of statistics from all connections
8636 are collected. This option defaults to I<false>.
8637
8638 =back
8639
8640 =head2 Plugin C<thermal>
8641
8642 =over 4
8643
8644 =item B<ForceUseProcfs> I<true>|I<false>
8645
8646 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8647 C<sysfs> interface. If that is not available, the plugin falls back to the
8648 C<procfs> interface. By setting this option to I<true>, you can force the
8649 plugin to use the latter. This option defaults to I<false>.
8650
8651 =item B<Device> I<Device>
8652
8653 Selects the name of the thermal device that you want to collect or ignore,
8654 depending on the value of the B<IgnoreSelected> option. This option may be
8655 used multiple times to specify a list of devices.
8656
8657 See F</"IGNORELISTS"> for details.
8658
8659 =item B<IgnoreSelected> I<true>|I<false>
8660
8661 Invert the selection: If set to true, all devices B<except> the ones that
8662 match the device names specified by the B<Device> option are collected. By
8663 default only selected devices are collected if a selection is made. If no
8664 selection is configured at all, B<all> devices are selected.
8665
8666 =back
8667
8668 =head2 Plugin C<threshold>
8669
8670 The I<Threshold plugin> checks values collected or received by I<collectd>
8671 against a configurable I<threshold> and issues I<notifications> if values are
8672 out of bounds.
8673
8674 Documentation for this plugin is available in the L<collectd-threshold(5)>
8675 manual page.
8676
8677 =head2 Plugin C<tokyotyrant>
8678
8679 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8680 couple metrics: number of records, and database size on disk.
8681
8682 =over 4
8683
8684 =item B<Host> I<Hostname/IP>
8685
8686 The hostname or IP which identifies the server.
8687 Default: B<127.0.0.1>
8688
8689 =item B<Port> I<Service/Port>
8690
8691 The query port of the server. This needs to be a string, even if the port is
8692 given in its numeric form.
8693 Default: B<1978>
8694
8695 =back
8696
8697 =head2 Plugin C<turbostat>
8698
8699 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8700 Intel processors by using I<Model Specific Registers>.
8701
8702 =over 4
8703
8704 =item B<CoreCstates> I<Bitmask(Integer)>
8705
8706 Bit mask of the list of core C-states supported by the processor.
8707 This option should only be used if the automated detection fails.
8708 Default value extracted from the CPU model and family.
8709
8710 Currently supported C-states (by this plugin): 3, 6, 7
8711
8712 B<Example:>
8713
8714   All states (3, 6 and 7):
8715   (1<<3) + (1<<6) + (1<<7) = 392
8716
8717 =item B<PackageCstates> I<Bitmask(Integer)>
8718
8719 Bit mask of the list of packages C-states supported by the processor. This
8720 option should only be used if the automated detection fails. Default value
8721 extracted from the CPU model and family.
8722
8723 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8724
8725 B<Example:>
8726
8727   States 2, 3, 6 and 7:
8728   (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8729
8730 =item B<SystemManagementInterrupt> I<true>|I<false>
8731
8732 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8733 This option should only be used if the automated detection fails or if you want
8734 to disable this feature.
8735
8736 =item B<DigitalTemperatureSensor> I<true>|I<false>
8737
8738 Boolean enabling the collection of the temperature of each core. This option
8739 should only be used if the automated detection fails or if you want to disable
8740 this feature.
8741
8742 =item B<TCCActivationTemp> I<Temperature>
8743
8744 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8745 temperature is used when collecting the temperature of cores or packages. This
8746 option should only be used if the automated detection fails. Default value
8747 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8748
8749 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8750
8751 Bit mask of the list of elements to be thermally monitored. This option should
8752 only be used if the automated detection fails or if you want to disable some
8753 collections. The different bits of this bit mask accepted by this plugin are:
8754
8755 =over 4
8756
8757 =item 0 ('1'): Package
8758
8759 =item 1 ('2'): DRAM
8760
8761 =item 2 ('4'): Cores
8762
8763 =item 3 ('8'): Embedded graphic device
8764
8765 =back
8766
8767 =item B<LogicalCoreNames> I<true>|I<false>
8768
8769 Boolean enabling the use of logical core numbering for per core statistics.
8770 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8771 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8772 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8773 more than one, where I<n> is the n-th core of package I<m>.
8774
8775 =back
8776
8777 =head2 Plugin C<unixsock>
8778
8779 =over 4
8780
8781 =item B<SocketFile> I<Path>
8782
8783 Sets the socket-file which is to be created.
8784
8785 =item B<SocketGroup> I<Group>
8786
8787 If running as root change the group of the UNIX-socket after it has been
8788 created. Defaults to B<collectd>.
8789
8790 =item B<SocketPerms> I<Permissions>
8791
8792 Change the file permissions of the UNIX-socket after it has been created. The
8793 permissions must be given as a numeric, octal value as you would pass to
8794 L<chmod(1)>. Defaults to B<0770>.
8795
8796 =item B<DeleteSocket> B<false>|B<true>
8797
8798 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8799 with the given name already exists. If I<collectd> crashes a socket file may be
8800 left over, preventing the daemon from opening a new socket when restarted.
8801 Since this is potentially dangerous, this defaults to B<false>.
8802
8803 =back
8804
8805 =head2 Plugin C<uuid>
8806
8807 This plugin, if loaded, causes the Hostname to be taken from the machine's
8808 UUID. The UUID is a universally unique designation for the machine, usually
8809 taken from the machine's BIOS. This is most useful if the machine is running in
8810 a virtual environment such as Xen, in which case the UUID is preserved across
8811 shutdowns and migration.
8812
8813 The following methods are used to find the machine's UUID, in order:
8814
8815 =over 4
8816
8817 =item *
8818
8819 Check I</etc/uuid> (or I<UUIDFile>).
8820
8821 =item *
8822
8823 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8824 present.
8825
8826 =item *
8827
8828 Check for UUID from C<dmidecode> / SMBIOS.
8829
8830 =item *
8831
8832 Check for UUID from Xen hypervisor.
8833
8834 =back
8835
8836 If no UUID can be found then the hostname is not modified.
8837
8838 =over 4
8839
8840 =item B<UUIDFile> I<Path>
8841
8842 Take the UUID from the given file (default I</etc/uuid>).
8843
8844 =back
8845
8846 =head2 Plugin C<varnish>
8847
8848 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8849 It collects a subset of the values displayed by L<varnishstat(1)>, and
8850 organizes them in categories which can be enabled or disabled. Currently only
8851 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8852 meaning of each metric can be found in L<varnish-counters(7)>.
8853
8854 Synopsis:
8855
8856  <Plugin "varnish">
8857    <Instance "example">
8858      CollectBackend     true
8859      CollectBan         false
8860      CollectCache       true
8861      CollectConnections true
8862      CollectDirectorDNS false
8863      CollectESI         false
8864      CollectFetch       false
8865      CollectHCB         false
8866      CollectObjects     false
8867      CollectPurge       false
8868      CollectSession     false
8869      CollectSHM         true
8870      CollectSMA         false
8871      CollectSMS         false
8872      CollectSM          false
8873      CollectStruct      false
8874      CollectTotals      false
8875      CollectUptime      false
8876      CollectVCL         false
8877      CollectVSM         false
8878      CollectWorkers     false
8879      CollectLock        false
8880      CollectMempool     false
8881      CollectManagement  false
8882      CollectSMF         false
8883      CollectVBE         false
8884      CollectMSE         false
8885    </Instance>
8886  </Plugin>
8887
8888 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8889 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8890 will collectd statistics from the default "varnishd" instance (this should work
8891 fine in most cases).
8892
8893 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8894
8895 =over 4
8896
8897 =item B<CollectBackend> B<true>|B<false>
8898
8899 Back-end connection statistics, such as successful, reused,
8900 and closed connections. True by default.
8901
8902 =item B<CollectBan> B<true>|B<false>
8903
8904 Statistics about ban operations, such as number of bans added, retired, and
8905 number of objects tested against ban operations. Only available with Varnish
8906 3.x and above. False by default.
8907
8908 =item B<CollectCache> B<true>|B<false>
8909
8910 Cache hits and misses. True by default.
8911
8912 =item B<CollectConnections> B<true>|B<false>
8913
8914 Number of client connections received, accepted and dropped. True by default.
8915
8916 =item B<CollectDirectorDNS> B<true>|B<false>
8917
8918 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8919 default.
8920
8921 =item B<CollectESI> B<true>|B<false>
8922
8923 Edge Side Includes (ESI) parse statistics. False by default.
8924
8925 =item B<CollectFetch> B<true>|B<false>
8926
8927 Statistics about fetches (HTTP requests sent to the backend). False by default.
8928
8929 =item B<CollectHCB> B<true>|B<false>
8930
8931 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8932 divided into locked and unlocked look-ups. False by default.
8933
8934 =item B<CollectObjects> B<true>|B<false>
8935
8936 Statistics on cached objects: number of objects expired, nuked (prematurely
8937 expired), saved, moved, etc. False by default.
8938
8939 =item B<CollectPurge> B<true>|B<false>
8940
8941 Statistics about purge operations, such as number of purges added, retired, and
8942 number of objects tested against purge operations. Only available with Varnish
8943 2.x. False by default.
8944
8945 =item B<CollectSession> B<true>|B<false>
8946
8947 Client session statistics. Number of past and current sessions, session herd and
8948 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8949 metrics found in the Connections and Threads sections with previous versions of
8950 Varnish have been moved here.
8951
8952 =item B<CollectSHM> B<true>|B<false>
8953
8954 Statistics about the shared memory log, a memory region to store
8955 log messages which is flushed to disk when full. True by default.
8956
8957 =item B<CollectSMA> B<true>|B<false>
8958
8959 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8960 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8961 only the one used by the Varnish instance. Only available with Varnish 2.x.
8962 False by default.
8963
8964 =item B<CollectSMS> B<true>|B<false>
8965
8966 synth (synthetic content) storage statistics. This storage
8967 component is used internally only. False by default.
8968
8969 =item B<CollectSM> B<true>|B<false>
8970
8971 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8972 in varnish 4.x. use CollectSMF.
8973 False by default.
8974
8975 =item B<CollectStruct> B<true>|B<false>
8976
8977 Current varnish internal state statistics. Number of current sessions, objects
8978 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8979 default.
8980
8981 =item B<CollectTotals> B<true>|B<false>
8982
8983 Collects overview counters, such as the number of sessions created,
8984 the number of requests and bytes transferred. False by default.
8985
8986 =item B<CollectUptime> B<true>|B<false>
8987
8988 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8989
8990 =item B<CollectVCL> B<true>|B<false>
8991
8992 Number of total (available + discarded) VCL (config files). False by default.
8993
8994 =item B<CollectVSM> B<true>|B<false>
8995
8996 Collect statistics about Varnish's shared memory usage (used by the logging and
8997 statistics subsystems). Only available with Varnish 4.x. False by default.
8998
8999 =item B<CollectWorkers> B<true>|B<false>
9000
9001 Collect statistics about worker threads. False by default.
9002
9003 =item B<CollectVBE> B<true>|B<false>
9004
9005 Backend counters. Only available with Varnish 4.x. False by default.
9006
9007 =item B<CollectSMF> B<true>|B<false>
9008
9009 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9010 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9011 instance. Used to be called SM in Varnish 2.x. False by default.
9012
9013 =item B<CollectManagement> B<true>|B<false>
9014
9015 Management process counters. Only available with Varnish 4.x. False by default.
9016
9017 =item B<CollectLock> B<true>|B<false>
9018
9019 Lock counters. Only available with Varnish 4.x. False by default.
9020
9021 =item B<CollectMempool> B<true>|B<false>
9022
9023 Memory pool counters. Only available with Varnish 4.x. False by default.
9024
9025 =item B<CollectMSE> B<true>|B<false>
9026
9027 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9028 Varnish, replacing the traditional malloc and file storages. Only available
9029 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9030 one used by the Varnish instance. False by default.
9031
9032 =back
9033
9034 =head2 Plugin C<virt>
9035
9036 This plugin allows CPU, disk, network load and other metrics to be collected for
9037 virtualized guests on the machine. The statistics are collected through libvirt
9038 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9039 installing any additional software on guests, especially I<collectd>, which runs
9040 only on the host system.
9041
9042 Only I<Connection> is required.
9043
9044 =over 4
9045
9046 =item B<Connection> I<uri>
9047
9048 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9049
9050  Connection "xen:///"
9051
9052 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9053
9054 =item B<RefreshInterval> I<seconds>
9055
9056 Refresh the list of domains and devices every I<seconds>. The default is 60
9057 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9058 the list of domains and devices to be refreshed on every iteration.
9059
9060 Refreshing the devices in particular is quite a costly operation, so if your
9061 virtualization setup is static you might consider increasing this. If this
9062 option is set to 0, refreshing is disabled completely.
9063
9064 =item B<Domain> I<name>
9065
9066 =item B<BlockDevice> I<name:dev>
9067
9068 =item B<InterfaceDevice> I<name:dev>
9069
9070 =item B<IgnoreSelected> B<true>|B<false>
9071
9072 Select which domains and devices are collected.
9073
9074 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9075 disk/network devices are collected.
9076
9077 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9078 domains and disk/network devices are ignored, while the rest are collected.
9079
9080 The domain name and device names may use a regular expression, if the name is
9081 surrounded by I</.../> and collectd was compiled with support for regexps.
9082
9083 The default is to collect statistics for all domains and all their devices.
9084
9085 Example:
9086
9087  BlockDevice "/:hdb/"
9088  IgnoreSelected "true"
9089
9090 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9091 will be collected.
9092
9093 =item B<BlockDeviceFormat> B<target>|B<source>
9094
9095 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9096 seen by the guest will be used for reporting metrics.
9097 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9098 domain.
9099
9100 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9101 using the path of the source, e.g. an image file.
9102 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9103 domain.
9104
9105 B<Example:>
9106
9107 If the domain XML have the following device defined:
9108
9109   <disk type='block' device='disk'>
9110     <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9111     <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9112     <target dev='sda' bus='scsi'/>
9113     <boot order='2'/>
9114     <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9115   </disk>
9116
9117 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9118 to C<sda>.
9119 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9120 to C<var_lib_libvirt_images_image1.qcow2>.
9121
9122 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9123
9124 The B<BlockDeviceFormatBasename> controls whether the full path or the
9125 L<basename(1)> of the source is being used as the I<type instance> when
9126 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9127
9128 B<Example:>
9129
9130 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9131 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9132 be set to C<var_lib_libvirt_images_image1.qcow2>.
9133 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9134 set to C<image1.qcow2>.
9135
9136 =item B<HostnameFormat> B<name|uuid|hostname|...>
9137
9138 When the virt plugin logs data, it sets the hostname of the collected data
9139 according to this setting. The default is to use the guest name as provided by
9140 the hypervisor, which is equal to setting B<name>.
9141
9142 B<uuid> means use the guest's UUID. This is useful if you want to track the
9143 same guest across migrations.
9144
9145 B<hostname> means to use the global B<Hostname> setting, which is probably not
9146 useful on its own because all guests will appear to have the same name.
9147
9148 You can also specify combinations of these fields. For example B<name uuid>
9149 means to concatenate the guest name and UUID (with a literal colon character
9150 between, thus I<"foo:1234-1234-1234-1234">).
9151
9152 At the moment of writing (collectd-5.5), hostname string is limited to 62
9153 characters. In case when combination of fields exceeds 62 characters,
9154 hostname will be truncated without a warning.
9155
9156 =item B<InterfaceFormat> B<name>|B<address>
9157
9158 When the virt plugin logs interface data, it sets the name of the collected
9159 data according to this setting. The default is to use the path as provided by
9160 the hypervisor (the "dev" property of the target node), which is equal to
9161 setting B<name>.
9162
9163 B<address> means use the interface's mac address. This is useful since the
9164 interface path might change between reboots of a guest or across migrations.
9165
9166 =item B<PluginInstanceFormat> B<name|uuid|none>
9167
9168 When the virt plugin logs data, it sets the plugin_instance of the collected
9169 data according to this setting. The default is to not set the plugin_instance.
9170
9171 B<name> means use the guest's name as provided by the hypervisor.
9172 B<uuid> means use the guest's UUID.
9173
9174 You can also specify combinations of the B<name> and B<uuid> fields.
9175 For example B<name uuid> means to concatenate the guest name and UUID
9176 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9177
9178 =item B<Instances> B<integer>
9179
9180 How many read instances you want to use for this plugin. The default is one,
9181 and the sensible setting is a multiple of the B<ReadThreads> value.
9182 If you are not sure, just use the default setting.
9183
9184 =item B<ExtraStats> B<string>
9185
9186 Report additional extra statistics. The default is no extra statistics, preserving
9187 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9188 allows the plugin to reported more detailed statistics about the behaviour of
9189 Virtual Machines. The argument is a space-separated list of selectors.
9190
9191 Currently supported selectors are:
9192
9193 =over 4
9194
9195 =item B<cpu_util>: report CPU utilization per domain in percentage.
9196
9197 =item B<disk>: report extra statistics like number of flush operations and total
9198 service time for read, write and flush operations. Requires libvirt API version
9199 I<0.9.5> or later.
9200
9201 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9202 I<0.9.10> or later.
9203
9204 =item B<domain_state>: report domain state and reason in human-readable format as
9205 a notification. If libvirt API version I<0.9.2> or later is available, domain
9206 reason will be included in notification.
9207
9208 =item B<fs_info>: report file system information as a notification. Requires
9209 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9210 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9211 version supports retrieving  file system information.
9212
9213 =item B<job_stats_background>: report statistics about progress of a background
9214 job on a domain. Only one type of job statistics can be collected at the same time.
9215 Requires libvirt API version I<1.2.9> or later.
9216
9217 =item B<job_stats_completed>: report statistics about a recently completed job on
9218 a domain. Only one type of job statistics can be collected at the same time.
9219 Requires libvirt API version I<1.2.9> or later.
9220
9221 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9222 Requires libvirt API version I<0.9.11> or later.
9223
9224 =item B<perf>: report performance monitoring events. To collect performance
9225 metrics they must be enabled for domain and supported by the platform. Requires
9226 libvirt API version I<1.3.3> or later.
9227 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9228
9229 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9230
9231 =back
9232
9233 =item B<PersistentNotification> B<true>|B<false>
9234 Override default configuration to only send notifications when there is a change
9235 in the lifecycle state of a domain. When set to true notifications will be sent
9236 for every read cycle. Default is false. Does not affect the stats being
9237 dispatched.
9238
9239 =back
9240
9241 =head2 Plugin C<vmem>
9242
9243 The C<vmem> plugin collects information about the usage of virtual memory.
9244 Since the statistics provided by the Linux kernel are very detailed, they are
9245 collected very detailed. However, to get all the details, you have to switch
9246 them on manually. Most people just want an overview over, such as the number of
9247 pages read from swap space.
9248
9249 =over 4
9250
9251 =item B<Verbose> B<true>|B<false>
9252
9253 Enables verbose collection of information. This will start collecting page
9254 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9255 Part of these statistics are collected on a "per zone" basis.
9256
9257 =back
9258
9259 =head2 Plugin C<vserver>
9260
9261 This plugin doesn't have any options. B<VServer> support is only available for
9262 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9263 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9264 need to apply the patches and compile your own kernel, which will then provide
9265 the F</proc/virtual> filesystem that is required by this plugin.
9266
9267 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9268
9269 B<Note>: The traffic collected by this plugin accounts for the amount of
9270 traffic passing a socket which might be a lot less than the actual on-wire
9271 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9272 collect on-wire traffic you could, for example, use the logging facilities of
9273 iptables to feed data for the guest IPs into the iptables plugin.
9274
9275 =head2 Plugin C<write_graphite>
9276
9277 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9278 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9279 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9280 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9281 of at most 1428 bytes to minimize the number of network packets.
9282
9283 Synopsis:
9284
9285  <Plugin write_graphite>
9286    <Node "example">
9287      Host "localhost"
9288      Port "2003"
9289      Protocol "tcp"
9290      LogSendErrors true
9291      Prefix "collectd"
9292    </Node>
9293  </Plugin>
9294
9295 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9296 blocks. Inside the B<Node> blocks, the following options are recognized:
9297
9298 =over 4
9299
9300 =item B<Host> I<Address>
9301
9302 Hostname or address to connect to. Defaults to C<localhost>.
9303
9304 =item B<Port> I<Service>
9305
9306 Service name or port number to connect to. Defaults to C<2003>.
9307
9308 =item B<Protocol> I<String>
9309
9310 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9311
9312 =item B<ReconnectInterval> I<Seconds>
9313
9314 When set to non-zero, forces the connection to the Graphite backend to be
9315 closed and re-opend periodically. This behavior is desirable in environments
9316 where the connection to the Graphite backend is done through load balancers,
9317 for example. When set to zero, the default, the connetion is kept open for as
9318 long as possible.
9319
9320 =item B<LogSendErrors> B<false>|B<true>
9321
9322 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9323 If set to B<false>, it will not log the errors. This is especially useful when
9324 using Protocol UDP since many times we want to use the "fire-and-forget"
9325 approach and logging errors fills syslog with unneeded messages.
9326
9327 =item B<Prefix> I<String>
9328
9329 When set, I<String> is added in front of the host name. Dots and whitespace are
9330 I<not> escaped in this string (see B<EscapeCharacter> below).
9331
9332 =item B<Postfix> I<String>
9333
9334 When set, I<String> is appended to the host name. Dots and whitespace are
9335 I<not> escaped in this string (see B<EscapeCharacter> below).
9336
9337 =item B<EscapeCharacter> I<Char>
9338
9339 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9340 in the identifier. The B<EscapeCharacter> option determines which character
9341 dots, whitespace and control characters are replaced with. Defaults to
9342 underscore (C<_>).
9343
9344 =item B<StoreRates> B<false>|B<true>
9345
9346 If set to B<true> (the default), convert counter values to rates. If set to
9347 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9348 number.
9349
9350 =item B<SeparateInstances> B<false>|B<true>
9351
9352 If set to B<true>, the plugin instance and type instance will be in their own
9353 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9354 default), the plugin and plugin instance (and likewise the type and type
9355 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9356
9357 =item B<AlwaysAppendDS> B<false>|B<true>
9358
9359 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9360 identifier. If set to B<false> (the default), this is only done when there is
9361 more than one DS.
9362
9363 =item B<PreserveSeparator> B<false>|B<true>
9364
9365 If set to B<false> (the default) the C<.> (dot) character is replaced with
9366 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9367 is preserved, i.e. passed through.
9368
9369 =item B<DropDuplicateFields> B<false>|B<true>
9370
9371 If set to B<true>, detect and remove duplicate components in Graphite metric
9372 names. For example, the metric name  C<host.load.load.shortterm> will
9373 be shortened to C<host.load.shortterm>.
9374
9375 =back
9376
9377 =head2 Plugin C<write_log>
9378
9379 The C<write_log> plugin writes metrics as INFO log messages.
9380
9381 This plugin supports two output formats: I<Graphite> and I<JSON>.
9382
9383 Synopsis:
9384
9385  <Plugin write_log>
9386    Format Graphite
9387  </Plugin>
9388
9389 =over 4
9390
9391 =item B<Format> I<Format>
9392
9393 The output format to use. Can be one of C<Graphite> or C<JSON>.
9394
9395 =back
9396
9397 =head2 Plugin C<write_tsdb>
9398
9399 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9400 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9401 state daemon that ingests metrics and stores them in HBase. The plugin uses
9402 I<TCP> over the "line based" protocol with a default port 4242. The data will
9403 be sent in blocks of at most 1428 bytes to minimize the number of network
9404 packets.
9405
9406 Synopsis:
9407
9408  <Plugin write_tsdb>
9409    ResolveInterval 60
9410    ResolveJitter 60
9411    <Node "example">
9412      Host "tsd-1.my.domain"
9413      Port "4242"
9414      HostTags "status=production"
9415    </Node>
9416  </Plugin>
9417
9418 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9419 blocks and global directives.
9420
9421 Global directives are:
9422
9423 =over 4
9424
9425 =item B<ResolveInterval> I<seconds>
9426
9427 =item B<ResolveJitter> I<seconds>
9428
9429 When I<collectd> connects to a TSDB node, it will request the hostname from
9430 DNS. This can become a problem if the TSDB node is unavailable or badly
9431 configured because collectd will request DNS in order to reconnect for every
9432 metric, which can flood your DNS. So you can cache the last value for
9433 I<ResolveInterval> seconds.
9434 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9435
9436 You can also define a jitter, a random interval to wait in addition to
9437 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9438 hostname at the same time when the connection fails.
9439 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9440
9441 B<Note:> If the DNS resolution has already been successful when the socket
9442 closes, the plugin will try to reconnect immediately with the cached
9443 information. DNS is queried only when the socket is closed for a longer than
9444 I<ResolveInterval> + I<ResolveJitter> seconds.
9445
9446 =back
9447
9448 Inside the B<Node> blocks, the following options are recognized:
9449
9450 =over 4
9451
9452 =item B<Host> I<Address>
9453
9454 Hostname or address to connect to. Defaults to C<localhost>.
9455
9456 =item B<Port> I<Service>
9457
9458 Service name or port number to connect to. Defaults to C<4242>.
9459
9460
9461 =item B<HostTags> I<String>
9462
9463 When set, I<HostTags> is added to the end of the metric. It is intended to be
9464 used for name=value pairs that the TSD will tag the metric with. Dots and
9465 whitespace are I<not> escaped in this string.
9466
9467 =item B<StoreRates> B<false>|B<true>
9468
9469 If set to B<true>, convert counter values to rates. If set to B<false>
9470 (the default) counter values are stored as is, as an increasing
9471 integer number.
9472
9473 =item B<AlwaysAppendDS> B<false>|B<true>
9474
9475 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9476 identifier. If set to B<false> (the default), this is only done when there is
9477 more than one DS.
9478
9479 =back
9480
9481 =head2 Plugin C<write_mongodb>
9482
9483 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9484 NoSQL database.
9485
9486 B<Synopsis:>
9487
9488  <Plugin "write_mongodb">
9489    <Node "default">
9490      Host "localhost"
9491      Port "27017"
9492      Timeout 1000
9493      StoreRates true
9494    </Node>
9495  </Plugin>
9496
9497 The plugin can send values to multiple instances of I<MongoDB> by specifying
9498 one B<Node> block for each instance. Within the B<Node> blocks, the following
9499 options are available:
9500
9501 =over 4
9502
9503 =item B<Host> I<Address>
9504
9505 Hostname or address to connect to. Defaults to C<localhost>.
9506
9507 =item B<Port> I<Service>
9508
9509 Service name or port number to connect to. Defaults to C<27017>.
9510
9511 =item B<Timeout> I<Milliseconds>
9512
9513 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9514 Setting this option to zero means no timeout, which is the default.
9515
9516 =item B<StoreRates> B<false>|B<true>
9517
9518 If set to B<true> (the default), convert counter values to rates. If set to
9519 B<false> counter values are stored as is, i.e. as an increasing integer
9520 number.
9521
9522 =item B<Database> I<Database>
9523
9524 =item B<User> I<User>
9525
9526 =item B<Password> I<Password>
9527
9528 Sets the information used when authenticating to a I<MongoDB> database. The
9529 fields are optional (in which case no authentication is attempted), but if you
9530 want to use authentication all three fields must be set.
9531
9532 =back
9533
9534 =head2 Plugin C<write_prometheus>
9535
9536 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9537 using I<Prometheus>.
9538
9539 B<Options:>
9540
9541 =over 4
9542
9543 =item B<Port> I<Port>
9544
9545 Port the embedded webserver should listen on. Defaults to B<9103>.
9546
9547 =item B<StalenessDelta> I<Seconds>
9548
9549 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9550 hasn't seen any update for it. This value must match the setting in Prometheus.
9551 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9552
9553 B<Background:>
9554
9555 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9556 which time a metric without updates is considered "stale". This setting
9557 effectively puts an upper limit on the interval in which metrics are reported.
9558
9559 When the I<write_prometheus plugin> encounters a metric with an interval
9560 exceeding this limit, it will inform you, the user, and provide the metric to
9561 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9562 metric "fresh" each time it is scraped, with the time of the scrape being
9563 considered the time of the update. The result is that there appear more
9564 datapoints in I<Prometheus> than were actually created, but at least the metric
9565 doesn't disappear periodically.
9566
9567 =back
9568
9569 =head2 Plugin C<write_http>
9570
9571 This output plugin submits values to an HTTP server using POST requests and
9572 encoding metrics with JSON or using the C<PUTVAL> command described in
9573 L<collectd-unixsock(5)>.
9574
9575 Synopsis:
9576
9577  <Plugin "write_http">
9578    <Node "example">
9579      URL "http://example.com/post-collectd"
9580      User "collectd"
9581      Password "weCh3ik0"
9582      Format JSON
9583    </Node>
9584  </Plugin>
9585
9586 The plugin can send values to multiple HTTP servers by specifying one
9587 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9588 block, the following options are available:
9589
9590 =over 4
9591
9592 =item B<URL> I<URL>
9593
9594 URL to which the values are submitted to. Mandatory.
9595
9596 =item B<User> I<Username>
9597
9598 Optional user name needed for authentication.
9599
9600 =item B<Password> I<Password>
9601
9602 Optional password needed for authentication.
9603
9604 =item B<VerifyPeer> B<true>|B<false>
9605
9606 Enable or disable peer SSL certificate verification. See
9607 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9608
9609 =item B<VerifyHost> B<true|false>
9610
9611 Enable or disable peer host name verification. If enabled, the plugin checks if
9612 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9613 matches the host name provided by the B<URL> option. If this identity check
9614 fails, the connection is aborted. Obviously, only works when connecting to a
9615 SSL enabled server. Enabled by default.
9616
9617 =item B<CACert> I<File>
9618
9619 File that holds one or more SSL certificates. If you want to use HTTPS you will
9620 possibly need this option. What CA certificates come bundled with C<libcurl>
9621 and are checked by default depends on the distribution you use.
9622
9623 =item B<CAPath> I<Directory>
9624
9625 Directory holding one or more CA certificate files. You can use this if for
9626 some reason all the needed CA certificates aren't in the same file and can't be
9627 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9628 OpenSSL.
9629
9630 =item B<ClientKey> I<File>
9631
9632 File that holds the private key in PEM format to be used for certificate-based
9633 authentication.
9634
9635 =item B<ClientCert> I<File>
9636
9637 File that holds the SSL certificate to be used for certificate-based
9638 authentication.
9639
9640 =item B<ClientKeyPass> I<Password>
9641
9642 Password required to load the private key in B<ClientKey>.
9643
9644 =item B<Header> I<Header>
9645
9646 A HTTP header to add to the request.  Multiple headers are added if this option is specified more than once.  Example:
9647
9648   Header "X-Custom-Header: custom_value"
9649
9650 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9651
9652 Define which SSL protocol version must be used. By default C<libcurl> will
9653 attempt to figure out the remote SSL protocol version. See
9654 L<curl_easy_setopt(3)> for more details.
9655
9656 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9657
9658 Format of the output to generate. If set to B<Command>, will create output that
9659 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9660 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9661 , will create output in the KairosDB format.
9662
9663 Defaults to B<Command>.
9664
9665 =item B<Attribute> I<String> I<String>
9666
9667 Only available for the KAIROSDB output format.
9668
9669 Consider the two given strings to be the key and value of an additional tag for
9670 each metric being sent out.
9671
9672 You can add multiple B<Attribute>.
9673
9674 =item B<TTL> I<Int>
9675
9676 Only available for the KAIROSDB output format.
9677
9678 Sets the Cassandra ttl for the data points.
9679
9680 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9681
9682 =item B<Prefix> I<String>
9683
9684 Only available for the KAIROSDB output format.
9685
9686 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9687
9688 =item B<Metrics> B<true>|B<false>
9689
9690 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9691
9692 =item B<Notifications> B<false>|B<true>
9693
9694 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9695
9696 =item B<StoreRates> B<true|false>
9697
9698 If set to B<true>, convert counter values to rates. If set to B<false> (the
9699 default) counter values are stored as is, i.e. as an increasing integer number.
9700
9701 =item B<BufferSize> I<Bytes>
9702
9703 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9704 requests will be generated, but more metrics will be batched / metrics are
9705 cached for longer before being sent, introducing additional delay until they
9706 are available on the server side. I<Bytes> must be at least 1024 and cannot
9707 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9708 Defaults to C<4096>.
9709
9710 =item B<LowSpeedLimit> I<Bytes per Second>
9711
9712 Sets the minimal transfer rate in I<Bytes per Second> below which the
9713 connection with the HTTP server will be considered too slow and aborted. All
9714 the data submitted over this connection will probably be lost. Defaults to 0,
9715 which means no minimum transfer rate is enforced.
9716
9717 =item B<Timeout> I<Timeout>
9718
9719 Sets the maximum time in milliseconds given for HTTP POST operations to
9720 complete. When this limit is reached, the POST operation will be aborted, and
9721 all the data in the current send buffer will probably be lost. Defaults to 0,
9722 which means the connection never times out.
9723
9724 =item B<LogHttpError> B<false>|B<true>
9725
9726 Enables printing of HTTP error code to log. Turned off by default.
9727
9728 The C<write_http> plugin regularly submits the collected values to the HTTP
9729 server. How frequently this happens depends on how much data you are collecting
9730 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9731 slightly below this interval, which you can estimate by monitoring the network
9732 traffic between collectd and the HTTP server.
9733
9734 =back
9735
9736 =head2 Plugin C<write_kafka>
9737
9738 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9739 queue.
9740 Synopsis:
9741
9742  <Plugin "write_kafka">
9743    Property "metadata.broker.list" "broker1:9092,broker2:9092"
9744    <Topic "collectd">
9745      Format JSON
9746    </Topic>
9747  </Plugin>
9748
9749 The following options are understood by the I<write_kafka plugin>:
9750
9751 =over 4
9752
9753 =item E<lt>B<Topic> I<Name>E<gt>
9754
9755 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9756 is given a unique I<Name> and specifies one kafka producer.
9757 Inside the B<Topic> block, the following per-topic options are
9758 understood:
9759
9760 =over 4
9761
9762 =item B<Property> I<String> I<String>
9763
9764 Configure the named property for the current topic. Properties are
9765 forwarded to the kafka producer library B<librdkafka>.
9766
9767 =item B<Key> I<String>
9768
9769 Use the specified string as a partitioning key for the topic. Kafka breaks
9770 topic into partitions and guarantees that for a given topology, the same
9771 consumer will be used for a specific key. The special (case insensitive)
9772 string B<Random> can be used to specify that an arbitrary partition should
9773 be used.
9774
9775 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9776
9777 Selects the format in which messages are sent to the broker. If set to
9778 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9779 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9780
9781 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9782 an easy and straight forward exchange format.
9783
9784 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9785 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9786
9787 =item B<StoreRates> B<true>|B<false>
9788
9789 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9790 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9791 default), no conversion is performed. Otherwise the conversion is performed
9792 using the internal value cache.
9793
9794 Please note that currently this option is only used if the B<Format> option has
9795 been set to B<JSON>.
9796
9797 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9798
9799 A prefix can be added in the metric name when outputting in the I<Graphite>
9800 format. It's added before the I<Host> name.
9801 Metric name will be
9802 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>>
9803
9804 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9805
9806 A postfix can be added in the metric name when outputting in the I<Graphite>
9807 format. It's added after the I<Host> name.
9808 Metric name will be
9809 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>>
9810
9811 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9812
9813 Specify a character to replace dots (.) in the host part of the metric name.
9814 In I<Graphite> metric name, dots are used as separators between different
9815 metric parts (host, plugin, type).
9816 Default is C<_> (I<Underscore>).
9817
9818 =item B<GraphiteSeparateInstances> B<false>|B<true>
9819
9820 If set to B<true>, the plugin instance and type instance will be in their own
9821 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9822 default), the plugin and plugin instance (and likewise the type and type
9823 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9824
9825 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9826
9827 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9828 identifier. If set to B<false> (the default), this is only done when there is
9829 more than one DS.
9830
9831 =item B<GraphitePreserveSeparator> B<false>|B<true>
9832
9833 If set to B<false> (the default) the C<.> (dot) character is replaced with
9834 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9835 is preserved, i.e. passed through.
9836
9837 =item B<StoreRates> B<true>|B<false>
9838
9839 If set to B<true> (the default), convert counter values to rates. If set to
9840 B<false> counter values are stored as is, i.e. as an increasing integer number.
9841
9842 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9843 converted values will have "rate" appended to the data source type, e.g.
9844 C<ds_type:derive:rate>.
9845
9846 =back
9847
9848 =item B<Property> I<String> I<String>
9849
9850 Configure the kafka producer through properties, you almost always will
9851 want to set B<metadata.broker.list> to your Kafka broker list.
9852
9853 =back
9854
9855 =head2 Plugin C<write_redis>
9856
9857 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9858
9859 Synopsis:
9860
9861   <Plugin "write_redis">
9862     <Node "example">
9863         Host "localhost"
9864         Port "6379"
9865         Timeout 1000
9866         Prefix "collectd/"
9867         Database 1
9868         MaxSetSize -1
9869         MaxSetDuration -1
9870         StoreRates true
9871     </Node>
9872   </Plugin>
9873
9874 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9875 the timestamp as the score. Retrieving a date range can then be done using the
9876 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9877 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9878 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9879 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9880 with the B<Database> parameter (default is C<0>). See
9881 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9882 details.
9883
9884 The information shown in the synopsis above is the I<default configuration>
9885 which is used by the plugin if no configuration is present.
9886
9887 The plugin can send values to multiple instances of I<Redis> by specifying
9888 one B<Node> block for each instance. Within the B<Node> blocks, the following
9889 options are available:
9890
9891 =over 4
9892
9893 =item B<Node> I<Nodename>
9894
9895 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9896 instance running on a specified host and port. The node name is a
9897 canonical identifier which is used as I<plugin instance>. It is limited to
9898 51E<nbsp>characters in length.
9899
9900 =item B<Host> I<Hostname>
9901
9902 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9903 running on.
9904
9905 =item B<Port> I<Port>
9906
9907 The B<Port> option is the TCP port on which the Redis instance accepts
9908 connections. Either a service name of a port number may be given. Please note
9909 that numerical port numbers must be given as a string, too.
9910
9911 =item B<Timeout> I<Milliseconds>
9912
9913 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9914
9915 =item B<Prefix> I<Prefix>
9916
9917 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9918 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9919 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9920 is recommended but not required to include a trailing slash in I<Prefix>.
9921
9922 =item B<Database> I<Index>
9923
9924 This index selects the redis database to use for writing operations. Defaults
9925 to C<0>.
9926
9927 =item B<MaxSetSize> I<Items>
9928
9929 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9930 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9931
9932 =item B<MaxSetDuration> I<Seconds>
9933
9934 The B<MaxSetDuration> option limits the duration of items that the
9935 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9936 is the default behavior.
9937
9938 =item B<StoreRates> B<true>|B<false>
9939
9940 If set to B<true> (the default), convert counter values to rates. If set to
9941 B<false> counter values are stored as is, i.e. as an increasing integer number.
9942
9943 =back
9944
9945 =head2 Plugin C<write_riemann>
9946
9947 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9948 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9949 I<Riemann> using UDP packets.
9950
9951 Synopsis:
9952
9953  <Plugin "write_riemann">
9954    <Node "example">
9955      Host "localhost"
9956      Port "5555"
9957      Protocol UDP
9958      StoreRates true
9959      AlwaysAppendDS false
9960      TTLFactor 2.0
9961    </Node>
9962    Tag "foobar"
9963    Attribute "foo" "bar"
9964  </Plugin>
9965
9966 The following options are understood by the I<write_riemann plugin>:
9967
9968 =over 4
9969
9970 =item E<lt>B<Node> I<Name>E<gt>
9971
9972 The plugin's configuration consists of one or more B<Node> blocks. Each block
9973 is given a unique I<Name> and specifies one connection to an instance of
9974 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9975 understood:
9976
9977 =over 4
9978
9979 =item B<Host> I<Address>
9980
9981 Hostname or address to connect to. Defaults to C<localhost>.
9982
9983 =item B<Port> I<Service>
9984
9985 Service name or port number to connect to. Defaults to C<5555>.
9986
9987 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9988
9989 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9990 B<TCP>.
9991
9992 =item B<TLSCertFile> I<Path>
9993
9994 When using the B<TLS> protocol, path to a PEM certificate to present
9995 to remote host.
9996
9997 =item B<TLSCAFile> I<Path>
9998
9999 When using the B<TLS> protocol, path to a PEM CA certificate to
10000 use to validate the remote hosts's identity.
10001
10002 =item B<TLSKeyFile> I<Path>
10003
10004 When using the B<TLS> protocol, path to a PEM private key associated
10005 with the certificate defined by B<TLSCertFile>.
10006
10007 =item B<Batch> B<true>|B<false>
10008
10009 If set to B<true> and B<Protocol> is set to B<TCP>,
10010 events will be batched in memory and flushed at
10011 regular intervals or when B<BatchMaxSize> is exceeded.
10012
10013 Notifications are not batched and sent as soon as possible.
10014
10015 When enabled, it can occur that events get processed by the Riemann server
10016 close to or after their expiration time. Tune the B<TTLFactor> and
10017 B<BatchMaxSize> settings according to the amount of values collected, if this
10018 is an issue.
10019
10020 Defaults to true
10021
10022 =item B<BatchMaxSize> I<size>
10023
10024 Maximum payload size for a riemann packet. Defaults to 8192
10025
10026 =item B<BatchFlushTimeout> I<seconds>
10027
10028 Maximum amount of seconds to wait in between to batch flushes.
10029 No timeout by default.
10030
10031 =item B<StoreRates> B<true>|B<false>
10032
10033 If set to B<true> (the default), convert counter values to rates. If set to
10034 B<false> counter values are stored as is, i.e. as an increasing integer number.
10035
10036 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10037 converted values will have "rate" appended to the data source type, e.g.
10038 C<ds_type:derive:rate>.
10039
10040 =item B<AlwaysAppendDS> B<false>|B<true>
10041
10042 If set to B<true>, append the name of the I<Data Source> (DS) to the
10043 "service", i.e. the field that, together with the "host" field, uniquely
10044 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10045 only done when there is more than one DS.
10046
10047 =item B<TTLFactor> I<Factor>
10048
10049 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10050 event is considered active. I<collectd> populates this field based on the
10051 metrics interval setting. This setting controls the factor with which the
10052 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10053 know exactly what you're doing, you should only increase this setting from its
10054 default value.
10055
10056 =item B<Notifications> B<false>|B<true>
10057
10058 If set to B<true>, create riemann events for notifications. This is B<true>
10059 by default. When processing thresholds from write_riemann, it might prove
10060 useful to avoid getting notification events.
10061
10062 =item B<CheckThresholds> B<false>|B<true>
10063
10064 If set to B<true>, attach state to events based on thresholds defined
10065 in the B<Threshold> plugin. Defaults to B<false>.
10066
10067 =item B<EventServicePrefix> I<String>
10068
10069 Add the given string as a prefix to the event service name.
10070 If B<EventServicePrefix> not set or set to an empty string (""),
10071 no prefix will be used.
10072
10073 =back
10074
10075 =item B<Tag> I<String>
10076
10077 Add the given string as an additional tag to the metric being sent to
10078 I<Riemann>.
10079
10080 =item B<Attribute> I<String> I<String>
10081
10082 Consider the two given strings to be the key and value of an additional
10083 attribute for each metric being sent out to I<Riemann>.
10084
10085 =back
10086
10087 =head2 Plugin C<write_sensu>
10088
10089 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10090 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10091 a local I<Sensu> client using a TCP socket.
10092
10093 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10094 parameter so it is not possible to use one collectd instance as a gateway for
10095 others. Each collectd host must pair with one I<Sensu> client.
10096
10097 Synopsis:
10098
10099  <Plugin "write_sensu">
10100    <Node "example">
10101      Host "localhost"
10102      Port "3030"
10103      StoreRates true
10104      AlwaysAppendDS false
10105      MetricHandler "influx"
10106      MetricHandler "default"
10107      NotificationHandler "flapjack"
10108      NotificationHandler "howling_monkey"
10109      Notifications true
10110    </Node>
10111    Tag "foobar"
10112    Attribute "foo" "bar"
10113  </Plugin>
10114
10115 The following options are understood by the I<write_sensu plugin>:
10116
10117 =over 4
10118
10119 =item E<lt>B<Node> I<Name>E<gt>
10120
10121 The plugin's configuration consists of one or more B<Node> blocks. Each block
10122 is given a unique I<Name> and specifies one connection to an instance of
10123 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10124 understood:
10125
10126 =over 4
10127
10128 =item B<Host> I<Address>
10129
10130 Hostname or address to connect to. Defaults to C<localhost>.
10131
10132 =item B<Port> I<Service>
10133
10134 Service name or port number to connect to. Defaults to C<3030>.
10135
10136 =item B<StoreRates> B<true>|B<false>
10137
10138 If set to B<true> (the default), convert counter values to rates. If set to
10139 B<false> counter values are stored as is, i.e. as an increasing integer number.
10140
10141 This will be reflected in the C<collectd_data_source_type> tag: If
10142 B<StoreRates> is enabled, converted values will have "rate" appended to the
10143 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
10144
10145 =item B<AlwaysAppendDS> B<false>|B<true>
10146
10147 If set the B<true>, append the name of the I<Data Source> (DS) to the
10148 "service", i.e. the field that, together with the "host" field, uniquely
10149 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10150 only done when there is more than one DS.
10151
10152 =item B<Notifications> B<false>|B<true>
10153
10154 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10155 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10156
10157 =item B<Metrics> B<false>|B<true>
10158
10159 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10160 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10161
10162
10163 =item B<Separator> I<String>
10164
10165 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10166
10167 =item B<MetricHandler> I<String>
10168
10169 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10170 several of them, one per line. Defaults to no handler.
10171
10172 =item B<NotificationHandler> I<String>
10173
10174 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10175 add several of them, one per line. Defaults to no handler.
10176
10177 =item B<EventServicePrefix> I<String>
10178
10179 Add the given string as a prefix to the event service name.
10180 If B<EventServicePrefix> not set or set to an empty string (""),
10181 no prefix will be used.
10182
10183 =back
10184
10185 =item B<Tag> I<String>
10186
10187 Add the given string as an additional tag to the metric being sent to
10188 I<Sensu>.
10189
10190 =item B<Attribute> I<String> I<String>
10191
10192 Consider the two given strings to be the key and value of an additional
10193 attribute for each metric being sent out to I<Sensu>.
10194
10195 =back
10196
10197 =head2 Plugin C<xencpu>
10198
10199 This plugin collects metrics of hardware CPU load for machine running Xen
10200 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10201 Result is reported using the C<percent> type, for each CPU (core).
10202
10203 This plugin doesn't have any options (yet).
10204
10205 =head2 Plugin C<zookeeper>
10206
10207 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10208 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
10209 client port.
10210
10211 B<Synopsis:>
10212
10213  <Plugin "zookeeper">
10214    Host "127.0.0.1"
10215    Port "2181"
10216  </Plugin>
10217
10218 =over 4
10219
10220 =item B<Host> I<Address>
10221
10222 Hostname or address to connect to. Defaults to C<localhost>.
10223
10224 =item B<Port> I<Service>
10225
10226 Service name or port number to connect to. Defaults to C<2181>.
10227
10228 =back
10229
10230 =head1 THRESHOLD CONFIGURATION
10231
10232 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10233 we mean that the values are not only stored or sent somewhere, but that they
10234 are judged and, if a problem is recognized, acted upon. The only action
10235 collectd takes itself is to generate and dispatch a "notification". Plugins can
10236 register to receive notifications and perform appropriate further actions.
10237
10238 Since systems and what you expect them to do differ a lot, you can configure
10239 B<thresholds> for your values freely. This gives you a lot of flexibility but
10240 also a lot of responsibility.
10241
10242 Every time a value is out of range a notification is dispatched. This means
10243 that the idle percentage of your CPU needs to be less then the configured
10244 threshold only once for a notification to be generated. There's no such thing
10245 as a moving average or similar - at least not now.
10246
10247 Also, all values that match a threshold are considered to be relevant or
10248 "interesting". As a consequence collectd will issue a notification if they are
10249 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10250 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10251 "2" (the default) and some hosts sends it's CPU statistics to the server every
10252 60 seconds, a notification will be dispatched after about 120 seconds. It may
10253 take a little longer because the timeout is checked only once each B<Interval>
10254 on the server.
10255
10256 When a value comes within range again or is received after it was missing, an
10257 "OKAY-notification" is dispatched.
10258
10259 Here is a configuration example to get you started. Read below for more
10260 information.
10261
10262  <Plugin threshold>
10263    <Type "foo">
10264      WarningMin    0.00
10265      WarningMax 1000.00
10266      FailureMin    0.00
10267      FailureMax 1200.00
10268      Invert false
10269      Instance "bar"
10270    </Type>
10271
10272    <Plugin "interface">
10273      Instance "eth0"
10274      <Type "if_octets">
10275        FailureMax 10000000
10276        DataSource "rx"
10277      </Type>
10278    </Plugin>
10279
10280    <Host "hostname">
10281      <Type "cpu">
10282        Instance "idle"
10283        FailureMin 10
10284      </Type>
10285
10286      <Plugin "memory">
10287        <Type "memory">
10288          Instance "cached"
10289          WarningMin 100000000
10290        </Type>
10291      </Plugin>
10292    </Host>
10293  </Plugin>
10294
10295 There are basically two types of configuration statements: The C<Host>,
10296 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10297 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10298 C<Instance> option. You can combine the block by nesting the blocks, though
10299 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10300 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10301 C<Type> may not contain other blocks. If multiple blocks apply to the same
10302 value the most specific block is used.
10303
10304 The other statements specify the threshold to configure. They B<must> be
10305 included in a C<Type> block. Currently the following statements are recognized:
10306
10307 =over 4
10308
10309 =item B<FailureMax> I<Value>
10310
10311 =item B<WarningMax> I<Value>
10312
10313 Sets the upper bound of acceptable values. If unset defaults to positive
10314 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10315 will be created. If the value is greater than B<WarningMax> but less than (or
10316 equal to) B<FailureMax> a B<WARNING> notification will be created.
10317
10318 =item B<FailureMin> I<Value>
10319
10320 =item B<WarningMin> I<Value>
10321
10322 Sets the lower bound of acceptable values. If unset defaults to negative
10323 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10324 be created. If the value is less than B<WarningMin> but greater than (or equal
10325 to) B<FailureMin> a B<WARNING> notification will be created.
10326
10327 =item B<DataSource> I<DSName>
10328
10329 Some data sets have more than one "data source". Interesting examples are the
10330 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10331 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10332 system load data set, C<load>, even has three data sources: C<shortterm>,
10333 C<midterm>, and C<longterm>.
10334
10335 Normally, all data sources are checked against a configured threshold. If this
10336 is undesirable, or if you want to specify different limits for each data
10337 source, you can use the B<DataSource> option to have a threshold apply only to
10338 one data source.
10339
10340 =item B<Invert> B<true>|B<false>
10341
10342 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10343 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10344 B<WarningMax>) are not okay. Defaults to B<false>.
10345
10346 =item B<Persist> B<true>|B<false>
10347
10348 Sets how often notifications are generated. If set to B<true> one notification
10349 will be generated for each value that is out of the acceptable range. If set to
10350 B<false> (the default) then a notification is only generated if a value is out
10351 of range but the previous value was okay.
10352
10353 This applies to missing values, too: If set to B<true> a notification about a
10354 missing value is generated once every B<Interval> seconds. If set to B<false>
10355 only one such notification is generated until the value appears again.
10356
10357 =item B<Percentage> B<true>|B<false>
10358
10359 If set to B<true>, the minimum and maximum values given are interpreted as
10360 percentage value, relative to the other data sources. This is helpful for
10361 example for the "df" type, where you may want to issue a warning when less than
10362 5E<nbsp>% of the total space is available. Defaults to B<false>.
10363
10364 =item B<Hits> I<Number>
10365
10366 Delay creating the notification until the threshold has been passed I<Number>
10367 times. When a notification has been generated, or when a subsequent value is
10368 inside the threshold, the counter is reset. If, for example, a value is
10369 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10370 will be dispatched at most once every 30E<nbsp>seconds.
10371
10372 This is useful when short bursts are not a problem. If, for example, 100% CPU
10373 usage for up to a minute is normal (and data is collected every
10374 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10375
10376 =item B<Hysteresis> I<Number>
10377
10378 When set to non-zero, a hysteresis value is applied when checking minimum and
10379 maximum bounds. This is useful for values that increase slowly and fluctuate a
10380 bit while doing so. When these values come close to the threshold, they may
10381 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10382
10383 If, for example, the threshold is configures as
10384
10385   WarningMax 100.0
10386   Hysteresis 1.0
10387
10388 then a I<Warning> notification is created when the value exceeds I<101> and the
10389 corresponding I<Okay> notification is only created once the value falls below
10390 I<99>, thus avoiding the "flapping".
10391
10392 =back
10393
10394 =head1 FILTER CONFIGURATION
10395
10396 Starting with collectd 4.6 there is a powerful filtering infrastructure
10397 implemented in the daemon. The concept has mostly been copied from
10398 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10399 terminology, so that users that are familiar with iptables feel right at home.
10400
10401 =head2 Terminology
10402
10403 The following are the terms used in the remainder of the filter configuration
10404 documentation. For an ASCII-art schema of the mechanism, see
10405 L<"General structure"> below.
10406
10407 =over 4
10408
10409 =item B<Match>
10410
10411 A I<match> is a criteria to select specific values. Examples are, of course, the
10412 name of the value or it's current value.
10413
10414 Matches are implemented in plugins which you have to load prior to using the
10415 match. The name of such plugins starts with the "match_" prefix.
10416
10417 =item B<Target>
10418
10419 A I<target> is some action that is to be performed with data. Such actions
10420 could, for example, be to change part of the value's identifier or to ignore
10421 the value completely.
10422
10423 Some of these targets are built into the daemon, see L<"Built-in targets">
10424 below. Other targets are implemented in plugins which you have to load prior to
10425 using the target. The name of such plugins starts with the "target_" prefix.
10426
10427 =item B<Rule>
10428
10429 The combination of any number of matches and at least one target is called a
10430 I<rule>. The target actions will be performed for all values for which B<all>
10431 matches apply. If the rule does not have any matches associated with it, the
10432 target action will be performed for all values.
10433
10434 =item B<Chain>
10435
10436 A I<chain> is a list of rules and possibly default targets. The rules are tried
10437 in order and if one matches, the associated target will be called. If a value
10438 is handled by a rule, it depends on the target whether or not any subsequent
10439 rules are considered or if traversal of the chain is aborted, see
10440 L<"Flow control"> below. After all rules have been checked, the default targets
10441 will be executed.
10442
10443 =back
10444
10445 =head2 General structure
10446
10447 The following shows the resulting structure:
10448
10449  +---------+
10450  ! Chain   !
10451  +---------+
10452       !
10453       V
10454  +---------+  +---------+  +---------+  +---------+
10455  ! Rule    !->! Match   !->! Match   !->! Target  !
10456  +---------+  +---------+  +---------+  +---------+
10457       !
10458       V
10459  +---------+  +---------+  +---------+
10460  ! Rule    !->! Target  !->! Target  !
10461  +---------+  +---------+  +---------+
10462       !
10463       V
10464       :
10465       :
10466       !
10467       V
10468  +---------+  +---------+  +---------+
10469  ! Rule    !->! Match   !->! Target  !
10470  +---------+  +---------+  +---------+
10471       !
10472       V
10473  +---------+
10474  ! Default !
10475  ! Target  !
10476  +---------+
10477
10478 =head2 Flow control
10479
10480 There are four ways to control which way a value takes through the filter
10481 mechanism:
10482
10483 =over 4
10484
10485 =item B<jump>
10486
10487 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10488 process the value with another chain. When the called chain finishes, usually
10489 the next target or rule after the jump is executed.
10490
10491 =item B<stop>
10492
10493 The stop condition, signaled for example by the built-in target B<stop>, causes
10494 all processing of the value to be stopped immediately.
10495
10496 =item B<return>
10497
10498 Causes processing in the current chain to be aborted, but processing of the
10499 value generally will continue. This means that if the chain was called via
10500 B<Jump>, the next target or rule after the jump will be executed. If the chain
10501 was not called by another chain, control will be returned to the daemon and it
10502 may pass the value to another chain.
10503
10504 =item B<continue>
10505
10506 Most targets will signal the B<continue> condition, meaning that processing
10507 should continue normally. There is no special built-in target for this
10508 condition.
10509
10510 =back
10511
10512 =head2 Synopsis
10513
10514 The configuration reflects this structure directly:
10515
10516  PostCacheChain "PostCache"
10517  <Chain "PostCache">
10518    <Rule "ignore_mysql_show">
10519      <Match "regex">
10520        Plugin "^mysql$"
10521        Type "^mysql_command$"
10522        TypeInstance "^show_"
10523      </Match>
10524      <Target "stop">
10525      </Target>
10526    </Rule>
10527    <Target "write">
10528      Plugin "rrdtool"
10529    </Target>
10530  </Chain>
10531
10532 The above configuration example will ignore all values where the plugin field
10533 is "mysql", the type is "mysql_command" and the type instance begins with
10534 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10535 default target of the chain. Since this chain is run after the value has been
10536 added to the cache, the MySQL C<show_*> command statistics will be available
10537 via the C<unixsock> plugin.
10538
10539 =head2 List of configuration options
10540
10541 =over 4
10542
10543 =item B<PreCacheChain> I<ChainName>
10544
10545 =item B<PostCacheChain> I<ChainName>
10546
10547 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10548 argument is the name of a I<chain> that should be executed before and/or after
10549 the values have been added to the cache.
10550
10551 To understand the implications, it's important you know what is going on inside
10552 I<collectd>. The following diagram shows how values are passed from the
10553 read-plugins to the write-plugins:
10554
10555    +---------------+
10556    !  Read-Plugin  !
10557    +-------+-------+
10558            !
10559  + - - - - V - - - - +
10560  : +---------------+ :
10561  : !   Pre-Cache   ! :
10562  : !     Chain     ! :
10563  : +-------+-------+ :
10564  :         !         :
10565  :         V         :
10566  : +-------+-------+ :  +---------------+
10567  : !     Cache     !--->!  Value Cache  !
10568  : !     insert    ! :  +---+---+-------+
10569  : +-------+-------+ :      !   !
10570  :         !   ,------------'   !
10571  :         V   V     :          V
10572  : +-------+---+---+ :  +-------+-------+
10573  : !  Post-Cache   +--->! Write-Plugins !
10574  : !     Chain     ! :  +---------------+
10575  : +---------------+ :
10576  :                   :
10577  :  dispatch values  :
10578  + - - - - - - - - - +
10579
10580 After the values are passed from the "read" plugins to the dispatch functions,
10581 the pre-cache chain is run first. The values are added to the internal cache
10582 afterwards. The post-cache chain is run after the values have been added to the
10583 cache. So why is it such a huge deal if chains are run before or after the
10584 values have been added to this cache?
10585
10586 Targets that change the identifier of a value list should be executed before
10587 the values are added to the cache, so that the name in the cache matches the
10588 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10589 this cache to receive a list of all available values. If you change the
10590 identifier after the value list has been added to the cache, this may easily
10591 lead to confusion, but it's not forbidden of course.
10592
10593 The cache is also used to convert counter values to rates. These rates are, for
10594 example, used by the C<value> match (see below). If you use the rate stored in
10595 the cache B<before> the new value is added, you will use the old, B<previous>
10596 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10597 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10598 command.
10599
10600 Last but not last, the B<stop> target makes a difference: If the pre-cache
10601 chain returns the stop condition, the value will not be added to the cache and
10602 the post-cache chain will not be run.
10603
10604 =item B<Chain> I<Name>
10605
10606 Adds a new chain with a certain name. This name can be used to refer to a
10607 specific chain, for example to jump to it.
10608
10609 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10610
10611 =item B<Rule> [I<Name>]
10612
10613 Adds a new rule to the current chain. The name of the rule is optional and
10614 currently has no meaning for the daemon.
10615
10616 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10617 must be at least one B<Target> block.
10618
10619 =item B<Match> I<Name>
10620
10621 Adds a match to a B<Rule> block. The name specifies what kind of match should
10622 be performed. Available matches depend on the plugins that have been loaded.
10623
10624 The arguments inside the B<Match> block are passed to the plugin implementing
10625 the match, so which arguments are valid here depends on the plugin being used.
10626 If you do not need any to pass any arguments to a match, you can use the
10627 shorter syntax:
10628
10629  Match "foobar"
10630
10631 Which is equivalent to:
10632
10633  <Match "foobar">
10634  </Match>
10635
10636 =item B<Target> I<Name>
10637
10638 Add a target to a rule or a default target to a chain. The name specifies what
10639 kind of target is to be added. Which targets are available depends on the
10640 plugins being loaded.
10641
10642 The arguments inside the B<Target> block are passed to the plugin implementing
10643 the target, so which arguments are valid here depends on the plugin being used.
10644 If you do not need any to pass any arguments to a target, you can use the
10645 shorter syntax:
10646
10647  Target "stop"
10648
10649 This is the same as writing:
10650
10651  <Target "stop">
10652  </Target>
10653
10654 =back
10655
10656 =head2 Built-in targets
10657
10658 The following targets are built into the core daemon and therefore need no
10659 plugins to be loaded:
10660
10661 =over 4
10662
10663 =item B<return>
10664
10665 Signals the "return" condition, see the L<"Flow control"> section above. This
10666 causes the current chain to stop processing the value and returns control to
10667 the calling chain. The calling chain will continue processing targets and rules
10668 just after the B<jump> target (see below). This is very similar to the
10669 B<RETURN> target of iptables, see L<iptables(8)>.
10670
10671 This target does not have any options.
10672
10673 Example:
10674
10675  Target "return"
10676
10677 =item B<stop>
10678
10679 Signals the "stop" condition, see the L<"Flow control"> section above. This
10680 causes processing of the value to be aborted immediately. This is similar to
10681 the B<DROP> target of iptables, see L<iptables(8)>.
10682
10683 This target does not have any options.
10684
10685 Example:
10686
10687  Target "stop"
10688
10689 =item B<write>
10690
10691 Sends the value to "write" plugins.
10692
10693 Available options:
10694
10695 =over 4
10696
10697 =item B<Plugin> I<Name>
10698
10699 Name of the write plugin to which the data should be sent. This option may be
10700 given multiple times to send the data to more than one write plugin. If the
10701 plugin supports multiple instances, the plugin's instance(s) must also be
10702 specified.
10703
10704 =back
10705
10706 If no plugin is explicitly specified, the values will be sent to all available
10707 write plugins.
10708
10709 Single-instance plugin example:
10710
10711  <Target "write">
10712    Plugin "rrdtool"
10713  </Target>
10714
10715 Multi-instance plugin example:
10716
10717  <Plugin "write_graphite">
10718    <Node "foo">
10719    ...
10720    </Node>
10721    <Node "bar">
10722    ...
10723    </Node>
10724  </Plugin>
10725   ...
10726  <Target "write">
10727    Plugin "write_graphite/foo"
10728  </Target>
10729
10730 =item B<jump>
10731
10732 Starts processing the rules of another chain, see L<"Flow control"> above. If
10733 the end of that chain is reached, or a stop condition is encountered,
10734 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10735 next target or the next rule. This is similar to the B<-j> command line option
10736 of iptables, see L<iptables(8)>.
10737
10738 Available options:
10739
10740 =over 4
10741
10742 =item B<Chain> I<Name>
10743
10744 Jumps to the chain I<Name>. This argument is required and may appear only once.
10745
10746 =back
10747
10748 Example:
10749
10750  <Target "jump">
10751    Chain "foobar"
10752  </Target>
10753
10754 =back
10755
10756 =head2 Available matches
10757
10758 =over 4
10759
10760 =item B<regex>
10761
10762 Matches a value using regular expressions.
10763
10764 Available options:
10765
10766 =over 4
10767
10768 =item B<Host> I<Regex>
10769
10770 =item B<Plugin> I<Regex>
10771
10772 =item B<PluginInstance> I<Regex>
10773
10774 =item B<Type> I<Regex>
10775
10776 =item B<TypeInstance> I<Regex>
10777
10778 =item B<MetaData> I<String> I<Regex>
10779
10780 Match values where the given regular expressions match the various fields of
10781 the identifier of a value. If multiple regular expressions are given, B<all>
10782 regexen must match for a value to match.
10783
10784 =item B<Invert> B<false>|B<true>
10785
10786 When set to B<true>, the result of the match is inverted, i.e. all value lists
10787 where all regular expressions apply are not matched, all other value lists are
10788 matched. Defaults to B<false>.
10789
10790 =back
10791
10792 Example:
10793
10794  <Match "regex">
10795    Host "customer[0-9]+"
10796    Plugin "^foobar$"
10797  </Match>
10798
10799 =item B<timediff>
10800
10801 Matches values that have a time which differs from the time on the server.
10802
10803 This match is mainly intended for servers that receive values over the
10804 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10805 is very sensitive to the timestamp used when updating the RRD files. In
10806 particular, the time must be ever increasing. If a misbehaving client sends one
10807 packet with a timestamp far in the future, all further packets with a correct
10808 time will be ignored because of that one packet. What's worse, such corrupted
10809 RRD files are hard to fix.
10810
10811 This match lets one match all values B<outside> a specified time range
10812 (relative to the server's time), so you can use the B<stop> target (see below)
10813 to ignore the value, for example.
10814
10815 Available options:
10816
10817 =over 4
10818
10819 =item B<Future> I<Seconds>
10820
10821 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10822 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10823 non-zero.
10824
10825 =item B<Past> I<Seconds>
10826
10827 Matches all values that are I<behind> of the server's time by I<Seconds> or
10828 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10829 non-zero.
10830
10831 =back
10832
10833 Example:
10834
10835  <Match "timediff">
10836    Future  300
10837    Past   3600
10838  </Match>
10839
10840 This example matches all values that are five minutes or more ahead of the
10841 server or one hour (or more) lagging behind.
10842
10843 =item B<value>
10844
10845 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10846 values. If a data-set consists of more than one data-source, all data-sources
10847 must match the specified ranges for a positive match.
10848
10849 Available options:
10850
10851 =over 4
10852
10853 =item B<Min> I<Value>
10854
10855 Sets the smallest value which still results in a match. If unset, behaves like
10856 negative infinity.
10857
10858 =item B<Max> I<Value>
10859
10860 Sets the largest value which still results in a match. If unset, behaves like
10861 positive infinity.
10862
10863 =item B<Invert> B<true>|B<false>
10864
10865 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10866 no-match is returned and vice versa. Please note that the B<Invert> setting
10867 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10868 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10869
10870 =item B<DataSource> I<DSName> [I<DSName> ...]
10871
10872 Select one or more of the data sources. If no data source is configured, all
10873 data sources will be checked. If the type handled by the match does not have a
10874 data source of the specified name(s), this will always result in no match
10875 (independent of the B<Invert> setting).
10876
10877 =item B<Satisfy> B<Any>|B<All>
10878
10879 Specifies how checking with several data sources is performed. If set to
10880 B<Any>, the match succeeds if one of the data sources is in the configured
10881 range. If set to B<All> the match only succeeds if all data sources are within
10882 the configured range. Default is B<All>.
10883
10884 Usually B<All> is used for positive matches, B<Any> is used for negative
10885 matches. This means that with B<All> you usually check that all values are in a
10886 "good" range, while with B<Any> you check if any value is within a "bad" range
10887 (or outside the "good" range).
10888
10889 =back
10890
10891 Either B<Min> or B<Max>, but not both, may be unset.
10892
10893 Example:
10894
10895  # Match all values smaller than or equal to 100. Matches only if all data
10896  # sources are below 100.
10897  <Match "value">
10898    Max 100
10899    Satisfy "All"
10900  </Match>
10901
10902  # Match if the value of any data source is outside the range of 0 - 100.
10903  <Match "value">
10904    Min   0
10905    Max 100
10906    Invert true
10907    Satisfy "Any"
10908  </Match>
10909
10910 =item B<empty_counter>
10911
10912 Matches all values with one or more data sources of type B<COUNTER> and where
10913 all counter values are zero. These counters usually I<never> increased since
10914 they started existing (and are therefore uninteresting), or got reset recently
10915 or overflowed and you had really, I<really> bad luck.
10916
10917 Please keep in mind that ignoring such counters can result in confusing
10918 behavior: Counters which hardly ever increase will be zero for long periods of
10919 time. If the counter is reset for some reason (machine or service restarted,
10920 usually), the graph will be empty (NAN) for a long time. People may not
10921 understand why.
10922
10923 =item B<hashed>
10924
10925 Calculates a hash value of the host name and matches values according to that
10926 hash value. This makes it possible to divide all hosts into groups and match
10927 only values that are in a specific group. The intended use is in load
10928 balancing, where you want to handle only part of all data and leave the rest
10929 for other servers.
10930
10931 The hashing function used tries to distribute the hosts evenly. First, it
10932 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10933
10934   hash_value = 0;
10935   for (i = 0; host[i] != 0; i++)
10936     hash_value = (hash_value * 251) + host[i];
10937
10938 The constant 251 is a prime number which is supposed to make this hash value
10939 more random. The code then checks the group for this host according to the
10940 I<Total> and I<Match> arguments:
10941
10942   if ((hash_value % Total) == Match)
10943     matches;
10944   else
10945     does not match;
10946
10947 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10948 groups), then the least significant bit of the hash value will be the XOR of
10949 all least significant bits in the host name. One consequence is that when you
10950 have two hosts, "server0.example.com" and "server1.example.com", where the host
10951 name differs in one digit only and the digits differ by one, those hosts will
10952 never end up in the same group.
10953
10954 Available options:
10955
10956 =over 4
10957
10958 =item B<Match> I<Match> I<Total>
10959
10960 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10961 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10962 be smaller than I<Total>. I<Total> must be at least one, although only values
10963 greater than one really do make any sense.
10964
10965 You can repeat this option to match multiple groups, for example:
10966
10967   Match 3 7
10968   Match 5 7
10969
10970 The above config will divide the data into seven groups and match groups three
10971 and five. One use would be to keep every value on two hosts so that if one
10972 fails the missing data can later be reconstructed from the second host.
10973
10974 =back
10975
10976 Example:
10977
10978  # Operate on the pre-cache chain, so that ignored values are not even in the
10979  # global cache.
10980  <Chain "PreCache">
10981    <Rule>
10982      <Match "hashed">
10983        # Divide all received hosts in seven groups and accept all hosts in
10984        # group three.
10985        Match 3 7
10986      </Match>
10987      # If matched: Return and continue.
10988      Target "return"
10989    </Rule>
10990    # If not matched: Return and stop.
10991    Target "stop"
10992  </Chain>
10993
10994 =back
10995
10996 =head2 Available targets
10997
10998 =over 4
10999
11000 =item B<notification>
11001
11002 Creates and dispatches a notification.
11003
11004 Available options:
11005
11006 =over 4
11007
11008 =item B<Message> I<String>
11009
11010 This required option sets the message of the notification. The following
11011 placeholders will be replaced by an appropriate value:
11012
11013 =over 4
11014
11015 =item B<%{host}>
11016
11017 =item B<%{plugin}>
11018
11019 =item B<%{plugin_instance}>
11020
11021 =item B<%{type}>
11022
11023 =item B<%{type_instance}>
11024
11025 These placeholders are replaced by the identifier field of the same name.
11026
11027 =item B<%{ds:>I<name>B<}>
11028
11029 These placeholders are replaced by a (hopefully) human readable representation
11030 of the current rate of this data source. If you changed the instance name
11031 (using the B<set> or B<replace> targets, see below), it may not be possible to
11032 convert counter values to rates.
11033
11034 =back
11035
11036 Please note that these placeholders are B<case sensitive>!
11037
11038 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11039
11040 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11041 used.
11042
11043 =back
11044
11045 Example:
11046
11047   <Target "notification">
11048     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11049     Severity "WARNING"
11050   </Target>
11051
11052 =item B<replace>
11053
11054 Replaces parts of the identifier using regular expressions.
11055
11056 Available options:
11057
11058 =over 4
11059
11060 =item B<Host> I<Regex> I<Replacement>
11061
11062 =item B<Plugin> I<Regex> I<Replacement>
11063
11064 =item B<PluginInstance> I<Regex> I<Replacement>
11065
11066 =item B<TypeInstance> I<Regex> I<Replacement>
11067
11068 =item B<MetaData> I<String> I<Regex> I<Replacement>
11069
11070 =item B<DeleteMetaData> I<String> I<Regex>
11071
11072 Match the appropriate field with the given regular expression I<Regex>. If the
11073 regular expression matches, that part that matches is replaced with
11074 I<Replacement>. If multiple places of the input buffer match a given regular
11075 expression, only the first occurrence will be replaced.
11076
11077 You can specify each option multiple times to use multiple regular expressions
11078 one after another.
11079
11080 =back
11081
11082 Example:
11083
11084  <Target "replace">
11085    # Replace "example.net" with "example.com"
11086    Host "\\<example.net\\>" "example.com"
11087
11088    # Strip "www." from hostnames
11089    Host "\\<www\\." ""
11090  </Target>
11091
11092 =item B<set>
11093
11094 Sets part of the identifier of a value to a given string.
11095
11096 Available options:
11097
11098 =over 4
11099
11100 =item B<Host> I<String>
11101
11102 =item B<Plugin> I<String>
11103
11104 =item B<PluginInstance> I<String>
11105
11106 =item B<TypeInstance> I<String>
11107
11108 =item B<MetaData> I<String> I<String>
11109
11110 Set the appropriate field to the given string. The strings for plugin instance,
11111 type instance, and meta data may be empty, the strings for host and plugin may
11112 not be empty. It's currently not possible to set the type of a value this way.
11113
11114 The following placeholders will be replaced by an appropriate value:
11115
11116 =over 4
11117
11118 =item B<%{host}>
11119
11120 =item B<%{plugin}>
11121
11122 =item B<%{plugin_instance}>
11123
11124 =item B<%{type}>
11125
11126 =item B<%{type_instance}>
11127
11128 These placeholders are replaced by the identifier field of the same name.
11129
11130 =item B<%{meta:>I<name>B<}>
11131
11132 These placeholders are replaced by the meta data value with the given name.
11133
11134 =back
11135
11136 Please note that these placeholders are B<case sensitive>!
11137
11138 =item B<DeleteMetaData> I<String>
11139
11140 Delete the named meta data field.
11141
11142 =back
11143
11144 Example:
11145
11146  <Target "set">
11147    PluginInstance "coretemp"
11148    TypeInstance "core3"
11149  </Target>
11150
11151 =back
11152
11153 =head2 Backwards compatibility
11154
11155 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11156 B<Chain> block, it will behave as it used to. This is equivalent to the
11157 following configuration:
11158
11159  <Chain "PostCache">
11160    Target "write"
11161  </Chain>
11162
11163 If you specify a B<PostCacheChain>, the B<write> target will not be added
11164 anywhere and you will have to make sure that it is called where appropriate. We
11165 suggest to add the above snippet as default target to your "PostCache" chain.
11166
11167 =head2 Examples
11168
11169 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11170 be an FQDN.
11171
11172  <Chain "PreCache">
11173    <Rule "no_fqdn">
11174      <Match "regex">
11175        Host "^[^\.]*$"
11176      </Match>
11177      Target "stop"
11178    </Rule>
11179    Target "write"
11180  </Chain>
11181
11182 =head1 IGNORELISTS
11183
11184 B<Ignorelists> are a generic framework to either ignore some metrics or report
11185 specific metircs only. Plugins usually provide one or more options to specify
11186 the items (mounts points, devices, ...) and the boolean option
11187 C<IgnoreSelected>.
11188
11189 =over 4
11190
11191 =item B<Select> I<String>
11192
11193 Selects the item I<String>. This option often has a plugin specific name, e.g.
11194 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11195 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11196 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11197
11198 By default, this option is doing a case-sensitive full-string match. The
11199 following config will match C<foo>, but not C<Foo>:
11200
11201   Select "foo"
11202
11203 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11204 I<regular expression>. For example, so match all item starting with C<foo>, use
11205 could use the following syntax:
11206
11207   Select "/^foo/"
11208
11209 The regular expression is I<not> anchored, i.e. the following config will match
11210 C<foobar>, C<barfoo> and C<AfooZ>:
11211
11212   Select "/foo/"
11213
11214 The B<Select> option may be repeated to select multiple items.
11215
11216 =item B<IgnoreSelected> B<true>|B<false>
11217
11218 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11219 collected. If set to B<false>, matching metrics are I<collected> and all other
11220 metrics are ignored.
11221
11222 =back
11223
11224 =head1 SEE ALSO
11225
11226 L<collectd(1)>,
11227 L<collectd-exec(5)>,
11228 L<collectd-perl(5)>,
11229 L<collectd-unixsock(5)>,
11230 L<types.db(5)>,
11231 L<hddtemp(8)>,
11232 L<iptables(8)>,
11233 L<kstat(3KSTAT)>,
11234 L<mbmon(1)>,
11235 L<psql(1)>,
11236 L<regex(7)>,
11237 L<rrdtool(1)>,
11238 L<sensors(1)>
11239
11240 =head1 AUTHOR
11241
11242 Florian Forster E<lt>octo@collectd.orgE<gt>
11243
11244 =cut