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