src/collectd.conf.pod

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