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