src/collectd.conf.pod

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