src/collectd.conf.pod

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