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.
3568
3569 =over 4
3570
3571 =item B<McelogClientSocket> I<Path>
3572 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3573 Defaults to B<"/var/run/mcelog-client">.
3574
3575 =item B<McelogLogfile> I<Path>
3576
3577 The mcelog file to parse. Defaults to B<"/var/log/mcelog">.
3578
3579 =back
3580
3581 =head2 Plugin C<md>
3582
3583 The C<md plugin> collects information from Linux Software-RAID devices (md).
3584
3585 All reported values are of the type C<md_disks>. Reported type instances are
3586 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3587 I<missing> (physically absent) disks.
3588
3589 =over 4
3590
3591 =item B<Device> I<Device>
3592
3593 Select md devices based on device name. The I<device name> is the basename of
3594 the device, i.e. the name of the block device without the leading C</dev/>.
3595 See B<IgnoreSelected> for more details.
3596
3597 See F</"IGNORELISTS"> for details.
3598
3599 =item B<IgnoreSelected> B<true>|B<false>
3600
3601 Invert device selection: If set to B<true>, all md devices B<except> those
3602 listed using B<Device> are collected. If B<false> (the default), only those
3603 listed are collected. If no configuration is given, the B<md> plugin will
3604 collect data from all md devices.
3605
3606 =back
3607
3608 =head2 Plugin C<memcachec>
3609
3610 The C<memcachec plugin> connects to a memcached server, queries one or more
3611 given I<pages> and parses the returned data according to user specification.
3612 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3613 plugins.
3614
3615 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3616 library. Please note that there is another library with a very similar name,
3617 libmemcache (notice the missing `d'), which is not applicable.
3618
3619 Synopsis of the configuration:
3620
3621  <Plugin "memcachec">
3622    <Page "plugin_instance">
3623      Server "localhost"
3624      Key "page_key"
3625      <Match>
3626        Regex "(\\d+) bytes sent"
3627        DSType CounterAdd
3628        Type "ipt_octets"
3629        Instance "type_instance"
3630      </Match>
3631    </Page>
3632  </Plugin>
3633
3634 The configuration options are:
3635
3636 =over 4
3637
3638 =item E<lt>B<Page> I<Name>E<gt>
3639
3640 Each B<Page> block defines one I<page> to be queried from the memcached server.
3641 The block requires one string argument which is used as I<plugin instance>.
3642
3643 =item B<Server> I<Address>
3644
3645 Sets the server address to connect to when querying the page. Must be inside a
3646 B<Page> block.
3647
3648 =item B<Key> I<Key>
3649
3650 When connected to the memcached server, asks for the page I<Key>.
3651
3652 =item E<lt>B<Match>E<gt>
3653
3654 Match blocks define which strings to look for and how matches substrings are
3655 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3656
3657 =back
3658
3659 =head2 Plugin C<memcached>
3660
3661 The B<memcached plugin> connects to a memcached server and queries statistics
3662 about cache utilization, memory and bandwidth used.
3663 L<http://memcached.org/>
3664
3665  <Plugin "memcached">
3666    <Instance "name">
3667      #Host "memcache.example.com"
3668      Address "127.0.0.1"
3669      Port 11211
3670    </Instance>
3671  </Plugin>
3672
3673 The plugin configuration consists of one or more B<Instance> blocks which
3674 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3675 following options are allowed:
3676
3677 =over 4
3678
3679 =item B<Host> I<Hostname>
3680
3681 Sets the B<host> field of dispatched values. Defaults to the global hostname
3682 setting.
3683 For backwards compatibility, values are also dispatched with the global
3684 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3685 not set.
3686
3687 =item B<Address> I<Address>
3688
3689 Hostname or IP to connect to. For backwards compatibility, defaults to the
3690 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3691
3692 =item B<Port> I<Port>
3693
3694 TCP port to connect to. Defaults to B<11211>.
3695
3696 =item B<Socket> I<Path>
3697
3698 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3699 setting is given, the B<Address> and B<Port> settings are ignored.
3700
3701 =back
3702
3703 =head2 Plugin C<mic>
3704
3705 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3706 Intel's Many Integrated Core (MIC) systems.
3707
3708 B<Synopsis:>
3709
3710  <Plugin mic>
3711    ShowCPU true
3712    ShowCPUCores true
3713    ShowMemory true
3714
3715    ShowTemperatures true
3716    Temperature vddg
3717    Temperature vddq
3718    IgnoreSelectedTemperature true
3719
3720    ShowPower true
3721    Power total0
3722    Power total1
3723    IgnoreSelectedPower true
3724  </Plugin>
3725
3726 The following options are valid inside the B<PluginE<nbsp>mic> block:
3727
3728 =over 4
3729
3730 =item B<ShowCPU> B<true>|B<false>
3731
3732 If enabled (the default) a sum of the CPU usage across all cores is reported.
3733
3734 =item B<ShowCPUCores> B<true>|B<false>
3735
3736 If enabled (the default) per-core CPU usage is reported.
3737
3738 =item B<ShowMemory> B<true>|B<false>
3739
3740 If enabled (the default) the physical memory usage of the MIC system is
3741 reported.
3742
3743 =item B<ShowTemperatures> B<true>|B<false>
3744
3745 If enabled (the default) various temperatures of the MIC system are reported.
3746
3747 =item B<Temperature> I<Name>
3748
3749 This option controls which temperatures are being reported. Whether matching
3750 temperatures are being ignored or I<only> matching temperatures are reported
3751 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3752 temperatures are reported.
3753
3754 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3755
3756 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3757 (the default) only temperatures matching a B<Temperature> option are reported
3758 or, if no B<Temperature> option is specified, all temperatures are reported. If
3759 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3760 are reported.
3761
3762 Known temperature names are:
3763
3764 =over 4
3765
3766 =item die
3767
3768 Die of the CPU
3769
3770 =item devmem
3771
3772 Device Memory
3773
3774 =item fin
3775
3776 Fan In
3777
3778 =item fout
3779
3780 Fan Out
3781
3782 =item vccp
3783
3784 Voltage ccp
3785
3786 =item vddg
3787
3788 Voltage ddg
3789
3790 =item vddq
3791
3792 Voltage ddq
3793
3794 =back
3795
3796 =item B<ShowPower> B<true>|B<false>
3797
3798 If enabled (the default) various temperatures of the MIC system are reported.
3799
3800 =item B<Power> I<Name>
3801
3802 This option controls which power readings are being reported. Whether matching
3803 power readings are being ignored or I<only> matching power readings are reported
3804 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3805 power readings are reported.
3806
3807 =item B<IgnoreSelectedPower> B<false>|B<true>
3808
3809 Controls the behavior of the B<Power> setting above. If set to B<false>
3810 (the default) only power readings matching a B<Power> option are reported
3811 or, if no B<Power> option is specified, all power readings are reported. If
3812 set to B<true>, matching power readings are I<ignored> and all other power readings
3813 are reported.
3814
3815 Known power names are:
3816
3817 =over 4
3818
3819 =item total0
3820
3821 Total power utilization averaged over Time Window 0 (uWatts).
3822
3823 =item total1
3824
3825 Total power utilization averaged over Time Window 0 (uWatts).
3826
3827 =item inst
3828
3829 Instantaneous power (uWatts).
3830
3831 =item imax
3832
3833 Max instantaneous power (uWatts).
3834
3835 =item pcie
3836
3837 PCI-E connector power (uWatts).
3838
3839 =item c2x3
3840
3841 2x3 connector power (uWatts).
3842
3843 =item c2x4
3844
3845 2x4 connector power (uWatts).
3846
3847 =item vccp
3848
3849 Core rail (uVolts).
3850
3851 =item vddg
3852
3853 Uncore rail (uVolts).
3854
3855 =item vddq
3856
3857 Memory subsystem rail (uVolts).
3858
3859 =back
3860
3861 =back
3862
3863 =head2 Plugin C<memory>
3864
3865 The I<memory plugin> provides the following configuration options:
3866
3867 =over 4
3868
3869 =item B<ValuesAbsolute> B<true>|B<false>
3870
3871 Enables or disables reporting of physical memory usage in absolute numbers,
3872 i.e. bytes. Defaults to B<true>.
3873
3874 =item B<ValuesPercentage> B<false>|B<true>
3875
3876 Enables or disables reporting of physical memory usage in percentages, e.g.
3877 percent of physical memory used. Defaults to B<false>.
3878
3879 This is useful for deploying I<collectd> in a heterogeneous environment in
3880 which the sizes of physical memory vary.
3881
3882 =back
3883
3884 =head2 Plugin C<modbus>
3885
3886 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3887 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3888 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3889 values (two registers interpreted as IEEE floats in big endian notation).
3890
3891 B<Synopsis:>
3892
3893  <Data "voltage-input-1">
3894    RegisterBase 0
3895    RegisterType float
3896    RegisterCmd ReadHolding
3897    Type voltage
3898    Instance "input-1"
3899  </Data>
3900
3901  <Data "voltage-input-2">
3902    RegisterBase 2
3903    RegisterType float
3904    RegisterCmd ReadHolding
3905    Type voltage
3906    Instance "input-2"
3907  </Data>
3908
3909  <Data "supply-temperature-1">
3910    RegisterBase 0
3911    RegisterType Int16
3912    RegisterCmd ReadHolding
3913    Type temperature
3914    Instance "temp-1"
3915  </Data>
3916
3917  <Host "modbus.example.com">
3918    Address "192.168.0.42"
3919    Port    "502"
3920    Interval 60
3921
3922    <Slave 1>
3923      Instance "power-supply"
3924      Collect  "voltage-input-1"
3925      Collect  "voltage-input-2"
3926    </Slave>
3927  </Host>
3928
3929  <Host "localhost">
3930    Device "/dev/ttyUSB0"
3931    Baudrate 38400
3932    Interval 20
3933
3934    <Slave 1>
3935      Instance "temperature"
3936      Collect  "supply-temperature-1"
3937    </Slave>
3938  </Host>
3939
3940 =over 4
3941
3942 =item E<lt>B<Data> I<Name>E<gt> blocks
3943
3944 Data blocks define a mapping between register numbers and the "types" used by
3945 I<collectd>.
3946
3947 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3948
3949 =over 4
3950
3951 =item B<RegisterBase> I<Number>
3952
3953 Configures the base register to read from the device. If the option
3954 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3955 register will be read (the register number is increased by one).
3956
3957 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3958
3959 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3960 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3961 combined into one value. Defaults to B<Uint16>.
3962
3963 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3964
3965 Specifies register type to be collected from device. Works only with libmodbus
3966 2.9.2 or higher. Defaults to B<ReadHolding>.
3967
3968 =item B<Type> I<Type>
3969
3970 Specifies the "type" (data set) to use when dispatching the value to
3971 I<collectd>. Currently, only data sets with exactly one data source are
3972 supported.
3973
3974 =item B<Instance> I<Instance>
3975
3976 Sets the type instance to use when dispatching the value to I<collectd>. If
3977 unset, an empty string (no type instance) is used.
3978
3979 =back
3980
3981 =item E<lt>B<Host> I<Name>E<gt> blocks
3982
3983 Host blocks are used to specify to which hosts to connect and what data to read
3984 from their "slaves". The string argument I<Name> is used as hostname when
3985 dispatching the values to I<collectd>.
3986
3987 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3988
3989 =over 4
3990
3991 =item B<Address> I<Hostname>
3992
3993 For Modbus/TCP, specifies the node name (the actual network address) used to
3994 connect to the host. This may be an IP address or a hostname. Please note that
3995 the used I<libmodbus> library only supports IPv4 at the moment.
3996
3997 =item B<Port> I<Service>
3998
3999 for Modbus/TCP, specifies the port used to connect to the host. The port can
4000 either be given as a number or as a service name. Please note that the
4001 I<Service> argument must be a string, even if ports are given in their numerical
4002 form. Defaults to "502".
4003
4004 =item B<Device> I<Devicenode>
4005
4006 For Modbus/RTU, specifies the path to the serial device being used.
4007
4008 =item B<Baudrate> I<Baudrate>
4009
4010 For Modbus/RTU, specifies the baud rate of the serial device.
4011 Note, connections currently support only 8/N/1.
4012
4013 =item B<Interval> I<Interval>
4014
4015 Sets the interval (in seconds) in which the values will be collected from this
4016 host. By default the global B<Interval> setting will be used.
4017
4018 =item E<lt>B<Slave> I<ID>E<gt>
4019
4020 Over each connection, multiple Modbus devices may be reached. The slave ID
4021 is used to specify which device should be addressed. For each device you want
4022 to query, one B<Slave> block must be given.
4023
4024 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4025
4026 =over 4
4027
4028 =item B<Instance> I<Instance>
4029
4030 Specify the plugin instance to use when dispatching the values to I<collectd>.
4031 By default "slave_I<ID>" is used.
4032
4033 =item B<Collect> I<DataName>
4034
4035 Specifies which data to retrieve from the device. I<DataName> must be the same
4036 string as the I<Name> argument passed to a B<Data> block. You can specify this
4037 option multiple times to collect more than one value from a slave. At least one
4038 B<Collect> option is mandatory.
4039
4040 =back
4041
4042 =back
4043
4044 =back
4045
4046 =head2 Plugin C<mqtt>
4047
4048 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4049 values from MQTT (B<Subscribe> blocks).
4050
4051 B<Synopsis:>
4052
4053  <Plugin mqtt>
4054    <Publish "name">
4055      Host "mqtt.example.com"
4056      Prefix "collectd"
4057    </Publish>
4058    <Subscribe "name">
4059      Host "mqtt.example.com"
4060      Topic "collectd/#"
4061    </Subscribe>
4062  </Plugin>
4063
4064 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4065 configuring the sending and receiving direction respectively. The plugin will
4066 register a write callback named C<mqtt/I<name>> where I<name> is the string
4067 argument given to the B<Publish> block. Both types of blocks share many but not
4068 all of the following options. If an option is valid in only one of the blocks,
4069 it will be mentioned explicitly.
4070
4071 B<Options:>
4072
4073 =over 4
4074
4075 =item B<Host> I<Hostname>
4076
4077 Hostname of the MQTT broker to connect to.
4078
4079 =item B<Port> I<Service>
4080
4081 Port number or service name of the MQTT broker to connect to.
4082
4083 =item B<User> I<UserName>
4084
4085 Username used when authenticating to the MQTT broker.
4086
4087 =item B<Password> I<Password>
4088
4089 Password used when authenticating to the MQTT broker.
4090
4091 =item B<ClientId> I<ClientId>
4092
4093 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4094
4095 =item B<QoS> [B<0>-B<2>]
4096
4097 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4098
4099 =over 4
4100
4101 =item B<0>
4102
4103 At most once
4104
4105 =item B<1>
4106
4107 At least once
4108
4109 =item B<2>
4110
4111 Exactly once
4112
4113 =back
4114
4115 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4116 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4117 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4118 on a message is larger than the maximum accepted QoS of a subscriber, the
4119 message's QoS will be downgraded.
4120
4121 =item B<Prefix> I<Prefix> (Publish only)
4122
4123 This plugin will use one topic per I<value list> which will looks like a path.
4124 I<Prefix> is used as the first path element and defaults to B<collectd>.
4125
4126 An example topic name would be:
4127
4128  collectd/cpu-0/cpu-user
4129
4130 =item B<Retain> B<false>|B<true> (Publish only)
4131
4132 Controls whether the MQTT broker will retain (keep a copy of) the last message
4133 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4134
4135 =item B<StoreRates> B<true>|B<false> (Publish only)
4136
4137 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4138 before sending. Defaults to B<true>.
4139
4140 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4141
4142 Controls whether the MQTT "cleans" the session up after the subscriber
4143 disconnects or if it maintains the subscriber's subscriptions and all messages
4144 that arrive while the subscriber is disconnected. Defaults to B<true>.
4145
4146 =item B<Topic> I<TopicName> (Subscribe only)
4147
4148 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4149 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4150 the B<collectd> branch.
4151
4152 =item B<CACert> I<file>
4153
4154 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4155 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4156 port of the MQTT broker.
4157 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4158
4159 =item B<CertificateFile> I<file>
4160
4161 Path to the PEM-encoded certificate file to use as client certificate when
4162 connecting to the MQTT broker.
4163 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4164
4165 =item B<CertificateKeyFile> I<file>
4166
4167 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4168 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
4169
4170 =item B<TLSProtocol> I<protocol>
4171
4172 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4173 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4174 version is used which depends on the version of OpenSSL the Mosquitto library
4175 was linked against.
4176
4177 =item B<CipherSuite> I<ciphersuite>
4178
4179 A string describing the ciphers available for use. See L<ciphers(1)> and the
4180 C<openssl ciphers> utility for more information. If unset, the default ciphers
4181 will be used.
4182
4183
4184 =back
4185
4186 =head2 Plugin C<mysql>
4187
4188 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4189 one or more databases when started and keeps the connection up as long as
4190 possible. When the connection is interrupted for whatever reason it will try
4191 to re-connect. The plugin will complain loudly in case anything goes wrong.
4192
4193 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4194 and collects information about MySQL network traffic, executed statements,
4195 requests, the query cache and threads by evaluating the
4196 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4197 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4198 Status Variables> for an explanation of these values.
4199
4200 Optionally, master and slave statistics may be collected in a MySQL
4201 replication setup. In that case, information about the synchronization state
4202 of the nodes are collected by evaluating the C<Position> return value of the
4203 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4204 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4205 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4206 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4207 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4208
4209 Synopsis:
4210
4211   <Plugin mysql>
4212     <Database foo>
4213       Host "hostname"
4214       User "username"
4215       Password "password"
4216       Port "3306"
4217       MasterStats true
4218       ConnectTimeout 10
4219       SSLKey "/path/to/key.pem"
4220       SSLCert "/path/to/cert.pem"
4221       SSLCA "/path/to/ca.pem"
4222       SSLCAPath "/path/to/cas/"
4223       SSLCipher "DHE-RSA-AES256-SHA"
4224     </Database>
4225
4226     <Database bar>
4227       Alias "squeeze"
4228       Host "localhost"
4229       Socket "/var/run/mysql/mysqld.sock"
4230       SlaveStats true
4231       SlaveNotifications true
4232     </Database>
4233
4234    <Database galera>
4235       Alias "galera"
4236       Host "localhost"
4237       Socket "/var/run/mysql/mysqld.sock"
4238       WsrepStats true
4239    </Database>
4240   </Plugin>
4241
4242 A B<Database> block defines one connection to a MySQL database. It accepts a
4243 single argument which specifies the name of the database. None of the other
4244 options are required. MySQL will use default values as documented in the
4245 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4246 B<MySQL reference manual>.
4247
4248 =over 4
4249
4250 =item B<Alias> I<Alias>
4251
4252 Alias to use as sender instead of hostname when reporting. This may be useful
4253 when having cryptic hostnames.
4254
4255 =item B<Host> I<Hostname>
4256
4257 Hostname of the database server. Defaults to B<localhost>.
4258
4259 =item B<User> I<Username>
4260
4261 Username to use when connecting to the database. The user does not have to be
4262 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4263 unless you want to collectd replication statistics (see B<MasterStats> and
4264 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4265 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4266
4267 =item B<Password> I<Password>
4268
4269 Password needed to log into the database.
4270
4271 =item B<Database> I<Database>
4272
4273 Select this database. Defaults to I<no database> which is a perfectly reasonable
4274 option for what this plugin does.
4275
4276 =item B<Port> I<Port>
4277
4278 TCP-port to connect to. The port must be specified in its numeric form, but it
4279 must be passed as a string nonetheless. For example:
4280
4281   Port "3306"
4282
4283 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4284 See the documentation for the C<mysql_real_connect> function for details.
4285
4286 =item B<Socket> I<Socket>
4287
4288 Specifies the path to the UNIX domain socket of the MySQL server. This option
4289 only has any effect, if B<Host> is set to B<localhost> (the default).
4290 Otherwise, use the B<Port> option above. See the documentation for the
4291 C<mysql_real_connect> function for details.
4292
4293 =item B<InnodbStats> I<true|false>
4294
4295 If enabled, metrics about the InnoDB storage engine are collected.
4296 Disabled by default.
4297
4298 =item B<MasterStats> I<true|false>
4299
4300 =item B<SlaveStats> I<true|false>
4301
4302 Enable the collection of master / slave statistics in a replication setup. In
4303 order to be able to get access to these statistics, the user needs special
4304 privileges. See the B<User> documentation above. Defaults to B<false>.
4305
4306 =item B<SlaveNotifications> I<true|false>
4307
4308 If enabled, the plugin sends a notification if the replication slave I/O and /
4309 or SQL threads are not running. Defaults to B<false>.
4310
4311 =item B<WsrepStats> I<true|false>
4312
4313  Enable the collection of wsrep plugin statistics, used in Master-Master
4314  replication setups like in MySQL Galera/Percona XtraDB Cluster.
4315  User needs only privileges to execute 'SHOW GLOBAL STATUS'
4316
4317 =item B<ConnectTimeout> I<Seconds>
4318
4319 Sets the connect timeout for the MySQL client.
4320
4321 =item B<SSLKey> I<Path>
4322
4323 If provided, the X509 key in PEM format.
4324
4325 =item B<SSLCert> I<Path>
4326
4327 If provided, the X509 cert in PEM format.
4328
4329 =item B<SSLCA> I<Path>
4330
4331 If provided, the CA file in PEM format (check OpenSSL docs).
4332
4333 =item B<SSLCAPath> I<Path>
4334
4335 If provided, the CA directory (check OpenSSL docs).
4336
4337 =item B<SSLCipher> I<String>
4338
4339 If provided, the SSL cipher to use.
4340
4341 =back
4342
4343 =head2 Plugin C<netapp>
4344
4345 The netapp plugin can collect various performance and capacity information
4346 from a NetApp filer using the NetApp API.
4347
4348 Please note that NetApp has a wide line of products and a lot of different
4349 software versions for each of these products. This plugin was developed for a
4350 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4351 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4352 model and software version but it is very hard to test this.
4353 If you have used this plugin with other models and/or software version, feel
4354 free to send us a mail to tell us about the results, even if it's just a short
4355 "It works".
4356
4357 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4358 basic authentication.
4359
4360 B<Do not use a regular user for this!> Create a special collectd user with just
4361 the minimum of capabilities needed. The user only needs the "login-http-admin"
4362 capability as well as a few more depending on which data will be collected.
4363 Required capabilities are documented below.
4364
4365 =head3 Synopsis
4366
4367  <Plugin "netapp">
4368    <Host "netapp1.example.com">
4369     Protocol      "https"
4370     Address       "10.0.0.1"
4371     Port          443
4372     User          "username"
4373     Password      "aef4Aebe"
4374     Interval      30
4375
4376     <WAFL>
4377       Interval 30
4378       GetNameCache   true
4379       GetDirCache    true
4380       GetBufferCache true
4381       GetInodeCache  true
4382     </WAFL>
4383
4384     <Disks>
4385       Interval 30
4386       GetBusy true
4387     </Disks>
4388
4389     <VolumePerf>
4390       Interval 30
4391       GetIO      "volume0"
4392       IgnoreSelectedIO      false
4393       GetOps     "volume0"
4394       IgnoreSelectedOps     false
4395       GetLatency "volume0"
4396       IgnoreSelectedLatency false
4397     </VolumePerf>
4398
4399     <VolumeUsage>
4400       Interval 30
4401       GetCapacity "vol0"
4402       GetCapacity "vol1"
4403       IgnoreSelectedCapacity false
4404       GetSnapshot "vol1"
4405       GetSnapshot "vol3"
4406       IgnoreSelectedSnapshot false
4407     </VolumeUsage>
4408
4409     <Quota>
4410       Interval 60
4411     </Quota>
4412
4413     <Snapvault>
4414       Interval 30
4415     </Snapvault>
4416
4417     <System>
4418       Interval 30
4419       GetCPULoad     true
4420       GetInterfaces  true
4421       GetDiskOps     true
4422       GetDiskIO      true
4423     </System>
4424
4425     <VFiler vfilerA>
4426       Interval 60
4427
4428       SnapVault true
4429       # ...
4430     </VFiler>
4431    </Host>
4432  </Plugin>
4433
4434 The netapp plugin accepts the following configuration options:
4435
4436 =over 4
4437
4438 =item B<Host> I<Name>
4439
4440 A host block defines one NetApp filer. It will appear in collectd with the name
4441 you specify here which does not have to be its real name nor its hostname (see
4442 the B<Address> option below).
4443
4444 =item B<VFiler> I<Name>
4445
4446 A B<VFiler> block may only be used inside a host block. It accepts all the
4447 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4448 will execute all NetApp API commands in the context of the specified
4449 VFiler(R). It will appear in collectd with the name you specify here which
4450 does not have to be its real name. The VFiler name may be specified using the
4451 B<VFilerName> option. If this is not specified, it will default to the name
4452 you specify here.
4453
4454 The VFiler block inherits all connection related settings from the surrounding
4455 B<Host> block (which appear before the B<VFiler> block) but they may be
4456 overwritten inside the B<VFiler> block.
4457
4458 This feature is useful, for example, when using a VFiler as SnapVault target
4459 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4460 available in the host filer (vfiler0) but only in the respective VFiler
4461 context.
4462
4463 =item B<Protocol> B<httpd>|B<http>
4464
4465 The protocol collectd will use to query this host.
4466
4467 Optional
4468
4469 Type: string
4470
4471 Default: https
4472
4473 Valid options: http, https
4474
4475 =item B<Address> I<Address>
4476
4477 The hostname or IP address of the host.
4478
4479 Optional
4480
4481 Type: string
4482
4483 Default: The "host" block's name.
4484
4485 =item B<Port> I<Port>
4486
4487 The TCP port to connect to on the host.
4488
4489 Optional
4490
4491 Type: integer
4492
4493 Default: 80 for protocol "http", 443 for protocol "https"
4494
4495 =item B<User> I<User>
4496
4497 =item B<Password> I<Password>
4498
4499 The username and password to use to login to the NetApp.
4500
4501 Mandatory
4502
4503 Type: string
4504
4505 =item B<VFilerName> I<Name>
4506
4507 The name of the VFiler in which context to execute API commands. If not
4508 specified, the name provided to the B<VFiler> block will be used instead.
4509
4510 Optional
4511
4512 Type: string
4513
4514 Default: name of the B<VFiler> block
4515
4516 B<Note:> This option may only be used inside B<VFiler> blocks.
4517
4518 =item B<Interval> I<Interval>
4519
4520 B<TODO>
4521
4522 =back
4523
4524 The following options decide what kind of data will be collected. You can
4525 either use them as a block and fine tune various parameters inside this block,
4526 use them as a single statement to just accept all default values, or omit it to
4527 not collect any data.
4528
4529 The following options are valid inside all blocks:
4530
4531 =over 4
4532
4533 =item B<Interval> I<Seconds>
4534
4535 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4536 host specific setting.
4537
4538 =back
4539
4540 =head3 The System block
4541
4542 This will collect various performance data about the whole system.
4543
4544 B<Note:> To get this data the collectd user needs the
4545 "api-perf-object-get-instances" capability.
4546
4547 =over 4
4548
4549 =item B<Interval> I<Seconds>
4550
4551 Collect disk statistics every I<Seconds> seconds.
4552
4553 =item B<GetCPULoad> B<true>|B<false>
4554
4555 If you set this option to true the current CPU usage will be read. This will be
4556 the average usage between all CPUs in your NetApp without any information about
4557 individual CPUs.
4558
4559 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4560 returns in the "CPU" field.
4561
4562 Optional
4563
4564 Type: boolean
4565
4566 Default: true
4567
4568 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4569
4570 =item B<GetInterfaces> B<true>|B<false>
4571
4572 If you set this option to true the current traffic of the network interfaces
4573 will be read. This will be the total traffic over all interfaces of your NetApp
4574 without any information about individual interfaces.
4575
4576 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4577 in the "Net kB/s" field.
4578
4579 B<Or is it?>
4580
4581 Optional
4582
4583 Type: boolean
4584
4585 Default: true
4586
4587 Result: One value list of type "if_octects".
4588
4589 =item B<GetDiskIO> B<true>|B<false>
4590
4591 If you set this option to true the current IO throughput will be read. This
4592 will be the total IO of your NetApp without any information about individual
4593 disks, volumes or aggregates.
4594
4595 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4596 in the "DiskE<nbsp>kB/s" field.
4597
4598 Optional
4599
4600 Type: boolean
4601
4602 Default: true
4603
4604 Result: One value list of type "disk_octets".
4605
4606 =item B<GetDiskOps> B<true>|B<false>
4607
4608 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4609 iSCSI, etc. operations will be read. This will be the total number of
4610 operations on your NetApp without any information about individual volumes or
4611 aggregates.
4612
4613 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4614 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4615
4616 Optional
4617
4618 Type: boolean
4619
4620 Default: true
4621
4622 Result: A variable number of value lists of type "disk_ops_complex". Each type
4623 of operation will result in one value list with the name of the operation as
4624 type instance.
4625
4626 =back
4627
4628 =head3 The WAFL block
4629
4630 This will collect various performance data about the WAFL file system. At the
4631 moment this just means cache performance.
4632
4633 B<Note:> To get this data the collectd user needs the
4634 "api-perf-object-get-instances" capability.
4635
4636 B<Note:> The interface to get these values is classified as "Diagnostics" by
4637 NetApp. This means that it is not guaranteed to be stable even between minor
4638 releases.
4639
4640 =over 4
4641
4642 =item B<Interval> I<Seconds>
4643
4644 Collect disk statistics every I<Seconds> seconds.
4645
4646 =item B<GetNameCache> B<true>|B<false>
4647
4648 Optional
4649
4650 Type: boolean
4651
4652 Default: true
4653
4654 Result: One value list of type "cache_ratio" and type instance
4655 "name_cache_hit".
4656
4657 =item B<GetDirCache> B<true>|B<false>
4658
4659 Optional
4660
4661 Type: boolean
4662
4663 Default: true
4664
4665 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4666
4667 =item B<GetInodeCache> B<true>|B<false>
4668
4669 Optional
4670
4671 Type: boolean
4672
4673 Default: true
4674
4675 Result: One value list of type "cache_ratio" and type instance
4676 "inode_cache_hit".
4677
4678 =item B<GetBufferCache> B<true>|B<false>
4679
4680 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4681 in the "Cache hit" field.
4682
4683 Optional
4684
4685 Type: boolean
4686
4687 Default: true
4688
4689 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4690
4691 =back
4692
4693 =head3 The Disks block
4694
4695 This will collect performance data about the individual disks in the NetApp.
4696
4697 B<Note:> To get this data the collectd user needs the
4698 "api-perf-object-get-instances" capability.
4699
4700 =over 4
4701
4702 =item B<Interval> I<Seconds>
4703
4704 Collect disk statistics every I<Seconds> seconds.
4705
4706 =item B<GetBusy> B<true>|B<false>
4707
4708 If you set this option to true the busy time of all disks will be calculated
4709 and the value of the busiest disk in the system will be written.
4710
4711 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4712 in the "Disk util" field. Probably.
4713
4714 Optional
4715
4716 Type: boolean
4717
4718 Default: true
4719
4720 Result: One value list of type "percent" and type instance "disk_busy".
4721
4722 =back
4723
4724 =head3 The VolumePerf block
4725
4726 This will collect various performance data about the individual volumes.
4727
4728 You can select which data to collect about which volume using the following
4729 options. They follow the standard ignorelist semantic.
4730
4731 B<Note:> To get this data the collectd user needs the
4732 I<api-perf-object-get-instances> capability.
4733
4734 =over 4
4735
4736 =item B<Interval> I<Seconds>
4737
4738 Collect volume performance data every I<Seconds> seconds.
4739
4740 =item B<GetIO> I<Volume>
4741
4742 =item B<GetOps> I<Volume>
4743
4744 =item B<GetLatency> I<Volume>
4745
4746 Select the given volume for IO, operations or latency statistics collection.
4747 The argument is the name of the volume without the C</vol/> prefix.
4748
4749 Since the standard ignorelist functionality is used here, you can use a string
4750 starting and ending with a slash to specify regular expression matching: To
4751 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4752 expression:
4753
4754   GetIO "/^vol[027]$/"
4755
4756 If no regular expression is specified, an exact match is required. Both,
4757 regular and exact matching are case sensitive.
4758
4759 If no volume was specified at all for either of the three options, that data
4760 will be collected for all available volumes.
4761
4762 See F</"IGNORELISTS"> for details.
4763
4764 =item B<IgnoreSelectedIO> B<true>|B<false>
4765
4766 =item B<IgnoreSelectedOps> B<true>|B<false>
4767
4768 =item B<IgnoreSelectedLatency> B<true>|B<false>
4769
4770 When set to B<true>, the volumes selected for IO, operations or latency
4771 statistics collection will be ignored and the data will be collected for all
4772 other volumes.
4773
4774 When set to B<false>, data will only be collected for the specified volumes and
4775 all other volumes will be ignored.
4776
4777 If no volumes have been specified with the above B<Get*> options, all volumes
4778 will be collected regardless of the B<IgnoreSelected*> option.
4779
4780 Defaults to B<false>
4781
4782 =back
4783
4784 =head3 The VolumeUsage block
4785
4786 This will collect capacity data about the individual volumes.
4787
4788 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4789 capability.
4790
4791 =over 4
4792
4793 =item B<Interval> I<Seconds>
4794
4795 Collect volume usage statistics every I<Seconds> seconds.
4796
4797 =item B<GetCapacity> I<VolumeName>
4798
4799 The current capacity of the volume will be collected. This will result in two
4800 to four value lists, depending on the configuration of the volume. All data
4801 sources are of type "df_complex" with the name of the volume as
4802 plugin_instance.
4803
4804 There will be type_instances "used" and "free" for the number of used and
4805 available bytes on the volume.  If the volume has some space reserved for
4806 snapshots, a type_instance "snap_reserved" will be available.  If the volume
4807 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4808 number of bytes saved by the SIS feature.
4809
4810 B<Note:> The current NetApp API has a bug that results in this value being
4811 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4812 number which works most of the time.  If you see strange values here, bug
4813 NetApp support to fix this.
4814
4815 Repeat this option to specify multiple volumes.
4816
4817 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4818
4819 Specify whether to collect only the volumes selected by the B<GetCapacity>
4820 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4821 B<false>. However, if no B<GetCapacity> option is specified at all, all
4822 capacities will be selected anyway.
4823
4824 =item B<GetSnapshot> I<VolumeName>
4825
4826 Select volumes from which to collect snapshot information.
4827
4828 Usually, the space used for snapshots is included in the space reported as
4829 "used". If snapshot information is collected as well, the space used for
4830 snapshots is subtracted from the used space.
4831
4832 To make things even more interesting, it is possible to reserve space to be
4833 used for snapshots. If the space required for snapshots is less than that
4834 reserved space, there is "reserved free" and "reserved used" space in addition
4835 to "free" and "used". If the space required for snapshots exceeds the reserved
4836 space, that part allocated in the normal space is subtracted from the "used"
4837 space again.
4838
4839 Repeat this option to specify multiple volumes.
4840
4841 =item B<IgnoreSelectedSnapshot>
4842
4843 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4844 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4845 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4846 capacities will be selected anyway.
4847
4848 =back
4849
4850 =head3 The Quota block
4851
4852 This will collect (tree) quota statistics (used disk space and number of used
4853 files). This mechanism is useful to get usage information for single qtrees.
4854 In case the quotas are not used for any other purpose, an entry similar to the
4855 following in C</etc/quotas> would be sufficient:
4856
4857   /vol/volA/some_qtree tree - - - - -
4858
4859 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4860
4861 =over 4
4862
4863 =item B<Interval> I<Seconds>
4864
4865 Collect SnapVault(R) statistics every I<Seconds> seconds.
4866
4867 =back
4868
4869 =head3 The SnapVault block
4870
4871 This will collect statistics about the time and traffic of SnapVault(R)
4872 transfers.
4873
4874 =over 4
4875
4876 =item B<Interval> I<Seconds>
4877
4878 Collect SnapVault(R) statistics every I<Seconds> seconds.
4879
4880 =back
4881
4882 =head2 Plugin C<netlink>
4883
4884 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4885 statistics of various interface and routing aspects.
4886
4887 =over 4
4888
4889 =item B<Interface> I<Interface>
4890
4891 =item B<VerboseInterface> I<Interface>
4892
4893 Instruct the plugin to collect interface statistics. This is basically the same
4894 as the statistics provided by the C<interface> plugin (see above) but
4895 potentially much more detailed.
4896
4897 When configuring with B<Interface> only the basic statistics will be collected,
4898 namely octets, packets, and errors. These statistics are collected by
4899 the C<interface> plugin, too, so using both at the same time is no benefit.
4900
4901 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4902 so that no data needs to be collected twice if you use the C<interface> plugin.
4903 This includes dropped packets, received multicast packets, collisions and a
4904 whole zoo of differentiated RX and TX errors. You can try the following command
4905 to get an idea of what awaits you:
4906
4907   ip -s -s link list
4908
4909 If I<Interface> is B<All>, all interfaces will be selected.
4910
4911 =item B<QDisc> I<Interface> [I<QDisc>]
4912
4913 =item B<Class> I<Interface> [I<Class>]
4914
4915 =item B<Filter> I<Interface> [I<Filter>]
4916
4917 Collect the octets and packets that pass a certain qdisc, class or filter.
4918
4919 QDiscs and classes are identified by their type and handle (or classid).
4920 Filters don't necessarily have a handle, therefore the parent's handle is used.
4921 The notation used in collectd differs from that used in tc(1) in that it
4922 doesn't skip the major or minor number if it's zero and doesn't print special
4923 ids by their name. So, for example, a qdisc may be identified by
4924 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4925 thus not displayed by tc(1).
4926
4927 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4928 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4929 associated with that interface will be collected.
4930
4931 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4932 used. This may lead to problems when more than one filter is attached to a
4933 qdisc or class. This isn't nice, but we don't know how this could be done any
4934 better. If you have a idea, please don't hesitate to tell us.
4935
4936 As with the B<Interface> option you can specify B<All> as the interface,
4937 meaning all interfaces.
4938
4939 Here are some examples to help you understand the above text more easily:
4940
4941   <Plugin netlink>
4942     VerboseInterface "All"
4943     QDisc "eth0" "pfifo_fast-1:0"
4944     QDisc "ppp0"
4945     Class "ppp0" "htb-1:10"
4946     Filter "ppp0" "u32-1:0"
4947   </Plugin>
4948
4949 See F</"IGNORELISTS"> for details.
4950
4951 =item B<IgnoreSelected>
4952
4953 The behavior is the same as with all other similar plugins: If nothing is
4954 selected at all, everything is collected. If some things are selected using the
4955 options described above, only these statistics are collected. If you set
4956 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4957 specified statistics will not be collected.
4958
4959 =back
4960
4961 =head2 Plugin C<network>
4962
4963 The Network plugin sends data to a remote instance of collectd, receives data
4964 from a remote instance, or both at the same time. Data which has been received
4965 from the network is usually not transmitted again, but this can be activated, see
4966 the B<Forward> option below.
4967
4968 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4969 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4970
4971 Both, B<Server> and B<Listen> can be used as single option or as block. When
4972 used as block, given options are valid for this socket only. The following
4973 example will export the metrics twice: Once to an "internal" server (without
4974 encryption and signing) and one to an external server (with cryptographic
4975 signature):
4976
4977  <Plugin "network">
4978    # Export to an internal server
4979    # (demonstrates usage without additional options)
4980    Server "collectd.internal.tld"
4981
4982    # Export to an external server
4983    # (demonstrates usage with signature options)
4984    <Server "collectd.external.tld">
4985      SecurityLevel "sign"
4986      Username "myhostname"
4987      Password "ohl0eQue"
4988    </Server>
4989  </Plugin>
4990
4991 =over 4
4992
4993 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4994
4995 The B<Server> statement/block sets the server to send datagrams to. The
4996 statement may occur multiple times to send each datagram to multiple
4997 destinations.
4998
4999 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5000 optional second argument specifies a port number or a service name. If not
5001 given, the default, B<25826>, is used.
5002
5003 The following options are recognized within B<Server> blocks:
5004
5005 =over 4
5006
5007 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5008
5009 Set the security you require for network communication. When the security level
5010 has been set to B<Encrypt>, data sent over the network will be encrypted using
5011 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5012 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5013 authentication code. When set to B<None>, data is sent without any security.
5014
5015 This feature is only available if the I<network> plugin was linked with
5016 I<libgcrypt>.
5017
5018 =item B<Username> I<Username>
5019
5020 Sets the username to transmit. This is used by the server to lookup the
5021 password. See B<AuthFile> below. All security levels except B<None> require
5022 this setting.
5023
5024 This feature is only available if the I<network> plugin was linked with
5025 I<libgcrypt>.
5026
5027 =item B<Password> I<Password>
5028
5029 Sets a password (shared secret) for this socket. All security levels except
5030 B<None> require this setting.
5031
5032 This feature is only available if the I<network> plugin was linked with
5033 I<libgcrypt>.
5034
5035 =item B<Interface> I<Interface name>
5036
5037 Set the outgoing interface for IP packets. This applies at least
5038 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5039 undefined or a non-existent interface name is specified, the default
5040 behavior is to let the kernel choose the appropriate interface. Be warned
5041 that the manual selection of an interface for unicast traffic is only
5042 necessary in rare cases.
5043
5044 =item B<ResolveInterval> I<Seconds>
5045
5046 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5047 useful to force a regular DNS lookup to support a high availability setup. If
5048 not specified, re-resolves are never attempted.
5049
5050 =back
5051
5052 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5053
5054 The B<Listen> statement sets the interfaces to bind to. When multiple
5055 statements are found the daemon will bind to multiple interfaces.
5056
5057 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5058 the argument is a multicast address the daemon will join that multicast group.
5059 The optional second argument specifies a port number or a service name. If not
5060 given, the default, B<25826>, is used.
5061
5062 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5063
5064 =over 4
5065
5066 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5067
5068 Set the security you require for network communication. When the security level
5069 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5070 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5071 signed and encrypted data is accepted. When set to B<None>, all data will be
5072 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5073 decrypted if possible.
5074
5075 This feature is only available if the I<network> plugin was linked with
5076 I<libgcrypt>.
5077
5078 =item B<AuthFile> I<Filename>
5079
5080 Sets a file in which usernames are mapped to passwords. These passwords are
5081 used to verify signatures and to decrypt encrypted network packets. If
5082 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5083 verified and encrypted packets are decrypted. Otherwise, signed data is
5084 accepted without checking the signature and encrypted data cannot be decrypted.
5085 For the other security levels this option is mandatory.
5086
5087 The file format is very simple: Each line consists of a username followed by a
5088 colon and any number of spaces followed by the password. To demonstrate, an
5089 example file could look like this:
5090
5091   user0: foo
5092   user1: bar
5093
5094 Each time a packet is received, the modification time of the file is checked
5095 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5096 the file is being read, it is locked using L<fcntl(2)>.
5097
5098 =item B<Interface> I<Interface name>
5099
5100 Set the incoming interface for IP packets explicitly. This applies at least
5101 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5102 undefined or a non-existent interface name is specified, the default
5103 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5104 traffic gets only accepted, if it arrives on the given interface.
5105
5106 =back
5107
5108 =item B<TimeToLive> I<1-255>
5109
5110 Set the time-to-live of sent packets. This applies to all, unicast and
5111 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5112 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5113 operating systems.
5114
5115 =item B<MaxPacketSize> I<1024-65535>
5116
5117 Set the maximum size for datagrams received over the network. Packets larger
5118 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5119 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5120 UDP.
5121
5122 On the server side, this limit should be set to the largest value used on
5123 I<any> client. Likewise, the value on the client must not be larger than the
5124 value on the server, or data will be lost.
5125
5126 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5127 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5128 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5129 server.
5130
5131 =item B<Forward> I<true|false>
5132
5133 If set to I<true>, write packets that were received via the network plugin to
5134 the sending sockets. This should only be activated when the B<Listen>- and
5135 B<Server>-statements differ. Otherwise packets may be send multiple times to
5136 the same multicast group. While this results in more network traffic than
5137 necessary it's not a huge problem since the plugin has a duplicate detection,
5138 so the values will not loop.
5139
5140 =item B<ReportStats> B<true>|B<false>
5141
5142 The network plugin cannot only receive and send statistics, it can also create
5143 statistics about itself. Collectd data included the number of received and
5144 sent octets and packets, the length of the receive queue and the number of
5145 values handled. When set to B<true>, the I<Network plugin> will make these
5146 statistics available. Defaults to B<false>.
5147
5148 =back
5149
5150 =head2 Plugin C<nginx>
5151
5152 This plugin collects the number of connections and requests handled by the
5153 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5154 queries the page provided by the C<ngx_http_stub_status_module> module, which
5155 isn't compiled by default. Please refer to
5156 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5157 how to compile and configure nginx and this module.
5158
5159 The following options are accepted by the C<nginx plugin>:
5160
5161 =over 4
5162
5163 =item B<URL> I<http://host/nginx_status>
5164
5165 Sets the URL of the C<ngx_http_stub_status_module> output.
5166
5167 =item B<User> I<Username>
5168
5169 Optional user name needed for authentication.
5170
5171 =item B<Password> I<Password>
5172
5173 Optional password needed for authentication.
5174
5175 =item B<VerifyPeer> B<true|false>
5176
5177 Enable or disable peer SSL certificate verification. See
5178 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5179
5180 =item B<VerifyHost> B<true|false>
5181
5182 Enable or disable peer host name verification. If enabled, the plugin checks
5183 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5184 certificate matches the host name provided by the B<URL> option. If this
5185 identity check fails, the connection is aborted. Obviously, only works when
5186 connecting to a SSL enabled server. Enabled by default.
5187
5188 =item B<CACert> I<File>
5189
5190 File that holds one or more SSL certificates. If you want to use HTTPS you will
5191 possibly need this option. What CA certificates come bundled with C<libcurl>
5192 and are checked by default depends on the distribution you use.
5193
5194 =item B<Timeout> I<Milliseconds>
5195
5196 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5197 milliseconds. By default, the configured B<Interval> is used to set the
5198 timeout.
5199
5200 =back
5201
5202 =head2 Plugin C<notify_desktop>
5203
5204 This plugin sends a desktop notification to a notification daemon, as defined
5205 in the Desktop Notification Specification. To actually display the
5206 notifications, B<notification-daemon> is required and B<collectd> has to be
5207 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5208 environment variables have to be set correctly) and the D-Bus message bus.
5209
5210 The Desktop Notification Specification can be found at
5211 L<http://www.galago-project.org/specs/notification/>.
5212
5213 =over 4
5214
5215 =item B<OkayTimeout> I<timeout>
5216
5217 =item B<WarningTimeout> I<timeout>
5218
5219 =item B<FailureTimeout> I<timeout>
5220
5221 Set the I<timeout>, in milliseconds, after which to expire the notification
5222 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5223 been specified, the displayed notification will not be closed at all - the
5224 user has to do so herself. These options default to 5000. If a negative number
5225 has been specified, the default is used as well.
5226
5227 =back
5228
5229 =head2 Plugin C<notify_email>
5230
5231 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5232 configured email address.
5233
5234 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5235
5236 Available configuration options:
5237
5238 =over 4
5239
5240 =item B<From> I<Address>
5241
5242 Email address from which the emails should appear to come from.
5243
5244 Default: C<root@localhost>
5245
5246 =item B<Recipient> I<Address>
5247
5248 Configures the email address(es) to which the notifications should be mailed.
5249 May be repeated to send notifications to multiple addresses.
5250
5251 At least one B<Recipient> must be present for the plugin to work correctly.
5252
5253 =item B<SMTPServer> I<Hostname>
5254
5255 Hostname of the SMTP server to connect to.
5256
5257 Default: C<localhost>
5258
5259 =item B<SMTPPort> I<Port>
5260
5261 TCP port to connect to.
5262
5263 Default: C<25>
5264
5265 =item B<SMTPUser> I<Username>
5266
5267 Username for ASMTP authentication. Optional.
5268
5269 =item B<SMTPPassword> I<Password>
5270
5271 Password for ASMTP authentication. Optional.
5272
5273 =item B<Subject> I<Subject>
5274
5275 Subject-template to use when sending emails. There must be exactly two
5276 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5277 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5278 with the hostname.
5279
5280 Default: C<Collectd notify: %s@%s>
5281
5282 =back
5283
5284 =head2 Plugin C<notify_nagios>
5285
5286 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5287 a I<passive service check result>.
5288
5289 Available configuration options:
5290
5291 =over 4
5292
5293 =item B<CommandFile> I<Path>
5294
5295 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5296
5297 =back
5298
5299 =head2 Plugin C<ntpd>
5300
5301 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5302 dispersion.
5303
5304 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5305 the wire - using B<mode 7> specific requests. This mode is deprecated with
5306 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5307 correctly with them, the ntp daemon must be explicitly configured to
5308 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5309 manual page for details.
5310
5311 Available configuration options for the C<ntpd> plugin:
5312
5313 =over 4
5314
5315 =item B<Host> I<Hostname>
5316
5317 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5318
5319 =item B<Port> I<Port>
5320
5321 UDP-Port to connect to. Defaults to B<123>.
5322
5323 =item B<ReverseLookups> B<true>|B<false>
5324
5325 Sets whether or not to perform reverse lookups on peers. Since the name or
5326 IP-address may be used in a filename it is recommended to disable reverse
5327 lookups. The default is to do reverse lookups to preserve backwards
5328 compatibility, though.
5329
5330 =item B<IncludeUnitID> B<true>|B<false>
5331
5332 When a peer is a refclock, include the unit ID in the I<type instance>.
5333 Defaults to B<false> for backward compatibility.
5334
5335 If two refclock peers use the same driver and this is B<false>, the plugin will
5336 try to write simultaneous measurements from both to the same type instance.
5337 This will result in error messages in the log and only one set of measurements
5338 making it through.
5339
5340 =back
5341
5342 =head2 Plugin C<nut>
5343
5344 =over 4
5345
5346 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5347
5348 Add a UPS to collect data from. The format is identical to the one accepted by
5349 L<upsc(8)>.
5350
5351 =item B<ForceSSL> B<true>|B<false>
5352
5353 Stops connections from falling back to unsecured if an SSL connection
5354 cannot be established. Defaults to false if undeclared.
5355
5356 =item B<VerifyPeer> I<true>|I<false>
5357
5358 If set to true, requires a CAPath be provided. Will use the CAPath to find
5359 certificates to use as Trusted Certificates to validate a upsd server certificate.
5360 If validation of the upsd server certificate fails, the connection will not be
5361 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5362 will override and set ForceSSL to true.
5363
5364 =item B<CAPath> I/path/to/certs/folder
5365
5366 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5367 The folder pointed at must contain certificate(s) named according to their hash.
5368 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5369 occur because two different certs have the same hash value, Y can be  incremented
5370 in order to avoid conflict. To create a symbolic link to a certificate the following
5371 command can be used from within the directory where the cert resides:
5372
5373 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5374
5375 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5376 generate links like the one described above for ALL certs in a given folder.
5377 Example usage:
5378 C<c_rehash /path/to/certs/folder>
5379
5380 =item B<ConnectTimeout> I<Milliseconds>
5381
5382 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5383 By default, the configured B<Interval> is used to set the timeout.
5384
5385 =back
5386
5387 =head2 Plugin C<olsrd>
5388
5389 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5390 the Optimized Link State Routing daemon and reads information about the current
5391 state of the meshed network.
5392
5393 The following configuration options are understood:
5394
5395 =over 4
5396
5397 =item B<Host> I<Host>
5398
5399 Connect to I<Host>. Defaults to B<"localhost">.
5400
5401 =item B<Port> I<Port>
5402
5403 Specifies the port to connect to. This must be a string, even if you give the
5404 port as a number rather than a service name. Defaults to B<"2006">.
5405
5406 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5407
5408 Specifies what information to collect about links, i.E<nbsp>e. direct
5409 connections of the daemon queried. If set to B<No>, no information is
5410 collected. If set to B<Summary>, the number of links and the average of all
5411 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5412 If set to B<Detail> LQ and NLQ are collected per link.
5413
5414 Defaults to B<Detail>.
5415
5416 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5417
5418 Specifies what information to collect about routes of the daemon queried. If
5419 set to B<No>, no information is collected. If set to B<Summary>, the number of
5420 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5421 metric and ETX are collected per route.
5422
5423 Defaults to B<Summary>.
5424
5425 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5426
5427 Specifies what information to collect about the global topology. If set to
5428 B<No>, no information is collected. If set to B<Summary>, the number of links
5429 in the entire topology and the average I<link quality> (LQ) is calculated.
5430 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5431
5432 Defaults to B<Summary>.
5433
5434 =back
5435
5436 =head2 Plugin C<onewire>
5437
5438 B<EXPERIMENTAL!> See notes below.
5439
5440 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5441 L<http://owfs.org/> to read sensors connected via the onewire bus.
5442
5443 It can be used in two possible modes - standard or advanced.
5444
5445 In the standard mode only temperature sensors (sensors with the family code
5446 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5447 other sensors you would like to have included, please send a sort request to
5448 the mailing list. You can select sensors to be read or to be ignored depending
5449 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5450 walked and all sensors are read.
5451
5452 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5453 experimental, below.
5454
5455 In the advanced mode you can configure any sensor to be read (only numerical
5456 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5457 In this mode you have to list all the sensors. Neither default bus walk nor
5458 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5459 the path automatically and should produce compatible structure with the "standard"
5460 mode (basically the path is expected as for example
5461 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5462 "F10FCA000800" and the rest after the slash is considered the type - here
5463 "temperature").
5464 There are two advantages to this mode - you can access virtually any sensor
5465 (not just temperature), select whether to use cached or directly read values
5466 and it is slighlty faster. The downside is more complex configuration.
5467
5468 The two modes are distinguished automatically by the format of the address.
5469 It is not possible to mix the two modes. Once a full path is detected in any
5470 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5471 (and as standard addresses will fail parsing they will be ignored).
5472
5473 =over 4
5474
5475 =item B<Device> I<Device>
5476
5477 Sets the device to read the values from. This can either be a "real" hardware
5478 device, such as a serial port or an USB port, or the address of the
5479 L<owserver(1)> socket, usually B<localhost:4304>.
5480
5481 Though the documentation claims to automatically recognize the given address
5482 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5483 with that version, the following configuration worked for us:
5484
5485   <Plugin onewire>
5486     Device "-s localhost:4304"
5487   </Plugin>
5488
5489 This directive is B<required> and does not have a default value.
5490
5491 =item B<Sensor> I<Sensor>
5492
5493 In the standard mode selects sensors to collect or to ignore
5494 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5495 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5496 and B<not> include the leading C<10.> family byte and point.
5497 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5498 sensors (see above) are read.
5499
5500 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5501 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5502 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5503
5504 As there can be multiple devices on the bus you can list multiple sensor (use
5505 multiple B<Sensor> elements).
5506
5507 See F</"IGNORELISTS"> for details.
5508
5509 =item B<IgnoreSelected> I<true>|I<false>
5510
5511 If no configuration is given, the B<onewire> plugin will collect data from all
5512 sensors found. This may not be practical, especially if sensors are added and
5513 removed regularly. Sometimes, however, it's easier/preferred to collect only
5514 specific sensors or all sensors I<except> a few specified ones. This option
5515 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5516 B<Sensor> is inverted: All selected interfaces are ignored and all other
5517 interfaces are collected.
5518
5519 Used only in the standard mode - see above.
5520
5521 =item B<Interval> I<Seconds>
5522
5523 Sets the interval in which all sensors should be read. If not specified, the
5524 global B<Interval> setting is used.
5525
5526 =back
5527
5528 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5529 work with big setups. It works with one sensor being attached to one
5530 controller, but as soon as you throw in a couple more senors and maybe a hub
5531 or two, reading all values will take more than ten seconds (the default
5532 interval). We will probably add some separate thread for reading the sensors
5533 and some cache or something like that, but it's not done yet. We will try to
5534 maintain backwards compatibility in the future, but we can't promise. So in
5535 short: If it works for you: Great! But keep in mind that the config I<might>
5536 change, though this is unlikely. Oh, and if you want to help improving this
5537 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5538
5539 =head2 Plugin C<openldap>
5540
5541 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5542 server correctly. The backend database C<monitor> needs to be loaded and
5543 working. See slapd-monitor(5) for the details.
5544
5545 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5546 blocks. Each block requires one string argument as the instance name. For
5547 example:
5548
5549  <Plugin "openldap">
5550    <Instance "foo">
5551      URL "ldap://localhost/"
5552    </Instance>
5553    <Instance "bar">
5554      URL "ldaps://localhost/"
5555    </Instance>
5556  </Plugin>
5557
5558 The instance name will be used as the I<plugin instance>. To emulate the old
5559 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5560 plugin to work correctly, each instance name must be unique. This is not
5561 enforced by the plugin and it is your responsibility to ensure it is.
5562
5563 The following options are accepted within each B<Instance> block:
5564
5565 =over 4
5566
5567 =item B<URL> I<ldap://host/binddn>
5568
5569 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5570 I<mandatory>.
5571
5572 =item B<BindDN> I<BindDN>
5573
5574 Name in the form of an LDAP distinguished name intended to be used for
5575 authentication. Defaults to empty string to establish an anonymous authorization.
5576
5577 =item B<Password> I<Password>
5578
5579 Password for simple bind authentication. If this option is not set,
5580 unauthenticated bind operation is used.
5581
5582 =item B<StartTLS> B<true|false>
5583
5584 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5585 Disabled by default.
5586
5587 =item B<VerifyHost> B<true|false>
5588
5589 Enables or disables peer host name verification. If enabled, the plugin checks
5590 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5591 certificate matches the host name provided by the B<URL> option. If this
5592 identity check fails, the connection is aborted. Enabled by default.
5593
5594 =item B<CACert> I<File>
5595
5596 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5597 may possibly need this option. What CA certificates are checked by default
5598 depends on the distribution you use and can be changed with the usual ldap
5599 client configuration mechanisms. See ldap.conf(5) for the details.
5600
5601 =item B<Timeout> I<Seconds>
5602
5603 Sets the timeout value for ldap operations, in seconds. By default, the
5604 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5605 (infinite timeout).
5606
5607 =item B<Version> I<Version>
5608
5609 An integer which sets the LDAP protocol version number to use when connecting
5610 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5611
5612 =back
5613
5614 =head2 Plugin C<openvpn>
5615
5616 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5617 traffic statistics about connected clients.
5618
5619 To set up OpenVPN to write to the status file periodically, use the
5620 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
5621 you need to set the required format, too. This is done by setting
5622 B<--status-version> to B<2>.
5623
5624 So, in a nutshell you need:
5625
5626   openvpn $OTHER_OPTIONS \
5627     --status "/var/run/openvpn-status" 10 \
5628     --status-version 2
5629
5630 Available options:
5631
5632 =over 4
5633
5634 =item B<StatusFile> I<File>
5635
5636 Specifies the location of the status file.
5637
5638 =item B<ImprovedNamingSchema> B<true>|B<false>
5639
5640 When enabled, the filename of the status file will be used as plugin instance
5641 and the client's "common name" will be used as type instance. This is required
5642 when reading multiple status files. Enabling this option is recommended, but to
5643 maintain backwards compatibility this option is disabled by default.
5644
5645 =item B<CollectCompression> B<true>|B<false>
5646
5647 Sets whether or not statistics about the compression used by OpenVPN should be
5648 collected. This information is only available in I<single> mode. Enabled by
5649 default.
5650
5651 =item B<CollectIndividualUsers> B<true>|B<false>
5652
5653 Sets whether or not traffic information is collected for each connected client
5654 individually. If set to false, currently no traffic data is collected at all
5655 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5656
5657 =item B<CollectUserCount> B<true>|B<false>
5658
5659 When enabled, the number of currently connected clients or users is collected.
5660 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5661 can be configured independently from that option. Defaults to B<false>.
5662
5663 =back
5664
5665 =head2 Plugin C<oracle>
5666
5667 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5668 Oracle® Database and lets you execute SQL statements there. It is very similar
5669 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5670 plugin's documentation above for details.
5671
5672   <Plugin oracle>
5673     <Query "out_of_stock">
5674       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5675       <Result>
5676         Type "gauge"
5677         # InstancePrefix "foo"
5678         InstancesFrom "category"
5679         ValuesFrom "value"
5680       </Result>
5681     </Query>
5682     <Database "product_information">
5683       ConnectID "db01"
5684       Username "oracle"
5685       Password "secret"
5686       Query "out_of_stock"
5687     </Database>
5688   </Plugin>
5689
5690 =head3 B<Query> blocks
5691
5692 The Query blocks are handled identically to the Query blocks of the "dbi"
5693 plugin. Please see its documentation above for details on how to specify
5694 queries.
5695
5696 =head3 B<Database> blocks
5697
5698 Database blocks define a connection to a database and which queries should be
5699 sent to that database. Each database needs a "name" as string argument in the
5700 starting tag of the block. This name will be used as "PluginInstance" in the
5701 values submitted to the daemon. Other than that, that name is not used.
5702
5703 =over 4
5704
5705 =item B<ConnectID> I<ID>
5706
5707 Defines the "database alias" or "service name" to connect to. Usually, these
5708 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5709
5710 =item B<Host> I<Host>
5711
5712 Hostname to use when dispatching values for this database. Defaults to using
5713 the global hostname of the I<collectd> instance.
5714
5715 =item B<Username> I<Username>
5716
5717 Username used for authentication.
5718
5719 =item B<Password> I<Password>
5720
5721 Password used for authentication.
5722
5723 =item B<Query> I<QueryName>
5724
5725 Associates the query named I<QueryName> with this database connection. The
5726 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5727 blocks you want to refer to must be placed above the database block you want to
5728 refer to them from.
5729
5730 =back
5731
5732 =head2 Plugin C<ovs_events>
5733
5734 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5735 connected interfaces, dispatches the values to collectd and sends the
5736 notification whenever the link state change occurs. This plugin uses OVS
5737 database to get a link state change notification.
5738
5739 B<Synopsis:>
5740
5741  <Plugin "ovs_events">
5742    Port 6640
5743    Address "127.0.0.1"
5744    Socket "/var/run/openvswitch/db.sock"
5745    Interfaces "br0" "veth0"
5746    SendNotification true
5747    DispatchValues false
5748  </Plugin>
5749
5750 The plugin provides the following configuration options:
5751
5752 =over 4
5753
5754 =item B<Address> I<node>
5755
5756 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5757 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5758 option. See L<ovsdb-server(1)> for more details. The option may be either
5759 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5760 format. Defaults to B<'localhost'>.
5761
5762 =item B<Port> I<service>
5763
5764 TCP-port to connect to. Either a service name or a port number may be given.
5765 Defaults to B<6640>.
5766
5767 =item B<Socket> I<path>
5768
5769 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5770 plugin. To enable the interface, the OVS DB daemon should be running with
5771 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5772 option is set, B<Address> and B<Port> options are ignored.
5773
5774 =item B<Interfaces> [I<ifname> ...]
5775
5776 List of interface names to be monitored by this plugin. If this option is not
5777 specified or is empty then all OVS connected interfaces on all bridges are
5778 monitored.
5779
5780 Default: empty (all interfaces on all bridges are monitored)
5781
5782 =item B<SendNotification> I<true|false>
5783
5784 If set to true, OVS link notifications (interface status and OVS DB connection
5785 terminate) are sent to collectd. Default value is true.
5786
5787 =item B<DispatchValues> I<true|false>
5788
5789 Dispatch the OVS DB interface link status value with configured plugin interval.
5790 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
5791 options are false, no OVS information will be provided by the plugin.
5792
5793 =back
5794
5795 B<Note:> By default, the global interval setting is used within which to
5796 retrieve the OVS link status. To configure a plugin-specific interval, please
5797 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
5798 simple divide the time by 1000 for example if the desired interval is 50ms, set
5799 interval to 0.05.
5800
5801 =head2 Plugin C<ovs_stats>
5802
5803 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
5804 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
5805 statistics from OVSDB
5806
5807 B<Synopsis:>
5808
5809  <Plugin "ovs_stats">
5810    Port 6640
5811    Address "127.0.0.1"
5812    Socket "/var/run/openvswitch/db.sock"
5813    Bridges "br0" "br_ext"
5814  </Plugin>
5815
5816 The plugin provides the following configuration options:
5817
5818 =over 4
5819
5820 =item B<Address> I<node>
5821
5822 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5823 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5824 option. See L<ovsdb-server(1)> for more details. The option may be either
5825 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5826 format. Defaults to B<'localhost'>.
5827
5828 =item B<Port> I<service>
5829
5830 TCP-port to connect to. Either a service name or a port number may be given.
5831 Defaults to B<6640>.
5832
5833 =item B<Socket> I<path>
5834
5835 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5836 plugin. To enable the interface, the OVS DB daemon should be running with
5837 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5838 option is set, B<Address> and B<Port> options are ignored.
5839
5840 =item B<Bridges> [I<brname> ...]
5841
5842 List of OVS bridge names to be monitored by this plugin. If this option is
5843 omitted or is empty then all OVS bridges will be monitored.
5844
5845 Default: empty (monitor all bridges)
5846
5847 =back
5848
5849 =head2 Plugin C<perl>
5850
5851 This plugin embeds a Perl-interpreter into collectd and provides an interface
5852 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5853
5854 =head2 Plugin C<pinba>
5855
5856 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5857 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5858 PHP-based webpage has been delivered, the extension will send a UDP packet
5859 containing timing information, peak memory usage and so on. The plugin will
5860 wait for such packets, parse them and account the provided information, which
5861 is then dispatched to the daemon once per interval.
5862
5863 Synopsis:
5864
5865  <Plugin pinba>
5866    Address "::0"
5867    Port "30002"
5868    # Overall statistics for the website.
5869    <View "www-total">
5870      Server "www.example.com"
5871    </View>
5872    # Statistics for www-a only
5873    <View "www-a">
5874      Host "www-a.example.com"
5875      Server "www.example.com"
5876    </View>
5877    # Statistics for www-b only
5878    <View "www-b">
5879      Host "www-b.example.com"
5880      Server "www.example.com"
5881    </View>
5882  </Plugin>
5883
5884 The plugin provides the following configuration options:
5885
5886 =over 4
5887
5888 =item B<Address> I<Node>
5889
5890 Configures the address used to open a listening socket. By default, plugin will
5891 bind to the I<any> address C<::0>.
5892
5893 =item B<Port> I<Service>
5894
5895 Configures the port (service) to bind to. By default the default Pinba port
5896 "30002" will be used. The option accepts service names in addition to port
5897 numbers and thus requires a I<string> argument.
5898
5899 =item E<lt>B<View> I<Name>E<gt> block
5900
5901 The packets sent by the Pinba extension include the hostname of the server, the
5902 server name (the name of the virtual host) and the script that was executed.
5903 Using B<View> blocks it is possible to separate the data into multiple groups
5904 to get more meaningful statistics. Each packet is added to all matching groups,
5905 so that a packet may be accounted for more than once.
5906
5907 =over 4
5908
5909 =item B<Host> I<Host>
5910
5911 Matches the hostname of the system the webserver / script is running on. This
5912 will contain the result of the L<gethostname(2)> system call. If not
5913 configured, all hostnames will be accepted.
5914
5915 =item B<Server> I<Server>
5916
5917 Matches the name of the I<virtual host>, i.e. the contents of the
5918 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5919 server names will be accepted.
5920
5921 =item B<Script> I<Script>
5922
5923 Matches the name of the I<script name>, i.e. the contents of the
5924 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5925 script names will be accepted.
5926
5927 =back
5928
5929 =back
5930
5931 =head2 Plugin C<ping>
5932
5933 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
5934 configured hosts periodically and measures the network latency. Whenever the
5935 C<read> function of the plugin is called, it submits the average latency, the
5936 standard deviation and the drop rate for each host.
5937
5938 Available configuration options:
5939
5940 =over 4
5941
5942 =item B<Host> I<IP-address>
5943
5944 Host to ping periodically. This option may be repeated several times to ping
5945 multiple hosts.
5946
5947 =item B<Interval> I<Seconds>
5948
5949 Sets the interval in which to send ICMP echo packets to the configured hosts.
5950 This is B<not> the interval in which metrics are read from the plugin but the
5951 interval in which the hosts are "pinged". Therefore, the setting here should be
5952 smaller than or equal to the global B<Interval> setting. Fractional times, such
5953 as "1.24" are allowed.
5954
5955 Default: B<1.0>
5956
5957 =item B<Timeout> I<Seconds>
5958
5959 Time to wait for a response from the host to which an ICMP packet had been
5960 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5961 to be down or the packet to be dropped. This setting must be smaller than the
5962 B<Interval> setting above for the plugin to work correctly. Fractional
5963 arguments are accepted.
5964
5965 Default: B<0.9>
5966
5967 =item B<TTL> I<0-255>
5968
5969 Sets the Time-To-Live of generated ICMP packets.
5970
5971 =item B<Size> I<size>
5972
5973 Sets the size of the data payload in ICMP packet to specified I<size> (it
5974 will be filled with regular ASCII pattern). If not set, default 56 byte
5975 long string is used so that the packet size of an ICMPv4 packet is exactly
5976 64 bytes, similar to the behaviour of normal ping(1) command.
5977
5978 =item B<SourceAddress> I<host>
5979
5980 Sets the source address to use. I<host> may either be a numerical network
5981 address or a network hostname.
5982
5983 =item B<Device> I<name>
5984
5985 Sets the outgoing network device to be used. I<name> has to specify an
5986 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
5987 operating systems.
5988
5989 =item B<MaxMissed> I<Packets>
5990
5991 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
5992 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
5993
5994 Default: B<-1> (disabled)
5995
5996 =back
5997
5998 =head2 Plugin C<postgresql>
5999
6000 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6001 keeps a persistent connection to all configured databases and tries to
6002 reconnect if the connection has been interrupted. A database is configured by
6003 specifying a B<Database> block as described below. The default statistics are
6004 collected from PostgreSQL's B<statistics collector> which thus has to be
6005 enabled for this plugin to work correctly. This should usually be the case by
6006 default. See the section "The Statistics Collector" of the B<PostgreSQL
6007 Documentation> for details.
6008
6009 By specifying custom database queries using a B<Query> block as described
6010 below, you may collect any data that is available from some PostgreSQL
6011 database. This way, you are able to access statistics of external daemons
6012 which are available in a PostgreSQL database or use future or special
6013 statistics provided by PostgreSQL without the need to upgrade your collectd
6014 installation.
6015
6016 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6017 PostgreSQL databases as well. This has been implemented in a generic way. You
6018 need to specify an SQL statement which will then be executed by collectd in
6019 order to write the data (see below for details). The benefit of that approach
6020 is that there is no fixed database layout. Rather, the layout may be optimized
6021 for the current setup.
6022
6023 The B<PostgreSQL Documentation> manual can be found at
6024 L<http://www.postgresql.org/docs/manuals/>.
6025
6026   <Plugin postgresql>
6027     <Query magic>
6028       Statement "SELECT magic FROM wizard WHERE host = $1;"
6029       Param hostname
6030       <Result>
6031         Type gauge
6032         InstancePrefix "magic"
6033         ValuesFrom magic
6034       </Result>
6035     </Query>
6036
6037     <Query rt36_tickets>
6038       Statement "SELECT COUNT(type) AS count, type \
6039                         FROM (SELECT CASE \
6040                                      WHEN resolved = 'epoch' THEN 'open' \
6041                                      ELSE 'resolved' END AS type \
6042                                      FROM tickets) type \
6043                         GROUP BY type;"
6044       <Result>
6045         Type counter
6046         InstancePrefix "rt36_tickets"
6047         InstancesFrom "type"
6048         ValuesFrom "count"
6049       </Result>
6050     </Query>
6051
6052     <Writer sqlstore>
6053       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6054       StoreRates true
6055     </Writer>
6056
6057     <Database foo>
6058       Host "hostname"
6059       Port "5432"
6060       User "username"
6061       Password "secret"
6062       SSLMode "prefer"
6063       KRBSrvName "kerberos_service_name"
6064       Query magic
6065     </Database>
6066
6067     <Database bar>
6068       Interval 300
6069       Service "service_name"
6070       Query backend # predefined
6071       Query rt36_tickets
6072     </Database>
6073
6074     <Database qux>
6075       # ...
6076       Writer sqlstore
6077       CommitInterval 10
6078     </Database>
6079   </Plugin>
6080
6081 The B<Query> block defines one database query which may later be used by a
6082 database definition. It accepts a single mandatory argument which specifies
6083 the name of the query. The names of all queries have to be unique (see the
6084 B<MinVersion> and B<MaxVersion> options below for an exception to this
6085 rule).
6086
6087 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6088 B<Result> blocks may be used to extract multiple values from a single query.
6089
6090 The following configuration options are available to define the query:
6091
6092 =over 4
6093
6094 =item B<Statement> I<sql query statement>
6095
6096 Specify the I<sql query statement> which the plugin should execute. The string
6097 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6098 first, second, etc. parameter. The value of the parameters is specified by the
6099 B<Param> configuration option - see below for details. To include a literal
6100 B<$> character followed by a number, surround it with single quotes (B<'>).
6101
6102 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6103 allowed. Note, however, that only a single command may be used. Semicolons are
6104 allowed as long as a single non-empty command has been specified only.
6105
6106 The returned lines will be handled separately one after another.
6107
6108 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6109
6110 Specify the parameters which should be passed to the SQL query. The parameters
6111 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6112 they appear in the configuration file. The value of the parameter is
6113 determined depending on the value of the B<Param> option as follows:
6114
6115 =over 4
6116
6117 =item I<hostname>
6118
6119 The configured hostname of the database connection. If a UNIX domain socket is
6120 used, the parameter expands to "localhost".
6121
6122 =item I<database>
6123
6124 The name of the database of the current connection.
6125
6126 =item I<instance>
6127
6128 The name of the database plugin instance. See the B<Instance> option of the
6129 database specification below for details.
6130
6131 =item I<username>
6132
6133 The username used to connect to the database.
6134
6135 =item I<interval>
6136
6137 The interval with which this database is queried (as specified by the database
6138 specific or global B<Interval> options).
6139
6140 =back
6141
6142 Please note that parameters are only supported by PostgreSQL's protocol
6143 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6144
6145 =item B<PluginInstanceFrom> I<column>
6146
6147 Specify how to create the "PluginInstance" for reporting this query results.
6148 Only one column is supported. You may concatenate fields and string values in
6149 the query statement to get the required results.
6150
6151 =item B<MinVersion> I<version>
6152
6153 =item B<MaxVersion> I<version>
6154
6155 Specify the minimum or maximum version of PostgreSQL that this query should be
6156 used with. Some statistics might only be available with certain versions of
6157 PostgreSQL. This allows you to specify multiple queries with the same name but
6158 which apply to different versions, thus allowing you to use the same
6159 configuration in a heterogeneous environment.
6160
6161 The I<version> has to be specified as the concatenation of the major, minor
6162 and patch-level versions, each represented as two-decimal-digit numbers. For
6163 example, version 8.2.3 will become 80203.
6164
6165 =back
6166
6167 The B<Result> block defines how to handle the values returned from the query.
6168 It defines which column holds which value and how to dispatch that value to
6169 the daemon.
6170
6171 =over 4
6172
6173 =item B<Type> I<type>
6174
6175 The I<type> name to be used when dispatching the values. The type describes
6176 how to handle the data and where to store it. See L<types.db(5)> for more
6177 details on types and their configuration. The number and type of values (as
6178 selected by the B<ValuesFrom> option) has to match the type of the given name.
6179
6180 This option is mandatory.
6181
6182 =item B<InstancePrefix> I<prefix>
6183
6184 =item B<InstancesFrom> I<column0> [I<column1> ...]
6185
6186 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6187 B<InstancePrefix> defines a static prefix that will be prepended to all type
6188 instances. B<InstancesFrom> defines the column names whose values will be used
6189 to create the type instance. Multiple values will be joined together using the
6190 hyphen (C<->) as separation character.
6191
6192 The plugin itself does not check whether or not all built instances are
6193 different. It is your responsibility to assure that each is unique.
6194
6195 Both options are optional. If none is specified, the type instance will be
6196 empty.
6197
6198 =item B<ValuesFrom> I<column0> [I<column1> ...]
6199
6200 Names the columns whose content is used as the actual data for the data sets
6201 that are dispatched to the daemon. How many such columns you need is
6202 determined by the B<Type> setting as explained above. If you specify too many
6203 or not enough columns, the plugin will complain about that and no data will be
6204 submitted to the daemon.
6205
6206 The actual data type, as seen by PostgreSQL, is not that important as long as
6207 it represents numbers. The plugin will automatically cast the values to the
6208 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6209 L<strtod(3)> functions, so anything supported by those functions is supported
6210 by the plugin as well.
6211
6212 This option is required inside a B<Result> block and may be specified multiple
6213 times. If multiple B<ValuesFrom> options are specified, the columns are read
6214 in the given order.
6215
6216 =back
6217
6218 The following predefined queries are available (the definitions can be found
6219 in the F<postgresql_default.conf> file which, by default, is available at
6220 C<I<prefix>/share/collectd/>):
6221
6222 =over 4
6223
6224 =item B<backends>
6225
6226 This query collects the number of backends, i.E<nbsp>e. the number of
6227 connected clients.
6228
6229 =item B<transactions>
6230
6231 This query collects the numbers of committed and rolled-back transactions of
6232 the user tables.
6233
6234 =item B<queries>
6235
6236 This query collects the numbers of various table modifications (i.E<nbsp>e.
6237 insertions, updates, deletions) of the user tables.
6238
6239 =item B<query_plans>
6240
6241 This query collects the numbers of various table scans and returned tuples of
6242 the user tables.
6243
6244 =item B<table_states>
6245
6246 This query collects the numbers of live and dead rows in the user tables.
6247
6248 =item B<disk_io>
6249
6250 This query collects disk block access counts for user tables.
6251
6252 =item B<disk_usage>
6253
6254 This query collects the on-disk size of the database in bytes.
6255
6256 =back
6257
6258 In addition, the following detailed queries are available by default. Please
6259 note that each of those queries collects information B<by table>, thus,
6260 potentially producing B<a lot> of data. For details see the description of the
6261 non-by_table queries above.
6262
6263 =over 4
6264
6265 =item B<queries_by_table>
6266
6267 =item B<query_plans_by_table>
6268
6269 =item B<table_states_by_table>
6270
6271 =item B<disk_io_by_table>
6272
6273 =back
6274
6275 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6276 mandatory argument specifying the name of the writer. This will then be used
6277 in the B<Database> specification in order to activate the writer instance. The
6278 names of all writers have to be unique. The following options may be
6279 specified:
6280
6281 =over 4
6282
6283 =item B<Statement> I<sql statement>
6284
6285 This mandatory option specifies the SQL statement that will be executed for
6286 each submitted value. A single SQL statement is allowed only. Anything after
6287 the first semicolon will be ignored.
6288
6289 Nine parameters will be passed to the statement and should be specified as
6290 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6291 values are made available through those parameters:
6292
6293 =over 4
6294
6295 =item B<$1>
6296
6297 The timestamp of the queried value as an RFC 3339-formatted local time.
6298
6299 =item B<$2>
6300
6301 The hostname of the queried value.
6302
6303 =item B<$3>
6304
6305 The plugin name of the queried value.
6306
6307 =item B<$4>
6308
6309 The plugin instance of the queried value. This value may be B<NULL> if there
6310 is no plugin instance.
6311
6312 =item B<$5>
6313
6314 The type of the queried value (cf. L<types.db(5)>).
6315
6316 =item B<$6>
6317
6318 The type instance of the queried value. This value may be B<NULL> if there is
6319 no type instance.
6320
6321 =item B<$7>
6322
6323 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6324 sources of the submitted value-list).
6325
6326 =item B<$8>
6327
6328 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6329 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6330 B<StoreRates> is enabled (which is the default, see below), all types will be
6331 C<gauge>.
6332
6333 =item B<$9>
6334
6335 An array of the submitted values. The dimensions of the value name and value
6336 arrays match.
6337
6338 =back
6339
6340 In general, it is advisable to create and call a custom function in the
6341 PostgreSQL database for this purpose. Any procedural language supported by
6342 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6343 for details).
6344
6345 =item B<StoreRates> B<false>|B<true>
6346
6347 If set to B<true> (the default), convert counter values to rates. If set to
6348 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6349 number.
6350
6351 =back
6352
6353 The B<Database> block defines one PostgreSQL database for which to collect
6354 statistics. It accepts a single mandatory argument which specifies the
6355 database name. None of the other options are required. PostgreSQL will use
6356 default values as documented in the section "CONNECTING TO A DATABASE" in the
6357 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6358 the user collectd is run as and special environment variables. See the manpage
6359 for details.
6360
6361 =over 4
6362
6363 =item B<Interval> I<seconds>
6364
6365 Specify the interval with which the database should be queried. The default is
6366 to use the global B<Interval> setting.
6367
6368 =item B<CommitInterval> I<seconds>
6369
6370 This option may be used for database connections which have "writers" assigned
6371 (see above). If specified, it causes a writer to put several updates into a
6372 single transaction. This transaction will last for the specified amount of
6373 time. By default, each update will be executed in a separate transaction. Each
6374 transaction generates a fair amount of overhead which can, thus, be reduced by
6375 activating this option. The draw-back is, that data covering the specified
6376 amount of time will be lost, for example, if a single statement within the
6377 transaction fails or if the database server crashes.
6378
6379 =item B<Instance> I<name>
6380
6381 Specify the plugin instance name that should be used instead of the database
6382 name (which is the default, if this option has not been specified). This
6383 allows one to query multiple databases of the same name on the same host (e.g.
6384 when running multiple database server versions in parallel).
6385 The plugin instance name can also be set from the query result using
6386 the B<PluginInstanceFrom> option in B<Query> block.
6387
6388 =item B<Host> I<hostname>
6389
6390 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6391 value begins with a slash, it is interpreted as the directory name in which to
6392 look for the UNIX domain socket.
6393
6394 This option is also used to determine the hostname that is associated with a
6395 collected data set. If it has been omitted or either begins with with a slash
6396 or equals B<localhost> it will be replaced with the global hostname definition
6397 of collectd. Any other value will be passed literally to collectd when
6398 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6399
6400 =item B<Port> I<port>
6401
6402 Specify the TCP port or the local UNIX domain socket file extension of the
6403 server.
6404
6405 =item B<User> I<username>
6406
6407 Specify the username to be used when connecting to the server.
6408
6409 =item B<Password> I<password>
6410
6411 Specify the password to be used when connecting to the server.
6412
6413 =item B<ExpireDelay> I<delay>
6414
6415 Skip expired values in query output.
6416
6417 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6418
6419 Specify whether to use an SSL connection when contacting the server. The
6420 following modes are supported:
6421
6422 =over 4
6423
6424 =item I<disable>
6425
6426 Do not use SSL at all.
6427
6428 =item I<allow>
6429
6430 First, try to connect without using SSL. If that fails, try using SSL.
6431
6432 =item I<prefer> (default)
6433
6434 First, try to connect using SSL. If that fails, try without using SSL.
6435
6436 =item I<require>
6437
6438 Use SSL only.
6439
6440 =back
6441
6442 =item B<Instance> I<name>
6443
6444 Specify the plugin instance name that should be used instead of the database
6445 name (which is the default, if this option has not been specified). This
6446 allows one to query multiple databases of the same name on the same host (e.g.
6447 when running multiple database server versions in parallel).
6448
6449 =item B<KRBSrvName> I<kerberos_service_name>
6450
6451 Specify the Kerberos service name to use when authenticating with Kerberos 5
6452 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6453 B<PostgreSQL Documentation> for details.
6454
6455 =item B<Service> I<service_name>
6456
6457 Specify the PostgreSQL service name to use for additional parameters. That
6458 service has to be defined in F<pg_service.conf> and holds additional
6459 connection parameters. See the section "The Connection Service File" in the
6460 B<PostgreSQL Documentation> for details.
6461
6462 =item B<Query> I<query>
6463
6464 Specifies a I<query> which should be executed in the context of the database
6465 connection. This may be any of the predefined or user-defined queries. If no
6466 such option is given, it defaults to "backends", "transactions", "queries",
6467 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6468 has been specified). Else, the specified queries are used only.
6469
6470 =item B<Writer> I<writer>
6471
6472 Assigns the specified I<writer> backend to the database connection. This
6473 causes all collected data to be send to the database using the settings
6474 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6475 below for details on how to selectively send data to certain plugins).
6476
6477 Each writer will register a flush callback which may be used when having long
6478 transactions enabled (see the B<CommitInterval> option above). When issuing
6479 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6480 transaction will be committed right away. Two different kinds of flush
6481 callbacks are available with the C<postgresql> plugin:
6482
6483 =over 4
6484
6485 =item B<postgresql>
6486
6487 Flush all writer backends.
6488
6489 =item B<postgresql->I<database>
6490
6491 Flush all writers of the specified I<database> only.
6492
6493 =back
6494
6495 =back
6496
6497 =head2 Plugin C<powerdns>
6498
6499 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6500 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6501 values, many of which are probably meaningless to most users, but may be useful
6502 for some. So you may chose which values to collect, but if you don't, some
6503 reasonable defaults will be collected.
6504
6505   <Plugin "powerdns">
6506     <Server "server_name">
6507       Collect "latency"
6508       Collect "udp-answers" "udp-queries"
6509       Socket "/var/run/pdns.controlsocket"
6510     </Server>
6511     <Recursor "recursor_name">
6512       Collect "questions"
6513       Collect "cache-hits" "cache-misses"
6514       Socket "/var/run/pdns_recursor.controlsocket"
6515     </Recursor>
6516     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6517   </Plugin>
6518
6519 =over 4
6520
6521 =item B<Server> and B<Recursor> block
6522
6523 The B<Server> block defines one authoritative server to query, the B<Recursor>
6524 does the same for an recursing server. The possible options in both blocks are
6525 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6526 and is required.
6527
6528 =over 4
6529
6530 =item B<Collect> I<Field>
6531
6532 Using the B<Collect> statement you can select which values to collect. Here,
6533 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6534 C<dlg-only-drops>, C<answers10-100>.
6535
6536 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6537 When querying the server a C<SHOW *> command is issued in any case, because
6538 that's the only way of getting multiple values out of the server at once.
6539 collectd then picks out the values you have selected. When querying the
6540 recursor, a command is generated to query exactly these values. So if you
6541 specify invalid fields when querying the recursor, a syntax error may be
6542 returned by the daemon and collectd may not collect any values at all.
6543
6544 If no B<Collect> statement is given, the following B<Server> values will be
6545 collected:
6546
6547 =over 4
6548
6549 =item latency
6550
6551 =item packetcache-hit
6552
6553 =item packetcache-miss
6554
6555 =item packetcache-size
6556
6557 =item query-cache-hit
6558
6559 =item query-cache-miss
6560
6561 =item recursing-answers
6562
6563 =item recursing-questions
6564
6565 =item tcp-answers
6566
6567 =item tcp-queries
6568
6569 =item udp-answers
6570
6571 =item udp-queries
6572
6573 =back
6574
6575 The following B<Recursor> values will be collected by default:
6576
6577 =over 4
6578
6579 =item noerror-answers
6580
6581 =item nxdomain-answers
6582
6583 =item servfail-answers
6584
6585 =item sys-msec
6586
6587 =item user-msec
6588
6589 =item qa-latency
6590
6591 =item cache-entries
6592
6593 =item cache-hits
6594
6595 =item cache-misses
6596
6597 =item questions
6598
6599 =back
6600
6601 Please note that up to that point collectd doesn't know what values are
6602 available on the server and values that are added do not need a change of the
6603 mechanism so far. However, the values must be mapped to collectd's naming
6604 scheme, which is done using a lookup table that lists all known values. If
6605 values are added in the future and collectd does not know about them, you will
6606 get an error much like this:
6607
6608   powerdns plugin: submit: Not found in lookup table: foobar = 42
6609
6610 In this case please file a bug report with the collectd team.
6611
6612 =item B<Socket> I<Path>
6613
6614 Configures the path to the UNIX domain socket to be used when connecting to the
6615 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6616 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6617 will be used for the recursor.
6618
6619 =back
6620
6621 =item B<LocalSocket> I<Path>
6622
6623 Querying the recursor is done using UDP. When using UDP over UNIX domain
6624 sockets, the client socket needs a name in the file system, too. You can set
6625 this local name to I<Path> using the B<LocalSocket> option. The default is
6626 C<I<prefix>/var/run/collectd-powerdns>.
6627
6628 =back
6629
6630 =head2 Plugin C<processes>
6631
6632 =over 4
6633
6634 =item B<Process> I<Name>
6635
6636 Select more detailed statistics of processes matching this name. The statistics
6637 collected for these selected processes are:
6638  - size of the resident segment size (RSS)
6639  - user- and system-time used
6640  - number of processes
6641  - number of threads
6642  - number of open files (under Linux)
6643  - io data (where available)
6644  - context switches (under Linux)
6645  - minor and major pagefaults.
6646
6647 Some platforms have a limit on the length of process names. I<Name> must stay
6648 below this limit.
6649
6650 =item B<ProcessMatch> I<name> I<regex>
6651
6652 Similar to the B<Process> option this allows one to select more detailed
6653 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6654 details). The statistics of all matching processes are summed up and
6655 dispatched to the daemon using the specified I<name> as an identifier. This
6656 allows one to "group" several processes together. I<name> must not contain
6657 slashes.
6658
6659 =item B<CollectContextSwitch> I<Boolean>
6660
6661 Collect context switch of the process.
6662
6663 =back
6664
6665 =head2 Plugin C<protocols>
6666
6667 Collects a lot of information about various network protocols, such as I<IP>,
6668 I<TCP>, I<UDP>, etc.
6669
6670 Available configuration options:
6671
6672 =over 4
6673
6674 =item B<Value> I<Selector>
6675
6676 Selects whether or not to select a specific value. The string being matched is
6677 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6678 plugin instance and I<ValueName> will be used as type instance. An example of
6679 the string being used would be C<Tcp:RetransSegs>.
6680
6681 You can use regular expressions to match a large number of values with just one
6682 configuration option. To select all "extended" I<TCP> values, you could use the
6683 following statement:
6684
6685   Value "/^TcpExt:/"
6686
6687 Whether only matched values are selected or all matched values are ignored
6688 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6689 If no value is configured at all, all values will be selected.
6690
6691 See F</"IGNORELISTS"> for details.
6692
6693 =item B<IgnoreSelected> B<true>|B<false>
6694
6695 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6696 matching values will be ignored.
6697
6698 =back
6699
6700 =head2 Plugin C<python>
6701
6702 This plugin embeds a Python-interpreter into collectd and provides an interface
6703 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6704
6705 =head2 Plugin C<routeros>
6706
6707 The C<routeros> plugin connects to a device running I<RouterOS>, the
6708 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6709 I<librouteros> to connect and reads information about the interfaces and
6710 wireless connections of the device. The configuration supports querying
6711 multiple routers:
6712
6713   <Plugin "routeros">
6714     <Router>
6715       Host "router0.example.com"
6716       User "collectd"
6717       Password "secr3t"
6718       CollectInterface true
6719       CollectCPULoad true
6720       CollectMemory true
6721     </Router>
6722     <Router>
6723       Host "router1.example.com"
6724       User "collectd"
6725       Password "5ecret"
6726       CollectInterface true
6727       CollectRegistrationTable true
6728       CollectDF true
6729       CollectDisk true
6730     </Router>
6731   </Plugin>
6732
6733 As you can see above, the configuration of the I<routeros> plugin consists of
6734 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6735 options are understood:
6736
6737 =over 4
6738
6739 =item B<Host> I<Host>
6740
6741 Hostname or IP-address of the router to connect to.
6742
6743 =item B<Port> I<Port>
6744
6745 Port name or port number used when connecting. If left unspecified, the default
6746 will be chosen by I<librouteros>, currently "8728". This option expects a
6747 string argument, even when a numeric port number is given.
6748
6749 =item B<User> I<User>
6750
6751 Use the user name I<User> to authenticate. Defaults to "admin".
6752
6753 =item B<Password> I<Password>
6754
6755 Set the password used to authenticate.
6756
6757 =item B<CollectInterface> B<true>|B<false>
6758
6759 When set to B<true>, interface statistics will be collected for all interfaces
6760 present on the device. Defaults to B<false>.
6761
6762 =item B<CollectRegistrationTable> B<true>|B<false>
6763
6764 When set to B<true>, information about wireless LAN connections will be
6765 collected. Defaults to B<false>.
6766
6767 =item B<CollectCPULoad> B<true>|B<false>
6768
6769 When set to B<true>, information about the CPU usage will be collected. The
6770 number is a dimensionless value where zero indicates no CPU usage at all.
6771 Defaults to B<false>.
6772
6773 =item B<CollectMemory> B<true>|B<false>
6774
6775 When enabled, the amount of used and free memory will be collected. How used
6776 memory is calculated is unknown, for example whether or not caches are counted
6777 as used space.
6778 Defaults to B<false>.
6779
6780 =item B<CollectDF> B<true>|B<false>
6781
6782 When enabled, the amount of used and free disk space will be collected.
6783 Defaults to B<false>.
6784
6785 =item B<CollectDisk> B<true>|B<false>
6786
6787 When enabled, the number of sectors written and bad blocks will be collected.
6788 Defaults to B<false>.
6789
6790 =back
6791
6792 =head2 Plugin C<redis>
6793
6794 The I<Redis plugin> connects to one or more Redis servers and gathers
6795 information about each server's state. For each server there is a I<Node> block
6796 which configures the connection parameters for this node.
6797
6798   <Plugin redis>
6799     <Node "example">
6800         Host "localhost"
6801         Port "6379"
6802         Timeout 2000
6803         <Query "LLEN myqueue">
6804           Type "queue_length"
6805           Instance "myqueue"
6806         <Query>
6807     </Node>
6808   </Plugin>
6809
6810 The information shown in the synopsis above is the I<default configuration>
6811 which is used by the plugin if no configuration is present.
6812
6813 =over 4
6814
6815 =item B<Node> I<Nodename>
6816
6817 The B<Node> block identifies a new Redis node, that is a new Redis instance
6818 running in an specified host and port. The name for node is a canonical
6819 identifier which is used as I<plugin instance>. It is limited to
6820 64E<nbsp>characters in length.
6821
6822 =item B<Host> I<Hostname>
6823
6824 The B<Host> option is the hostname or IP-address where the Redis instance is
6825 running on.
6826
6827 =item B<Port> I<Port>
6828
6829 The B<Port> option is the TCP port on which the Redis instance accepts
6830 connections. Either a service name of a port number may be given. Please note
6831 that numerical port numbers must be given as a string, too.
6832
6833 =item B<Password> I<Password>
6834
6835 Use I<Password> to authenticate when connecting to I<Redis>.
6836
6837 =item B<Timeout> I<Milliseconds>
6838
6839 The B<Timeout> option set the socket timeout for node response. Since the Redis
6840 read function is blocking, you should keep this value as low as possible. Keep
6841 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6842 than B<Interval> defined globally.
6843
6844 =item B<Query> I<Querystring>
6845
6846 The B<Query> block identifies a query to execute against the redis server.
6847 There may be an arbitrary number of queries to execute.
6848
6849 =item B<Type> I<Collectd type>
6850
6851 Within a query definition, a valid collectd type to use as when submitting
6852 the result of the query. When not supplied, will default to B<gauge>.
6853
6854 =item B<Instance> I<Type instance>
6855
6856 Within a query definition, an optional type instance to use when submitting
6857 the result of the query. When not supplied will default to the escaped
6858 command, up to 64 chars.
6859
6860 =back
6861
6862 =head2 Plugin C<rrdcached>
6863
6864 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6865 to store values to RRD files in an efficient manner. The combination of the
6866 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6867 way the C<rrdtool> plugin works (see below). The added abstraction layer
6868 provides a number of benefits, though: Because the cache is not within
6869 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6870 restarted. This results in much shorter (if any) gaps in graphs, especially
6871 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6872 daemon so that it can flush values to disk automatically when needed. This
6873 allows one to integrate automated flushing of values into graphing solutions
6874 much more easily.
6875
6876 There are disadvantages, though: The daemon may reside on a different host, so
6877 it may not be possible for C<collectd> to create the appropriate RRD files
6878 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6879 different base directory, so relative paths may do weird stuff if you're not
6880 careful.
6881
6882 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6883 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6884 setting should be set to an absolute path, so that a changed base directory
6885 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6886
6887 =over 4
6888
6889 =item B<DaemonAddress> I<Address>
6890
6891 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6892 library. See L<rrdcached(1)> for details. Example:
6893
6894   <Plugin "rrdcached">
6895     DaemonAddress "unix:/var/run/rrdcached.sock"
6896   </Plugin>
6897
6898 =item B<DataDir> I<Directory>
6899
6900 Set the base directory in which the RRD files reside. If this is a relative
6901 path, it is relative to the working base directory of the C<rrdcached> daemon!
6902 Use of an absolute path is recommended.
6903
6904 =item B<CreateFiles> B<true>|B<false>
6905
6906 Enables or disables the creation of RRD files. If the daemon is not running
6907 locally, or B<DataDir> is set to a relative path, this will not work as
6908 expected. Default is B<true>.
6909
6910 =item B<CreateFilesAsync> B<false>|B<true>
6911
6912 When enabled, new RRD files are enabled asynchronously, using a separate thread
6913 that runs in the background. This prevents writes to block, which is a problem
6914 especially when many hundreds of files need to be created at once. However,
6915 since the purpose of creating the files asynchronously is I<not> to block until
6916 the file is available, values before the file is available will be discarded.
6917 When disabled (the default) files are created synchronously, blocking for a
6918 short while, while the file is being written.
6919
6920 =item B<StepSize> I<Seconds>
6921
6922 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6923 this setting is unset and the stepsize is set to the interval in which the data
6924 is collected. Do not use this option unless you absolutely have to for some
6925 reason. Setting this option may cause problems with the C<snmp plugin>, the
6926 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6927
6928 =item B<HeartBeat> I<Seconds>
6929
6930 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6931 in which case the heartbeat is set to twice the B<StepSize> which should equal
6932 the interval in which data is collected. Do not set this option unless you have
6933 a very good reason to do so.
6934
6935 =item B<RRARows> I<NumRows>
6936
6937 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6938 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6939 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6940 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6941 week, one month, and one year.
6942
6943 So for each timespan, it calculates how many PDPs need to be consolidated into
6944 one CDP by calculating:
6945   number of PDPs = timespan / (stepsize * rrarows)
6946
6947 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6948 default is 1200.
6949
6950 =item B<RRATimespan> I<Seconds>
6951
6952 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6953 more then one RRA. If this option is never used, the built-in default of (3600,
6954 86400, 604800, 2678400, 31622400) is used.
6955
6956 For more information on how RRA-sizes are calculated see B<RRARows> above.
6957
6958 =item B<XFF> I<Factor>
6959
6960 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6961 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6962 one (exclusive).
6963
6964 =item B<CollectStatistics> B<false>|B<true>
6965
6966 When set to B<true>, various statistics about the I<rrdcached> daemon will be
6967 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
6968
6969 Statistics are read via I<rrdcached>s socket using the STATS command.
6970 See L<rrdcached(1)> for details.
6971
6972 =back
6973
6974 =head2 Plugin C<rrdtool>
6975
6976 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
6977 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
6978 using these settings. If you don't want to dive into the depths of RRDtool, you
6979 can safely ignore these settings.
6980
6981 =over 4
6982
6983 =item B<DataDir> I<Directory>
6984
6985 Set the directory to store RRD files under. By default RRD files are generated
6986 beneath the daemon's working directory, i.e. the B<BaseDir>.
6987
6988 =item B<CreateFilesAsync> B<false>|B<true>
6989
6990 When enabled, new RRD files are enabled asynchronously, using a separate thread
6991 that runs in the background. This prevents writes to block, which is a problem
6992 especially when many hundreds of files need to be created at once. However,
6993 since the purpose of creating the files asynchronously is I<not> to block until
6994 the file is available, values before the file is available will be discarded.
6995 When disabled (the default) files are created synchronously, blocking for a
6996 short while, while the file is being written.
6997
6998 =item B<StepSize> I<Seconds>
6999
7000 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7001 this setting is unset and the stepsize is set to the interval in which the data
7002 is collected. Do not use this option unless you absolutely have to for some
7003 reason. Setting this option may cause problems with the C<snmp plugin>, the
7004 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7005
7006 =item B<HeartBeat> I<Seconds>
7007
7008 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7009 in which case the heartbeat is set to twice the B<StepSize> which should equal
7010 the interval in which data is collected. Do not set this option unless you have
7011 a very good reason to do so.
7012
7013 =item B<RRARows> I<NumRows>
7014
7015 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7016 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7017 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7018 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7019 week, one month, and one year.
7020
7021 So for each timespan, it calculates how many PDPs need to be consolidated into
7022 one CDP by calculating:
7023   number of PDPs = timespan / (stepsize * rrarows)
7024
7025 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7026 default is 1200.
7027
7028 =item B<RRATimespan> I<Seconds>
7029
7030 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7031 more then one RRA. If this option is never used, the built-in default of (3600,
7032 86400, 604800, 2678400, 31622400) is used.
7033
7034 For more information on how RRA-sizes are calculated see B<RRARows> above.
7035
7036 =item B<XFF> I<Factor>
7037
7038 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7039 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7040 one (exclusive).
7041
7042 =item B<CacheFlush> I<Seconds>
7043
7044 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7045 it writes all values for a certain RRD-file if the oldest value is older than
7046 (or equal to) the number of seconds specified by B<CacheTimeout>.
7047 That check happens on new values arriwal. If some RRD-file is not updated
7048 anymore for some reason (the computer was shut down, the network is broken,
7049 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7050 every I<Seconds> seconds the entire cache is searched for entries older than
7051 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7052 disk. Since scanning the entire cache is kind of expensive and does nothing
7053 under normal circumstances, this value should not be too small. 900 seconds
7054 might be a good value, though setting this to 7200 seconds doesn't normally
7055 do much harm either.
7056
7057 Defaults to 10x B<CacheTimeout>.
7058 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7059 above default is used.
7060
7061 =item B<CacheTimeout> I<Seconds>
7062
7063 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7064 save values in a cache, as described above. Writing multiple values at once
7065 reduces IO-operations and thus lessens the load produced by updating the files.
7066 The trade off is that the graphs kind of "drag behind" and that more memory is
7067 used.
7068
7069 =item B<WritesPerSecond> I<Updates>
7070
7071 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7072 will run serious performance problems. The B<CacheFlush> setting and the
7073 internal update queue assert that collectd continues to work just fine even
7074 under heavy load, but the system may become very unresponsive and slow. This is
7075 a problem especially if you create graphs from the RRD files on the same
7076 machine, for example using the C<graph.cgi> script included in the
7077 C<contrib/collection3/> directory.
7078
7079 This setting is designed for very large setups. Setting this option to a value
7080 between 25 and 80 updates per second, depending on your hardware, will leave
7081 the server responsive enough to draw graphs even while all the cached values
7082 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7083 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7084 written as fast as possible, so that web frontends have up to date data when
7085 generating graphs.
7086
7087 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7088 updates per second, writing all values to disk will take approximately
7089 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7090 "collection3" you'll end up with a responsive and fast system, up to date
7091 graphs and basically a "backup" of your values every hour.
7092
7093 =item B<RandomTimeout> I<Seconds>
7094
7095 When set, the actual timeout for each value is chosen randomly between
7096 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7097 intention is to avoid high load situations that appear when many values timeout
7098 at the same time. This is especially a problem shortly after the daemon starts,
7099 because all values were added to the internal cache at roughly the same time.
7100
7101 =back
7102
7103 =head2 Plugin C<sensors>
7104
7105 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7106 that all the needed modules have to be loaded and lm_sensors has to be
7107 configured (most likely by editing F</etc/sensors.conf>. Read
7108 L<sensors.conf(5)> for details.
7109
7110 The B<lm_sensors> homepage can be found at
7111 L<http://secure.netroedge.com/~lm78/>.
7112
7113 =over 4
7114
7115 =item B<SensorConfigFile> I<File>
7116
7117 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7118 the library's default will be used.
7119
7120 =item B<Sensor> I<chip-bus-address/type-feature>
7121
7122 Selects the name of the sensor which you want to collect or ignore, depending
7123 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7124 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7125 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7126
7127 See F</"IGNORELISTS"> for details.
7128
7129 =item B<IgnoreSelected> I<true>|I<false>
7130
7131 If no configuration if given, the B<sensors>-plugin will collect data from all
7132 sensors. This may not be practical, especially for uninteresting sensors.
7133 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7134 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7135 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7136 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7137 and all other sensors are collected.
7138
7139 =item B<UseLabels> I<true>|I<false>
7140
7141 Configures how sensor readings are reported. When set to I<true>, sensor
7142 readings are reported using their descriptive label (e.g. "VCore"). When set to
7143 I<false> (the default) the sensor name is used ("in0").
7144
7145 =back
7146
7147 =head2 Plugin C<sigrok>
7148
7149 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7150 supported by the L<sigrok|http://sigrok.org/> project.
7151
7152 B<Synopsis>
7153
7154  <Plugin sigrok>
7155    LogLevel 3
7156    <Device "AC Voltage">
7157       Driver "fluke-dmm"
7158       MinimumInterval 10
7159       Conn "/dev/ttyUSB2"
7160    </Device>
7161    <Device "Sound Level">
7162       Driver "cem-dt-885x"
7163       Conn "/dev/ttyUSB1"
7164    </Device>
7165  </Plugin>
7166
7167 =over 4
7168
7169 =item B<LogLevel> B<0-5>
7170
7171 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7172 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7173 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7174 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7175 their level, are always submitted to I<collectd> at its INFO log level.
7176
7177 =item E<lt>B<Device> I<Name>E<gt>
7178
7179 A sigrok-supported device, uniquely identified by this section's options. The
7180 I<Name> is passed to I<collectd> as the I<plugin instance>.
7181
7182 =item B<Driver> I<DriverName>
7183
7184 The sigrok driver to use for this device.
7185
7186 =item B<Conn> I<ConnectionSpec>
7187
7188 If the device cannot be auto-discovered, or more than one might be discovered
7189 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7190 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7191 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7192 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7193 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7194
7195 =item B<SerialComm> I<SerialSpec>
7196
7197 For serial devices with non-standard port settings, this option can be used
7198 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7199 This should not be necessary; drivers know how to communicate with devices they
7200 support.
7201
7202 =item B<MinimumInterval> I<Seconds>
7203
7204 Specifies the minimum time between measurement dispatches to I<collectd>, in
7205 seconds. Since some I<sigrok> supported devices can acquire measurements many
7206 times per second, it may be necessary to throttle these. For example, the
7207 I<RRD plugin> cannot process writes more than once per second.
7208
7209 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7210 device are always dispatched to I<collectd>. When throttled, unused
7211 measurements are discarded.
7212
7213 =back
7214
7215 =head2 Plugin C<smart>
7216
7217 The C<smart> plugin collects SMART information from physical
7218 disks. Values collectd include temperature, power cycle count, poweron
7219 time and bad sectors. Also, all SMART attributes are collected along
7220 with the normalized current value, the worst value, the threshold and
7221 a human readable value.
7222
7223 Using the following two options you can ignore some disks or configure the
7224 collection only of specific disks.
7225
7226 =over 4
7227
7228 =item B<Disk> I<Name>
7229
7230 Select the disk I<Name>. Whether it is collected or ignored depends on the
7231 B<IgnoreSelected> setting, see below. As with other plugins that use the
7232 daemon's ignorelist functionality, a string that starts and ends with a slash
7233 is interpreted as a regular expression. Examples:
7234
7235   Disk "sdd"
7236   Disk "/hda[34]/"
7237
7238 See F</"IGNORELISTS"> for details.
7239
7240 =item B<IgnoreSelected> B<true>|B<false>
7241
7242 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7243 statements, are ignored or if all other disks are ignored. The behavior
7244 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7245 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7246 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7247 is set to B<true>, all disks are collected B<except> the ones matched.
7248
7249 =item B<IgnoreSleepMode> B<true>|B<false>
7250
7251 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7252 This option disables the sleep mode check and allows the plugin to collect data
7253 from these disks anyway. This is useful in cases where libatasmart mistakenly
7254 reports disks as asleep because it has not been updated to incorporate support
7255 for newer idle states in the ATA spec.
7256
7257 =item B<UseSerial> B<true>|B<false>
7258
7259 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7260 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7261 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7262 storing data. This ensures that the data for a given disk will be kept together
7263 even if the kernel name changes.
7264
7265 =back
7266
7267 =head2 Plugin C<snmp>
7268
7269 Since the configuration of the C<snmp plugin> is a little more complicated than
7270 other plugins, its documentation has been moved to an own manpage,
7271 L<collectd-snmp(5)>. Please see there for details.
7272
7273 =head2 Plugin C<snmp_agent>
7274
7275 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7276 from SNMP master agent and returns the data collected by read plugins.
7277 The I<snmp_agent> plugin handles requests only for OIDs specified in
7278 configuration file. To handle SNMP queries the plugin gets data from collectd
7279 and translates requested values from collectd's internal format to SNMP format.
7280 This plugin is a generic plugin and cannot work without configuration.
7281 For more details on AgentX subagent see
7282 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7283
7284 B<Synopsis:>
7285
7286   <Plugin snmp_agent>
7287     <Data "memAvailReal">
7288       Plugin "memory"
7289       #PluginInstance "some"
7290       Type "memory"
7291       TypeInstance "free"
7292       OIDs "1.3.6.1.4.1.2021.4.6.0"
7293     </Data>
7294     <Table "ifTable">
7295       IndexOID "IF-MIB::ifIndex"
7296       SizeOID "IF-MIB::ifNumber"
7297       <Data "ifDescr">
7298         Instance true
7299         Plugin "interface"
7300         OIDs "IF-MIB::ifDescr"
7301       </Data>
7302       <Data "ifOctets">
7303         Plugin "interface"
7304         Type "if_octets"
7305         TypeInstance ""
7306         OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7307       </Data>
7308     </Table>
7309   </Plugin>
7310
7311 There are two types of blocks that can be contained in the
7312 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7313
7314 =head3 The B<Data> block
7315
7316 The B<Data> block defines a list OIDs that are to be handled. This block can
7317 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7318 block it reperesents table OIDs.
7319 The following options can be set:
7320
7321 =over 4
7322
7323 =item B<Instance> I<true|false>
7324
7325 When B<Instance> is set to B<true>, the value for requested OID is copied from
7326 plugin instance field of corresponding collectd value. If B<Data> block defines
7327 scalar data type B<Instance> has no effect and can be omitted.
7328
7329 =item B<Plugin> I<String>
7330
7331 Read plugin name whose collected data will be mapped to specified OIDs.
7332
7333 =item B<PluginInstance> I<String>
7334
7335 Read plugin instance whose collected data will be mapped to specified OIDs.
7336 The field is optional and by default there is no plugin instance check.
7337 Allowed only if B<Data> block defines scalar data type.
7338
7339 =item B<Type> I<String>
7340
7341 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7342 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7343
7344 =item B<TypeInstance> I<String>
7345
7346 Collectd's type-instance that is to be used for specified OID.
7347
7348 =item B<OIDs> I<OID> [I<OID> ...]
7349
7350 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7351 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7352 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7353 configured should correspond to number of values in specified B<Type>.
7354 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7355 "rx" and "tx" values of "if_octets" type.
7356
7357 =item B<Scale> I<Value>
7358
7359 The values taken from collectd are multiplied by I<Value>. The field is optional
7360 and the default is B<1.0>.
7361
7362 =item B<Shift> I<Value>
7363
7364 I<Value> is added to values from collectd after they have been multiplied by
7365 B<Scale> value. The field is optional and the default value is B<0.0>.
7366
7367 =back
7368
7369 =head3 The B<Table> block
7370
7371 The B<Table> block defines a collection of B<Data> blocks that belong to one
7372 snmp table. In addition to multiple B<Data> blocks the following options can be
7373 set:
7374
7375 =over 4
7376
7377 =item B<IndexOID> I<OID>
7378
7379 OID that is handled by the plugin and is mapped to numerical index value that is
7380 generated by the plugin for each table record.
7381
7382 =item B<SizeOID> I<OID>
7383
7384 OID that is handled by the plugin. Returned value is the number of records in
7385 the table. The field is optional.
7386
7387 =back
7388
7389 =head2 Plugin C<statsd>
7390
7391 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7392 protocol and dispatches rates or other aggregates of these numbers
7393 periodically.
7394
7395 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7396 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7397 C<objects> respectively.
7398
7399 The following configuration options are valid:
7400
7401 =over 4
7402
7403 =item B<Host> I<Host>
7404
7405 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7406 "any" address, i.e. accept packets sent to any of the hosts addresses.
7407
7408 =item B<Port> I<Port>
7409
7410 UDP port to listen to. This can be either a service name or a port number.
7411 Defaults to C<8125>.
7412
7413 =item B<DeleteCounters> B<false>|B<true>
7414
7415 =item B<DeleteTimers> B<false>|B<true>
7416
7417 =item B<DeleteGauges> B<false>|B<true>
7418
7419 =item B<DeleteSets> B<false>|B<true>
7420
7421 These options control what happens if metrics are not updated in an interval.
7422 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7423 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7424 are unchanged. If set to B<True>, the such metrics are not dispatched and
7425 removed from the internal cache.
7426
7427 =item B<CounterSum> B<false>|B<true>
7428
7429 When enabled, creates a C<count> metric which reports the change since the last
7430 read. This option primarily exists for compatibility with the I<statsd>
7431 implementation by Etsy.
7432
7433 =item B<TimerPercentile> I<Percent>
7434
7435 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7436 that I<Percent> of all reported timers are smaller than or equal to the
7437 computed latency. This is useful for cutting off the long tail latency, as it's
7438 often done in I<Service Level Agreements> (SLAs).
7439
7440 Different percentiles can be calculated by setting this option several times.
7441 If none are specified, no percentiles are calculated / dispatched.
7442
7443 =item B<TimerLower> B<false>|B<true>
7444
7445 =item B<TimerUpper> B<false>|B<true>
7446
7447 =item B<TimerSum> B<false>|B<true>
7448
7449 =item B<TimerCount> B<false>|B<true>
7450
7451 Calculate and dispatch various values out of I<Timer> metrics received during
7452 an interval. If set to B<False>, the default, these values aren't calculated /
7453 dispatched.
7454
7455 =back
7456
7457 =head2 Plugin C<swap>
7458
7459 The I<Swap plugin> collects information about used and available swap space. On
7460 I<Linux> and I<Solaris>, the following options are available:
7461
7462 =over 4
7463
7464 =item B<ReportByDevice> B<false>|B<true>
7465
7466 Configures how to report physical swap devices. If set to B<false> (the
7467 default), the summary over all swap devices is reported only, i.e. the globally
7468 used and available space over all devices. If B<true> is configured, the used
7469 and available space of each device will be reported separately.
7470
7471 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7472 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7473
7474 =item B<ReportBytes> B<false>|B<true>
7475
7476 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7477 I<swap I/O> is reported in pages. This option is available under Linux only.
7478
7479 =item B<ValuesAbsolute> B<true>|B<false>
7480
7481 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7482 available and used. Defaults to B<true>.
7483
7484 =item B<ValuesPercentage> B<false>|B<true>
7485
7486 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7487 available and free. Defaults to B<false>.
7488
7489 This is useful for deploying I<collectd> in a heterogeneous environment, where
7490 swap sizes differ and you want to specify generic thresholds or similar.
7491
7492 =back
7493
7494 =head2 Plugin C<syslog>
7495
7496 =over 4
7497
7498 =item B<LogLevel> B<debug|info|notice|warning|err>
7499
7500 Sets the log-level. If, for example, set to B<notice>, then all events with
7501 severity B<notice>, B<warning>, or B<err> will be submitted to the
7502 syslog-daemon.
7503
7504 Please note that B<debug> is only available if collectd has been compiled with
7505 debugging support.
7506
7507 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7508
7509 Controls which notifications should be sent to syslog. The default behaviour is
7510 not to send any. Less severe notifications always imply logging more severe
7511 notifications: Setting this to B<OKAY> means all notifications will be sent to
7512 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7513 notifications but will dismiss B<OKAY> notifications. Setting this option to
7514 B<FAILURE> will only send failures to syslog.
7515
7516 =back
7517
7518 =head2 Plugin C<table>
7519
7520 The C<table plugin> provides generic means to parse tabular data and dispatch
7521 user specified values. Values are selected based on column numbers. For
7522 example, this plugin may be used to get values from the Linux L<proc(5)>
7523 filesystem or CSV (comma separated values) files.
7524
7525   <Plugin table>
7526     <Table "/proc/slabinfo">
7527       Instance "slabinfo"
7528       Separator " "
7529       <Result>
7530         Type gauge
7531         InstancePrefix "active_objs"
7532         InstancesFrom 0
7533         ValuesFrom 1
7534       </Result>
7535       <Result>
7536         Type gauge
7537         InstancePrefix "objperslab"
7538         InstancesFrom 0
7539         ValuesFrom 4
7540       </Result>
7541     </Table>
7542   </Plugin>
7543
7544 The configuration consists of one or more B<Table> blocks, each of which
7545 configures one file to parse. Within each B<Table> block, there are one or
7546 more B<Result> blocks, which configure which data to select and how to
7547 interpret it.
7548
7549 The following options are available inside a B<Table> block:
7550
7551 =over 4
7552
7553 =item B<Instance> I<instance>
7554
7555 If specified, I<instance> is used as the plugin instance. So, in the above
7556 example, the plugin name C<table-slabinfo> would be used. If omitted, the
7557 filename of the table is used instead, with all special characters replaced
7558 with an underscore (C<_>).
7559
7560 =item B<Separator> I<string>
7561
7562 Any character of I<string> is interpreted as a delimiter between the different
7563 columns of the table. A sequence of two or more contiguous delimiters in the
7564 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7565 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7566 of a table - see its documentation for more details. This option is mandatory.
7567
7568 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7569 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7570 required because of collectd's config parsing.
7571
7572 =back
7573
7574 The following options are available inside a B<Result> block:
7575
7576 =over 4
7577
7578 =item B<Type> I<type>
7579
7580 Sets the type used to dispatch the values to the daemon. Detailed information
7581 about types and their configuration can be found in L<types.db(5)>. This
7582 option is mandatory.
7583
7584 =item B<InstancePrefix> I<prefix>
7585
7586 If specified, prepend I<prefix> to the type instance. If omitted, only the
7587 B<InstancesFrom> option is considered for the type instance.
7588
7589 =item B<InstancesFrom> I<column0> [I<column1> ...]
7590
7591 If specified, the content of the given columns (identified by the column
7592 number starting at zero) will be used to create the type instance for each
7593 row. Multiple values (and the instance prefix) will be joined together with
7594 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7595 option is considered for the type instance.
7596
7597 The plugin itself does not check whether or not all built instances are
7598 different. It’s your responsibility to assure that each is unique. This is
7599 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7600 sure that the table only contains one row.
7601
7602 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7603 will be empty.
7604
7605 =item B<ValuesFrom> I<column0> [I<column1> ...]
7606
7607 Specifies the columns (identified by the column numbers starting at zero)
7608 whose content is used as the actual data for the data sets that are dispatched
7609 to the daemon. How many such columns you need is determined by the B<Type>
7610 setting above. If you specify too many or not enough columns, the plugin will
7611 complain about that and no data will be submitted to the daemon. The plugin
7612 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7613 respectively, so anything supported by those functions is supported by the
7614 plugin as well. This option is mandatory.
7615
7616 =back
7617
7618 =head2 Plugin C<tail>
7619
7620 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7621 each line and dispatches found values. What is matched can be configured by the
7622 user using (extended) regular expressions, as described in L<regex(7)>.
7623
7624   <Plugin "tail">
7625     <File "/var/log/exim4/mainlog">
7626       Instance "exim"
7627       Interval 60
7628       <Match>
7629         Regex "S=([1-9][0-9]*)"
7630         DSType "CounterAdd"
7631         Type "ipt_bytes"
7632         Instance "total"
7633       </Match>
7634       <Match>
7635         Regex "\\<R=local_user\\>"
7636         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7637         DSType "CounterInc"
7638         Type "counter"
7639         Instance "local_user"
7640       </Match>
7641       <Match>
7642         Regex "l=([0-9]*\\.[0-9]*)"
7643         <DSType "Distribution">
7644           Percentile 99
7645           Bucket 0 100
7646         </DSType>
7647         Type "latency"
7648         Instance "foo"
7649       </Match>
7650     </File>
7651   </Plugin>
7652
7653 The config consists of one or more B<File> blocks, each of which configures one
7654 logfile to parse. Within each B<File> block, there are one or more B<Match>
7655 blocks, which configure a regular expression to search for.
7656
7657 The B<Instance> option in the B<File> block may be used to set the plugin
7658 instance. So in the above example the plugin name C<tail-foo> would be used.
7659 This plugin instance is for all B<Match> blocks that B<follow> it, until the
7660 next B<Instance> option. This way you can extract several plugin instances from
7661 one logfile, handy when parsing syslog and the like.
7662
7663 The B<Interval> option allows you to define the length of time between reads. If
7664 this is not set, the default Interval will be used.
7665
7666 Each B<Match> block has the following options to describe how the match should
7667 be performed:
7668
7669 =over 4
7670
7671 =item B<Regex> I<regex>
7672
7673 Sets the regular expression to use for matching against a line. The first
7674 subexpression has to match something that can be turned into a number by
7675 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7676 below. Because B<extended> regular expressions are used, you do not need to use
7677 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7678 collectd's config parsing you need to escape backslashes, though. So if you
7679 want to match literal parentheses you need to do the following:
7680
7681   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7682
7683 =item B<ExcludeRegex> I<regex>
7684
7685 Sets an optional regular expression to use for excluding lines from the match.
7686 An example which excludes all connections from localhost from the match:
7687
7688   ExcludeRegex "127\\.0\\.0\\.1"
7689
7690 =item B<DSType> I<Type>
7691
7692 Sets how the values are cumulated. I<Type> is one of:
7693
7694 =over 4
7695
7696 =item B<GaugeAverage>
7697
7698 Calculate the average.
7699
7700 =item B<GaugeMin>
7701
7702 Use the smallest number only.
7703
7704 =item B<GaugeMax>
7705
7706 Use the greatest number only.
7707
7708 =item B<GaugeLast>
7709
7710 Use the last number found.
7711
7712 =item B<GaugePersist>
7713
7714 Use the last number found. The number is not reset at the end of an interval.
7715 It is continously reported until another number is matched. This is intended
7716 for cases in which only state changes are reported, for example a thermometer
7717 that only reports the temperature when it changes.
7718
7719 =item B<CounterSet>
7720
7721 =item B<DeriveSet>
7722
7723 =item B<AbsoluteSet>
7724
7725 The matched number is a counter. Simply I<sets> the internal counter to this
7726 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7727
7728 =item B<GaugeAdd>
7729
7730 =item B<CounterAdd>
7731
7732 =item B<DeriveAdd>
7733
7734 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7735 matched number may be negative, which will effectively subtract from the
7736 internal counter.
7737
7738 =item B<GaugeInc>
7739
7740 =item B<CounterInc>
7741
7742 =item B<DeriveInc>
7743
7744 Increase the internal counter by one. These B<DSType> are the only ones that do
7745 not use the matched subexpression, but simply count the number of matched
7746 lines. Thus, you may use a regular expression without submatch in this case.
7747
7748 =item B<Distribution>
7749
7750 Type to do calculations based on the distribution of values, primarily
7751 calculating percentiles. This is primarily geared towards latency, but can be
7752 used for other metrics as well. The range of values tracked with this setting
7753 must be in the range (0–2^34) and can be fractional. Please note that neither
7754 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
7755 distribution.
7756
7757 This option must be used together with the B<Percentile> and/or B<Bucket>
7758 options.
7759
7760 B<Synopsis:>
7761
7762   <DSType "Distribution">
7763     Percentile 99
7764     Bucket 0 100
7765   </DSType>
7766
7767 =over 4
7768
7769 =item B<Percentile> I<Percent>
7770
7771 Calculate and dispatch the configured percentile, i.e. compute the value, so
7772 that I<Percent> of all matched values are smaller than or equal to the computed
7773 latency.
7774
7775 Metrics are reported with the I<type> B<Type> (the value of the above option)
7776 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
7777
7778 This option may be repeated to calculate more than one percentile.
7779
7780 =item B<Bucket> I<lower_bound> I<upper_bound>
7781
7782 Export the number of values (a C<DERIVE>) falling within the given range. Both,
7783 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
7784 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
7785 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
7786 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
7787 lower/upper bound.
7788
7789 To export the entire (0–inf) range without overlap, use the upper bound of the
7790 previous range as the lower bound of the following range. In other words, use
7791 the following schema:
7792
7793   Bucket   0   1
7794   Bucket   1   2
7795   Bucket   2   5
7796   Bucket   5  10
7797   Bucket  10  20
7798   Bucket  20  50
7799   Bucket  50   0
7800
7801 Metrics are reported with the I<type> C<bucket> and the I<type instance>
7802 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
7803
7804 This option may be repeated to calculate more than one rate.
7805
7806 =back
7807
7808 =back
7809
7810 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
7811 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
7812 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
7813 B<Derive*> types interpret the submatch as a signed integer using
7814 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
7815 and it may be omitted in this case.
7816
7817 =item B<Type> I<Type>
7818
7819 Sets the type used to dispatch this value. Detailed information about types and
7820 their configuration can be found in L<types.db(5)>.
7821
7822 =item B<Instance> I<TypeInstance>
7823
7824 This optional setting sets the type instance to use.
7825
7826 =back
7827
7828 =head2 Plugin C<tail_csv>
7829
7830 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7831 written by I<Snort>.
7832
7833 B<Synopsis:>
7834
7835  <Plugin "tail_csv">
7836    <Metric "snort-dropped">
7837        Type "percent"
7838        Instance "dropped"
7839        Index 1
7840    </Metric>
7841    <File "/var/log/snort/snort.stats">
7842        Instance "snort-eth0"
7843        Interval 600
7844        Collect "snort-dropped"
7845    </File>
7846  </Plugin>
7847
7848 The configuration consists of one or more B<Metric> blocks that define an index
7849 into the line of the CSV file and how this value is mapped to I<collectd's>
7850 internal representation. These are followed by one or more B<Instance> blocks
7851 which configure which file to read, in which interval and which metrics to
7852 extract.
7853
7854 =over 4
7855
7856 =item E<lt>B<Metric> I<Name>E<gt>
7857
7858 The B<Metric> block configures a new metric to be extracted from the statistics
7859 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7860 only used inside the B<Instance> blocks to refer to this block, so you can use
7861 one B<Metric> block for multiple CSV files.
7862
7863 =over 4
7864
7865 =item B<Type> I<Type>
7866
7867 Configures which I<Type> to use when dispatching this metric. Types are defined
7868 in the L<types.db(5)> file, see the appropriate manual page for more
7869 information on specifying types. Only types with a single I<data source> are
7870 supported by the I<tail_csv plugin>. The information whether the value is an
7871 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7872 I<Type's> definition.
7873
7874 =item B<Instance> I<TypeInstance>
7875
7876 If set, I<TypeInstance> is used to populate the type instance field of the
7877 created value lists. Otherwise, no type instance is used.
7878
7879 =item B<ValueFrom> I<Index>
7880
7881 Configure to read the value from the field with the zero-based index I<Index>.
7882 If the value is parsed as signed integer, unsigned integer or double depends on
7883 the B<Type> setting, see above.
7884
7885 =back
7886
7887 =item E<lt>B<File> I<Path>E<gt>
7888
7889 Each B<File> block represents one CSV file to read. There must be at least one
7890 I<File> block but there can be multiple if you have multiple CSV files.
7891
7892 =over 4
7893
7894 =item B<Instance> I<PluginInstance>
7895
7896 Sets the I<plugin instance> used when dispatching the values.
7897
7898 =item B<Collect> I<Metric>
7899
7900 Specifies which I<Metric> to collect. This option must be specified at least
7901 once, and you can use this option multiple times to specify more than one
7902 metric to be extracted from this statistic file.
7903
7904 =item B<Interval> I<Seconds>
7905
7906 Configures the interval in which to read values from this instance / file.
7907 Defaults to the plugin's default interval.
7908
7909 =item B<TimeFrom> I<Index>
7910
7911 Rather than using the local time when dispatching a value, read the timestamp
7912 from the field with the zero-based index I<Index>. The value is interpreted as
7913 seconds since epoch. The value is parsed as a double and may be factional.
7914
7915 =back
7916
7917 =back
7918
7919 =head2 Plugin C<teamspeak2>
7920
7921 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
7922 polls interesting global and virtual server data. The plugin can query only one
7923 physical server but unlimited virtual servers. You can use the following
7924 options to configure it:
7925
7926 =over 4
7927
7928 =item B<Host> I<hostname/ip>
7929
7930 The hostname or ip which identifies the physical server.
7931 Default: 127.0.0.1
7932
7933 =item B<Port> I<port>
7934
7935 The query port of the physical server. This needs to be a string.
7936 Default: "51234"
7937
7938 =item B<Server> I<port>
7939
7940 This option has to be added once for every virtual server the plugin should
7941 query. If you want to query the virtual server on port 8767 this is what the
7942 option would look like:
7943
7944   Server "8767"
7945
7946 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
7947 use quotes around it! If no such statement is given only global information
7948 will be collected.
7949
7950 =back
7951
7952 =head2 Plugin C<ted>
7953
7954 The I<TED> plugin connects to a device of "The Energy Detective", a device to
7955 measure power consumption. These devices are usually connected to a serial
7956 (RS232) or USB port. The plugin opens a configured device and tries to read the
7957 current energy readings. For more information on TED, visit
7958 L<http://www.theenergydetective.com/>.
7959
7960 Available configuration options:
7961
7962 =over 4
7963
7964 =item B<Device> I<Path>
7965
7966 Path to the device on which TED is connected. collectd will need read and write
7967 permissions on that file.
7968
7969 Default: B</dev/ttyUSB0>
7970
7971 =item B<Retries> I<Num>
7972
7973 Apparently reading from TED is not that reliable. You can therefore configure a
7974 number of retries here. You only configure the I<retries> here, to if you
7975 specify zero, one reading will be performed (but no retries if that fails); if
7976 you specify three, a maximum of four readings are performed. Negative values
7977 are illegal.
7978
7979 Default: B<0>
7980
7981 =back
7982
7983 =head2 Plugin C<tcpconns>
7984
7985 The C<tcpconns plugin> counts the number of currently established TCP
7986 connections based on the local port and/or the remote port. Since there may be
7987 a lot of connections the default if to count all connections with a local port,
7988 for which a listening socket is opened. You can use the following options to
7989 fine-tune the ports you are interested in:
7990
7991 =over 4
7992
7993 =item B<ListeningPorts> I<true>|I<false>
7994
7995 If this option is set to I<true>, statistics for all local ports for which a
7996 listening socket exists are collected. The default depends on B<LocalPort> and
7997 B<RemotePort> (see below): If no port at all is specifically selected, the
7998 default is to collect listening ports. If specific ports (no matter if local or
7999 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8000 the selected ports will be collected unless this option is set to I<true>
8001 specifically.
8002
8003 =item B<LocalPort> I<Port>
8004
8005 Count the connections to a specific local port. This can be used to see how
8006 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8007 You have to specify the port in numeric form, so for the mailserver example
8008 you'd need to set B<25>.
8009
8010 =item B<RemotePort> I<Port>
8011
8012 Count the connections to a specific remote port. This is useful to see how
8013 much a remote service is used. This is most useful if you want to know how many
8014 connections a local service has opened to remote services, e.E<nbsp>g. how many
8015 connections a mail server or news server has to other mail or news servers, or
8016 how many connections a web proxy holds to web servers. You have to give the
8017 port in numeric form.
8018
8019 =item B<AllPortsSummary> I<true>|I<false>
8020
8021 If this option is set to I<true> a summary of statistics from all connections
8022 are collected. This option defaults to I<false>.
8023
8024 =back
8025
8026 =head2 Plugin C<thermal>
8027
8028 =over 4
8029
8030 =item B<ForceUseProcfs> I<true>|I<false>
8031
8032 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8033 C<sysfs> interface. If that is not available, the plugin falls back to the
8034 C<procfs> interface. By setting this option to I<true>, you can force the
8035 plugin to use the latter. This option defaults to I<false>.
8036
8037 =item B<Device> I<Device>
8038
8039 Selects the name of the thermal device that you want to collect or ignore,
8040 depending on the value of the B<IgnoreSelected> option. This option may be
8041 used multiple times to specify a list of devices.
8042
8043 See F</"IGNORELISTS"> for details.
8044
8045 =item B<IgnoreSelected> I<true>|I<false>
8046
8047 Invert the selection: If set to true, all devices B<except> the ones that
8048 match the device names specified by the B<Device> option are collected. By
8049 default only selected devices are collected if a selection is made. If no
8050 selection is configured at all, B<all> devices are selected.
8051
8052 =back
8053
8054 =head2 Plugin C<threshold>
8055
8056 The I<Threshold plugin> checks values collected or received by I<collectd>
8057 against a configurable I<threshold> and issues I<notifications> if values are
8058 out of bounds.
8059
8060 Documentation for this plugin is available in the L<collectd-threshold(5)>
8061 manual page.
8062
8063 =head2 Plugin C<tokyotyrant>
8064
8065 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8066 couple metrics: number of records, and database size on disk.
8067
8068 =over 4
8069
8070 =item B<Host> I<Hostname/IP>
8071
8072 The hostname or IP which identifies the server.
8073 Default: B<127.0.0.1>
8074
8075 =item B<Port> I<Service/Port>
8076
8077 The query port of the server. This needs to be a string, even if the port is
8078 given in its numeric form.
8079 Default: B<1978>
8080
8081 =back
8082
8083 =head2 Plugin C<turbostat>
8084
8085 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8086 Intel processors by using I<Model Specific Registers>.
8087
8088 =over 4
8089
8090 =item B<CoreCstates> I<Bitmask(Integer)>
8091
8092 Bit mask of the list of core C-states supported by the processor.
8093 This option should only be used if the automated detection fails.
8094 Default value extracted from the CPU model and family.
8095
8096 Currently supported C-states (by this plugin): 3, 6, 7
8097
8098 B<Example:>
8099
8100   All states (3, 6 and 7):
8101   (1<<3) + (1<<6) + (1<<7) = 392
8102
8103 =item B<PackageCstates> I<Bitmask(Integer)>
8104
8105 Bit mask of the list of packages C-states supported by the processor. This
8106 option should only be used if the automated detection fails. Default value
8107 extracted from the CPU model and family.
8108
8109 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8110
8111 B<Example:>
8112
8113   States 2, 3, 6 and 7:
8114   (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8115
8116 =item B<SystemManagementInterrupt> I<true>|I<false>
8117
8118 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8119 This option should only be used if the automated detection fails or if you want
8120 to disable this feature.
8121
8122 =item B<DigitalTemperatureSensor> I<true>|I<false>
8123
8124 Boolean enabling the collection of the temperature of each core. This option
8125 should only be used if the automated detection fails or if you want to disable
8126 this feature.
8127
8128 =item B<TCCActivationTemp> I<Temperature>
8129
8130 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8131 temperature is used when collecting the temperature of cores or packages. This
8132 option should only be used if the automated detection fails. Default value
8133 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8134
8135 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8136
8137 Bit mask of the list of elements to be thermally monitored. This option should
8138 only be used if the automated detection fails or if you want to disable some
8139 collections. The different bits of this bit mask accepted by this plugin are:
8140
8141 =over 4
8142
8143 =item 0 ('1'): Package
8144
8145 =item 1 ('2'): DRAM
8146
8147 =item 2 ('4'): Cores
8148
8149 =item 3 ('8'): Embedded graphic device
8150
8151 =back
8152
8153 =item B<LogicalCoreNames> I<true>|I<false>
8154
8155 Boolean enabling the use of logical core numbering for per core statistics.
8156 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8157 sequential number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8158 where I<n> is the n-th core of the socket, causing name conflicts when there is
8159 more than one socket.
8160
8161 =back
8162
8163 =head2 Plugin C<unixsock>
8164
8165 =over 4
8166
8167 =item B<SocketFile> I<Path>
8168
8169 Sets the socket-file which is to be created.
8170
8171 =item B<SocketGroup> I<Group>
8172
8173 If running as root change the group of the UNIX-socket after it has been
8174 created. Defaults to B<collectd>.
8175
8176 =item B<SocketPerms> I<Permissions>
8177
8178 Change the file permissions of the UNIX-socket after it has been created. The
8179 permissions must be given as a numeric, octal value as you would pass to
8180 L<chmod(1)>. Defaults to B<0770>.
8181
8182 =item B<DeleteSocket> B<false>|B<true>
8183
8184 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8185 with the given name already exists. If I<collectd> crashes a socket file may be
8186 left over, preventing the daemon from opening a new socket when restarted.
8187 Since this is potentially dangerous, this defaults to B<false>.
8188
8189 =back
8190
8191 =head2 Plugin C<uuid>
8192
8193 This plugin, if loaded, causes the Hostname to be taken from the machine's
8194 UUID. The UUID is a universally unique designation for the machine, usually
8195 taken from the machine's BIOS. This is most useful if the machine is running in
8196 a virtual environment such as Xen, in which case the UUID is preserved across
8197 shutdowns and migration.
8198
8199 The following methods are used to find the machine's UUID, in order:
8200
8201 =over 4
8202
8203 =item *
8204
8205 Check I</etc/uuid> (or I<UUIDFile>).
8206
8207 =item *
8208
8209 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8210 present.
8211
8212 =item *
8213
8214 Check for UUID from C<dmidecode> / SMBIOS.
8215
8216 =item *
8217
8218 Check for UUID from Xen hypervisor.
8219
8220 =back
8221
8222 If no UUID can be found then the hostname is not modified.
8223
8224 =over 4
8225
8226 =item B<UUIDFile> I<Path>
8227
8228 Take the UUID from the given file (default I</etc/uuid>).
8229
8230 =back
8231
8232 =head2 Plugin C<varnish>
8233
8234 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8235 It collects a subset of the values displayed by L<varnishstat(1)>, and
8236 organizes them in categories which can be enabled or disabled. Currently only
8237 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8238 meaning of each metric can be found in L<varnish-counters(7)>.
8239
8240 Synopsis:
8241
8242  <Plugin "varnish">
8243    <Instance "example">
8244      CollectBackend     true
8245      CollectBan         false
8246      CollectCache       true
8247      CollectConnections true
8248      CollectDirectorDNS false
8249      CollectESI         false
8250      CollectFetch       false
8251      CollectHCB         false
8252      CollectObjects     false
8253      CollectPurge       false
8254      CollectSession     false
8255      CollectSHM         true
8256      CollectSMA         false
8257      CollectSMS         false
8258      CollectSM          false
8259      CollectStruct      false
8260      CollectTotals      false
8261      CollectUptime      false
8262      CollectVCL         false
8263      CollectVSM         false
8264      CollectWorkers     false
8265    </Instance>
8266  </Plugin>
8267
8268 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8269 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8270 will collectd statistics from the default "varnishd" instance (this should work
8271 fine in most cases).
8272
8273 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8274
8275 =over 4
8276
8277 =item B<CollectBackend> B<true>|B<false>
8278
8279 Back-end connection statistics, such as successful, reused,
8280 and closed connections. True by default.
8281
8282 =item B<CollectBan> B<true>|B<false>
8283
8284 Statistics about ban operations, such as number of bans added, retired, and
8285 number of objects tested against ban operations. Only available with Varnish
8286 3.x and above. False by default.
8287
8288 =item B<CollectCache> B<true>|B<false>
8289
8290 Cache hits and misses. True by default.
8291
8292 =item B<CollectConnections> B<true>|B<false>
8293
8294 Number of client connections received, accepted and dropped. True by default.
8295
8296 =item B<CollectDirectorDNS> B<true>|B<false>
8297
8298 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8299 default.
8300
8301 =item B<CollectESI> B<true>|B<false>
8302
8303 Edge Side Includes (ESI) parse statistics. False by default.
8304
8305 =item B<CollectFetch> B<true>|B<false>
8306
8307 Statistics about fetches (HTTP requests sent to the backend). False by default.
8308
8309 =item B<CollectHCB> B<true>|B<false>
8310
8311 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8312 divided into locked and unlocked look-ups. False by default.
8313
8314 =item B<CollectObjects> B<true>|B<false>
8315
8316 Statistics on cached objects: number of objects expired, nuked (prematurely
8317 expired), saved, moved, etc. False by default.
8318
8319 =item B<CollectPurge> B<true>|B<false>
8320
8321 Statistics about purge operations, such as number of purges added, retired, and
8322 number of objects tested against purge operations. Only available with Varnish
8323 2.x. False by default.
8324
8325 =item B<CollectSession> B<true>|B<false>
8326
8327 Client session statistics. Number of past and current sessions, session herd and
8328 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8329 metrics found in the Connections and Threads sections with previous versions of
8330 Varnish have been moved here.
8331
8332 =item B<CollectSHM> B<true>|B<false>
8333
8334 Statistics about the shared memory log, a memory region to store
8335 log messages which is flushed to disk when full. True by default.
8336
8337 =item B<CollectSMA> B<true>|B<false>
8338
8339 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8340 component is Solaris specific. Only available with Varnish 2.x. False by
8341 default.
8342
8343 =item B<CollectSMS> B<true>|B<false>
8344
8345 synth (synthetic content) storage statistics. This storage
8346 component is used internally only. False by default.
8347
8348 =item B<CollectSM> B<true>|B<false>
8349
8350 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
8351 False by default.
8352
8353 =item B<CollectStruct> B<true>|B<false>
8354
8355 Current varnish internal state statistics. Number of current sessions, objects
8356 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8357 default.
8358
8359 =item B<CollectTotals> B<true>|B<false>
8360
8361 Collects overview counters, such as the number of sessions created,
8362 the number of requests and bytes transferred. False by default.
8363
8364 =item B<CollectUptime> B<true>|B<false>
8365
8366 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8367
8368 =item B<CollectVCL> B<true>|B<false>
8369
8370 Number of total (available + discarded) VCL (config files). False by default.
8371
8372 =item B<CollectVSM> B<true>|B<false>
8373
8374 Collect statistics about Varnish's shared memory usage (used by the logging and
8375 statistics subsystems). Only available with Varnish 4.x. False by default.
8376
8377 =item B<CollectWorkers> B<true>|B<false>
8378
8379 Collect statistics about worker threads. False by default.
8380
8381 =back
8382
8383 =head2 Plugin C<virt>
8384
8385 This plugin allows CPU, disk, network load and other metrics to be collected for
8386 virtualized guests on the machine. The statistics are collected through libvirt
8387 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8388 installing any additional software on guests, especially I<collectd>, which runs
8389 only on the host system.
8390
8391 Only I<Connection> is required.
8392
8393 =over 4
8394
8395 =item B<Connection> I<uri>
8396
8397 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8398
8399  Connection "xen:///"
8400
8401 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8402
8403 =item B<RefreshInterval> I<seconds>
8404
8405 Refresh the list of domains and devices every I<seconds>. The default is 60
8406 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8407 the list of domains and devices to be refreshed on every iteration.
8408
8409 Refreshing the devices in particular is quite a costly operation, so if your
8410 virtualization setup is static you might consider increasing this. If this
8411 option is set to 0, refreshing is disabled completely.
8412
8413 =item B<Domain> I<name>
8414
8415 =item B<BlockDevice> I<name:dev>
8416
8417 =item B<InterfaceDevice> I<name:dev>
8418
8419 =item B<IgnoreSelected> B<true>|B<false>
8420
8421 Select which domains and devices are collected.
8422
8423 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8424 disk/network devices are collected.
8425
8426 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8427 domains and disk/network devices are ignored, while the rest are collected.
8428
8429 The domain name and device names may use a regular expression, if the name is
8430 surrounded by I</.../> and collectd was compiled with support for regexps.
8431
8432 The default is to collect statistics for all domains and all their devices.
8433
8434 Example:
8435
8436  BlockDevice "/:hdb/"
8437  IgnoreSelected "true"
8438
8439 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8440 will be collected.
8441
8442 =item B<BlockDeviceFormat> B<target>|B<source>
8443
8444 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8445 seen by the guest will be used for reporting metrics.
8446 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8447 domain.
8448
8449 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8450 using the path of the source, e.g. an image file.
8451 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8452 domain.
8453
8454 B<Example:>
8455
8456 If the domain XML have the following device defined:
8457
8458   <disk type='block' device='disk'>
8459     <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8460     <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8461     <target dev='sda' bus='scsi'/>
8462     <boot order='2'/>
8463     <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8464   </disk>
8465
8466 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8467 to C<sda>.
8468 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8469 to C<var_lib_libvirt_images_image1.qcow2>.
8470
8471 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8472
8473 The B<BlockDeviceFormatBasename> controls whether the full path or the
8474 L<basename(1)> of the source is being used as the I<type instance> when
8475 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8476
8477 B<Example:>
8478
8479 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8480 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8481 be set to C<var_lib_libvirt_images_image1.qcow2>.
8482 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8483 set to C<image1.qcow2>.
8484
8485 =item B<HostnameFormat> B<name|uuid|hostname|...>
8486
8487 When the virt plugin logs data, it sets the hostname of the collected data
8488 according to this setting. The default is to use the guest name as provided by
8489 the hypervisor, which is equal to setting B<name>.
8490
8491 B<uuid> means use the guest's UUID. This is useful if you want to track the
8492 same guest across migrations.
8493
8494 B<hostname> means to use the global B<Hostname> setting, which is probably not
8495 useful on its own because all guests will appear to have the same name.
8496
8497 You can also specify combinations of these fields. For example B<name uuid>
8498 means to concatenate the guest name and UUID (with a literal colon character
8499 between, thus I<"foo:1234-1234-1234-1234">).
8500
8501 At the moment of writing (collectd-5.5), hostname string is limited to 62
8502 characters. In case when combination of fields exceeds 62 characters,
8503 hostname will be truncated without a warning.
8504
8505 =item B<InterfaceFormat> B<name>|B<address>
8506
8507 When the virt plugin logs interface data, it sets the name of the collected
8508 data according to this setting. The default is to use the path as provided by
8509 the hypervisor (the "dev" property of the target node), which is equal to
8510 setting B<name>.
8511
8512 B<address> means use the interface's mac address. This is useful since the
8513 interface path might change between reboots of a guest or across migrations.
8514
8515 =item B<PluginInstanceFormat> B<name|uuid|none>
8516
8517 When the virt plugin logs data, it sets the plugin_instance of the collected
8518 data according to this setting. The default is to not set the plugin_instance.
8519
8520 B<name> means use the guest's name as provided by the hypervisor.
8521 B<uuid> means use the guest's UUID.
8522
8523 You can also specify combinations of the B<name> and B<uuid> fields.
8524 For example B<name uuid> means to concatenate the guest name and UUID
8525 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8526
8527 =item B<Instances> B<integer>
8528
8529 How many read instances you want to use for this plugin. The default is one,
8530 and the sensible setting is a multiple of the B<ReadThreads> value.
8531 If you are not sure, just use the default setting.
8532
8533 =item B<ExtraStats> B<string>
8534
8535 Report additional extra statistics. The default is no extra statistics, preserving
8536 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8537 allows the plugin to reported more detailed statistics about the behaviour of
8538 Virtual Machines. The argument is a space-separated list of selectors.
8539
8540 Currently supported selectors are:
8541
8542 =over 4
8543
8544 =item B<cpu_util>: report CPU utilization per domain in percentage.
8545
8546 =item B<disk>: report extra statistics like number of flush operations and total
8547 service time for read, write and flush operations. Requires libvirt API version
8548 I<0.9.5> or later.
8549
8550 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8551 I<0.9.10> or later.
8552
8553 =item B<domain_state>: report domain state and reason in human-readable format as
8554 a notification. If libvirt API version I<0.9.2> or later is available, domain
8555 reason will be included in notification.
8556
8557 =item B<fs_info>: report file system information as a notification. Requires
8558 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8559 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8560 version supports retrieving  file system information.
8561
8562 =item B<job_stats_background>: report statistics about progress of a background
8563 job on a domain. Only one type of job statistics can be collected at the same time.
8564 Requires libvirt API version I<1.2.9> or later.
8565
8566 =item B<job_stats_completed>: report statistics about a recently completed job on
8567 a domain. Only one type of job statistics can be collected at the same time.
8568 Requires libvirt API version I<1.2.9> or later.
8569
8570 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8571 Requires libvirt API version I<0.9.11> or later.
8572
8573 =item B<perf>: report performance monitoring events. To collect performance
8574 metrics they must be enabled for domain and supported by the platform. Requires
8575 libvirt API version I<1.3.3> or later.
8576 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8577
8578 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8579
8580 =back
8581
8582 =back
8583
8584 =head2 Plugin C<vmem>
8585
8586 The C<vmem> plugin collects information about the usage of virtual memory.
8587 Since the statistics provided by the Linux kernel are very detailed, they are
8588 collected very detailed. However, to get all the details, you have to switch
8589 them on manually. Most people just want an overview over, such as the number of
8590 pages read from swap space.
8591
8592 =over 4
8593
8594 =item B<Verbose> B<true>|B<false>
8595
8596 Enables verbose collection of information. This will start collecting page
8597 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8598 Part of these statistics are collected on a "per zone" basis.
8599
8600 =back
8601
8602 =head2 Plugin C<vserver>
8603
8604 This plugin doesn't have any options. B<VServer> support is only available for
8605 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8606 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8607 need to apply the patches and compile your own kernel, which will then provide
8608 the F</proc/virtual> filesystem that is required by this plugin.
8609
8610 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8611
8612 B<Note>: The traffic collected by this plugin accounts for the amount of
8613 traffic passing a socket which might be a lot less than the actual on-wire
8614 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8615 collect on-wire traffic you could, for example, use the logging facilities of
8616 iptables to feed data for the guest IPs into the iptables plugin.
8617
8618 =head2 Plugin C<write_graphite>
8619
8620 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8621 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8622 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8623 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8624 of at most 1428 bytes to minimize the number of network packets.
8625
8626 Synopsis:
8627
8628  <Plugin write_graphite>
8629    <Node "example">
8630      Host "localhost"
8631      Port "2003"
8632      Protocol "tcp"
8633      LogSendErrors true
8634      Prefix "collectd"
8635    </Node>
8636  </Plugin>
8637
8638 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8639 blocks. Inside the B<Node> blocks, the following options are recognized:
8640
8641 =over 4
8642
8643 =item B<Host> I<Address>
8644
8645 Hostname or address to connect to. Defaults to C<localhost>.
8646
8647 =item B<Port> I<Service>
8648
8649 Service name or port number to connect to. Defaults to C<2003>.
8650
8651 =item B<Protocol> I<String>
8652
8653 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8654
8655 =item B<ReconnectInterval> I<Seconds>
8656
8657 When set to non-zero, forces the connection to the Graphite backend to be
8658 closed and re-opend periodically. This behavior is desirable in environments
8659 where the connection to the Graphite backend is done through load balancers,
8660 for example. When set to zero, the default, the connetion is kept open for as
8661 long as possible.
8662
8663 =item B<LogSendErrors> B<false>|B<true>
8664
8665 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
8666 If set to B<false>, it will not log the errors. This is especially useful when
8667 using Protocol UDP since many times we want to use the "fire-and-forget"
8668 approach and logging errors fills syslog with unneeded messages.
8669
8670 =item B<Prefix> I<String>
8671
8672 When set, I<String> is added in front of the host name. Dots and whitespace are
8673 I<not> escaped in this string (see B<EscapeCharacter> below).
8674
8675 =item B<Postfix> I<String>
8676
8677 When set, I<String> is appended to the host name. Dots and whitespace are
8678 I<not> escaped in this string (see B<EscapeCharacter> below).
8679
8680 =item B<EscapeCharacter> I<Char>
8681
8682 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
8683 in the identifier. The B<EscapeCharacter> option determines which character
8684 dots, whitespace and control characters are replaced with. Defaults to
8685 underscore (C<_>).
8686
8687 =item B<StoreRates> B<false>|B<true>
8688
8689 If set to B<true> (the default), convert counter values to rates. If set to
8690 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
8691 number.
8692
8693 =item B<SeparateInstances> B<false>|B<true>
8694
8695 If set to B<true>, the plugin instance and type instance will be in their own
8696 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8697 default), the plugin and plugin instance (and likewise the type and type
8698 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8699
8700 =item B<AlwaysAppendDS> B<false>|B<true>
8701
8702 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8703 identifier. If set to B<false> (the default), this is only done when there is
8704 more than one DS.
8705
8706 =item B<PreserveSeparator> B<false>|B<true>
8707
8708 If set to B<false> (the default) the C<.> (dot) character is replaced with
8709 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
8710 is preserved, i.e. passed through.
8711
8712 =item B<DropDuplicateFields> B<false>|B<true>
8713
8714 If set to B<true>, detect and remove duplicate components in Graphite metric
8715 names. For example, the metric name  C<host.load.load.shortterm> will
8716 be shortened to C<host.load.shortterm>.
8717
8718 =back
8719
8720 =head2 Plugin C<write_log>
8721
8722 The C<write_log> plugin writes metrics as INFO log messages.
8723
8724 This plugin supports two output formats: I<Graphite> and I<JSON>.
8725
8726 Synopsis:
8727
8728  <Plugin write_log>
8729    Format Graphite
8730  </Plugin>
8731
8732 =over 4
8733
8734 =item B<Format> I<Format>
8735
8736 The output format to use. Can be one of C<Graphite> or C<JSON>.
8737
8738 =back
8739
8740 =head2 Plugin C<write_tsdb>
8741
8742 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
8743 time series database. The plugin connects to a I<TSD>, a masterless, no shared
8744 state daemon that ingests metrics and stores them in HBase. The plugin uses
8745 I<TCP> over the "line based" protocol with a default port 4242. The data will
8746 be sent in blocks of at most 1428 bytes to minimize the number of network
8747 packets.
8748
8749 Synopsis:
8750
8751  <Plugin write_tsdb>
8752    ResolveInterval 60
8753    ResolveJitter 60
8754    <Node "example">
8755      Host "tsd-1.my.domain"
8756      Port "4242"
8757      HostTags "status=production"
8758    </Node>
8759  </Plugin>
8760
8761 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8762 blocks and global directives.
8763
8764 Global directives are:
8765
8766 =over 4
8767
8768 =item B<ResolveInterval> I<seconds>
8769
8770 =item B<ResolveJitter> I<seconds>
8771
8772 When I<collectd> connects to a TSDB node, it will request the hostname from
8773 DNS. This can become a problem if the TSDB node is unavailable or badly
8774 configured because collectd will request DNS in order to reconnect for every
8775 metric, which can flood your DNS. So you can cache the last value for
8776 I<ResolveInterval> seconds.
8777 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8778
8779 You can also define a jitter, a random interval to wait in addition to
8780 I<ResolveInterval>. This prevents all your collectd servers to resolve the
8781 hostname at the same time when the connection fails.
8782 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8783
8784 B<Note:> If the DNS resolution has already been successful when the socket
8785 closes, the plugin will try to reconnect immediately with the cached
8786 information. DNS is queried only when the socket is closed for a longer than
8787 I<ResolveInterval> + I<ResolveJitter> seconds.
8788
8789 =back
8790
8791 Inside the B<Node> blocks, the following options are recognized:
8792
8793 =over 4
8794
8795 =item B<Host> I<Address>
8796
8797 Hostname or address to connect to. Defaults to C<localhost>.
8798
8799 =item B<Port> I<Service>
8800
8801 Service name or port number to connect to. Defaults to C<4242>.
8802
8803
8804 =item B<HostTags> I<String>
8805
8806 When set, I<HostTags> is added to the end of the metric. It is intended to be
8807 used for name=value pairs that the TSD will tag the metric with. Dots and
8808 whitespace are I<not> escaped in this string.
8809
8810 =item B<StoreRates> B<false>|B<true>
8811
8812 If set to B<true>, convert counter values to rates. If set to B<false>
8813 (the default) counter values are stored as is, as an increasing
8814 integer number.
8815
8816 =item B<AlwaysAppendDS> B<false>|B<true>
8817
8818 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
8819 identifier. If set to B<false> (the default), this is only done when there is
8820 more than one DS.
8821
8822 =back
8823
8824 =head2 Plugin C<write_mongodb>
8825
8826 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
8827 NoSQL database.
8828
8829 B<Synopsis:>
8830
8831  <Plugin "write_mongodb">
8832    <Node "default">
8833      Host "localhost"
8834      Port "27017"
8835      Timeout 1000
8836      StoreRates true
8837    </Node>
8838  </Plugin>
8839
8840 The plugin can send values to multiple instances of I<MongoDB> by specifying
8841 one B<Node> block for each instance. Within the B<Node> blocks, the following
8842 options are available:
8843
8844 =over 4
8845
8846 =item B<Host> I<Address>
8847
8848 Hostname or address to connect to. Defaults to C<localhost>.
8849
8850 =item B<Port> I<Service>
8851
8852 Service name or port number to connect to. Defaults to C<27017>.
8853
8854 =item B<Timeout> I<Milliseconds>
8855
8856 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
8857 Setting this option to zero means no timeout, which is the default.
8858
8859 =item B<StoreRates> B<false>|B<true>
8860
8861 If set to B<true> (the default), convert counter values to rates. If set to
8862 B<false> counter values are stored as is, i.e. as an increasing integer
8863 number.
8864
8865 =item B<Database> I<Database>
8866
8867 =item B<User> I<User>
8868
8869 =item B<Password> I<Password>
8870
8871 Sets the information used when authenticating to a I<MongoDB> database. The
8872 fields are optional (in which case no authentication is attempted), but if you
8873 want to use authentication all three fields must be set.
8874
8875 =back
8876
8877 =head2 Plugin C<write_prometheus>
8878
8879 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
8880 using I<Prometheus>.
8881
8882 B<Options:>
8883
8884 =over 4
8885
8886 =item B<Port> I<Port>
8887
8888 Port the embedded webserver should listen on. Defaults to B<9103>.
8889
8890 =item B<StalenessDelta> I<Seconds>
8891
8892 Time in seconds after which I<Prometheus> considers a metric "stale" if it
8893 hasn't seen any update for it. This value must match the setting in Prometheus.
8894 It defaults to B<300> seconds (5 minutes), same as Prometheus.
8895
8896 B<Background:>
8897
8898 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
8899 which time a metric without updates is considered "stale". This setting
8900 effectively puts an upper limit on the interval in which metrics are reported.
8901
8902 When the I<write_prometheus plugin> encounters a metric with an interval
8903 exceeding this limit, it will inform you, the user, and provide the metric to
8904 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
8905 metric "fresh" each time it is scraped, with the time of the scrape being
8906 considered the time of the update. The result is that there appear more
8907 datapoints in I<Prometheus> than were actually created, but at least the metric
8908 doesn't disappear periodically.
8909
8910 =back
8911
8912 =head2 Plugin C<write_http>
8913
8914 This output plugin submits values to an HTTP server using POST requests and
8915 encoding metrics with JSON or using the C<PUTVAL> command described in
8916 L<collectd-unixsock(5)>.
8917
8918 Synopsis:
8919
8920  <Plugin "write_http">
8921    <Node "example">
8922      URL "http://example.com/post-collectd"
8923      User "collectd"
8924      Password "weCh3ik0"
8925      Format JSON
8926    </Node>
8927  </Plugin>
8928
8929 The plugin can send values to multiple HTTP servers by specifying one
8930 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
8931 block, the following options are available:
8932
8933 =over 4
8934
8935 =item B<URL> I<URL>
8936
8937 URL to which the values are submitted to. Mandatory.
8938
8939 =item B<User> I<Username>
8940
8941 Optional user name needed for authentication.
8942
8943 =item B<Password> I<Password>
8944
8945 Optional password needed for authentication.
8946
8947 =item B<VerifyPeer> B<true>|B<false>
8948
8949 Enable or disable peer SSL certificate verification. See
8950 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
8951
8952 =item B<VerifyHost> B<true|false>
8953
8954 Enable or disable peer host name verification. If enabled, the plugin checks if
8955 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
8956 matches the host name provided by the B<URL> option. If this identity check
8957 fails, the connection is aborted. Obviously, only works when connecting to a
8958 SSL enabled server. Enabled by default.
8959
8960 =item B<CACert> I<File>
8961
8962 File that holds one or more SSL certificates. If you want to use HTTPS you will
8963 possibly need this option. What CA certificates come bundled with C<libcurl>
8964 and are checked by default depends on the distribution you use.
8965
8966 =item B<CAPath> I<Directory>
8967
8968 Directory holding one or more CA certificate files. You can use this if for
8969 some reason all the needed CA certificates aren't in the same file and can't be
8970 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
8971 OpenSSL.
8972
8973 =item B<ClientKey> I<File>
8974
8975 File that holds the private key in PEM format to be used for certificate-based
8976 authentication.
8977
8978 =item B<ClientCert> I<File>
8979
8980 File that holds the SSL certificate to be used for certificate-based
8981 authentication.
8982
8983 =item B<ClientKeyPass> I<Password>
8984
8985 Password required to load the private key in B<ClientKey>.
8986
8987 =item B<Header> I<Header>
8988
8989 A HTTP header to add to the request.  Multiple headers are added if this option is specified more than once.  Example:
8990
8991   Header "X-Custom-Header: custom_value"
8992
8993 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
8994
8995 Define which SSL protocol version must be used. By default C<libcurl> will
8996 attempt to figure out the remote SSL protocol version. See
8997 L<curl_easy_setopt(3)> for more details.
8998
8999 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9000
9001 Format of the output to generate. If set to B<Command>, will create output that
9002 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9003 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9004 , will create output in the KairosDB format.
9005
9006 Defaults to B<Command>.
9007
9008 =item B<Attribute> I<String> I<String>
9009
9010 Only available for the KAIROSDB output format.
9011
9012 Consider the two given strings to be the key and value of an additional tag for
9013 each metric being sent out.
9014
9015 You can add multiple B<Attribute>.
9016
9017 =item B<TTL> I<Int>
9018
9019 Only available for the KAIROSDB output format.
9020
9021 Sets the Cassandra ttl for the data points.
9022
9023 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9024
9025 =item B<Metrics> B<true>|B<false>
9026
9027 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9028
9029 =item B<Notifications> B<false>|B<true>
9030
9031 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9032
9033 =item B<StoreRates> B<true|false>
9034
9035 If set to B<true>, convert counter values to rates. If set to B<false> (the
9036 default) counter values are stored as is, i.e. as an increasing integer number.
9037
9038 =item B<BufferSize> I<Bytes>
9039
9040 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9041 requests will be generated, but more metrics will be batched / metrics are
9042 cached for longer before being sent, introducing additional delay until they
9043 are available on the server side. I<Bytes> must be at least 1024 and cannot
9044 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9045 Defaults to C<4096>.
9046
9047 =item B<LowSpeedLimit> I<Bytes per Second>
9048
9049 Sets the minimal transfer rate in I<Bytes per Second> below which the
9050 connection with the HTTP server will be considered too slow and aborted. All
9051 the data submitted over this connection will probably be lost. Defaults to 0,
9052 which means no minimum transfer rate is enforced.
9053
9054 =item B<Timeout> I<Timeout>
9055
9056 Sets the maximum time in milliseconds given for HTTP POST operations to
9057 complete. When this limit is reached, the POST operation will be aborted, and
9058 all the data in the current send buffer will probably be lost. Defaults to 0,
9059 which means the connection never times out.
9060
9061 =item B<LogHttpError> B<false>|B<true>
9062
9063 Enables printing of HTTP error code to log. Turned off by default.
9064
9065 The C<write_http> plugin regularly submits the collected values to the HTTP
9066 server. How frequently this happens depends on how much data you are collecting
9067 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9068 slightly below this interval, which you can estimate by monitoring the network
9069 traffic between collectd and the HTTP server.
9070
9071 =back
9072
9073 =head2 Plugin C<write_kafka>
9074
9075 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9076 queue.
9077 Synopsis:
9078
9079  <Plugin "write_kafka">
9080    Property "metadata.broker.list" "broker1:9092,broker2:9092"
9081    <Topic "collectd">
9082      Format JSON
9083    </Topic>
9084  </Plugin>
9085
9086 The following options are understood by the I<write_kafka plugin>:
9087
9088 =over 4
9089
9090 =item E<lt>B<Topic> I<Name>E<gt>
9091
9092 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9093 is given a unique I<Name> and specifies one kafka producer.
9094 Inside the B<Topic> block, the following per-topic options are
9095 understood:
9096
9097 =over 4
9098
9099 =item B<Property> I<String> I<String>
9100
9101 Configure the named property for the current topic. Properties are
9102 forwarded to the kafka producer library B<librdkafka>.
9103
9104 =item B<Key> I<String>
9105
9106 Use the specified string as a partitioning key for the topic. Kafka breaks
9107 topic into partitions and guarantees that for a given topology, the same
9108 consumer will be used for a specific key. The special (case insensitive)
9109 string B<Random> can be used to specify that an arbitrary partition should
9110 be used.
9111
9112 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9113
9114 Selects the format in which messages are sent to the broker. If set to
9115 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9116 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9117
9118 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9119 an easy and straight forward exchange format.
9120
9121 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9122 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9123
9124 =item B<StoreRates> B<true>|B<false>
9125
9126 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9127 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9128 default), no conversion is performed. Otherwise the conversion is performed
9129 using the internal value cache.
9130
9131 Please note that currently this option is only used if the B<Format> option has
9132 been set to B<JSON>.
9133
9134 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9135
9136 A prefix can be added in the metric name when outputting in the I<Graphite>
9137 format. It's added before the I<Host> name.
9138 Metric name will be
9139 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>>
9140
9141 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9142
9143 A postfix can be added in the metric name when outputting in the I<Graphite>
9144 format. It's added after the I<Host> name.
9145 Metric name will be
9146 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>>
9147
9148 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9149
9150 Specify a character to replace dots (.) in the host part of the metric name.
9151 In I<Graphite> metric name, dots are used as separators between different
9152 metric parts (host, plugin, type).
9153 Default is C<_> (I<Underscore>).
9154
9155 =item B<GraphiteSeparateInstances> B<false>|B<true>
9156
9157 If set to B<true>, the plugin instance and type instance will be in their own
9158 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9159 default), the plugin and plugin instance (and likewise the type and type
9160 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9161
9162 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9163
9164 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9165 identifier. If set to B<false> (the default), this is only done when there is
9166 more than one DS.
9167
9168 =item B<GraphitePreserveSeparator> B<false>|B<true>
9169
9170 If set to B<false> (the default) the C<.> (dot) character is replaced with
9171 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9172 is preserved, i.e. passed through.
9173
9174 =item B<StoreRates> B<true>|B<false>
9175
9176 If set to B<true> (the default), convert counter values to rates. If set to
9177 B<false> counter values are stored as is, i.e. as an increasing integer number.
9178
9179 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9180 converted values will have "rate" appended to the data source type, e.g.
9181 C<ds_type:derive:rate>.
9182
9183 =back
9184
9185 =item B<Property> I<String> I<String>
9186
9187 Configure the kafka producer through properties, you almost always will
9188 want to set B<metadata.broker.list> to your Kafka broker list.
9189
9190 =back
9191
9192 =head2 Plugin C<write_redis>
9193
9194 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9195
9196 Synopsis:
9197
9198   <Plugin "write_redis">
9199     <Node "example">
9200         Host "localhost"
9201         Port "6379"
9202         Timeout 1000
9203         Prefix "collectd/"
9204         Database 1
9205         MaxSetSize -1
9206         StoreRates true
9207     </Node>
9208   </Plugin>
9209
9210 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9211 the timestamp as the score. Retrieving a date range can then be done using the
9212 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9213 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9214 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9215 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9216 with the B<Database> parameter (default is C<0>). See
9217 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9218 details.
9219
9220 The information shown in the synopsis above is the I<default configuration>
9221 which is used by the plugin if no configuration is present.
9222
9223 The plugin can send values to multiple instances of I<Redis> by specifying
9224 one B<Node> block for each instance. Within the B<Node> blocks, the following
9225 options are available:
9226
9227 =over 4
9228
9229 =item B<Node> I<Nodename>
9230
9231 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9232 instance running on a specified host and port. The node name is a
9233 canonical identifier which is used as I<plugin instance>. It is limited to
9234 51E<nbsp>characters in length.
9235
9236 =item B<Host> I<Hostname>
9237
9238 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9239 running on.
9240
9241 =item B<Port> I<Port>
9242
9243 The B<Port> option is the TCP port on which the Redis instance accepts
9244 connections. Either a service name of a port number may be given. Please note
9245 that numerical port numbers must be given as a string, too.
9246
9247 =item B<Timeout> I<Milliseconds>
9248
9249 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9250
9251 =item B<Prefix> I<Prefix>
9252
9253 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9254 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9255 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9256 is recommended but not required to include a trailing slash in I<Prefix>.
9257
9258 =item B<Database> I<Index>
9259
9260 This index selects the redis database to use for writing operations. Defaults
9261 to C<0>.
9262
9263 =item B<MaxSetSize> I<Items>
9264
9265 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9266 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9267
9268 =item B<StoreRates> B<true>|B<false>
9269
9270 If set to B<true> (the default), convert counter values to rates. If set to
9271 B<false> counter values are stored as is, i.e. as an increasing integer number.
9272
9273 =back
9274
9275 =head2 Plugin C<write_riemann>
9276
9277 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9278 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9279 I<Riemann> using UDP packets.
9280
9281 Synopsis:
9282
9283  <Plugin "write_riemann">
9284    <Node "example">
9285      Host "localhost"
9286      Port "5555"
9287      Protocol UDP
9288      StoreRates true
9289      AlwaysAppendDS false
9290      TTLFactor 2.0
9291    </Node>
9292    Tag "foobar"
9293    Attribute "foo" "bar"
9294  </Plugin>
9295
9296 The following options are understood by the I<write_riemann plugin>:
9297
9298 =over 4
9299
9300 =item E<lt>B<Node> I<Name>E<gt>
9301
9302 The plugin's configuration consists of one or more B<Node> blocks. Each block
9303 is given a unique I<Name> and specifies one connection to an instance of
9304 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9305 understood:
9306
9307 =over 4
9308
9309 =item B<Host> I<Address>
9310
9311 Hostname or address to connect to. Defaults to C<localhost>.
9312
9313 =item B<Port> I<Service>
9314
9315 Service name or port number to connect to. Defaults to C<5555>.
9316
9317 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9318
9319 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9320 B<TCP>.
9321
9322 =item B<TLSCertFile> I<Path>
9323
9324 When using the B<TLS> protocol, path to a PEM certificate to present
9325 to remote host.
9326
9327 =item B<TLSCAFile> I<Path>
9328
9329 When using the B<TLS> protocol, path to a PEM CA certificate to
9330 use to validate the remote hosts's identity.
9331
9332 =item B<TLSKeyFile> I<Path>
9333
9334 When using the B<TLS> protocol, path to a PEM private key associated
9335 with the certificate defined by B<TLSCertFile>.
9336
9337 =item B<Batch> B<true>|B<false>
9338
9339 If set to B<true> and B<Protocol> is set to B<TCP>,
9340 events will be batched in memory and flushed at
9341 regular intervals or when B<BatchMaxSize> is exceeded.
9342
9343 Notifications are not batched and sent as soon as possible.
9344
9345 When enabled, it can occur that events get processed by the Riemann server
9346 close to or after their expiration time. Tune the B<TTLFactor> and
9347 B<BatchMaxSize> settings according to the amount of values collected, if this
9348 is an issue.
9349
9350 Defaults to true
9351
9352 =item B<BatchMaxSize> I<size>
9353
9354 Maximum payload size for a riemann packet. Defaults to 8192
9355
9356 =item B<BatchFlushTimeout> I<seconds>
9357
9358 Maximum amount of seconds to wait in between to batch flushes.
9359 No timeout by default.
9360
9361 =item B<StoreRates> B<true>|B<false>
9362
9363 If set to B<true> (the default), convert counter values to rates. If set to
9364 B<false> counter values are stored as is, i.e. as an increasing integer number.
9365
9366 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9367 converted values will have "rate" appended to the data source type, e.g.
9368 C<ds_type:derive:rate>.
9369
9370 =item B<AlwaysAppendDS> B<false>|B<true>
9371
9372 If set to B<true>, append the name of the I<Data Source> (DS) to the
9373 "service", i.e. the field that, together with the "host" field, uniquely
9374 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9375 only done when there is more than one DS.
9376
9377 =item B<TTLFactor> I<Factor>
9378
9379 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9380 event is considered active. I<collectd> populates this field based on the
9381 metrics interval setting. This setting controls the factor with which the
9382 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9383 know exactly what you're doing, you should only increase this setting from its
9384 default value.
9385
9386 =item B<Notifications> B<false>|B<true>
9387
9388 If set to B<true>, create riemann events for notifications. This is B<true>
9389 by default. When processing thresholds from write_riemann, it might prove
9390 useful to avoid getting notification events.
9391
9392 =item B<CheckThresholds> B<false>|B<true>
9393
9394 If set to B<true>, attach state to events based on thresholds defined
9395 in the B<Threshold> plugin. Defaults to B<false>.
9396
9397 =item B<EventServicePrefix> I<String>
9398
9399 Add the given string as a prefix to the event service name.
9400 If B<EventServicePrefix> not set or set to an empty string (""),
9401 no prefix will be used.
9402
9403 =back
9404
9405 =item B<Tag> I<String>
9406
9407 Add the given string as an additional tag to the metric being sent to
9408 I<Riemann>.
9409
9410 =item B<Attribute> I<String> I<String>
9411
9412 Consider the two given strings to be the key and value of an additional
9413 attribute for each metric being sent out to I<Riemann>.
9414
9415 =back
9416
9417 =head2 Plugin C<write_sensu>
9418
9419 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9420 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9421 a local I<Sensu> client using a TCP socket.
9422
9423 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9424 parameter so it is not possible to use one collectd instance as a gateway for
9425 others. Each collectd host must pair with one I<Sensu> client.
9426
9427 Synopsis:
9428
9429  <Plugin "write_sensu">
9430    <Node "example">
9431      Host "localhost"
9432      Port "3030"
9433      StoreRates true
9434      AlwaysAppendDS false
9435      MetricHandler "influx"
9436      MetricHandler "default"
9437      NotificationHandler "flapjack"
9438      NotificationHandler "howling_monkey"
9439      Notifications true
9440    </Node>
9441    Tag "foobar"
9442    Attribute "foo" "bar"
9443  </Plugin>
9444
9445 The following options are understood by the I<write_sensu plugin>:
9446
9447 =over 4
9448
9449 =item E<lt>B<Node> I<Name>E<gt>
9450
9451 The plugin's configuration consists of one or more B<Node> blocks. Each block
9452 is given a unique I<Name> and specifies one connection to an instance of
9453 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9454 understood:
9455
9456 =over 4
9457
9458 =item B<Host> I<Address>
9459
9460 Hostname or address to connect to. Defaults to C<localhost>.
9461
9462 =item B<Port> I<Service>
9463
9464 Service name or port number to connect to. Defaults to C<3030>.
9465
9466 =item B<StoreRates> B<true>|B<false>
9467
9468 If set to B<true> (the default), convert counter values to rates. If set to
9469 B<false> counter values are stored as is, i.e. as an increasing integer number.
9470
9471 This will be reflected in the C<collectd_data_source_type> tag: If
9472 B<StoreRates> is enabled, converted values will have "rate" appended to the
9473 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
9474
9475 =item B<AlwaysAppendDS> B<false>|B<true>
9476
9477 If set the B<true>, append the name of the I<Data Source> (DS) to the
9478 "service", i.e. the field that, together with the "host" field, uniquely
9479 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9480 only done when there is more than one DS.
9481
9482 =item B<Notifications> B<false>|B<true>
9483
9484 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9485 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9486
9487 =item B<Metrics> B<false>|B<true>
9488
9489 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9490 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9491
9492
9493 =item B<Separator> I<String>
9494
9495 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9496
9497 =item B<MetricHandler> I<String>
9498
9499 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9500 several of them, one per line. Defaults to no handler.
9501
9502 =item B<NotificationHandler> I<String>
9503
9504 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9505 add several of them, one per line. Defaults to no handler.
9506
9507 =item B<EventServicePrefix> I<String>
9508
9509 Add the given string as a prefix to the event service name.
9510 If B<EventServicePrefix> not set or set to an empty string (""),
9511 no prefix will be used.
9512
9513 =back
9514
9515 =item B<Tag> I<String>
9516
9517 Add the given string as an additional tag to the metric being sent to
9518 I<Sensu>.
9519
9520 =item B<Attribute> I<String> I<String>
9521
9522 Consider the two given strings to be the key and value of an additional
9523 attribute for each metric being sent out to I<Sensu>.
9524
9525 =back
9526
9527 =head2 Plugin C<xencpu>
9528
9529 This plugin collects metrics of hardware CPU load for machine running Xen
9530 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9531 Result is reported using the C<percent> type, for each CPU (core).
9532
9533 This plugin doesn't have any options (yet).
9534
9535 =head2 Plugin C<zookeeper>
9536
9537 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9538 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
9539 client port.
9540
9541 B<Synopsis:>
9542
9543  <Plugin "zookeeper">
9544    Host "127.0.0.1"
9545    Port "2181"
9546  </Plugin>
9547
9548 =over 4
9549
9550 =item B<Host> I<Address>
9551
9552 Hostname or address to connect to. Defaults to C<localhost>.
9553
9554 =item B<Port> I<Service>
9555
9556 Service name or port number to connect to. Defaults to C<2181>.
9557
9558 =back
9559
9560 =head1 THRESHOLD CONFIGURATION
9561
9562 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9563 we mean that the values are not only stored or sent somewhere, but that they
9564 are judged and, if a problem is recognized, acted upon. The only action
9565 collectd takes itself is to generate and dispatch a "notification". Plugins can
9566 register to receive notifications and perform appropriate further actions.
9567
9568 Since systems and what you expect them to do differ a lot, you can configure
9569 B<thresholds> for your values freely. This gives you a lot of flexibility but
9570 also a lot of responsibility.
9571
9572 Every time a value is out of range a notification is dispatched. This means
9573 that the idle percentage of your CPU needs to be less then the configured
9574 threshold only once for a notification to be generated. There's no such thing
9575 as a moving average or similar - at least not now.
9576
9577 Also, all values that match a threshold are considered to be relevant or
9578 "interesting". As a consequence collectd will issue a notification if they are
9579 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9580 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9581 "2" (the default) and some hosts sends it's CPU statistics to the server every
9582 60 seconds, a notification will be dispatched after about 120 seconds. It may
9583 take a little longer because the timeout is checked only once each B<Interval>
9584 on the server.
9585
9586 When a value comes within range again or is received after it was missing, an
9587 "OKAY-notification" is dispatched.
9588
9589 Here is a configuration example to get you started. Read below for more
9590 information.
9591
9592  <Plugin threshold>
9593    <Type "foo">
9594      WarningMin    0.00
9595      WarningMax 1000.00
9596      FailureMin    0.00
9597      FailureMax 1200.00
9598      Invert false
9599      Instance "bar"
9600    </Type>
9601
9602    <Plugin "interface">
9603      Instance "eth0"
9604      <Type "if_octets">
9605        FailureMax 10000000
9606        DataSource "rx"
9607      </Type>
9608    </Plugin>
9609
9610    <Host "hostname">
9611      <Type "cpu">
9612        Instance "idle"
9613        FailureMin 10
9614      </Type>
9615
9616      <Plugin "memory">
9617        <Type "memory">
9618          Instance "cached"
9619          WarningMin 100000000
9620        </Type>
9621      </Plugin>
9622    </Host>
9623  </Plugin>
9624
9625 There are basically two types of configuration statements: The C<Host>,
9626 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9627 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9628 C<Instance> option. You can combine the block by nesting the blocks, though
9629 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9630 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9631 C<Type> may not contain other blocks. If multiple blocks apply to the same
9632 value the most specific block is used.
9633
9634 The other statements specify the threshold to configure. They B<must> be
9635 included in a C<Type> block. Currently the following statements are recognized:
9636
9637 =over 4
9638
9639 =item B<FailureMax> I<Value>
9640
9641 =item B<WarningMax> I<Value>
9642
9643 Sets the upper bound of acceptable values. If unset defaults to positive
9644 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
9645 will be created. If the value is greater than B<WarningMax> but less than (or
9646 equal to) B<FailureMax> a B<WARNING> notification will be created.
9647
9648 =item B<FailureMin> I<Value>
9649
9650 =item B<WarningMin> I<Value>
9651
9652 Sets the lower bound of acceptable values. If unset defaults to negative
9653 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
9654 be created. If the value is less than B<WarningMin> but greater than (or equal
9655 to) B<FailureMin> a B<WARNING> notification will be created.
9656
9657 =item B<DataSource> I<DSName>
9658
9659 Some data sets have more than one "data source". Interesting examples are the
9660 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
9661 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
9662 system load data set, C<load>, even has three data sources: C<shortterm>,
9663 C<midterm>, and C<longterm>.
9664
9665 Normally, all data sources are checked against a configured threshold. If this
9666 is undesirable, or if you want to specify different limits for each data
9667 source, you can use the B<DataSource> option to have a threshold apply only to
9668 one data source.
9669
9670 =item B<Invert> B<true>|B<false>
9671
9672 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
9673 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
9674 B<WarningMax>) are not okay. Defaults to B<false>.
9675
9676 =item B<Persist> B<true>|B<false>
9677
9678 Sets how often notifications are generated. If set to B<true> one notification
9679 will be generated for each value that is out of the acceptable range. If set to
9680 B<false> (the default) then a notification is only generated if a value is out
9681 of range but the previous value was okay.
9682
9683 This applies to missing values, too: If set to B<true> a notification about a
9684 missing value is generated once every B<Interval> seconds. If set to B<false>
9685 only one such notification is generated until the value appears again.
9686
9687 =item B<Percentage> B<true>|B<false>
9688
9689 If set to B<true>, the minimum and maximum values given are interpreted as
9690 percentage value, relative to the other data sources. This is helpful for
9691 example for the "df" type, where you may want to issue a warning when less than
9692 5E<nbsp>% of the total space is available. Defaults to B<false>.
9693
9694 =item B<Hits> I<Number>
9695
9696 Delay creating the notification until the threshold has been passed I<Number>
9697 times. When a notification has been generated, or when a subsequent value is
9698 inside the threshold, the counter is reset. If, for example, a value is
9699 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
9700 will be dispatched at most once every 30E<nbsp>seconds.
9701
9702 This is useful when short bursts are not a problem. If, for example, 100% CPU
9703 usage for up to a minute is normal (and data is collected every
9704 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
9705
9706 =item B<Hysteresis> I<Number>
9707
9708 When set to non-zero, a hysteresis value is applied when checking minimum and
9709 maximum bounds. This is useful for values that increase slowly and fluctuate a
9710 bit while doing so. When these values come close to the threshold, they may
9711 "flap", i.e. switch between failure / warning case and okay case repeatedly.
9712
9713 If, for example, the threshold is configures as
9714
9715   WarningMax 100.0
9716   Hysteresis 1.0
9717
9718 then a I<Warning> notification is created when the value exceeds I<101> and the
9719 corresponding I<Okay> notification is only created once the value falls below
9720 I<99>, thus avoiding the "flapping".
9721
9722 =back
9723
9724 =head1 FILTER CONFIGURATION
9725
9726 Starting with collectd 4.6 there is a powerful filtering infrastructure
9727 implemented in the daemon. The concept has mostly been copied from
9728 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
9729 terminology, so that users that are familiar with iptables feel right at home.
9730
9731 =head2 Terminology
9732
9733 The following are the terms used in the remainder of the filter configuration
9734 documentation. For an ASCII-art schema of the mechanism, see
9735 L<"General structure"> below.
9736
9737 =over 4
9738
9739 =item B<Match>
9740
9741 A I<match> is a criteria to select specific values. Examples are, of course, the
9742 name of the value or it's current value.
9743
9744 Matches are implemented in plugins which you have to load prior to using the
9745 match. The name of such plugins starts with the "match_" prefix.
9746
9747 =item B<Target>
9748
9749 A I<target> is some action that is to be performed with data. Such actions
9750 could, for example, be to change part of the value's identifier or to ignore
9751 the value completely.
9752
9753 Some of these targets are built into the daemon, see L<"Built-in targets">
9754 below. Other targets are implemented in plugins which you have to load prior to
9755 using the target. The name of such plugins starts with the "target_" prefix.
9756
9757 =item B<Rule>
9758
9759 The combination of any number of matches and at least one target is called a
9760 I<rule>. The target actions will be performed for all values for which B<all>
9761 matches apply. If the rule does not have any matches associated with it, the
9762 target action will be performed for all values.
9763
9764 =item B<Chain>
9765
9766 A I<chain> is a list of rules and possibly default targets. The rules are tried
9767 in order and if one matches, the associated target will be called. If a value
9768 is handled by a rule, it depends on the target whether or not any subsequent
9769 rules are considered or if traversal of the chain is aborted, see
9770 L<"Flow control"> below. After all rules have been checked, the default targets
9771 will be executed.
9772
9773 =back
9774
9775 =head2 General structure
9776
9777 The following shows the resulting structure:
9778
9779  +---------+
9780  ! Chain   !
9781  +---------+
9782       !
9783       V
9784  +---------+  +---------+  +---------+  +---------+
9785  ! Rule    !->! Match   !->! Match   !->! Target  !
9786  +---------+  +---------+  +---------+  +---------+
9787       !
9788       V
9789  +---------+  +---------+  +---------+
9790  ! Rule    !->! Target  !->! Target  !
9791  +---------+  +---------+  +---------+
9792       !
9793       V
9794       :
9795       :
9796       !
9797       V
9798  +---------+  +---------+  +---------+
9799  ! Rule    !->! Match   !->! Target  !
9800  +---------+  +---------+  +---------+
9801       !
9802       V
9803  +---------+
9804  ! Default !
9805  ! Target  !
9806  +---------+
9807
9808 =head2 Flow control
9809
9810 There are four ways to control which way a value takes through the filter
9811 mechanism:
9812
9813 =over 4
9814
9815 =item B<jump>
9816
9817 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
9818 process the value with another chain. When the called chain finishes, usually
9819 the next target or rule after the jump is executed.
9820
9821 =item B<stop>
9822
9823 The stop condition, signaled for example by the built-in target B<stop>, causes
9824 all processing of the value to be stopped immediately.
9825
9826 =item B<return>
9827
9828 Causes processing in the current chain to be aborted, but processing of the
9829 value generally will continue. This means that if the chain was called via
9830 B<Jump>, the next target or rule after the jump will be executed. If the chain
9831 was not called by another chain, control will be returned to the daemon and it
9832 may pass the value to another chain.
9833
9834 =item B<continue>
9835
9836 Most targets will signal the B<continue> condition, meaning that processing
9837 should continue normally. There is no special built-in target for this
9838 condition.
9839
9840 =back
9841
9842 =head2 Synopsis
9843
9844 The configuration reflects this structure directly:
9845
9846  PostCacheChain "PostCache"
9847  <Chain "PostCache">
9848    <Rule "ignore_mysql_show">
9849      <Match "regex">
9850        Plugin "^mysql$"
9851        Type "^mysql_command$"
9852        TypeInstance "^show_"
9853      </Match>
9854      <Target "stop">
9855      </Target>
9856    </Rule>
9857    <Target "write">
9858      Plugin "rrdtool"
9859    </Target>
9860  </Chain>
9861
9862 The above configuration example will ignore all values where the plugin field
9863 is "mysql", the type is "mysql_command" and the type instance begins with
9864 "show_". All other values will be sent to the C<rrdtool> write plugin via the
9865 default target of the chain. Since this chain is run after the value has been
9866 added to the cache, the MySQL C<show_*> command statistics will be available
9867 via the C<unixsock> plugin.
9868
9869 =head2 List of configuration options
9870
9871 =over 4
9872
9873 =item B<PreCacheChain> I<ChainName>
9874
9875 =item B<PostCacheChain> I<ChainName>
9876
9877 Configure the name of the "pre-cache chain" and the "post-cache chain". The
9878 argument is the name of a I<chain> that should be executed before and/or after
9879 the values have been added to the cache.
9880
9881 To understand the implications, it's important you know what is going on inside
9882 I<collectd>. The following diagram shows how values are passed from the
9883 read-plugins to the write-plugins:
9884
9885    +---------------+
9886    !  Read-Plugin  !
9887    +-------+-------+
9888            !
9889  + - - - - V - - - - +
9890  : +---------------+ :
9891  : !   Pre-Cache   ! :
9892  : !     Chain     ! :
9893  : +-------+-------+ :
9894  :         !         :
9895  :         V         :
9896  : +-------+-------+ :  +---------------+
9897  : !     Cache     !--->!  Value Cache  !
9898  : !     insert    ! :  +---+---+-------+
9899  : +-------+-------+ :      !   !
9900  :         !   ,------------'   !
9901  :         V   V     :          V
9902  : +-------+---+---+ :  +-------+-------+
9903  : !  Post-Cache   +--->! Write-Plugins !
9904  : !     Chain     ! :  +---------------+
9905  : +---------------+ :
9906  :                   :
9907  :  dispatch values  :
9908  + - - - - - - - - - +
9909
9910 After the values are passed from the "read" plugins to the dispatch functions,
9911 the pre-cache chain is run first. The values are added to the internal cache
9912 afterwards. The post-cache chain is run after the values have been added to the
9913 cache. So why is it such a huge deal if chains are run before or after the
9914 values have been added to this cache?
9915
9916 Targets that change the identifier of a value list should be executed before
9917 the values are added to the cache, so that the name in the cache matches the
9918 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
9919 this cache to receive a list of all available values. If you change the
9920 identifier after the value list has been added to the cache, this may easily
9921 lead to confusion, but it's not forbidden of course.
9922
9923 The cache is also used to convert counter values to rates. These rates are, for
9924 example, used by the C<value> match (see below). If you use the rate stored in
9925 the cache B<before> the new value is added, you will use the old, B<previous>
9926 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
9927 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
9928 command.
9929
9930 Last but not last, the B<stop> target makes a difference: If the pre-cache
9931 chain returns the stop condition, the value will not be added to the cache and
9932 the post-cache chain will not be run.
9933
9934 =item B<Chain> I<Name>
9935
9936 Adds a new chain with a certain name. This name can be used to refer to a
9937 specific chain, for example to jump to it.
9938
9939 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
9940
9941 =item B<Rule> [I<Name>]
9942
9943 Adds a new rule to the current chain. The name of the rule is optional and
9944 currently has no meaning for the daemon.
9945
9946 Within the B<Rule> block, there may be any number of B<Match> blocks and there
9947 must be at least one B<Target> block.
9948
9949 =item B<Match> I<Name>
9950
9951 Adds a match to a B<Rule> block. The name specifies what kind of match should
9952 be performed. Available matches depend on the plugins that have been loaded.
9953
9954 The arguments inside the B<Match> block are passed to the plugin implementing
9955 the match, so which arguments are valid here depends on the plugin being used.
9956 If you do not need any to pass any arguments to a match, you can use the
9957 shorter syntax:
9958
9959  Match "foobar"
9960
9961 Which is equivalent to:
9962
9963  <Match "foobar">
9964  </Match>
9965
9966 =item B<Target> I<Name>
9967
9968 Add a target to a rule or a default target to a chain. The name specifies what
9969 kind of target is to be added. Which targets are available depends on the
9970 plugins being loaded.
9971
9972 The arguments inside the B<Target> block are passed to the plugin implementing
9973 the target, so which arguments are valid here depends on the plugin being used.
9974 If you do not need any to pass any arguments to a target, you can use the
9975 shorter syntax:
9976
9977  Target "stop"
9978
9979 This is the same as writing:
9980
9981  <Target "stop">
9982  </Target>
9983
9984 =back
9985
9986 =head2 Built-in targets
9987
9988 The following targets are built into the core daemon and therefore need no
9989 plugins to be loaded:
9990
9991 =over 4
9992
9993 =item B<return>
9994
9995 Signals the "return" condition, see the L<"Flow control"> section above. This
9996 causes the current chain to stop processing the value and returns control to
9997 the calling chain. The calling chain will continue processing targets and rules
9998 just after the B<jump> target (see below). This is very similar to the
9999 B<RETURN> target of iptables, see L<iptables(8)>.
10000
10001 This target does not have any options.
10002
10003 Example:
10004
10005  Target "return"
10006
10007 =item B<stop>
10008
10009 Signals the "stop" condition, see the L<"Flow control"> section above. This
10010 causes processing of the value to be aborted immediately. This is similar to
10011 the B<DROP> target of iptables, see L<iptables(8)>.
10012
10013 This target does not have any options.
10014
10015 Example:
10016
10017  Target "stop"
10018
10019 =item B<write>
10020
10021 Sends the value to "write" plugins.
10022
10023 Available options:
10024
10025 =over 4
10026
10027 =item B<Plugin> I<Name>
10028
10029 Name of the write plugin to which the data should be sent. This option may be
10030 given multiple times to send the data to more than one write plugin. If the
10031 plugin supports multiple instances, the plugin's instance(s) must also be
10032 specified.
10033
10034 =back
10035
10036 If no plugin is explicitly specified, the values will be sent to all available
10037 write plugins.
10038
10039 Single-instance plugin example:
10040
10041  <Target "write">
10042    Plugin "rrdtool"
10043  </Target>
10044
10045 Multi-instance plugin example:
10046
10047  <Plugin "write_graphite">
10048    <Node "foo">
10049    ...
10050    </Node>
10051    <Node "bar">
10052    ...
10053    </Node>
10054  </Plugin>
10055   ...
10056  <Target "write">
10057    Plugin "write_graphite/foo"
10058  </Target>
10059
10060 =item B<jump>
10061
10062 Starts processing the rules of another chain, see L<"Flow control"> above. If
10063 the end of that chain is reached, or a stop condition is encountered,
10064 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10065 next target or the next rule. This is similar to the B<-j> command line option
10066 of iptables, see L<iptables(8)>.
10067
10068 Available options:
10069
10070 =over 4
10071
10072 =item B<Chain> I<Name>
10073
10074 Jumps to the chain I<Name>. This argument is required and may appear only once.
10075
10076 =back
10077
10078 Example:
10079
10080  <Target "jump">
10081    Chain "foobar"
10082  </Target>
10083
10084 =back
10085
10086 =head2 Available matches
10087
10088 =over 4
10089
10090 =item B<regex>
10091
10092 Matches a value using regular expressions.
10093
10094 Available options:
10095
10096 =over 4
10097
10098 =item B<Host> I<Regex>
10099
10100 =item B<Plugin> I<Regex>
10101
10102 =item B<PluginInstance> I<Regex>
10103
10104 =item B<Type> I<Regex>
10105
10106 =item B<TypeInstance> I<Regex>
10107
10108 =item B<MetaData> I<String> I<Regex>
10109
10110 Match values where the given regular expressions match the various fields of
10111 the identifier of a value. If multiple regular expressions are given, B<all>
10112 regexen must match for a value to match.
10113
10114 =item B<Invert> B<false>|B<true>
10115
10116 When set to B<true>, the result of the match is inverted, i.e. all value lists
10117 where all regular expressions apply are not matched, all other value lists are
10118 matched. Defaults to B<false>.
10119
10120 =back
10121
10122 Example:
10123
10124  <Match "regex">
10125    Host "customer[0-9]+"
10126    Plugin "^foobar$"
10127  </Match>
10128
10129 =item B<timediff>
10130
10131 Matches values that have a time which differs from the time on the server.
10132
10133 This match is mainly intended for servers that receive values over the
10134 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10135 is very sensitive to the timestamp used when updating the RRD files. In
10136 particular, the time must be ever increasing. If a misbehaving client sends one
10137 packet with a timestamp far in the future, all further packets with a correct
10138 time will be ignored because of that one packet. What's worse, such corrupted
10139 RRD files are hard to fix.
10140
10141 This match lets one match all values B<outside> a specified time range
10142 (relative to the server's time), so you can use the B<stop> target (see below)
10143 to ignore the value, for example.
10144
10145 Available options:
10146
10147 =over 4
10148
10149 =item B<Future> I<Seconds>
10150
10151 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10152 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10153 non-zero.
10154
10155 =item B<Past> I<Seconds>
10156
10157 Matches all values that are I<behind> of the server's time by I<Seconds> or
10158 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10159 non-zero.
10160
10161 =back
10162
10163 Example:
10164
10165  <Match "timediff">
10166    Future  300
10167    Past   3600
10168  </Match>
10169
10170 This example matches all values that are five minutes or more ahead of the
10171 server or one hour (or more) lagging behind.
10172
10173 =item B<value>
10174
10175 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10176 values. If a data-set consists of more than one data-source, all data-sources
10177 must match the specified ranges for a positive match.
10178
10179 Available options:
10180
10181 =over 4
10182
10183 =item B<Min> I<Value>
10184
10185 Sets the smallest value which still results in a match. If unset, behaves like
10186 negative infinity.
10187
10188 =item B<Max> I<Value>
10189
10190 Sets the largest value which still results in a match. If unset, behaves like
10191 positive infinity.
10192
10193 =item B<Invert> B<true>|B<false>
10194
10195 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10196 no-match is returned and vice versa. Please note that the B<Invert> setting
10197 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10198 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10199
10200 =item B<DataSource> I<DSName> [I<DSName> ...]
10201
10202 Select one or more of the data sources. If no data source is configured, all
10203 data sources will be checked. If the type handled by the match does not have a
10204 data source of the specified name(s), this will always result in no match
10205 (independent of the B<Invert> setting).
10206
10207 =item B<Satisfy> B<Any>|B<All>
10208
10209 Specifies how checking with several data sources is performed. If set to
10210 B<Any>, the match succeeds if one of the data sources is in the configured
10211 range. If set to B<All> the match only succeeds if all data sources are within
10212 the configured range. Default is B<All>.
10213
10214 Usually B<All> is used for positive matches, B<Any> is used for negative
10215 matches. This means that with B<All> you usually check that all values are in a
10216 "good" range, while with B<Any> you check if any value is within a "bad" range
10217 (or outside the "good" range).
10218
10219 =back
10220
10221 Either B<Min> or B<Max>, but not both, may be unset.
10222
10223 Example:
10224
10225  # Match all values smaller than or equal to 100. Matches only if all data
10226  # sources are below 100.
10227  <Match "value">
10228    Max 100
10229    Satisfy "All"
10230  </Match>
10231
10232  # Match if the value of any data source is outside the range of 0 - 100.
10233  <Match "value">
10234    Min   0
10235    Max 100
10236    Invert true
10237    Satisfy "Any"
10238  </Match>
10239
10240 =item B<empty_counter>
10241
10242 Matches all values with one or more data sources of type B<COUNTER> and where
10243 all counter values are zero. These counters usually I<never> increased since
10244 they started existing (and are therefore uninteresting), or got reset recently
10245 or overflowed and you had really, I<really> bad luck.
10246
10247 Please keep in mind that ignoring such counters can result in confusing
10248 behavior: Counters which hardly ever increase will be zero for long periods of
10249 time. If the counter is reset for some reason (machine or service restarted,
10250 usually), the graph will be empty (NAN) for a long time. People may not
10251 understand why.
10252
10253 =item B<hashed>
10254
10255 Calculates a hash value of the host name and matches values according to that
10256 hash value. This makes it possible to divide all hosts into groups and match
10257 only values that are in a specific group. The intended use is in load
10258 balancing, where you want to handle only part of all data and leave the rest
10259 for other servers.
10260
10261 The hashing function used tries to distribute the hosts evenly. First, it
10262 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10263
10264   hash_value = 0;
10265   for (i = 0; host[i] != 0; i++)
10266     hash_value = (hash_value * 251) + host[i];
10267
10268 The constant 251 is a prime number which is supposed to make this hash value
10269 more random. The code then checks the group for this host according to the
10270 I<Total> and I<Match> arguments:
10271
10272   if ((hash_value % Total) == Match)
10273     matches;
10274   else
10275     does not match;
10276
10277 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10278 groups), then the least significant bit of the hash value will be the XOR of
10279 all least significant bits in the host name. One consequence is that when you
10280 have two hosts, "server0.example.com" and "server1.example.com", where the host
10281 name differs in one digit only and the digits differ by one, those hosts will
10282 never end up in the same group.
10283
10284 Available options:
10285
10286 =over 4
10287
10288 =item B<Match> I<Match> I<Total>
10289
10290 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10291 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10292 be smaller than I<Total>. I<Total> must be at least one, although only values
10293 greater than one really do make any sense.
10294
10295 You can repeat this option to match multiple groups, for example:
10296
10297   Match 3 7
10298   Match 5 7
10299
10300 The above config will divide the data into seven groups and match groups three
10301 and five. One use would be to keep every value on two hosts so that if one
10302 fails the missing data can later be reconstructed from the second host.
10303
10304 =back
10305
10306 Example:
10307
10308  # Operate on the pre-cache chain, so that ignored values are not even in the
10309  # global cache.
10310  <Chain "PreCache">
10311    <Rule>
10312      <Match "hashed">
10313        # Divide all received hosts in seven groups and accept all hosts in
10314        # group three.
10315        Match 3 7
10316      </Match>
10317      # If matched: Return and continue.
10318      Target "return"
10319    </Rule>
10320    # If not matched: Return and stop.
10321    Target "stop"
10322  </Chain>
10323
10324 =back
10325
10326 =head2 Available targets
10327
10328 =over 4
10329
10330 =item B<notification>
10331
10332 Creates and dispatches a notification.
10333
10334 Available options:
10335
10336 =over 4
10337
10338 =item B<Message> I<String>
10339
10340 This required option sets the message of the notification. The following
10341 placeholders will be replaced by an appropriate value:
10342
10343 =over 4
10344
10345 =item B<%{host}>
10346
10347 =item B<%{plugin}>
10348
10349 =item B<%{plugin_instance}>
10350
10351 =item B<%{type}>
10352
10353 =item B<%{type_instance}>
10354
10355 These placeholders are replaced by the identifier field of the same name.
10356
10357 =item B<%{ds:>I<name>B<}>
10358
10359 These placeholders are replaced by a (hopefully) human readable representation
10360 of the current rate of this data source. If you changed the instance name
10361 (using the B<set> or B<replace> targets, see below), it may not be possible to
10362 convert counter values to rates.
10363
10364 =back
10365
10366 Please note that these placeholders are B<case sensitive>!
10367
10368 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10369
10370 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10371 used.
10372
10373 =back
10374
10375 Example:
10376
10377   <Target "notification">
10378     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10379     Severity "WARNING"
10380   </Target>
10381
10382 =item B<replace>
10383
10384 Replaces parts of the identifier using regular expressions.
10385
10386 Available options:
10387
10388 =over 4
10389
10390 =item B<Host> I<Regex> I<Replacement>
10391
10392 =item B<Plugin> I<Regex> I<Replacement>
10393
10394 =item B<PluginInstance> I<Regex> I<Replacement>
10395
10396 =item B<TypeInstance> I<Regex> I<Replacement>
10397
10398 =item B<MetaData> I<String> I<Regex> I<Replacement>
10399
10400 =item B<DeleteMetaData> I<String> I<Regex>
10401
10402 Match the appropriate field with the given regular expression I<Regex>. If the
10403 regular expression matches, that part that matches is replaced with
10404 I<Replacement>. If multiple places of the input buffer match a given regular
10405 expression, only the first occurrence will be replaced.
10406
10407 You can specify each option multiple times to use multiple regular expressions
10408 one after another.
10409
10410 =back
10411
10412 Example:
10413
10414  <Target "replace">
10415    # Replace "example.net" with "example.com"
10416    Host "\\<example.net\\>" "example.com"
10417
10418    # Strip "www." from hostnames
10419    Host "\\<www\\." ""
10420  </Target>
10421
10422 =item B<set>
10423
10424 Sets part of the identifier of a value to a given string.
10425
10426 Available options:
10427
10428 =over 4
10429
10430 =item B<Host> I<String>
10431
10432 =item B<Plugin> I<String>
10433
10434 =item B<PluginInstance> I<String>
10435
10436 =item B<TypeInstance> I<String>
10437
10438 =item B<MetaData> I<String> I<String>
10439
10440 Set the appropriate field to the given string. The strings for plugin instance,
10441 type instance, and meta data may be empty, the strings for host and plugin may
10442 not be empty. It's currently not possible to set the type of a value this way.
10443
10444 The following placeholders will be replaced by an appropriate value:
10445
10446 =over 4
10447
10448 =item B<%{host}>
10449
10450 =item B<%{plugin}>
10451
10452 =item B<%{plugin_instance}>
10453
10454 =item B<%{type}>
10455
10456 =item B<%{type_instance}>
10457
10458 These placeholders are replaced by the identifier field of the same name.
10459
10460 =item B<%{meta:>I<name>B<}>
10461
10462 These placeholders are replaced by the meta data value with the given name.
10463
10464 =back
10465
10466 Please note that these placeholders are B<case sensitive>!
10467
10468 =item B<DeleteMetaData> I<String>
10469
10470 Delete the named meta data field.
10471
10472 =back
10473
10474 Example:
10475
10476  <Target "set">
10477    PluginInstance "coretemp"
10478    TypeInstance "core3"
10479  </Target>
10480
10481 =back
10482
10483 =head2 Backwards compatibility
10484
10485 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10486 B<Chain> block, it will behave as it used to. This is equivalent to the
10487 following configuration:
10488
10489  <Chain "PostCache">
10490    Target "write"
10491  </Chain>
10492
10493 If you specify a B<PostCacheChain>, the B<write> target will not be added
10494 anywhere and you will have to make sure that it is called where appropriate. We
10495 suggest to add the above snippet as default target to your "PostCache" chain.
10496
10497 =head2 Examples
10498
10499 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10500 be an FQDN.
10501
10502  <Chain "PreCache">
10503    <Rule "no_fqdn">
10504      <Match "regex">
10505        Host "^[^\.]*$"
10506      </Match>
10507      Target "stop"
10508    </Rule>
10509    Target "write"
10510  </Chain>
10511
10512 =head1 IGNORELISTS
10513
10514 B<Ignorelists> are a generic framework to either ignore some metrics or report
10515 specific metircs only. Plugins usually provide one or more options to specify
10516 the items (mounts points, devices, ...) and the boolean option
10517 C<IgnoreSelected>.
10518
10519 =over 4
10520
10521 =item B<Select> I<String>
10522
10523 Selects the item I<String>. This option often has a plugin specific name, e.g.
10524 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10525 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10526 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10527
10528 By default, this option is doing a case-sensitive full-string match. The
10529 following config will match C<foo>, but not C<Foo>:
10530
10531   Select "foo"
10532
10533 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10534 I<regular expression>. For example, so match all item starting with C<foo>, use
10535 could use the following syntax:
10536
10537   Select "/^foo/"
10538
10539 The regular expression is I<not> anchored, i.e. the following config will match
10540 C<foobar>, C<barfoo> and C<AfooZ>:
10541
10542   Select "/foo/"
10543
10544 The B<Select> option may be repeated to select multiple items.
10545
10546 =item B<IgnoreSelected> B<true>|B<false>
10547
10548 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10549 collected. If set to B<false>, matching metrics are I<collected> and all other
10550 metrics are ignored.
10551
10552 =back
10553
10554 =head1 SEE ALSO
10555
10556 L<collectd(1)>,
10557 L<collectd-exec(5)>,
10558 L<collectd-perl(5)>,
10559 L<collectd-unixsock(5)>,
10560 L<types.db(5)>,
10561 L<hddtemp(8)>,
10562 L<iptables(8)>,
10563 L<kstat(3KSTAT)>,
10564 L<mbmon(1)>,
10565 L<psql(1)>,
10566 L<regex(7)>,
10567 L<rrdtool(1)>,
10568 L<sensors(1)>
10569
10570 =head1 AUTHOR
10571
10572 Florian Forster E<lt>octo@collectd.orgE<gt>
10573
10574 =cut