src/collectd.conf.pod

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