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