src/collectd.conf.pod

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