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