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