src/collectd.conf.pod

   1 =encoding UTF-8
   2
   3 =head1 NAME
   4
   5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
   6
   7 =head1 SYNOPSIS
   8
   9   BaseDir "/var/lib/collectd"
  10   PIDFile "/run/collectd.pid"
  11   Interval 10.0
  12
  13   LoadPlugin cpu
  14   LoadPlugin load
  15
  16   <LoadPlugin df>
  17     Interval 3600
  18   </LoadPlugin>
  19   <Plugin df>
  20     ValuesPercentage true
  21   </Plugin>
  22
  23   LoadPlugin ping
  24   <Plugin ping>
  25     Host "example.org"
  26     Host "provider.net"
  27   </Plugin>
  28
  29 =head1 DESCRIPTION
  30
  31 This config file controls how the system statistics collection daemon
  32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
  33 controls which plugins to load. These plugins ultimately define collectd's
  34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
  35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
  36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
  37
  38 The syntax of this config file is similar to the config file of the famous
  39 I<Apache> webserver. Each line contains either an option (a key and a list of
  40 one or more values) or a section-start or -end. Empty lines and everything
  41 after a non-quoted hash-symbol (C<#>) are ignored. I<Keys> are unquoted
  42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
  43 character. Keys are handled case insensitive by I<collectd> itself and all
  44 plugins included with it. I<Values> can either be an I<unquoted string>, a
  45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
  46 expression. I<Unquoted strings> consist of only alphanumeric characters and
  47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
  48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
  49 to include double quotes as part of the string. I<Numbers> can be specified in
  50 decimal and floating point format (using a dot C<.> as decimal separator),
  51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
  52 I<Boolean> values are either B<true> or B<false>.
  53
  54 Lines may be wrapped by using C<\> as the last character before the newline.
  55 This allows long lines to be split into multiple lines. Quoted strings may be
  56 wrapped as well. However, those are treated special in that whitespace at the
  57 beginning of the following lines will be ignored, which allows for nicely
  58 indenting the wrapped lines.
  59
  60 The configuration is read and processed in order, i.e. from top to bottom. So
  61 the plugins are loaded in the order listed in this config file. It is a good
  62 idea to load any logging plugins first in order to catch messages from plugins
  63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
  64 B<LoadPlugin> option I<must> occur I<before> the appropriate
  65 C<E<lt>B<Plugin> ...E<gt>> block.
  66
  67 =head1 GLOBAL OPTIONS
  68
  69 =over 4
  70
  71 =item B<BaseDir> I<Directory>
  72
  73 Sets the base directory. This is the directory beneath which all RRD-files are
  74 created. Possibly more subdirectories are created. This is also the working
  75 directory for the daemon.
  76
  77 =item B<LoadPlugin> I<Plugin>
  78
  79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
  80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
  81 I<collectd> will be mostly useless.
  82
  83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
  84 effect. This is useful when you want to split up the configuration into smaller
  85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
  86 block I<and> the appropriate B<LoadPlugin> statement. The downside is that if
  87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
  88 different intervals, only one of them (the first one encountered) will take
  89 effect and all others will be silently ignored.
  90
  91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
  92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
  93 statement looks like this:
  94
  95  LoadPlugin "cpu"
  96
  97 Options inside a B<LoadPlugin> block can override default settings and
  98 influence the way plugins are loaded, e.g.:
  99
 100  <LoadPlugin perl>
 101    Interval 60
 102  </LoadPlugin>
 103
 104 The following options are valid inside B<LoadPlugin> blocks:
 105
 106 =over 4
 107
 108 =item B<Globals> B<true|false>
 109
 110 If enabled, collectd will export all global symbols of the plugin (and of all
 111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
 112 available for resolving unresolved symbols in subsequently loaded plugins if
 113 that is supported by your system.
 114
 115 This is useful (or possibly even required), e.g., when loading a plugin that
 116 embeds some scripting language into the daemon (e.g. the I<Perl> and
 117 I<Python plugins>). Scripting languages usually provide means to load
 118 extensions written in C. Those extensions require symbols provided by the
 119 interpreter, which is loaded as a dependency of the respective collectd plugin.
 120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
 121 L<collectd-python(5)>) for details.
 122
 123 By default, this is disabled. As a special exception, if the plugin name is
 124 either C<perl> or C<python>, the default is changed to enabled in order to keep
 125 the average user from ever having to deal with this low level linking stuff.
 126
 127 =item B<Interval> I<Seconds>
 128
 129 Sets a plugin-specific interval for collecting metrics. This overrides the
 130 global B<Interval> setting. If a plugin provides its own support for specifying
 131 an interval, that setting will take precedence.
 132
 133 =item B<FlushInterval> I<Seconds>
 134
 135 Specifies the interval, in seconds, to call the flush callback if it's
 136 defined in this plugin. By default, this is disabled.
 137
 138 =item B<FlushTimeout> I<Seconds>
 139
 140 Specifies the value of the timeout argument of the flush callback.
 141
 142 =back
 143
 144 =item B<AutoLoadPlugin> B<false>|B<true>
 145
 146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
 147 using the B<LoadPlugin> statement documented above. If a
 148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
 149 handling callback for this plugin has been registered, a warning is logged and
 150 the block is ignored.
 151
 152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
 153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
 154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
 155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
 156
 157 =item B<CollectInternalStats> B<false>|B<true>
 158
 159 When set to B<true>, various statistics about the I<collectd> daemon will be
 160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
 161
 162 The following metrics are reported:
 163
 164 =over 4
 165
 166 =item C<collectd-write_queue/queue_length>
 167
 168 The number of metrics currently in the write queue. You can limit the queue
 169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
 170
 171 =item C<collectd-write_queue/derive-dropped>
 172
 173 The number of metrics dropped due to a queue length limitation.
 174 If this value is non-zero, your system can't handle all incoming metrics and
 175 protects itself against overload by dropping metrics.
 176
 177 =item C<collectd-cache/cache_size>
 178
 179 The number of elements in the metric cache (the cache you can interact with
 180 using L<collectd-unixsock(5)>).
 181
 182 =back
 183
 184 =item B<Include> I<Path> [I<pattern>]
 185
 186 If I<Path> points to a file, includes that file. If I<Path> points to a
 187 directory, recursively includes all files within that directory and its
 188 subdirectories. If the C<wordexp> function is available on your system,
 189 shell-like wildcards are expanded before files are included. This means you can
 190 use statements like the following:
 191
 192   Include "/etc/collectd.d/*.conf"
 193
 194 Starting with version 5.3, this may also be a block in which further options
 195 affecting the behavior of B<Include> may be specified. The following option is
 196 currently allowed:
 197
 198   <Include "/etc/collectd.d">
 199     Filter "*.conf"
 200   </Include>
 201
 202 =over 4
 203
 204 =item B<Filter> I<pattern>
 205
 206 If the C<fnmatch> function is available on your system, a shell-like wildcard
 207 I<pattern> may be specified to filter which files to include. This may be used
 208 in combination with recursively including a directory to easily be able to
 209 arbitrarily mix configuration files and other documents (e.g. README files).
 210 The given example is similar to the first example above but includes all files
 211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
 212
 213 =back
 214
 215 If more than one file is included by a single B<Include> option, the files
 216 will be included in lexicographical order (as defined by the C<strcmp>
 217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
 218 order in which the files are loaded.
 219
 220 To prevent loops and shooting yourself in the foot in interesting ways the
 221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
 222 most uses. Since symlinks are followed it is still possible to crash the daemon
 223 by looping symlinks. In our opinion significant stupidity should result in an
 224 appropriate amount of pain.
 225
 226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
 227 file, but you cannot include files from within blocks.
 228
 229 =item B<PIDFile> I<File>
 230
 231 Sets where to write the PID file to. This file is overwritten when it exists
 232 and deleted when the program is stopped. Some init-scripts might override this
 233 setting using the B<-P> command-line option.
 234
 235 =item B<PluginDir> I<Directory>
 236
 237 Path to the plugins (shared objects) of collectd.
 238
 239 =item B<TypesDB> I<File> [I<File> ...]
 240
 241 Set one or more files that contain the data-set descriptions. See
 242 L<types.db(5)> for a description of the format of this file.
 243
 244 If this option is not specified, a default file is read. If you need to define
 245 custom types in addition to the types defined in the default file, you need to
 246 explicitly load both. In other words, if the B<TypesDB> option is encountered
 247 the default behavior is disabled and if you need the default types you have to
 248 also explicitly load them.
 249
 250 =item B<Interval> I<Seconds>
 251
 252 Configures the interval in which to query the read plugins. Obviously smaller
 253 values lead to a higher system load produced by collectd, while higher values
 254 lead to more coarse statistics.
 255
 256 B<Warning:> You should set this once and then never touch it again. If you do,
 257 I<you will have to delete all your RRD files> or know some serious RRDtool
 258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
 259
 260 =item B<MaxReadInterval> I<Seconds>
 261
 262 A read plugin doubles the interval between queries after each failed attempt
 263 to get data.
 264
 265 This options limits the maximum value of the interval. The default value is
 266 B<86400>.
 267
 268 =item B<Timeout> I<Iterations>
 269
 270 Consider a value list "missing" when no update has been read or received for
 271 I<Iterations> iterations. By default, I<collectd> considers a value list
 272 missing when no update has been received for twice the update interval. Since
 273 this setting uses iterations, the maximum allowed time without update depends
 274 on the I<Interval> information contained in each value list. This is used in
 275 the I<Threshold> configuration to dispatch notifications about missing values,
 276 see L<collectd-threshold(5)> for details.
 277
 278 =item B<ReadThreads> I<Num>
 279
 280 Number of threads to start for reading plugins. The default value is B<5>, but
 281 you may want to increase this if you have more than five plugins that take a
 282 long time to read. Mostly those are plugins that do network-IO. Setting this to
 283 a value higher than the number of registered read callbacks is not recommended.
 284
 285 =item B<WriteThreads> I<Num>
 286
 287 Number of threads to start for dispatching value lists to write plugins. The
 288 default value is B<5>, but you may want to increase this if you have more than
 289 five plugins that may take relatively long to write to.
 290
 291 =item B<WriteQueueLimitHigh> I<HighNum>
 292
 293 =item B<WriteQueueLimitLow> I<LowNum>
 294
 295 Metrics are read by the I<read threads> and then put into a queue to be handled
 296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
 297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
 298 running into memory issues in such a case, you can limit the size of this
 299 queue.
 300
 301 By default, there is no limit and memory may grow indefinitely. This is most
 302 likely not an issue for clients, i.e. instances that only handle the local
 303 metrics. For servers it is recommended to set this to a non-zero value, though.
 304
 305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
 306 Each of them takes a numerical argument which is the number of metrics in the
 307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
 308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
 309 I<will> be enqueued. If the number of metrics currently in the queue is between
 310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
 311 proportional to the number of metrics in the queue (i.e. it increases linearly
 312 until it reaches 100%.)
 313
 314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
 315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
 316
 317 If you do not want to randomly drop values when the queue size is between
 318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
 319 to the same value.
 320
 321 Enabling the B<CollectInternalStats> option is of great help to figure out the
 322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
 323
 324 =item B<Hostname> I<Name>
 325
 326 Sets the hostname that identifies a host. If you omit this setting, the
 327 hostname will be determined using the L<gethostname(2)> system call.
 328
 329 =item B<FQDNLookup> B<true|false>
 330
 331 If B<Hostname> is determined automatically this setting controls whether or not
 332 the daemon should try to figure out the "fully qualified domain name", FQDN.
 333 This is done using a lookup of the name returned by C<gethostname>. This option
 334 is enabled by default.
 335
 336 =item B<PreCacheChain> I<ChainName>
 337
 338 =item B<PostCacheChain> I<ChainName>
 339
 340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
 341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
 342 setting change the daemon's behavior.
 343
 344 =back
 345
 346 =head1 PLUGIN OPTIONS
 347
 348 Some plugins may register own options. These options must be enclosed in a
 349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
 350 require external configuration, too. The C<apache plugin>, for example,
 351 required C<mod_status> to be configured in the webserver you're going to
 352 collect data from. These plugins are listed below as well, even if they don't
 353 require any configuration within collectd's configuration file.
 354
 355 A list of all plugins and a short summary for each plugin can be found in the
 356 F<README> file shipped with the sourcecode and hopefully binary packets as
 357 well.
 358
 359 =head2 Plugin C<aggregation>
 360
 361 The I<Aggregation plugin> makes it possible to aggregate several values into
 362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
 363 This can be put to a wide variety of uses, e.g. average and total CPU
 364 statistics for your entire fleet.
 365
 366 The grouping is powerful but, as with many powerful tools, may be a bit
 367 difficult to wrap your head around. The grouping will therefore be
 368 demonstrated using an example: The average and sum of the CPU usage across
 369 all CPUs of each host is to be calculated.
 370
 371 To select all the affected values for our example, set C<Plugin cpu> and
 372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
 373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
 374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
 375 statement.
 376
 377   Plugin "cpu"
 378   Type "cpu"
 379
 380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...)  and
 381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
 382 example, the intention is to have a new value for each host / type instance
 383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
 384 It can be specified multiple times to group by more than one field.
 385
 386   GroupBy "Host"
 387   GroupBy "TypeInstance"
 388
 389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
 390 metrics that differ in the CPU number only will be aggregated. Each
 391 aggregation needs I<at least one> such field, otherwise no aggregation would
 392 take place.
 393
 394 The full example configuration looks like this:
 395
 396  <Plugin "aggregation">
 397    <Aggregation>
 398      Plugin "cpu"
 399      Type "cpu"
 400
 401      GroupBy "Host"
 402      GroupBy "TypeInstance"
 403
 404      CalculateSum true
 405      CalculateAverage true
 406    </Aggregation>
 407  </Plugin>
 408
 409 There are a couple of limitations you should be aware of:
 410
 411 =over 4
 412
 413 =item *
 414
 415 The I<Type> cannot be left unspecified, because it is not reasonable to add
 416 apples to oranges. Also, the internal lookup structure won't work if you try
 417 to group by type.
 418
 419 =item *
 420
 421 There must be at least one unspecified, ungrouped field. Otherwise nothing
 422 will be aggregated.
 423
 424 =back
 425
 426 As you can see in the example above, each aggregation has its own
 427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
 428 blocks may match the same values, i.e. one value list can update multiple
 429 aggregations. The following options are valid inside B<Aggregation> blocks:
 430
 431 =over 4
 432
 433 =item B<Host> I<Host>
 434
 435 =item B<Plugin> I<Plugin>
 436
 437 =item B<PluginInstance> I<PluginInstance>
 438
 439 =item B<Type> I<Type>
 440
 441 =item B<TypeInstance> I<TypeInstance>
 442
 443 Selects the value lists to be added to this aggregation. B<Type> must be a
 444 valid data set name, see L<types.db(5)> for details.
 445
 446 If the string starts with and ends with a slash (C</>), the string is
 447 interpreted as a I<regular expression>. The regex flavor used are POSIX
 448 extended regular expressions as described in L<regex(7)>. Example usage:
 449
 450  Host "/^db[0-9]\\.example\\.com$/"
 451
 452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
 453
 454 Group valued by the specified field. The B<GroupBy> option may be repeated to
 455 group by multiple fields.
 456
 457 =item B<SetHost> I<Host>
 458
 459 =item B<SetPlugin> I<Plugin>
 460
 461 =item B<SetPluginInstance> I<PluginInstance>
 462
 463 =item B<SetTypeInstance> I<TypeInstance>
 464
 465 Sets the appropriate part of the identifier to the provided string.
 466
 467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
 468 will be replaced with the aggregation function, e.g. "average". Not including
 469 the placeholder will result in duplication warnings and/or messed up values if
 470 more than one aggregation function are enabled.
 471
 472 The following example calculates the average usage of all "even" CPUs:
 473
 474  <Plugin "aggregation">
 475    <Aggregation>
 476      Plugin "cpu"
 477      PluginInstance "/[0,2,4,6,8]$/"
 478      Type "cpu"
 479
 480      SetPlugin "cpu"
 481      SetPluginInstance "even-%{aggregation}"
 482
 483      GroupBy "Host"
 484      GroupBy "TypeInstance"
 485
 486      CalculateAverage true
 487    </Aggregation>
 488  </Plugin>
 489
 490 This will create the files:
 491
 492 =over 4
 493
 494 =item *
 495
 496 foo.example.com/cpu-even-average/cpu-idle
 497
 498 =item *
 499
 500 foo.example.com/cpu-even-average/cpu-system
 501
 502 =item *
 503
 504 foo.example.com/cpu-even-average/cpu-user
 505
 506 =item *
 507
 508 ...
 509
 510 =back
 511
 512 =item B<CalculateNum> B<true>|B<false>
 513
 514 =item B<CalculateSum> B<true>|B<false>
 515
 516 =item B<CalculateAverage> B<true>|B<false>
 517
 518 =item B<CalculateMinimum> B<true>|B<false>
 519
 520 =item B<CalculateMaximum> B<true>|B<false>
 521
 522 =item B<CalculateStddev> B<true>|B<false>
 523
 524 Boolean options for enabling calculation of the number of value lists, their
 525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
 526 are disabled by default.
 527
 528 =back
 529
 530 =head2 Plugin C<amqp>
 531
 532 The I<AMQP plugin> can be used to communicate with other instances of
 533 I<collectd> or third party applications using an AMQP 0.9.1 message broker.
 534 Values are sent to or received from the broker, which handles routing,
 535 queueing and possibly filtering out messages.
 536
 537 B<Synopsis:>
 538
 539  <Plugin "amqp">
 540    # Send values to an AMQP broker
 541    <Publish "some_name">
 542      Host "localhost"
 543      Port "5672"
 544      VHost "/"
 545      User "guest"
 546      Password "guest"
 547      Exchange "amq.fanout"
 548  #   ExchangeType "fanout"
 549  #   RoutingKey "collectd"
 550  #   Persistent false
 551  #   ConnectionRetryDelay 0
 552  #   Format "command"
 553  #   StoreRates false
 554  #   GraphitePrefix "collectd."
 555  #   GraphiteEscapeChar "_"
 556  #   GraphiteSeparateInstances false
 557  #   GraphiteAlwaysAppendDS false
 558  #   GraphitePreserveSeparator false
 559    </Publish>
 560
 561    # Receive values from an AMQP broker
 562    <Subscribe "some_name">
 563      Host "localhost"
 564      Port "5672"
 565      VHost "/"
 566      User "guest"
 567      Password "guest"
 568      Exchange "amq.fanout"
 569  #   ExchangeType "fanout"
 570  #   Queue "queue_name"
 571  #   QueueDurable false
 572  #   QueueAutoDelete true
 573  #   RoutingKey "collectd.#"
 574  #   ConnectionRetryDelay 0
 575    </Subscribe>
 576  </Plugin>
 577
 578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
 579 blocks, which configure sending and receiving of values respectively. The two
 580 blocks are very similar, so unless otherwise noted, an option can be used in
 581 either block. The name given in the blocks starting tag is only used for
 582 reporting messages, but may be used to support I<flushing> of certain
 583 I<Publish> blocks in the future.
 584
 585 =over 4
 586
 587 =item B<Host> I<Host>
 588
 589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
 590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
 591
 592 =item B<Port> I<Port>
 593
 594 Service name or port number on which the AMQP broker accepts connections. This
 595 argument must be a string, even if the numeric form is used. Defaults to
 596 "5672".
 597
 598 =item B<VHost> I<VHost>
 599
 600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
 601
 602 =item B<User> I<User>
 603
 604 =item B<Password> I<Password>
 605
 606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
 607 is used.
 608
 609 =item B<Exchange> I<Exchange>
 610
 611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
 612 By default, "amq.fanout" will be used.
 613
 614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
 615 the given exchange and the I<queue> is created, using the I<routing key> if
 616 configured. See the B<Queue> and B<RoutingKey> options below.
 617
 618 =item B<ExchangeType> I<Type>
 619
 620 If given, the plugin will try to create the configured I<exchange> with this
 621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
 622 be bound to this exchange.
 623
 624 =item B<Queue> I<Queue> (Subscribe only)
 625
 626 Configures the I<queue> name to subscribe to. If no queue name was configured
 627 explicitly, a unique queue name will be created by the broker.
 628
 629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
 630
 631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
 632 or transient (will disappear if the AMQP broker is restarted). Defaults to
 633 "false".
 634
 635 This option should be used in conjunction with the I<Persistent> option on the
 636 publish side.
 637
 638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
 639
 640 Defines if the I<queue> subscribed to will be deleted once the last consumer
 641 unsubscribes. Defaults to "true".
 642
 643 =item B<RoutingKey> I<Key>
 644
 645 In I<Publish> blocks, this configures the routing key to set on all outgoing
 646 messages. If not given, the routing key will be computed from the I<identifier>
 647 of the value. The host, plugin, type and the two instances are concatenated
 648 together using dots as the separator and all containing dots replaced with
 649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
 650 possible to receive only specific values using a "topic" exchange.
 651
 652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
 653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
 654 used to filter messages when using a "topic" exchange. If you're only
 655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
 656 for example.
 657
 658 =item B<Persistent> B<true>|B<false> (Publish only)
 659
 660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
 661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
 662 default), the I<transient> delivery mode will be used, i.e. messages may be
 663 lost due to high load, overflowing queues or similar issues.
 664
 665 =item B<ConnectionRetryDelay> I<Delay>
 666
 667 When the connection to the AMQP broker is lost, defines the time in seconds to
 668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
 669 attempt to reconnect at each read interval (in Subscribe mode) or each time
 670 values are ready for submission (in Publish mode).
 671
 672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
 673
 674 Selects the format in which messages are sent to the broker. If set to
 675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
 676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
 677 case, the C<Content-Type> header field will be set to C<text/collectd>.
 678
 679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
 680 an easy and straight forward exchange format. The C<Content-Type> header field
 681 will be set to C<application/json>.
 682
 683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
 684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
 685 C<text/graphite>.
 686
 687 A subscribing client I<should> use the C<Content-Type> header field to
 688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
 689 only decode the B<Command> format.
 690
 691 =item B<StoreRates> B<true>|B<false> (Publish only)
 692
 693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
 694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
 695 default), no conversion is performed. Otherwise the conversion is performed
 696 using the internal value cache.
 697
 698 Please note that currently this option is only used if the B<Format> option has
 699 been set to B<JSON>.
 700
 701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
 702
 703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
 704 It's added before the I<Host> name.
 705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 706
 707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
 708
 709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
 710 It's added after the I<Host> name.
 711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 712
 713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
 714
 715 Specify a character to replace dots (.) in the host part of the metric name.
 716 In I<Graphite> metric name, dots are used as separators between different
 717 metric parts (host, plugin, type).
 718 Default is "_" (I<Underscore>).
 719
 720 =item B<GraphiteSeparateInstances> B<true>|B<false>
 721
 722 If set to B<true>, the plugin instance and type instance will be in their own
 723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
 724 default), the plugin and plugin instance (and likewise the type and type
 725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
 726
 727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
 728
 729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
 730 identifier. If set to B<false> (the default), this is only done when there is
 731 more than one DS.
 732
 733 =item B<GraphitePreserveSeparator> B<false>|B<true>
 734
 735 If set to B<false> (the default) the C<.> (dot) character is replaced with
 736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
 737 is preserved, i.e. passed through.
 738
 739 =back
 740
 741 =head2 Plugin C<amqp1>
 742
 743 The I<AMQP1 plugin> can be used to communicate with other instances of
 744 I<collectd> or third party applications using an AMQP 1.0 message
 745 intermediary. Metric values or notifications are sent to the
 746 messaging intermediary which may handle direct messaging or
 747 queue based transfer.
 748
 749 B<Synopsis:>
 750
 751  <Plugin "amqp1">
 752    # Send values to an AMQP 1.0 intermediary
 753   <Transport "name">
 754     Host "localhost"
 755     Port "5672"
 756     User "guest"
 757     Password "guest"
 758     Address "collectd"
 759 #    RetryDelay 1
 760     <Instance "some_name">
 761         Format "command"
 762         PreSettle false
 763         Notify false
 764  #      StoreRates false
 765  #      GraphitePrefix "collectd."
 766  #      GraphiteEscapeChar "_"
 767  #      GraphiteSeparateInstances false
 768  #      GraphiteAlwaysAppendDS false
 769  #      GraphitePreserveSeparator false
 770     </Instance>
 771   </Transport>
 772  </Plugin>
 773
 774 The plugin's configuration consists of a I<Transport> that configures
 775 communications to the AMQP 1.0 messaging bus and one or more I<Instance>
 776 corresponding to metric or event publishers to the messaging system.
 777
 778 The address in the I<Transport> block concatenated with the name given in the
 779 I<Instance> block starting tag will be used as the send-to address for
 780 communications over the messaging link.
 781
 782 The following options are accepted within each I<Transport> block:
 783
 784 =over 4
 785
 786 =item B<Host> I<Host>
 787
 788 Hostname or IP-address of the AMQP 1.0 intermediary. Defaults to the
 789 default behavior of the underlying communications library,
 790 I<libqpid-proton>, which is "localhost".
 791
 792 =item B<Port> I<Port>
 793
 794 Service name or port number on which the AMQP 1.0 intermediary accepts
 795 connections. This argument must be a string, even if the numeric form
 796 is used. Defaults to "5672".
 797
 798 =item B<User> I<User>
 799
 800 =item B<Password> I<Password>
 801
 802 Credentials used to authenticate to the AMQP 1.0 intermediary. By
 803 default "guest"/"guest" is used.
 804
 805 =item B<Address> I<Address>
 806
 807 This option specifies the prefix for the send-to value in the message.
 808 By default, "collectd" will be used.
 809
 810 =item B<RetryDelay> I<RetryDelay>
 811
 812 When the AMQP1 connection is lost, defines the time in seconds to wait
 813 before attempting to reconnect. Defaults to 1, which implies attempt
 814 to reconnect at 1 second intervals.
 815
 816 =back
 817
 818 The following options are accepted within each I<Instance> block:
 819
 820 =over 4
 821
 822 =item B<Format> B<Command>|B<JSON>|B<Graphite>
 823
 824 Selects the format in which messages are sent to the intermediary. If set to
 825 B<Command> (the default), values are sent as C<PUTVAL> commands which are
 826 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
 827 case, the C<Content-Type> header field will be set to C<text/collectd>.
 828
 829 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
 830 an easy and straight forward exchange format. The C<Content-Type> header field
 831 will be set to C<application/json>.
 832
 833 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
 834 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
 835 C<text/graphite>.
 836
 837 A subscribing client I<should> use the C<Content-Type> header field to
 838 determine how to decode the values.
 839
 840 =item B<PreSettle> B<true>|B<false>
 841
 842 If set to B<false> (the default), the plugin will wait for a message
 843 acknowledgement from the messaging bus before sending the next
 844 message. This indicates transfer of ownership to the messaging
 845 system. If set to B<true>, the plugin will not wait for a message
 846 acknowledgement and the message may be dropped prior to transfer of
 847 ownership.
 848
 849 =item B<Notify> B<true>|B<false>
 850
 851 If set to B<false> (the default), the plugin will service the
 852 instance write call back as a value list. If set to B<true> the
 853 plugin will service the instance as a write notification callback
 854 for alert formatting.
 855
 856 =item B<StoreRates> B<true>|B<false>
 857
 858 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
 859 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
 860 default), no conversion is performed. Otherwise the conversion is performed
 861 using the internal value cache.
 862
 863 Please note that currently this option is only used if the B<Format> option has
 864 been set to B<JSON>.
 865
 866 =item B<GraphitePrefix>
 867
 868 A prefix can be added in the metric name when outputting in the I<Graphite> format.
 869 It's added before the I<Host> name.
 870 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 871
 872 =item B<GraphitePostfix>
 873
 874 A postfix can be added in the metric name when outputting in the I<Graphite> format.
 875 It's added after the I<Host> name.
 876 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 877
 878 =item B<GraphiteEscapeChar>
 879
 880 Specify a character to replace dots (.) in the host part of the metric name.
 881 In I<Graphite> metric name, dots are used as separators between different
 882 metric parts (host, plugin, type).
 883 Default is "_" (I<Underscore>).
 884
 885 =item B<GraphiteSeparateInstances> B<true>|B<false>
 886
 887 If set to B<true>, the plugin instance and type instance will be in their own
 888 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
 889 default), the plugin and plugin instance (and likewise the type and type
 890 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
 891
 892 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
 893
 894 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
 895 identifier. If set to B<false> (the default), this is only done when there is
 896 more than one DS.
 897
 898 =item B<GraphitePreserveSeparator> B<false>|B<true>
 899
 900 If set to B<false> (the default) the C<.> (dot) character is replaced with
 901 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
 902 is preserved, i.e. passed through.
 903
 904 =back
 905
 906 =head2 Plugin C<apache>
 907
 908 To configure the C<apache>-plugin you first need to configure the Apache
 909 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
 910 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
 911 the following snipped to base your Apache config upon:
 912
 913   ExtendedStatus on
 914   <IfModule mod_status.c>
 915     <Location /mod_status>
 916       SetHandler server-status
 917     </Location>
 918   </IfModule>
 919
 920 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
 921 also supported. It introduces a new field, called C<BusyServers>, to count the
 922 number of currently connected clients. This field is also supported.
 923
 924 The configuration of the I<Apache> plugin consists of one or more
 925 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
 926 as the instance name. For example:
 927
 928  <Plugin "apache">
 929    <Instance "www1">
 930      URL "http://www1.example.com/mod_status?auto"
 931    </Instance>
 932    <Instance "www2">
 933      URL "http://www2.example.com/mod_status?auto"
 934    </Instance>
 935  </Plugin>
 936
 937 The instance name will be used as the I<plugin instance>. To emulate the old
 938 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
 939 plugin to work correctly, each instance name must be unique. This is not
 940 enforced by the plugin and it is your responsibility to ensure it.
 941
 942 The following options are accepted within each I<Instance> block:
 943
 944 =over 4
 945
 946 =item B<URL> I<http://host/mod_status?auto>
 947
 948 Sets the URL of the C<mod_status> output. This needs to be the output generated
 949 by C<ExtendedStatus on> and it needs to be the machine readable output
 950 generated by appending the C<?auto> argument. This option is I<mandatory>.
 951
 952 =item B<User> I<Username>
 953
 954 Optional user name needed for authentication.
 955
 956 =item B<Password> I<Password>
 957
 958 Optional password needed for authentication.
 959
 960 =item B<VerifyPeer> B<true|false>
 961
 962 Enable or disable peer SSL certificate verification. See
 963 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
 964
 965 =item B<VerifyHost> B<true|false>
 966
 967 Enable or disable peer host name verification. If enabled, the plugin checks
 968 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
 969 certificate matches the host name provided by the B<URL> option. If this
 970 identity check fails, the connection is aborted. Obviously, only works when
 971 connecting to a SSL enabled server. Enabled by default.
 972
 973 =item B<CACert> I<File>
 974
 975 File that holds one or more SSL certificates. If you want to use HTTPS you will
 976 possibly need this option. What CA certificates come bundled with C<libcurl>
 977 and are checked by default depends on the distribution you use.
 978
 979 =item B<SSLCiphers> I<list of ciphers>
 980
 981 Specifies which ciphers to use in the connection. The list of ciphers
 982 must specify valid ciphers. See
 983 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
 984
 985 =item B<Timeout> I<Milliseconds>
 986
 987 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
 988 milliseconds. By default, the configured B<Interval> is used to set the
 989 timeout.
 990
 991 =back
 992
 993 =head2 Plugin C<apcups>
 994
 995 =over 4
 996
 997 =item B<Host> I<Hostname>
 998
 999 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
1000 that IPv6 support has been disabled unless someone can confirm or decline that
1001 B<apcupsd> can handle it.
1002
1003 =item B<Port> I<Port>
1004
1005 TCP-Port to connect to. Defaults to B<3551>.
1006
1007 =item B<ReportSeconds> B<true>|B<false>
1008
1009 If set to B<true>, the time reported in the C<timeleft> metric will be
1010 converted to seconds. This is the recommended setting. If set to B<false>, the
1011 default for backwards compatibility, the time will be reported in minutes.
1012
1013 =item B<PersistentConnection> B<true>|B<false>
1014
1015 The plugin is designed to keep the connection to I<apcupsd> open between reads.
1016 If plugin poll interval is greater than 15 seconds (hardcoded socket close
1017 timeout in I<apcupsd> NIS), then this option is B<false> by default.
1018
1019 You can instruct the plugin to close the connection after each read by setting
1020 this option to B<false> or force keeping the connection by setting it to B<true>.
1021
1022 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
1023 the plugin will try to detect this problem and switch to an open-read-close mode.
1024
1025 =back
1026
1027 =head2 Plugin C<aquaero>
1028
1029 This plugin collects the value of the available sensors in an
1030 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
1031 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
1032 connection for monitoring and configuration. The board can handle multiple
1033 temperature sensors, fans, water pumps and water level sensors and adjust the
1034 output settings such as fan voltage or power used by the water pump based on
1035 the available inputs using a configurable controller included in the board.
1036 This plugin collects all the available inputs as well as some of the output
1037 values chosen by this controller. The plugin is based on the I<libaquaero5>
1038 library provided by I<aquatools-ng>.
1039
1040 =over 4
1041
1042 =item B<Device> I<DevicePath>
1043
1044 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
1045 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
1046 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
1047
1048 =back
1049
1050 =head2 Plugin C<ascent>
1051
1052 This plugin collects information about an Ascent server, a free server for the
1053 "World of Warcraft" game. This plugin gathers the information by fetching the
1054 XML status page using C<libcurl> and parses it using C<libxml2>.
1055
1056 The configuration options are the same as for the C<apache> plugin above:
1057
1058 =over 4
1059
1060 =item B<URL> I<http://localhost/ascent/status/>
1061
1062 Sets the URL of the XML status output.
1063
1064 =item B<User> I<Username>
1065
1066 Optional user name needed for authentication.
1067
1068 =item B<Password> I<Password>
1069
1070 Optional password needed for authentication.
1071
1072 =item B<VerifyPeer> B<true|false>
1073
1074 Enable or disable peer SSL certificate verification. See
1075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1076
1077 =item B<VerifyHost> B<true|false>
1078
1079 Enable or disable peer host name verification. If enabled, the plugin checks
1080 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1081 certificate matches the host name provided by the B<URL> option. If this
1082 identity check fails, the connection is aborted. Obviously, only works when
1083 connecting to a SSL enabled server. Enabled by default.
1084
1085 =item B<CACert> I<File>
1086
1087 File that holds one or more SSL certificates. If you want to use HTTPS you will
1088 possibly need this option. What CA certificates come bundled with C<libcurl>
1089 and are checked by default depends on the distribution you use.
1090
1091 =item B<Timeout> I<Milliseconds>
1092
1093 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1094 milliseconds. By default, the configured B<Interval> is used to set the
1095 timeout.
1096
1097 =back
1098
1099 =head2 Plugin C<barometer>
1100
1101 This plugin reads absolute air pressure using digital barometer sensor on a I2C
1102 bus. Supported sensors are:
1103
1104 =over 5
1105
1106 =item I<MPL115A2> from Freescale,
1107 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
1108
1109
1110 =item I<MPL3115> from Freescale
1111 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
1112
1113
1114 =item I<BMP085> from Bosch Sensortec
1115
1116 =back
1117
1118 The sensor type - one of the above - is detected automatically by the plugin
1119 and indicated in the plugin_instance (you will see subdirectory
1120 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
1121 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
1122 (only one sensor can be used by the plugin).
1123
1124 The plugin provides absolute barometric pressure, air pressure reduced to sea
1125 level (several possible approximations) and as an auxiliary value also internal
1126 sensor temperature. It uses (expects/provides) typical metric units - pressure
1127 in [hPa], temperature in [C], altitude in [m].
1128
1129 It was developed and tested under Linux only. The only platform dependency is
1130 the standard Linux i2c-dev interface (the particular bus driver has to
1131 support the SM Bus command subset).
1132
1133 The reduction or normalization to mean sea level pressure requires (depending
1134 on selected method/approximation) also altitude and reference to temperature
1135 sensor(s).  When multiple temperature sensors are configured the minimum of
1136 their values is always used (expecting that the warmer ones are affected by
1137 e.g. direct sun light at that moment).
1138
1139 Synopsis:
1140
1141   <Plugin "barometer">
1142      Device            "/dev/i2c-0";
1143      Oversampling      512
1144      PressureOffset    0.0
1145      TemperatureOffset 0.0
1146      Normalization     2
1147      Altitude          238.0
1148      TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
1149   </Plugin>
1150
1151 =over 4
1152
1153 =item B<Device> I<device>
1154
1155 The only mandatory configuration parameter.
1156
1157 Device name of the I2C bus to which the sensor is connected. Note that
1158 typically you need to have loaded the i2c-dev module.
1159 Using i2c-tools you can check/list i2c buses available on your system by:
1160
1161   i2cdetect -l
1162
1163 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1164
1165   i2cdetect -y -a 0
1166
1167 This way you should be able to verify that the pressure sensor (either type) is
1168 connected and detected on address 0x60.
1169
1170 =item B<Oversampling> I<value>
1171
1172 Optional parameter controlling the oversampling/accuracy. Default value
1173 is 1 providing fastest and least accurate reading.
1174
1175 For I<MPL115> this is the size of the averaging window. To filter out sensor
1176 noise a simple averaging using floating window of this configurable size is
1177 used. The plugin will use average of the last C<value> measurements (value of 1
1178 means no averaging).  Minimal size is 1, maximal 1024.
1179
1180 For I<MPL3115> this is the oversampling value. The actual oversampling is
1181 performed by the sensor and the higher value the higher accuracy and longer
1182 conversion time (although nothing to worry about in the collectd context).
1183 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1184 adjusted by the plugin to the closest supported one.
1185
1186 For I<BMP085> this is the oversampling value. The actual oversampling is
1187 performed by the sensor and the higher value the higher accuracy and longer
1188 conversion time (although nothing to worry about in the collectd context).
1189 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1190 the closest supported one.
1191
1192 =item B<PressureOffset> I<offset>
1193
1194 Optional parameter for MPL3115 only.
1195
1196 You can further calibrate the sensor by supplying pressure and/or temperature
1197 offsets.  This is added to the measured/caclulated value (i.e. if the measured
1198 value is too high then use negative offset).
1199 In hPa, default is 0.0.
1200
1201 =item B<TemperatureOffset> I<offset>
1202
1203 Optional parameter for MPL3115 only.
1204
1205 You can further calibrate the sensor by supplying pressure and/or temperature
1206 offsets.  This is added to the measured/caclulated value (i.e. if the measured
1207 value is too high then use negative offset).
1208 In C, default is 0.0.
1209
1210 =item B<Normalization> I<method>
1211
1212 Optional parameter, default value is 0.
1213
1214 Normalization method - what approximation/model is used to compute the mean sea
1215 level pressure from the air absolute pressure.
1216
1217 Supported values of the C<method> (integer between from 0 to 2) are:
1218
1219 =over 5
1220
1221 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1222        do not need to configure C<Altitude> or C<TemperatureSensor>.
1223
1224 =item B<1> - international formula for conversion ,
1225 See
1226 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1227 For this method you have to configure C<Altitude> but do not need
1228 C<TemperatureSensor> (uses fixed global temperature average instead).
1229
1230 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1231 Meteorological Service).
1232 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1233 For this method you have to configure both  C<Altitude> and
1234 C<TemperatureSensor>.
1235
1236 =back
1237
1238
1239 =item B<Altitude> I<altitude>
1240
1241 The altitude (in meters) of the location where you meassure the pressure.
1242
1243 =item B<TemperatureSensor> I<reference>
1244
1245 Temperature sensor(s) which should be used as a reference when normalizing the
1246 pressure using C<Normalization> method 2.
1247 When specified more sensors a minimum is found and used each time.  The
1248 temperature reading directly from this pressure sensor/plugin is typically not
1249 suitable as the pressure sensor will be probably inside while we want outside
1250 temperature.  The collectd reference name is something like
1251 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1252 (<type_instance> is usually omitted when there is just single value type). Or
1253 you can figure it out from the path of the output data files.
1254
1255 =back
1256
1257 =head2 Plugin C<battery>
1258
1259 The I<battery plugin> reports the remaining capacity, power and voltage of
1260 laptop batteries.
1261
1262 =over 4
1263
1264 =item B<ValuesPercentage> B<false>|B<true>
1265
1266 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1267 capacity remaining". Otherwise the capacity is stored as reported by the
1268 battery, most likely in "Wh". This option does not work with all input methods,
1269 in particular when only C</proc/pmu> is available on an old Linux system.
1270 Defaults to B<false>.
1271
1272 =item B<ReportDegraded> B<false>|B<true>
1273
1274 Typical laptop batteries degrade over time, meaning the capacity decreases with
1275 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1276 "last full capacity" and used to determine that a battery is "fully charged".
1277
1278 When this option is set to B<false>, the default, the I<battery plugin> will
1279 only report the remaining capacity. If the B<ValuesPercentage> option is
1280 enabled, the relative remaining capacity is calculated as the ratio of the
1281 "remaining capacity" and the "last full capacity". This is what most tools,
1282 such as the status bar of desktop environments, also do.
1283
1284 When set to B<true>, the battery plugin will report three values: B<charged>
1285 (remaining capacity), B<discharged> (difference between "last full capacity"
1286 and "remaining capacity") and B<degraded> (difference between "design capacity"
1287 and "last full capacity").
1288
1289 =item B<QueryStateFS> B<false>|B<true>
1290
1291 When set to B<true>, the battery plugin will only read statistics
1292 related to battery performance as exposed by StateFS at
1293 /run/state. StateFS is used in Mer-based Sailfish OS, for
1294 example.
1295
1296 =back
1297
1298 =head2 Plugin C<bind>
1299
1300 Starting with BIND 9.5.0, the most widely used DNS server software provides
1301 extensive statistics about queries, responses and lots of other information.
1302 The bind plugin retrieves this information that's encoded in XML and provided
1303 via HTTP and submits the values to collectd.
1304
1305 To use this plugin, you first need to tell BIND to make this information
1306 available. This is done with the C<statistics-channels> configuration option:
1307
1308  statistics-channels {
1309    inet localhost port 8053;
1310  };
1311
1312 The configuration follows the grouping that can be seen when looking at the
1313 data with an XSLT compatible viewer, such as a modern web browser. It's
1314 probably a good idea to make yourself familiar with the provided values, so you
1315 can understand what the collected statistics actually mean.
1316
1317 Synopsis:
1318
1319  <Plugin "bind">
1320    URL "http://localhost:8053/"
1321    ParseTime       false
1322    OpCodes         true
1323    QTypes          true
1324
1325    ServerStats     true
1326    ZoneMaintStats  true
1327    ResolverStats   false
1328    MemoryStats     true
1329
1330    <View "_default">
1331      QTypes        true
1332      ResolverStats true
1333      CacheRRSets   true
1334
1335      Zone "127.in-addr.arpa/IN"
1336    </View>
1337  </Plugin>
1338
1339 The bind plugin accepts the following configuration options:
1340
1341 =over 4
1342
1343 =item B<URL> I<URL>
1344
1345 URL from which to retrieve the XML data. If not specified,
1346 C<http://localhost:8053/> will be used.
1347
1348 =item B<ParseTime> B<true>|B<false>
1349
1350 When set to B<true>, the time provided by BIND will be parsed and used to
1351 dispatch the values. When set to B<false>, the local time source is queried.
1352
1353 This setting is set to B<true> by default for backwards compatibility; setting
1354 this to B<false> is I<recommended> to avoid problems with timezones and
1355 localization.
1356
1357 =item B<OpCodes> B<true>|B<false>
1358
1359 When enabled, statistics about the I<"OpCodes">, for example the number of
1360 C<QUERY> packets, are collected.
1361
1362 Default: Enabled.
1363
1364 =item B<QTypes> B<true>|B<false>
1365
1366 When enabled, the number of I<incoming> queries by query types (for example
1367 C<A>, C<MX>, C<AAAA>) is collected.
1368
1369 Default: Enabled.
1370
1371 =item B<ServerStats> B<true>|B<false>
1372
1373 Collect global server statistics, such as requests received over IPv4 and IPv6,
1374 successful queries, and failed updates.
1375
1376 Default: Enabled.
1377
1378 =item B<ZoneMaintStats> B<true>|B<false>
1379
1380 Collect zone maintenance statistics, mostly information about notifications
1381 (zone updates) and zone transfers.
1382
1383 Default: Enabled.
1384
1385 =item B<ResolverStats> B<true>|B<false>
1386
1387 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1388 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1389 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1390 default. Use the B<ResolverStats> option within a B<View "_default"> block
1391 instead for the same functionality.
1392
1393 Default: Disabled.
1394
1395 =item B<MemoryStats>
1396
1397 Collect global memory statistics.
1398
1399 Default: Enabled.
1400
1401 =item B<Timeout> I<Milliseconds>
1402
1403 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1404 milliseconds. By default, the configured B<Interval> is used to set the
1405 timeout.
1406
1407 =item B<View> I<Name>
1408
1409 Collect statistics about a specific I<"view">. BIND can behave different,
1410 mostly depending on the source IP-address of the request. These different
1411 configurations are called "views". If you don't use this feature, you most
1412 likely are only interested in the C<_default> view.
1413
1414 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1415 information you want to collect about a view. If no B<View> block is
1416 configured, no detailed view statistics will be collected.
1417
1418 =over 4
1419
1420 =item B<QTypes> B<true>|B<false>
1421
1422 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1423 C<MX>) is collected.
1424
1425 Default: Enabled.
1426
1427 =item B<ResolverStats> B<true>|B<false>
1428
1429 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1430 (e.E<nbsp>g. queries over IPv4, lame servers).
1431
1432 Default: Enabled.
1433
1434 =item B<CacheRRSets> B<true>|B<false>
1435
1436 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1437 type is collected. Negative entries (queries which resulted in an error, for
1438 example names that do not exist) are reported with a leading exclamation mark,
1439 e.E<nbsp>g. "!A".
1440
1441 Default: Enabled.
1442
1443 =item B<Zone> I<Name>
1444
1445 When given, collect detailed information about the given zone in the view. The
1446 information collected if very similar to the global B<ServerStats> information
1447 (see above).
1448
1449 You can repeat this option to collect detailed information about multiple
1450 zones.
1451
1452 By default no detailed zone information is collected.
1453
1454 =back
1455
1456 =back
1457
1458 =head2 Plugin C<ceph>
1459
1460 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1461 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1462
1463 A separate B<Daemon> block must be configured for each ceph daemon to be
1464 monitored. The following example will read daemon statistics from four
1465 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1466
1467   <Plugin ceph>
1468     LongRunAvgLatency false
1469     ConvertSpecialMetricTypes true
1470     <Daemon "osd.0">
1471       SocketPath "/var/run/ceph/ceph-osd.0.asok"
1472     </Daemon>
1473     <Daemon "osd.1">
1474       SocketPath "/var/run/ceph/ceph-osd.1.asok"
1475     </Daemon>
1476     <Daemon "mon.a">
1477       SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1478     </Daemon>
1479     <Daemon "mds.a">
1480       SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1481     </Daemon>
1482   </Plugin>
1483
1484 The ceph plugin accepts the following configuration options:
1485
1486 =over 4
1487
1488 =item B<LongRunAvgLatency> B<true>|B<false>
1489
1490 If enabled, latency values(sum,count pairs) are calculated as the long run
1491 average - average since the ceph daemon was started = (sum / count).
1492 When disabled, latency values are calculated as the average since the last
1493 collection = (sum_now - sum_last) / (count_now - count_last).
1494
1495 Default: Disabled
1496
1497 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1498
1499 If enabled, special metrics (metrics that differ in type from similar counters)
1500 are converted to the type of those similar counters. This currently only
1501 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1502 ceph schema reports this metric type as a sum,count pair while similar counters
1503 are treated as derive types. When converted, the sum is used as the counter
1504 value and is treated as a derive type.
1505 When disabled, all metrics are treated as the types received from the ceph schema.
1506
1507 Default: Enabled
1508
1509 =back
1510
1511 Each B<Daemon> block must have a string argument for the plugin instance name.
1512 A B<SocketPath> is also required for each B<Daemon> block:
1513
1514 =over 4
1515
1516 =item B<Daemon> I<DaemonName>
1517
1518 Name to be used as the instance name for this daemon.
1519
1520 =item B<SocketPath> I<SocketPath>
1521
1522 Specifies the path to the UNIX admin socket of the ceph daemon.
1523
1524 =back
1525
1526 =head2 Plugin C<cgroups>
1527
1528 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1529 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1530 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1531
1532 =over 4
1533
1534 =item B<CGroup> I<Directory>
1535
1536 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1537 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1538 see below.
1539
1540 See F</"IGNORELISTS"> for details.
1541
1542 =item B<IgnoreSelected> B<true>|B<false>
1543
1544 Invert the selection: If set to true, all cgroups I<except> the ones that
1545 match any one of the criteria are collected. By default only selected
1546 cgroups are collected if a selection is made. If no selection is configured
1547 at all, B<all> cgroups are selected.
1548
1549 =back
1550
1551 =head2 Plugin C<chrony>
1552
1553 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1554 skew and per-peer stratum.
1555
1556 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1557 on the wire.
1558
1559 Available configuration options for the C<chrony> plugin:
1560
1561 =over 4
1562
1563 =item B<Host> I<Hostname>
1564
1565 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1566
1567 =item B<Port> I<Port>
1568
1569 UDP-Port to connect to. Defaults to B<323>.
1570
1571 =item B<Timeout> I<Timeout>
1572
1573 Connection timeout in seconds. Defaults to B<2>.
1574
1575 =back
1576
1577 =head2 Plugin C<conntrack>
1578
1579 This plugin collects IP conntrack statistics.
1580
1581 =over 4
1582
1583 =item B<OldFiles>
1584
1585 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1586 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1587
1588 =back
1589
1590 =head2 Plugin C<cpu>
1591
1592 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1593 as Jiffies, using the C<cpu> type. Two aggregations are available:
1594
1595 =over 4
1596
1597 =item *
1598
1599 Sum, per-state, over all CPUs installed in the system; and
1600
1601 =item *
1602
1603 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1604
1605 =back
1606
1607 The two aggregations can be combined, leading to I<collectd> only emitting a
1608 single "active" metric for the entire system. As soon as one of these
1609 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1610 rather than Jiffies. In addition, you can request individual, per-state,
1611 per-CPU metrics to be reported as percentage.
1612
1613 The following configuration options are available:
1614
1615 =over 4
1616
1617 =item B<ReportByState> B<true>|B<false>
1618
1619 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1620 "user" and "idle".
1621 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1622 "active" metric.
1623
1624 =item B<ReportByCpu> B<true>|B<false>
1625
1626 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1627 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1628 global sum of CPU states is emitted.
1629
1630 =item B<ValuesPercentage> B<false>|B<true>
1631
1632 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1633 are set to B<true>. In this case, by default, metrics will be reported as
1634 Jiffies. By setting this option to B<true>, you can request percentage values
1635 in the un-aggregated (per-CPU, per-state) mode as well.
1636
1637 =item B<ReportNumCpu> B<false>|B<true>
1638
1639 When set to B<true>, reports the number of available CPUs.
1640 Defaults to B<false>.
1641
1642 =item B<ReportGuestState> B<false>|B<true>
1643
1644 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1645 Defaults to B<false>.
1646
1647 =item B<SubtractGuestState> B<false>|B<true>
1648
1649 This option is only considered when B<ReportGuestState> is set to B<true>.
1650 "guest" and "guest_nice" are included in respectively "user" and "nice".
1651 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1652 will be subtracted from "nice".
1653 Defaults to B<true>.
1654
1655 =back
1656
1657 =head2 Plugin C<cpufreq>
1658
1659 This plugin doesn't have any options. It reads
1660 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1661 installed) to get the current CPU frequency. If this file does not exist make
1662 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1663 installed and an "cpu governor" (that's a kernel module) is loaded.
1664
1665 If the system has the I<cpufreq-stats> kernel module loaded, this plugin reports
1666 the rate of p-state (cpu frequency) transitions and the percentage of time spent
1667 in each p-state.
1668
1669 =head2 Plugin C<cpusleep>
1670
1671 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1672 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1673 BOOTTIME clock increments while device is suspended and MONOTONIC
1674 clock does not, the derivative of the difference between these clocks
1675 gives the relative amount of time the device has spent in suspend
1676 state. The recorded value is in milliseconds of sleep per seconds of
1677 wall clock.
1678
1679 =head2 Plugin C<csv>
1680
1681 =over 4
1682
1683 =item B<DataDir> I<Directory>
1684
1685 Set the directory to store CSV-files under. Per default CSV-files are generated
1686 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1687 The special strings B<stdout> and B<stderr> can be used to write to the standard
1688 output and standard error channels, respectively. This, of course, only makes
1689 much sense when collectd is running in foreground- or non-daemon-mode.
1690
1691 =item B<StoreRates> B<true|false>
1692
1693 If set to B<true>, convert counter values to rates. If set to B<false> (the
1694 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1695 number.
1696
1697 =back
1698
1699 =head2 cURL Statistics
1700
1701 All cURL-based plugins support collection of generic, request-based
1702 statistics. These are disabled by default and can be enabled selectively for
1703 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1704 the documentation of those plugins for specific information. This section
1705 describes the available metrics that can be configured for each plugin. All
1706 options are disabled by default.
1707
1708 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1709
1710 =over 4
1711
1712 =item B<TotalTime> B<true|false>
1713
1714 Total time of the transfer, including name resolving, TCP connect, etc.
1715
1716 =item B<NamelookupTime> B<true|false>
1717
1718 Time it took from the start until name resolving was completed.
1719
1720 =item B<ConnectTime> B<true|false>
1721
1722 Time it took from the start until the connect to the remote host (or proxy)
1723 was completed.
1724
1725 =item B<AppconnectTime> B<true|false>
1726
1727 Time it took from the start until the SSL/SSH connect/handshake to the remote
1728 host was completed.
1729
1730 =item B<PretransferTime> B<true|false>
1731
1732 Time it took from the start until just before the transfer begins.
1733
1734 =item B<StarttransferTime> B<true|false>
1735
1736 Time it took from the start until the first byte was received.
1737
1738 =item B<RedirectTime> B<true|false>
1739
1740 Time it took for all redirection steps include name lookup, connect,
1741 pre-transfer and transfer before final transaction was started.
1742
1743 =item B<RedirectCount> B<true|false>
1744
1745 The total number of redirections that were actually followed.
1746
1747 =item B<SizeUpload> B<true|false>
1748
1749 The total amount of bytes that were uploaded.
1750
1751 =item B<SizeDownload> B<true|false>
1752
1753 The total amount of bytes that were downloaded.
1754
1755 =item B<SpeedDownload> B<true|false>
1756
1757 The average download speed that curl measured for the complete download.
1758
1759 =item B<SpeedUpload> B<true|false>
1760
1761 The average upload speed that curl measured for the complete upload.
1762
1763 =item B<HeaderSize> B<true|false>
1764
1765 The total size of all the headers received.
1766
1767 =item B<RequestSize> B<true|false>
1768
1769 The total size of the issued requests.
1770
1771 =item B<ContentLengthDownload> B<true|false>
1772
1773 The content-length of the download.
1774
1775 =item B<ContentLengthUpload> B<true|false>
1776
1777 The specified size of the upload.
1778
1779 =item B<NumConnects> B<true|false>
1780
1781 The number of new connections that were created to achieve the transfer.
1782
1783 =back
1784
1785 =head2 Plugin C<curl>
1786
1787 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1788 and the match infrastructure (the same code used by the tail plugin) to use
1789 regular expressions with the received data.
1790
1791 The following example will read the current value of AMD stock from Google's
1792 finance page and dispatch the value to collectd.
1793
1794   <Plugin curl>
1795     <Page "stock_quotes">
1796       Plugin "quotes"
1797       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1798       AddressFamily "any"
1799       User "foo"
1800       Password "bar"
1801       Digest false
1802       VerifyPeer true
1803       VerifyHost true
1804       CACert "/path/to/ca.crt"
1805       Header "X-Custom-Header: foobar"
1806       Post "foo=bar"
1807
1808       MeasureResponseTime false
1809       MeasureResponseCode false
1810
1811       <Match>
1812         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1813         DSType "GaugeAverage"
1814         # Note: `stock_value' is not a standard type.
1815         Type "stock_value"
1816         Instance "AMD"
1817       </Match>
1818     </Page>
1819   </Plugin>
1820
1821 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1822 a web page and one or more "matches" to be performed on the returned data. The
1823 string argument to the B<Page> block is used as plugin instance.
1824
1825 The following options are valid within B<Page> blocks:
1826
1827 =over 4
1828
1829 =item B<Plugin> I<Plugin>
1830
1831 Use I<Plugin> as the plugin name when submitting values.
1832 Defaults to C<curl>.
1833
1834 =item B<URL> I<URL>
1835
1836 URL of the web site to retrieve. Since a regular expression will be used to
1837 extract information from this data, non-binary data is a big plus here ;)
1838
1839 =item B<AddressFamily> I<Type>
1840
1841 IP version to resolve URL to. Useful in cases when hostname in URL resolves
1842 to both IPv4 and IPv6 addresses, and you are interested in using one of them
1843 specifically.
1844 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
1845 default behavior of resolving addresses to all IP versions your system allows.
1846 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
1847 a warning and fallback to C<any>.
1848 If C<Type> cannot be parsed, a warning will be printed and the whole B<Page>
1849 block will be ignored.
1850
1851 =item B<User> I<Name>
1852
1853 Username to use if authorization is required to read the page.
1854
1855 =item B<Password> I<Password>
1856
1857 Password to use if authorization is required to read the page.
1858
1859 =item B<Digest> B<true>|B<false>
1860
1861 Enable HTTP digest authentication.
1862
1863 =item B<VerifyPeer> B<true>|B<false>
1864
1865 Enable or disable peer SSL certificate verification. See
1866 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1867
1868 =item B<VerifyHost> B<true>|B<false>
1869
1870 Enable or disable peer host name verification. If enabled, the plugin checks if
1871 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1872 matches the host name provided by the B<URL> option. If this identity check
1873 fails, the connection is aborted. Obviously, only works when connecting to a
1874 SSL enabled server. Enabled by default.
1875
1876 =item B<CACert> I<file>
1877
1878 File that holds one or more SSL certificates. If you want to use HTTPS you will
1879 possibly need this option. What CA certificates come bundled with C<libcurl>
1880 and are checked by default depends on the distribution you use.
1881
1882 =item B<Header> I<Header>
1883
1884 A HTTP header to add to the request. Multiple headers are added if this option
1885 is specified more than once.
1886
1887 =item B<Post> I<Body>
1888
1889 Specifies that the HTTP operation should be a POST instead of a GET. The
1890 complete data to be posted is given as the argument.  This option will usually
1891 need to be accompanied by a B<Header> option to set an appropriate
1892 C<Content-Type> for the post body (e.g. to
1893 C<application/x-www-form-urlencoded>).
1894
1895 =item B<MeasureResponseTime> B<true>|B<false>
1896
1897 Measure response time for the request. If this setting is enabled, B<Match>
1898 blocks (see below) are optional. Disabled by default.
1899
1900 Beware that requests will get aborted if they take too long to complete. Adjust
1901 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1902 requests.
1903
1904 This option is similar to enabling the B<TotalTime> statistic but it's
1905 measured by collectd instead of cURL.
1906
1907 =item B<MeasureResponseCode> B<true>|B<false>
1908
1909 Measure response code for the request. If this setting is enabled, B<Match>
1910 blocks (see below) are optional. Disabled by default.
1911
1912 =item B<E<lt>StatisticsE<gt>>
1913
1914 One B<Statistics> block can be used to specify cURL statistics to be collected
1915 for each request to the remote web site. See the section "cURL Statistics"
1916 above for details. If this setting is enabled, B<Match> blocks (see below) are
1917 optional.
1918
1919 =item B<E<lt>MatchE<gt>>
1920
1921 One or more B<Match> blocks that define how to match information in the data
1922 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1923 used by the C<tail> plugin, so please see the documentation of the C<tail>
1924 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1925 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1926 optional.
1927
1928 =item B<Interval> I<Interval>
1929
1930 Sets the interval (in seconds) in which the values will be collected from this
1931 URL. By default the global B<Interval> setting will be used.
1932
1933 =item B<Timeout> I<Milliseconds>
1934
1935 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1936 milliseconds. By default, the configured B<Interval> is used to set the
1937 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1938 indefinitely. This legacy behaviour can be achieved by setting the value of
1939 B<Timeout> to 0.
1940
1941 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1942 network connection will stall one read thread. Adjust the B<ReadThreads> global
1943 setting accordingly to prevent this from blocking other plugins.
1944
1945 =back
1946
1947 =head2 Plugin C<curl_json>
1948
1949 The B<curl_json plugin> collects values from JSON data to be parsed by
1950 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1951 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1952 unix socket. The former can be used, for example, to collect values
1953 from CouchDB documents (which are stored JSON notation), and the
1954 latter to collect values from a uWSGI stats socket.
1955
1956 The following example will collect several values from the built-in
1957 C<_stats> runtime statistics module of I<CouchDB>
1958 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1959
1960   <Plugin curl_json>
1961     <URL "http://localhost:5984/_stats">
1962       AddressFamily "any"
1963       Instance "httpd"
1964       <Key "httpd/requests/count">
1965         Type "http_requests"
1966       </Key>
1967
1968       <Key "httpd_request_methods/*/count">
1969         Type "http_request_methods"
1970       </Key>
1971
1972       <Key "httpd_status_codes/*/count">
1973         Type "http_response_codes"
1974       </Key>
1975     </URL>
1976   </Plugin>
1977
1978 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1979
1980   <Plugin curl_json>
1981     <Sock "/var/run/uwsgi.stats.sock">
1982       Instance "uwsgi"
1983       <Key "workers/*/requests">
1984         Type "http_requests"
1985       </Key>
1986
1987       <Key "workers/*/apps/*/requests">
1988         Type "http_requests"
1989       </Key>
1990     </Sock>
1991   </Plugin>
1992
1993 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1994 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1995 blocks defining a unix socket to read JSON from directly.  Each of
1996 these blocks may have one or more B<Key> blocks.
1997
1998 The B<Key> string argument must be in a path format. Each component is
1999 used to match the key from a JSON map or the index of an JSON
2000 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
2001 values for all map keys or array indices will be collectd.
2002
2003 The following options are valid within B<URL> blocks:
2004
2005 =over 4
2006
2007 =item B<AddressFamily> I<Type>
2008
2009 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2010 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2011 specifically.
2012 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2013 default behavior of resolving addresses to all IP versions your system allows.
2014 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2015 a warning and fallback to C<any>.
2016 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2017 block will be ignored.
2018
2019 =item B<Host> I<Name>
2020
2021 Use I<Name> as the host name when submitting values. Defaults to the global
2022 host name setting.
2023
2024 =item B<Plugin> I<Plugin>
2025
2026 Use I<Plugin> as the plugin name when submitting values.
2027 Defaults to C<curl_json>.
2028
2029 =item B<Instance> I<Instance>
2030
2031 Sets the plugin instance to I<Instance>.
2032
2033 =item B<Interval> I<Interval>
2034
2035 Sets the interval (in seconds) in which the values will be collected from this
2036 URL. By default the global B<Interval> setting will be used.
2037
2038 =item B<User> I<Name>
2039
2040 =item B<Password> I<Password>
2041
2042 =item B<Digest> B<true>|B<false>
2043
2044 =item B<VerifyPeer> B<true>|B<false>
2045
2046 =item B<VerifyHost> B<true>|B<false>
2047
2048 =item B<CACert> I<file>
2049
2050 =item B<Header> I<Header>
2051
2052 =item B<Post> I<Body>
2053
2054 =item B<Timeout> I<Milliseconds>
2055
2056 These options behave exactly equivalent to the appropriate options of the
2057 I<cURL> plugin. Please see there for a detailed description.
2058
2059 =item B<E<lt>StatisticsE<gt>>
2060
2061 One B<Statistics> block can be used to specify cURL statistics to be collected
2062 for each request to the remote URL. See the section "cURL Statistics" above
2063 for details.
2064
2065 =back
2066
2067 The following options are valid within B<Key> blocks:
2068
2069 =over 4
2070
2071 =item B<Type> I<Type>
2072
2073 Sets the type used to dispatch the values to the daemon. Detailed information
2074 about types and their configuration can be found in L<types.db(5)>. This
2075 option is mandatory.
2076
2077 =item B<Instance> I<Instance>
2078
2079 Type-instance to use. Defaults to the current map key or current string array element value.
2080
2081 =back
2082
2083 =head2 Plugin C<curl_xml>
2084
2085 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2086 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2087
2088  <Plugin "curl_xml">
2089    <URL "http://localhost/stats.xml">
2090      AddressFamily "any"
2091      Host "my_host"
2092      #Plugin "curl_xml"
2093      Instance "some_instance"
2094      User "collectd"
2095      Password "thaiNg0I"
2096      VerifyPeer true
2097      VerifyHost true
2098      CACert "/path/to/ca.crt"
2099      Header "X-Custom-Header: foobar"
2100      Post "foo=bar"
2101
2102      <XPath "table[@id=\"magic_level\"]/tr">
2103        Type "magic_level"
2104        #InstancePrefix "prefix-"
2105        InstanceFrom "td[1]"
2106        #PluginInstanceFrom "td[1]"
2107        ValuesFrom "td[2]/span[@class=\"level\"]"
2108      </XPath>
2109    </URL>
2110  </Plugin>
2111
2112 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2113 URL to be fetched using libcurl. Within each B<URL> block there are
2114 options which specify the connection parameters, for example authentication
2115 information, and one or more B<XPath> blocks.
2116
2117 Each B<XPath> block specifies how to get one type of information. The
2118 string argument must be a valid XPath expression which returns a list
2119 of "base elements". One value is dispatched for each "base element". The
2120 I<type instance> and values are looked up using further I<XPath> expressions
2121 that should be relative to the base element.
2122
2123 Within the B<URL> block the following options are accepted:
2124
2125 =over 4
2126
2127 =item B<AddressFamily> I<Type>
2128
2129 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2130 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2131 specifically.
2132 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2133 default behavior of resolving addresses to all IP versions your system allows.
2134 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2135 a warning and fallback to C<any>.
2136 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2137 block will be ignored.
2138
2139 =item B<Host> I<Name>
2140
2141 Use I<Name> as the host name when submitting values. Defaults to the global
2142 host name setting.
2143
2144 =item B<Plugin> I<Plugin>
2145
2146 Use I<Plugin> as the plugin name when submitting values.
2147 Defaults to 'curl_xml'.
2148
2149 =item B<Instance> I<Instance>
2150
2151 Use I<Instance> as the plugin instance when submitting values.
2152 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2153 Defaults to an empty string (no plugin instance).
2154
2155 =item B<Interval> I<Interval>
2156
2157 Sets the interval (in seconds) in which the values will be collected from this
2158 URL. By default the global B<Interval> setting will be used.
2159
2160 =item B<Namespace> I<Prefix> I<URL>
2161
2162 If an XPath expression references namespaces, they must be specified
2163 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2164 I<URL> is the "namespace name", an URI reference uniquely identifying the
2165 namespace. The option can be repeated to register multiple namespaces.
2166
2167 Examples:
2168
2169   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2170   Namespace "m" "http://www.w3.org/1998/Math/MathML"
2171
2172 =item B<User> I<User>
2173
2174 =item B<Password> I<Password>
2175
2176 =item B<Digest> B<true>|B<false>
2177
2178 =item B<VerifyPeer> B<true>|B<false>
2179
2180 =item B<VerifyHost> B<true>|B<false>
2181
2182 =item B<CACert> I<CA Cert File>
2183
2184 =item B<Header> I<Header>
2185
2186 =item B<Post> I<Body>
2187
2188 =item B<Timeout> I<Milliseconds>
2189
2190 These options behave exactly equivalent to the appropriate options of the
2191 I<cURL plugin>. Please see there for a detailed description.
2192
2193 =item B<E<lt>StatisticsE<gt>>
2194
2195 One B<Statistics> block can be used to specify cURL statistics to be collected
2196 for each request to the remote URL. See the section "cURL Statistics" above
2197 for details.
2198
2199 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2200
2201 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2202 B<XPath> block specifies how to get one type of information. The string
2203 argument must be a valid XPath expression which returns a list of "base
2204 elements". One value is dispatched for each "base element".
2205
2206 Within the B<XPath> block the following options are accepted:
2207
2208 =over 4
2209
2210 =item B<Type> I<Type>
2211
2212 Specifies the I<Type> used for submitting patches. This determines the number
2213 of values that are required / expected and whether the strings are parsed as
2214 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2215 This option is required.
2216
2217 =item B<InstancePrefix> I<InstancePrefix>
2218
2219 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2220 concatenated together without any separator.
2221 This option is optional.
2222
2223 =item B<InstanceFrom> I<InstanceFrom>
2224
2225 Specifies a XPath expression to use for determining the I<type instance>. The
2226 XPath expression must return exactly one element. The element's value is then
2227 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2228
2229 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2230
2231 Specifies a XPath expression to use for determining the I<plugin instance>. The
2232 XPath expression must return exactly one element. The element's value is then
2233 used as I<plugin instance>.
2234
2235 =back
2236
2237 If the "base XPath expression" (the argument to the B<XPath> block) returns
2238 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2239 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2240
2241 =over 4
2242
2243 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2244
2245 Specifies one or more XPath expression to use for reading the values. The
2246 number of XPath expressions must match the number of data sources in the
2247 I<type> specified with B<Type> (see above). Each XPath expression must return
2248 exactly one element. The element's value is then parsed as a number and used as
2249 value for the appropriate value in the value list dispatched to the daemon.
2250 This option is required.
2251
2252 =back
2253
2254 =back
2255
2256 =head2 Plugin C<dbi>
2257
2258 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2259 connect to various databases, execute I<SQL> statements and read back the
2260 results. I<dbi> is an acronym for "database interface" in case you were
2261 wondering about the name. You can configure how each column is to be
2262 interpreted and the plugin will generate one or more data sets from each row
2263 returned according to these rules.
2264
2265 Because the plugin is very generic, the configuration is a little more complex
2266 than those of other plugins. It usually looks something like this:
2267
2268   <Plugin dbi>
2269     <Query "out_of_stock">
2270       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2271       # Use with MySQL 5.0.0 or later
2272       MinVersion 50000
2273       <Result>
2274         Type "gauge"
2275         InstancePrefix "out_of_stock"
2276         InstancesFrom "category"
2277         ValuesFrom "value"
2278       </Result>
2279     </Query>
2280     <Database "product_information">
2281       #Plugin "warehouse"
2282       Driver "mysql"
2283       Interval 120
2284       DriverOption "host" "localhost"
2285       DriverOption "username" "collectd"
2286       DriverOption "password" "aZo6daiw"
2287       DriverOption "dbname" "prod_info"
2288       SelectDB "prod_info"
2289       Query "out_of_stock"
2290     </Database>
2291   </Plugin>
2292
2293 The configuration above defines one query with one result and one database. The
2294 query is then linked to the database with the B<Query> option I<within> the
2295 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2296 and you can also use the B<Include> statement to split up the configuration
2297 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2298 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2299 top to bottom!
2300
2301 The following is a complete list of options:
2302
2303 =head3 B<Query> blocks
2304
2305 Query blocks define I<SQL> statements and how the returned data should be
2306 interpreted. They are identified by the name that is given in the opening line
2307 of the block. Thus the name needs to be unique. Other than that, the name is
2308 not used in collectd.
2309
2310 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2311 define which column holds which value or instance information. You can use
2312 multiple B<Result> blocks to create multiple values from one returned row. This
2313 is especially useful, when queries take a long time and sending almost the same
2314 query again and again is not desirable.
2315
2316 Example:
2317
2318   <Query "environment">
2319     Statement "select station, temperature, humidity from environment"
2320     <Result>
2321       Type "temperature"
2322       # InstancePrefix "foo"
2323       InstancesFrom "station"
2324       ValuesFrom "temperature"
2325     </Result>
2326     <Result>
2327       Type "humidity"
2328       InstancesFrom "station"
2329       ValuesFrom "humidity"
2330     </Result>
2331   </Query>
2332
2333 The following options are accepted:
2334
2335 =over 4
2336
2337 =item B<Statement> I<SQL>
2338
2339 Sets the statement that should be executed on the server. This is B<not>
2340 interpreted by collectd, but simply passed to the database server. Therefore,
2341 the SQL dialect that's used depends on the server collectd is connected to.
2342
2343 The query has to return at least two columns, one for the instance and one
2344 value. You cannot omit the instance, even if the statement is guaranteed to
2345 always return exactly one line. In that case, you can usually specify something
2346 like this:
2347
2348   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2349
2350 (That works with MySQL but may not be valid SQL according to the spec. If you
2351 use a more strict database server, you may have to select from a dummy table or
2352 something.)
2353
2354 Please note that some databases, for example B<Oracle>, will fail if you
2355 include a semicolon at the end of the statement.
2356
2357 =item B<MinVersion> I<Version>
2358
2359 =item B<MaxVersion> I<Value>
2360
2361 Only use this query for the specified database version. You can use these
2362 options to provide multiple queries with the same name but with a slightly
2363 different syntax. The plugin will use only those queries, where the specified
2364 minimum and maximum versions fit the version of the database in use.
2365
2366 The database version is determined by C<dbi_conn_get_engine_version>, see the
2367 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2368 for details. Basically, each part of the version is assumed to be in the range
2369 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2370 "40102", version "5.0.42" becomes "50042".
2371
2372 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2373 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2374 happen. Don't to it! A valid example would be something along these lines:
2375
2376   MinVersion 40000
2377   MaxVersion 49999
2378   ...
2379   MinVersion 50000
2380   MaxVersion 50099
2381   ...
2382   MinVersion 50100
2383   # No maximum
2384
2385 In the above example, there are three ranges that don't overlap. The last one
2386 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2387 before "4.0.0" are not specified.
2388
2389 =item B<Type> I<Type>
2390
2391 The B<type> that's used for each line returned. See L<types.db(5)> for more
2392 details on how types are defined. In short: A type is a predefined layout of
2393 data and the number of values and type of values has to match the type
2394 definition.
2395
2396 If you specify "temperature" here, you need exactly one gauge column. If you
2397 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2398 setting below.
2399
2400 There must be exactly one B<Type> option inside each B<Result> block.
2401
2402 =item B<InstancePrefix> I<prefix>
2403
2404 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2405 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2406 all strings returned in the appropriate columns are concatenated together,
2407 separated by dashes I<("-")>.
2408
2409 =item B<InstancesFrom> I<column0> [I<column1> ...]
2410
2411 Specifies the columns whose values will be used to create the "type-instance"
2412 for each row. If you specify more than one column, the value of all columns
2413 will be joined together with dashes I<("-")> as separation characters.
2414
2415 The plugin itself does not check whether or not all built instances are
2416 different. It's your responsibility to assure that each is unique. This is
2417 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2418 sure that only one row is returned in this case.
2419
2420 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2421 will be empty.
2422
2423 =item B<ValuesFrom> I<column0> [I<column1> ...]
2424
2425 Names the columns whose content is used as the actual data for the data sets
2426 that are dispatched to the daemon. How many such columns you need is determined
2427 by the B<Type> setting above. If you specify too many or not enough columns,
2428 the plugin will complain about that and no data will be submitted to the
2429 daemon.
2430
2431 The actual data type in the columns is not that important. The plugin will
2432 automatically cast the values to the right type if it know how to do that. So
2433 it should be able to handle integer an floating point types, as well as strings
2434 (if they include a number at the beginning).
2435
2436 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2437
2438 =item B<MetadataFrom> [I<column0> I<column1> ...]
2439
2440 Names the columns whose content is used as metadata for the data sets
2441 that are dispatched to the daemon.
2442
2443 The actual data type in the columns is not that important. The plugin will
2444 automatically cast the values to the right type if it know how to do that. So
2445 it should be able to handle integer an floating point types, as well as strings
2446 (if they include a number at the beginning).
2447
2448 =back
2449
2450 =head3 B<Database> blocks
2451
2452 Database blocks define a connection to a database and which queries should be
2453 sent to that database. Since the used "dbi" library can handle a wide variety
2454 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2455 documentationE<nbsp>- we stick as close to the terminology used there.
2456
2457 Each database needs a "name" as string argument in the starting tag of the
2458 block. This name will be used as "PluginInstance" in the values submitted to
2459 the daemon. Other than that, that name is not used.
2460
2461 =over 4
2462
2463 =item B<Plugin> I<Plugin>
2464
2465 Use I<Plugin> as the plugin name when submitting query results from
2466 this B<Database>. Defaults to C<dbi>.
2467
2468 =item B<Interval> I<Interval>
2469
2470 Sets the interval (in seconds) in which the values will be collected from this
2471 database. By default the global B<Interval> setting will be used.
2472
2473 =item B<Driver> I<Driver>
2474
2475 Specifies the driver to use to connect to the database. In many cases those
2476 drivers are named after the database they can connect to, but this is not a
2477 technical necessity. These drivers are sometimes referred to as "DBD",
2478 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2479 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2480 project at L<http://libdbi-drivers.sourceforge.net/>.
2481
2482 You need to give the driver name as expected by the "dbi" library here. You
2483 should be able to find that in the documentation for each driver. If you
2484 mistype the driver name, the plugin will dump a list of all known driver names
2485 to the log.
2486
2487 =item B<DriverOption> I<Key> I<Value>
2488
2489 Sets driver-specific options. What option a driver supports can be found in the
2490 documentation for each driver, somewhere at
2491 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2492 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2493
2494 DBDs can register two types of options: String options and numeric options. The
2495 plugin will use the C<dbi_conn_set_option> function when the configuration
2496 provides a string and the C<dbi_conn_require_option_numeric> function when the
2497 configuration provides a number. So these two lines will actually result in
2498 different calls being used:
2499
2500   DriverOption "Port" 1234      # numeric
2501   DriverOption "Port" "1234"    # string
2502
2503 Unfortunately, drivers are not too keen to report errors when an unknown option
2504 is passed to them, so invalid settings here may go unnoticed. This is not the
2505 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2506 the driver. If a driver complains about an option, the plugin will dump a
2507 complete list of all options understood by that driver to the log. There is no
2508 way to programmatically find out if an option expects a string or a numeric
2509 argument, so you will have to refer to the appropriate DBD's documentation to
2510 find this out. Sorry.
2511
2512 =item B<SelectDB> I<Database>
2513
2514 In some cases, the database name you connect with is not the database name you
2515 want to use for querying data. If this option is set, the plugin will "select"
2516 (switch to) that database after the connection is established.
2517
2518 =item B<Query> I<QueryName>
2519
2520 Associates the query named I<QueryName> with this database connection. The
2521 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2522 blocks you want to refer to must be placed above the database block you want to
2523 refer to them from.
2524
2525 =item B<Host> I<Hostname>
2526
2527 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2528 values. Defaults to the global hostname setting.
2529
2530 =back
2531
2532 =head2 Plugin C<df>
2533
2534 =over 4
2535
2536 =item B<Device> I<Device>
2537
2538 Select partitions based on the devicename.
2539
2540 See F</"IGNORELISTS"> for details.
2541
2542 =item B<MountPoint> I<Directory>
2543
2544 Select partitions based on the mountpoint.
2545
2546 See F</"IGNORELISTS"> for details.
2547
2548 =item B<FSType> I<FSType>
2549
2550 Select partitions based on the filesystem type.
2551
2552 See F</"IGNORELISTS"> for details.
2553
2554 =item B<IgnoreSelected> B<true>|B<false>
2555
2556 Invert the selection: If set to true, all partitions B<except> the ones that
2557 match any one of the criteria are collected. By default only selected
2558 partitions are collected if a selection is made. If no selection is configured
2559 at all, B<all> partitions are selected.
2560
2561 =item B<ReportByDevice> B<true>|B<false>
2562
2563 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2564 (the default), it will report a disk as "root", but with it I<true>, it will be
2565 "sda1" (or whichever).
2566
2567 =item B<ReportInodes> B<true>|B<false>
2568
2569 Enables or disables reporting of free, reserved and used inodes. Defaults to
2570 inode collection being disabled.
2571
2572 Enable this option if inodes are a scarce resource for you, usually because
2573 many small files are stored on the disk. This is a usual scenario for mail
2574 transfer agents and web caches.
2575
2576 =item B<ValuesAbsolute> B<true>|B<false>
2577
2578 Enables or disables reporting of free and used disk space in 1K-blocks.
2579 Defaults to B<true>.
2580
2581 =item B<ValuesPercentage> B<false>|B<true>
2582
2583 Enables or disables reporting of free and used disk space in percentage.
2584 Defaults to B<false>.
2585
2586 This is useful for deploying I<collectd> on the cloud, where machines with
2587 different disk size may exist. Then it is more practical to configure
2588 thresholds based on relative disk size.
2589
2590 =back
2591
2592 =head2 Plugin C<disk>
2593
2594 The C<disk> plugin collects information about the usage of physical disks and
2595 logical disks (partitions). Values collected are the number of octets written
2596 to and read from a disk or partition, the number of read/write operations
2597 issued to the disk and a rather complex "time" it took for these commands to be
2598 issued.
2599
2600 Using the following two options you can ignore some disks or configure the
2601 collection only of specific disks.
2602
2603 =over 4
2604
2605 =item B<Disk> I<Name>
2606
2607 Select the disk I<Name>. Whether it is collected or ignored depends on the
2608 B<IgnoreSelected> setting, see below. As with other plugins that use the
2609 daemon's ignorelist functionality, a string that starts and ends with a slash
2610 is interpreted as a regular expression. Examples:
2611
2612   Disk "sdd"
2613   Disk "/hda[34]/"
2614
2615 See F</"IGNORELISTS"> for details.
2616
2617 =item B<IgnoreSelected> B<true>|B<false>
2618
2619 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2620 statements, are ignored or if all other disks are ignored. The behavior
2621 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2622 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2623 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2624 is set to B<true>, all disks are collected B<except> the ones matched.
2625
2626 =item B<UseBSDName> B<true>|B<false>
2627
2628 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2629 default major/minor numbers. Requires collectd to be built with Apple's
2630 IOKitLib support.
2631
2632 =item B<UdevNameAttr> I<Attribute>
2633
2634 Attempt to override disk instance name with the value of a specified udev
2635 attribute when built with B<libudev>.  If the attribute is not defined for the
2636 given device, the default name is used. Example:
2637
2638   UdevNameAttr "DM_NAME"
2639
2640 =back
2641
2642 =head2 Plugin C<dns>
2643
2644 =over 4
2645
2646 =item B<Interface> I<Interface>
2647
2648 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2649 option sets the interface that should be used. If this option is not set, or
2650 set to "any", the plugin will try to get packets from B<all> interfaces. This
2651 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2652
2653 =item B<IgnoreSource> I<IP-address>
2654
2655 Ignore packets that originate from this address.
2656
2657 =item B<SelectNumericQueryTypes> B<true>|B<false>
2658
2659 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2660
2661 =back
2662
2663 =head2 Plugin C<dpdkevents>
2664
2665 The I<dpdkevents plugin> collects events from DPDK such as link status of
2666 network ports and Keep Alive status of DPDK logical cores.
2667 In order to get Keep Alive events following requirements must be met:
2668 - DPDK >= 16.07
2669 - support for Keep Alive implemented in DPDK application. More details can
2670 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2671
2672 B<Synopsis:>
2673
2674  <Plugin "dpdkevents">
2675    <EAL>
2676      Coremask "0x1"
2677      MemoryChannels "4"
2678      FilePrefix "rte"
2679    </EAL>
2680    <Event "link_status">
2681      SendEventsOnUpdate true
2682      EnabledPortMask 0xffff
2683      PortName "interface1"
2684      PortName "interface2"
2685      SendNotification false
2686    </Event>
2687    <Event "keep_alive">
2688      SendEventsOnUpdate true
2689      LCoreMask "0xf"
2690      KeepAliveShmName "/dpdk_keepalive_shm_name"
2691      SendNotification false
2692    </Event>
2693  </Plugin>
2694
2695 B<Options:>
2696
2697
2698 =head3 The EAL block
2699
2700 =over 4
2701
2702 =item B<Coremask> I<Mask>
2703
2704 =item B<Memorychannels> I<Channels>
2705
2706 Number of memory channels per processor socket.
2707
2708 =item B<FilePrefix> I<File>
2709
2710 The prefix text used for hugepage filenames. The filename will be set to
2711 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2712
2713 =back
2714
2715 =head3 The Event block
2716
2717 The B<Event> block defines configuration for specific event. It accepts a
2718 single argument which specifies the name of the event.
2719
2720 =head4 Link Status event
2721
2722 =over 4
2723
2724 =item B<SendEventOnUpdate> I<true|false>
2725
2726 If set to true link status value will be dispatched only when it is
2727 different from previously read value. This is an optional argument - default
2728 value is true.
2729
2730 =item B<EnabledPortMask> I<Mask>
2731
2732 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2733 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2734 that all ports will be enabled. This is an optional argument - by default
2735 all ports are enabled.
2736
2737 =item B<PortName> I<Name>
2738
2739 A string containing an optional name for the enabled DPDK ports. Each PortName
2740 option should contain only one port name; specify as many PortName options as
2741 desired. Default naming convention will be used if PortName is blank. If there
2742 are less PortName options than there are enabled ports, the default naming
2743 convention will be used for the additional ports.
2744
2745 =item B<SendNotification> I<true|false>
2746
2747 If set to true, link status notifications are sent, instead of link status
2748 being collected as a statistic. This is an optional argument - default
2749 value is false.
2750
2751 =back
2752
2753 =head4 Keep Alive event
2754
2755 =over 4
2756
2757 =item B<SendEventOnUpdate> I<true|false>
2758
2759 If set to true keep alive value will be dispatched only when it is
2760 different from previously read value. This is an optional argument - default
2761 value is true.
2762
2763 =item B<LCoreMask> I<Mask>
2764
2765 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2766
2767 =item B<KeepAliveShmName> I<Name>
2768
2769 Shared memory name identifier that is used by secondary process to monitor
2770 the keep alive cores state.
2771
2772 =item B<SendNotification> I<true|false>
2773
2774 If set to true, keep alive notifications are sent, instead of keep alive
2775 information being collected as a statistic. This is an optional
2776 argument - default value is false.
2777
2778 =back
2779
2780 =head2 Plugin C<dpdkstat>
2781
2782 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2783 extended NIC stats API in DPDK.
2784
2785 B<Synopsis:>
2786
2787  <Plugin "dpdkstat">
2788    <EAL>
2789      Coremask "0x4"
2790      MemoryChannels "4"
2791      FilePrefix "rte"
2792      SocketMemory "1024"
2793      LogLevel "7"
2794      RteDriverLibPath "/usr/lib/dpdk-pmd"
2795    </EAL>
2796    SharedMemObj "dpdk_collectd_stats_0"
2797    EnabledPortMask 0xffff
2798    PortName "interface1"
2799    PortName "interface2"
2800  </Plugin>
2801
2802 B<Options:>
2803
2804 =head3 The EAL block
2805
2806 =over 4
2807
2808 =item B<Coremask> I<Mask>
2809
2810 A string containing an hexadecimal bit mask of the cores to run on. Note that
2811 core numbering can change between platforms and should be determined beforehand.
2812
2813 =item B<Memorychannels> I<Channels>
2814
2815 A string containing a number of memory channels per processor socket.
2816
2817 =item B<FilePrefix> I<File>
2818
2819 The prefix text used for hugepage filenames. The filename will be set to
2820 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2821
2822 =item B<SocketMemory> I<MB>
2823
2824 A string containing amount of Memory to allocate from hugepages on specific
2825 sockets in MB. This is an optional value.
2826
2827 =item B<LogLevel> I<LogLevel_number>
2828
2829 A string containing log level number. This parameter is optional.
2830 If parameter is not present then default value "7" - (INFO) is used.
2831 Value "8" - (DEBUG) can be set to enable debug traces.
2832
2833 =item B<RteDriverLibPath> I<Path>
2834
2835 A string containing path to shared pmd driver lib or path to directory,
2836 where shared pmd driver libs are available. This parameter is optional.
2837 This parameter enable loading of shared pmd driver libs from defined path.
2838 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2839 or    "/usr/lib/dpdk-pmd"
2840
2841 =back
2842
2843 =over 3
2844
2845 =item B<SharedMemObj> I<Mask>
2846
2847 A string containing the name of the shared memory object that should be used to
2848 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2849 Defaults to dpdk_collectd_stats if no other value is configured.
2850
2851 =item B<EnabledPortMask> I<Mask>
2852
2853 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2854 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2855 that all ports will be enabled. This is an optional argument - default
2856 is all ports enabled.
2857
2858 =item B<PortName> I<Name>
2859
2860 A string containing an optional name for the enabled DPDK ports. Each PortName
2861 option should contain only one port name; specify as many PortName options as
2862 desired. Default naming convention will be used if PortName is blank. If there
2863 are less PortName options than there are enabled ports, the default naming
2864 convention will be used for the additional ports.
2865
2866 =back
2867
2868 =head2 Plugin C<email>
2869
2870 =over 4
2871
2872 =item B<SocketFile> I<Path>
2873
2874 Sets the socket-file which is to be created.
2875
2876 =item B<SocketGroup> I<Group>
2877
2878 If running as root change the group of the UNIX-socket after it has been
2879 created. Defaults to B<collectd>.
2880
2881 =item B<SocketPerms> I<Permissions>
2882
2883 Change the file permissions of the UNIX-socket after it has been created. The
2884 permissions must be given as a numeric, octal value as you would pass to
2885 L<chmod(1)>. Defaults to B<0770>.
2886
2887 =item B<MaxConns> I<Number>
2888
2889 Sets the maximum number of connections that can be handled in parallel. Since
2890 this many threads will be started immediately setting this to a very high
2891 value will waste valuable resources. Defaults to B<5> and will be forced to be
2892 at most B<16384> to prevent typos and dumb mistakes.
2893
2894 =back
2895
2896 =head2 Plugin C<ethstat>
2897
2898 The I<ethstat plugin> collects information about network interface cards (NICs)
2899 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2900
2901 B<Synopsis:>
2902
2903  <Plugin "ethstat">
2904    Interface "eth0"
2905    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2906    Map "multicast" "if_multicast"
2907  </Plugin>
2908
2909 B<Options:>
2910
2911 =over 4
2912
2913 =item B<Interface> I<Name>
2914
2915 Collect statistical information about interface I<Name>.
2916
2917 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2918
2919 By default, the plugin will submit values as type C<derive> and I<type
2920 instance> set to I<Name>, the name of the metric as reported by the driver. If
2921 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2922 I<TypeInstance> will be used.
2923
2924 =item B<MappedOnly> B<true>|B<false>
2925
2926 When set to B<true>, only metrics that can be mapped to a I<type> will be
2927 collected, all other metrics will be ignored. Defaults to B<false>.
2928
2929 =back
2930
2931 =head2 Plugin C<exec>
2932
2933 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2934 contains valuable information on when the executable is executed and the
2935 output that is expected from it.
2936
2937 =over 4
2938
2939 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2940
2941 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2942
2943 Execute the executable I<Executable> as user I<User>. If the user name is
2944 followed by a colon and a group name, the effective group is set to that group.
2945 The real group and saved-set group will be set to the default group of that
2946 user. If no group is given the effective group ID will be the same as the real
2947 group ID.
2948
2949 Please note that in order to change the user and/or group the daemon needs
2950 superuser privileges. If the daemon is run as an unprivileged user you must
2951 specify the same user/group here. If the daemon is run with superuser
2952 privileges, you must supply a non-root user here.
2953
2954 The executable may be followed by optional arguments that are passed to the
2955 program. Please note that due to the configuration parsing numbers and boolean
2956 values may be changed. If you want to be absolutely sure that something is
2957 passed as-is please enclose it in quotes.
2958
2959 The B<Exec> and B<NotificationExec> statements change the semantics of the
2960 programs executed, i.E<nbsp>e. the data passed to them and the response
2961 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2962
2963 =back
2964
2965 =head2 Plugin C<fhcount>
2966
2967 The C<fhcount> plugin provides statistics about used, unused and total number of
2968 file handles on Linux.
2969
2970 The I<fhcount plugin> provides the following configuration options:
2971
2972 =over 4
2973
2974 =item B<ValuesAbsolute> B<true>|B<false>
2975
2976 Enables or disables reporting of file handles usage in absolute numbers,
2977 e.g. file handles used. Defaults to B<true>.
2978
2979 =item B<ValuesPercentage> B<false>|B<true>
2980
2981 Enables or disables reporting of file handles usage in percentages, e.g.
2982 percent of file handles used. Defaults to B<false>.
2983
2984 =back
2985
2986 =head2 Plugin C<filecount>
2987
2988 The C<filecount> plugin counts the number of files in a certain directory (and
2989 its subdirectories) and their combined size. The configuration is very straight
2990 forward:
2991
2992   <Plugin "filecount">
2993     <Directory "/var/qmail/queue/mess">
2994       Instance "qmail-message"
2995     </Directory>
2996     <Directory "/var/qmail/queue/todo">
2997       Instance "qmail-todo"
2998     </Directory>
2999     <Directory "/var/lib/php5">
3000       Instance "php5-sessions"
3001       Name "sess_*"
3002     </Directory>
3003   </Plugin>
3004
3005 The example above counts the number of files in QMail's queue directories and
3006 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
3007 QMail has not yet looked at, the "message" queue holds the messages that were
3008 classified into "local" and "remote".
3009
3010 As you can see, the configuration consists of one or more C<Directory> blocks,
3011 each of which specifies a directory in which to count the files. Within those
3012 blocks, the following options are recognized:
3013
3014 =over 4
3015
3016 =item B<Plugin> I<Plugin>
3017
3018 Use I<Plugin> as the plugin name when submitting values.
3019 Defaults to B<filecount>.
3020
3021 =item B<Instance> I<Instance>
3022
3023 Sets the plugin instance to I<Instance>. If not given, the instance is set to
3024 the directory name with all slashes replaced by underscores and all leading
3025 underscores removed. Empty value is allowed.
3026
3027 =item B<Name> I<Pattern>
3028
3029 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3030 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3031 against the pattern, not the entire path. In case this makes it easier for you:
3032 This option has been named after the B<-name> parameter to L<find(1)>.
3033
3034 =item B<MTime> I<Age>
3035
3036 Count only files of a specific age: If I<Age> is greater than zero, only files
3037 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3038 a negative number, this is inversed. For example, if B<-60> is specified, only
3039 files that have been modified in the last minute will be counted.
3040
3041 The number can also be followed by a "multiplier" to easily specify a larger
3042 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3043 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3044 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3045 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3046 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3047 B<"12h">.
3048
3049 =item B<Size> I<Size>
3050
3051 Count only files of a specific size. When I<Size> is a positive number, only
3052 files that are at least this big are counted. If I<Size> is a negative number,
3053 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3054 I<Size> are counted.
3055
3056 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3057 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3058 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3059 note that there are 1000 bytes in a kilobyte, not 1024.
3060
3061 =item B<Recursive> I<true>|I<false>
3062
3063 Controls whether or not to recurse into subdirectories. Enabled by default.
3064
3065 =item B<IncludeHidden> I<true>|I<false>
3066
3067 Controls whether or not to include "hidden" files and directories in the count.
3068 "Hidden" files and directories are those, whose name begins with a dot.
3069 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3070
3071 =item B<RegularOnly> I<true>|I<false>
3072
3073 Controls whether or not to include only regular files in the count.
3074 Defaults to I<true>, i.e. by default non regular files are ignored.
3075
3076 =item B<FilesSizeType> I<Type>
3077
3078 Sets the type used to dispatch files combined size. Empty value ("") disables
3079 reporting. Defaults to B<bytes>.
3080
3081 =item B<FilesCountType> I<Type>
3082
3083 Sets the type used to dispatch number of files. Empty value ("") disables
3084 reporting. Defaults to B<files>.
3085
3086 =item B<TypeInstance> I<Instance>
3087
3088 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3089 (no plugin instance).
3090
3091 =back
3092
3093 =head2 Plugin C<GenericJMX>
3094
3095 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3096 L<collectd-java(5)>.
3097
3098 =head2 Plugin C<gmond>
3099
3100 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3101 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3102 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3103
3104 Synopsis:
3105
3106  <Plugin "gmond">
3107    MCReceiveFrom "239.2.11.71" "8649"
3108    <Metric "swap_total">
3109      Type "swap"
3110      TypeInstance "total"
3111      DataSource "value"
3112    </Metric>
3113    <Metric "swap_free">
3114      Type "swap"
3115      TypeInstance "free"
3116      DataSource "value"
3117    </Metric>
3118  </Plugin>
3119
3120 The following metrics are built-in:
3121
3122 =over 4
3123
3124 =item *
3125
3126 load_one, load_five, load_fifteen
3127
3128 =item *
3129
3130 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3131
3132 =item *
3133
3134 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3135
3136 =item *
3137
3138 bytes_in, bytes_out
3139
3140 =item *
3141
3142 pkts_in, pkts_out
3143
3144 =back
3145
3146 Available configuration options:
3147
3148 =over 4
3149
3150 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3151
3152 Sets sets the multicast group and UDP port to which to subscribe.
3153
3154 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3155
3156 =item E<lt>B<Metric> I<Name>E<gt>
3157
3158 These blocks add a new metric conversion to the internal table. I<Name>, the
3159 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3160
3161 =over 4
3162
3163 =item B<Type> I<Type>
3164
3165 Type to map this metric to. Required.
3166
3167 =item B<TypeInstance> I<Instance>
3168
3169 Type-instance to use. Optional.
3170
3171 =item B<DataSource> I<Name>
3172
3173 Data source to map this metric to. If the configured type has exactly one data
3174 source, this is optional. Otherwise the option is required.
3175
3176 =back
3177
3178 =back
3179
3180 =head2 Plugin C<gps>
3181
3182 The C<gps plugin> connects to gpsd on the host machine.
3183 The host, port, timeout and pause are configurable.
3184
3185 This is useful if you run an NTP server using a GPS for source and you want to
3186 monitor it.
3187
3188 Mind your GPS must send $--GSA for having the data reported!
3189
3190 The following elements are collected:
3191
3192 =over 4
3193
3194 =item B<satellites>
3195
3196 Number of satellites used for fix (type instance "used") and in view (type
3197 instance "visible"). 0 means no GPS satellites are visible.
3198
3199 =item B<dilution_of_precision>
3200
3201 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3202 It should be between 0 and 3.
3203 Look at the documentation of your GPS to know more.
3204
3205 =back
3206
3207 Synopsis:
3208
3209  LoadPlugin gps
3210  <Plugin "gps">
3211    # Connect to localhost on gpsd regular port:
3212    Host "127.0.0.1"
3213    Port "2947"
3214    # 15 ms timeout
3215    Timeout 0.015
3216    # PauseConnect of 5 sec. between connection attempts.
3217    PauseConnect 5
3218  </Plugin>
3219
3220 Available configuration options:
3221
3222 =over 4
3223
3224 =item B<Host> I<Host>
3225
3226 The host on which gpsd daemon runs. Defaults to B<localhost>.
3227
3228 =item B<Port> I<Port>
3229
3230 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3231
3232 =item B<Timeout> I<Seconds>
3233
3234 Timeout in seconds (default 0.015 sec).
3235
3236 The GPS data stream is fetch by the plugin form the daemon.
3237 It waits for data to be available, if none arrives it times out
3238 and loop for another reading.
3239 Mind to put a low value gpsd expects value in the micro-seconds area
3240 (recommended is 500 us) since the waiting function is blocking.
3241 Value must be between 500 us and 5 sec., if outside that range the
3242 default value is applied.
3243
3244 This only applies from gpsd release-2.95.
3245
3246 =item B<PauseConnect> I<Seconds>
3247
3248 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3249
3250 =back
3251
3252 =head2 Plugin C<gpu_nvidia>
3253
3254 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3255 NVML library. Currently collected are fan speed, core temperature, percent
3256 load, percent memory used, compute and memory frequencies, and power
3257 consumption.
3258
3259 =over 4
3260
3261 =item B<GPUIndex>
3262
3263 If one or more of these options is specified, only GPUs at that index (as
3264 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3265 If no instance of this option is specified, all GPUs are monitored.
3266
3267 =item B<IgnoreSelected>
3268
3269 If set to true, all detected GPUs B<except> the ones at indices specified by
3270 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3271 without any GPUIndex directives will result in B<no> statistics being
3272 collected.
3273
3274 =back
3275
3276 =head2 Plugin C<grpc>
3277
3278 The I<grpc> plugin provides an RPC interface to submit values to or query
3279 values from collectd based on the open source gRPC framework. It exposes an
3280 end-point for dispatching values to the daemon.
3281
3282 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3283
3284 =over 4
3285
3286 =item B<Server> I<Host> I<Port>
3287
3288 The B<Server> statement sets the address of a server to which to send metrics
3289 via the C<DispatchValues> function.
3290
3291 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3292
3293 Optionally, B<Server> may be specified as a configuration block which supports
3294 the following options:
3295
3296 =over 4
3297
3298 =item B<EnableSSL> B<false>|B<true>
3299
3300 Whether to require SSL for outgoing connections. Default: false.
3301
3302 =item B<SSLCACertificateFile> I<Filename>
3303
3304 =item B<SSLCertificateFile> I<Filename>
3305
3306 =item B<SSLCertificateKeyFile> I<Filename>
3307
3308 Filenames specifying SSL certificate and key material to be used with SSL
3309 connections.
3310
3311 =back
3312
3313 =item B<Listen> I<Host> I<Port>
3314
3315 The B<Listen> statement sets the network address to bind to. When multiple
3316 statements are specified, the daemon will bind to all of them. If none are
3317 specified, it defaults to B<0.0.0.0:50051>.
3318
3319 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3320
3321 Optionally, B<Listen> may be specified as a configuration block which
3322 supports the following options:
3323
3324 =over 4
3325
3326 =item B<EnableSSL> I<true>|I<false>
3327
3328 Whether to enable SSL for incoming connections. Default: false.
3329
3330 =item B<SSLCACertificateFile> I<Filename>
3331
3332 =item B<SSLCertificateFile> I<Filename>
3333
3334 =item B<SSLCertificateKeyFile> I<Filename>
3335
3336 Filenames specifying SSL certificate and key material to be used with SSL
3337 connections.
3338
3339 =item B<VerifyPeer> B<true>|B<false>
3340
3341 When enabled, a valid client certificate is required to connect to the server.
3342 When disabled, a client certifiacte is not requested and any unsolicited client
3343 certificate is accepted.
3344 Enabled by default.
3345
3346 =back
3347
3348 =back
3349
3350 =head2 Plugin C<hddtemp>
3351
3352 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3353 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3354 default values, see below. C<hddtemp> has to be running to work correctly. If
3355 C<hddtemp> is not running timeouts may appear which may interfere with other
3356 statistics..
3357
3358 The B<hddtemp> homepage can be found at
3359 L<http://www.guzu.net/linux/hddtemp.php>.
3360
3361 =over 4
3362
3363 =item B<Host> I<Hostname>
3364
3365 Hostname to connect to. Defaults to B<127.0.0.1>.
3366
3367 =item B<Port> I<Port>
3368
3369 TCP-Port to connect to. Defaults to B<7634>.
3370
3371 =back
3372
3373 =head2 Plugin C<hugepages>
3374
3375 To collect B<hugepages> information, collectd reads directories
3376 "/sys/devices/system/node/*/hugepages" and
3377 "/sys/kernel/mm/hugepages".
3378 Reading of these directories can be disabled by the following
3379 options (default is enabled).
3380
3381 =over 4
3382
3383 =item B<ReportPerNodeHP> B<true>|B<false>
3384
3385 If enabled, information will be collected from the hugepage
3386 counters in "/sys/devices/system/node/*/hugepages".
3387 This is used to check the per-node hugepage statistics on
3388 a NUMA system.
3389
3390 =item B<ReportRootHP> B<true>|B<false>
3391
3392 If enabled, information will be collected from the hugepage
3393 counters in "/sys/kernel/mm/hugepages".
3394 This can be used on both NUMA and non-NUMA systems to check
3395 the overall hugepage statistics.
3396
3397 =item B<ValuesPages> B<true>|B<false>
3398
3399 Whether to report hugepages metrics in number of pages.
3400 Defaults to B<true>.
3401
3402 =item B<ValuesBytes> B<false>|B<true>
3403
3404 Whether to report hugepages metrics in bytes.
3405 Defaults to B<false>.
3406
3407 =item B<ValuesPercentage> B<false>|B<true>
3408
3409 Whether to report hugepages metrics as percentage.
3410 Defaults to B<false>.
3411
3412 =back
3413
3414 =head2 Plugin C<intel_pmu>
3415
3416 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3417 Linux perf interface. All events are reported on a per core basis.
3418
3419 B<Synopsis:>
3420
3421   <Plugin intel_pmu>
3422     ReportHardwareCacheEvents true
3423     ReportKernelPMUEvents true
3424     ReportSoftwareEvents true
3425     EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3426     HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3427     Cores "0-3" "4,6" "[12-15]"
3428   </Plugin>
3429
3430 B<Options:>
3431
3432 =over 4
3433
3434 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3435
3436 Enable or disable measuring of hardware CPU cache events:
3437   - L1-dcache-loads
3438   - L1-dcache-load-misses
3439   - L1-dcache-stores
3440   - L1-dcache-store-misses
3441   - L1-dcache-prefetches
3442   - L1-dcache-prefetch-misses
3443   - L1-icache-loads
3444   - L1-icache-load-misses
3445   - L1-icache-prefetches
3446   - L1-icache-prefetch-misses
3447   - LLC-loads
3448   - LLC-load-misses
3449   - LLC-stores
3450   - LLC-store-misses
3451   - LLC-prefetches
3452   - LLC-prefetch-misses
3453   - dTLB-loads
3454   - dTLB-load-misses
3455   - dTLB-stores
3456   - dTLB-store-misses
3457   - dTLB-prefetches
3458   - dTLB-prefetch-misses
3459   - iTLB-loads
3460   - iTLB-load-misses
3461   - branch-loads
3462   - branch-load-misses
3463
3464 =item B<ReportKernelPMUEvents> B<false>|B<true>
3465
3466 Enable or disable measuring of the following events:
3467   - cpu-cycles
3468   - instructions
3469   - cache-references
3470   - cache-misses
3471   - branches
3472   - branch-misses
3473   - bus-cycles
3474
3475 =item B<ReportSoftwareEvents> B<false>|B<true>
3476
3477 Enable or disable measuring of software events provided by kernel:
3478   - cpu-clock
3479   - task-clock
3480   - context-switches
3481   - cpu-migrations
3482   - page-faults
3483   - minor-faults
3484   - major-faults
3485   - alignment-faults
3486   - emulation-faults
3487
3488 =item B<EventList> I<filename>
3489
3490 JSON performance counter event list file name. To be able to monitor all Intel
3491 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3492 event_download.py script to download event list for current CPU.
3493
3494 =item B<HardwareEvents> I<events>
3495
3496 This field is a list of event names or groups of comma separated event names.
3497 This option requires B<EventList> option to be configured.
3498
3499 =item B<Cores> I<cores groups>
3500
3501 All events are reported on a per core basis. Monitoring of the events can be
3502 configured for a group of cores (aggregated statistics). This field defines
3503 groups of cores on which to monitor supported events. The field is represented
3504 as list of strings with core group values. Each string represents a list of
3505 cores in a group. If a group is enclosed in square brackets each core is added
3506 individually to a separate group (that is statistics are not aggregated).
3507 Allowed formats are:
3508     0,1,2,3
3509     0-10,20-18
3510     1,3,5-8,10,0x10-12
3511     [4-15,32-63]
3512
3513 If an empty string is provided as value for this field default cores
3514 configuration is applied - that is separate group is created for each core.
3515
3516 =back
3517
3518 =head2 Plugin C<intel_rdt>
3519
3520 The I<intel_rdt> plugin collects information provided by monitoring features of
3521 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3522 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3523 information about utilization of shared resources. CMT monitors last level cache
3524 occupancy (LLC). MBM supports two types of events reporting local and remote
3525 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3526 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3527 reports the bandwidth of accessing the remote socket. Also this technology
3528 allows to monitor instructions per clock (IPC).
3529 Monitor events are hardware dependant. Monitoring capabilities are detected on
3530 plugin initialization and only supported events are monitored.
3531
3532 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3533 require an additional capability to be enabled if collectd is run as a service.
3534 Please refer to I<contrib/systemd.collectd.service> file for more details.
3535
3536 B<Synopsis:>
3537
3538   <Plugin "intel_rdt">
3539     Cores "0-2" "3,4,6" "8-10,15"
3540   </Plugin>
3541
3542 B<Options:>
3543
3544 =over 4
3545
3546 =item B<Interval> I<seconds>
3547
3548 The interval within which to retrieve statistics on monitored events in seconds.
3549 For milliseconds divide the time by 1000 for example if the desired interval
3550 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3551 recommended to set interval higher than 1 sec.
3552
3553 =item B<Cores> I<cores groups>
3554
3555 All events are reported on a per core basis. Monitoring of the events can be
3556 configured for group of cores (aggregated statistics). This field defines groups
3557 of cores on which to monitor supported events. The field is represented as list
3558 of strings with core group values. Each string represents a list of cores in a
3559 group. Allowed formats are:
3560     0,1,2,3
3561     0-10,20-18
3562     1,3,5-8,10,0x10-12
3563
3564 If an empty string is provided as value for this field default cores
3565 configuration is applied - a separate group is created for each core.
3566
3567 =back
3568
3569 B<Note:> By default global interval is used to retrieve statistics on monitored
3570 events. To configure a plugin specific interval use B<Interval> option of the
3571 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3572 example if the desired interval is 50ms, set interval to 0.05.
3573 Due to limited capacity of counters it is not recommended to set interval higher
3574 than 1 sec.
3575
3576 =head2 Plugin C<interface>
3577
3578 =over 4
3579
3580 =item B<Interface> I<Interface>
3581
3582 Select this interface. By default these interfaces will then be collected. For
3583 a more detailed description see B<IgnoreSelected> below.
3584
3585 See F</"IGNORELISTS"> for details.
3586
3587 =item B<IgnoreSelected> I<true>|I<false>
3588
3589 If no configuration is given, the B<interface>-plugin will collect data from
3590 all interfaces. This may not be practical, especially for loopback- and
3591 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3592 interfaces you're interested in. Sometimes, however, it's easier/preferred
3593 to collect all interfaces I<except> a few ones. This option enables you to
3594 do that: By setting B<IgnoreSelected> to I<true> the effect of
3595 B<Interface> is inverted: All selected interfaces are ignored and all
3596 other interfaces are collected.
3597
3598 It is possible to use regular expressions to match interface names, if the
3599 name is surrounded by I</.../> and collectd was compiled with support for
3600 regexps. This is useful if there's a need to collect (or ignore) data
3601 for a group of interfaces that are similarly named, without the need to
3602 explicitly list all of them (especially useful if the list is dynamic).
3603 Example:
3604
3605  Interface "lo"
3606  Interface "/^veth/"
3607  Interface "/^tun[0-9]+/"
3608  IgnoreSelected "true"
3609
3610 This will ignore the loopback interface, all interfaces with names starting
3611 with I<veth> and all interfaces with names starting with I<tun> followed by
3612 at least one digit.
3613
3614 =item B<ReportInactive> I<true>|I<false>
3615
3616 When set to I<false>, only interfaces with non-zero traffic will be
3617 reported. Note that the check is done by looking into whether a
3618 package was sent at any time from boot and the corresponding counter
3619 is non-zero. So, if the interface has been sending data in the past
3620 since boot, but not during the reported time-interval, it will still
3621 be reported.
3622
3623 The default value is I<true> and results in collection of the data
3624 from all interfaces that are selected by B<Interface> and
3625 B<IgnoreSelected> options.
3626
3627 =item B<UniqueName> I<true>|I<false>
3628
3629 Interface name is not unique on Solaris (KSTAT), interface name is unique
3630 only within a module/instance. Following tuple is considered unique:
3631    (ks_module, ks_instance, ks_name)
3632 If this option is set to true, interface name contains above three fields
3633 separated by an underscore. For more info on KSTAT, visit
3634 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3635
3636 This option is only available on Solaris.
3637
3638 =back
3639
3640 =head2 Plugin C<ipmi>
3641
3642 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3643 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3644
3645 The plugin configuration consists of one or more B<Instance> blocks which
3646 specify one I<ipmi> connection each. Each block requires one unique string
3647 argument as the instance name. If instances are not configured, an instance with
3648 the default option values will be created.
3649
3650 For backwards compatibility, any option other than B<Instance> block will trigger
3651 legacy config handling and it will be treated as an option within B<Instance>
3652 block. This support will go away in the next major version of Collectd.
3653
3654 Within the B<Instance> blocks, the following options are allowed:
3655
3656 =over 4
3657
3658 =item B<Address> I<Address>
3659
3660 Hostname or IP to connect to. If not specified, plugin will try to connect to
3661 local management controller (BMC).
3662
3663 =item B<Username> I<Username>
3664
3665 =item B<Password> I<Password>
3666
3667 The username and the password to use for the connection to remote BMC.
3668
3669 =item B<AuthType> I<MD5>|I<rmcp+>
3670
3671 Forces the authentication type to use for the connection to remote BMC.
3672 By default most secure type is seleted.
3673
3674 =item B<Host> I<Hostname>
3675
3676 Sets the B<host> field of dispatched values. Defaults to the global hostname
3677 setting.
3678
3679 =item B<Sensor> I<Sensor>
3680
3681 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3682
3683 See F</"IGNORELISTS"> for details.
3684
3685 =item B<IgnoreSelected> I<true>|I<false>
3686
3687 If no configuration if given, the B<ipmi> plugin will collect data from all
3688 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3689 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3690 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3691 all other sensors are collected.
3692
3693 =item B<NotifySensorAdd> I<true>|I<false>
3694
3695 If a sensor appears after initialization time of a minute a notification
3696 is sent.
3697
3698 =item B<NotifySensorRemove> I<true>|I<false>
3699
3700 If a sensor disappears a notification is sent.
3701
3702 =item B<NotifySensorNotPresent> I<true>|I<false>
3703
3704 If you have for example dual power supply and one of them is (un)plugged then
3705 a notification is sent.
3706
3707 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3708
3709 If a IPMI connection state changes after initialization time of a minute
3710 a notification is sent. Defaults to B<false>.
3711
3712 =item B<SELEnabled> I<true>|I<false>
3713
3714 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3715 and discrete events. When event is received the notification is sent.
3716 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3717 config options.
3718 Defaults to B<false>.
3719
3720 =item B<SELSensor> I<SELSensor>
3721
3722 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3723
3724 See F</"IGNORELISTS"> for details.
3725
3726 =item B<SELIgnoreSelected> I<true>|I<false>
3727
3728 If no configuration is given, the B<ipmi> plugin will pass events from all
3729 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3730 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3731 sensors are ignored and all events from other sensors are passed.
3732
3733 =item B<SELClearEvent> I<true>|I<false>
3734
3735 If SEL clear event is enabled, plugin will delete event from SEL list after
3736 it is received and successfully handled. In this case other tools that are
3737 subscribed for SEL events will receive an empty event.
3738 Defaults to B<false>.
3739
3740 =back
3741
3742 =head2 Plugin C<iptables>
3743
3744 =over 4
3745
3746 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3747
3748 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3749
3750 Select the iptables/ip6tables filter rules to count packets and bytes from.
3751
3752 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3753 of all rules which have a comment-match. The comment is then used as
3754 type-instance.
3755
3756 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3757 the I<n>th rule will be collected. Again, the comment (or the number) will be
3758 used as the type-instance.
3759
3760 If I<Name> is supplied, it will be used as the type-instance instead of the
3761 comment or the number.
3762
3763 =back
3764
3765 =head2 Plugin C<irq>
3766
3767 =over 4
3768
3769 =item B<Irq> I<Irq>
3770
3771 Select this irq. By default these irqs will then be collected. For a more
3772 detailed description see B<IgnoreSelected> below.
3773
3774 See F</"IGNORELISTS"> for details.
3775
3776 =item B<IgnoreSelected> I<true>|I<false>
3777
3778 If no configuration if given, the B<irq>-plugin will collect data from all
3779 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3780 can use the B<Irq>-option to pick the interrupt you're interested in.
3781 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3782 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3783 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3784 and all other interrupts are collected.
3785
3786 =back
3787
3788 =head2 Plugin C<java>
3789
3790 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3791 This section only discusses the syntax and semantic of the configuration
3792 options. For more in-depth information on the I<Java> plugin, please read
3793 L<collectd-java(5)>.
3794
3795 Synopsis:
3796
3797  <Plugin "java">
3798    JVMArg "-verbose:jni"
3799    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3800    LoadPlugin "org.collectd.java.Foobar"
3801    <Plugin "org.collectd.java.Foobar">
3802      # To be parsed by the plugin
3803    </Plugin>
3804  </Plugin>
3805
3806 Available configuration options:
3807
3808 =over 4
3809
3810 =item B<JVMArg> I<Argument>
3811
3812 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3813 exactly the way the arguments to the I<java> binary on the command line work.
3814 Execute C<javaE<nbsp>--help> for details.
3815
3816 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3817 any other options! When another option is found, the JVM will be started and
3818 later options will have to be ignored!
3819
3820 =item B<LoadPlugin> I<JavaClass>
3821
3822 Instantiates a new I<JavaClass> object. The constructor of this object very
3823 likely then registers one or more callback methods with the server.
3824
3825 See L<collectd-java(5)> for details.
3826
3827 When the first such option is found, the virtual machine (JVM) is created. This
3828 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3829 B<LoadPlugin> options!
3830
3831 =item B<Plugin> I<Name>
3832
3833 The entire block is passed to the Java plugin as an
3834 I<org.collectd.api.OConfigItem> object.
3835
3836 For this to work, the plugin has to register a configuration callback first,
3837 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3838 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3839 depends on the (Java) plugin registering the callback and is completely
3840 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3841
3842 =back
3843
3844 =head2 Plugin C<load>
3845
3846 The I<Load plugin> collects the system load. These numbers give a rough overview
3847 over the utilization of a machine. The system load is defined as the number of
3848 runnable tasks in the run-queue and is provided by many operating systems as a
3849 one, five or fifteen minute average.
3850
3851 The following configuration options are available:
3852
3853 =over 4
3854
3855 =item B<ReportRelative> B<false>|B<true>
3856
3857 When enabled, system load divided by number of available CPU cores is reported
3858 for intervals 1 min, 5 min and 15 min. Defaults to false.
3859
3860 =back
3861
3862
3863 =head2 Plugin C<logfile>
3864
3865 =over 4
3866
3867 =item B<LogLevel> B<debug|info|notice|warning|err>
3868
3869 Sets the log-level. If, for example, set to B<notice>, then all events with
3870 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3871
3872 Please note that B<debug> is only available if collectd has been compiled with
3873 debugging support.
3874
3875 =item B<File> I<File>
3876
3877 Sets the file to write log messages to. The special strings B<stdout> and
3878 B<stderr> can be used to write to the standard output and standard error
3879 channels, respectively. This, of course, only makes much sense when I<collectd>
3880 is running in foreground- or non-daemon-mode.
3881
3882 =item B<Timestamp> B<true>|B<false>
3883
3884 Prefix all lines printed by the current time. Defaults to B<true>.
3885
3886 =item B<PrintSeverity> B<true>|B<false>
3887
3888 When enabled, all lines are prefixed by the severity of the log message, for
3889 example "warning". Defaults to B<false>.
3890
3891 =back
3892
3893 B<Note>: There is no need to notify the daemon after moving or removing the
3894 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3895 for each line it writes.
3896
3897 =head2 Plugin C<log_logstash>
3898
3899 The I<log logstash plugin> behaves like the logfile plugin but formats
3900 messages as JSON events for logstash to parse and input.
3901
3902 =over 4
3903
3904 =item B<LogLevel> B<debug|info|notice|warning|err>
3905
3906 Sets the log-level. If, for example, set to B<notice>, then all events with
3907 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3908
3909 Please note that B<debug> is only available if collectd has been compiled with
3910 debugging support.
3911
3912 =item B<File> I<File>
3913
3914 Sets the file to write log messages to. The special strings B<stdout> and
3915 B<stderr> can be used to write to the standard output and standard error
3916 channels, respectively. This, of course, only makes much sense when I<collectd>
3917 is running in foreground- or non-daemon-mode.
3918
3919 =back
3920
3921 B<Note>: There is no need to notify the daemon after moving or removing the
3922 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3923 for each line it writes.
3924
3925 =head2 Plugin C<lpar>
3926
3927 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3928 virtualization technique for IBM POWER processors. It takes into account CPU
3929 time stolen from or donated to a partition, in addition to the usual user,
3930 system, I/O statistics.
3931
3932 The following configuration options are available:
3933
3934 =over 4
3935
3936 =item B<CpuPoolStats> B<false>|B<true>
3937
3938 When enabled, statistics about the processor pool are read, too. The partition
3939 needs to have pool authority in order to be able to acquire this information.
3940 Defaults to false.
3941
3942 =item B<ReportBySerial> B<false>|B<true>
3943
3944 If enabled, the serial of the physical machine the partition is currently
3945 running on is reported as I<hostname> and the logical hostname of the machine
3946 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3947 used (just like other plugins) and the I<plugin instance> will be empty.
3948 Defaults to false.
3949
3950 =back
3951
3952 =head2 Plugin C<lua>
3953
3954 This plugin embeds a Lua interpreter into collectd and provides an interface
3955 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3956
3957
3958 =head2 Plugin C<mbmon>
3959
3960 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3961
3962 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3963 B<Host> and B<Port> options can be used to change these values, see below.
3964 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3965 timeouts may appear which may interfere with other statistics..
3966
3967 C<mbmon> must be run with the -r option ("print TAG and Value format");
3968 Debian's F</etc/init.d/mbmon> script already does this, other people
3969 will need to ensure that this is the case.
3970
3971 =over 4
3972
3973 =item B<Host> I<Hostname>
3974
3975 Hostname to connect to. Defaults to B<127.0.0.1>.
3976
3977 =item B<Port> I<Port>
3978
3979 TCP-Port to connect to. Defaults to B<411>.
3980
3981 =back
3982
3983 =head2 Plugin C<mcelog>
3984
3985 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3986
3987 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3988 mcelog server is running. When the server is running, the plugin will tail the
3989 specified logfile to retrieve machine check exception information and send a
3990 notification with the details from the logfile. The plugin will use the mcelog
3991 client protocol to retrieve memory related machine check exceptions. Note that
3992 for memory exceptions, notifications are only sent when there is a change in
3993 the number of corrected/uncorrected memory errors.
3994
3995 =head3 The Memory block
3996
3997 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3998 exclusive.
3999
4000 =over 3
4001
4002 =item B<McelogClientSocket> I<Path>
4003 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
4004 Defaults to B<"/var/run/mcelog-client">.
4005
4006 =item B<PersistentNotification> B<true>|B<false>
4007 Override default configuration to only send notifications when sent when there
4008 is a change in the number of corrected/uncorrected memory errors. When set to
4009 true notifications will be sent for every read cycle. Default is false. Does
4010 not affect the stats being dispatched.
4011
4012 =back
4013
4014 =over 4
4015
4016 =item B<McelogLogfile> I<Path>
4017
4018 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
4019 cannot be used in conjunction with the memory block options, they are mutually
4020 exclusive.
4021
4022 =back
4023
4024 =head2 Plugin C<md>
4025
4026 The C<md plugin> collects information from Linux Software-RAID devices (md).
4027
4028 All reported values are of the type C<md_disks>. Reported type instances are
4029 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
4030 I<missing> (physically absent) disks.
4031
4032 =over 4
4033
4034 =item B<Device> I<Device>
4035
4036 Select md devices based on device name. The I<device name> is the basename of
4037 the device, i.e. the name of the block device without the leading C</dev/>.
4038 See B<IgnoreSelected> for more details.
4039
4040 See F</"IGNORELISTS"> for details.
4041
4042 =item B<IgnoreSelected> B<true>|B<false>
4043
4044 Invert device selection: If set to B<true>, all md devices B<except> those
4045 listed using B<Device> are collected. If B<false> (the default), only those
4046 listed are collected. If no configuration is given, the B<md> plugin will
4047 collect data from all md devices.
4048
4049 =back
4050
4051 =head2 Plugin C<memcachec>
4052
4053 The C<memcachec plugin> connects to a memcached server, queries one or more
4054 given I<pages> and parses the returned data according to user specification.
4055 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4056 plugins.
4057
4058 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4059 library. Please note that there is another library with a very similar name,
4060 libmemcache (notice the missing `d'), which is not applicable.
4061
4062 Synopsis of the configuration:
4063
4064  <Plugin "memcachec">
4065    <Page "plugin_instance">
4066      Server "localhost"
4067      Key "page_key"
4068      Plugin "plugin_name"
4069      <Match>
4070        Regex "(\\d+) bytes sent"
4071        DSType CounterAdd
4072        Type "ipt_octets"
4073        Instance "type_instance"
4074      </Match>
4075    </Page>
4076  </Plugin>
4077
4078 The configuration options are:
4079
4080 =over 4
4081
4082 =item E<lt>B<Page> I<Name>E<gt>
4083
4084 Each B<Page> block defines one I<page> to be queried from the memcached server.
4085 The block requires one string argument which is used as I<plugin instance>.
4086
4087 =item B<Server> I<Address>
4088
4089 Sets the server address to connect to when querying the page. Must be inside a
4090 B<Page> block.
4091
4092 =item B<Key> I<Key>
4093
4094 When connected to the memcached server, asks for the page I<Key>.
4095
4096 =item B<Plugin> I<Plugin>
4097
4098 Use I<Plugin> as the plugin name when submitting values.
4099 Defaults to C<memcachec>.
4100
4101 =item E<lt>B<Match>E<gt>
4102
4103 Match blocks define which strings to look for and how matches substrings are
4104 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4105
4106 =back
4107
4108 =head2 Plugin C<memcached>
4109
4110 The B<memcached plugin> connects to a memcached server and queries statistics
4111 about cache utilization, memory and bandwidth used.
4112 L<http://memcached.org/>
4113
4114  <Plugin "memcached">
4115    <Instance "name">
4116      #Host "memcache.example.com"
4117      Address "127.0.0.1"
4118      Port 11211
4119    </Instance>
4120  </Plugin>
4121
4122 The plugin configuration consists of one or more B<Instance> blocks which
4123 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4124 following options are allowed:
4125
4126 =over 4
4127
4128 =item B<Host> I<Hostname>
4129
4130 Sets the B<host> field of dispatched values. Defaults to the global hostname
4131 setting.
4132 For backwards compatibility, values are also dispatched with the global
4133 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4134 not set.
4135
4136 =item B<Address> I<Address>
4137
4138 Hostname or IP to connect to. For backwards compatibility, defaults to the
4139 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4140
4141 =item B<Port> I<Port>
4142
4143 TCP port to connect to. Defaults to B<11211>.
4144
4145 =item B<Socket> I<Path>
4146
4147 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4148 setting is given, the B<Address> and B<Port> settings are ignored.
4149
4150 =back
4151
4152 =head2 Plugin C<mic>
4153
4154 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4155 Intel's Many Integrated Core (MIC) systems.
4156
4157 B<Synopsis:>
4158
4159  <Plugin mic>
4160    ShowCPU true
4161    ShowCPUCores true
4162    ShowMemory true
4163
4164    ShowTemperatures true
4165    Temperature vddg
4166    Temperature vddq
4167    IgnoreSelectedTemperature true
4168
4169    ShowPower true
4170    Power total0
4171    Power total1
4172    IgnoreSelectedPower true
4173  </Plugin>
4174
4175 The following options are valid inside the B<PluginE<nbsp>mic> block:
4176
4177 =over 4
4178
4179 =item B<ShowCPU> B<true>|B<false>
4180
4181 If enabled (the default) a sum of the CPU usage across all cores is reported.
4182
4183 =item B<ShowCPUCores> B<true>|B<false>
4184
4185 If enabled (the default) per-core CPU usage is reported.
4186
4187 =item B<ShowMemory> B<true>|B<false>
4188
4189 If enabled (the default) the physical memory usage of the MIC system is
4190 reported.
4191
4192 =item B<ShowTemperatures> B<true>|B<false>
4193
4194 If enabled (the default) various temperatures of the MIC system are reported.
4195
4196 =item B<Temperature> I<Name>
4197
4198 This option controls which temperatures are being reported. Whether matching
4199 temperatures are being ignored or I<only> matching temperatures are reported
4200 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4201 temperatures are reported.
4202
4203 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4204
4205 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4206 (the default) only temperatures matching a B<Temperature> option are reported
4207 or, if no B<Temperature> option is specified, all temperatures are reported. If
4208 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4209 are reported.
4210
4211 Known temperature names are:
4212
4213 =over 4
4214
4215 =item die
4216
4217 Die of the CPU
4218
4219 =item devmem
4220
4221 Device Memory
4222
4223 =item fin
4224
4225 Fan In
4226
4227 =item fout
4228
4229 Fan Out
4230
4231 =item vccp
4232
4233 Voltage ccp
4234
4235 =item vddg
4236
4237 Voltage ddg
4238
4239 =item vddq
4240
4241 Voltage ddq
4242
4243 =back
4244
4245 =item B<ShowPower> B<true>|B<false>
4246
4247 If enabled (the default) various temperatures of the MIC system are reported.
4248
4249 =item B<Power> I<Name>
4250
4251 This option controls which power readings are being reported. Whether matching
4252 power readings are being ignored or I<only> matching power readings are reported
4253 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4254 power readings are reported.
4255
4256 =item B<IgnoreSelectedPower> B<false>|B<true>
4257
4258 Controls the behavior of the B<Power> setting above. If set to B<false>
4259 (the default) only power readings matching a B<Power> option are reported
4260 or, if no B<Power> option is specified, all power readings are reported. If
4261 set to B<true>, matching power readings are I<ignored> and all other power readings
4262 are reported.
4263
4264 Known power names are:
4265
4266 =over 4
4267
4268 =item total0
4269
4270 Total power utilization averaged over Time Window 0 (uWatts).
4271
4272 =item total1
4273
4274 Total power utilization averaged over Time Window 0 (uWatts).
4275
4276 =item inst
4277
4278 Instantaneous power (uWatts).
4279
4280 =item imax
4281
4282 Max instantaneous power (uWatts).
4283
4284 =item pcie
4285
4286 PCI-E connector power (uWatts).
4287
4288 =item c2x3
4289
4290 2x3 connector power (uWatts).
4291
4292 =item c2x4
4293
4294 2x4 connector power (uWatts).
4295
4296 =item vccp
4297
4298 Core rail (uVolts).
4299
4300 =item vddg
4301
4302 Uncore rail (uVolts).
4303
4304 =item vddq
4305
4306 Memory subsystem rail (uVolts).
4307
4308 =back
4309
4310 =back
4311
4312 =head2 Plugin C<memory>
4313
4314 The I<memory plugin> provides the following configuration options:
4315
4316 =over 4
4317
4318 =item B<ValuesAbsolute> B<true>|B<false>
4319
4320 Enables or disables reporting of physical memory usage in absolute numbers,
4321 i.e. bytes. Defaults to B<true>.
4322
4323 =item B<ValuesPercentage> B<false>|B<true>
4324
4325 Enables or disables reporting of physical memory usage in percentages, e.g.
4326 percent of physical memory used. Defaults to B<false>.
4327
4328 This is useful for deploying I<collectd> in a heterogeneous environment in
4329 which the sizes of physical memory vary.
4330
4331 =back
4332
4333 =head2 Plugin C<modbus>
4334
4335 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4336 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4337 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4338 floating point values (two registers interpreted as IEEE floats in big endian
4339 notation).
4340
4341 B<Synopsis:>
4342
4343  <Data "voltage-input-1">
4344    RegisterBase 0
4345    RegisterType float
4346    RegisterCmd ReadHolding
4347    Type voltage
4348    Instance "input-1"
4349    #Scale 1.0
4350    #Shift 0.0
4351  </Data>
4352
4353  <Data "voltage-input-2">
4354    RegisterBase 2
4355    RegisterType float
4356    RegisterCmd ReadHolding
4357    Type voltage
4358    Instance "input-2"
4359  </Data>
4360
4361  <Data "supply-temperature-1">
4362    RegisterBase 0
4363    RegisterType Int16
4364    RegisterCmd ReadHolding
4365    Type temperature
4366    Instance "temp-1"
4367  </Data>
4368
4369  <Host "modbus.example.com">
4370    Address "192.168.0.42"
4371    Port    "502"
4372    Interval 60
4373
4374    <Slave 1>
4375      Instance "power-supply"
4376      Collect  "voltage-input-1"
4377      Collect  "voltage-input-2"
4378    </Slave>
4379  </Host>
4380
4381  <Host "localhost">
4382    Device "/dev/ttyUSB0"
4383    Baudrate 38400
4384    Interval 20
4385
4386    <Slave 1>
4387      Instance "temperature"
4388      Collect  "supply-temperature-1"
4389    </Slave>
4390  </Host>
4391
4392 =over 4
4393
4394 =item E<lt>B<Data> I<Name>E<gt> blocks
4395
4396 Data blocks define a mapping between register numbers and the "types" used by
4397 I<collectd>.
4398
4399 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4400
4401 =over 4
4402
4403 =item B<RegisterBase> I<Number>
4404
4405 Configures the base register to read from the device. If the option
4406 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4407 register will be read (the register number is increased by one).
4408
4409 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4410
4411 Specifies what kind of data is returned by the device. This defaults to
4412 B<Uint16>.  If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4413 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4414 and B<RegisterBase+1> will be read and the data is combined into one
4415 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4416 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4417 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4418 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4419 registers are swapped with the most significant 16E<nbsp>bits in
4420 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4421 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4422 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4423 B<RegisterBase+3> will be read and the data combined into one
4424 64E<nbsp>value.
4425
4426 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4427
4428 Specifies register type to be collected from device. Works only with libmodbus
4429 2.9.2 or higher. Defaults to B<ReadHolding>.
4430
4431 =item B<Type> I<Type>
4432
4433 Specifies the "type" (data set) to use when dispatching the value to
4434 I<collectd>. Currently, only data sets with exactly one data source are
4435 supported.
4436
4437 =item B<Instance> I<Instance>
4438
4439 Sets the type instance to use when dispatching the value to I<Instance>. If
4440 unset, an empty string (no type instance) is used.
4441
4442 =item B<Scale> I<Value>
4443
4444 The values taken from device are multiplied by I<Value>. The field is optional
4445 and the default is B<1.0>.
4446
4447 =item B<Shift> I<Value>
4448
4449 I<Value> is added to values from device after they have been multiplied by
4450 B<Scale> value. The field is optional and the default value is B<0.0>.
4451
4452 =back
4453
4454 =item E<lt>B<Host> I<Name>E<gt> blocks
4455
4456 Host blocks are used to specify to which hosts to connect and what data to read
4457 from their "slaves". The string argument I<Name> is used as hostname when
4458 dispatching the values to I<collectd>.
4459
4460 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4461
4462 =over 4
4463
4464 =item B<Address> I<Hostname>
4465
4466 For Modbus/TCP, specifies the node name (the actual network address) used to
4467 connect to the host. This may be an IP address or a hostname. Please note that
4468 the used I<libmodbus> library only supports IPv4 at the moment.
4469
4470 =item B<Port> I<Service>
4471
4472 for Modbus/TCP, specifies the port used to connect to the host. The port can
4473 either be given as a number or as a service name. Please note that the
4474 I<Service> argument must be a string, even if ports are given in their numerical
4475 form. Defaults to "502".
4476
4477 =item B<Device> I<Devicenode>
4478
4479 For Modbus/RTU, specifies the path to the serial device being used.
4480
4481 =item B<Baudrate> I<Baudrate>
4482
4483 For Modbus/RTU, specifies the baud rate of the serial device.
4484 Note, connections currently support only 8/N/1.
4485
4486 =item B<Interval> I<Interval>
4487
4488 Sets the interval (in seconds) in which the values will be collected from this
4489 host. By default the global B<Interval> setting will be used.
4490
4491 =item E<lt>B<Slave> I<ID>E<gt>
4492
4493 Over each connection, multiple Modbus devices may be reached. The slave ID
4494 is used to specify which device should be addressed. For each device you want
4495 to query, one B<Slave> block must be given.
4496
4497 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4498
4499 =over 4
4500
4501 =item B<Instance> I<Instance>
4502
4503 Specify the plugin instance to use when dispatching the values to I<collectd>.
4504 By default "slave_I<ID>" is used.
4505
4506 =item B<Collect> I<DataName>
4507
4508 Specifies which data to retrieve from the device. I<DataName> must be the same
4509 string as the I<Name> argument passed to a B<Data> block. You can specify this
4510 option multiple times to collect more than one value from a slave. At least one
4511 B<Collect> option is mandatory.
4512
4513 =back
4514
4515 =back
4516
4517 =back
4518
4519 =head2 Plugin C<mqtt>
4520
4521 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4522 values from MQTT (B<Subscribe> blocks).
4523
4524 B<Synopsis:>
4525
4526  <Plugin mqtt>
4527    <Publish "name">
4528      Host "mqtt.example.com"
4529      Prefix "collectd"
4530    </Publish>
4531    <Subscribe "name">
4532      Host "mqtt.example.com"
4533      Topic "collectd/#"
4534    </Subscribe>
4535  </Plugin>
4536
4537 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4538 configuring the sending and receiving direction respectively. The plugin will
4539 register a write callback named C<mqtt/I<name>> where I<name> is the string
4540 argument given to the B<Publish> block. Both types of blocks share many but not
4541 all of the following options. If an option is valid in only one of the blocks,
4542 it will be mentioned explicitly.
4543
4544 B<Options:>
4545
4546 =over 4
4547
4548 =item B<Host> I<Hostname>
4549
4550 Hostname of the MQTT broker to connect to.
4551
4552 =item B<Port> I<Service>
4553
4554 Port number or service name of the MQTT broker to connect to.
4555
4556 =item B<User> I<UserName>
4557
4558 Username used when authenticating to the MQTT broker.
4559
4560 =item B<Password> I<Password>
4561
4562 Password used when authenticating to the MQTT broker.
4563
4564 =item B<ClientId> I<ClientId>
4565
4566 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4567
4568 =item B<QoS> [B<0>-B<2>]
4569
4570 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4571
4572 =over 4
4573
4574 =item B<0>
4575
4576 At most once
4577
4578 =item B<1>
4579
4580 At least once
4581
4582 =item B<2>
4583
4584 Exactly once
4585
4586 =back
4587
4588 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4589 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4590 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4591 on a message is larger than the maximum accepted QoS of a subscriber, the
4592 message's QoS will be downgraded.
4593
4594 =item B<Prefix> I<Prefix> (Publish only)
4595
4596 This plugin will use one topic per I<value list> which will looks like a path.
4597 I<Prefix> is used as the first path element and defaults to B<collectd>.
4598
4599 An example topic name would be:
4600
4601  collectd/cpu-0/cpu-user
4602
4603 =item B<Retain> B<false>|B<true> (Publish only)
4604
4605 Controls whether the MQTT broker will retain (keep a copy of) the last message
4606 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4607
4608 =item B<StoreRates> B<true>|B<false> (Publish only)
4609
4610 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4611 before sending. Defaults to B<true>.
4612
4613 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4614
4615 Controls whether the MQTT "cleans" the session up after the subscriber
4616 disconnects or if it maintains the subscriber's subscriptions and all messages
4617 that arrive while the subscriber is disconnected. Defaults to B<true>.
4618
4619 =item B<Topic> I<TopicName> (Subscribe only)
4620
4621 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4622 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4623 the B<collectd> branch.
4624
4625 =item B<CACert> I<file>
4626
4627 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4628 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4629 port of the MQTT broker.
4630 This option enables the use of TLS.
4631
4632 =item B<CertificateFile> I<file>
4633
4634 Path to the PEM-encoded certificate file to use as client certificate when
4635 connecting to the MQTT broker.
4636 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4637
4638 =item B<CertificateKeyFile> I<file>
4639
4640 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4641 Only valid if B<CACert> and B<CertificateFile> are also set.
4642
4643 =item B<TLSProtocol> I<protocol>
4644
4645 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4646 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4647 version is used which depends on the version of OpenSSL the Mosquitto library
4648 was linked against.
4649 Only valid if B<CACert> is set.
4650
4651 =item B<CipherSuite> I<ciphersuite>
4652
4653 A string describing the ciphers available for use. See L<ciphers(1)> and the
4654 C<openssl ciphers> utility for more information. If unset, the default ciphers
4655 will be used.
4656 Only valid if B<CACert> is set.
4657
4658 =back
4659
4660 =head2 Plugin C<mysql>
4661
4662 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4663 one or more databases when started and keeps the connection up as long as
4664 possible. When the connection is interrupted for whatever reason it will try
4665 to re-connect. The plugin will complain loudly in case anything goes wrong.
4666
4667 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4668 and collects information about MySQL network traffic, executed statements,
4669 requests, the query cache and threads by evaluating the
4670 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4671 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4672 Status Variables> for an explanation of these values.
4673
4674 Optionally, master and slave statistics may be collected in a MySQL
4675 replication setup. In that case, information about the synchronization state
4676 of the nodes are collected by evaluating the C<Position> return value of the
4677 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4678 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4679 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4680 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4681 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4682
4683 Synopsis:
4684
4685   <Plugin mysql>
4686     <Database foo>
4687       Host "hostname"
4688       User "username"
4689       Password "password"
4690       Port "3306"
4691       MasterStats true
4692       ConnectTimeout 10
4693       SSLKey "/path/to/key.pem"
4694       SSLCert "/path/to/cert.pem"
4695       SSLCA "/path/to/ca.pem"
4696       SSLCAPath "/path/to/cas/"
4697       SSLCipher "DHE-RSA-AES256-SHA"
4698     </Database>
4699
4700     <Database bar>
4701       Alias "squeeze"
4702       Host "localhost"
4703       Socket "/var/run/mysql/mysqld.sock"
4704       SlaveStats true
4705       SlaveNotifications true
4706     </Database>
4707
4708    <Database galera>
4709       Alias "galera"
4710       Host "localhost"
4711       Socket "/var/run/mysql/mysqld.sock"
4712       WsrepStats true
4713    </Database>
4714   </Plugin>
4715
4716 A B<Database> block defines one connection to a MySQL database. It accepts a
4717 single argument which specifies the name of the database. None of the other
4718 options are required. MySQL will use default values as documented in the
4719 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4720 B<MySQL reference manual>.
4721
4722 =over 4
4723
4724 =item B<Alias> I<Alias>
4725
4726 Alias to use as sender instead of hostname when reporting. This may be useful
4727 when having cryptic hostnames.
4728
4729 =item B<Host> I<Hostname>
4730
4731 Hostname of the database server. Defaults to B<localhost>.
4732
4733 =item B<User> I<Username>
4734
4735 Username to use when connecting to the database. The user does not have to be
4736 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4737 unless you want to collectd replication statistics (see B<MasterStats> and
4738 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4739 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4740
4741 =item B<Password> I<Password>
4742
4743 Password needed to log into the database.
4744
4745 =item B<Database> I<Database>
4746
4747 Select this database. Defaults to I<no database> which is a perfectly reasonable
4748 option for what this plugin does.
4749
4750 =item B<Port> I<Port>
4751
4752 TCP-port to connect to. The port must be specified in its numeric form, but it
4753 must be passed as a string nonetheless. For example:
4754
4755   Port "3306"
4756
4757 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4758 See the documentation for the C<mysql_real_connect> function for details.
4759
4760 =item B<Socket> I<Socket>
4761
4762 Specifies the path to the UNIX domain socket of the MySQL server. This option
4763 only has any effect, if B<Host> is set to B<localhost> (the default).
4764 Otherwise, use the B<Port> option above. See the documentation for the
4765 C<mysql_real_connect> function for details.
4766
4767 =item B<InnodbStats> I<true|false>
4768
4769 If enabled, metrics about the InnoDB storage engine are collected.
4770 Disabled by default.
4771
4772 =item B<MasterStats> I<true|false>
4773
4774 =item B<SlaveStats> I<true|false>
4775
4776 Enable the collection of master / slave statistics in a replication setup. In
4777 order to be able to get access to these statistics, the user needs special
4778 privileges. See the B<User> documentation above. Defaults to B<false>.
4779
4780 =item B<SlaveNotifications> I<true|false>
4781
4782 If enabled, the plugin sends a notification if the replication slave I/O and /
4783 or SQL threads are not running. Defaults to B<false>.
4784
4785 =item B<WsrepStats> I<true|false>
4786
4787  Enable the collection of wsrep plugin statistics, used in Master-Master
4788  replication setups like in MySQL Galera/Percona XtraDB Cluster.
4789  User needs only privileges to execute 'SHOW GLOBAL STATUS'
4790
4791 =item B<ConnectTimeout> I<Seconds>
4792
4793 Sets the connect timeout for the MySQL client.
4794
4795 =item B<SSLKey> I<Path>
4796
4797 If provided, the X509 key in PEM format.
4798
4799 =item B<SSLCert> I<Path>
4800
4801 If provided, the X509 cert in PEM format.
4802
4803 =item B<SSLCA> I<Path>
4804
4805 If provided, the CA file in PEM format (check OpenSSL docs).
4806
4807 =item B<SSLCAPath> I<Path>
4808
4809 If provided, the CA directory (check OpenSSL docs).
4810
4811 =item B<SSLCipher> I<String>
4812
4813 If provided, the SSL cipher to use.
4814
4815 =back
4816
4817 =head2 Plugin C<netapp>
4818
4819 The netapp plugin can collect various performance and capacity information
4820 from a NetApp filer using the NetApp API.
4821
4822 Please note that NetApp has a wide line of products and a lot of different
4823 software versions for each of these products. This plugin was developed for a
4824 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4825 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4826 model and software version but it is very hard to test this.
4827 If you have used this plugin with other models and/or software version, feel
4828 free to send us a mail to tell us about the results, even if it's just a short
4829 "It works".
4830
4831 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4832 basic authentication.
4833
4834 B<Do not use a regular user for this!> Create a special collectd user with just
4835 the minimum of capabilities needed. The user only needs the "login-http-admin"
4836 capability as well as a few more depending on which data will be collected.
4837 Required capabilities are documented below.
4838
4839 =head3 Synopsis
4840
4841  <Plugin "netapp">
4842    <Host "netapp1.example.com">
4843     Protocol      "https"
4844     Address       "10.0.0.1"
4845     Port          443
4846     User          "username"
4847     Password      "aef4Aebe"
4848     Interval      30
4849
4850     <WAFL>
4851       Interval 30
4852       GetNameCache   true
4853       GetDirCache    true
4854       GetBufferCache true
4855       GetInodeCache  true
4856     </WAFL>
4857
4858     <Disks>
4859       Interval 30
4860       GetBusy true
4861     </Disks>
4862
4863     <VolumePerf>
4864       Interval 30
4865       GetIO      "volume0"
4866       IgnoreSelectedIO      false
4867       GetOps     "volume0"
4868       IgnoreSelectedOps     false
4869       GetLatency "volume0"
4870       IgnoreSelectedLatency false
4871     </VolumePerf>
4872
4873     <VolumeUsage>
4874       Interval 30
4875       GetCapacity "vol0"
4876       GetCapacity "vol1"
4877       IgnoreSelectedCapacity false
4878       GetSnapshot "vol1"
4879       GetSnapshot "vol3"
4880       IgnoreSelectedSnapshot false
4881     </VolumeUsage>
4882
4883     <Quota>
4884       Interval 60
4885     </Quota>
4886
4887     <Snapvault>
4888       Interval 30
4889     </Snapvault>
4890
4891     <System>
4892       Interval 30
4893       GetCPULoad     true
4894       GetInterfaces  true
4895       GetDiskOps     true
4896       GetDiskIO      true
4897     </System>
4898
4899     <VFiler vfilerA>
4900       Interval 60
4901
4902       SnapVault true
4903       # ...
4904     </VFiler>
4905    </Host>
4906  </Plugin>
4907
4908 The netapp plugin accepts the following configuration options:
4909
4910 =over 4
4911
4912 =item B<Host> I<Name>
4913
4914 A host block defines one NetApp filer. It will appear in collectd with the name
4915 you specify here which does not have to be its real name nor its hostname (see
4916 the B<Address> option below).
4917
4918 =item B<VFiler> I<Name>
4919
4920 A B<VFiler> block may only be used inside a host block. It accepts all the
4921 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4922 will execute all NetApp API commands in the context of the specified
4923 VFiler(R). It will appear in collectd with the name you specify here which
4924 does not have to be its real name. The VFiler name may be specified using the
4925 B<VFilerName> option. If this is not specified, it will default to the name
4926 you specify here.
4927
4928 The VFiler block inherits all connection related settings from the surrounding
4929 B<Host> block (which appear before the B<VFiler> block) but they may be
4930 overwritten inside the B<VFiler> block.
4931
4932 This feature is useful, for example, when using a VFiler as SnapVault target
4933 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4934 available in the host filer (vfiler0) but only in the respective VFiler
4935 context.
4936
4937 =item B<Protocol> B<httpd>|B<http>
4938
4939 The protocol collectd will use to query this host.
4940
4941 Optional
4942
4943 Type: string
4944
4945 Default: https
4946
4947 Valid options: http, https
4948
4949 =item B<Address> I<Address>
4950
4951 The hostname or IP address of the host.
4952
4953 Optional
4954
4955 Type: string
4956
4957 Default: The "host" block's name.
4958
4959 =item B<Port> I<Port>
4960
4961 The TCP port to connect to on the host.
4962
4963 Optional
4964
4965 Type: integer
4966
4967 Default: 80 for protocol "http", 443 for protocol "https"
4968
4969 =item B<User> I<User>
4970
4971 =item B<Password> I<Password>
4972
4973 The username and password to use to login to the NetApp.
4974
4975 Mandatory
4976
4977 Type: string
4978
4979 =item B<VFilerName> I<Name>
4980
4981 The name of the VFiler in which context to execute API commands. If not
4982 specified, the name provided to the B<VFiler> block will be used instead.
4983
4984 Optional
4985
4986 Type: string
4987
4988 Default: name of the B<VFiler> block
4989
4990 B<Note:> This option may only be used inside B<VFiler> blocks.
4991
4992 =item B<Interval> I<Interval>
4993
4994 B<TODO>
4995
4996 =back
4997
4998 The following options decide what kind of data will be collected. You can
4999 either use them as a block and fine tune various parameters inside this block,
5000 use them as a single statement to just accept all default values, or omit it to
5001 not collect any data.
5002
5003 The following options are valid inside all blocks:
5004
5005 =over 4
5006
5007 =item B<Interval> I<Seconds>
5008
5009 Collect the respective statistics every I<Seconds> seconds. Defaults to the
5010 host specific setting.
5011
5012 =back
5013
5014 =head3 The System block
5015
5016 This will collect various performance data about the whole system.
5017
5018 B<Note:> To get this data the collectd user needs the
5019 "api-perf-object-get-instances" capability.
5020
5021 =over 4
5022
5023 =item B<Interval> I<Seconds>
5024
5025 Collect disk statistics every I<Seconds> seconds.
5026
5027 =item B<GetCPULoad> B<true>|B<false>
5028
5029 If you set this option to true the current CPU usage will be read. This will be
5030 the average usage between all CPUs in your NetApp without any information about
5031 individual CPUs.
5032
5033 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5034 returns in the "CPU" field.
5035
5036 Optional
5037
5038 Type: boolean
5039
5040 Default: true
5041
5042 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5043
5044 =item B<GetInterfaces> B<true>|B<false>
5045
5046 If you set this option to true the current traffic of the network interfaces
5047 will be read. This will be the total traffic over all interfaces of your NetApp
5048 without any information about individual interfaces.
5049
5050 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5051 in the "Net kB/s" field.
5052
5053 B<Or is it?>
5054
5055 Optional
5056
5057 Type: boolean
5058
5059 Default: true
5060
5061 Result: One value list of type "if_octects".
5062
5063 =item B<GetDiskIO> B<true>|B<false>
5064
5065 If you set this option to true the current IO throughput will be read. This
5066 will be the total IO of your NetApp without any information about individual
5067 disks, volumes or aggregates.
5068
5069 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5070 in the "DiskE<nbsp>kB/s" field.
5071
5072 Optional
5073
5074 Type: boolean
5075
5076 Default: true
5077
5078 Result: One value list of type "disk_octets".
5079
5080 =item B<GetDiskOps> B<true>|B<false>
5081
5082 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5083 iSCSI, etc. operations will be read. This will be the total number of
5084 operations on your NetApp without any information about individual volumes or
5085 aggregates.
5086
5087 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5088 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5089
5090 Optional
5091
5092 Type: boolean
5093
5094 Default: true
5095
5096 Result: A variable number of value lists of type "disk_ops_complex". Each type
5097 of operation will result in one value list with the name of the operation as
5098 type instance.
5099
5100 =back
5101
5102 =head3 The WAFL block
5103
5104 This will collect various performance data about the WAFL file system. At the
5105 moment this just means cache performance.
5106
5107 B<Note:> To get this data the collectd user needs the
5108 "api-perf-object-get-instances" capability.
5109
5110 B<Note:> The interface to get these values is classified as "Diagnostics" by
5111 NetApp. This means that it is not guaranteed to be stable even between minor
5112 releases.
5113
5114 =over 4
5115
5116 =item B<Interval> I<Seconds>
5117
5118 Collect disk statistics every I<Seconds> seconds.
5119
5120 =item B<GetNameCache> B<true>|B<false>
5121
5122 Optional
5123
5124 Type: boolean
5125
5126 Default: true
5127
5128 Result: One value list of type "cache_ratio" and type instance
5129 "name_cache_hit".
5130
5131 =item B<GetDirCache> B<true>|B<false>
5132
5133 Optional
5134
5135 Type: boolean
5136
5137 Default: true
5138
5139 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5140
5141 =item B<GetInodeCache> B<true>|B<false>
5142
5143 Optional
5144
5145 Type: boolean
5146
5147 Default: true
5148
5149 Result: One value list of type "cache_ratio" and type instance
5150 "inode_cache_hit".
5151
5152 =item B<GetBufferCache> B<true>|B<false>
5153
5154 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5155 in the "Cache hit" field.
5156
5157 Optional
5158
5159 Type: boolean
5160
5161 Default: true
5162
5163 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5164
5165 =back
5166
5167 =head3 The Disks block
5168
5169 This will collect performance data about the individual disks in the NetApp.
5170
5171 B<Note:> To get this data the collectd user needs the
5172 "api-perf-object-get-instances" capability.
5173
5174 =over 4
5175
5176 =item B<Interval> I<Seconds>
5177
5178 Collect disk statistics every I<Seconds> seconds.
5179
5180 =item B<GetBusy> B<true>|B<false>
5181
5182 If you set this option to true the busy time of all disks will be calculated
5183 and the value of the busiest disk in the system will be written.
5184
5185 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5186 in the "Disk util" field. Probably.
5187
5188 Optional
5189
5190 Type: boolean
5191
5192 Default: true
5193
5194 Result: One value list of type "percent" and type instance "disk_busy".
5195
5196 =back
5197
5198 =head3 The VolumePerf block
5199
5200 This will collect various performance data about the individual volumes.
5201
5202 You can select which data to collect about which volume using the following
5203 options. They follow the standard ignorelist semantic.
5204
5205 B<Note:> To get this data the collectd user needs the
5206 I<api-perf-object-get-instances> capability.
5207
5208 =over 4
5209
5210 =item B<Interval> I<Seconds>
5211
5212 Collect volume performance data every I<Seconds> seconds.
5213
5214 =item B<GetIO> I<Volume>
5215
5216 =item B<GetOps> I<Volume>
5217
5218 =item B<GetLatency> I<Volume>
5219
5220 Select the given volume for IO, operations or latency statistics collection.
5221 The argument is the name of the volume without the C</vol/> prefix.
5222
5223 Since the standard ignorelist functionality is used here, you can use a string
5224 starting and ending with a slash to specify regular expression matching: To
5225 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5226 expression:
5227
5228   GetIO "/^vol[027]$/"
5229
5230 If no regular expression is specified, an exact match is required. Both,
5231 regular and exact matching are case sensitive.
5232
5233 If no volume was specified at all for either of the three options, that data
5234 will be collected for all available volumes.
5235
5236 See F</"IGNORELISTS"> for details.
5237
5238 =item B<IgnoreSelectedIO> B<true>|B<false>
5239
5240 =item B<IgnoreSelectedOps> B<true>|B<false>
5241
5242 =item B<IgnoreSelectedLatency> B<true>|B<false>
5243
5244 When set to B<true>, the volumes selected for IO, operations or latency
5245 statistics collection will be ignored and the data will be collected for all
5246 other volumes.
5247
5248 When set to B<false>, data will only be collected for the specified volumes and
5249 all other volumes will be ignored.
5250
5251 If no volumes have been specified with the above B<Get*> options, all volumes
5252 will be collected regardless of the B<IgnoreSelected*> option.
5253
5254 Defaults to B<false>
5255
5256 =back
5257
5258 =head3 The VolumeUsage block
5259
5260 This will collect capacity data about the individual volumes.
5261
5262 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5263 capability.
5264
5265 =over 4
5266
5267 =item B<Interval> I<Seconds>
5268
5269 Collect volume usage statistics every I<Seconds> seconds.
5270
5271 =item B<GetCapacity> I<VolumeName>
5272
5273 The current capacity of the volume will be collected. This will result in two
5274 to four value lists, depending on the configuration of the volume. All data
5275 sources are of type "df_complex" with the name of the volume as
5276 plugin_instance.
5277
5278 There will be type_instances "used" and "free" for the number of used and
5279 available bytes on the volume.  If the volume has some space reserved for
5280 snapshots, a type_instance "snap_reserved" will be available.  If the volume
5281 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5282 number of bytes saved by the SIS feature.
5283
5284 B<Note:> The current NetApp API has a bug that results in this value being
5285 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5286 number which works most of the time.  If you see strange values here, bug
5287 NetApp support to fix this.
5288
5289 Repeat this option to specify multiple volumes.
5290
5291 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5292
5293 Specify whether to collect only the volumes selected by the B<GetCapacity>
5294 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5295 B<false>. However, if no B<GetCapacity> option is specified at all, all
5296 capacities will be selected anyway.
5297
5298 =item B<GetSnapshot> I<VolumeName>
5299
5300 Select volumes from which to collect snapshot information.
5301
5302 Usually, the space used for snapshots is included in the space reported as
5303 "used". If snapshot information is collected as well, the space used for
5304 snapshots is subtracted from the used space.
5305
5306 To make things even more interesting, it is possible to reserve space to be
5307 used for snapshots. If the space required for snapshots is less than that
5308 reserved space, there is "reserved free" and "reserved used" space in addition
5309 to "free" and "used". If the space required for snapshots exceeds the reserved
5310 space, that part allocated in the normal space is subtracted from the "used"
5311 space again.
5312
5313 Repeat this option to specify multiple volumes.
5314
5315 =item B<IgnoreSelectedSnapshot>
5316
5317 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5318 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5319 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5320 capacities will be selected anyway.
5321
5322 =back
5323
5324 =head3 The Quota block
5325
5326 This will collect (tree) quota statistics (used disk space and number of used
5327 files). This mechanism is useful to get usage information for single qtrees.
5328 In case the quotas are not used for any other purpose, an entry similar to the
5329 following in C</etc/quotas> would be sufficient:
5330
5331   /vol/volA/some_qtree tree - - - - -
5332
5333 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5334
5335 =over 4
5336
5337 =item B<Interval> I<Seconds>
5338
5339 Collect SnapVault(R) statistics every I<Seconds> seconds.
5340
5341 =back
5342
5343 =head3 The SnapVault block
5344
5345 This will collect statistics about the time and traffic of SnapVault(R)
5346 transfers.
5347
5348 =over 4
5349
5350 =item B<Interval> I<Seconds>
5351
5352 Collect SnapVault(R) statistics every I<Seconds> seconds.
5353
5354 =back
5355
5356 =head2 Plugin C<netlink>
5357
5358 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5359 statistics of various interface and routing aspects.
5360
5361 =over 4
5362
5363 =item B<Interface> I<Interface>
5364
5365 =item B<VerboseInterface> I<Interface>
5366
5367 Instruct the plugin to collect interface statistics. This is basically the same
5368 as the statistics provided by the C<interface> plugin (see above) but
5369 potentially much more detailed.
5370
5371 When configuring with B<Interface> only the basic statistics will be collected,
5372 namely octets, packets, and errors. These statistics are collected by
5373 the C<interface> plugin, too, so using both at the same time is no benefit.
5374
5375 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5376 so that no data needs to be collected twice if you use the C<interface> plugin.
5377 This includes dropped packets, received multicast packets, collisions and a
5378 whole zoo of differentiated RX and TX errors. You can try the following command
5379 to get an idea of what awaits you:
5380
5381   ip -s -s link list
5382
5383 If I<Interface> is B<All>, all interfaces will be selected.
5384
5385 =item B<QDisc> I<Interface> [I<QDisc>]
5386
5387 =item B<Class> I<Interface> [I<Class>]
5388
5389 =item B<Filter> I<Interface> [I<Filter>]
5390
5391 Collect the octets and packets that pass a certain qdisc, class or filter.
5392
5393 QDiscs and classes are identified by their type and handle (or classid).
5394 Filters don't necessarily have a handle, therefore the parent's handle is used.
5395 The notation used in collectd differs from that used in tc(1) in that it
5396 doesn't skip the major or minor number if it's zero and doesn't print special
5397 ids by their name. So, for example, a qdisc may be identified by
5398 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5399 thus not displayed by tc(1).
5400
5401 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5402 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5403 associated with that interface will be collected.
5404
5405 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5406 used. This may lead to problems when more than one filter is attached to a
5407 qdisc or class. This isn't nice, but we don't know how this could be done any
5408 better. If you have a idea, please don't hesitate to tell us.
5409
5410 As with the B<Interface> option you can specify B<All> as the interface,
5411 meaning all interfaces.
5412
5413 Here are some examples to help you understand the above text more easily:
5414
5415   <Plugin netlink>
5416     VerboseInterface "All"
5417     QDisc "eth0" "pfifo_fast-1:0"
5418     QDisc "ppp0"
5419     Class "ppp0" "htb-1:10"
5420     Filter "ppp0" "u32-1:0"
5421   </Plugin>
5422
5423 See F</"IGNORELISTS"> for details.
5424
5425 =item B<IgnoreSelected>
5426
5427 The behavior is the same as with all other similar plugins: If nothing is
5428 selected at all, everything is collected. If some things are selected using the
5429 options described above, only these statistics are collected. If you set
5430 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5431 specified statistics will not be collected.
5432
5433 =back
5434
5435 =head2 Plugin C<network>
5436
5437 The Network plugin sends data to a remote instance of collectd, receives data
5438 from a remote instance, or both at the same time. Data which has been received
5439 from the network is usually not transmitted again, but this can be activated, see
5440 the B<Forward> option below.
5441
5442 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5443 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5444
5445 Both, B<Server> and B<Listen> can be used as single option or as block. When
5446 used as block, given options are valid for this socket only. The following
5447 example will export the metrics twice: Once to an "internal" server (without
5448 encryption and signing) and one to an external server (with cryptographic
5449 signature):
5450
5451  <Plugin "network">
5452    # Export to an internal server
5453    # (demonstrates usage without additional options)
5454    Server "collectd.internal.tld"
5455
5456    # Export to an external server
5457    # (demonstrates usage with signature options)
5458    <Server "collectd.external.tld">
5459      SecurityLevel "sign"
5460      Username "myhostname"
5461      Password "ohl0eQue"
5462    </Server>
5463  </Plugin>
5464
5465 =over 4
5466
5467 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5468
5469 The B<Server> statement/block sets the server to send datagrams to. The
5470 statement may occur multiple times to send each datagram to multiple
5471 destinations.
5472
5473 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5474 optional second argument specifies a port number or a service name. If not
5475 given, the default, B<25826>, is used.
5476
5477 The following options are recognized within B<Server> blocks:
5478
5479 =over 4
5480
5481 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5482
5483 Set the security you require for network communication. When the security level
5484 has been set to B<Encrypt>, data sent over the network will be encrypted using
5485 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5486 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5487 authentication code. When set to B<None>, data is sent without any security.
5488
5489 This feature is only available if the I<network> plugin was linked with
5490 I<libgcrypt>.
5491
5492 =item B<Username> I<Username>
5493
5494 Sets the username to transmit. This is used by the server to lookup the
5495 password. See B<AuthFile> below. All security levels except B<None> require
5496 this setting.
5497
5498 This feature is only available if the I<network> plugin was linked with
5499 I<libgcrypt>.
5500
5501 =item B<Password> I<Password>
5502
5503 Sets a password (shared secret) for this socket. All security levels except
5504 B<None> require this setting.
5505
5506 This feature is only available if the I<network> plugin was linked with
5507 I<libgcrypt>.
5508
5509 =item B<Interface> I<Interface name>
5510
5511 Set the outgoing interface for IP packets. This applies at least
5512 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5513 undefined or a non-existent interface name is specified, the default
5514 behavior is to let the kernel choose the appropriate interface. Be warned
5515 that the manual selection of an interface for unicast traffic is only
5516 necessary in rare cases.
5517
5518 =item B<BindAddress> I<IP Address>
5519
5520 Set the outgoing IP address for IP packets. This option can be used instead of
5521 the I<Interface> option to explicitly define the IP address which will be used
5522 to send Packets to the remote server.
5523
5524 =item B<ResolveInterval> I<Seconds>
5525
5526 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5527 useful to force a regular DNS lookup to support a high availability setup. If
5528 not specified, re-resolves are never attempted.
5529
5530 =back
5531
5532 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5533
5534 The B<Listen> statement sets the interfaces to bind to. When multiple
5535 statements are found the daemon will bind to multiple interfaces.
5536
5537 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5538 the argument is a multicast address the daemon will join that multicast group.
5539 The optional second argument specifies a port number or a service name. If not
5540 given, the default, B<25826>, is used.
5541
5542 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5543
5544 =over 4
5545
5546 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5547
5548 Set the security you require for network communication. When the security level
5549 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5550 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5551 signed and encrypted data is accepted. When set to B<None>, all data will be
5552 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5553 decrypted if possible.
5554
5555 This feature is only available if the I<network> plugin was linked with
5556 I<libgcrypt>.
5557
5558 =item B<AuthFile> I<Filename>
5559
5560 Sets a file in which usernames are mapped to passwords. These passwords are
5561 used to verify signatures and to decrypt encrypted network packets. If
5562 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5563 verified and encrypted packets are decrypted. Otherwise, signed data is
5564 accepted without checking the signature and encrypted data cannot be decrypted.
5565 For the other security levels this option is mandatory.
5566
5567 The file format is very simple: Each line consists of a username followed by a
5568 colon and any number of spaces followed by the password. To demonstrate, an
5569 example file could look like this:
5570
5571   user0: foo
5572   user1: bar
5573
5574 Each time a packet is received, the modification time of the file is checked
5575 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5576 the file is being read, it is locked using L<fcntl(2)>.
5577
5578 =item B<Interface> I<Interface name>
5579
5580 Set the incoming interface for IP packets explicitly. This applies at least
5581 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5582 undefined or a non-existent interface name is specified, the default
5583 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5584 traffic gets only accepted, if it arrives on the given interface.
5585
5586 =back
5587
5588 =item B<TimeToLive> I<1-255>
5589
5590 Set the time-to-live of sent packets. This applies to all, unicast and
5591 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5592 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5593 operating systems.
5594
5595 =item B<MaxPacketSize> I<1024-65535>
5596
5597 Set the maximum size for datagrams received over the network. Packets larger
5598 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5599 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5600 UDP.
5601
5602 On the server side, this limit should be set to the largest value used on
5603 I<any> client. Likewise, the value on the client must not be larger than the
5604 value on the server, or data will be lost.
5605
5606 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5607 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5608 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5609 server.
5610
5611 =item B<Forward> I<true|false>
5612
5613 If set to I<true>, write packets that were received via the network plugin to
5614 the sending sockets. This should only be activated when the B<Listen>- and
5615 B<Server>-statements differ. Otherwise packets may be send multiple times to
5616 the same multicast group. While this results in more network traffic than
5617 necessary it's not a huge problem since the plugin has a duplicate detection,
5618 so the values will not loop.
5619
5620 =item B<ReportStats> B<true>|B<false>
5621
5622 The network plugin cannot only receive and send statistics, it can also create
5623 statistics about itself. Collectd data included the number of received and
5624 sent octets and packets, the length of the receive queue and the number of
5625 values handled. When set to B<true>, the I<Network plugin> will make these
5626 statistics available. Defaults to B<false>.
5627
5628 =back
5629
5630 =head2 Plugin C<nfs>
5631
5632 The I<nfs plugin> collects information about the usage of the Network File
5633 System (NFS). It counts the number of procedure calls for each procedure,
5634 grouped by version and whether the system runs as server or client.
5635
5636 It is possibly to omit metrics for a specific NFS version by setting one or
5637 more of the following options to B<false> (all of them default to B<true>).
5638
5639 =over 4
5640
5641 =item B<ReportV2> B<true>|B<false>
5642
5643 =item B<ReportV3> B<true>|B<false>
5644
5645 =item B<ReportV4> B<true>|B<false>
5646
5647 =back
5648
5649 =head2 Plugin C<nginx>
5650
5651 This plugin collects the number of connections and requests handled by the
5652 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5653 queries the page provided by the C<ngx_http_stub_status_module> module, which
5654 isn't compiled by default. Please refer to
5655 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5656 how to compile and configure nginx and this module.
5657
5658 The following options are accepted by the C<nginx plugin>:
5659
5660 =over 4
5661
5662 =item B<URL> I<http://host/nginx_status>
5663
5664 Sets the URL of the C<ngx_http_stub_status_module> output.
5665
5666 =item B<User> I<Username>
5667
5668 Optional user name needed for authentication.
5669
5670 =item B<Password> I<Password>
5671
5672 Optional password needed for authentication.
5673
5674 =item B<VerifyPeer> B<true|false>
5675
5676 Enable or disable peer SSL certificate verification. See
5677 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5678
5679 =item B<VerifyHost> B<true|false>
5680
5681 Enable or disable peer host name verification. If enabled, the plugin checks
5682 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5683 certificate matches the host name provided by the B<URL> option. If this
5684 identity check fails, the connection is aborted. Obviously, only works when
5685 connecting to a SSL enabled server. Enabled by default.
5686
5687 =item B<CACert> I<File>
5688
5689 File that holds one or more SSL certificates. If you want to use HTTPS you will
5690 possibly need this option. What CA certificates come bundled with C<libcurl>
5691 and are checked by default depends on the distribution you use.
5692
5693 =item B<Timeout> I<Milliseconds>
5694
5695 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5696 milliseconds. By default, the configured B<Interval> is used to set the
5697 timeout.
5698
5699 =back
5700
5701 =head2 Plugin C<notify_desktop>
5702
5703 This plugin sends a desktop notification to a notification daemon, as defined
5704 in the Desktop Notification Specification. To actually display the
5705 notifications, B<notification-daemon> is required and B<collectd> has to be
5706 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5707 environment variables have to be set correctly) and the D-Bus message bus.
5708
5709 The Desktop Notification Specification can be found at
5710 L<http://www.galago-project.org/specs/notification/>.
5711
5712 =over 4
5713
5714 =item B<OkayTimeout> I<timeout>
5715
5716 =item B<WarningTimeout> I<timeout>
5717
5718 =item B<FailureTimeout> I<timeout>
5719
5720 Set the I<timeout>, in milliseconds, after which to expire the notification
5721 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5722 been specified, the displayed notification will not be closed at all - the
5723 user has to do so herself. These options default to 5000. If a negative number
5724 has been specified, the default is used as well.
5725
5726 =back
5727
5728 =head2 Plugin C<notify_email>
5729
5730 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5731 configured email address.
5732
5733 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5734
5735 Available configuration options:
5736
5737 =over 4
5738
5739 =item B<From> I<Address>
5740
5741 Email address from which the emails should appear to come from.
5742
5743 Default: C<root@localhost>
5744
5745 =item B<Recipient> I<Address>
5746
5747 Configures the email address(es) to which the notifications should be mailed.
5748 May be repeated to send notifications to multiple addresses.
5749
5750 At least one B<Recipient> must be present for the plugin to work correctly.
5751
5752 =item B<SMTPServer> I<Hostname>
5753
5754 Hostname of the SMTP server to connect to.
5755
5756 Default: C<localhost>
5757
5758 =item B<SMTPPort> I<Port>
5759
5760 TCP port to connect to.
5761
5762 Default: C<25>
5763
5764 =item B<SMTPUser> I<Username>
5765
5766 Username for ASMTP authentication. Optional.
5767
5768 =item B<SMTPPassword> I<Password>
5769
5770 Password for ASMTP authentication. Optional.
5771
5772 =item B<Subject> I<Subject>
5773
5774 Subject-template to use when sending emails. There must be exactly two
5775 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5776 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5777 with the hostname.
5778
5779 Default: C<Collectd notify: %s@%s>
5780
5781 =back
5782
5783 =head2 Plugin C<notify_nagios>
5784
5785 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5786 a I<passive service check result>.
5787
5788 Available configuration options:
5789
5790 =over 4
5791
5792 =item B<CommandFile> I<Path>
5793
5794 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5795
5796 =back
5797
5798 =head2 Plugin C<ntpd>
5799
5800 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5801 dispersion.
5802
5803 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5804 the wire - using B<mode 7> specific requests. This mode is deprecated with
5805 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5806 correctly with them, the ntp daemon must be explicitly configured to
5807 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5808 manual page for details.
5809
5810 Available configuration options for the C<ntpd> plugin:
5811
5812 =over 4
5813
5814 =item B<Host> I<Hostname>
5815
5816 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5817
5818 =item B<Port> I<Port>
5819
5820 UDP-Port to connect to. Defaults to B<123>.
5821
5822 =item B<ReverseLookups> B<true>|B<false>
5823
5824 Sets whether or not to perform reverse lookups on peers. Since the name or
5825 IP-address may be used in a filename it is recommended to disable reverse
5826 lookups. The default is to do reverse lookups to preserve backwards
5827 compatibility, though.
5828
5829 =item B<IncludeUnitID> B<true>|B<false>
5830
5831 When a peer is a refclock, include the unit ID in the I<type instance>.
5832 Defaults to B<false> for backward compatibility.
5833
5834 If two refclock peers use the same driver and this is B<false>, the plugin will
5835 try to write simultaneous measurements from both to the same type instance.
5836 This will result in error messages in the log and only one set of measurements
5837 making it through.
5838
5839 =back
5840
5841 =head2 Plugin C<nut>
5842
5843 =over 4
5844
5845 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5846
5847 Add a UPS to collect data from. The format is identical to the one accepted by
5848 L<upsc(8)>.
5849
5850 =item B<ForceSSL> B<true>|B<false>
5851
5852 Stops connections from falling back to unsecured if an SSL connection
5853 cannot be established. Defaults to false if undeclared.
5854
5855 =item B<VerifyPeer> I<true>|I<false>
5856
5857 If set to true, requires a CAPath be provided. Will use the CAPath to find
5858 certificates to use as Trusted Certificates to validate a upsd server certificate.
5859 If validation of the upsd server certificate fails, the connection will not be
5860 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5861 will override and set ForceSSL to true.
5862
5863 =item B<CAPath> I/path/to/certs/folder
5864
5865 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5866 The folder pointed at must contain certificate(s) named according to their hash.
5867 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5868 occur because two different certs have the same hash value, Y can be  incremented
5869 in order to avoid conflict. To create a symbolic link to a certificate the following
5870 command can be used from within the directory where the cert resides:
5871
5872 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5873
5874 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5875 generate links like the one described above for ALL certs in a given folder.
5876 Example usage:
5877 C<c_rehash /path/to/certs/folder>
5878
5879 =item B<ConnectTimeout> I<Milliseconds>
5880
5881 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5882 By default, the configured B<Interval> is used to set the timeout.
5883
5884 =back
5885
5886 =head2 Plugin C<olsrd>
5887
5888 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5889 the Optimized Link State Routing daemon and reads information about the current
5890 state of the meshed network.
5891
5892 The following configuration options are understood:
5893
5894 =over 4
5895
5896 =item B<Host> I<Host>
5897
5898 Connect to I<Host>. Defaults to B<"localhost">.
5899
5900 =item B<Port> I<Port>
5901
5902 Specifies the port to connect to. This must be a string, even if you give the
5903 port as a number rather than a service name. Defaults to B<"2006">.
5904
5905 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5906
5907 Specifies what information to collect about links, i.E<nbsp>e. direct
5908 connections of the daemon queried. If set to B<No>, no information is
5909 collected. If set to B<Summary>, the number of links and the average of all
5910 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5911 If set to B<Detail> LQ and NLQ are collected per link.
5912
5913 Defaults to B<Detail>.
5914
5915 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5916
5917 Specifies what information to collect about routes of the daemon queried. If
5918 set to B<No>, no information is collected. If set to B<Summary>, the number of
5919 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5920 metric and ETX are collected per route.
5921
5922 Defaults to B<Summary>.
5923
5924 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5925
5926 Specifies what information to collect about the global topology. If set to
5927 B<No>, no information is collected. If set to B<Summary>, the number of links
5928 in the entire topology and the average I<link quality> (LQ) is calculated.
5929 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5930
5931 Defaults to B<Summary>.
5932
5933 =back
5934
5935 =head2 Plugin C<onewire>
5936
5937 B<EXPERIMENTAL!> See notes below.
5938
5939 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5940 L<http://owfs.org/> to read sensors connected via the onewire bus.
5941
5942 It can be used in two possible modes - standard or advanced.
5943
5944 In the standard mode only temperature sensors (sensors with the family code
5945 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5946 other sensors you would like to have included, please send a sort request to
5947 the mailing list. You can select sensors to be read or to be ignored depending
5948 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5949 walked and all sensors are read.
5950
5951 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5952 experimental, below.
5953
5954 In the advanced mode you can configure any sensor to be read (only numerical
5955 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5956 In this mode you have to list all the sensors. Neither default bus walk nor
5957 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5958 the path automatically and should produce compatible structure with the "standard"
5959 mode (basically the path is expected as for example
5960 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5961 "F10FCA000800" and the rest after the slash is considered the type - here
5962 "temperature").
5963 There are two advantages to this mode - you can access virtually any sensor
5964 (not just temperature), select whether to use cached or directly read values
5965 and it is slighlty faster. The downside is more complex configuration.
5966
5967 The two modes are distinguished automatically by the format of the address.
5968 It is not possible to mix the two modes. Once a full path is detected in any
5969 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5970 (and as standard addresses will fail parsing they will be ignored).
5971
5972 =over 4
5973
5974 =item B<Device> I<Device>
5975
5976 Sets the device to read the values from. This can either be a "real" hardware
5977 device, such as a serial port or an USB port, or the address of the
5978 L<owserver(1)> socket, usually B<localhost:4304>.
5979
5980 Though the documentation claims to automatically recognize the given address
5981 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5982 with that version, the following configuration worked for us:
5983
5984   <Plugin onewire>
5985     Device "-s localhost:4304"
5986   </Plugin>
5987
5988 This directive is B<required> and does not have a default value.
5989
5990 =item B<Sensor> I<Sensor>
5991
5992 In the standard mode selects sensors to collect or to ignore
5993 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5994 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5995 and B<not> include the leading C<10.> family byte and point.
5996 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5997 sensors (see above) are read.
5998
5999 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
6000 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
6001 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
6002
6003 As there can be multiple devices on the bus you can list multiple sensor (use
6004 multiple B<Sensor> elements).
6005
6006 See F</"IGNORELISTS"> for details.
6007
6008 =item B<IgnoreSelected> I<true>|I<false>
6009
6010 If no configuration is given, the B<onewire> plugin will collect data from all
6011 sensors found. This may not be practical, especially if sensors are added and
6012 removed regularly. Sometimes, however, it's easier/preferred to collect only
6013 specific sensors or all sensors I<except> a few specified ones. This option
6014 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
6015 B<Sensor> is inverted: All selected interfaces are ignored and all other
6016 interfaces are collected.
6017
6018 Used only in the standard mode - see above.
6019
6020 =item B<Interval> I<Seconds>
6021
6022 Sets the interval in which all sensors should be read. If not specified, the
6023 global B<Interval> setting is used.
6024
6025 =back
6026
6027 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
6028 work with big setups. It works with one sensor being attached to one
6029 controller, but as soon as you throw in a couple more senors and maybe a hub
6030 or two, reading all values will take more than ten seconds (the default
6031 interval). We will probably add some separate thread for reading the sensors
6032 and some cache or something like that, but it's not done yet. We will try to
6033 maintain backwards compatibility in the future, but we can't promise. So in
6034 short: If it works for you: Great! But keep in mind that the config I<might>
6035 change, though this is unlikely. Oh, and if you want to help improving this
6036 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6037
6038 =head2 Plugin C<openldap>
6039
6040 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6041 server correctly. The backend database C<monitor> needs to be loaded and
6042 working. See slapd-monitor(5) for the details.
6043
6044 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6045 blocks. Each block requires one string argument as the instance name. For
6046 example:
6047
6048  <Plugin "openldap">
6049    <Instance "foo">
6050      URL "ldap://localhost/"
6051    </Instance>
6052    <Instance "bar">
6053      URL "ldaps://localhost/"
6054    </Instance>
6055  </Plugin>
6056
6057 The instance name will be used as the I<plugin instance>. To emulate the old
6058 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6059 plugin to work correctly, each instance name must be unique. This is not
6060 enforced by the plugin and it is your responsibility to ensure it is.
6061
6062 The following options are accepted within each B<Instance> block:
6063
6064 =over 4
6065
6066 =item B<URL> I<ldap://host/binddn>
6067
6068 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6069 I<mandatory>.
6070
6071 =item B<BindDN> I<BindDN>
6072
6073 Name in the form of an LDAP distinguished name intended to be used for
6074 authentication. Defaults to empty string to establish an anonymous authorization.
6075
6076 =item B<Password> I<Password>
6077
6078 Password for simple bind authentication. If this option is not set,
6079 unauthenticated bind operation is used.
6080
6081 =item B<StartTLS> B<true|false>
6082
6083 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6084 Disabled by default.
6085
6086 =item B<VerifyHost> B<true|false>
6087
6088 Enables or disables peer host name verification. If enabled, the plugin checks
6089 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6090 certificate matches the host name provided by the B<URL> option. If this
6091 identity check fails, the connection is aborted. Enabled by default.
6092
6093 =item B<CACert> I<File>
6094
6095 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6096 may possibly need this option. What CA certificates are checked by default
6097 depends on the distribution you use and can be changed with the usual ldap
6098 client configuration mechanisms. See ldap.conf(5) for the details.
6099
6100 =item B<Timeout> I<Seconds>
6101
6102 Sets the timeout value for ldap operations, in seconds. By default, the
6103 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6104 (infinite timeout).
6105
6106 =item B<Version> I<Version>
6107
6108 An integer which sets the LDAP protocol version number to use when connecting
6109 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6110
6111 =back
6112
6113 =head2 Plugin C<openvpn>
6114
6115 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6116 traffic statistics about connected clients.
6117
6118 To set up OpenVPN to write to the status file periodically, use the
6119 B<--status> option of OpenVPN.
6120
6121 So, in a nutshell you need:
6122
6123   openvpn $OTHER_OPTIONS \
6124     --status "/var/run/openvpn-status" 10
6125
6126 Available options:
6127
6128 =over 4
6129
6130 =item B<StatusFile> I<File>
6131
6132 Specifies the location of the status file.
6133
6134 =item B<ImprovedNamingSchema> B<true>|B<false>
6135
6136 When enabled, the filename of the status file will be used as plugin instance
6137 and the client's "common name" will be used as type instance. This is required
6138 when reading multiple status files. Enabling this option is recommended, but to
6139 maintain backwards compatibility this option is disabled by default.
6140
6141 =item B<CollectCompression> B<true>|B<false>
6142
6143 Sets whether or not statistics about the compression used by OpenVPN should be
6144 collected. This information is only available in I<single> mode. Enabled by
6145 default.
6146
6147 =item B<CollectIndividualUsers> B<true>|B<false>
6148
6149 Sets whether or not traffic information is collected for each connected client
6150 individually. If set to false, currently no traffic data is collected at all
6151 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6152
6153 =item B<CollectUserCount> B<true>|B<false>
6154
6155 When enabled, the number of currently connected clients or users is collected.
6156 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6157 can be configured independently from that option. Defaults to B<false>.
6158
6159 =back
6160
6161 =head2 Plugin C<oracle>
6162
6163 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6164 Oracle® Database and lets you execute SQL statements there. It is very similar
6165 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6166 plugin's documentation above for details.
6167
6168   <Plugin oracle>
6169     <Query "out_of_stock">
6170       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6171       <Result>
6172         Type "gauge"
6173         # InstancePrefix "foo"
6174         InstancesFrom "category"
6175         ValuesFrom "value"
6176       </Result>
6177     </Query>
6178     <Database "product_information">
6179       #Plugin "warehouse"
6180       ConnectID "db01"
6181       Username "oracle"
6182       Password "secret"
6183       Query "out_of_stock"
6184     </Database>
6185   </Plugin>
6186
6187 =head3 B<Query> blocks
6188
6189 The Query blocks are handled identically to the Query blocks of the "dbi"
6190 plugin. Please see its documentation above for details on how to specify
6191 queries.
6192
6193 =head3 B<Database> blocks
6194
6195 Database blocks define a connection to a database and which queries should be
6196 sent to that database. Each database needs a "name" as string argument in the
6197 starting tag of the block. This name will be used as "PluginInstance" in the
6198 values submitted to the daemon. Other than that, that name is not used.
6199
6200 =over 4
6201
6202 =item B<Plugin> I<Plugin>
6203
6204 Use I<Plugin> as the plugin name when submitting query results from
6205 this B<Database>. Defaults to C<oracle>.
6206
6207 =item B<ConnectID> I<ID>
6208
6209 Defines the "database alias" or "service name" to connect to. Usually, these
6210 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6211
6212 =item B<Host> I<Host>
6213
6214 Hostname to use when dispatching values for this database. Defaults to using
6215 the global hostname of the I<collectd> instance.
6216
6217 =item B<Username> I<Username>
6218
6219 Username used for authentication.
6220
6221 =item B<Password> I<Password>
6222
6223 Password used for authentication.
6224
6225 =item B<Query> I<QueryName>
6226
6227 Associates the query named I<QueryName> with this database connection. The
6228 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6229 blocks you want to refer to must be placed above the database block you want to
6230 refer to them from.
6231
6232 =back
6233
6234 =head2 Plugin C<ovs_events>
6235
6236 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6237 connected interfaces, dispatches the values to collectd and sends the
6238 notification whenever the link state change occurs. This plugin uses OVS
6239 database to get a link state change notification.
6240
6241 B<Synopsis:>
6242
6243  <Plugin "ovs_events">
6244    Port 6640
6245    Address "127.0.0.1"
6246    Socket "/var/run/openvswitch/db.sock"
6247    Interfaces "br0" "veth0"
6248    SendNotification true
6249    DispatchValues false
6250  </Plugin>
6251
6252 The plugin provides the following configuration options:
6253
6254 =over 4
6255
6256 =item B<Address> I<node>
6257
6258 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6259 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6260 option. See L<ovsdb-server(1)> for more details. The option may be either
6261 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6262 format. Defaults to C<localhost>.
6263
6264 =item B<Port> I<service>
6265
6266 TCP-port to connect to. Either a service name or a port number may be given.
6267 Defaults to B<6640>.
6268
6269 =item B<Socket> I<path>
6270
6271 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6272 plugin. To enable the interface, the OVS DB daemon should be running with
6273 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6274 option is set, B<Address> and B<Port> options are ignored.
6275
6276 =item B<Interfaces> [I<ifname> ...]
6277
6278 List of interface names to be monitored by this plugin. If this option is not
6279 specified or is empty then all OVS connected interfaces on all bridges are
6280 monitored.
6281
6282 Default: empty (all interfaces on all bridges are monitored)
6283
6284 =item B<SendNotification> I<true|false>
6285
6286 If set to true, OVS link notifications (interface status and OVS DB connection
6287 terminate) are sent to collectd. Default value is true.
6288
6289 =item B<DispatchValues> I<true|false>
6290
6291 Dispatch the OVS DB interface link status value with configured plugin interval.
6292 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6293 options are false, no OVS information will be provided by the plugin.
6294
6295 =back
6296
6297 B<Note:> By default, the global interval setting is used within which to
6298 retrieve the OVS link status. To configure a plugin-specific interval, please
6299 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6300 simple divide the time by 1000 for example if the desired interval is 50ms, set
6301 interval to 0.05.
6302
6303 =head2 Plugin C<ovs_stats>
6304
6305 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6306 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6307 statistics from OVSDB
6308
6309 B<Synopsis:>
6310
6311  <Plugin "ovs_stats">
6312    Port 6640
6313    Address "127.0.0.1"
6314    Socket "/var/run/openvswitch/db.sock"
6315    Bridges "br0" "br_ext"
6316  </Plugin>
6317
6318 The plugin provides the following configuration options:
6319
6320 =over 4
6321
6322 =item B<Address> I<node>
6323
6324 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6325 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6326 option. See L<ovsdb-server(1)> for more details. The option may be either
6327 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6328 format. Defaults to C<localhost>.
6329
6330 =item B<Port> I<service>
6331
6332 TCP-port to connect to. Either a service name or a port number may be given.
6333 Defaults to B<6640>.
6334
6335 =item B<Socket> I<path>
6336
6337 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6338 plugin. To enable the interface, the OVS DB daemon should be running with
6339 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6340 option is set, B<Address> and B<Port> options are ignored.
6341
6342 =item B<Bridges> [I<brname> ...]
6343
6344 List of OVS bridge names to be monitored by this plugin. If this option is
6345 omitted or is empty then all OVS bridges will be monitored.
6346
6347 Default: empty (monitor all bridges)
6348
6349 =back
6350
6351 =head2 Plugin C<pcie_errors>
6352
6353 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6354 structure and from Advanced Error Reporting Extended Capability where available.
6355 At every read it polls config space of PCI Express devices and dispatches
6356 notification for every error that is set. It checks for new errors at every read.
6357 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6358 Errors are divided into categories indicated by type_instance: "correctable", and
6359 for uncorrectable errors "non_fatal" or "fatal".
6360 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6361
6362 B<Synopsis:>
6363
6364   <Plugin "pcie_errors">
6365     Source "sysfs"
6366     AccessDir "/sys/bus/pci"
6367     ReportMasked false
6368     PersistentNotifications false
6369   </Plugin>
6370
6371 B<Options:>
6372
6373 =over 4
6374
6375 =item B<Source> B<sysfs>|B<proc>
6376
6377 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6378 The default value is B<sysfs>.
6379
6380 =item B<AccessDir> I<dir>
6381
6382 Directory used to access device config space. It is optional and defaults to
6383 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6384
6385 =item B<ReportMasked> B<false>|B<true>
6386
6387 If true plugin will notify about errors that are set to masked in Error Mask register.
6388 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6389
6390 =item B<PersistentNotifications> B<false>|B<true>
6391
6392 If false plugin will dispatch notification only on set/clear of error.
6393 The ones already reported will be ignored. Defaults to B<false>.
6394
6395 =back
6396
6397 =head2 Plugin C<perl>
6398
6399 This plugin embeds a Perl-interpreter into collectd and provides an interface
6400 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6401
6402 =head2 Plugin C<pinba>
6403
6404 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6405 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6406 PHP-based webpage has been delivered, the extension will send a UDP packet
6407 containing timing information, peak memory usage and so on. The plugin will
6408 wait for such packets, parse them and account the provided information, which
6409 is then dispatched to the daemon once per interval.
6410
6411 Synopsis:
6412
6413  <Plugin pinba>
6414    Address "::0"
6415    Port "30002"
6416    # Overall statistics for the website.
6417    <View "www-total">
6418      Server "www.example.com"
6419    </View>
6420    # Statistics for www-a only
6421    <View "www-a">
6422      Host "www-a.example.com"
6423      Server "www.example.com"
6424    </View>
6425    # Statistics for www-b only
6426    <View "www-b">
6427      Host "www-b.example.com"
6428      Server "www.example.com"
6429    </View>
6430  </Plugin>
6431
6432 The plugin provides the following configuration options:
6433
6434 =over 4
6435
6436 =item B<Address> I<Node>
6437
6438 Configures the address used to open a listening socket. By default, plugin will
6439 bind to the I<any> address C<::0>.
6440
6441 =item B<Port> I<Service>
6442
6443 Configures the port (service) to bind to. By default the default Pinba port
6444 "30002" will be used. The option accepts service names in addition to port
6445 numbers and thus requires a I<string> argument.
6446
6447 =item E<lt>B<View> I<Name>E<gt> block
6448
6449 The packets sent by the Pinba extension include the hostname of the server, the
6450 server name (the name of the virtual host) and the script that was executed.
6451 Using B<View> blocks it is possible to separate the data into multiple groups
6452 to get more meaningful statistics. Each packet is added to all matching groups,
6453 so that a packet may be accounted for more than once.
6454
6455 =over 4
6456
6457 =item B<Host> I<Host>
6458
6459 Matches the hostname of the system the webserver / script is running on. This
6460 will contain the result of the L<gethostname(2)> system call. If not
6461 configured, all hostnames will be accepted.
6462
6463 =item B<Server> I<Server>
6464
6465 Matches the name of the I<virtual host>, i.e. the contents of the
6466 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6467 server names will be accepted.
6468
6469 =item B<Script> I<Script>
6470
6471 Matches the name of the I<script name>, i.e. the contents of the
6472 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6473 script names will be accepted.
6474
6475 =back
6476
6477 =back
6478
6479 =head2 Plugin C<ping>
6480
6481 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6482 configured hosts periodically and measures the network latency. Whenever the
6483 C<read> function of the plugin is called, it submits the average latency, the
6484 standard deviation and the drop rate for each host.
6485
6486 Available configuration options:
6487
6488 =over 4
6489
6490 =item B<Host> I<IP-address>
6491
6492 Host to ping periodically. This option may be repeated several times to ping
6493 multiple hosts.
6494
6495 =item B<Interval> I<Seconds>
6496
6497 Sets the interval in which to send ICMP echo packets to the configured hosts.
6498 This is B<not> the interval in which metrics are read from the plugin but the
6499 interval in which the hosts are "pinged". Therefore, the setting here should be
6500 smaller than or equal to the global B<Interval> setting. Fractional times, such
6501 as "1.24" are allowed.
6502
6503 Default: B<1.0>
6504
6505 =item B<Timeout> I<Seconds>
6506
6507 Time to wait for a response from the host to which an ICMP packet had been
6508 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6509 to be down or the packet to be dropped. This setting must be smaller than the
6510 B<Interval> setting above for the plugin to work correctly. Fractional
6511 arguments are accepted.
6512
6513 Default: B<0.9>
6514
6515 =item B<TTL> I<0-255>
6516
6517 Sets the Time-To-Live of generated ICMP packets.
6518
6519 =item B<Size> I<size>
6520
6521 Sets the size of the data payload in ICMP packet to specified I<size> (it
6522 will be filled with regular ASCII pattern). If not set, default 56 byte
6523 long string is used so that the packet size of an ICMPv4 packet is exactly
6524 64 bytes, similar to the behaviour of normal ping(1) command.
6525
6526 =item B<SourceAddress> I<host>
6527
6528 Sets the source address to use. I<host> may either be a numerical network
6529 address or a network hostname.
6530
6531 =item B<AddressFamily> I<af>
6532
6533 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6534 option will be ignored if you set a B<SourceAddress>.
6535
6536 =item B<Device> I<name>
6537
6538 Sets the outgoing network device to be used. I<name> has to specify an
6539 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6540 operating systems.
6541
6542 =item B<MaxMissed> I<Packets>
6543
6544 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6545 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6546
6547 Default: B<-1> (disabled)
6548
6549 =back
6550
6551 =head2 Plugin C<postgresql>
6552
6553 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6554 keeps a persistent connection to all configured databases and tries to
6555 reconnect if the connection has been interrupted. A database is configured by
6556 specifying a B<Database> block as described below. The default statistics are
6557 collected from PostgreSQL's B<statistics collector> which thus has to be
6558 enabled for this plugin to work correctly. This should usually be the case by
6559 default. See the section "The Statistics Collector" of the B<PostgreSQL
6560 Documentation> for details.
6561
6562 By specifying custom database queries using a B<Query> block as described
6563 below, you may collect any data that is available from some PostgreSQL
6564 database. This way, you are able to access statistics of external daemons
6565 which are available in a PostgreSQL database or use future or special
6566 statistics provided by PostgreSQL without the need to upgrade your collectd
6567 installation.
6568
6569 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6570 PostgreSQL databases as well. This has been implemented in a generic way. You
6571 need to specify an SQL statement which will then be executed by collectd in
6572 order to write the data (see below for details). The benefit of that approach
6573 is that there is no fixed database layout. Rather, the layout may be optimized
6574 for the current setup.
6575
6576 The B<PostgreSQL Documentation> manual can be found at
6577 L<http://www.postgresql.org/docs/manuals/>.
6578
6579   <Plugin postgresql>
6580     <Query magic>
6581       Statement "SELECT magic FROM wizard WHERE host = $1;"
6582       Param hostname
6583       <Result>
6584         Type gauge
6585         InstancePrefix "magic"
6586         ValuesFrom magic
6587       </Result>
6588     </Query>
6589
6590     <Query rt36_tickets>
6591       Statement "SELECT COUNT(type) AS count, type \
6592                         FROM (SELECT CASE \
6593                                      WHEN resolved = 'epoch' THEN 'open' \
6594                                      ELSE 'resolved' END AS type \
6595                                      FROM tickets) type \
6596                         GROUP BY type;"
6597       <Result>
6598         Type counter
6599         InstancePrefix "rt36_tickets"
6600         InstancesFrom "type"
6601         ValuesFrom "count"
6602       </Result>
6603     </Query>
6604
6605     <Writer sqlstore>
6606       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6607       StoreRates true
6608     </Writer>
6609
6610     <Database foo>
6611       Plugin "kingdom"
6612       Host "hostname"
6613       Port "5432"
6614       User "username"
6615       Password "secret"
6616       SSLMode "prefer"
6617       KRBSrvName "kerberos_service_name"
6618       Query magic
6619     </Database>
6620
6621     <Database bar>
6622       Interval 300
6623       Service "service_name"
6624       Query backends # predefined
6625       Query rt36_tickets
6626     </Database>
6627
6628     <Database qux>
6629       # ...
6630       Writer sqlstore
6631       CommitInterval 10
6632     </Database>
6633   </Plugin>
6634
6635 The B<Query> block defines one database query which may later be used by a
6636 database definition. It accepts a single mandatory argument which specifies
6637 the name of the query. The names of all queries have to be unique (see the
6638 B<MinVersion> and B<MaxVersion> options below for an exception to this
6639 rule).
6640
6641 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6642 B<Result> blocks may be used to extract multiple values from a single query.
6643
6644 The following configuration options are available to define the query:
6645
6646 =over 4
6647
6648 =item B<Statement> I<sql query statement>
6649
6650 Specify the I<sql query statement> which the plugin should execute. The string
6651 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6652 first, second, etc. parameter. The value of the parameters is specified by the
6653 B<Param> configuration option - see below for details. To include a literal
6654 B<$> character followed by a number, surround it with single quotes (B<'>).
6655
6656 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6657 allowed. Note, however, that only a single command may be used. Semicolons are
6658 allowed as long as a single non-empty command has been specified only.
6659
6660 The returned lines will be handled separately one after another.
6661
6662 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6663
6664 Specify the parameters which should be passed to the SQL query. The parameters
6665 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6666 they appear in the configuration file. The value of the parameter is
6667 determined depending on the value of the B<Param> option as follows:
6668
6669 =over 4
6670
6671 =item I<hostname>
6672
6673 The configured hostname of the database connection. If a UNIX domain socket is
6674 used, the parameter expands to "localhost".
6675
6676 =item I<database>
6677
6678 The name of the database of the current connection.
6679
6680 =item I<instance>
6681
6682 The name of the database plugin instance. See the B<Instance> option of the
6683 database specification below for details.
6684
6685 =item I<username>
6686
6687 The username used to connect to the database.
6688
6689 =item I<interval>
6690
6691 The interval with which this database is queried (as specified by the database
6692 specific or global B<Interval> options).
6693
6694 =back
6695
6696 Please note that parameters are only supported by PostgreSQL's protocol
6697 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6698
6699 =item B<PluginInstanceFrom> I<column>
6700
6701 Specify how to create the "PluginInstance" for reporting this query results.
6702 Only one column is supported. You may concatenate fields and string values in
6703 the query statement to get the required results.
6704
6705 =item B<MinVersion> I<version>
6706
6707 =item B<MaxVersion> I<version>
6708
6709 Specify the minimum or maximum version of PostgreSQL that this query should be
6710 used with. Some statistics might only be available with certain versions of
6711 PostgreSQL. This allows you to specify multiple queries with the same name but
6712 which apply to different versions, thus allowing you to use the same
6713 configuration in a heterogeneous environment.
6714
6715 The I<version> has to be specified as the concatenation of the major, minor
6716 and patch-level versions, each represented as two-decimal-digit numbers. For
6717 example, version 8.2.3 will become 80203.
6718
6719 =back
6720
6721 The B<Result> block defines how to handle the values returned from the query.
6722 It defines which column holds which value and how to dispatch that value to
6723 the daemon.
6724
6725 =over 4
6726
6727 =item B<Type> I<type>
6728
6729 The I<type> name to be used when dispatching the values. The type describes
6730 how to handle the data and where to store it. See L<types.db(5)> for more
6731 details on types and their configuration. The number and type of values (as
6732 selected by the B<ValuesFrom> option) has to match the type of the given name.
6733
6734 This option is mandatory.
6735
6736 =item B<InstancePrefix> I<prefix>
6737
6738 =item B<InstancesFrom> I<column0> [I<column1> ...]
6739
6740 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6741 B<InstancePrefix> defines a static prefix that will be prepended to all type
6742 instances. B<InstancesFrom> defines the column names whose values will be used
6743 to create the type instance. Multiple values will be joined together using the
6744 hyphen (C<->) as separation character.
6745
6746 The plugin itself does not check whether or not all built instances are
6747 different. It is your responsibility to assure that each is unique.
6748
6749 Both options are optional. If none is specified, the type instance will be
6750 empty.
6751
6752 =item B<ValuesFrom> I<column0> [I<column1> ...]
6753
6754 Names the columns whose content is used as the actual data for the data sets
6755 that are dispatched to the daemon. How many such columns you need is
6756 determined by the B<Type> setting as explained above. If you specify too many
6757 or not enough columns, the plugin will complain about that and no data will be
6758 submitted to the daemon.
6759
6760 The actual data type, as seen by PostgreSQL, is not that important as long as
6761 it represents numbers. The plugin will automatically cast the values to the
6762 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6763 L<strtod(3)> functions, so anything supported by those functions is supported
6764 by the plugin as well.
6765
6766 This option is required inside a B<Result> block and may be specified multiple
6767 times. If multiple B<ValuesFrom> options are specified, the columns are read
6768 in the given order.
6769
6770 =back
6771
6772 The following predefined queries are available (the definitions can be found
6773 in the F<postgresql_default.conf> file which, by default, is available at
6774 C<I<prefix>/share/collectd/>):
6775
6776 =over 4
6777
6778 =item B<backends>
6779
6780 This query collects the number of backends, i.E<nbsp>e. the number of
6781 connected clients.
6782
6783 =item B<transactions>
6784
6785 This query collects the numbers of committed and rolled-back transactions of
6786 the user tables.
6787
6788 =item B<queries>
6789
6790 This query collects the numbers of various table modifications (i.E<nbsp>e.
6791 insertions, updates, deletions) of the user tables.
6792
6793 =item B<query_plans>
6794
6795 This query collects the numbers of various table scans and returned tuples of
6796 the user tables.
6797
6798 =item B<table_states>
6799
6800 This query collects the numbers of live and dead rows in the user tables.
6801
6802 =item B<disk_io>
6803
6804 This query collects disk block access counts for user tables.
6805
6806 =item B<disk_usage>
6807
6808 This query collects the on-disk size of the database in bytes.
6809
6810 =back
6811
6812 In addition, the following detailed queries are available by default. Please
6813 note that each of those queries collects information B<by table>, thus,
6814 potentially producing B<a lot> of data. For details see the description of the
6815 non-by_table queries above.
6816
6817 =over 4
6818
6819 =item B<queries_by_table>
6820
6821 =item B<query_plans_by_table>
6822
6823 =item B<table_states_by_table>
6824
6825 =item B<disk_io_by_table>
6826
6827 =back
6828
6829 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6830 mandatory argument specifying the name of the writer. This will then be used
6831 in the B<Database> specification in order to activate the writer instance. The
6832 names of all writers have to be unique. The following options may be
6833 specified:
6834
6835 =over 4
6836
6837 =item B<Statement> I<sql statement>
6838
6839 This mandatory option specifies the SQL statement that will be executed for
6840 each submitted value. A single SQL statement is allowed only. Anything after
6841 the first semicolon will be ignored.
6842
6843 Nine parameters will be passed to the statement and should be specified as
6844 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6845 values are made available through those parameters:
6846
6847 =over 4
6848
6849 =item B<$1>
6850
6851 The timestamp of the queried value as an RFC 3339-formatted local time.
6852
6853 =item B<$2>
6854
6855 The hostname of the queried value.
6856
6857 =item B<$3>
6858
6859 The plugin name of the queried value.
6860
6861 =item B<$4>
6862
6863 The plugin instance of the queried value. This value may be B<NULL> if there
6864 is no plugin instance.
6865
6866 =item B<$5>
6867
6868 The type of the queried value (cf. L<types.db(5)>).
6869
6870 =item B<$6>
6871
6872 The type instance of the queried value. This value may be B<NULL> if there is
6873 no type instance.
6874
6875 =item B<$7>
6876
6877 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6878 sources of the submitted value-list).
6879
6880 =item B<$8>
6881
6882 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6883 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6884 B<StoreRates> is enabled (which is the default, see below), all types will be
6885 C<gauge>.
6886
6887 =item B<$9>
6888
6889 An array of the submitted values. The dimensions of the value name and value
6890 arrays match.
6891
6892 =back
6893
6894 In general, it is advisable to create and call a custom function in the
6895 PostgreSQL database for this purpose. Any procedural language supported by
6896 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6897 for details).
6898
6899 =item B<StoreRates> B<false>|B<true>
6900
6901 If set to B<true> (the default), convert counter values to rates. If set to
6902 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6903 number.
6904
6905 =back
6906
6907 The B<Database> block defines one PostgreSQL database for which to collect
6908 statistics. It accepts a single mandatory argument which specifies the
6909 database name. None of the other options are required. PostgreSQL will use
6910 default values as documented in the section "CONNECTING TO A DATABASE" in the
6911 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6912 the user collectd is run as and special environment variables. See the manpage
6913 for details.
6914
6915 =over 4
6916
6917 =item B<Interval> I<seconds>
6918
6919 Specify the interval with which the database should be queried. The default is
6920 to use the global B<Interval> setting.
6921
6922 =item B<CommitInterval> I<seconds>
6923
6924 This option may be used for database connections which have "writers" assigned
6925 (see above). If specified, it causes a writer to put several updates into a
6926 single transaction. This transaction will last for the specified amount of
6927 time. By default, each update will be executed in a separate transaction. Each
6928 transaction generates a fair amount of overhead which can, thus, be reduced by
6929 activating this option. The draw-back is, that data covering the specified
6930 amount of time will be lost, for example, if a single statement within the
6931 transaction fails or if the database server crashes.
6932
6933 =item B<Plugin> I<Plugin>
6934
6935 Use I<Plugin> as the plugin name when submitting query results from
6936 this B<Database>. Defaults to C<postgresql>.
6937
6938 =item B<Instance> I<name>
6939
6940 Specify the plugin instance name that should be used instead of the database
6941 name (which is the default, if this option has not been specified). This
6942 allows one to query multiple databases of the same name on the same host (e.g.
6943 when running multiple database server versions in parallel).
6944 The plugin instance name can also be set from the query result using
6945 the B<PluginInstanceFrom> option in B<Query> block.
6946
6947 =item B<Host> I<hostname>
6948
6949 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6950 value begins with a slash, it is interpreted as the directory name in which to
6951 look for the UNIX domain socket.
6952
6953 This option is also used to determine the hostname that is associated with a
6954 collected data set. If it has been omitted or either begins with with a slash
6955 or equals B<localhost> it will be replaced with the global hostname definition
6956 of collectd. Any other value will be passed literally to collectd when
6957 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6958
6959 =item B<Port> I<port>
6960
6961 Specify the TCP port or the local UNIX domain socket file extension of the
6962 server.
6963
6964 =item B<User> I<username>
6965
6966 Specify the username to be used when connecting to the server.
6967
6968 =item B<Password> I<password>
6969
6970 Specify the password to be used when connecting to the server.
6971
6972 =item B<ExpireDelay> I<delay>
6973
6974 Skip expired values in query output.
6975
6976 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6977
6978 Specify whether to use an SSL connection when contacting the server. The
6979 following modes are supported:
6980
6981 =over 4
6982
6983 =item I<disable>
6984
6985 Do not use SSL at all.
6986
6987 =item I<allow>
6988
6989 First, try to connect without using SSL. If that fails, try using SSL.
6990
6991 =item I<prefer> (default)
6992
6993 First, try to connect using SSL. If that fails, try without using SSL.
6994
6995 =item I<require>
6996
6997 Use SSL only.
6998
6999 =back
7000
7001 =item B<Instance> I<name>
7002
7003 Specify the plugin instance name that should be used instead of the database
7004 name (which is the default, if this option has not been specified). This
7005 allows one to query multiple databases of the same name on the same host (e.g.
7006 when running multiple database server versions in parallel).
7007
7008 =item B<KRBSrvName> I<kerberos_service_name>
7009
7010 Specify the Kerberos service name to use when authenticating with Kerberos 5
7011 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
7012 B<PostgreSQL Documentation> for details.
7013
7014 =item B<Service> I<service_name>
7015
7016 Specify the PostgreSQL service name to use for additional parameters. That
7017 service has to be defined in F<pg_service.conf> and holds additional
7018 connection parameters. See the section "The Connection Service File" in the
7019 B<PostgreSQL Documentation> for details.
7020
7021 =item B<Query> I<query>
7022
7023 Specifies a I<query> which should be executed in the context of the database
7024 connection. This may be any of the predefined or user-defined queries. If no
7025 such option is given, it defaults to "backends", "transactions", "queries",
7026 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
7027 has been specified). Else, the specified queries are used only.
7028
7029 =item B<Writer> I<writer>
7030
7031 Assigns the specified I<writer> backend to the database connection. This
7032 causes all collected data to be send to the database using the settings
7033 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7034 below for details on how to selectively send data to certain plugins).
7035
7036 Each writer will register a flush callback which may be used when having long
7037 transactions enabled (see the B<CommitInterval> option above). When issuing
7038 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7039 transaction will be committed right away. Two different kinds of flush
7040 callbacks are available with the C<postgresql> plugin:
7041
7042 =over 4
7043
7044 =item B<postgresql>
7045
7046 Flush all writer backends.
7047
7048 =item B<postgresql->I<database>
7049
7050 Flush all writers of the specified I<database> only.
7051
7052 =back
7053
7054 =back
7055
7056 =head2 Plugin C<powerdns>
7057
7058 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7059 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7060 values, many of which are probably meaningless to most users, but may be useful
7061 for some. So you may chose which values to collect, but if you don't, some
7062 reasonable defaults will be collected.
7063
7064   <Plugin "powerdns">
7065     <Server "server_name">
7066       Collect "latency"
7067       Collect "udp-answers" "udp-queries"
7068       Socket "/var/run/pdns.controlsocket"
7069     </Server>
7070     <Recursor "recursor_name">
7071       Collect "questions"
7072       Collect "cache-hits" "cache-misses"
7073       Socket "/var/run/pdns_recursor.controlsocket"
7074     </Recursor>
7075     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7076   </Plugin>
7077
7078 =over 4
7079
7080 =item B<Server> and B<Recursor> block
7081
7082 The B<Server> block defines one authoritative server to query, the B<Recursor>
7083 does the same for an recursing server. The possible options in both blocks are
7084 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7085 and is required.
7086
7087 =over 4
7088
7089 =item B<Collect> I<Field>
7090
7091 Using the B<Collect> statement you can select which values to collect. Here,
7092 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7093 C<dlg-only-drops>, C<answers10-100>.
7094
7095 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7096 When querying the server a C<SHOW *> command is issued in any case, because
7097 that's the only way of getting multiple values out of the server at once.
7098 collectd then picks out the values you have selected. When querying the
7099 recursor, a command is generated to query exactly these values. So if you
7100 specify invalid fields when querying the recursor, a syntax error may be
7101 returned by the daemon and collectd may not collect any values at all.
7102
7103 If no B<Collect> statement is given, the following B<Server> values will be
7104 collected:
7105
7106 =over 4
7107
7108 =item latency
7109
7110 =item packetcache-hit
7111
7112 =item packetcache-miss
7113
7114 =item packetcache-size
7115
7116 =item query-cache-hit
7117
7118 =item query-cache-miss
7119
7120 =item recursing-answers
7121
7122 =item recursing-questions
7123
7124 =item tcp-answers
7125
7126 =item tcp-queries
7127
7128 =item udp-answers
7129
7130 =item udp-queries
7131
7132 =back
7133
7134 The following B<Recursor> values will be collected by default:
7135
7136 =over 4
7137
7138 =item noerror-answers
7139
7140 =item nxdomain-answers
7141
7142 =item servfail-answers
7143
7144 =item sys-msec
7145
7146 =item user-msec
7147
7148 =item qa-latency
7149
7150 =item cache-entries
7151
7152 =item cache-hits
7153
7154 =item cache-misses
7155
7156 =item questions
7157
7158 =back
7159
7160 Please note that up to that point collectd doesn't know what values are
7161 available on the server and values that are added do not need a change of the
7162 mechanism so far. However, the values must be mapped to collectd's naming
7163 scheme, which is done using a lookup table that lists all known values. If
7164 values are added in the future and collectd does not know about them, you will
7165 get an error much like this:
7166
7167   powerdns plugin: submit: Not found in lookup table: foobar = 42
7168
7169 In this case please file a bug report with the collectd team.
7170
7171 =item B<Socket> I<Path>
7172
7173 Configures the path to the UNIX domain socket to be used when connecting to the
7174 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7175 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7176 will be used for the recursor.
7177
7178 =back
7179
7180 =item B<LocalSocket> I<Path>
7181
7182 Querying the recursor is done using UDP. When using UDP over UNIX domain
7183 sockets, the client socket needs a name in the file system, too. You can set
7184 this local name to I<Path> using the B<LocalSocket> option. The default is
7185 C<I<prefix>/var/run/collectd-powerdns>.
7186
7187 =back
7188
7189 =head2 Plugin C<processes>
7190
7191 Collects information about processes of local system.
7192
7193 By default, with no process matches configured, only general statistics is
7194 collected: the number of processes in each state and fork rate.
7195
7196 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7197 These may also be a block in which further options may be specified.
7198
7199 The statistics collected for matched processes are:
7200  - size of the resident segment size (RSS)
7201  - user- and system-time used
7202  - number of processes
7203  - number of threads
7204  - number of open files (under Linux)
7205  - number of memory mapped files (under Linux)
7206  - io data (where available)
7207  - context switches (under Linux)
7208  - minor and major pagefaults
7209  - Delay Accounting information (Linux only, requires libmnl)
7210
7211 B<Synopsis:>
7212
7213  <Plugin processes>
7214    CollectFileDescriptor  true
7215    CollectContextSwitch   true
7216    CollectDelayAccounting false
7217    Process "name"
7218    ProcessMatch "name" "regex"
7219    <Process "collectd">
7220      CollectFileDescriptor  false
7221      CollectContextSwitch   false
7222      CollectDelayAccounting true
7223    </Process>
7224    <ProcessMatch "name" "regex">
7225      CollectFileDescriptor false
7226      CollectContextSwitch true
7227    </ProcessMatch>
7228  </Plugin>
7229
7230 =over 4
7231
7232 =item B<Process> I<Name>
7233
7234 Select more detailed statistics of processes matching this name.
7235
7236 Some platforms have a limit on the length of process names.
7237 I<Name> must stay below this limit.
7238
7239 =item B<ProcessMatch> I<name> I<regex>
7240
7241 Select more detailed statistics of processes matching the specified I<regex>
7242 (see L<regex(7)> for details). The statistics of all matching processes are
7243 summed up and dispatched to the daemon using the specified I<name> as an
7244 identifier. This allows one to "group" several processes together.
7245 I<name> must not contain slashes.
7246
7247 =item B<CollectContextSwitch> I<Boolean>
7248
7249 Collect the number of context switches for matched processes.
7250 Disabled by default.
7251
7252 =item B<CollectDelayAccounting> I<Boolean>
7253
7254 If enabled, collect Linux Delay Accounding information for matching processes.
7255 Delay Accounting provides the time processes wait for the CPU to become
7256 available, for I/O operations to finish, for pages to be swapped in and for
7257 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7258 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7259 Disabled by default.
7260
7261 This option is only available on Linux, requires the C<libmnl> library and
7262 requires the C<CAP_NET_ADMIN> capability at runtime.
7263
7264 =item B<CollectFileDescriptor> I<Boolean>
7265
7266 Collect number of file descriptors of matched processes.
7267 Disabled by default.
7268
7269 =item B<CollectMemoryMaps> I<Boolean>
7270
7271 Collect the number of memory mapped files of the process.
7272 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7273 the Linux kernel.
7274
7275 =back
7276
7277 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7278 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7279 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7280 reporting the corresponding processes only. Outside of B<Process> and
7281 B<ProcessMatch> blocks these options set the default value for subsequent
7282 matches.
7283
7284 =head2 Plugin C<protocols>
7285
7286 Collects a lot of information about various network protocols, such as I<IP>,
7287 I<TCP>, I<UDP>, etc.
7288
7289 Available configuration options:
7290
7291 =over 4
7292
7293 =item B<Value> I<Selector>
7294
7295 Selects whether or not to select a specific value. The string being matched is
7296 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7297 plugin instance and I<ValueName> will be used as type instance. An example of
7298 the string being used would be C<Tcp:RetransSegs>.
7299
7300 You can use regular expressions to match a large number of values with just one
7301 configuration option. To select all "extended" I<TCP> values, you could use the
7302 following statement:
7303
7304   Value "/^TcpExt:/"
7305
7306 Whether only matched values are selected or all matched values are ignored
7307 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7308 If no value is configured at all, all values will be selected.
7309
7310 See F</"IGNORELISTS"> for details.
7311
7312 =item B<IgnoreSelected> B<true>|B<false>
7313
7314 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7315 matching values will be ignored.
7316
7317 =back
7318
7319 =head2 Plugin C<python>
7320
7321 This plugin embeds a Python-interpreter into collectd and provides an interface
7322 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7323
7324 =head2 Plugin C<routeros>
7325
7326 The C<routeros> plugin connects to a device running I<RouterOS>, the
7327 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7328 I<librouteros> to connect and reads information about the interfaces and
7329 wireless connections of the device. The configuration supports querying
7330 multiple routers:
7331
7332   <Plugin "routeros">
7333     <Router>
7334       Host "router0.example.com"
7335       User "collectd"
7336       Password "secr3t"
7337       CollectInterface true
7338       CollectCPULoad true
7339       CollectMemory true
7340     </Router>
7341     <Router>
7342       Host "router1.example.com"
7343       User "collectd"
7344       Password "5ecret"
7345       CollectInterface true
7346       CollectRegistrationTable true
7347       CollectDF true
7348       CollectDisk true
7349       CollectHealth true
7350     </Router>
7351   </Plugin>
7352
7353 As you can see above, the configuration of the I<routeros> plugin consists of
7354 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7355 options are understood:
7356
7357 =over 4
7358
7359 =item B<Host> I<Host>
7360
7361 Hostname or IP-address of the router to connect to.
7362
7363 =item B<Port> I<Port>
7364
7365 Port name or port number used when connecting. If left unspecified, the default
7366 will be chosen by I<librouteros>, currently "8728". This option expects a
7367 string argument, even when a numeric port number is given.
7368
7369 =item B<User> I<User>
7370
7371 Use the user name I<User> to authenticate. Defaults to "admin".
7372
7373 =item B<Password> I<Password>
7374
7375 Set the password used to authenticate.
7376
7377 =item B<CollectInterface> B<true>|B<false>
7378
7379 When set to B<true>, interface statistics will be collected for all interfaces
7380 present on the device. Defaults to B<false>.
7381
7382 =item B<CollectRegistrationTable> B<true>|B<false>
7383
7384 When set to B<true>, information about wireless LAN connections will be
7385 collected. Defaults to B<false>.
7386
7387 =item B<CollectCPULoad> B<true>|B<false>
7388
7389 When set to B<true>, information about the CPU usage will be collected. The
7390 number is a dimensionless value where zero indicates no CPU usage at all.
7391 Defaults to B<false>.
7392
7393 =item B<CollectMemory> B<true>|B<false>
7394
7395 When enabled, the amount of used and free memory will be collected. How used
7396 memory is calculated is unknown, for example whether or not caches are counted
7397 as used space.
7398 Defaults to B<false>.
7399
7400 =item B<CollectDF> B<true>|B<false>
7401
7402 When enabled, the amount of used and free disk space will be collected.
7403 Defaults to B<false>.
7404
7405 =item B<CollectDisk> B<true>|B<false>
7406
7407 When enabled, the number of sectors written and bad blocks will be collected.
7408 Defaults to B<false>.
7409
7410 =item B<CollectHealth> B<true>|B<false>
7411
7412 When enabled, the health statistics will be collected. This includes the
7413 voltage and temperature on supported hardware.
7414 Defaults to B<false>.
7415
7416 =back
7417
7418 =head2 Plugin C<redis>
7419
7420 The I<Redis plugin> connects to one or more Redis servers, gathers
7421 information about each server's state and executes user-defined queries.
7422 For each server there is a I<Node> block which configures the connection
7423 parameters and set of user-defined queries for this node.
7424
7425   <Plugin redis>
7426     <Node "example">
7427         Host "localhost"
7428         Port "6379"
7429         #Socket "/var/run/redis/redis.sock"
7430         Timeout 2000
7431         ReportCommandStats false
7432         ReportCpuUsage true
7433         <Query "LLEN myqueue">
7434           #Database 0
7435           Type "queue_length"
7436           Instance "myqueue"
7437         </Query>
7438     </Node>
7439   </Plugin>
7440
7441 =over 4
7442
7443 =item B<Node> I<Nodename>
7444
7445 The B<Node> block identifies a new Redis node, that is a new Redis instance
7446 running in an specified host and port. The name for node is a canonical
7447 identifier which is used as I<plugin instance>. It is limited to
7448 128E<nbsp>characters in length.
7449
7450 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7451
7452 =item B<Host> I<Hostname>
7453
7454 The B<Host> option is the hostname or IP-address where the Redis instance is
7455 running on.
7456
7457 =item B<Port> I<Port>
7458
7459 The B<Port> option is the TCP port on which the Redis instance accepts
7460 connections. Either a service name of a port number may be given. Please note
7461 that numerical port numbers must be given as a string, too.
7462
7463 =item B<Socket> I<Path>
7464
7465 Connect to Redis using the UNIX domain socket at I<Path>. If this
7466 setting is given, the B<Hostname> and B<Port> settings are ignored.
7467
7468 =item B<Password> I<Password>
7469
7470 Use I<Password> to authenticate when connecting to I<Redis>.
7471
7472 =item B<Timeout> I<Milliseconds>
7473
7474 The B<Timeout> option set the socket timeout for node response. Since the Redis
7475 read function is blocking, you should keep this value as low as possible.
7476 It is expected what B<Timeout> values should be lower than B<Interval> defined
7477 globally.
7478
7479 Defaults to 2000 (2 seconds).
7480
7481 =item B<ReportCommandStats> B<false>|B<true>
7482
7483 Enables or disables reporting of statistics based on the command type, including
7484 rate of command calls and average CPU time consumed by command processing.
7485 Defaults to B<false>.
7486
7487 =item B<ReportCpuUsage> B<true>|B<false>
7488
7489 Enables or disables reporting of CPU consumption statistics.
7490 Defaults to B<true>.
7491
7492 =item B<Query> I<Querystring>
7493
7494 The B<Query> block identifies a query to execute against the redis server.
7495 There may be an arbitrary number of queries to execute. Each query should
7496 return single string or integer.
7497
7498 =item B<Type> I<Collectd type>
7499
7500 Within a query definition, a valid I<collectd type> to use as when submitting
7501 the result of the query. When not supplied, will default to B<gauge>.
7502
7503 Currently only types with one datasource are supported.
7504 See L<types.db(5)> for more details on types and their configuration.
7505
7506 =item B<Instance> I<Type instance>
7507
7508 Within a query definition, an optional type instance to use when submitting
7509 the result of the query. When not supplied will default to the escaped
7510 command, up to 128 chars.
7511
7512 =item B<Database> I<Index>
7513
7514 This index selects the Redis logical database to use for query. Defaults
7515 to C<0>.
7516
7517 =back
7518
7519 =head2 Plugin C<rrdcached>
7520
7521 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7522 to store values to RRD files in an efficient manner. The combination of the
7523 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7524 way the C<rrdtool> plugin works (see below). The added abstraction layer
7525 provides a number of benefits, though: Because the cache is not within
7526 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7527 restarted. This results in much shorter (if any) gaps in graphs, especially
7528 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7529 daemon so that it can flush values to disk automatically when needed. This
7530 allows one to integrate automated flushing of values into graphing solutions
7531 much more easily.
7532
7533 There are disadvantages, though: The daemon may reside on a different host, so
7534 it may not be possible for C<collectd> to create the appropriate RRD files
7535 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7536 different base directory, so relative paths may do weird stuff if you're not
7537 careful.
7538
7539 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7540 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7541 setting should be set to an absolute path, so that a changed base directory
7542 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7543
7544 =over 4
7545
7546 =item B<DaemonAddress> I<Address>
7547
7548 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7549 library. See L<rrdcached(1)> for details. Example:
7550
7551   <Plugin "rrdcached">
7552     DaemonAddress "unix:/var/run/rrdcached.sock"
7553   </Plugin>
7554
7555 =item B<DataDir> I<Directory>
7556
7557 Set the base directory in which the RRD files reside. If this is a relative
7558 path, it is relative to the working base directory of the C<rrdcached> daemon!
7559 Use of an absolute path is recommended.
7560
7561 =item B<CreateFiles> B<true>|B<false>
7562
7563 Enables or disables the creation of RRD files. If the daemon is not running
7564 locally, or B<DataDir> is set to a relative path, this will not work as
7565 expected. Default is B<true>.
7566
7567 =item B<CreateFilesAsync> B<false>|B<true>
7568
7569 When enabled, new RRD files are enabled asynchronously, using a separate thread
7570 that runs in the background. This prevents writes to block, which is a problem
7571 especially when many hundreds of files need to be created at once. However,
7572 since the purpose of creating the files asynchronously is I<not> to block until
7573 the file is available, values before the file is available will be discarded.
7574 When disabled (the default) files are created synchronously, blocking for a
7575 short while, while the file is being written.
7576
7577 =item B<StepSize> I<Seconds>
7578
7579 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7580 this setting is unset and the stepsize is set to the interval in which the data
7581 is collected. Do not use this option unless you absolutely have to for some
7582 reason. Setting this option may cause problems with the C<snmp plugin>, the
7583 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7584
7585 =item B<HeartBeat> I<Seconds>
7586
7587 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7588 in which case the heartbeat is set to twice the B<StepSize> which should equal
7589 the interval in which data is collected. Do not set this option unless you have
7590 a very good reason to do so.
7591
7592 =item B<RRARows> I<NumRows>
7593
7594 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7595 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7596 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7597 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7598 week, one month, and one year.
7599
7600 So for each timespan, it calculates how many PDPs need to be consolidated into
7601 one CDP by calculating:
7602   number of PDPs = timespan / (stepsize * rrarows)
7603
7604 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7605 default is 1200.
7606
7607 =item B<RRATimespan> I<Seconds>
7608
7609 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7610 more then one RRA. If this option is never used, the built-in default of (3600,
7611 86400, 604800, 2678400, 31622400) is used.
7612
7613 For more information on how RRA-sizes are calculated see B<RRARows> above.
7614
7615 =item B<XFF> I<Factor>
7616
7617 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7618 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7619 one (exclusive).
7620
7621 =item B<CollectStatistics> B<false>|B<true>
7622
7623 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7624 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7625
7626 Statistics are read via I<rrdcached>s socket using the STATS command.
7627 See L<rrdcached(1)> for details.
7628
7629 =back
7630
7631 =head2 Plugin C<rrdtool>
7632
7633 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7634 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7635 using these settings. If you don't want to dive into the depths of RRDtool, you
7636 can safely ignore these settings.
7637
7638 =over 4
7639
7640 =item B<DataDir> I<Directory>
7641
7642 Set the directory to store RRD files under. By default RRD files are generated
7643 beneath the daemon's working directory, i.e. the B<BaseDir>.
7644
7645 =item B<CreateFilesAsync> B<false>|B<true>
7646
7647 When enabled, new RRD files are enabled asynchronously, using a separate thread
7648 that runs in the background. This prevents writes to block, which is a problem
7649 especially when many hundreds of files need to be created at once. However,
7650 since the purpose of creating the files asynchronously is I<not> to block until
7651 the file is available, values before the file is available will be discarded.
7652 When disabled (the default) files are created synchronously, blocking for a
7653 short while, while the file is being written.
7654
7655 =item B<StepSize> I<Seconds>
7656
7657 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7658 this setting is unset and the stepsize is set to the interval in which the data
7659 is collected. Do not use this option unless you absolutely have to for some
7660 reason. Setting this option may cause problems with the C<snmp plugin>, the
7661 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7662
7663 =item B<HeartBeat> I<Seconds>
7664
7665 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7666 in which case the heartbeat is set to twice the B<StepSize> which should equal
7667 the interval in which data is collected. Do not set this option unless you have
7668 a very good reason to do so.
7669
7670 =item B<RRARows> I<NumRows>
7671
7672 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7673 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7674 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7675 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7676 week, one month, and one year.
7677
7678 So for each timespan, it calculates how many PDPs need to be consolidated into
7679 one CDP by calculating:
7680   number of PDPs = timespan / (stepsize * rrarows)
7681
7682 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7683 default is 1200.
7684
7685 =item B<RRATimespan> I<Seconds>
7686
7687 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7688 more then one RRA. If this option is never used, the built-in default of (3600,
7689 86400, 604800, 2678400, 31622400) is used.
7690
7691 For more information on how RRA-sizes are calculated see B<RRARows> above.
7692
7693 =item B<XFF> I<Factor>
7694
7695 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7696 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7697 one (exclusive).
7698
7699 =item B<CacheFlush> I<Seconds>
7700
7701 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7702 it writes all values for a certain RRD-file if the oldest value is older than
7703 (or equal to) the number of seconds specified by B<CacheTimeout>.
7704 That check happens on new values arriwal. If some RRD-file is not updated
7705 anymore for some reason (the computer was shut down, the network is broken,
7706 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7707 every I<Seconds> seconds the entire cache is searched for entries older than
7708 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7709 disk. Since scanning the entire cache is kind of expensive and does nothing
7710 under normal circumstances, this value should not be too small. 900 seconds
7711 might be a good value, though setting this to 7200 seconds doesn't normally
7712 do much harm either.
7713
7714 Defaults to 10x B<CacheTimeout>.
7715 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7716 above default is used.
7717
7718 =item B<CacheTimeout> I<Seconds>
7719
7720 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7721 save values in a cache, as described above. Writing multiple values at once
7722 reduces IO-operations and thus lessens the load produced by updating the files.
7723 The trade off is that the graphs kind of "drag behind" and that more memory is
7724 used.
7725
7726 =item B<WritesPerSecond> I<Updates>
7727
7728 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7729 will run serious performance problems. The B<CacheFlush> setting and the
7730 internal update queue assert that collectd continues to work just fine even
7731 under heavy load, but the system may become very unresponsive and slow. This is
7732 a problem especially if you create graphs from the RRD files on the same
7733 machine, for example using the C<graph.cgi> script included in the
7734 C<contrib/collection3/> directory.
7735
7736 This setting is designed for very large setups. Setting this option to a value
7737 between 25 and 80 updates per second, depending on your hardware, will leave
7738 the server responsive enough to draw graphs even while all the cached values
7739 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7740 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7741 written as fast as possible, so that web frontends have up to date data when
7742 generating graphs.
7743
7744 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7745 updates per second, writing all values to disk will take approximately
7746 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7747 "collection3" you'll end up with a responsive and fast system, up to date
7748 graphs and basically a "backup" of your values every hour.
7749
7750 =item B<RandomTimeout> I<Seconds>
7751
7752 When set, the actual timeout for each value is chosen randomly between
7753 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7754 intention is to avoid high load situations that appear when many values timeout
7755 at the same time. This is especially a problem shortly after the daemon starts,
7756 because all values were added to the internal cache at roughly the same time.
7757
7758 =back
7759
7760 =head2 Plugin C<sensors>
7761
7762 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7763 that all the needed modules have to be loaded and lm_sensors has to be
7764 configured (most likely by editing F</etc/sensors.conf>. Read
7765 L<sensors.conf(5)> for details.
7766
7767 The B<lm_sensors> homepage can be found at
7768 L<http://secure.netroedge.com/~lm78/>.
7769
7770 =over 4
7771
7772 =item B<SensorConfigFile> I<File>
7773
7774 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7775 the library's default will be used.
7776
7777 =item B<Sensor> I<chip-bus-address/type-feature>
7778
7779 Selects the name of the sensor which you want to collect or ignore, depending
7780 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7781 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7782 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7783
7784 See F</"IGNORELISTS"> for details.
7785
7786 =item B<IgnoreSelected> I<true>|I<false>
7787
7788 If no configuration if given, the B<sensors>-plugin will collect data from all
7789 sensors. This may not be practical, especially for uninteresting sensors.
7790 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7791 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7792 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7793 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7794 and all other sensors are collected.
7795
7796 =item B<UseLabels> I<true>|I<false>
7797
7798 Configures how sensor readings are reported. When set to I<true>, sensor
7799 readings are reported using their descriptive label (e.g. "VCore"). When set to
7800 I<false> (the default) the sensor name is used ("in0").
7801
7802 =back
7803
7804 =head2 Plugin C<sigrok>
7805
7806 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7807 supported by the L<sigrok|http://sigrok.org/> project.
7808
7809 B<Synopsis>
7810
7811  <Plugin sigrok>
7812    LogLevel 3
7813    <Device "AC Voltage">
7814       Driver "fluke-dmm"
7815       MinimumInterval 10
7816       Conn "/dev/ttyUSB2"
7817    </Device>
7818    <Device "Sound Level">
7819       Driver "cem-dt-885x"
7820       Conn "/dev/ttyUSB1"
7821    </Device>
7822  </Plugin>
7823
7824 =over 4
7825
7826 =item B<LogLevel> B<0-5>
7827
7828 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7829 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7830 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7831 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7832 their level, are always submitted to I<collectd> at its INFO log level.
7833
7834 =item E<lt>B<Device> I<Name>E<gt>
7835
7836 A sigrok-supported device, uniquely identified by this section's options. The
7837 I<Name> is passed to I<collectd> as the I<plugin instance>.
7838
7839 =item B<Driver> I<DriverName>
7840
7841 The sigrok driver to use for this device.
7842
7843 =item B<Conn> I<ConnectionSpec>
7844
7845 If the device cannot be auto-discovered, or more than one might be discovered
7846 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7847 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7848 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7849 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7850 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7851
7852 =item B<SerialComm> I<SerialSpec>
7853
7854 For serial devices with non-standard port settings, this option can be used
7855 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7856 This should not be necessary; drivers know how to communicate with devices they
7857 support.
7858
7859 =item B<MinimumInterval> I<Seconds>
7860
7861 Specifies the minimum time between measurement dispatches to I<collectd>, in
7862 seconds. Since some I<sigrok> supported devices can acquire measurements many
7863 times per second, it may be necessary to throttle these. For example, the
7864 I<RRD plugin> cannot process writes more than once per second.
7865
7866 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7867 device are always dispatched to I<collectd>. When throttled, unused
7868 measurements are discarded.
7869
7870 =back
7871
7872 =head2 Plugin C<smart>
7873
7874 The C<smart> plugin collects SMART information from physical
7875 disks. Values collectd include temperature, power cycle count, poweron
7876 time and bad sectors. Also, all SMART attributes are collected along
7877 with the normalized current value, the worst value, the threshold and
7878 a human readable value.
7879
7880 Using the following two options you can ignore some disks or configure the
7881 collection only of specific disks.
7882
7883 =over 4
7884
7885 =item B<Disk> I<Name>
7886
7887 Select the disk I<Name>. Whether it is collected or ignored depends on the
7888 B<IgnoreSelected> setting, see below. As with other plugins that use the
7889 daemon's ignorelist functionality, a string that starts and ends with a slash
7890 is interpreted as a regular expression. Examples:
7891
7892   Disk "sdd"
7893   Disk "/hda[34]/"
7894
7895 See F</"IGNORELISTS"> for details.
7896
7897 =item B<IgnoreSelected> B<true>|B<false>
7898
7899 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7900 statements, are ignored or if all other disks are ignored. The behavior
7901 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7902 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7903 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7904 is set to B<true>, all disks are collected B<except> the ones matched.
7905
7906 =item B<IgnoreSleepMode> B<true>|B<false>
7907
7908 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7909 This option disables the sleep mode check and allows the plugin to collect data
7910 from these disks anyway. This is useful in cases where libatasmart mistakenly
7911 reports disks as asleep because it has not been updated to incorporate support
7912 for newer idle states in the ATA spec.
7913
7914 =item B<UseSerial> B<true>|B<false>
7915
7916 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7917 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7918 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7919 storing data. This ensures that the data for a given disk will be kept together
7920 even if the kernel name changes.
7921
7922 =back
7923
7924 =head2 Plugin C<snmp>
7925
7926 Since the configuration of the C<snmp plugin> is a little more complicated than
7927 other plugins, its documentation has been moved to an own manpage,
7928 L<collectd-snmp(5)>. Please see there for details.
7929
7930 =head2 Plugin C<snmp_agent>
7931
7932 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7933 from SNMP master agent and returns the data collected by read plugins.
7934 The I<snmp_agent> plugin handles requests only for OIDs specified in
7935 configuration file. To handle SNMP queries the plugin gets data from collectd
7936 and translates requested values from collectd's internal format to SNMP format.
7937 This plugin is a generic plugin and cannot work without configuration.
7938 For more details on AgentX subagent see
7939 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7940
7941 B<Synopsis:>
7942
7943   <Plugin snmp_agent>
7944     <Data "memAvailReal">
7945       Plugin "memory"
7946       #PluginInstance "some"
7947       Type "memory"
7948       TypeInstance "free"
7949       OIDs "1.3.6.1.4.1.2021.4.6.0"
7950     </Data>
7951     <Table "ifTable">
7952       IndexOID "IF-MIB::ifIndex"
7953       SizeOID "IF-MIB::ifNumber"
7954       <Data "ifDescr">
7955         <IndexKey>
7956           Source "PluginInstance"
7957         </IndexKey>
7958         Plugin "interface"
7959         OIDs "IF-MIB::ifDescr"
7960       </Data>
7961       <Data "ifOctets">
7962         Plugin "interface"
7963         Type "if_octets"
7964         TypeInstance ""
7965         OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7966       </Data>
7967     </Table>
7968     <Table "CPUAffinityTable">
7969       <Data "DomainName">
7970         <IndexKey>
7971           Source "PluginInstance"
7972         </IndexKey>
7973         Plugin "virt"
7974         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
7975       </Data>
7976       <Data "VCPU">
7977         Plugin "virt"
7978         <IndexKey>
7979           Source "TypeInstance"
7980           Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
7981           Group 1
7982         </IndexKey>
7983         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
7984       </Data>
7985       <Data "CPU">
7986         Plugin "virt"
7987         <IndexKey>
7988           Source "TypeInstance"
7989           Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
7990           Group 1
7991         </IndexKey>
7992         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
7993       </Data>
7994       <Data "CPUAffinity">
7995         Plugin "virt"
7996         Type "cpu_affinity"
7997         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
7998       </Data>
7999     </Table>
8000   </Plugin>
8001
8002 There are two types of blocks that can be contained in the
8003 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
8004
8005 =head3 B<Data> block
8006
8007 The B<Data> block defines a list OIDs that are to be handled. This block can
8008 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
8009 block it reperesents table OIDs.
8010 The following options can be set:
8011
8012 =over 4
8013
8014 =item B<IndexKey> block
8015
8016 B<IndexKey> block contains all data needed for proper index build of snmp table.
8017 In case more than
8018 one table B<Data> block has B<IndexKey> block present then multiple key index is
8019 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
8020 be omitted.
8021
8022 =over 8
8023
8024 =item B<Source> I<String>
8025
8026 B<Source> can be set to one of the following values: "Hostname", "Plugin",
8027 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
8028 corresponding collectd metric is taken as a SNMP table index.
8029
8030 =item B<Regex> I<String>
8031
8032 B<Regex> option can also be used to parse strings or numbers out of
8033 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8034 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8035 as a table index.
8036
8037 =item B<Group> I<Number>
8038
8039 B<Group> number can be specified in case groups are used in regex.
8040
8041 =back
8042
8043 =item B<Plugin> I<String>
8044
8045 Read plugin name whose collected data will be mapped to specified OIDs.
8046
8047 =item B<PluginInstance> I<String>
8048
8049 Read plugin instance whose collected data will be mapped to specified OIDs.
8050 The field is optional and by default there is no plugin instance check.
8051 Allowed only if B<Data> block defines scalar data type.
8052
8053 =item B<Type> I<String>
8054
8055 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8056 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8057
8058 =item B<TypeInstance> I<String>
8059
8060 Collectd's type-instance that is to be used for specified OID.
8061
8062 =item B<OIDs> I<OID> [I<OID> ...]
8063
8064 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8065 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8066 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8067 configured should correspond to number of values in specified B<Type>.
8068 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8069 "rx" and "tx" values of "if_octets" type.
8070
8071 =item B<Scale> I<Value>
8072
8073 The values taken from collectd are multiplied by I<Value>. The field is optional
8074 and the default is B<1.0>.
8075
8076 =item B<Shift> I<Value>
8077
8078 I<Value> is added to values from collectd after they have been multiplied by
8079 B<Scale> value. The field is optional and the default value is B<0.0>.
8080
8081 =back
8082
8083 =head3 The B<Table> block
8084
8085 The B<Table> block defines a collection of B<Data> blocks that belong to one
8086 snmp table. In addition to multiple B<Data> blocks the following options can be
8087 set:
8088
8089 =over 4
8090
8091 =item B<IndexOID> I<OID>
8092
8093 OID that is handled by the plugin and is mapped to numerical index value that is
8094 generated by the plugin for each table record.
8095
8096 =item B<SizeOID> I<OID>
8097
8098 OID that is handled by the plugin. Returned value is the number of records in
8099 the table. The field is optional.
8100
8101 =back
8102
8103 =head2 Plugin C<statsd>
8104
8105 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8106 protocol and dispatches rates or other aggregates of these numbers
8107 periodically.
8108
8109 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8110 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8111 C<objects> respectively.
8112
8113 The following configuration options are valid:
8114
8115 =over 4
8116
8117 =item B<Host> I<Host>
8118
8119 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8120 "any" address, i.e. accept packets sent to any of the hosts addresses.
8121
8122 =item B<Port> I<Port>
8123
8124 UDP port to listen to. This can be either a service name or a port number.
8125 Defaults to C<8125>.
8126
8127 =item B<DeleteCounters> B<false>|B<true>
8128
8129 =item B<DeleteTimers> B<false>|B<true>
8130
8131 =item B<DeleteGauges> B<false>|B<true>
8132
8133 =item B<DeleteSets> B<false>|B<true>
8134
8135 These options control what happens if metrics are not updated in an interval.
8136 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8137 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8138 are unchanged. If set to B<True>, the such metrics are not dispatched and
8139 removed from the internal cache.
8140
8141 =item B<CounterSum> B<false>|B<true>
8142
8143 When enabled, creates a C<count> metric which reports the change since the last
8144 read. This option primarily exists for compatibility with the I<statsd>
8145 implementation by Etsy.
8146
8147 =item B<TimerPercentile> I<Percent>
8148
8149 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8150 that I<Percent> of all reported timers are smaller than or equal to the
8151 computed latency. This is useful for cutting off the long tail latency, as it's
8152 often done in I<Service Level Agreements> (SLAs).
8153
8154 Different percentiles can be calculated by setting this option several times.
8155 If none are specified, no percentiles are calculated / dispatched.
8156
8157 =item B<TimerLower> B<false>|B<true>
8158
8159 =item B<TimerUpper> B<false>|B<true>
8160
8161 =item B<TimerSum> B<false>|B<true>
8162
8163 =item B<TimerCount> B<false>|B<true>
8164
8165 Calculate and dispatch various values out of I<Timer> metrics received during
8166 an interval. If set to B<False>, the default, these values aren't calculated /
8167 dispatched.
8168
8169 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8170
8171 =back
8172
8173 =head2 Plugin C<swap>
8174
8175 The I<Swap plugin> collects information about used and available swap space. On
8176 I<Linux> and I<Solaris>, the following options are available:
8177
8178 =over 4
8179
8180 =item B<ReportByDevice> B<false>|B<true>
8181
8182 Configures how to report physical swap devices. If set to B<false> (the
8183 default), the summary over all swap devices is reported only, i.e. the globally
8184 used and available space over all devices. If B<true> is configured, the used
8185 and available space of each device will be reported separately.
8186
8187 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8188 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8189
8190 =item B<ReportBytes> B<false>|B<true>
8191
8192 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8193 I<swap I/O> is reported in pages. This option is available under Linux only.
8194
8195 =item B<ValuesAbsolute> B<true>|B<false>
8196
8197 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8198 available and used. Defaults to B<true>.
8199
8200 =item B<ValuesPercentage> B<false>|B<true>
8201
8202 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8203 available and free. Defaults to B<false>.
8204
8205 This is useful for deploying I<collectd> in a heterogeneous environment, where
8206 swap sizes differ and you want to specify generic thresholds or similar.
8207
8208 =item B<ReportIO> B<true>|B<false>
8209
8210 Enables or disables reporting swap IO. Defaults to B<true>.
8211
8212 This is useful for the cases when swap IO is not neccessary, is not available,
8213 or is not reliable.
8214
8215 =back
8216
8217 =head2 Plugin C<syslog>
8218
8219 =over 4
8220
8221 =item B<LogLevel> B<debug|info|notice|warning|err>
8222
8223 Sets the log-level. If, for example, set to B<notice>, then all events with
8224 severity B<notice>, B<warning>, or B<err> will be submitted to the
8225 syslog-daemon.
8226
8227 Please note that B<debug> is only available if collectd has been compiled with
8228 debugging support.
8229
8230 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8231
8232 Controls which notifications should be sent to syslog. The default behaviour is
8233 not to send any. Less severe notifications always imply logging more severe
8234 notifications: Setting this to B<OKAY> means all notifications will be sent to
8235 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8236 notifications but will dismiss B<OKAY> notifications. Setting this option to
8237 B<FAILURE> will only send failures to syslog.
8238
8239 =back
8240
8241 =head2 Plugin C<table>
8242
8243 The C<table plugin> provides generic means to parse tabular data and dispatch
8244 user specified values. Values are selected based on column numbers. For
8245 example, this plugin may be used to get values from the Linux L<proc(5)>
8246 filesystem or CSV (comma separated values) files.
8247
8248   <Plugin table>
8249     <Table "/proc/slabinfo">
8250       #Plugin "slab"
8251       Instance "slabinfo"
8252       Separator " "
8253       <Result>
8254         Type gauge
8255         InstancePrefix "active_objs"
8256         InstancesFrom 0
8257         ValuesFrom 1
8258       </Result>
8259       <Result>
8260         Type gauge
8261         InstancePrefix "objperslab"
8262         InstancesFrom 0
8263         ValuesFrom 4
8264       </Result>
8265     </Table>
8266   </Plugin>
8267
8268 The configuration consists of one or more B<Table> blocks, each of which
8269 configures one file to parse. Within each B<Table> block, there are one or
8270 more B<Result> blocks, which configure which data to select and how to
8271 interpret it.
8272
8273 The following options are available inside a B<Table> block:
8274
8275 =over 4
8276
8277 =item B<Plugin> I<Plugin>
8278
8279 If specified, I<Plugin> is used as the plugin name when submitting values.
8280 Defaults to B<table>.
8281
8282 =item B<Instance> I<instance>
8283
8284 If specified, I<instance> is used as the plugin instance. If omitted, the
8285 filename of the table is used instead, with all special characters replaced
8286 with an underscore (C<_>).
8287
8288 =item B<Separator> I<string>
8289
8290 Any character of I<string> is interpreted as a delimiter between the different
8291 columns of the table. A sequence of two or more contiguous delimiters in the
8292 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8293 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8294 of a table - see its documentation for more details. This option is mandatory.
8295
8296 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8297 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8298 required because of collectd's config parsing.
8299
8300 =back
8301
8302 The following options are available inside a B<Result> block:
8303
8304 =over 4
8305
8306 =item B<Type> I<type>
8307
8308 Sets the type used to dispatch the values to the daemon. Detailed information
8309 about types and their configuration can be found in L<types.db(5)>. This
8310 option is mandatory.
8311
8312 =item B<InstancePrefix> I<prefix>
8313
8314 If specified, prepend I<prefix> to the type instance. If omitted, only the
8315 B<InstancesFrom> option is considered for the type instance.
8316
8317 =item B<InstancesFrom> I<column0> [I<column1> ...]
8318
8319 If specified, the content of the given columns (identified by the column
8320 number starting at zero) will be used to create the type instance for each
8321 row. Multiple values (and the instance prefix) will be joined together with
8322 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8323 option is considered for the type instance.
8324
8325 The plugin itself does not check whether or not all built instances are
8326 different. It’s your responsibility to assure that each is unique. This is
8327 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8328 sure that the table only contains one row.
8329
8330 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8331 will be empty.
8332
8333 =item B<ValuesFrom> I<column0> [I<column1> ...]
8334
8335 Specifies the columns (identified by the column numbers starting at zero)
8336 whose content is used as the actual data for the data sets that are dispatched
8337 to the daemon. How many such columns you need is determined by the B<Type>
8338 setting above. If you specify too many or not enough columns, the plugin will
8339 complain about that and no data will be submitted to the daemon. The plugin
8340 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8341 respectively, so anything supported by those functions is supported by the
8342 plugin as well. This option is mandatory.
8343
8344 =back
8345
8346 =head2 Plugin C<tail>
8347
8348 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8349 each line and dispatches found values. What is matched can be configured by the
8350 user using (extended) regular expressions, as described in L<regex(7)>.
8351
8352   <Plugin "tail">
8353     <File "/var/log/exim4/mainlog">
8354       Plugin "mail"
8355       Instance "exim"
8356       Interval 60
8357       <Match>
8358         Regex "S=([1-9][0-9]*)"
8359         DSType "CounterAdd"
8360         Type "ipt_bytes"
8361         Instance "total"
8362       </Match>
8363       <Match>
8364         Regex "\\<R=local_user\\>"
8365         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8366         DSType "CounterInc"
8367         Type "counter"
8368         Instance "local_user"
8369       </Match>
8370       <Match>
8371         Regex "l=([0-9]*\\.[0-9]*)"
8372         <DSType "Distribution">
8373           Percentile 99
8374           Bucket 0 100
8375           #BucketType "bucket"
8376         </DSType>
8377         Type "latency"
8378         Instance "foo"
8379       </Match>
8380     </File>
8381   </Plugin>
8382
8383 The config consists of one or more B<File> blocks, each of which configures one
8384 logfile to parse. Within each B<File> block, there are one or more B<Match>
8385 blocks, which configure a regular expression to search for.
8386
8387 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8388 the plugin name and instance respectively. So in the above example the plugin name
8389 C<mail-exim> would be used.
8390
8391 These options are applied for all B<Match> blocks that B<follow> it, until the
8392 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8393 instances from one logfile, handy when parsing syslog and the like.
8394
8395 The B<Interval> option allows you to define the length of time between reads. If
8396 this is not set, the default Interval will be used.
8397
8398 Each B<Match> block has the following options to describe how the match should
8399 be performed:
8400
8401 =over 4
8402
8403 =item B<Regex> I<regex>
8404
8405 Sets the regular expression to use for matching against a line. The first
8406 subexpression has to match something that can be turned into a number by
8407 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8408 below. Because B<extended> regular expressions are used, you do not need to use
8409 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8410 collectd's config parsing you need to escape backslashes, though. So if you
8411 want to match literal parentheses you need to do the following:
8412
8413   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8414
8415 =item B<ExcludeRegex> I<regex>
8416
8417 Sets an optional regular expression to use for excluding lines from the match.
8418 An example which excludes all connections from localhost from the match:
8419
8420   ExcludeRegex "127\\.0\\.0\\.1"
8421
8422 =item B<DSType> I<Type>
8423
8424 Sets how the values are cumulated. I<Type> is one of:
8425
8426 =over 4
8427
8428 =item B<GaugeAverage>
8429
8430 Calculate the average.
8431
8432 =item B<GaugeMin>
8433
8434 Use the smallest number only.
8435
8436 =item B<GaugeMax>
8437
8438 Use the greatest number only.
8439
8440 =item B<GaugeLast>
8441
8442 Use the last number found.
8443
8444 =item B<GaugePersist>
8445
8446 Use the last number found. The number is not reset at the end of an interval.
8447 It is continously reported until another number is matched. This is intended
8448 for cases in which only state changes are reported, for example a thermometer
8449 that only reports the temperature when it changes.
8450
8451 =item B<CounterSet>
8452
8453 =item B<DeriveSet>
8454
8455 =item B<AbsoluteSet>
8456
8457 The matched number is a counter. Simply I<sets> the internal counter to this
8458 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8459
8460 =item B<GaugeAdd>
8461
8462 =item B<CounterAdd>
8463
8464 =item B<DeriveAdd>
8465
8466 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8467 matched number may be negative, which will effectively subtract from the
8468 internal counter.
8469
8470 =item B<GaugeInc>
8471
8472 =item B<CounterInc>
8473
8474 =item B<DeriveInc>
8475
8476 Increase the internal counter by one. These B<DSType> are the only ones that do
8477 not use the matched subexpression, but simply count the number of matched
8478 lines. Thus, you may use a regular expression without submatch in this case.
8479
8480 =item B<Distribution>
8481
8482 Type to do calculations based on the distribution of values, primarily
8483 calculating percentiles. This is primarily geared towards latency, but can be
8484 used for other metrics as well. The range of values tracked with this setting
8485 must be in the range (0–2^34) and can be fractional. Please note that neither
8486 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8487 distribution.
8488
8489 This option must be used together with the B<Percentile> and/or B<Bucket>
8490 options.
8491
8492 B<Synopsis:>
8493
8494   <DSType "Distribution">
8495     Percentile 99
8496     Bucket 0 100
8497     BucketType "bucket"
8498   </DSType>
8499
8500 =over 4
8501
8502 =item B<Percentile> I<Percent>
8503
8504 Calculate and dispatch the configured percentile, i.e. compute the value, so
8505 that I<Percent> of all matched values are smaller than or equal to the computed
8506 latency.
8507
8508 Metrics are reported with the I<type> B<Type> (the value of the above option)
8509 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8510
8511 This option may be repeated to calculate more than one percentile.
8512
8513 =item B<Bucket> I<lower_bound> I<upper_bound>
8514
8515 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8516 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8517 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8518 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8519 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8520 lower/upper bound.
8521
8522 To export the entire (0–inf) range without overlap, use the upper bound of the
8523 previous range as the lower bound of the following range. In other words, use
8524 the following schema:
8525
8526   Bucket   0   1
8527   Bucket   1   2
8528   Bucket   2   5
8529   Bucket   5  10
8530   Bucket  10  20
8531   Bucket  20  50
8532   Bucket  50   0
8533
8534 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8535 by default) and the I<type instance>
8536 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8537
8538 This option may be repeated to calculate more than one rate.
8539
8540 =item B<BucketType> I<Type>
8541
8542 Sets the type used to dispatch B<Bucket> metrics.
8543 Optional, by default C<bucket> will be used.
8544
8545 =back
8546
8547 =back
8548
8549 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8550 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8551 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8552 B<Derive*> types interpret the submatch as a signed integer using
8553 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8554 and it may be omitted in this case.
8555
8556 =item B<Type> I<Type>
8557
8558 Sets the type used to dispatch this value. Detailed information about types and
8559 their configuration can be found in L<types.db(5)>.
8560
8561 =item B<Instance> I<TypeInstance>
8562
8563 This optional setting sets the type instance to use.
8564
8565 =back
8566
8567 =head2 Plugin C<tail_csv>
8568
8569 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8570 written by I<Snort>.
8571
8572 B<Synopsis:>
8573
8574  <Plugin "tail_csv">
8575    <Metric "snort-dropped">
8576        Type "percent"
8577        Instance "dropped"
8578        ValueFrom 1
8579    </Metric>
8580    <File "/var/log/snort/snort.stats">
8581        Plugin "snortstats"
8582        Instance "eth0"
8583        Interval 600
8584        Collect "snort-dropped"
8585        #TimeFrom 0
8586    </File>
8587  </Plugin>
8588
8589 The configuration consists of one or more B<Metric> blocks that define an index
8590 into the line of the CSV file and how this value is mapped to I<collectd's>
8591 internal representation. These are followed by one or more B<Instance> blocks
8592 which configure which file to read, in which interval and which metrics to
8593 extract.
8594
8595 =over 4
8596
8597 =item E<lt>B<Metric> I<Name>E<gt>
8598
8599 The B<Metric> block configures a new metric to be extracted from the statistics
8600 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8601 only used inside the B<Instance> blocks to refer to this block, so you can use
8602 one B<Metric> block for multiple CSV files.
8603
8604 =over 4
8605
8606 =item B<Type> I<Type>
8607
8608 Configures which I<Type> to use when dispatching this metric. Types are defined
8609 in the L<types.db(5)> file, see the appropriate manual page for more
8610 information on specifying types. Only types with a single I<data source> are
8611 supported by the I<tail_csv plugin>. The information whether the value is an
8612 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8613 I<Type's> definition.
8614
8615 =item B<Instance> I<TypeInstance>
8616
8617 If set, I<TypeInstance> is used to populate the type instance field of the
8618 created value lists. Otherwise, no type instance is used.
8619
8620 =item B<ValueFrom> I<Index>
8621
8622 Configure to read the value from the field with the zero-based index I<Index>.
8623 If the value is parsed as signed integer, unsigned integer or double depends on
8624 the B<Type> setting, see above.
8625
8626 =back
8627
8628 =item E<lt>B<File> I<Path>E<gt>
8629
8630 Each B<File> block represents one CSV file to read. There must be at least one
8631 I<File> block but there can be multiple if you have multiple CSV files.
8632
8633 =over 4
8634
8635 =item B<Plugin> I<Plugin>
8636
8637 Use I<Plugin> as the plugin name when submitting values.
8638 Defaults to C<tail_csv>.
8639
8640 =item B<Instance> I<PluginInstance>
8641
8642 Sets the I<plugin instance> used when dispatching the values.
8643
8644 =item B<Collect> I<Metric>
8645
8646 Specifies which I<Metric> to collect. This option must be specified at least
8647 once, and you can use this option multiple times to specify more than one
8648 metric to be extracted from this statistic file.
8649
8650 =item B<Interval> I<Seconds>
8651
8652 Configures the interval in which to read values from this instance / file.
8653 Defaults to the plugin's default interval.
8654
8655 =item B<TimeFrom> I<Index>
8656
8657 Rather than using the local time when dispatching a value, read the timestamp
8658 from the field with the zero-based index I<Index>. The value is interpreted as
8659 seconds since epoch. The value is parsed as a double and may be factional.
8660
8661 =back
8662
8663 =back
8664
8665 =head2 Plugin C<teamspeak2>
8666
8667 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8668 polls interesting global and virtual server data. The plugin can query only one
8669 physical server but unlimited virtual servers. You can use the following
8670 options to configure it:
8671
8672 =over 4
8673
8674 =item B<Host> I<hostname/ip>
8675
8676 The hostname or ip which identifies the physical server.
8677 Default: 127.0.0.1
8678
8679 =item B<Port> I<port>
8680
8681 The query port of the physical server. This needs to be a string.
8682 Default: "51234"
8683
8684 =item B<Server> I<port>
8685
8686 This option has to be added once for every virtual server the plugin should
8687 query. If you want to query the virtual server on port 8767 this is what the
8688 option would look like:
8689
8690   Server "8767"
8691
8692 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8693 use quotes around it! If no such statement is given only global information
8694 will be collected.
8695
8696 =back
8697
8698 =head2 Plugin C<ted>
8699
8700 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8701 measure power consumption. These devices are usually connected to a serial
8702 (RS232) or USB port. The plugin opens a configured device and tries to read the
8703 current energy readings. For more information on TED, visit
8704 L<http://www.theenergydetective.com/>.
8705
8706 Available configuration options:
8707
8708 =over 4
8709
8710 =item B<Device> I<Path>
8711
8712 Path to the device on which TED is connected. collectd will need read and write
8713 permissions on that file.
8714
8715 Default: B</dev/ttyUSB0>
8716
8717 =item B<Retries> I<Num>
8718
8719 Apparently reading from TED is not that reliable. You can therefore configure a
8720 number of retries here. You only configure the I<retries> here, to if you
8721 specify zero, one reading will be performed (but no retries if that fails); if
8722 you specify three, a maximum of four readings are performed. Negative values
8723 are illegal.
8724
8725 Default: B<0>
8726
8727 =back
8728
8729 =head2 Plugin C<tcpconns>
8730
8731 The C<tcpconns plugin> counts the number of currently established TCP
8732 connections based on the local port and/or the remote port. Since there may be
8733 a lot of connections the default if to count all connections with a local port,
8734 for which a listening socket is opened. You can use the following options to
8735 fine-tune the ports you are interested in:
8736
8737 =over 4
8738
8739 =item B<ListeningPorts> I<true>|I<false>
8740
8741 If this option is set to I<true>, statistics for all local ports for which a
8742 listening socket exists are collected. The default depends on B<LocalPort> and
8743 B<RemotePort> (see below): If no port at all is specifically selected, the
8744 default is to collect listening ports. If specific ports (no matter if local or
8745 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8746 the selected ports will be collected unless this option is set to I<true>
8747 specifically.
8748
8749 =item B<LocalPort> I<Port>
8750
8751 Count the connections to a specific local port. This can be used to see how
8752 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8753 You have to specify the port in numeric form, so for the mailserver example
8754 you'd need to set B<25>.
8755
8756 =item B<RemotePort> I<Port>
8757
8758 Count the connections to a specific remote port. This is useful to see how
8759 much a remote service is used. This is most useful if you want to know how many
8760 connections a local service has opened to remote services, e.E<nbsp>g. how many
8761 connections a mail server or news server has to other mail or news servers, or
8762 how many connections a web proxy holds to web servers. You have to give the
8763 port in numeric form.
8764
8765 =item B<AllPortsSummary> I<true>|I<false>
8766
8767 If this option is set to I<true> a summary of statistics from all connections
8768 are collected. This option defaults to I<false>.
8769
8770 =back
8771
8772 =head2 Plugin C<thermal>
8773
8774 =over 4
8775
8776 =item B<ForceUseProcfs> I<true>|I<false>
8777
8778 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8779 C<sysfs> interface. If that is not available, the plugin falls back to the
8780 C<procfs> interface. By setting this option to I<true>, you can force the
8781 plugin to use the latter. This option defaults to I<false>.
8782
8783 =item B<Device> I<Device>
8784
8785 Selects the name of the thermal device that you want to collect or ignore,
8786 depending on the value of the B<IgnoreSelected> option. This option may be
8787 used multiple times to specify a list of devices.
8788
8789 See F</"IGNORELISTS"> for details.
8790
8791 =item B<IgnoreSelected> I<true>|I<false>
8792
8793 Invert the selection: If set to true, all devices B<except> the ones that
8794 match the device names specified by the B<Device> option are collected. By
8795 default only selected devices are collected if a selection is made. If no
8796 selection is configured at all, B<all> devices are selected.
8797
8798 =back
8799
8800 =head2 Plugin C<threshold>
8801
8802 The I<Threshold plugin> checks values collected or received by I<collectd>
8803 against a configurable I<threshold> and issues I<notifications> if values are
8804 out of bounds.
8805
8806 Documentation for this plugin is available in the L<collectd-threshold(5)>
8807 manual page.
8808
8809 =head2 Plugin C<tokyotyrant>
8810
8811 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8812 couple metrics: number of records, and database size on disk.
8813
8814 =over 4
8815
8816 =item B<Host> I<Hostname/IP>
8817
8818 The hostname or IP which identifies the server.
8819 Default: B<127.0.0.1>
8820
8821 =item B<Port> I<Service/Port>
8822
8823 The query port of the server. This needs to be a string, even if the port is
8824 given in its numeric form.
8825 Default: B<1978>
8826
8827 =back
8828
8829 =head2 Plugin C<turbostat>
8830
8831 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8832 Intel processors by using I<Model Specific Registers>.
8833
8834 =over 4
8835
8836 =item B<CoreCstates> I<Bitmask(Integer)>
8837
8838 Bit mask of the list of core C-states supported by the processor.
8839 This option should only be used if the automated detection fails.
8840 Default value extracted from the CPU model and family.
8841
8842 Currently supported C-states (by this plugin): 3, 6, 7
8843
8844 B<Example:>
8845
8846   All states (3, 6 and 7):
8847   (1<<3) + (1<<6) + (1<<7) = 392
8848
8849 =item B<PackageCstates> I<Bitmask(Integer)>
8850
8851 Bit mask of the list of packages C-states supported by the processor. This
8852 option should only be used if the automated detection fails. Default value
8853 extracted from the CPU model and family.
8854
8855 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8856
8857 B<Example:>
8858
8859   States 2, 3, 6 and 7:
8860   (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8861
8862 =item B<SystemManagementInterrupt> I<true>|I<false>
8863
8864 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8865 This option should only be used if the automated detection fails or if you want
8866 to disable this feature.
8867
8868 =item B<DigitalTemperatureSensor> I<true>|I<false>
8869
8870 Boolean enabling the collection of the temperature of each core. This option
8871 should only be used if the automated detection fails or if you want to disable
8872 this feature.
8873
8874 =item B<TCCActivationTemp> I<Temperature>
8875
8876 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8877 temperature is used when collecting the temperature of cores or packages. This
8878 option should only be used if the automated detection fails. Default value
8879 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8880
8881 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8882
8883 Bit mask of the list of elements to be thermally monitored. This option should
8884 only be used if the automated detection fails or if you want to disable some
8885 collections. The different bits of this bit mask accepted by this plugin are:
8886
8887 =over 4
8888
8889 =item 0 ('1'): Package
8890
8891 =item 1 ('2'): DRAM
8892
8893 =item 2 ('4'): Cores
8894
8895 =item 3 ('8'): Embedded graphic device
8896
8897 =back
8898
8899 =item B<LogicalCoreNames> I<true>|I<false>
8900
8901 Boolean enabling the use of logical core numbering for per core statistics.
8902 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8903 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8904 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8905 more than one, where I<n> is the n-th core of package I<m>.
8906
8907 =item B<RestoreAffinityPolicy> I<AllCPUs>|I<Restore>
8908
8909 Reading data from CPU has side-effect: collectd process's CPU affinity mask
8910 changes. After reading data is completed, affinity mask needs to be restored.
8911 This option allows to set restore policy.
8912
8913 B<AllCPUs> (the default): Restore the affinity by setting affinity to any/all
8914 CPUs.
8915
8916 B<Restore>: Save affinity using sched_getaffinity() before reading data and
8917 restore it after.
8918
8919 On some systems, sched_getaffinity() will fail due to inconsistency of the CPU
8920 set size between userspace and kernel. In these cases plugin will detect the
8921 unsuccessful call and fail with an error, preventing data collection.
8922 Most of configurations does not need to save affinity as Collectd process is
8923 allowed to run on any/all available CPUs.
8924
8925 If you need to save and restore affinity and get errors like 'Unable to save
8926 the CPU affinity', setting 'possible_cpus' kernel boot option may also help.
8927
8928 See following links for details:
8929
8930 L<https://github.com/collectd/collectd/issues/1593>
8931 L<https://sourceware.org/bugzilla/show_bug.cgi?id=15630>
8932 L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
8933
8934 =back
8935
8936 =head2 Plugin C<unixsock>
8937
8938 =over 4
8939
8940 =item B<SocketFile> I<Path>
8941
8942 Sets the socket-file which is to be created.
8943
8944 =item B<SocketGroup> I<Group>
8945
8946 If running as root change the group of the UNIX-socket after it has been
8947 created. Defaults to B<collectd>.
8948
8949 =item B<SocketPerms> I<Permissions>
8950
8951 Change the file permissions of the UNIX-socket after it has been created. The
8952 permissions must be given as a numeric, octal value as you would pass to
8953 L<chmod(1)>. Defaults to B<0770>.
8954
8955 =item B<DeleteSocket> B<false>|B<true>
8956
8957 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8958 with the given name already exists. If I<collectd> crashes a socket file may be
8959 left over, preventing the daemon from opening a new socket when restarted.
8960 Since this is potentially dangerous, this defaults to B<false>.
8961
8962 =back
8963
8964 =head2 Plugin C<uuid>
8965
8966 This plugin, if loaded, causes the Hostname to be taken from the machine's
8967 UUID. The UUID is a universally unique designation for the machine, usually
8968 taken from the machine's BIOS. This is most useful if the machine is running in
8969 a virtual environment such as Xen, in which case the UUID is preserved across
8970 shutdowns and migration.
8971
8972 The following methods are used to find the machine's UUID, in order:
8973
8974 =over 4
8975
8976 =item *
8977
8978 Check I</etc/uuid> (or I<UUIDFile>).
8979
8980 =item *
8981
8982 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8983 present.
8984
8985 =item *
8986
8987 Check for UUID from C<dmidecode> / SMBIOS.
8988
8989 =item *
8990
8991 Check for UUID from Xen hypervisor.
8992
8993 =back
8994
8995 If no UUID can be found then the hostname is not modified.
8996
8997 =over 4
8998
8999 =item B<UUIDFile> I<Path>
9000
9001 Take the UUID from the given file (default I</etc/uuid>).
9002
9003 =back
9004
9005 =head2 Plugin C<varnish>
9006
9007 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
9008 It collects a subset of the values displayed by L<varnishstat(1)>, and
9009 organizes them in categories which can be enabled or disabled. Currently only
9010 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
9011 meaning of each metric can be found in L<varnish-counters(7)>.
9012
9013 Synopsis:
9014
9015  <Plugin "varnish">
9016    <Instance "example">
9017      CollectBackend     true
9018      CollectBan         false
9019      CollectCache       true
9020      CollectConnections true
9021      CollectDirectorDNS false
9022      CollectESI         false
9023      CollectFetch       false
9024      CollectHCB         false
9025      CollectObjects     false
9026      CollectPurge       false
9027      CollectSession     false
9028      CollectSHM         true
9029      CollectSMA         false
9030      CollectSMS         false
9031      CollectSM          false
9032      CollectStruct      false
9033      CollectTotals      false
9034      CollectUptime      false
9035      CollectVCL         false
9036      CollectVSM         false
9037      CollectWorkers     false
9038      CollectLock        false
9039      CollectMempool     false
9040      CollectManagement  false
9041      CollectSMF         false
9042      CollectVBE         false
9043      CollectMSE         false
9044    </Instance>
9045  </Plugin>
9046
9047 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9048 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9049 will collectd statistics from the default "varnishd" instance (this should work
9050 fine in most cases).
9051
9052 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9053
9054 =over 4
9055
9056 =item B<CollectBackend> B<true>|B<false>
9057
9058 Back-end connection statistics, such as successful, reused,
9059 and closed connections. True by default.
9060
9061 =item B<CollectBan> B<true>|B<false>
9062
9063 Statistics about ban operations, such as number of bans added, retired, and
9064 number of objects tested against ban operations. Only available with Varnish
9065 3.x and above. False by default.
9066
9067 =item B<CollectCache> B<true>|B<false>
9068
9069 Cache hits and misses. True by default.
9070
9071 =item B<CollectConnections> B<true>|B<false>
9072
9073 Number of client connections received, accepted and dropped. True by default.
9074
9075 =item B<CollectDirectorDNS> B<true>|B<false>
9076
9077 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9078 default.
9079
9080 =item B<CollectESI> B<true>|B<false>
9081
9082 Edge Side Includes (ESI) parse statistics. False by default.
9083
9084 =item B<CollectFetch> B<true>|B<false>
9085
9086 Statistics about fetches (HTTP requests sent to the backend). False by default.
9087
9088 =item B<CollectHCB> B<true>|B<false>
9089
9090 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9091 divided into locked and unlocked look-ups. False by default.
9092
9093 =item B<CollectObjects> B<true>|B<false>
9094
9095 Statistics on cached objects: number of objects expired, nuked (prematurely
9096 expired), saved, moved, etc. False by default.
9097
9098 =item B<CollectPurge> B<true>|B<false>
9099
9100 Statistics about purge operations, such as number of purges added, retired, and
9101 number of objects tested against purge operations. Only available with Varnish
9102 2.x. False by default.
9103
9104 =item B<CollectSession> B<true>|B<false>
9105
9106 Client session statistics. Number of past and current sessions, session herd and
9107 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9108 metrics found in the Connections and Threads sections with previous versions of
9109 Varnish have been moved here.
9110
9111 =item B<CollectSHM> B<true>|B<false>
9112
9113 Statistics about the shared memory log, a memory region to store
9114 log messages which is flushed to disk when full. True by default.
9115
9116 =item B<CollectSMA> B<true>|B<false>
9117
9118 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9119 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9120 only the one used by the Varnish instance. Only available with Varnish 2.x.
9121 False by default.
9122
9123 =item B<CollectSMS> B<true>|B<false>
9124
9125 synth (synthetic content) storage statistics. This storage
9126 component is used internally only. False by default.
9127
9128 =item B<CollectSM> B<true>|B<false>
9129
9130 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9131 in varnish 4.x. use CollectSMF.
9132 False by default.
9133
9134 =item B<CollectStruct> B<true>|B<false>
9135
9136 Current varnish internal state statistics. Number of current sessions, objects
9137 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9138 default.
9139
9140 =item B<CollectTotals> B<true>|B<false>
9141
9142 Collects overview counters, such as the number of sessions created,
9143 the number of requests and bytes transferred. False by default.
9144
9145 =item B<CollectUptime> B<true>|B<false>
9146
9147 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9148
9149 =item B<CollectVCL> B<true>|B<false>
9150
9151 Number of total (available + discarded) VCL (config files). False by default.
9152
9153 =item B<CollectVSM> B<true>|B<false>
9154
9155 Collect statistics about Varnish's shared memory usage (used by the logging and
9156 statistics subsystems). Only available with Varnish 4.x. False by default.
9157
9158 =item B<CollectWorkers> B<true>|B<false>
9159
9160 Collect statistics about worker threads. False by default.
9161
9162 =item B<CollectVBE> B<true>|B<false>
9163
9164 Backend counters. Only available with Varnish 4.x. False by default.
9165
9166 =item B<CollectSMF> B<true>|B<false>
9167
9168 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9169 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9170 instance. Used to be called SM in Varnish 2.x. False by default.
9171
9172 =item B<CollectManagement> B<true>|B<false>
9173
9174 Management process counters. Only available with Varnish 4.x. False by default.
9175
9176 =item B<CollectLock> B<true>|B<false>
9177
9178 Lock counters. Only available with Varnish 4.x. False by default.
9179
9180 =item B<CollectMempool> B<true>|B<false>
9181
9182 Memory pool counters. Only available with Varnish 4.x. False by default.
9183
9184 =item B<CollectMSE> B<true>|B<false>
9185
9186 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9187 Varnish, replacing the traditional malloc and file storages. Only available
9188 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9189 one used by the Varnish instance. False by default.
9190
9191 =back
9192
9193 =head2 Plugin C<virt>
9194
9195 This plugin allows CPU, disk, network load and other metrics to be collected for
9196 virtualized guests on the machine. The statistics are collected through libvirt
9197 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9198 installing any additional software on guests, especially I<collectd>, which runs
9199 only on the host system.
9200
9201 Only I<Connection> is required.
9202
9203 Consider the following example config:
9204
9205  <Plugin "virt">
9206    Connection "qemu:///system"
9207    HostnameFormat "hostname"
9208    InterfaceFormat "address"
9209    PluginInstanceFormat "name"
9210  </Plugin>
9211
9212 It will generate the following values:
9213
9214   node42.example.com/virt-instance-0006f26c/disk_octets-vda
9215   node42.example.com/virt-instance-0006f26c/disk_ops-vda
9216   node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe
9217   node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe
9218   node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe
9219   node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe
9220   node42.example.com/virt-instance-0006f26c/memory-actual_balloon
9221   node42.example.com/virt-instance-0006f26c/memory-available
9222   node42.example.com/virt-instance-0006f26c/memory-last_update
9223   node42.example.com/virt-instance-0006f26c/memory-major_fault
9224   node42.example.com/virt-instance-0006f26c/memory-minor_fault
9225   node42.example.com/virt-instance-0006f26c/memory-rss
9226   node42.example.com/virt-instance-0006f26c/memory-swap_in
9227   node42.example.com/virt-instance-0006f26c/memory-swap_out
9228   node42.example.com/virt-instance-0006f26c/memory-total
9229   node42.example.com/virt-instance-0006f26c/memory-unused
9230   node42.example.com/virt-instance-0006f26c/memory-usable
9231   node42.example.com/virt-instance-0006f26c/virt_cpu_total
9232   node42.example.com/virt-instance-0006f26c/virt_vcpu-0
9233
9234 You can get information on the metric's units from the online libvirt documentation.
9235 For instance, I<virt_cpu_total> is in nanoseconds.
9236
9237 =over 4
9238
9239 =item B<Connection> I<uri>
9240
9241 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9242
9243  Connection "xen:///"
9244
9245 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9246
9247 =item B<RefreshInterval> I<seconds>
9248
9249 Refresh the list of domains and devices every I<seconds>. The default is 60
9250 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9251 the list of domains and devices to be refreshed on every iteration.
9252
9253 Refreshing the devices in particular is quite a costly operation, so if your
9254 virtualization setup is static you might consider increasing this. If this
9255 option is set to 0, refreshing is disabled completely.
9256
9257 =item B<Domain> I<name>
9258
9259 =item B<BlockDevice> I<name:dev>
9260
9261 =item B<InterfaceDevice> I<name:dev>
9262
9263 =item B<IgnoreSelected> B<true>|B<false>
9264
9265 Select which domains and devices are collected.
9266
9267 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9268 disk/network devices are collected.
9269
9270 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9271 domains and disk/network devices are ignored, while the rest are collected.
9272
9273 The domain name and device names may use a regular expression, if the name is
9274 surrounded by I</.../> and collectd was compiled with support for regexps.
9275
9276 The default is to collect statistics for all domains and all their devices.
9277
9278 Example:
9279
9280  BlockDevice "/:hdb/"
9281  IgnoreSelected "true"
9282
9283 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9284 will be collected.
9285
9286 =item B<BlockDeviceFormat> B<target>|B<source>
9287
9288 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9289 seen by the guest will be used for reporting metrics.
9290 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9291 domain.
9292
9293 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9294 using the path of the source, e.g. an image file.
9295 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9296 domain.
9297
9298 B<Example:>
9299
9300 If the domain XML have the following device defined:
9301
9302   <disk type='block' device='disk'>
9303     <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9304     <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9305     <target dev='sda' bus='scsi'/>
9306     <boot order='2'/>
9307     <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9308   </disk>
9309
9310 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9311 to C<sda>.
9312 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9313 to C<var_lib_libvirt_images_image1.qcow2>.
9314
9315 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9316
9317 The B<BlockDeviceFormatBasename> controls whether the full path or the
9318 L<basename(1)> of the source is being used as the I<type instance> when
9319 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9320
9321 B<Example:>
9322
9323 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9324 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9325 be set to C<var_lib_libvirt_images_image1.qcow2>.
9326 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9327 set to C<image1.qcow2>.
9328
9329 =item B<HostnameFormat> B<name|uuid|hostname|...>
9330
9331 When the virt plugin logs data, it sets the hostname of the collected data
9332 according to this setting. The default is to use the guest name as provided by
9333 the hypervisor, which is equal to setting B<name>.
9334
9335 B<uuid> means use the guest's UUID. This is useful if you want to track the
9336 same guest across migrations.
9337
9338 B<hostname> means to use the global B<Hostname> setting, which is probably not
9339 useful on its own because all guests will appear to have the same name. This is
9340 useful in conjunction with B<PluginInstanceFormat> though.
9341
9342 You can also specify combinations of these fields. For example B<name uuid>
9343 means to concatenate the guest name and UUID (with a literal colon character
9344 between, thus I<"foo:1234-1234-1234-1234">).
9345
9346 At the moment of writing (collectd-5.5), hostname string is limited to 62
9347 characters. In case when combination of fields exceeds 62 characters,
9348 hostname will be truncated without a warning.
9349
9350 =item B<InterfaceFormat> B<name>|B<address>
9351
9352 When the virt plugin logs interface data, it sets the name of the collected
9353 data according to this setting. The default is to use the path as provided by
9354 the hypervisor (the "dev" property of the target node), which is equal to
9355 setting B<name>.
9356
9357 B<address> means use the interface's mac address. This is useful since the
9358 interface path might change between reboots of a guest or across migrations.
9359
9360 =item B<PluginInstanceFormat> B<name|uuid|none>
9361
9362 When the virt plugin logs data, it sets the plugin_instance of the collected
9363 data according to this setting. The default is to not set the plugin_instance.
9364
9365 B<name> means use the guest's name as provided by the hypervisor.
9366 B<uuid> means use the guest's UUID.
9367
9368 You can also specify combinations of the B<name> and B<uuid> fields.
9369 For example B<name uuid> means to concatenate the guest name and UUID
9370 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9371
9372 =item B<Instances> B<integer>
9373
9374 How many read instances you want to use for this plugin. The default is one,
9375 and the sensible setting is a multiple of the B<ReadThreads> value.
9376 If you are not sure, just use the default setting.
9377
9378 =item B<ExtraStats> B<string>
9379
9380 Report additional extra statistics. The default is no extra statistics, preserving
9381 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9382 allows the plugin to reported more detailed statistics about the behaviour of
9383 Virtual Machines. The argument is a space-separated list of selectors.
9384
9385 Currently supported selectors are:
9386
9387 =over 4
9388
9389 =item B<cpu_util>: report CPU utilization per domain in percentage.
9390
9391 =item B<disk>: report extra statistics like number of flush operations and total
9392 service time for read, write and flush operations. Requires libvirt API version
9393 I<0.9.5> or later.
9394
9395 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9396 I<0.9.10> or later.
9397
9398 =item B<domain_state>: report domain state and reason in human-readable format as
9399 a notification. If libvirt API version I<0.9.2> or later is available, domain
9400 reason will be included in notification.
9401
9402 =item B<fs_info>: report file system information as a notification. Requires
9403 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9404 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9405 version supports retrieving  file system information.
9406
9407 =item B<job_stats_background>: report statistics about progress of a background
9408 job on a domain. Only one type of job statistics can be collected at the same time.
9409 Requires libvirt API version I<1.2.9> or later.
9410
9411 =item B<job_stats_completed>: report statistics about a recently completed job on
9412 a domain. Only one type of job statistics can be collected at the same time.
9413 Requires libvirt API version I<1.2.9> or later.
9414
9415 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9416 Requires libvirt API version I<0.9.11> or later.
9417
9418 =item B<perf>: report performance monitoring events. To collect performance
9419 metrics they must be enabled for domain and supported by the platform. Requires
9420 libvirt API version I<1.3.3> or later.
9421 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9422
9423 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9424
9425 =back
9426
9427 =item B<PersistentNotification> B<true>|B<false>
9428 Override default configuration to only send notifications when there is a change
9429 in the lifecycle state of a domain. When set to true notifications will be sent
9430 for every read cycle. Default is false. Does not affect the stats being
9431 dispatched.
9432
9433 =back
9434
9435 =head2 Plugin C<vmem>
9436
9437 The C<vmem> plugin collects information about the usage of virtual memory.
9438 Since the statistics provided by the Linux kernel are very detailed, they are
9439 collected very detailed. However, to get all the details, you have to switch
9440 them on manually. Most people just want an overview over, such as the number of
9441 pages read from swap space.
9442
9443 =over 4
9444
9445 =item B<Verbose> B<true>|B<false>
9446
9447 Enables verbose collection of information. This will start collecting page
9448 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9449 Part of these statistics are collected on a "per zone" basis.
9450
9451 =back
9452
9453 =head2 Plugin C<vserver>
9454
9455 This plugin doesn't have any options. B<VServer> support is only available for
9456 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9457 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9458 need to apply the patches and compile your own kernel, which will then provide
9459 the F</proc/virtual> filesystem that is required by this plugin.
9460
9461 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9462
9463 B<Note>: The traffic collected by this plugin accounts for the amount of
9464 traffic passing a socket which might be a lot less than the actual on-wire
9465 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9466 collect on-wire traffic you could, for example, use the logging facilities of
9467 iptables to feed data for the guest IPs into the iptables plugin.
9468
9469 =head2 Plugin C<write_graphite>
9470
9471 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9472 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9473 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9474 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9475 of at most 1428 bytes to minimize the number of network packets.
9476
9477 Synopsis:
9478
9479  <Plugin write_graphite>
9480    <Node "example">
9481      Host "localhost"
9482      Port "2003"
9483      Protocol "tcp"
9484      LogSendErrors true
9485      Prefix "collectd"
9486      UseTags false
9487    </Node>
9488  </Plugin>
9489
9490 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9491 blocks. Inside the B<Node> blocks, the following options are recognized:
9492
9493 =over 4
9494
9495 =item B<Host> I<Address>
9496
9497 Hostname or address to connect to. Defaults to C<localhost>.
9498
9499 =item B<Port> I<Service>
9500
9501 Service name or port number to connect to. Defaults to C<2003>.
9502
9503 =item B<Protocol> I<String>
9504
9505 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9506
9507 =item B<ReconnectInterval> I<Seconds>
9508
9509 When set to non-zero, forces the connection to the Graphite backend to be
9510 closed and re-opend periodically. This behavior is desirable in environments
9511 where the connection to the Graphite backend is done through load balancers,
9512 for example. When set to zero, the default, the connetion is kept open for as
9513 long as possible.
9514
9515 =item B<LogSendErrors> B<false>|B<true>
9516
9517 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9518 If set to B<false>, it will not log the errors. This is especially useful when
9519 using Protocol UDP since many times we want to use the "fire-and-forget"
9520 approach and logging errors fills syslog with unneeded messages.
9521
9522 =item B<Prefix> I<String>
9523
9524 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9525 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9526
9527 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9528 below).
9529
9530 =item B<Postfix> I<String>
9531
9532 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9533 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9534 (before the first ; that separates the name from the tags).
9535
9536 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9537 below).
9538
9539 =item B<EscapeCharacter> I<Char>
9540
9541 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9542 in the identifier. The B<EscapeCharacter> option determines which character
9543 dots, whitespace and control characters are replaced with. Defaults to
9544 underscore (C<_>).
9545
9546 =item B<StoreRates> B<false>|B<true>
9547
9548 If set to B<true> (the default), convert counter values to rates. If set to
9549 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9550 number.
9551
9552 =item B<SeparateInstances> B<false>|B<true>
9553
9554 If set to B<true>, the plugin instance and type instance will be in their own
9555 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9556 default), the plugin and plugin instance (and likewise the type and type
9557 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9558
9559 Option value is not used when B<UseTags> is I<true>.
9560
9561 =item B<AlwaysAppendDS> B<false>|B<true>
9562
9563 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9564 identifier. If set to B<false> (the default), this is only done when there is
9565 more than one DS.
9566
9567 =item B<PreserveSeparator> B<false>|B<true>
9568
9569 If set to B<false> (the default) the C<.> (dot) character is replaced with
9570 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9571 is preserved, i.e. passed through.
9572
9573 Option value is not used when B<UseTags> is I<true>.
9574
9575 =item B<DropDuplicateFields> B<false>|B<true>
9576
9577 If set to B<true>, detect and remove duplicate components in Graphite metric
9578 names. For example, the metric name  C<host.load.load.shortterm> will
9579 be shortened to C<host.load.shortterm>.
9580
9581 =item B<UseTags> B<false>|B<true>
9582
9583 If set to B<true>, Graphite metric names will be generated as tagged series.
9584 This allows for much more flexibility than the traditional hierarchical layout.
9585
9586 Example:
9587 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9588
9589 You can use B<Postfix> option to add more tags by specifying it like
9590 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9591 version 1.1.x.
9592
9593 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9594 are not used.
9595
9596 Default value: B<false>.
9597
9598 =back
9599
9600 =head2 Plugin C<write_log>
9601
9602 The C<write_log> plugin writes metrics as INFO log messages.
9603
9604 This plugin supports two output formats: I<Graphite> and I<JSON>.
9605
9606 Synopsis:
9607
9608  <Plugin write_log>
9609    Format Graphite
9610  </Plugin>
9611
9612 =over 4
9613
9614 =item B<Format> I<Format>
9615
9616 The output format to use. Can be one of C<Graphite> or C<JSON>.
9617
9618 =back
9619
9620 =head2 Plugin C<write_tsdb>
9621
9622 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9623 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9624 state daemon that ingests metrics and stores them in HBase. The plugin uses
9625 I<TCP> over the "line based" protocol with a default port 4242. The data will
9626 be sent in blocks of at most 1428 bytes to minimize the number of network
9627 packets.
9628
9629 Synopsis:
9630
9631  <Plugin write_tsdb>
9632    ResolveInterval 60
9633    ResolveJitter 60
9634    <Node "example">
9635      Host "tsd-1.my.domain"
9636      Port "4242"
9637      HostTags "status=production"
9638    </Node>
9639  </Plugin>
9640
9641 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9642 blocks and global directives.
9643
9644 Global directives are:
9645
9646 =over 4
9647
9648 =item B<ResolveInterval> I<seconds>
9649
9650 =item B<ResolveJitter> I<seconds>
9651
9652 When I<collectd> connects to a TSDB node, it will request the hostname from
9653 DNS. This can become a problem if the TSDB node is unavailable or badly
9654 configured because collectd will request DNS in order to reconnect for every
9655 metric, which can flood your DNS. So you can cache the last value for
9656 I<ResolveInterval> seconds.
9657 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9658
9659 You can also define a jitter, a random interval to wait in addition to
9660 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9661 hostname at the same time when the connection fails.
9662 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9663
9664 B<Note:> If the DNS resolution has already been successful when the socket
9665 closes, the plugin will try to reconnect immediately with the cached
9666 information. DNS is queried only when the socket is closed for a longer than
9667 I<ResolveInterval> + I<ResolveJitter> seconds.
9668
9669 =back
9670
9671 Inside the B<Node> blocks, the following options are recognized:
9672
9673 =over 4
9674
9675 =item B<Host> I<Address>
9676
9677 Hostname or address to connect to. Defaults to C<localhost>.
9678
9679 =item B<Port> I<Service>
9680
9681 Service name or port number to connect to. Defaults to C<4242>.
9682
9683
9684 =item B<HostTags> I<String>
9685
9686 When set, I<HostTags> is added to the end of the metric. It is intended to be
9687 used for name=value pairs that the TSD will tag the metric with. Dots and
9688 whitespace are I<not> escaped in this string.
9689
9690 =item B<StoreRates> B<false>|B<true>
9691
9692 If set to B<true>, convert counter values to rates. If set to B<false>
9693 (the default) counter values are stored as is, as an increasing
9694 integer number.
9695
9696 =item B<AlwaysAppendDS> B<false>|B<true>
9697
9698 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9699 identifier. If set to B<false> (the default), this is only done when there is
9700 more than one DS.
9701
9702 =back
9703
9704 =head2 Plugin C<write_mongodb>
9705
9706 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9707 NoSQL database.
9708
9709 B<Synopsis:>
9710
9711  <Plugin "write_mongodb">
9712    <Node "default">
9713      Host "localhost"
9714      Port "27017"
9715      Timeout 1000
9716      StoreRates true
9717    </Node>
9718  </Plugin>
9719
9720 The plugin can send values to multiple instances of I<MongoDB> by specifying
9721 one B<Node> block for each instance. Within the B<Node> blocks, the following
9722 options are available:
9723
9724 =over 4
9725
9726 =item B<Host> I<Address>
9727
9728 Hostname or address to connect to. Defaults to C<localhost>.
9729
9730 =item B<Port> I<Service>
9731
9732 Service name or port number to connect to. Defaults to C<27017>.
9733
9734 =item B<Timeout> I<Milliseconds>
9735
9736 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9737 Setting this option to zero means no timeout, which is the default.
9738
9739 =item B<StoreRates> B<false>|B<true>
9740
9741 If set to B<true> (the default), convert counter values to rates. If set to
9742 B<false> counter values are stored as is, i.e. as an increasing integer
9743 number.
9744
9745 =item B<Database> I<Database>
9746
9747 =item B<User> I<User>
9748
9749 =item B<Password> I<Password>
9750
9751 Sets the information used when authenticating to a I<MongoDB> database. The
9752 fields are optional (in which case no authentication is attempted), but if you
9753 want to use authentication all three fields must be set.
9754
9755 =back
9756
9757 =head2 Plugin C<write_prometheus>
9758
9759 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9760 using I<Prometheus>.
9761
9762 B<Options:>
9763
9764 =over 4
9765
9766 =item B<Host> I<Host>
9767
9768 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
9769 "any" address, i.e. accept packets sent to any of the hosts addresses.
9770
9771 This option is supported only for libmicrohttpd newer than 0.9.0.
9772
9773 =item B<Port> I<Port>
9774
9775 Port the embedded webserver should listen on. Defaults to B<9103>.
9776
9777 =item B<StalenessDelta> I<Seconds>
9778
9779 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9780 hasn't seen any update for it. This value must match the setting in Prometheus.
9781 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9782
9783 B<Background:>
9784
9785 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9786 which time a metric without updates is considered "stale". This setting
9787 effectively puts an upper limit on the interval in which metrics are reported.
9788
9789 When the I<write_prometheus plugin> encounters a metric with an interval
9790 exceeding this limit, it will inform you, the user, and provide the metric to
9791 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9792 metric "fresh" each time it is scraped, with the time of the scrape being
9793 considered the time of the update. The result is that there appear more
9794 datapoints in I<Prometheus> than were actually created, but at least the metric
9795 doesn't disappear periodically.
9796
9797 =back
9798
9799 =head2 Plugin C<write_http>
9800
9801 This output plugin submits values to an HTTP server using POST requests and
9802 encoding metrics with JSON or using the C<PUTVAL> command described in
9803 L<collectd-unixsock(5)>.
9804
9805 Synopsis:
9806
9807  <Plugin "write_http">
9808    <Node "example">
9809      URL "http://example.com/post-collectd"
9810      User "collectd"
9811      Password "weCh3ik0"
9812      Format JSON
9813    </Node>
9814  </Plugin>
9815
9816 The plugin can send values to multiple HTTP servers by specifying one
9817 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9818 block, the following options are available:
9819
9820 =over 4
9821
9822 =item B<URL> I<URL>
9823
9824 URL to which the values are submitted to. Mandatory.
9825
9826 =item B<User> I<Username>
9827
9828 Optional user name needed for authentication.
9829
9830 =item B<Password> I<Password>
9831
9832 Optional password needed for authentication.
9833
9834 =item B<VerifyPeer> B<true>|B<false>
9835
9836 Enable or disable peer SSL certificate verification. See
9837 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9838
9839 =item B<VerifyHost> B<true|false>
9840
9841 Enable or disable peer host name verification. If enabled, the plugin checks if
9842 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9843 matches the host name provided by the B<URL> option. If this identity check
9844 fails, the connection is aborted. Obviously, only works when connecting to a
9845 SSL enabled server. Enabled by default.
9846
9847 =item B<CACert> I<File>
9848
9849 File that holds one or more SSL certificates. If you want to use HTTPS you will
9850 possibly need this option. What CA certificates come bundled with C<libcurl>
9851 and are checked by default depends on the distribution you use.
9852
9853 =item B<CAPath> I<Directory>
9854
9855 Directory holding one or more CA certificate files. You can use this if for
9856 some reason all the needed CA certificates aren't in the same file and can't be
9857 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9858 OpenSSL.
9859
9860 =item B<ClientKey> I<File>
9861
9862 File that holds the private key in PEM format to be used for certificate-based
9863 authentication.
9864
9865 =item B<ClientCert> I<File>
9866
9867 File that holds the SSL certificate to be used for certificate-based
9868 authentication.
9869
9870 =item B<ClientKeyPass> I<Password>
9871
9872 Password required to load the private key in B<ClientKey>.
9873
9874 =item B<Header> I<Header>
9875
9876 A HTTP header to add to the request.  Multiple headers are added if this option is specified more than once.  Example:
9877
9878   Header "X-Custom-Header: custom_value"
9879
9880 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9881
9882 Define which SSL protocol version must be used. By default C<libcurl> will
9883 attempt to figure out the remote SSL protocol version. See
9884 L<curl_easy_setopt(3)> for more details.
9885
9886 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9887
9888 Format of the output to generate. If set to B<Command>, will create output that
9889 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9890 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9891 , will create output in the KairosDB format.
9892
9893 Defaults to B<Command>.
9894
9895 =item B<Attribute> I<String> I<String>
9896
9897 Only available for the KAIROSDB output format.
9898
9899 Consider the two given strings to be the key and value of an additional tag for
9900 each metric being sent out.
9901
9902 You can add multiple B<Attribute>.
9903
9904 =item B<TTL> I<Int>
9905
9906 Only available for the KAIROSDB output format.
9907
9908 Sets the Cassandra ttl for the data points.
9909
9910 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9911
9912 =item B<Prefix> I<String>
9913
9914 Only available for the KAIROSDB output format.
9915
9916 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9917
9918 =item B<Metrics> B<true>|B<false>
9919
9920 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9921
9922 =item B<Notifications> B<false>|B<true>
9923
9924 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9925
9926 =item B<StoreRates> B<true|false>
9927
9928 If set to B<true>, convert counter values to rates. If set to B<false> (the
9929 default) counter values are stored as is, i.e. as an increasing integer number.
9930
9931 =item B<BufferSize> I<Bytes>
9932
9933 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9934 requests will be generated, but more metrics will be batched / metrics are
9935 cached for longer before being sent, introducing additional delay until they
9936 are available on the server side. I<Bytes> must be at least 1024 and cannot
9937 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9938 Defaults to C<4096>.
9939
9940 =item B<LowSpeedLimit> I<Bytes per Second>
9941
9942 Sets the minimal transfer rate in I<Bytes per Second> below which the
9943 connection with the HTTP server will be considered too slow and aborted. All
9944 the data submitted over this connection will probably be lost. Defaults to 0,
9945 which means no minimum transfer rate is enforced.
9946
9947 =item B<Timeout> I<Timeout>
9948
9949 Sets the maximum time in milliseconds given for HTTP POST operations to
9950 complete. When this limit is reached, the POST operation will be aborted, and
9951 all the data in the current send buffer will probably be lost. Defaults to 0,
9952 which means the connection never times out.
9953
9954 =item B<LogHttpError> B<false>|B<true>
9955
9956 Enables printing of HTTP error code to log. Turned off by default.
9957
9958 The C<write_http> plugin regularly submits the collected values to the HTTP
9959 server. How frequently this happens depends on how much data you are collecting
9960 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9961 slightly below this interval, which you can estimate by monitoring the network
9962 traffic between collectd and the HTTP server.
9963
9964 =back
9965
9966 =head2 Plugin C<write_kafka>
9967
9968 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9969 queue.
9970 Synopsis:
9971
9972  <Plugin "write_kafka">
9973    Property "metadata.broker.list" "broker1:9092,broker2:9092"
9974    <Topic "collectd">
9975      Format JSON
9976    </Topic>
9977  </Plugin>
9978
9979 The following options are understood by the I<write_kafka plugin>:
9980
9981 =over 4
9982
9983 =item E<lt>B<Topic> I<Name>E<gt>
9984
9985 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9986 is given a unique I<Name> and specifies one kafka producer.
9987 Inside the B<Topic> block, the following per-topic options are
9988 understood:
9989
9990 =over 4
9991
9992 =item B<Property> I<String> I<String>
9993
9994 Configure the named property for the current topic. Properties are
9995 forwarded to the kafka producer library B<librdkafka>.
9996
9997 =item B<Key> I<String>
9998
9999 Use the specified string as a partitioning key for the topic. Kafka breaks
10000 topic into partitions and guarantees that for a given topology, the same
10001 consumer will be used for a specific key. The special (case insensitive)
10002 string B<Random> can be used to specify that an arbitrary partition should
10003 be used.
10004
10005 =item B<Format> B<Command>|B<JSON>|B<Graphite>
10006
10007 Selects the format in which messages are sent to the broker. If set to
10008 B<Command> (the default), values are sent as C<PUTVAL> commands which are
10009 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
10010
10011 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
10012 an easy and straight forward exchange format.
10013
10014 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
10015 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
10016
10017 =item B<StoreRates> B<true>|B<false>
10018
10019 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
10020 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
10021 default), no conversion is performed. Otherwise the conversion is performed
10022 using the internal value cache.
10023
10024 Please note that currently this option is only used if the B<Format> option has
10025 been set to B<JSON>.
10026
10027 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10028
10029 A prefix can be added in the metric name when outputting in the I<Graphite>
10030 format.
10031
10032 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10033 Metric name will be
10034 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>>
10035
10036 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10037
10038 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10039
10040 A postfix can be added in the metric name when outputting in the I<Graphite>
10041 format.
10042
10043 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10044 Metric name will be
10045 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>>
10046
10047 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10048 name (before the first ; that separates the name from the tags).
10049
10050 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10051
10052 Specify a character to replace dots (.) in the host part of the metric name.
10053 In I<Graphite> metric name, dots are used as separators between different
10054 metric parts (host, plugin, type).
10055 Default is C<_> (I<Underscore>).
10056
10057 =item B<GraphiteSeparateInstances> B<false>|B<true>
10058
10059 If set to B<true>, the plugin instance and type instance will be in their own
10060 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10061 default), the plugin and plugin instance (and likewise the type and type
10062 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10063
10064 Option value is not used when B<GraphiteUseTags> is I<true>.
10065
10066 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10067
10068 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10069 identifier. If set to B<false> (the default), this is only done when there is
10070 more than one DS.
10071
10072 =item B<GraphitePreserveSeparator> B<false>|B<true>
10073
10074 If set to B<false> (the default) the C<.> (dot) character is replaced with
10075 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10076 is preserved, i.e. passed through.
10077
10078 Option value is not used when B<GraphiteUseTags> is I<true>.
10079
10080 =item B<GraphiteUseTags> B<false>|B<true>
10081
10082 If set to B<true> Graphite metric names will be generated as tagged series.
10083
10084 Default value: B<false>.
10085
10086 =item B<StoreRates> B<true>|B<false>
10087
10088 If set to B<true> (the default), convert counter values to rates. If set to
10089 B<false> counter values are stored as is, i.e. as an increasing integer number.
10090
10091 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10092 converted values will have "rate" appended to the data source type, e.g.
10093 C<ds_type:derive:rate>.
10094
10095 =back
10096
10097 =item B<Property> I<String> I<String>
10098
10099 Configure the kafka producer through properties, you almost always will
10100 want to set B<metadata.broker.list> to your Kafka broker list.
10101
10102 =back
10103
10104 =head2 Plugin C<write_redis>
10105
10106 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10107
10108 Synopsis:
10109
10110   <Plugin "write_redis">
10111     <Node "example">
10112         Host "localhost"
10113         Port "6379"
10114         Timeout 1000
10115         Prefix "collectd/"
10116         Database 1
10117         MaxSetSize -1
10118         MaxSetDuration -1
10119         StoreRates true
10120     </Node>
10121   </Plugin>
10122
10123 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10124 the timestamp as the score. Retrieving a date range can then be done using the
10125 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10126 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10127 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10128 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10129 with the B<Database> parameter (default is C<0>). See
10130 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10131 details.
10132
10133 The information shown in the synopsis above is the I<default configuration>
10134 which is used by the plugin if no configuration is present.
10135
10136 The plugin can send values to multiple instances of I<Redis> by specifying
10137 one B<Node> block for each instance. Within the B<Node> blocks, the following
10138 options are available:
10139
10140 =over 4
10141
10142 =item B<Node> I<Nodename>
10143
10144 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10145 instance running on a specified host and port. The node name is a
10146 canonical identifier which is used as I<plugin instance>. It is limited to
10147 51E<nbsp>characters in length.
10148
10149 =item B<Host> I<Hostname>
10150
10151 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10152 running on.
10153
10154 =item B<Port> I<Port>
10155
10156 The B<Port> option is the TCP port on which the Redis instance accepts
10157 connections. Either a service name of a port number may be given. Please note
10158 that numerical port numbers must be given as a string, too.
10159
10160 =item B<Timeout> I<Milliseconds>
10161
10162 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10163
10164 =item B<Prefix> I<Prefix>
10165
10166 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10167 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10168 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10169 is recommended but not required to include a trailing slash in I<Prefix>.
10170
10171 =item B<Database> I<Index>
10172
10173 This index selects the redis database to use for writing operations. Defaults
10174 to C<0>.
10175
10176 =item B<MaxSetSize> I<Items>
10177
10178 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10179 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10180
10181 =item B<MaxSetDuration> I<Seconds>
10182
10183 The B<MaxSetDuration> option limits the duration of items that the
10184 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10185 is the default behavior.
10186
10187 =item B<StoreRates> B<true>|B<false>
10188
10189 If set to B<true> (the default), convert counter values to rates. If set to
10190 B<false> counter values are stored as is, i.e. as an increasing integer number.
10191
10192 =back
10193
10194 =head2 Plugin C<write_riemann>
10195
10196 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10197 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10198 I<Riemann> using UDP packets.
10199
10200 Synopsis:
10201
10202  <Plugin "write_riemann">
10203    <Node "example">
10204      Host "localhost"
10205      Port "5555"
10206      Protocol UDP
10207      StoreRates true
10208      AlwaysAppendDS false
10209      TTLFactor 2.0
10210    </Node>
10211    Tag "foobar"
10212    Attribute "foo" "bar"
10213  </Plugin>
10214
10215 The following options are understood by the I<write_riemann plugin>:
10216
10217 =over 4
10218
10219 =item E<lt>B<Node> I<Name>E<gt>
10220
10221 The plugin's configuration consists of one or more B<Node> blocks. Each block
10222 is given a unique I<Name> and specifies one connection to an instance of
10223 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10224 understood:
10225
10226 =over 4
10227
10228 =item B<Host> I<Address>
10229
10230 Hostname or address to connect to. Defaults to C<localhost>.
10231
10232 =item B<Port> I<Service>
10233
10234 Service name or port number to connect to. Defaults to C<5555>.
10235
10236 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10237
10238 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10239 B<TCP>.
10240
10241 =item B<TLSCertFile> I<Path>
10242
10243 When using the B<TLS> protocol, path to a PEM certificate to present
10244 to remote host.
10245
10246 =item B<TLSCAFile> I<Path>
10247
10248 When using the B<TLS> protocol, path to a PEM CA certificate to
10249 use to validate the remote hosts's identity.
10250
10251 =item B<TLSKeyFile> I<Path>
10252
10253 When using the B<TLS> protocol, path to a PEM private key associated
10254 with the certificate defined by B<TLSCertFile>.
10255
10256 =item B<Batch> B<true>|B<false>
10257
10258 If set to B<true> and B<Protocol> is set to B<TCP>,
10259 events will be batched in memory and flushed at
10260 regular intervals or when B<BatchMaxSize> is exceeded.
10261
10262 Notifications are not batched and sent as soon as possible.
10263
10264 When enabled, it can occur that events get processed by the Riemann server
10265 close to or after their expiration time. Tune the B<TTLFactor> and
10266 B<BatchMaxSize> settings according to the amount of values collected, if this
10267 is an issue.
10268
10269 Defaults to true
10270
10271 =item B<BatchMaxSize> I<size>
10272
10273 Maximum payload size for a riemann packet. Defaults to 8192
10274
10275 =item B<BatchFlushTimeout> I<seconds>
10276
10277 Maximum amount of seconds to wait in between to batch flushes.
10278 No timeout by default.
10279
10280 =item B<StoreRates> B<true>|B<false>
10281
10282 If set to B<true> (the default), convert counter values to rates. If set to
10283 B<false> counter values are stored as is, i.e. as an increasing integer number.
10284
10285 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10286 converted values will have "rate" appended to the data source type, e.g.
10287 C<ds_type:derive:rate>.
10288
10289 =item B<AlwaysAppendDS> B<false>|B<true>
10290
10291 If set to B<true>, append the name of the I<Data Source> (DS) to the
10292 "service", i.e. the field that, together with the "host" field, uniquely
10293 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10294 only done when there is more than one DS.
10295
10296 =item B<TTLFactor> I<Factor>
10297
10298 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10299 event is considered active. I<collectd> populates this field based on the
10300 metrics interval setting. This setting controls the factor with which the
10301 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10302 know exactly what you're doing, you should only increase this setting from its
10303 default value.
10304
10305 =item B<Notifications> B<false>|B<true>
10306
10307 If set to B<true>, create riemann events for notifications. This is B<true>
10308 by default. When processing thresholds from write_riemann, it might prove
10309 useful to avoid getting notification events.
10310
10311 =item B<CheckThresholds> B<false>|B<true>
10312
10313 If set to B<true>, attach state to events based on thresholds defined
10314 in the B<Threshold> plugin. Defaults to B<false>.
10315
10316 =item B<EventServicePrefix> I<String>
10317
10318 Add the given string as a prefix to the event service name.
10319 If B<EventServicePrefix> not set or set to an empty string (""),
10320 no prefix will be used.
10321
10322 =back
10323
10324 =item B<Tag> I<String>
10325
10326 Add the given string as an additional tag to the metric being sent to
10327 I<Riemann>.
10328
10329 =item B<Attribute> I<String> I<String>
10330
10331 Consider the two given strings to be the key and value of an additional
10332 attribute for each metric being sent out to I<Riemann>.
10333
10334 =back
10335
10336 =head2 Plugin C<write_sensu>
10337
10338 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10339 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10340 a local I<Sensu> client using a TCP socket.
10341
10342 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10343 parameter so it is not possible to use one collectd instance as a gateway for
10344 others. Each collectd host must pair with one I<Sensu> client.
10345
10346 Synopsis:
10347
10348  <Plugin "write_sensu">
10349    <Node "example">
10350      Host "localhost"
10351      Port "3030"
10352      StoreRates true
10353      AlwaysAppendDS false
10354      MetricHandler "influx"
10355      MetricHandler "default"
10356      NotificationHandler "flapjack"
10357      NotificationHandler "howling_monkey"
10358      Notifications true
10359    </Node>
10360    Tag "foobar"
10361    Attribute "foo" "bar"
10362  </Plugin>
10363
10364 The following options are understood by the I<write_sensu plugin>:
10365
10366 =over 4
10367
10368 =item E<lt>B<Node> I<Name>E<gt>
10369
10370 The plugin's configuration consists of one or more B<Node> blocks. Each block
10371 is given a unique I<Name> and specifies one connection to an instance of
10372 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10373 understood:
10374
10375 =over 4
10376
10377 =item B<Host> I<Address>
10378
10379 Hostname or address to connect to. Defaults to C<localhost>.
10380
10381 =item B<Port> I<Service>
10382
10383 Service name or port number to connect to. Defaults to C<3030>.
10384
10385 =item B<StoreRates> B<true>|B<false>
10386
10387 If set to B<true> (the default), convert counter values to rates. If set to
10388 B<false> counter values are stored as is, i.e. as an increasing integer number.
10389
10390 This will be reflected in the C<collectd_data_source_type> tag: If
10391 B<StoreRates> is enabled, converted values will have "rate" appended to the
10392 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
10393
10394 =item B<AlwaysAppendDS> B<false>|B<true>
10395
10396 If set the B<true>, append the name of the I<Data Source> (DS) to the
10397 "service", i.e. the field that, together with the "host" field, uniquely
10398 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10399 only done when there is more than one DS.
10400
10401 =item B<Notifications> B<false>|B<true>
10402
10403 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10404 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10405
10406 =item B<Metrics> B<false>|B<true>
10407
10408 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10409 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10410
10411
10412 =item B<Separator> I<String>
10413
10414 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10415
10416 =item B<MetricHandler> I<String>
10417
10418 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10419 several of them, one per line. Defaults to no handler.
10420
10421 =item B<NotificationHandler> I<String>
10422
10423 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10424 add several of them, one per line. Defaults to no handler.
10425
10426 =item B<EventServicePrefix> I<String>
10427
10428 Add the given string as a prefix to the event service name.
10429 If B<EventServicePrefix> not set or set to an empty string (""),
10430 no prefix will be used.
10431
10432 =back
10433
10434 =item B<Tag> I<String>
10435
10436 Add the given string as an additional tag to the metric being sent to
10437 I<Sensu>.
10438
10439 =item B<Attribute> I<String> I<String>
10440
10441 Consider the two given strings to be the key and value of an additional
10442 attribute for each metric being sent out to I<Sensu>.
10443
10444 =back
10445
10446 =head2 Plugin C<write_stackdriver>
10447
10448 The C<write_stackdriver> plugin writes metrics to the
10449 I<Google Stackdriver Monitoring> service.
10450
10451 This plugin supports two authentication methods: When configured, credentials
10452 are read from the JSON credentials file specified with B<CredentialFile>.
10453 Alternatively, when running on
10454 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10455 I<metadata server> and used to authenticate to GCM.
10456
10457 B<Synopsis:>
10458
10459  <Plugin write_stackdriver>
10460    CredentialFile "/path/to/service_account.json"
10461    <Resource "global">
10462      Label "project_id" "monitored_project"
10463    </Resource>
10464  </Plugin>
10465
10466 =over 4
10467
10468 =item B<CredentialFile> I<file>
10469
10470 Path to a JSON credentials file holding the credentials for a GCP service
10471 account.
10472
10473 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10474 Credentials>. That means which credentials are used depends on the environment:
10475
10476 =over 4
10477
10478 =item
10479
10480 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10481 variable is specified it should point to a JSON file that defines the
10482 credentials.
10483
10484 =item
10485
10486 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10487 checked. This where credentials used by the I<gcloud> command line utility are
10488 stored. You can use C<gcloud auth application-default login> to create these
10489 credentials.
10490
10491 Please note that these credentials are often of your personal account, not a
10492 service account, and are therefore unfit to be used in a production
10493 environment.
10494
10495 =item
10496
10497 When running on GCE, the built-in service account associated with the virtual
10498 machine instance is used.
10499 See also the B<Email> option below.
10500
10501 =back
10502
10503 =item B<Project> I<Project>
10504
10505 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10506 I<Project ID> is a string identifying the GCP project, which you can chose
10507 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10508 number. You can look up both on the I<Developer Console>.
10509
10510 This setting is optional. If not set, the project ID is read from the
10511 credentials file or determined from the GCE's metadata service.
10512
10513 =item B<Email> I<Email> (GCE only)
10514
10515 Choses the GCE I<Service Account> used for authentication.
10516
10517 Each GCE instance has a C<default> I<Service Account> but may also be
10518 associated with additional I<Service Accounts>. This is often used to restrict
10519 the permissions of services running on the GCE instance to the required
10520 minimum. The I<write_stackdriver plugin> requires the
10521 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10522 Accounts> are available, this option selects which one is used by
10523 I<write_stackdriver plugin>.
10524
10525 =item B<Resource> I<ResourceType>
10526
10527 Configures the I<Monitored Resource> to use when storing metrics.
10528 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10529 available at L<https://cloud.google.com/monitoring/api/resources>.
10530
10531 This block takes one string argument, the I<ResourceType>. Inside the block are
10532 one or more B<Label> options which configure the resource labels.
10533
10534 This block is optional. The default value depends on the runtime environment:
10535 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10536 resource type ist used:
10537
10538 =over 4
10539
10540 =item
10541
10542 B<On GCE>, defaults to the equivalent of this config:
10543
10544   <Resource "gce_instance">
10545     Label "project_id" "<project_id>"
10546     Label "instance_id" "<instance_id>"
10547     Label "zone" "<zone>"
10548   </Resource>
10549
10550 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10551 metadata service.
10552
10553 =item
10554
10555 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10556
10557   <Resource "global">
10558     Label "project_id" "<Project>"
10559   </Resource>
10560
10561 Where I<Project> refers to the value of the B<Project> option or the project ID
10562 inferred from the B<CredentialFile>.
10563
10564 =back
10565
10566 =item B<Url> I<Url>
10567
10568 URL of the I<Stackdriver Monitoring> API. Defaults to
10569 C<https://monitoring.googleapis.com/v3>.
10570
10571 =back
10572
10573 =head2 Plugin C<xencpu>
10574
10575 This plugin collects metrics of hardware CPU load for machine running Xen
10576 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10577 Result is reported using the C<percent> type, for each CPU (core).
10578
10579 This plugin doesn't have any options (yet).
10580
10581 =head2 Plugin C<zookeeper>
10582
10583 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10584 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
10585 client port.
10586
10587 B<Synopsis:>
10588
10589  <Plugin "zookeeper">
10590    Host "127.0.0.1"
10591    Port "2181"
10592  </Plugin>
10593
10594 =over 4
10595
10596 =item B<Host> I<Address>
10597
10598 Hostname or address to connect to. Defaults to C<localhost>.
10599
10600 =item B<Port> I<Service>
10601
10602 Service name or port number to connect to. Defaults to C<2181>.
10603
10604 =back
10605
10606 =head1 THRESHOLD CONFIGURATION
10607
10608 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10609 we mean that the values are not only stored or sent somewhere, but that they
10610 are judged and, if a problem is recognized, acted upon. The only action
10611 collectd takes itself is to generate and dispatch a "notification". Plugins can
10612 register to receive notifications and perform appropriate further actions.
10613
10614 Since systems and what you expect them to do differ a lot, you can configure
10615 B<thresholds> for your values freely. This gives you a lot of flexibility but
10616 also a lot of responsibility.
10617
10618 Every time a value is out of range a notification is dispatched. This means
10619 that the idle percentage of your CPU needs to be less then the configured
10620 threshold only once for a notification to be generated. There's no such thing
10621 as a moving average or similar - at least not now.
10622
10623 Also, all values that match a threshold are considered to be relevant or
10624 "interesting". As a consequence collectd will issue a notification if they are
10625 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10626 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10627 "2" (the default) and some hosts sends it's CPU statistics to the server every
10628 60 seconds, a notification will be dispatched after about 120 seconds. It may
10629 take a little longer because the timeout is checked only once each B<Interval>
10630 on the server.
10631
10632 When a value comes within range again or is received after it was missing, an
10633 "OKAY-notification" is dispatched.
10634
10635 Here is a configuration example to get you started. Read below for more
10636 information.
10637
10638  <Plugin threshold>
10639    <Type "foo">
10640      WarningMin    0.00
10641      WarningMax 1000.00
10642      FailureMin    0.00
10643      FailureMax 1200.00
10644      Invert false
10645      Instance "bar"
10646    </Type>
10647
10648    <Plugin "interface">
10649      Instance "eth0"
10650      <Type "if_octets">
10651        FailureMax 10000000
10652        DataSource "rx"
10653      </Type>
10654    </Plugin>
10655
10656    <Host "hostname">
10657      <Type "cpu">
10658        Instance "idle"
10659        FailureMin 10
10660      </Type>
10661
10662      <Plugin "memory">
10663        <Type "memory">
10664          Instance "cached"
10665          WarningMin 100000000
10666        </Type>
10667      </Plugin>
10668    </Host>
10669  </Plugin>
10670
10671 There are basically two types of configuration statements: The C<Host>,
10672 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10673 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10674 C<Instance> option. You can combine the block by nesting the blocks, though
10675 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10676 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10677 C<Type> may not contain other blocks. If multiple blocks apply to the same
10678 value the most specific block is used.
10679
10680 The other statements specify the threshold to configure. They B<must> be
10681 included in a C<Type> block. Currently the following statements are recognized:
10682
10683 =over 4
10684
10685 =item B<FailureMax> I<Value>
10686
10687 =item B<WarningMax> I<Value>
10688
10689 Sets the upper bound of acceptable values. If unset defaults to positive
10690 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10691 will be created. If the value is greater than B<WarningMax> but less than (or
10692 equal to) B<FailureMax> a B<WARNING> notification will be created.
10693
10694 =item B<FailureMin> I<Value>
10695
10696 =item B<WarningMin> I<Value>
10697
10698 Sets the lower bound of acceptable values. If unset defaults to negative
10699 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10700 be created. If the value is less than B<WarningMin> but greater than (or equal
10701 to) B<FailureMin> a B<WARNING> notification will be created.
10702
10703 =item B<DataSource> I<DSName>
10704
10705 Some data sets have more than one "data source". Interesting examples are the
10706 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10707 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10708 system load data set, C<load>, even has three data sources: C<shortterm>,
10709 C<midterm>, and C<longterm>.
10710
10711 Normally, all data sources are checked against a configured threshold. If this
10712 is undesirable, or if you want to specify different limits for each data
10713 source, you can use the B<DataSource> option to have a threshold apply only to
10714 one data source.
10715
10716 =item B<Invert> B<true>|B<false>
10717
10718 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10719 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10720 B<WarningMax>) are not okay. Defaults to B<false>.
10721
10722 =item B<Persist> B<true>|B<false>
10723
10724 Sets how often notifications are generated. If set to B<true> one notification
10725 will be generated for each value that is out of the acceptable range. If set to
10726 B<false> (the default) then a notification is only generated if a value is out
10727 of range but the previous value was okay.
10728
10729 This applies to missing values, too: If set to B<true> a notification about a
10730 missing value is generated once every B<Interval> seconds. If set to B<false>
10731 only one such notification is generated until the value appears again.
10732
10733 =item B<Percentage> B<true>|B<false>
10734
10735 If set to B<true>, the minimum and maximum values given are interpreted as
10736 percentage value, relative to the other data sources. This is helpful for
10737 example for the "df" type, where you may want to issue a warning when less than
10738 5E<nbsp>% of the total space is available. Defaults to B<false>.
10739
10740 =item B<Hits> I<Number>
10741
10742 Delay creating the notification until the threshold has been passed I<Number>
10743 times. When a notification has been generated, or when a subsequent value is
10744 inside the threshold, the counter is reset. If, for example, a value is
10745 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10746 will be dispatched at most once every 30E<nbsp>seconds.
10747
10748 This is useful when short bursts are not a problem. If, for example, 100% CPU
10749 usage for up to a minute is normal (and data is collected every
10750 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10751
10752 =item B<Hysteresis> I<Number>
10753
10754 When set to non-zero, a hysteresis value is applied when checking minimum and
10755 maximum bounds. This is useful for values that increase slowly and fluctuate a
10756 bit while doing so. When these values come close to the threshold, they may
10757 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10758
10759 If, for example, the threshold is configures as
10760
10761   WarningMax 100.0
10762   Hysteresis 1.0
10763
10764 then a I<Warning> notification is created when the value exceeds I<101> and the
10765 corresponding I<Okay> notification is only created once the value falls below
10766 I<99>, thus avoiding the "flapping".
10767
10768 =back
10769
10770 =head1 FILTER CONFIGURATION
10771
10772 Starting with collectd 4.6 there is a powerful filtering infrastructure
10773 implemented in the daemon. The concept has mostly been copied from
10774 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10775 terminology, so that users that are familiar with iptables feel right at home.
10776
10777 =head2 Terminology
10778
10779 The following are the terms used in the remainder of the filter configuration
10780 documentation. For an ASCII-art schema of the mechanism, see
10781 L<"General structure"> below.
10782
10783 =over 4
10784
10785 =item B<Match>
10786
10787 A I<match> is a criteria to select specific values. Examples are, of course, the
10788 name of the value or it's current value.
10789
10790 Matches are implemented in plugins which you have to load prior to using the
10791 match. The name of such plugins starts with the "match_" prefix.
10792
10793 =item B<Target>
10794
10795 A I<target> is some action that is to be performed with data. Such actions
10796 could, for example, be to change part of the value's identifier or to ignore
10797 the value completely.
10798
10799 Some of these targets are built into the daemon, see L<"Built-in targets">
10800 below. Other targets are implemented in plugins which you have to load prior to
10801 using the target. The name of such plugins starts with the "target_" prefix.
10802
10803 =item B<Rule>
10804
10805 The combination of any number of matches and at least one target is called a
10806 I<rule>. The target actions will be performed for all values for which B<all>
10807 matches apply. If the rule does not have any matches associated with it, the
10808 target action will be performed for all values.
10809
10810 =item B<Chain>
10811
10812 A I<chain> is a list of rules and possibly default targets. The rules are tried
10813 in order and if one matches, the associated target will be called. If a value
10814 is handled by a rule, it depends on the target whether or not any subsequent
10815 rules are considered or if traversal of the chain is aborted, see
10816 L<"Flow control"> below. After all rules have been checked, the default targets
10817 will be executed.
10818
10819 =back
10820
10821 =head2 General structure
10822
10823 The following shows the resulting structure:
10824
10825  +---------+
10826  ! Chain   !
10827  +---------+
10828       !
10829       V
10830  +---------+  +---------+  +---------+  +---------+
10831  ! Rule    !->! Match   !->! Match   !->! Target  !
10832  +---------+  +---------+  +---------+  +---------+
10833       !
10834       V
10835  +---------+  +---------+  +---------+
10836  ! Rule    !->! Target  !->! Target  !
10837  +---------+  +---------+  +---------+
10838       !
10839       V
10840       :
10841       :
10842       !
10843       V
10844  +---------+  +---------+  +---------+
10845  ! Rule    !->! Match   !->! Target  !
10846  +---------+  +---------+  +---------+
10847       !
10848       V
10849  +---------+
10850  ! Default !
10851  ! Target  !
10852  +---------+
10853
10854 =head2 Flow control
10855
10856 There are four ways to control which way a value takes through the filter
10857 mechanism:
10858
10859 =over 4
10860
10861 =item B<jump>
10862
10863 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10864 process the value with another chain. When the called chain finishes, usually
10865 the next target or rule after the jump is executed.
10866
10867 =item B<stop>
10868
10869 The stop condition, signaled for example by the built-in target B<stop>, causes
10870 all processing of the value to be stopped immediately.
10871
10872 =item B<return>
10873
10874 Causes processing in the current chain to be aborted, but processing of the
10875 value generally will continue. This means that if the chain was called via
10876 B<Jump>, the next target or rule after the jump will be executed. If the chain
10877 was not called by another chain, control will be returned to the daemon and it
10878 may pass the value to another chain.
10879
10880 =item B<continue>
10881
10882 Most targets will signal the B<continue> condition, meaning that processing
10883 should continue normally. There is no special built-in target for this
10884 condition.
10885
10886 =back
10887
10888 =head2 Synopsis
10889
10890 The configuration reflects this structure directly:
10891
10892  PostCacheChain "PostCache"
10893  <Chain "PostCache">
10894    <Rule "ignore_mysql_show">
10895      <Match "regex">
10896        Plugin "^mysql$"
10897        Type "^mysql_command$"
10898        TypeInstance "^show_"
10899      </Match>
10900      <Target "stop">
10901      </Target>
10902    </Rule>
10903    <Target "write">
10904      Plugin "rrdtool"
10905    </Target>
10906  </Chain>
10907
10908 The above configuration example will ignore all values where the plugin field
10909 is "mysql", the type is "mysql_command" and the type instance begins with
10910 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10911 default target of the chain. Since this chain is run after the value has been
10912 added to the cache, the MySQL C<show_*> command statistics will be available
10913 via the C<unixsock> plugin.
10914
10915 =head2 List of configuration options
10916
10917 =over 4
10918
10919 =item B<PreCacheChain> I<ChainName>
10920
10921 =item B<PostCacheChain> I<ChainName>
10922
10923 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10924 argument is the name of a I<chain> that should be executed before and/or after
10925 the values have been added to the cache.
10926
10927 To understand the implications, it's important you know what is going on inside
10928 I<collectd>. The following diagram shows how values are passed from the
10929 read-plugins to the write-plugins:
10930
10931    +---------------+
10932    !  Read-Plugin  !
10933    +-------+-------+
10934            !
10935  + - - - - V - - - - +
10936  : +---------------+ :
10937  : !   Pre-Cache   ! :
10938  : !     Chain     ! :
10939  : +-------+-------+ :
10940  :         !         :
10941  :         V         :
10942  : +-------+-------+ :  +---------------+
10943  : !     Cache     !--->!  Value Cache  !
10944  : !     insert    ! :  +---+---+-------+
10945  : +-------+-------+ :      !   !
10946  :         !   ,------------'   !
10947  :         V   V     :          V
10948  : +-------+---+---+ :  +-------+-------+
10949  : !  Post-Cache   +--->! Write-Plugins !
10950  : !     Chain     ! :  +---------------+
10951  : +---------------+ :
10952  :                   :
10953  :  dispatch values  :
10954  + - - - - - - - - - +
10955
10956 After the values are passed from the "read" plugins to the dispatch functions,
10957 the pre-cache chain is run first. The values are added to the internal cache
10958 afterwards. The post-cache chain is run after the values have been added to the
10959 cache. So why is it such a huge deal if chains are run before or after the
10960 values have been added to this cache?
10961
10962 Targets that change the identifier of a value list should be executed before
10963 the values are added to the cache, so that the name in the cache matches the
10964 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10965 this cache to receive a list of all available values. If you change the
10966 identifier after the value list has been added to the cache, this may easily
10967 lead to confusion, but it's not forbidden of course.
10968
10969 The cache is also used to convert counter values to rates. These rates are, for
10970 example, used by the C<value> match (see below). If you use the rate stored in
10971 the cache B<before> the new value is added, you will use the old, B<previous>
10972 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10973 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10974 command.
10975
10976 Last but not last, the B<stop> target makes a difference: If the pre-cache
10977 chain returns the stop condition, the value will not be added to the cache and
10978 the post-cache chain will not be run.
10979
10980 =item B<Chain> I<Name>
10981
10982 Adds a new chain with a certain name. This name can be used to refer to a
10983 specific chain, for example to jump to it.
10984
10985 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10986
10987 =item B<Rule> [I<Name>]
10988
10989 Adds a new rule to the current chain. The name of the rule is optional and
10990 currently has no meaning for the daemon.
10991
10992 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10993 must be at least one B<Target> block.
10994
10995 =item B<Match> I<Name>
10996
10997 Adds a match to a B<Rule> block. The name specifies what kind of match should
10998 be performed. Available matches depend on the plugins that have been loaded.
10999
11000 The arguments inside the B<Match> block are passed to the plugin implementing
11001 the match, so which arguments are valid here depends on the plugin being used.
11002 If you do not need any to pass any arguments to a match, you can use the
11003 shorter syntax:
11004
11005  Match "foobar"
11006
11007 Which is equivalent to:
11008
11009  <Match "foobar">
11010  </Match>
11011
11012 =item B<Target> I<Name>
11013
11014 Add a target to a rule or a default target to a chain. The name specifies what
11015 kind of target is to be added. Which targets are available depends on the
11016 plugins being loaded.
11017
11018 The arguments inside the B<Target> block are passed to the plugin implementing
11019 the target, so which arguments are valid here depends on the plugin being used.
11020 If you do not need any to pass any arguments to a target, you can use the
11021 shorter syntax:
11022
11023  Target "stop"
11024
11025 This is the same as writing:
11026
11027  <Target "stop">
11028  </Target>
11029
11030 =back
11031
11032 =head2 Built-in targets
11033
11034 The following targets are built into the core daemon and therefore need no
11035 plugins to be loaded:
11036
11037 =over 4
11038
11039 =item B<return>
11040
11041 Signals the "return" condition, see the L<"Flow control"> section above. This
11042 causes the current chain to stop processing the value and returns control to
11043 the calling chain. The calling chain will continue processing targets and rules
11044 just after the B<jump> target (see below). This is very similar to the
11045 B<RETURN> target of iptables, see L<iptables(8)>.
11046
11047 This target does not have any options.
11048
11049 Example:
11050
11051  Target "return"
11052
11053 =item B<stop>
11054
11055 Signals the "stop" condition, see the L<"Flow control"> section above. This
11056 causes processing of the value to be aborted immediately. This is similar to
11057 the B<DROP> target of iptables, see L<iptables(8)>.
11058
11059 This target does not have any options.
11060
11061 Example:
11062
11063  Target "stop"
11064
11065 =item B<write>
11066
11067 Sends the value to "write" plugins.
11068
11069 Available options:
11070
11071 =over 4
11072
11073 =item B<Plugin> I<Name>
11074
11075 Name of the write plugin to which the data should be sent. This option may be
11076 given multiple times to send the data to more than one write plugin. If the
11077 plugin supports multiple instances, the plugin's instance(s) must also be
11078 specified.
11079
11080 =back
11081
11082 If no plugin is explicitly specified, the values will be sent to all available
11083 write plugins.
11084
11085 Single-instance plugin example:
11086
11087  <Target "write">
11088    Plugin "rrdtool"
11089  </Target>
11090
11091 Multi-instance plugin example:
11092
11093  <Plugin "write_graphite">
11094    <Node "foo">
11095    ...
11096    </Node>
11097    <Node "bar">
11098    ...
11099    </Node>
11100  </Plugin>
11101   ...
11102  <Target "write">
11103    Plugin "write_graphite/foo"
11104  </Target>
11105
11106 =item B<jump>
11107
11108 Starts processing the rules of another chain, see L<"Flow control"> above. If
11109 the end of that chain is reached, or a stop condition is encountered,
11110 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11111 next target or the next rule. This is similar to the B<-j> command line option
11112 of iptables, see L<iptables(8)>.
11113
11114 Available options:
11115
11116 =over 4
11117
11118 =item B<Chain> I<Name>
11119
11120 Jumps to the chain I<Name>. This argument is required and may appear only once.
11121
11122 =back
11123
11124 Example:
11125
11126  <Target "jump">
11127    Chain "foobar"
11128  </Target>
11129
11130 =back
11131
11132 =head2 Available matches
11133
11134 =over 4
11135
11136 =item B<regex>
11137
11138 Matches a value using regular expressions.
11139
11140 Available options:
11141
11142 =over 4
11143
11144 =item B<Host> I<Regex>
11145
11146 =item B<Plugin> I<Regex>
11147
11148 =item B<PluginInstance> I<Regex>
11149
11150 =item B<Type> I<Regex>
11151
11152 =item B<TypeInstance> I<Regex>
11153
11154 =item B<MetaData> I<String> I<Regex>
11155
11156 Match values where the given regular expressions match the various fields of
11157 the identifier of a value. If multiple regular expressions are given, B<all>
11158 regexen must match for a value to match.
11159
11160 =item B<Invert> B<false>|B<true>
11161
11162 When set to B<true>, the result of the match is inverted, i.e. all value lists
11163 where all regular expressions apply are not matched, all other value lists are
11164 matched. Defaults to B<false>.
11165
11166 =back
11167
11168 Example:
11169
11170  <Match "regex">
11171    Host "customer[0-9]+"
11172    Plugin "^foobar$"
11173  </Match>
11174
11175 =item B<timediff>
11176
11177 Matches values that have a time which differs from the time on the server.
11178
11179 This match is mainly intended for servers that receive values over the
11180 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11181 is very sensitive to the timestamp used when updating the RRD files. In
11182 particular, the time must be ever increasing. If a misbehaving client sends one
11183 packet with a timestamp far in the future, all further packets with a correct
11184 time will be ignored because of that one packet. What's worse, such corrupted
11185 RRD files are hard to fix.
11186
11187 This match lets one match all values B<outside> a specified time range
11188 (relative to the server's time), so you can use the B<stop> target (see below)
11189 to ignore the value, for example.
11190
11191 Available options:
11192
11193 =over 4
11194
11195 =item B<Future> I<Seconds>
11196
11197 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11198 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11199 non-zero.
11200
11201 =item B<Past> I<Seconds>
11202
11203 Matches all values that are I<behind> of the server's time by I<Seconds> or
11204 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11205 non-zero.
11206
11207 =back
11208
11209 Example:
11210
11211  <Match "timediff">
11212    Future  300
11213    Past   3600
11214  </Match>
11215
11216 This example matches all values that are five minutes or more ahead of the
11217 server or one hour (or more) lagging behind.
11218
11219 =item B<value>
11220
11221 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11222 values. If a data-set consists of more than one data-source, all data-sources
11223 must match the specified ranges for a positive match.
11224
11225 Available options:
11226
11227 =over 4
11228
11229 =item B<Min> I<Value>
11230
11231 Sets the smallest value which still results in a match. If unset, behaves like
11232 negative infinity.
11233
11234 =item B<Max> I<Value>
11235
11236 Sets the largest value which still results in a match. If unset, behaves like
11237 positive infinity.
11238
11239 =item B<Invert> B<true>|B<false>
11240
11241 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11242 no-match is returned and vice versa. Please note that the B<Invert> setting
11243 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11244 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11245
11246 =item B<DataSource> I<DSName> [I<DSName> ...]
11247
11248 Select one or more of the data sources. If no data source is configured, all
11249 data sources will be checked. If the type handled by the match does not have a
11250 data source of the specified name(s), this will always result in no match
11251 (independent of the B<Invert> setting).
11252
11253 =item B<Satisfy> B<Any>|B<All>
11254
11255 Specifies how checking with several data sources is performed. If set to
11256 B<Any>, the match succeeds if one of the data sources is in the configured
11257 range. If set to B<All> the match only succeeds if all data sources are within
11258 the configured range. Default is B<All>.
11259
11260 Usually B<All> is used for positive matches, B<Any> is used for negative
11261 matches. This means that with B<All> you usually check that all values are in a
11262 "good" range, while with B<Any> you check if any value is within a "bad" range
11263 (or outside the "good" range).
11264
11265 =back
11266
11267 Either B<Min> or B<Max>, but not both, may be unset.
11268
11269 Example:
11270
11271  # Match all values smaller than or equal to 100. Matches only if all data
11272  # sources are below 100.
11273  <Match "value">
11274    Max 100
11275    Satisfy "All"
11276  </Match>
11277
11278  # Match if the value of any data source is outside the range of 0 - 100.
11279  <Match "value">
11280    Min   0
11281    Max 100
11282    Invert true
11283    Satisfy "Any"
11284  </Match>
11285
11286 =item B<empty_counter>
11287
11288 Matches all values with one or more data sources of type B<COUNTER> and where
11289 all counter values are zero. These counters usually I<never> increased since
11290 they started existing (and are therefore uninteresting), or got reset recently
11291 or overflowed and you had really, I<really> bad luck.
11292
11293 Please keep in mind that ignoring such counters can result in confusing
11294 behavior: Counters which hardly ever increase will be zero for long periods of
11295 time. If the counter is reset for some reason (machine or service restarted,
11296 usually), the graph will be empty (NAN) for a long time. People may not
11297 understand why.
11298
11299 =item B<hashed>
11300
11301 Calculates a hash value of the host name and matches values according to that
11302 hash value. This makes it possible to divide all hosts into groups and match
11303 only values that are in a specific group. The intended use is in load
11304 balancing, where you want to handle only part of all data and leave the rest
11305 for other servers.
11306
11307 The hashing function used tries to distribute the hosts evenly. First, it
11308 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11309
11310   hash_value = 0;
11311   for (i = 0; host[i] != 0; i++)
11312     hash_value = (hash_value * 251) + host[i];
11313
11314 The constant 251 is a prime number which is supposed to make this hash value
11315 more random. The code then checks the group for this host according to the
11316 I<Total> and I<Match> arguments:
11317
11318   if ((hash_value % Total) == Match)
11319     matches;
11320   else
11321     does not match;
11322
11323 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11324 groups), then the least significant bit of the hash value will be the XOR of
11325 all least significant bits in the host name. One consequence is that when you
11326 have two hosts, "server0.example.com" and "server1.example.com", where the host
11327 name differs in one digit only and the digits differ by one, those hosts will
11328 never end up in the same group.
11329
11330 Available options:
11331
11332 =over 4
11333
11334 =item B<Match> I<Match> I<Total>
11335
11336 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11337 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11338 be smaller than I<Total>. I<Total> must be at least one, although only values
11339 greater than one really do make any sense.
11340
11341 You can repeat this option to match multiple groups, for example:
11342
11343   Match 3 7
11344   Match 5 7
11345
11346 The above config will divide the data into seven groups and match groups three
11347 and five. One use would be to keep every value on two hosts so that if one
11348 fails the missing data can later be reconstructed from the second host.
11349
11350 =back
11351
11352 Example:
11353
11354  # Operate on the pre-cache chain, so that ignored values are not even in the
11355  # global cache.
11356  <Chain "PreCache">
11357    <Rule>
11358      <Match "hashed">
11359        # Divide all received hosts in seven groups and accept all hosts in
11360        # group three.
11361        Match 3 7
11362      </Match>
11363      # If matched: Return and continue.
11364      Target "return"
11365    </Rule>
11366    # If not matched: Return and stop.
11367    Target "stop"
11368  </Chain>
11369
11370 =back
11371
11372 =head2 Available targets
11373
11374 =over 4
11375
11376 =item B<notification>
11377
11378 Creates and dispatches a notification.
11379
11380 Available options:
11381
11382 =over 4
11383
11384 =item B<Message> I<String>
11385
11386 This required option sets the message of the notification. The following
11387 placeholders will be replaced by an appropriate value:
11388
11389 =over 4
11390
11391 =item B<%{host}>
11392
11393 =item B<%{plugin}>
11394
11395 =item B<%{plugin_instance}>
11396
11397 =item B<%{type}>
11398
11399 =item B<%{type_instance}>
11400
11401 These placeholders are replaced by the identifier field of the same name.
11402
11403 =item B<%{ds:>I<name>B<}>
11404
11405 These placeholders are replaced by a (hopefully) human readable representation
11406 of the current rate of this data source. If you changed the instance name
11407 (using the B<set> or B<replace> targets, see below), it may not be possible to
11408 convert counter values to rates.
11409
11410 =back
11411
11412 Please note that these placeholders are B<case sensitive>!
11413
11414 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11415
11416 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11417 used.
11418
11419 =back
11420
11421 Example:
11422
11423   <Target "notification">
11424     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11425     Severity "WARNING"
11426   </Target>
11427
11428 =item B<replace>
11429
11430 Replaces parts of the identifier using regular expressions.
11431
11432 Available options:
11433
11434 =over 4
11435
11436 =item B<Host> I<Regex> I<Replacement>
11437
11438 =item B<Plugin> I<Regex> I<Replacement>
11439
11440 =item B<PluginInstance> I<Regex> I<Replacement>
11441
11442 =item B<TypeInstance> I<Regex> I<Replacement>
11443
11444 =item B<MetaData> I<String> I<Regex> I<Replacement>
11445
11446 =item B<DeleteMetaData> I<String> I<Regex>
11447
11448 Match the appropriate field with the given regular expression I<Regex>. If the
11449 regular expression matches, that part that matches is replaced with
11450 I<Replacement>. If multiple places of the input buffer match a given regular
11451 expression, only the first occurrence will be replaced.
11452
11453 You can specify each option multiple times to use multiple regular expressions
11454 one after another.
11455
11456 =back
11457
11458 Example:
11459
11460  <Target "replace">
11461    # Replace "example.net" with "example.com"
11462    Host "\\<example.net\\>" "example.com"
11463
11464    # Strip "www." from hostnames
11465    Host "\\<www\\." ""
11466  </Target>
11467
11468 =item B<set>
11469
11470 Sets part of the identifier of a value to a given string.
11471
11472 Available options:
11473
11474 =over 4
11475
11476 =item B<Host> I<String>
11477
11478 =item B<Plugin> I<String>
11479
11480 =item B<PluginInstance> I<String>
11481
11482 =item B<TypeInstance> I<String>
11483
11484 =item B<MetaData> I<String> I<String>
11485
11486 Set the appropriate field to the given string. The strings for plugin instance,
11487 type instance, and meta data may be empty, the strings for host and plugin may
11488 not be empty. It's currently not possible to set the type of a value this way.
11489
11490 The following placeholders will be replaced by an appropriate value:
11491
11492 =over 4
11493
11494 =item B<%{host}>
11495
11496 =item B<%{plugin}>
11497
11498 =item B<%{plugin_instance}>
11499
11500 =item B<%{type}>
11501
11502 =item B<%{type_instance}>
11503
11504 These placeholders are replaced by the identifier field of the same name.
11505
11506 =item B<%{meta:>I<name>B<}>
11507
11508 These placeholders are replaced by the meta data value with the given name.
11509
11510 =back
11511
11512 Please note that these placeholders are B<case sensitive>!
11513
11514 =item B<DeleteMetaData> I<String>
11515
11516 Delete the named meta data field.
11517
11518 =back
11519
11520 Example:
11521
11522  <Target "set">
11523    PluginInstance "coretemp"
11524    TypeInstance "core3"
11525  </Target>
11526
11527 =back
11528
11529 =head2 Backwards compatibility
11530
11531 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11532 B<Chain> block, it will behave as it used to. This is equivalent to the
11533 following configuration:
11534
11535  <Chain "PostCache">
11536    Target "write"
11537  </Chain>
11538
11539 If you specify a B<PostCacheChain>, the B<write> target will not be added
11540 anywhere and you will have to make sure that it is called where appropriate. We
11541 suggest to add the above snippet as default target to your "PostCache" chain.
11542
11543 =head2 Examples
11544
11545 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11546 be an FQDN.
11547
11548  <Chain "PreCache">
11549    <Rule "no_fqdn">
11550      <Match "regex">
11551        Host "^[^\.]*$"
11552      </Match>
11553      Target "stop"
11554    </Rule>
11555    Target "write"
11556  </Chain>
11557
11558 =head1 IGNORELISTS
11559
11560 B<Ignorelists> are a generic framework to either ignore some metrics or report
11561 specific metircs only. Plugins usually provide one or more options to specify
11562 the items (mounts points, devices, ...) and the boolean option
11563 C<IgnoreSelected>.
11564
11565 =over 4
11566
11567 =item B<Select> I<String>
11568
11569 Selects the item I<String>. This option often has a plugin specific name, e.g.
11570 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11571 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11572 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11573
11574 By default, this option is doing a case-sensitive full-string match. The
11575 following config will match C<foo>, but not C<Foo>:
11576
11577   Select "foo"
11578
11579 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11580 I<regular expression>. For example, so match all item starting with C<foo>, use
11581 could use the following syntax:
11582
11583   Select "/^foo/"
11584
11585 The regular expression is I<not> anchored, i.e. the following config will match
11586 C<foobar>, C<barfoo> and C<AfooZ>:
11587
11588   Select "/foo/"
11589
11590 The B<Select> option may be repeated to select multiple items.
11591
11592 =item B<IgnoreSelected> B<true>|B<false>
11593
11594 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11595 collected. If set to B<false>, matching metrics are I<collected> and all other
11596 metrics are ignored.
11597
11598 =back
11599
11600 =head1 SEE ALSO
11601
11602 L<collectd(1)>,
11603 L<collectd-exec(5)>,
11604 L<collectd-perl(5)>,
11605 L<collectd-unixsock(5)>,
11606 L<types.db(5)>,
11607 L<hddtemp(8)>,
11608 L<iptables(8)>,
11609 L<kstat(3KSTAT)>,
11610 L<mbmon(1)>,
11611 L<psql(1)>,
11612 L<regex(7)>,
11613 L<rrdtool(1)>,
11614 L<sensors(1)>
11615
11616 =head1 AUTHOR
11617
11618 Florian Forster E<lt>octo@collectd.orgE<gt>
11619
11620 =cut