src/collectd.conf.pod

   1 =encoding UTF-8
   2
   3 =head1 NAME
   4
   5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
   6
   7 =head1 SYNOPSIS
   8
   9   BaseDir "/var/lib/collectd"
  10   PIDFile "/run/collectd.pid"
  11   Interval 10.0
  12
  13   LoadPlugin cpu
  14   LoadPlugin load
  15
  16   <LoadPlugin df>
  17     Interval 3600
  18   </LoadPlugin>
  19   <Plugin df>
  20     ValuesPercentage true
  21   </Plugin>
  22
  23   LoadPlugin ping
  24   <Plugin ping>
  25     Host "example.org"
  26     Host "provider.net"
  27   </Plugin>
  28
  29 =head1 DESCRIPTION
  30
  31 This config file controls how the system statistics collection daemon
  32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
  33 controls which plugins to load. These plugins ultimately define collectd's
  34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
  35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
  36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
  37
  38 The syntax of this config file is similar to the config file of the famous
  39 I<Apache> webserver. Each line contains either an option (a key and a list of
  40 one or more values) or a section-start or -end. Empty lines and everything
  41 after a non-quoted hash-symbol (C<#>) are ignored. I<Keys> are unquoted
  42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
  43 character. Keys are handled case insensitive by I<collectd> itself and all
  44 plugins included with it. I<Values> can either be an I<unquoted string>, a
  45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
  46 expression. I<Unquoted strings> consist of only alphanumeric characters and
  47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
  48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
  49 to include double quotes as part of the string. I<Numbers> can be specified in
  50 decimal and floating point format (using a dot C<.> as decimal separator),
  51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
  52 I<Boolean> values are either B<true> or B<false>.
  53
  54 Lines may be wrapped by using C<\> as the last character before the newline.
  55 This allows long lines to be split into multiple lines. Quoted strings may be
  56 wrapped as well. However, those are treated special in that whitespace at the
  57 beginning of the following lines will be ignored, which allows for nicely
  58 indenting the wrapped lines.
  59
  60 The configuration is read and processed in order, i.e. from top to bottom. So
  61 the plugins are loaded in the order listed in this config file. It is a good
  62 idea to load any logging plugins first in order to catch messages from plugins
  63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
  64 B<LoadPlugin> option I<must> occur I<before> the appropriate
  65 C<E<lt>B<Plugin> ...E<gt>> block.
  66
  67 =head1 GLOBAL OPTIONS
  68
  69 =over 4
  70
  71 =item B<BaseDir> I<Directory>
  72
  73 Sets the base directory. This is the directory beneath which all RRD-files are
  74 created. Possibly more subdirectories are created. This is also the working
  75 directory for the daemon.
  76
  77 =item B<LoadPlugin> I<Plugin>
  78
  79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
  80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
  81 I<collectd> will be mostly useless.
  82
  83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
  84 effect. This is useful when you want to split up the configuration into smaller
  85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
  86 block I<and> the appropriate B<LoadPlugin> statement. The downside is that if
  87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
  88 different intervals, only one of them (the first one encountered) will take
  89 effect and all others will be silently ignored.
  90
  91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
  92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
  93 statement looks like this:
  94
  95  LoadPlugin "cpu"
  96
  97 Options inside a B<LoadPlugin> block can override default settings and
  98 influence the way plugins are loaded, e.g.:
  99
 100  <LoadPlugin perl>
 101    Interval 60
 102  </LoadPlugin>
 103
 104 The following options are valid inside B<LoadPlugin> blocks:
 105
 106 =over 4
 107
 108 =item B<Globals> B<true|false>
 109
 110 If enabled, collectd will export all global symbols of the plugin (and of all
 111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
 112 available for resolving unresolved symbols in subsequently loaded plugins if
 113 that is supported by your system.
 114
 115 This is useful (or possibly even required), e.g., when loading a plugin that
 116 embeds some scripting language into the daemon (e.g. the I<Perl> and
 117 I<Python plugins>). Scripting languages usually provide means to load
 118 extensions written in C. Those extensions require symbols provided by the
 119 interpreter, which is loaded as a dependency of the respective collectd plugin.
 120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
 121 L<collectd-python(5)>) for details.
 122
 123 By default, this is disabled. As a special exception, if the plugin name is
 124 either C<perl> or C<python>, the default is changed to enabled in order to keep
 125 the average user from ever having to deal with this low level linking stuff.
 126
 127 =item B<Interval> I<Seconds>
 128
 129 Sets a plugin-specific interval for collecting metrics. This overrides the
 130 global B<Interval> setting. If a plugin provides its own support for specifying
 131 an interval, that setting will take precedence.
 132
 133 =item B<FlushInterval> I<Seconds>
 134
 135 Specifies the interval, in seconds, to call the flush callback if it's
 136 defined in this plugin. By default, this is disabled.
 137
 138 =item B<FlushTimeout> I<Seconds>
 139
 140 Specifies the value of the timeout argument of the flush callback.
 141
 142 =back
 143
 144 =item B<AutoLoadPlugin> B<false>|B<true>
 145
 146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
 147 using the B<LoadPlugin> statement documented above. If a
 148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
 149 handling callback for this plugin has been registered, a warning is logged and
 150 the block is ignored.
 151
 152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
 153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
 154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
 155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
 156
 157 =item B<CollectInternalStats> B<false>|B<true>
 158
 159 When set to B<true>, various statistics about the I<collectd> daemon will be
 160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
 161
 162 The following metrics are reported:
 163
 164 =over 4
 165
 166 =item C<collectd-write_queue/queue_length>
 167
 168 The number of metrics currently in the write queue. You can limit the queue
 169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
 170
 171 =item C<collectd-write_queue/derive-dropped>
 172
 173 The number of metrics dropped due to a queue length limitation.
 174 If this value is non-zero, your system can't handle all incoming metrics and
 175 protects itself against overload by dropping metrics.
 176
 177 =item C<collectd-cache/cache_size>
 178
 179 The number of elements in the metric cache (the cache you can interact with
 180 using L<collectd-unixsock(5)>).
 181
 182 =back
 183
 184 =item B<Include> I<Path> [I<pattern>]
 185
 186 If I<Path> points to a file, includes that file. If I<Path> points to a
 187 directory, recursively includes all files within that directory and its
 188 subdirectories. If the C<wordexp> function is available on your system,
 189 shell-like wildcards are expanded before files are included. This means you can
 190 use statements like the following:
 191
 192   Include "/etc/collectd.d/*.conf"
 193
 194 Starting with version 5.3, this may also be a block in which further options
 195 affecting the behavior of B<Include> may be specified. The following option is
 196 currently allowed:
 197
 198   <Include "/etc/collectd.d">
 199     Filter "*.conf"
 200   </Include>
 201
 202 =over 4
 203
 204 =item B<Filter> I<pattern>
 205
 206 If the C<fnmatch> function is available on your system, a shell-like wildcard
 207 I<pattern> may be specified to filter which files to include. This may be used
 208 in combination with recursively including a directory to easily be able to
 209 arbitrarily mix configuration files and other documents (e.g. README files).
 210 The given example is similar to the first example above but includes all files
 211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
 212
 213 =back
 214
 215 If more than one file is included by a single B<Include> option, the files
 216 will be included in lexicographical order (as defined by the C<strcmp>
 217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
 218 order in which the files are loaded.
 219
 220 To prevent loops and shooting yourself in the foot in interesting ways the
 221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
 222 most uses. Since symlinks are followed it is still possible to crash the daemon
 223 by looping symlinks. In our opinion significant stupidity should result in an
 224 appropriate amount of pain.
 225
 226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
 227 file, but you cannot include files from within blocks.
 228
 229 =item B<PIDFile> I<File>
 230
 231 Sets where to write the PID file to. This file is overwritten when it exists
 232 and deleted when the program is stopped. Some init-scripts might override this
 233 setting using the B<-P> command-line option.
 234
 235 =item B<PluginDir> I<Directory>
 236
 237 Path to the plugins (shared objects) of collectd.
 238
 239 =item B<TypesDB> I<File> [I<File> ...]
 240
 241 Set one or more files that contain the data-set descriptions. See
 242 L<types.db(5)> for a description of the format of this file.
 243
 244 If this option is not specified, a default file is read. If you need to define
 245 custom types in addition to the types defined in the default file, you need to
 246 explicitly load both. In other words, if the B<TypesDB> option is encountered
 247 the default behavior is disabled and if you need the default types you have to
 248 also explicitly load them.
 249
 250 =item B<Interval> I<Seconds>
 251
 252 Configures the interval in which to query the read plugins. Obviously smaller
 253 values lead to a higher system load produced by collectd, while higher values
 254 lead to more coarse statistics.
 255
 256 B<Warning:> You should set this once and then never touch it again. If you do,
 257 I<you will have to delete all your RRD files> or know some serious RRDtool
 258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
 259
 260 =item B<MaxReadInterval> I<Seconds>
 261
 262 A read plugin doubles the interval between queries after each failed attempt
 263 to get data.
 264
 265 This options limits the maximum value of the interval. The default value is
 266 B<86400>.
 267
 268 =item B<Timeout> I<Iterations>
 269
 270 Consider a value list "missing" when no update has been read or received for
 271 I<Iterations> iterations. By default, I<collectd> considers a value list
 272 missing when no update has been received for twice the update interval. Since
 273 this setting uses iterations, the maximum allowed time without update depends
 274 on the I<Interval> information contained in each value list. This is used in
 275 the I<Threshold> configuration to dispatch notifications about missing values,
 276 see L<collectd-threshold(5)> for details.
 277
 278 =item B<ReadThreads> I<Num>
 279
 280 Number of threads to start for reading plugins. The default value is B<5>, but
 281 you may want to increase this if you have more than five plugins that take a
 282 long time to read. Mostly those are plugins that do network-IO. Setting this to
 283 a value higher than the number of registered read callbacks is not recommended.
 284
 285 =item B<WriteThreads> I<Num>
 286
 287 Number of threads to start for dispatching value lists to write plugins. The
 288 default value is B<5>, but you may want to increase this if you have more than
 289 five plugins that may take relatively long to write to.
 290
 291 =item B<WriteQueueLimitHigh> I<HighNum>
 292
 293 =item B<WriteQueueLimitLow> I<LowNum>
 294
 295 Metrics are read by the I<read threads> and then put into a queue to be handled
 296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
 297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
 298 running into memory issues in such a case, you can limit the size of this
 299 queue.
 300
 301 By default, there is no limit and memory may grow indefinitely. This is most
 302 likely not an issue for clients, i.e. instances that only handle the local
 303 metrics. For servers it is recommended to set this to a non-zero value, though.
 304
 305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
 306 Each of them takes a numerical argument which is the number of metrics in the
 307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
 308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
 309 I<will> be enqueued. If the number of metrics currently in the queue is between
 310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
 311 proportional to the number of metrics in the queue (i.e. it increases linearly
 312 until it reaches 100%.)
 313
 314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
 315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
 316
 317 If you do not want to randomly drop values when the queue size is between
 318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
 319 to the same value.
 320
 321 Enabling the B<CollectInternalStats> option is of great help to figure out the
 322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
 323
 324 =item B<Hostname> I<Name>
 325
 326 Sets the hostname that identifies a host. If you omit this setting, the
 327 hostname will be determined using the L<gethostname(2)> system call.
 328
 329 =item B<FQDNLookup> B<true|false>
 330
 331 If B<Hostname> is determined automatically this setting controls whether or not
 332 the daemon should try to figure out the "fully qualified domain name", FQDN.
 333 This is done using a lookup of the name returned by C<gethostname>. This option
 334 is enabled by default.
 335
 336 =item B<PreCacheChain> I<ChainName>
 337
 338 =item B<PostCacheChain> I<ChainName>
 339
 340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
 341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
 342 setting change the daemon's behavior.
 343
 344 =back
 345
 346 =head1 PLUGIN OPTIONS
 347
 348 Some plugins may register own options. These options must be enclosed in a
 349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
 350 require external configuration, too. The C<apache plugin>, for example,
 351 required C<mod_status> to be configured in the webserver you're going to
 352 collect data from. These plugins are listed below as well, even if they don't
 353 require any configuration within collectd's configuration file.
 354
 355 A list of all plugins and a short summary for each plugin can be found in the
 356 F<README> file shipped with the sourcecode and hopefully binary packets as
 357 well.
 358
 359 =head2 Plugin C<aggregation>
 360
 361 The I<Aggregation plugin> makes it possible to aggregate several values into
 362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
 363 This can be put to a wide variety of uses, e.g. average and total CPU
 364 statistics for your entire fleet.
 365
 366 The grouping is powerful but, as with many powerful tools, may be a bit
 367 difficult to wrap your head around. The grouping will therefore be
 368 demonstrated using an example: The average and sum of the CPU usage across
 369 all CPUs of each host is to be calculated.
 370
 371 To select all the affected values for our example, set C<Plugin cpu> and
 372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
 373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
 374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
 375 statement.
 376
 377   Plugin "cpu"
 378   Type "cpu"
 379
 380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...)  and
 381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
 382 example, the intention is to have a new value for each host / type instance
 383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
 384 It can be specified multiple times to group by more than one field.
 385
 386   GroupBy "Host"
 387   GroupBy "TypeInstance"
 388
 389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
 390 metrics that differ in the CPU number only will be aggregated. Each
 391 aggregation needs I<at least one> such field, otherwise no aggregation would
 392 take place.
 393
 394 The full example configuration looks like this:
 395
 396  <Plugin "aggregation">
 397    <Aggregation>
 398      Plugin "cpu"
 399      Type "cpu"
 400
 401      GroupBy "Host"
 402      GroupBy "TypeInstance"
 403
 404      CalculateSum true
 405      CalculateAverage true
 406    </Aggregation>
 407  </Plugin>
 408
 409 There are a couple of limitations you should be aware of:
 410
 411 =over 4
 412
 413 =item *
 414
 415 The I<Type> cannot be left unspecified, because it is not reasonable to add
 416 apples to oranges. Also, the internal lookup structure won't work if you try
 417 to group by type.
 418
 419 =item *
 420
 421 There must be at least one unspecified, ungrouped field. Otherwise nothing
 422 will be aggregated.
 423
 424 =back
 425
 426 As you can see in the example above, each aggregation has its own
 427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
 428 blocks may match the same values, i.e. one value list can update multiple
 429 aggregations. The following options are valid inside B<Aggregation> blocks:
 430
 431 =over 4
 432
 433 =item B<Host> I<Host>
 434
 435 =item B<Plugin> I<Plugin>
 436
 437 =item B<PluginInstance> I<PluginInstance>
 438
 439 =item B<Type> I<Type>
 440
 441 =item B<TypeInstance> I<TypeInstance>
 442
 443 Selects the value lists to be added to this aggregation. B<Type> must be a
 444 valid data set name, see L<types.db(5)> for details.
 445
 446 If the string starts with and ends with a slash (C</>), the string is
 447 interpreted as a I<regular expression>. The regex flavor used are POSIX
 448 extended regular expressions as described in L<regex(7)>. Example usage:
 449
 450  Host "/^db[0-9]\\.example\\.com$/"
 451
 452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
 453
 454 Group valued by the specified field. The B<GroupBy> option may be repeated to
 455 group by multiple fields.
 456
 457 =item B<SetHost> I<Host>
 458
 459 =item B<SetPlugin> I<Plugin>
 460
 461 =item B<SetPluginInstance> I<PluginInstance>
 462
 463 =item B<SetTypeInstance> I<TypeInstance>
 464
 465 Sets the appropriate part of the identifier to the provided string.
 466
 467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
 468 will be replaced with the aggregation function, e.g. "average". Not including
 469 the placeholder will result in duplication warnings and/or messed up values if
 470 more than one aggregation function are enabled.
 471
 472 The following example calculates the average usage of all "even" CPUs:
 473
 474  <Plugin "aggregation">
 475    <Aggregation>
 476      Plugin "cpu"
 477      PluginInstance "/[0,2,4,6,8]$/"
 478      Type "cpu"
 479
 480      SetPlugin "cpu"
 481      SetPluginInstance "even-%{aggregation}"
 482
 483      GroupBy "Host"
 484      GroupBy "TypeInstance"
 485
 486      CalculateAverage true
 487    </Aggregation>
 488  </Plugin>
 489
 490 This will create the files:
 491
 492 =over 4
 493
 494 =item *
 495
 496 foo.example.com/cpu-even-average/cpu-idle
 497
 498 =item *
 499
 500 foo.example.com/cpu-even-average/cpu-system
 501
 502 =item *
 503
 504 foo.example.com/cpu-even-average/cpu-user
 505
 506 =item *
 507
 508 ...
 509
 510 =back
 511
 512 =item B<CalculateNum> B<true>|B<false>
 513
 514 =item B<CalculateSum> B<true>|B<false>
 515
 516 =item B<CalculateAverage> B<true>|B<false>
 517
 518 =item B<CalculateMinimum> B<true>|B<false>
 519
 520 =item B<CalculateMaximum> B<true>|B<false>
 521
 522 =item B<CalculateStddev> B<true>|B<false>
 523
 524 Boolean options for enabling calculation of the number of value lists, their
 525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
 526 are disabled by default.
 527
 528 =back
 529
 530 =head2 Plugin C<amqp>
 531
 532 The I<AMQP plugin> can be used to communicate with other instances of
 533 I<collectd> or third party applications using an AMQP 0.9.1 message broker.
 534 Values are sent to or received from the broker, which handles routing,
 535 queueing and possibly filtering out messages.
 536
 537 B<Synopsis:>
 538
 539  <Plugin "amqp">
 540    # Send values to an AMQP broker
 541    <Publish "some_name">
 542      Host "localhost"
 543      Port "5672"
 544      VHost "/"
 545      User "guest"
 546      Password "guest"
 547      Exchange "amq.fanout"
 548  #   ExchangeType "fanout"
 549  #   RoutingKey "collectd"
 550  #   Persistent false
 551  #   ConnectionRetryDelay 0
 552  #   Format "command"
 553  #   StoreRates false
 554  #   GraphitePrefix "collectd."
 555  #   GraphiteEscapeChar "_"
 556  #   GraphiteSeparateInstances false
 557  #   GraphiteAlwaysAppendDS false
 558  #   GraphitePreserveSeparator false
 559    </Publish>
 560
 561    # Receive values from an AMQP broker
 562    <Subscribe "some_name">
 563      Host "localhost"
 564      Port "5672"
 565      VHost "/"
 566      User "guest"
 567      Password "guest"
 568      Exchange "amq.fanout"
 569  #   ExchangeType "fanout"
 570  #   Queue "queue_name"
 571  #   QueueDurable false
 572  #   QueueAutoDelete true
 573  #   RoutingKey "collectd.#"
 574  #   ConnectionRetryDelay 0
 575    </Subscribe>
 576  </Plugin>
 577
 578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
 579 blocks, which configure sending and receiving of values respectively. The two
 580 blocks are very similar, so unless otherwise noted, an option can be used in
 581 either block. The name given in the blocks starting tag is only used for
 582 reporting messages, but may be used to support I<flushing> of certain
 583 I<Publish> blocks in the future.
 584
 585 =over 4
 586
 587 =item B<Host> I<Host>
 588
 589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
 590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
 591
 592 =item B<Port> I<Port>
 593
 594 Service name or port number on which the AMQP broker accepts connections. This
 595 argument must be a string, even if the numeric form is used. Defaults to
 596 "5672".
 597
 598 =item B<VHost> I<VHost>
 599
 600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
 601
 602 =item B<User> I<User>
 603
 604 =item B<Password> I<Password>
 605
 606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
 607 is used.
 608
 609 =item B<Exchange> I<Exchange>
 610
 611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
 612 By default, "amq.fanout" will be used.
 613
 614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
 615 the given exchange and the I<queue> is created, using the I<routing key> if
 616 configured. See the B<Queue> and B<RoutingKey> options below.
 617
 618 =item B<ExchangeType> I<Type>
 619
 620 If given, the plugin will try to create the configured I<exchange> with this
 621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
 622 be bound to this exchange.
 623
 624 =item B<Queue> I<Queue> (Subscribe only)
 625
 626 Configures the I<queue> name to subscribe to. If no queue name was configured
 627 explicitly, a unique queue name will be created by the broker.
 628
 629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
 630
 631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
 632 or transient (will disappear if the AMQP broker is restarted). Defaults to
 633 "false".
 634
 635 This option should be used in conjunction with the I<Persistent> option on the
 636 publish side.
 637
 638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
 639
 640 Defines if the I<queue> subscribed to will be deleted once the last consumer
 641 unsubscribes. Defaults to "true".
 642
 643 =item B<RoutingKey> I<Key>
 644
 645 In I<Publish> blocks, this configures the routing key to set on all outgoing
 646 messages. If not given, the routing key will be computed from the I<identifier>
 647 of the value. The host, plugin, type and the two instances are concatenated
 648 together using dots as the separator and all containing dots replaced with
 649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
 650 possible to receive only specific values using a "topic" exchange.
 651
 652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
 653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
 654 used to filter messages when using a "topic" exchange. If you're only
 655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
 656 for example.
 657
 658 =item B<Persistent> B<true>|B<false> (Publish only)
 659
 660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
 661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
 662 default), the I<transient> delivery mode will be used, i.e. messages may be
 663 lost due to high load, overflowing queues or similar issues.
 664
 665 =item B<ConnectionRetryDelay> I<Delay>
 666
 667 When the connection to the AMQP broker is lost, defines the time in seconds to
 668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
 669 attempt to reconnect at each read interval (in Subscribe mode) or each time
 670 values are ready for submission (in Publish mode).
 671
 672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
 673
 674 Selects the format in which messages are sent to the broker. If set to
 675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
 676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
 677 case, the C<Content-Type> header field will be set to C<text/collectd>.
 678
 679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
 680 an easy and straight forward exchange format. The C<Content-Type> header field
 681 will be set to C<application/json>.
 682
 683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
 684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
 685 C<text/graphite>.
 686
 687 A subscribing client I<should> use the C<Content-Type> header field to
 688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
 689 only decode the B<Command> format.
 690
 691 =item B<StoreRates> B<true>|B<false> (Publish only)
 692
 693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
 694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
 695 default), no conversion is performed. Otherwise the conversion is performed
 696 using the internal value cache.
 697
 698 Please note that currently this option is only used if the B<Format> option has
 699 been set to B<JSON>.
 700
 701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
 702
 703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
 704 It's added before the I<Host> name.
 705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 706
 707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
 708
 709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
 710 It's added after the I<Host> name.
 711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 712
 713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
 714
 715 Specify a character to replace dots (.) in the host part of the metric name.
 716 In I<Graphite> metric name, dots are used as separators between different
 717 metric parts (host, plugin, type).
 718 Default is "_" (I<Underscore>).
 719
 720 =item B<GraphiteSeparateInstances> B<true>|B<false>
 721
 722 If set to B<true>, the plugin instance and type instance will be in their own
 723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
 724 default), the plugin and plugin instance (and likewise the type and type
 725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
 726
 727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
 728
 729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
 730 identifier. If set to B<false> (the default), this is only done when there is
 731 more than one DS.
 732
 733 =item B<GraphitePreserveSeparator> B<false>|B<true>
 734
 735 If set to B<false> (the default) the C<.> (dot) character is replaced with
 736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
 737 is preserved, i.e. passed through.
 738
 739 =back
 740
 741 =head2 Plugin C<amqp1>
 742
 743 The I<AMQP1 plugin> can be used to communicate with other instances of
 744 I<collectd> or third party applications using an AMQP 1.0 message
 745 intermediary. Metric values or notifications are sent to the
 746 messaging intermediary which may handle direct messaging or
 747 queue based transfer.
 748
 749 B<Synopsis:>
 750
 751  <Plugin "amqp1">
 752    # Send values to an AMQP 1.0 intermediary
 753   <Transport "name">
 754     Host "localhost"
 755     Port "5672"
 756     User "guest"
 757     Password "guest"
 758     Address "collectd"
 759 #    RetryDelay 1
 760     <Instance "some_name">
 761         Format "command"
 762         PreSettle false
 763         Notify false
 764  #      StoreRates false
 765  #      GraphitePrefix "collectd."
 766  #      GraphiteEscapeChar "_"
 767  #      GraphiteSeparateInstances false
 768  #      GraphiteAlwaysAppendDS false
 769  #      GraphitePreserveSeparator false
 770     </Instance>
 771   </Transport>
 772  </Plugin>
 773
 774 The plugin's configuration consists of a I<Transport> that configures
 775 communications to the AMQP 1.0 messaging bus and one or more I<Instance>
 776 corresponding to metric or event publishers to the messaging system.
 777
 778 The address in the I<Transport> block concatenated with the name given in the
 779 I<Instance> block starting tag will be used as the send-to address for
 780 communications over the messaging link.
 781
 782 The following options are accepted within each I<Transport> block:
 783
 784 =over 4
 785
 786 =item B<Host> I<Host>
 787
 788 Hostname or IP-address of the AMQP 1.0 intermediary. Defaults to the
 789 default behavior of the underlying communications library,
 790 I<libqpid-proton>, which is "localhost".
 791
 792 =item B<Port> I<Port>
 793
 794 Service name or port number on which the AMQP 1.0 intermediary accepts
 795 connections. This argument must be a string, even if the numeric form
 796 is used. Defaults to "5672".
 797
 798 =item B<User> I<User>
 799
 800 =item B<Password> I<Password>
 801
 802 Credentials used to authenticate to the AMQP 1.0 intermediary. By
 803 default "guest"/"guest" is used.
 804
 805 =item B<Address> I<Address>
 806
 807 This option specifies the prefix for the send-to value in the message.
 808 By default, "collectd" will be used.
 809
 810 =item B<RetryDelay> I<RetryDelay>
 811
 812 When the AMQP1 connection is lost, defines the time in seconds to wait
 813 before attempting to reconnect. Defaults to 1, which implies attempt
 814 to reconnect at 1 second intervals.
 815
 816 =back
 817
 818 The following options are accepted within each I<Instance> block:
 819
 820 =over 4
 821
 822 =item B<Format> B<Command>|B<JSON>|B<Graphite>
 823
 824 Selects the format in which messages are sent to the intermediary. If set to
 825 B<Command> (the default), values are sent as C<PUTVAL> commands which are
 826 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
 827 case, the C<Content-Type> header field will be set to C<text/collectd>.
 828
 829 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
 830 an easy and straight forward exchange format. The C<Content-Type> header field
 831 will be set to C<application/json>.
 832
 833 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
 834 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
 835 C<text/graphite>.
 836
 837 A subscribing client I<should> use the C<Content-Type> header field to
 838 determine how to decode the values.
 839
 840 =item B<PreSettle> B<true>|B<false>
 841
 842 If set to B<false> (the default), the plugin will wait for a message
 843 acknowledgement from the messaging bus before sending the next
 844 message. This indicates transfer of ownership to the messaging
 845 system. If set to B<true>, the plugin will not wait for a message
 846 acknowledgement and the message may be dropped prior to transfer of
 847 ownership.
 848
 849 =item B<Notify> B<true>|B<false>
 850
 851 If set to B<false> (the default), the plugin will service the
 852 instance write call back as a value list. If set to B<true> the
 853 plugin will service the instance as a write notification callback
 854 for alert formatting.
 855
 856 =item B<StoreRates> B<true>|B<false>
 857
 858 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
 859 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
 860 default), no conversion is performed. Otherwise the conversion is performed
 861 using the internal value cache.
 862
 863 Please note that currently this option is only used if the B<Format> option has
 864 been set to B<JSON>.
 865
 866 =item B<GraphitePrefix>
 867
 868 A prefix can be added in the metric name when outputting in the I<Graphite> format.
 869 It's added before the I<Host> name.
 870 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 871
 872 =item B<GraphitePostfix>
 873
 874 A postfix can be added in the metric name when outputting in the I<Graphite> format.
 875 It's added after the I<Host> name.
 876 Metric name will be "<prefix><host><postfix><plugin><type><name>"
 877
 878 =item B<GraphiteEscapeChar>
 879
 880 Specify a character to replace dots (.) in the host part of the metric name.
 881 In I<Graphite> metric name, dots are used as separators between different
 882 metric parts (host, plugin, type).
 883 Default is "_" (I<Underscore>).
 884
 885 =item B<GraphiteSeparateInstances> B<true>|B<false>
 886
 887 If set to B<true>, the plugin instance and type instance will be in their own
 888 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
 889 default), the plugin and plugin instance (and likewise the type and type
 890 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
 891
 892 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
 893
 894 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
 895 identifier. If set to B<false> (the default), this is only done when there is
 896 more than one DS.
 897
 898 =item B<GraphitePreserveSeparator> B<false>|B<true>
 899
 900 If set to B<false> (the default) the C<.> (dot) character is replaced with
 901 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
 902 is preserved, i.e. passed through.
 903
 904 =back
 905
 906 =head2 Plugin C<apache>
 907
 908 To configure the C<apache>-plugin you first need to configure the Apache
 909 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
 910 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
 911 the following snipped to base your Apache config upon:
 912
 913   ExtendedStatus on
 914   <IfModule mod_status.c>
 915     <Location /mod_status>
 916       SetHandler server-status
 917     </Location>
 918   </IfModule>
 919
 920 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
 921 also supported. It introduces a new field, called C<BusyServers>, to count the
 922 number of currently connected clients. This field is also supported.
 923
 924 The configuration of the I<Apache> plugin consists of one or more
 925 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
 926 as the instance name. For example:
 927
 928  <Plugin "apache">
 929    <Instance "www1">
 930      URL "http://www1.example.com/mod_status?auto"
 931    </Instance>
 932    <Instance "www2">
 933      URL "http://www2.example.com/mod_status?auto"
 934    </Instance>
 935  </Plugin>
 936
 937 The instance name will be used as the I<plugin instance>. To emulate the old
 938 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
 939 plugin to work correctly, each instance name must be unique. This is not
 940 enforced by the plugin and it is your responsibility to ensure it.
 941
 942 The following options are accepted within each I<Instance> block:
 943
 944 =over 4
 945
 946 =item B<URL> I<http://host/mod_status?auto>
 947
 948 Sets the URL of the C<mod_status> output. This needs to be the output generated
 949 by C<ExtendedStatus on> and it needs to be the machine readable output
 950 generated by appending the C<?auto> argument. This option is I<mandatory>.
 951
 952 =item B<User> I<Username>
 953
 954 Optional user name needed for authentication.
 955
 956 =item B<Password> I<Password>
 957
 958 Optional password needed for authentication.
 959
 960 =item B<VerifyPeer> B<true|false>
 961
 962 Enable or disable peer SSL certificate verification. See
 963 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
 964
 965 =item B<VerifyHost> B<true|false>
 966
 967 Enable or disable peer host name verification. If enabled, the plugin checks
 968 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
 969 certificate matches the host name provided by the B<URL> option. If this
 970 identity check fails, the connection is aborted. Obviously, only works when
 971 connecting to a SSL enabled server. Enabled by default.
 972
 973 =item B<CACert> I<File>
 974
 975 File that holds one or more SSL certificates. If you want to use HTTPS you will
 976 possibly need this option. What CA certificates come bundled with C<libcurl>
 977 and are checked by default depends on the distribution you use.
 978
 979 =item B<SSLCiphers> I<list of ciphers>
 980
 981 Specifies which ciphers to use in the connection. The list of ciphers
 982 must specify valid ciphers. See
 983 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
 984
 985 =item B<Timeout> I<Milliseconds>
 986
 987 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
 988 milliseconds. By default, the configured B<Interval> is used to set the
 989 timeout.
 990
 991 =back
 992
 993 =head2 Plugin C<apcups>
 994
 995 =over 4
 996
 997 =item B<Host> I<Hostname>
 998
 999 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
1000 that IPv6 support has been disabled unless someone can confirm or decline that
1001 B<apcupsd> can handle it.
1002
1003 =item B<Port> I<Port>
1004
1005 TCP-Port to connect to. Defaults to B<3551>.
1006
1007 =item B<ReportSeconds> B<true>|B<false>
1008
1009 If set to B<true>, the time reported in the C<timeleft> metric will be
1010 converted to seconds. This is the recommended setting. If set to B<false>, the
1011 default for backwards compatibility, the time will be reported in minutes.
1012
1013 =item B<PersistentConnection> B<true>|B<false>
1014
1015 The plugin is designed to keep the connection to I<apcupsd> open between reads.
1016 If plugin poll interval is greater than 15 seconds (hardcoded socket close
1017 timeout in I<apcupsd> NIS), then this option is B<false> by default.
1018
1019 You can instruct the plugin to close the connection after each read by setting
1020 this option to B<false> or force keeping the connection by setting it to B<true>.
1021
1022 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
1023 the plugin will try to detect this problem and switch to an open-read-close mode.
1024
1025 =back
1026
1027 =head2 Plugin C<aquaero>
1028
1029 This plugin collects the value of the available sensors in an
1030 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
1031 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
1032 connection for monitoring and configuration. The board can handle multiple
1033 temperature sensors, fans, water pumps and water level sensors and adjust the
1034 output settings such as fan voltage or power used by the water pump based on
1035 the available inputs using a configurable controller included in the board.
1036 This plugin collects all the available inputs as well as some of the output
1037 values chosen by this controller. The plugin is based on the I<libaquaero5>
1038 library provided by I<aquatools-ng>.
1039
1040 =over 4
1041
1042 =item B<Device> I<DevicePath>
1043
1044 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
1045 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
1046 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
1047
1048 =back
1049
1050 =head2 Plugin C<ascent>
1051
1052 This plugin collects information about an Ascent server, a free server for the
1053 "World of Warcraft" game. This plugin gathers the information by fetching the
1054 XML status page using C<libcurl> and parses it using C<libxml2>.
1055
1056 The configuration options are the same as for the C<apache> plugin above:
1057
1058 =over 4
1059
1060 =item B<URL> I<http://localhost/ascent/status/>
1061
1062 Sets the URL of the XML status output.
1063
1064 =item B<User> I<Username>
1065
1066 Optional user name needed for authentication.
1067
1068 =item B<Password> I<Password>
1069
1070 Optional password needed for authentication.
1071
1072 =item B<VerifyPeer> B<true|false>
1073
1074 Enable or disable peer SSL certificate verification. See
1075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1076
1077 =item B<VerifyHost> B<true|false>
1078
1079 Enable or disable peer host name verification. If enabled, the plugin checks
1080 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1081 certificate matches the host name provided by the B<URL> option. If this
1082 identity check fails, the connection is aborted. Obviously, only works when
1083 connecting to a SSL enabled server. Enabled by default.
1084
1085 =item B<CACert> I<File>
1086
1087 File that holds one or more SSL certificates. If you want to use HTTPS you will
1088 possibly need this option. What CA certificates come bundled with C<libcurl>
1089 and are checked by default depends on the distribution you use.
1090
1091 =item B<Timeout> I<Milliseconds>
1092
1093 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1094 milliseconds. By default, the configured B<Interval> is used to set the
1095 timeout.
1096
1097 =back
1098
1099 =head2 Plugin C<barometer>
1100
1101 This plugin reads absolute air pressure using digital barometer sensor on a I2C
1102 bus. Supported sensors are:
1103
1104 =over 5
1105
1106 =item I<MPL115A2> from Freescale,
1107 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
1108
1109
1110 =item I<MPL3115> from Freescale
1111 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
1112
1113
1114 =item I<BMP085> from Bosch Sensortec
1115
1116 =back
1117
1118 The sensor type - one of the above - is detected automatically by the plugin
1119 and indicated in the plugin_instance (you will see subdirectory
1120 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
1121 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
1122 (only one sensor can be used by the plugin).
1123
1124 The plugin provides absolute barometric pressure, air pressure reduced to sea
1125 level (several possible approximations) and as an auxiliary value also internal
1126 sensor temperature. It uses (expects/provides) typical metric units - pressure
1127 in [hPa], temperature in [C], altitude in [m].
1128
1129 It was developed and tested under Linux only. The only platform dependency is
1130 the standard Linux i2c-dev interface (the particular bus driver has to
1131 support the SM Bus command subset).
1132
1133 The reduction or normalization to mean sea level pressure requires (depending
1134 on selected method/approximation) also altitude and reference to temperature
1135 sensor(s).  When multiple temperature sensors are configured the minimum of
1136 their values is always used (expecting that the warmer ones are affected by
1137 e.g. direct sun light at that moment).
1138
1139 Synopsis:
1140
1141   <Plugin "barometer">
1142      Device            "/dev/i2c-0";
1143      Oversampling      512
1144      PressureOffset    0.0
1145      TemperatureOffset 0.0
1146      Normalization     2
1147      Altitude          238.0
1148      TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
1149   </Plugin>
1150
1151 =over 4
1152
1153 =item B<Device> I<device>
1154
1155 The only mandatory configuration parameter.
1156
1157 Device name of the I2C bus to which the sensor is connected. Note that
1158 typically you need to have loaded the i2c-dev module.
1159 Using i2c-tools you can check/list i2c buses available on your system by:
1160
1161   i2cdetect -l
1162
1163 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1164
1165   i2cdetect -y -a 0
1166
1167 This way you should be able to verify that the pressure sensor (either type) is
1168 connected and detected on address 0x60.
1169
1170 =item B<Oversampling> I<value>
1171
1172 Optional parameter controlling the oversampling/accuracy. Default value
1173 is 1 providing fastest and least accurate reading.
1174
1175 For I<MPL115> this is the size of the averaging window. To filter out sensor
1176 noise a simple averaging using floating window of this configurable size is
1177 used. The plugin will use average of the last C<value> measurements (value of 1
1178 means no averaging).  Minimal size is 1, maximal 1024.
1179
1180 For I<MPL3115> this is the oversampling value. The actual oversampling is
1181 performed by the sensor and the higher value the higher accuracy and longer
1182 conversion time (although nothing to worry about in the collectd context).
1183 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1184 adjusted by the plugin to the closest supported one.
1185
1186 For I<BMP085> this is the oversampling value. The actual oversampling is
1187 performed by the sensor and the higher value the higher accuracy and longer
1188 conversion time (although nothing to worry about in the collectd context).
1189 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1190 the closest supported one.
1191
1192 =item B<PressureOffset> I<offset>
1193
1194 Optional parameter for MPL3115 only.
1195
1196 You can further calibrate the sensor by supplying pressure and/or temperature
1197 offsets.  This is added to the measured/caclulated value (i.e. if the measured
1198 value is too high then use negative offset).
1199 In hPa, default is 0.0.
1200
1201 =item B<TemperatureOffset> I<offset>
1202
1203 Optional parameter for MPL3115 only.
1204
1205 You can further calibrate the sensor by supplying pressure and/or temperature
1206 offsets.  This is added to the measured/caclulated value (i.e. if the measured
1207 value is too high then use negative offset).
1208 In C, default is 0.0.
1209
1210 =item B<Normalization> I<method>
1211
1212 Optional parameter, default value is 0.
1213
1214 Normalization method - what approximation/model is used to compute the mean sea
1215 level pressure from the air absolute pressure.
1216
1217 Supported values of the C<method> (integer between from 0 to 2) are:
1218
1219 =over 5
1220
1221 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1222        do not need to configure C<Altitude> or C<TemperatureSensor>.
1223
1224 =item B<1> - international formula for conversion ,
1225 See
1226 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1227 For this method you have to configure C<Altitude> but do not need
1228 C<TemperatureSensor> (uses fixed global temperature average instead).
1229
1230 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1231 Meteorological Service).
1232 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1233 For this method you have to configure both  C<Altitude> and
1234 C<TemperatureSensor>.
1235
1236 =back
1237
1238
1239 =item B<Altitude> I<altitude>
1240
1241 The altitude (in meters) of the location where you meassure the pressure.
1242
1243 =item B<TemperatureSensor> I<reference>
1244
1245 Temperature sensor(s) which should be used as a reference when normalizing the
1246 pressure using C<Normalization> method 2.
1247 When specified more sensors a minimum is found and used each time.  The
1248 temperature reading directly from this pressure sensor/plugin is typically not
1249 suitable as the pressure sensor will be probably inside while we want outside
1250 temperature.  The collectd reference name is something like
1251 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1252 (<type_instance> is usually omitted when there is just single value type). Or
1253 you can figure it out from the path of the output data files.
1254
1255 =back
1256
1257 =head2 Plugin C<battery>
1258
1259 The I<battery plugin> reports the remaining capacity, power and voltage of
1260 laptop batteries.
1261
1262 =over 4
1263
1264 =item B<ValuesPercentage> B<false>|B<true>
1265
1266 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1267 capacity remaining". Otherwise the capacity is stored as reported by the
1268 battery, most likely in "Wh". This option does not work with all input methods,
1269 in particular when only C</proc/pmu> is available on an old Linux system.
1270 Defaults to B<false>.
1271
1272 =item B<ReportDegraded> B<false>|B<true>
1273
1274 Typical laptop batteries degrade over time, meaning the capacity decreases with
1275 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1276 "last full capacity" and used to determine that a battery is "fully charged".
1277
1278 When this option is set to B<false>, the default, the I<battery plugin> will
1279 only report the remaining capacity. If the B<ValuesPercentage> option is
1280 enabled, the relative remaining capacity is calculated as the ratio of the
1281 "remaining capacity" and the "last full capacity". This is what most tools,
1282 such as the status bar of desktop environments, also do.
1283
1284 When set to B<true>, the battery plugin will report three values: B<charged>
1285 (remaining capacity), B<discharged> (difference between "last full capacity"
1286 and "remaining capacity") and B<degraded> (difference between "design capacity"
1287 and "last full capacity").
1288
1289 =item B<QueryStateFS> B<false>|B<true>
1290
1291 When set to B<true>, the battery plugin will only read statistics
1292 related to battery performance as exposed by StateFS at
1293 /run/state. StateFS is used in Mer-based Sailfish OS, for
1294 example.
1295
1296 =back
1297
1298 =head2 Plugin C<bind>
1299
1300 Starting with BIND 9.5.0, the most widely used DNS server software provides
1301 extensive statistics about queries, responses and lots of other information.
1302 The bind plugin retrieves this information that's encoded in XML and provided
1303 via HTTP and submits the values to collectd.
1304
1305 To use this plugin, you first need to tell BIND to make this information
1306 available. This is done with the C<statistics-channels> configuration option:
1307
1308  statistics-channels {
1309    inet localhost port 8053;
1310  };
1311
1312 The configuration follows the grouping that can be seen when looking at the
1313 data with an XSLT compatible viewer, such as a modern web browser. It's
1314 probably a good idea to make yourself familiar with the provided values, so you
1315 can understand what the collected statistics actually mean.
1316
1317 Synopsis:
1318
1319  <Plugin "bind">
1320    URL "http://localhost:8053/"
1321    ParseTime       false
1322    OpCodes         true
1323    QTypes          true
1324
1325    ServerStats     true
1326    ZoneMaintStats  true
1327    ResolverStats   false
1328    MemoryStats     true
1329
1330    <View "_default">
1331      QTypes        true
1332      ResolverStats true
1333      CacheRRSets   true
1334
1335      Zone "127.in-addr.arpa/IN"
1336    </View>
1337  </Plugin>
1338
1339 The bind plugin accepts the following configuration options:
1340
1341 =over 4
1342
1343 =item B<URL> I<URL>
1344
1345 URL from which to retrieve the XML data. If not specified,
1346 C<http://localhost:8053/> will be used.
1347
1348 =item B<ParseTime> B<true>|B<false>
1349
1350 When set to B<true>, the time provided by BIND will be parsed and used to
1351 dispatch the values. When set to B<false>, the local time source is queried.
1352
1353 This setting is set to B<true> by default for backwards compatibility; setting
1354 this to B<false> is I<recommended> to avoid problems with timezones and
1355 localization.
1356
1357 =item B<OpCodes> B<true>|B<false>
1358
1359 When enabled, statistics about the I<"OpCodes">, for example the number of
1360 C<QUERY> packets, are collected.
1361
1362 Default: Enabled.
1363
1364 =item B<QTypes> B<true>|B<false>
1365
1366 When enabled, the number of I<incoming> queries by query types (for example
1367 C<A>, C<MX>, C<AAAA>) is collected.
1368
1369 Default: Enabled.
1370
1371 =item B<ServerStats> B<true>|B<false>
1372
1373 Collect global server statistics, such as requests received over IPv4 and IPv6,
1374 successful queries, and failed updates.
1375
1376 Default: Enabled.
1377
1378 =item B<ZoneMaintStats> B<true>|B<false>
1379
1380 Collect zone maintenance statistics, mostly information about notifications
1381 (zone updates) and zone transfers.
1382
1383 Default: Enabled.
1384
1385 =item B<ResolverStats> B<true>|B<false>
1386
1387 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1388 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1389 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1390 default. Use the B<ResolverStats> option within a B<View "_default"> block
1391 instead for the same functionality.
1392
1393 Default: Disabled.
1394
1395 =item B<MemoryStats>
1396
1397 Collect global memory statistics.
1398
1399 Default: Enabled.
1400
1401 =item B<Timeout> I<Milliseconds>
1402
1403 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1404 milliseconds. By default, the configured B<Interval> is used to set the
1405 timeout.
1406
1407 =item B<View> I<Name>
1408
1409 Collect statistics about a specific I<"view">. BIND can behave different,
1410 mostly depending on the source IP-address of the request. These different
1411 configurations are called "views". If you don't use this feature, you most
1412 likely are only interested in the C<_default> view.
1413
1414 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1415 information you want to collect about a view. If no B<View> block is
1416 configured, no detailed view statistics will be collected.
1417
1418 =over 4
1419
1420 =item B<QTypes> B<true>|B<false>
1421
1422 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1423 C<MX>) is collected.
1424
1425 Default: Enabled.
1426
1427 =item B<ResolverStats> B<true>|B<false>
1428
1429 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1430 (e.E<nbsp>g. queries over IPv4, lame servers).
1431
1432 Default: Enabled.
1433
1434 =item B<CacheRRSets> B<true>|B<false>
1435
1436 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1437 type is collected. Negative entries (queries which resulted in an error, for
1438 example names that do not exist) are reported with a leading exclamation mark,
1439 e.E<nbsp>g. "!A".
1440
1441 Default: Enabled.
1442
1443 =item B<Zone> I<Name>
1444
1445 When given, collect detailed information about the given zone in the view. The
1446 information collected if very similar to the global B<ServerStats> information
1447 (see above).
1448
1449 You can repeat this option to collect detailed information about multiple
1450 zones.
1451
1452 By default no detailed zone information is collected.
1453
1454 =back
1455
1456 =back
1457
1458 =head2 Plugin C<ceph>
1459
1460 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1461 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1462
1463 A separate B<Daemon> block must be configured for each ceph daemon to be
1464 monitored. The following example will read daemon statistics from four
1465 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1466
1467   <Plugin ceph>
1468     LongRunAvgLatency false
1469     ConvertSpecialMetricTypes true
1470     <Daemon "osd.0">
1471       SocketPath "/var/run/ceph/ceph-osd.0.asok"
1472     </Daemon>
1473     <Daemon "osd.1">
1474       SocketPath "/var/run/ceph/ceph-osd.1.asok"
1475     </Daemon>
1476     <Daemon "mon.a">
1477       SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1478     </Daemon>
1479     <Daemon "mds.a">
1480       SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1481     </Daemon>
1482   </Plugin>
1483
1484 The ceph plugin accepts the following configuration options:
1485
1486 =over 4
1487
1488 =item B<LongRunAvgLatency> B<true>|B<false>
1489
1490 If enabled, latency values(sum,count pairs) are calculated as the long run
1491 average - average since the ceph daemon was started = (sum / count).
1492 When disabled, latency values are calculated as the average since the last
1493 collection = (sum_now - sum_last) / (count_now - count_last).
1494
1495 Default: Disabled
1496
1497 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1498
1499 If enabled, special metrics (metrics that differ in type from similar counters)
1500 are converted to the type of those similar counters. This currently only
1501 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1502 ceph schema reports this metric type as a sum,count pair while similar counters
1503 are treated as derive types. When converted, the sum is used as the counter
1504 value and is treated as a derive type.
1505 When disabled, all metrics are treated as the types received from the ceph schema.
1506
1507 Default: Enabled
1508
1509 =back
1510
1511 Each B<Daemon> block must have a string argument for the plugin instance name.
1512 A B<SocketPath> is also required for each B<Daemon> block:
1513
1514 =over 4
1515
1516 =item B<Daemon> I<DaemonName>
1517
1518 Name to be used as the instance name for this daemon.
1519
1520 =item B<SocketPath> I<SocketPath>
1521
1522 Specifies the path to the UNIX admin socket of the ceph daemon.
1523
1524 =back
1525
1526 =head2 Plugin C<cgroups>
1527
1528 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1529 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1530 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1531
1532 =over 4
1533
1534 =item B<CGroup> I<Directory>
1535
1536 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1537 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1538 see below.
1539
1540 See F</"IGNORELISTS"> for details.
1541
1542 =item B<IgnoreSelected> B<true>|B<false>
1543
1544 Invert the selection: If set to true, all cgroups I<except> the ones that
1545 match any one of the criteria are collected. By default only selected
1546 cgroups are collected if a selection is made. If no selection is configured
1547 at all, B<all> cgroups are selected.
1548
1549 =back
1550
1551 =head2 Plugin C<chrony>
1552
1553 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1554 skew and per-peer stratum.
1555
1556 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1557 on the wire.
1558
1559 Available configuration options for the C<chrony> plugin:
1560
1561 =over 4
1562
1563 =item B<Host> I<Hostname>
1564
1565 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1566
1567 =item B<Port> I<Port>
1568
1569 UDP-Port to connect to. Defaults to B<323>.
1570
1571 =item B<Timeout> I<Timeout>
1572
1573 Connection timeout in seconds. Defaults to B<2>.
1574
1575 =back
1576
1577 =head2 Plugin Connectivity
1578
1579 connectivity - Documentation of collectd's C<connectivity plugin>
1580
1581
1582   LoadPlugin connectivity
1583   # ...
1584   <Plugin connectivity>
1585     Interface eth0
1586   </Plugin>
1587
1588 The C<connectivity plugin> queries interface status using netlink (man 7 netlink) which provides information about network interfaces via the NETLINK_ROUTE family (man 7 rtnetlink). The plugin translates the value it receives to collectd's internal format and, depending on the write plugins you have loaded, it may be written to disk or submitted to another instance.
1589 The plugin listens to interfaces enumerated within the plugin configuration (see below).  If no interfaces are listed, then the default is for all interfaces to be monitored.
1590
1591 This example shows C<connectivity plugin> monitoring all interfaces.
1592 LoadPlugin connectivity
1593 <Plugin connectivity>
1594 </Plugin>
1595
1596 This example shows C<connectivity plugin> monitoring 2 interfaces, "eth0" and "eth1".
1597 LoadPlugin connectivity
1598 <Plugin connectivity>
1599   Interface eth0
1600   Interface eth1
1601 </Plugin>
1602
1603 =over 4
1604
1605 =item B<Interface> I<interface_name>
1606
1607 interface(s) to monitor connect to.
1608
1609 =item I<Status>
1610
1611 If I<Status> is greater than or equal to zero the message indicates interface is up,
1612 if I<Status> is less than zero the message indicates interface is down.
1613
1614 =back
1615
1616 =head2 Plugin C<conntrack>
1617
1618 This plugin collects IP conntrack statistics.
1619
1620 =over 4
1621
1622 =item B<OldFiles>
1623
1624 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1625 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1626
1627 =back
1628
1629 =head2 Plugin C<cpu>
1630
1631 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1632 as Jiffies, using the C<cpu> type. Two aggregations are available:
1633
1634 =over 4
1635
1636 =item *
1637
1638 Sum, per-state, over all CPUs installed in the system; and
1639
1640 =item *
1641
1642 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1643
1644 =back
1645
1646 The two aggregations can be combined, leading to I<collectd> only emitting a
1647 single "active" metric for the entire system. As soon as one of these
1648 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1649 rather than Jiffies. In addition, you can request individual, per-state,
1650 per-CPU metrics to be reported as percentage.
1651
1652 The following configuration options are available:
1653
1654 =over 4
1655
1656 =item B<ReportByState> B<true>|B<false>
1657
1658 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1659 "user" and "idle".
1660 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1661 "active" metric.
1662
1663 =item B<ReportByCpu> B<true>|B<false>
1664
1665 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1666 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1667 global sum of CPU states is emitted.
1668
1669 =item B<ValuesPercentage> B<false>|B<true>
1670
1671 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1672 are set to B<true>. In this case, by default, metrics will be reported as
1673 Jiffies. By setting this option to B<true>, you can request percentage values
1674 in the un-aggregated (per-CPU, per-state) mode as well.
1675
1676 =item B<ReportNumCpu> B<false>|B<true>
1677
1678 When set to B<true>, reports the number of available CPUs.
1679 Defaults to B<false>.
1680
1681 =item B<ReportGuestState> B<false>|B<true>
1682
1683 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1684 Defaults to B<false>.
1685
1686 =item B<SubtractGuestState> B<false>|B<true>
1687
1688 This option is only considered when B<ReportGuestState> is set to B<true>.
1689 "guest" and "guest_nice" are included in respectively "user" and "nice".
1690 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1691 will be subtracted from "nice".
1692 Defaults to B<true>.
1693
1694 =back
1695
1696 =head2 Plugin C<cpufreq>
1697
1698 This plugin is available on Linux and FreeBSD only.  It doesn't have any
1699 options.  On Linux it reads
1700 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1701 installed) to get the current CPU frequency. If this file does not exist make
1702 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1703 installed and an "cpu governor" (that's a kernel module) is loaded.
1704
1705 On Linux, if the system has the I<cpufreq-stats> kernel module loaded, this
1706 plugin reports the rate of p-state (cpu frequency) transitions and the
1707 percentage of time spent in each p-state.
1708
1709 On FreeBSD it does a sysctl dev.cpu.0.freq and submits this as instance 0.
1710 At this time FreeBSD only has one frequency setting for all cores.
1711 See the BUGS section in the FreeBSD man page for cpufreq(4) for more details.
1712
1713 On FreeBSD the plugin checks the success of sysctl dev.cpu.0.freq and
1714 unregisters the plugin when this fails.  A message will be logged to indicate
1715 this.
1716
1717 =head2 Plugin C<cpusleep>
1718
1719 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1720 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1721 BOOTTIME clock increments while device is suspended and MONOTONIC
1722 clock does not, the derivative of the difference between these clocks
1723 gives the relative amount of time the device has spent in suspend
1724 state. The recorded value is in milliseconds of sleep per seconds of
1725 wall clock.
1726
1727 =head2 Plugin C<csv>
1728
1729 =over 4
1730
1731 =item B<DataDir> I<Directory>
1732
1733 Set the directory to store CSV-files under. Per default CSV-files are generated
1734 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1735 The special strings B<stdout> and B<stderr> can be used to write to the standard
1736 output and standard error channels, respectively. This, of course, only makes
1737 much sense when collectd is running in foreground- or non-daemon-mode.
1738
1739 =item B<StoreRates> B<true|false>
1740
1741 If set to B<true>, convert counter values to rates. If set to B<false> (the
1742 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1743 number.
1744
1745 =back
1746
1747 =head2 cURL Statistics
1748
1749 All cURL-based plugins support collection of generic, request-based
1750 statistics. These are disabled by default and can be enabled selectively for
1751 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1752 the documentation of those plugins for specific information. This section
1753 describes the available metrics that can be configured for each plugin. All
1754 options are disabled by default.
1755
1756 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1757
1758 =over 4
1759
1760 =item B<TotalTime> B<true|false>
1761
1762 Total time of the transfer, including name resolving, TCP connect, etc.
1763
1764 =item B<NamelookupTime> B<true|false>
1765
1766 Time it took from the start until name resolving was completed.
1767
1768 =item B<ConnectTime> B<true|false>
1769
1770 Time it took from the start until the connect to the remote host (or proxy)
1771 was completed.
1772
1773 =item B<AppconnectTime> B<true|false>
1774
1775 Time it took from the start until the SSL/SSH connect/handshake to the remote
1776 host was completed.
1777
1778 =item B<PretransferTime> B<true|false>
1779
1780 Time it took from the start until just before the transfer begins.
1781
1782 =item B<StarttransferTime> B<true|false>
1783
1784 Time it took from the start until the first byte was received.
1785
1786 =item B<RedirectTime> B<true|false>
1787
1788 Time it took for all redirection steps include name lookup, connect,
1789 pre-transfer and transfer before final transaction was started.
1790
1791 =item B<RedirectCount> B<true|false>
1792
1793 The total number of redirections that were actually followed.
1794
1795 =item B<SizeUpload> B<true|false>
1796
1797 The total amount of bytes that were uploaded.
1798
1799 =item B<SizeDownload> B<true|false>
1800
1801 The total amount of bytes that were downloaded.
1802
1803 =item B<SpeedDownload> B<true|false>
1804
1805 The average download speed that curl measured for the complete download.
1806
1807 =item B<SpeedUpload> B<true|false>
1808
1809 The average upload speed that curl measured for the complete upload.
1810
1811 =item B<HeaderSize> B<true|false>
1812
1813 The total size of all the headers received.
1814
1815 =item B<RequestSize> B<true|false>
1816
1817 The total size of the issued requests.
1818
1819 =item B<ContentLengthDownload> B<true|false>
1820
1821 The content-length of the download.
1822
1823 =item B<ContentLengthUpload> B<true|false>
1824
1825 The specified size of the upload.
1826
1827 =item B<NumConnects> B<true|false>
1828
1829 The number of new connections that were created to achieve the transfer.
1830
1831 =back
1832
1833 =head2 Plugin C<curl>
1834
1835 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1836 and the match infrastructure (the same code used by the tail plugin) to use
1837 regular expressions with the received data.
1838
1839 The following example will read the current value of AMD stock from Google's
1840 finance page and dispatch the value to collectd.
1841
1842   <Plugin curl>
1843     <Page "stock_quotes">
1844       Plugin "quotes"
1845       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1846       AddressFamily "any"
1847       User "foo"
1848       Password "bar"
1849       Digest false
1850       VerifyPeer true
1851       VerifyHost true
1852       CACert "/path/to/ca.crt"
1853       Header "X-Custom-Header: foobar"
1854       Post "foo=bar"
1855
1856       MeasureResponseTime false
1857       MeasureResponseCode false
1858
1859       <Match>
1860         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1861         DSType "GaugeAverage"
1862         # Note: `stock_value' is not a standard type.
1863         Type "stock_value"
1864         Instance "AMD"
1865       </Match>
1866     </Page>
1867   </Plugin>
1868
1869 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1870 a web page and one or more "matches" to be performed on the returned data. The
1871 string argument to the B<Page> block is used as plugin instance.
1872
1873 The following options are valid within B<Page> blocks:
1874
1875 =over 4
1876
1877 =item B<Plugin> I<Plugin>
1878
1879 Use I<Plugin> as the plugin name when submitting values.
1880 Defaults to C<curl>.
1881
1882 =item B<URL> I<URL>
1883
1884 URL of the web site to retrieve. Since a regular expression will be used to
1885 extract information from this data, non-binary data is a big plus here ;)
1886
1887 =item B<AddressFamily> I<Type>
1888
1889 IP version to resolve URL to. Useful in cases when hostname in URL resolves
1890 to both IPv4 and IPv6 addresses, and you are interested in using one of them
1891 specifically.
1892 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
1893 default behavior of resolving addresses to all IP versions your system allows.
1894 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
1895 a warning and fallback to C<any>.
1896 If C<Type> cannot be parsed, a warning will be printed and the whole B<Page>
1897 block will be ignored.
1898
1899 =item B<User> I<Name>
1900
1901 Username to use if authorization is required to read the page.
1902
1903 =item B<Password> I<Password>
1904
1905 Password to use if authorization is required to read the page.
1906
1907 =item B<Digest> B<true>|B<false>
1908
1909 Enable HTTP digest authentication.
1910
1911 =item B<VerifyPeer> B<true>|B<false>
1912
1913 Enable or disable peer SSL certificate verification. See
1914 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1915
1916 =item B<VerifyHost> B<true>|B<false>
1917
1918 Enable or disable peer host name verification. If enabled, the plugin checks if
1919 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1920 matches the host name provided by the B<URL> option. If this identity check
1921 fails, the connection is aborted. Obviously, only works when connecting to a
1922 SSL enabled server. Enabled by default.
1923
1924 =item B<CACert> I<file>
1925
1926 File that holds one or more SSL certificates. If you want to use HTTPS you will
1927 possibly need this option. What CA certificates come bundled with C<libcurl>
1928 and are checked by default depends on the distribution you use.
1929
1930 =item B<Header> I<Header>
1931
1932 A HTTP header to add to the request. Multiple headers are added if this option
1933 is specified more than once.
1934
1935 =item B<Post> I<Body>
1936
1937 Specifies that the HTTP operation should be a POST instead of a GET. The
1938 complete data to be posted is given as the argument.  This option will usually
1939 need to be accompanied by a B<Header> option to set an appropriate
1940 C<Content-Type> for the post body (e.g. to
1941 C<application/x-www-form-urlencoded>).
1942
1943 =item B<MeasureResponseTime> B<true>|B<false>
1944
1945 Measure response time for the request. If this setting is enabled, B<Match>
1946 blocks (see below) are optional. Disabled by default.
1947
1948 Beware that requests will get aborted if they take too long to complete. Adjust
1949 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1950 requests.
1951
1952 This option is similar to enabling the B<TotalTime> statistic but it's
1953 measured by collectd instead of cURL.
1954
1955 =item B<MeasureResponseCode> B<true>|B<false>
1956
1957 Measure response code for the request. If this setting is enabled, B<Match>
1958 blocks (see below) are optional. Disabled by default.
1959
1960 =item B<E<lt>StatisticsE<gt>>
1961
1962 One B<Statistics> block can be used to specify cURL statistics to be collected
1963 for each request to the remote web site. See the section "cURL Statistics"
1964 above for details. If this setting is enabled, B<Match> blocks (see below) are
1965 optional.
1966
1967 =item B<E<lt>MatchE<gt>>
1968
1969 One or more B<Match> blocks that define how to match information in the data
1970 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1971 used by the C<tail> plugin, so please see the documentation of the C<tail>
1972 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1973 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1974 optional.
1975
1976 =item B<Interval> I<Interval>
1977
1978 Sets the interval (in seconds) in which the values will be collected from this
1979 URL. By default the global B<Interval> setting will be used.
1980
1981 =item B<Timeout> I<Milliseconds>
1982
1983 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1984 milliseconds. By default, the configured B<Interval> is used to set the
1985 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1986 indefinitely. This legacy behaviour can be achieved by setting the value of
1987 B<Timeout> to 0.
1988
1989 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1990 network connection will stall one read thread. Adjust the B<ReadThreads> global
1991 setting accordingly to prevent this from blocking other plugins.
1992
1993 =back
1994
1995 =head2 Plugin C<curl_json>
1996
1997 The B<curl_json plugin> collects values from JSON data to be parsed by
1998 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1999 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
2000 unix socket. The former can be used, for example, to collect values
2001 from CouchDB documents (which are stored JSON notation), and the
2002 latter to collect values from a uWSGI stats socket.
2003
2004 The following example will collect several values from the built-in
2005 C<_stats> runtime statistics module of I<CouchDB>
2006 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
2007
2008   <Plugin curl_json>
2009     <URL "http://localhost:5984/_stats">
2010       AddressFamily "any"
2011       Instance "httpd"
2012       <Key "httpd/requests/count">
2013         Type "http_requests"
2014       </Key>
2015
2016       <Key "httpd_request_methods/*/count">
2017         Type "http_request_methods"
2018       </Key>
2019
2020       <Key "httpd_status_codes/*/count">
2021         Type "http_response_codes"
2022       </Key>
2023     </URL>
2024   </Plugin>
2025
2026 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
2027
2028   <Plugin curl_json>
2029     <Sock "/var/run/uwsgi.stats.sock">
2030       Instance "uwsgi"
2031       <Key "workers/*/requests">
2032         Type "http_requests"
2033       </Key>
2034
2035       <Key "workers/*/apps/*/requests">
2036         Type "http_requests"
2037       </Key>
2038     </Sock>
2039   </Plugin>
2040
2041 In the B<Plugin> block, there may be one or more B<URL> blocks, each
2042 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
2043 blocks defining a unix socket to read JSON from directly.  Each of
2044 these blocks may have one or more B<Key> blocks.
2045
2046 The B<Key> string argument must be in a path format. Each component is
2047 used to match the key from a JSON map or the index of an JSON
2048 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
2049 values for all map keys or array indices will be collectd.
2050
2051 The following options are valid within B<URL> blocks:
2052
2053 =over 4
2054
2055 =item B<AddressFamily> I<Type>
2056
2057 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2058 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2059 specifically.
2060 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2061 default behavior of resolving addresses to all IP versions your system allows.
2062 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2063 a warning and fallback to C<any>.
2064 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2065 block will be ignored.
2066
2067 =item B<Host> I<Name>
2068
2069 Use I<Name> as the host name when submitting values. Defaults to the global
2070 host name setting.
2071
2072 =item B<Plugin> I<Plugin>
2073
2074 Use I<Plugin> as the plugin name when submitting values.
2075 Defaults to C<curl_json>.
2076
2077 =item B<Instance> I<Instance>
2078
2079 Sets the plugin instance to I<Instance>.
2080
2081 =item B<Interval> I<Interval>
2082
2083 Sets the interval (in seconds) in which the values will be collected from this
2084 URL. By default the global B<Interval> setting will be used.
2085
2086 =item B<User> I<Name>
2087
2088 =item B<Password> I<Password>
2089
2090 =item B<Digest> B<true>|B<false>
2091
2092 =item B<VerifyPeer> B<true>|B<false>
2093
2094 =item B<VerifyHost> B<true>|B<false>
2095
2096 =item B<CACert> I<file>
2097
2098 =item B<Header> I<Header>
2099
2100 =item B<Post> I<Body>
2101
2102 =item B<Timeout> I<Milliseconds>
2103
2104 These options behave exactly equivalent to the appropriate options of the
2105 I<cURL> plugin. Please see there for a detailed description.
2106
2107 =item B<E<lt>StatisticsE<gt>>
2108
2109 One B<Statistics> block can be used to specify cURL statistics to be collected
2110 for each request to the remote URL. See the section "cURL Statistics" above
2111 for details.
2112
2113 =back
2114
2115 The following options are valid within B<Key> blocks:
2116
2117 =over 4
2118
2119 =item B<Type> I<Type>
2120
2121 Sets the type used to dispatch the values to the daemon. Detailed information
2122 about types and their configuration can be found in L<types.db(5)>. This
2123 option is mandatory.
2124
2125 =item B<Instance> I<Instance>
2126
2127 Type-instance to use. Defaults to the current map key or current string array element value.
2128
2129 =back
2130
2131 =head2 Plugin C<curl_xml>
2132
2133 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2134 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2135
2136  <Plugin "curl_xml">
2137    <URL "http://localhost/stats.xml">
2138      AddressFamily "any"
2139      Host "my_host"
2140      #Plugin "curl_xml"
2141      Instance "some_instance"
2142      User "collectd"
2143      Password "thaiNg0I"
2144      VerifyPeer true
2145      VerifyHost true
2146      CACert "/path/to/ca.crt"
2147      Header "X-Custom-Header: foobar"
2148      Post "foo=bar"
2149
2150      <XPath "table[@id=\"magic_level\"]/tr">
2151        Type "magic_level"
2152        #InstancePrefix "prefix-"
2153        InstanceFrom "td[1]"
2154        #PluginInstanceFrom "td[1]"
2155        ValuesFrom "td[2]/span[@class=\"level\"]"
2156      </XPath>
2157    </URL>
2158  </Plugin>
2159
2160 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2161 URL to be fetched using libcurl. Within each B<URL> block there are
2162 options which specify the connection parameters, for example authentication
2163 information, and one or more B<XPath> blocks.
2164
2165 Each B<XPath> block specifies how to get one type of information. The
2166 string argument must be a valid XPath expression which returns a list
2167 of "base elements". One value is dispatched for each "base element". The
2168 I<type instance> and values are looked up using further I<XPath> expressions
2169 that should be relative to the base element.
2170
2171 Within the B<URL> block the following options are accepted:
2172
2173 =over 4
2174
2175 =item B<AddressFamily> I<Type>
2176
2177 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2178 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2179 specifically.
2180 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2181 default behavior of resolving addresses to all IP versions your system allows.
2182 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2183 a warning and fallback to C<any>.
2184 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2185 block will be ignored.
2186
2187 =item B<Host> I<Name>
2188
2189 Use I<Name> as the host name when submitting values. Defaults to the global
2190 host name setting.
2191
2192 =item B<Plugin> I<Plugin>
2193
2194 Use I<Plugin> as the plugin name when submitting values.
2195 Defaults to 'curl_xml'.
2196
2197 =item B<Instance> I<Instance>
2198
2199 Use I<Instance> as the plugin instance when submitting values.
2200 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2201 Defaults to an empty string (no plugin instance).
2202
2203 =item B<Interval> I<Interval>
2204
2205 Sets the interval (in seconds) in which the values will be collected from this
2206 URL. By default the global B<Interval> setting will be used.
2207
2208 =item B<Namespace> I<Prefix> I<URL>
2209
2210 If an XPath expression references namespaces, they must be specified
2211 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2212 I<URL> is the "namespace name", an URI reference uniquely identifying the
2213 namespace. The option can be repeated to register multiple namespaces.
2214
2215 Examples:
2216
2217   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2218   Namespace "m" "http://www.w3.org/1998/Math/MathML"
2219
2220 =item B<User> I<User>
2221
2222 =item B<Password> I<Password>
2223
2224 =item B<Digest> B<true>|B<false>
2225
2226 =item B<VerifyPeer> B<true>|B<false>
2227
2228 =item B<VerifyHost> B<true>|B<false>
2229
2230 =item B<CACert> I<CA Cert File>
2231
2232 =item B<Header> I<Header>
2233
2234 =item B<Post> I<Body>
2235
2236 =item B<Timeout> I<Milliseconds>
2237
2238 These options behave exactly equivalent to the appropriate options of the
2239 I<cURL plugin>. Please see there for a detailed description.
2240
2241 =item B<E<lt>StatisticsE<gt>>
2242
2243 One B<Statistics> block can be used to specify cURL statistics to be collected
2244 for each request to the remote URL. See the section "cURL Statistics" above
2245 for details.
2246
2247 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2248
2249 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2250 B<XPath> block specifies how to get one type of information. The string
2251 argument must be a valid XPath expression which returns a list of "base
2252 elements". One value is dispatched for each "base element".
2253
2254 Within the B<XPath> block the following options are accepted:
2255
2256 =over 4
2257
2258 =item B<Type> I<Type>
2259
2260 Specifies the I<Type> used for submitting patches. This determines the number
2261 of values that are required / expected and whether the strings are parsed as
2262 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2263 This option is required.
2264
2265 =item B<InstancePrefix> I<InstancePrefix>
2266
2267 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2268 concatenated together without any separator.
2269 This option is optional.
2270
2271 =item B<InstanceFrom> I<InstanceFrom>
2272
2273 Specifies a XPath expression to use for determining the I<type instance>. The
2274 XPath expression must return exactly one element. The element's value is then
2275 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2276
2277 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2278
2279 Specifies a XPath expression to use for determining the I<plugin instance>. The
2280 XPath expression must return exactly one element. The element's value is then
2281 used as I<plugin instance>.
2282
2283 =back
2284
2285 If the "base XPath expression" (the argument to the B<XPath> block) returns
2286 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2287 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2288
2289 =over 4
2290
2291 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2292
2293 Specifies one or more XPath expression to use for reading the values. The
2294 number of XPath expressions must match the number of data sources in the
2295 I<type> specified with B<Type> (see above). Each XPath expression must return
2296 exactly one element. The element's value is then parsed as a number and used as
2297 value for the appropriate value in the value list dispatched to the daemon.
2298 This option is required.
2299
2300 =back
2301
2302 =back
2303
2304 =head2 Plugin C<dbi>
2305
2306 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2307 connect to various databases, execute I<SQL> statements and read back the
2308 results. I<dbi> is an acronym for "database interface" in case you were
2309 wondering about the name. You can configure how each column is to be
2310 interpreted and the plugin will generate one or more data sets from each row
2311 returned according to these rules.
2312
2313 Because the plugin is very generic, the configuration is a little more complex
2314 than those of other plugins. It usually looks something like this:
2315
2316   <Plugin dbi>
2317     <Query "out_of_stock">
2318       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2319       # Use with MySQL 5.0.0 or later
2320       MinVersion 50000
2321       <Result>
2322         Type "gauge"
2323         InstancePrefix "out_of_stock"
2324         InstancesFrom "category"
2325         ValuesFrom "value"
2326       </Result>
2327     </Query>
2328     <Database "product_information">
2329       #Plugin "warehouse"
2330       Driver "mysql"
2331       Interval 120
2332       DriverOption "host" "localhost"
2333       DriverOption "username" "collectd"
2334       DriverOption "password" "aZo6daiw"
2335       DriverOption "dbname" "prod_info"
2336       SelectDB "prod_info"
2337       Query "out_of_stock"
2338     </Database>
2339   </Plugin>
2340
2341 The configuration above defines one query with one result and one database. The
2342 query is then linked to the database with the B<Query> option I<within> the
2343 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2344 and you can also use the B<Include> statement to split up the configuration
2345 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2346 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2347 top to bottom!
2348
2349 The following is a complete list of options:
2350
2351 =head3 B<Query> blocks
2352
2353 Query blocks define I<SQL> statements and how the returned data should be
2354 interpreted. They are identified by the name that is given in the opening line
2355 of the block. Thus the name needs to be unique. Other than that, the name is
2356 not used in collectd.
2357
2358 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2359 define which column holds which value or instance information. You can use
2360 multiple B<Result> blocks to create multiple values from one returned row. This
2361 is especially useful, when queries take a long time and sending almost the same
2362 query again and again is not desirable.
2363
2364 Example:
2365
2366   <Query "environment">
2367     Statement "select station, temperature, humidity from environment"
2368     <Result>
2369       Type "temperature"
2370       # InstancePrefix "foo"
2371       InstancesFrom "station"
2372       ValuesFrom "temperature"
2373     </Result>
2374     <Result>
2375       Type "humidity"
2376       InstancesFrom "station"
2377       ValuesFrom "humidity"
2378     </Result>
2379   </Query>
2380
2381 The following options are accepted:
2382
2383 =over 4
2384
2385 =item B<Statement> I<SQL>
2386
2387 Sets the statement that should be executed on the server. This is B<not>
2388 interpreted by collectd, but simply passed to the database server. Therefore,
2389 the SQL dialect that's used depends on the server collectd is connected to.
2390
2391 The query has to return at least two columns, one for the instance and one
2392 value. You cannot omit the instance, even if the statement is guaranteed to
2393 always return exactly one line. In that case, you can usually specify something
2394 like this:
2395
2396   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2397
2398 (That works with MySQL but may not be valid SQL according to the spec. If you
2399 use a more strict database server, you may have to select from a dummy table or
2400 something.)
2401
2402 Please note that some databases, for example B<Oracle>, will fail if you
2403 include a semicolon at the end of the statement.
2404
2405 =item B<MinVersion> I<Version>
2406
2407 =item B<MaxVersion> I<Value>
2408
2409 Only use this query for the specified database version. You can use these
2410 options to provide multiple queries with the same name but with a slightly
2411 different syntax. The plugin will use only those queries, where the specified
2412 minimum and maximum versions fit the version of the database in use.
2413
2414 The database version is determined by C<dbi_conn_get_engine_version>, see the
2415 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2416 for details. Basically, each part of the version is assumed to be in the range
2417 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2418 "40102", version "5.0.42" becomes "50042".
2419
2420 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2421 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2422 happen. Don't to it! A valid example would be something along these lines:
2423
2424   MinVersion 40000
2425   MaxVersion 49999
2426   ...
2427   MinVersion 50000
2428   MaxVersion 50099
2429   ...
2430   MinVersion 50100
2431   # No maximum
2432
2433 In the above example, there are three ranges that don't overlap. The last one
2434 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2435 before "4.0.0" are not specified.
2436
2437 =item B<Type> I<Type>
2438
2439 The B<type> that's used for each line returned. See L<types.db(5)> for more
2440 details on how types are defined. In short: A type is a predefined layout of
2441 data and the number of values and type of values has to match the type
2442 definition.
2443
2444 If you specify "temperature" here, you need exactly one gauge column. If you
2445 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2446 setting below.
2447
2448 There must be exactly one B<Type> option inside each B<Result> block.
2449
2450 =item B<InstancePrefix> I<prefix>
2451
2452 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2453 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2454 all strings returned in the appropriate columns are concatenated together,
2455 separated by dashes I<("-")>.
2456
2457 =item B<InstancesFrom> I<column0> [I<column1> ...]
2458
2459 Specifies the columns whose values will be used to create the "type-instance"
2460 for each row. If you specify more than one column, the value of all columns
2461 will be joined together with dashes I<("-")> as separation characters.
2462
2463 The plugin itself does not check whether or not all built instances are
2464 different. It's your responsibility to assure that each is unique. This is
2465 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2466 sure that only one row is returned in this case.
2467
2468 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2469 will be empty.
2470
2471 =item B<ValuesFrom> I<column0> [I<column1> ...]
2472
2473 Names the columns whose content is used as the actual data for the data sets
2474 that are dispatched to the daemon. How many such columns you need is determined
2475 by the B<Type> setting above. If you specify too many or not enough columns,
2476 the plugin will complain about that and no data will be submitted to the
2477 daemon.
2478
2479 The actual data type in the columns is not that important. The plugin will
2480 automatically cast the values to the right type if it know how to do that. So
2481 it should be able to handle integer an floating point types, as well as strings
2482 (if they include a number at the beginning).
2483
2484 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2485
2486 =item B<MetadataFrom> [I<column0> I<column1> ...]
2487
2488 Names the columns whose content is used as metadata for the data sets
2489 that are dispatched to the daemon.
2490
2491 The actual data type in the columns is not that important. The plugin will
2492 automatically cast the values to the right type if it know how to do that. So
2493 it should be able to handle integer an floating point types, as well as strings
2494 (if they include a number at the beginning).
2495
2496 =back
2497
2498 =head3 B<Database> blocks
2499
2500 Database blocks define a connection to a database and which queries should be
2501 sent to that database. Since the used "dbi" library can handle a wide variety
2502 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2503 documentationE<nbsp>- we stick as close to the terminology used there.
2504
2505 Each database needs a "name" as string argument in the starting tag of the
2506 block. This name will be used as "PluginInstance" in the values submitted to
2507 the daemon. Other than that, that name is not used.
2508
2509 =over 4
2510
2511 =item B<Plugin> I<Plugin>
2512
2513 Use I<Plugin> as the plugin name when submitting query results from
2514 this B<Database>. Defaults to C<dbi>.
2515
2516 =item B<Interval> I<Interval>
2517
2518 Sets the interval (in seconds) in which the values will be collected from this
2519 database. By default the global B<Interval> setting will be used.
2520
2521 =item B<Driver> I<Driver>
2522
2523 Specifies the driver to use to connect to the database. In many cases those
2524 drivers are named after the database they can connect to, but this is not a
2525 technical necessity. These drivers are sometimes referred to as "DBD",
2526 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2527 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2528 project at L<http://libdbi-drivers.sourceforge.net/>.
2529
2530 You need to give the driver name as expected by the "dbi" library here. You
2531 should be able to find that in the documentation for each driver. If you
2532 mistype the driver name, the plugin will dump a list of all known driver names
2533 to the log.
2534
2535 =item B<DriverOption> I<Key> I<Value>
2536
2537 Sets driver-specific options. What option a driver supports can be found in the
2538 documentation for each driver, somewhere at
2539 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2540 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2541
2542 DBDs can register two types of options: String options and numeric options. The
2543 plugin will use the C<dbi_conn_set_option> function when the configuration
2544 provides a string and the C<dbi_conn_require_option_numeric> function when the
2545 configuration provides a number. So these two lines will actually result in
2546 different calls being used:
2547
2548   DriverOption "Port" 1234      # numeric
2549   DriverOption "Port" "1234"    # string
2550
2551 Unfortunately, drivers are not too keen to report errors when an unknown option
2552 is passed to them, so invalid settings here may go unnoticed. This is not the
2553 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2554 the driver. If a driver complains about an option, the plugin will dump a
2555 complete list of all options understood by that driver to the log. There is no
2556 way to programmatically find out if an option expects a string or a numeric
2557 argument, so you will have to refer to the appropriate DBD's documentation to
2558 find this out. Sorry.
2559
2560 =item B<SelectDB> I<Database>
2561
2562 In some cases, the database name you connect with is not the database name you
2563 want to use for querying data. If this option is set, the plugin will "select"
2564 (switch to) that database after the connection is established.
2565
2566 =item B<Query> I<QueryName>
2567
2568 Associates the query named I<QueryName> with this database connection. The
2569 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2570 blocks you want to refer to must be placed above the database block you want to
2571 refer to them from.
2572
2573 =item B<Host> I<Hostname>
2574
2575 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2576 values. Defaults to the global hostname setting.
2577
2578 =back
2579
2580 =head2 Plugin C<df>
2581
2582 =over 4
2583
2584 =item B<Device> I<Device>
2585
2586 Select partitions based on the devicename.
2587
2588 See F</"IGNORELISTS"> for details.
2589
2590 =item B<MountPoint> I<Directory>
2591
2592 Select partitions based on the mountpoint.
2593
2594 See F</"IGNORELISTS"> for details.
2595
2596 =item B<FSType> I<FSType>
2597
2598 Select partitions based on the filesystem type.
2599
2600 See F</"IGNORELISTS"> for details.
2601
2602 =item B<IgnoreSelected> B<true>|B<false>
2603
2604 Invert the selection: If set to true, all partitions B<except> the ones that
2605 match any one of the criteria are collected. By default only selected
2606 partitions are collected if a selection is made. If no selection is configured
2607 at all, B<all> partitions are selected.
2608
2609 =item B<ReportByDevice> B<true>|B<false>
2610
2611 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2612 (the default), it will report a disk as "root", but with it I<true>, it will be
2613 "sda1" (or whichever).
2614
2615 =item B<ReportInodes> B<true>|B<false>
2616
2617 Enables or disables reporting of free, reserved and used inodes. Defaults to
2618 inode collection being disabled.
2619
2620 Enable this option if inodes are a scarce resource for you, usually because
2621 many small files are stored on the disk. This is a usual scenario for mail
2622 transfer agents and web caches.
2623
2624 =item B<ValuesAbsolute> B<true>|B<false>
2625
2626 Enables or disables reporting of free and used disk space in 1K-blocks.
2627 Defaults to B<true>.
2628
2629 =item B<ValuesPercentage> B<false>|B<true>
2630
2631 Enables or disables reporting of free and used disk space in percentage.
2632 Defaults to B<false>.
2633
2634 This is useful for deploying I<collectd> on the cloud, where machines with
2635 different disk size may exist. Then it is more practical to configure
2636 thresholds based on relative disk size.
2637
2638 =back
2639
2640 =head2 Plugin C<disk>
2641
2642 The C<disk> plugin collects information about the usage of physical disks and
2643 logical disks (partitions). Values collected are the number of octets written
2644 to and read from a disk or partition, the number of read/write operations
2645 issued to the disk and a rather complex "time" it took for these commands to be
2646 issued.
2647
2648 Using the following two options you can ignore some disks or configure the
2649 collection only of specific disks.
2650
2651 =over 4
2652
2653 =item B<Disk> I<Name>
2654
2655 Select the disk I<Name>. Whether it is collected or ignored depends on the
2656 B<IgnoreSelected> setting, see below. As with other plugins that use the
2657 daemon's ignorelist functionality, a string that starts and ends with a slash
2658 is interpreted as a regular expression. Examples:
2659
2660   Disk "sdd"
2661   Disk "/hda[34]/"
2662
2663 See F</"IGNORELISTS"> for details.
2664
2665 =item B<IgnoreSelected> B<true>|B<false>
2666
2667 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2668 statements, are ignored or if all other disks are ignored. The behavior
2669 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2670 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2671 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2672 is set to B<true>, all disks are collected B<except> the ones matched.
2673
2674 =item B<UseBSDName> B<true>|B<false>
2675
2676 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2677 default major/minor numbers. Requires collectd to be built with Apple's
2678 IOKitLib support.
2679
2680 =item B<UdevNameAttr> I<Attribute>
2681
2682 Attempt to override disk instance name with the value of a specified udev
2683 attribute when built with B<libudev>.  If the attribute is not defined for the
2684 given device, the default name is used. Example:
2685
2686   UdevNameAttr "DM_NAME"
2687
2688 =back
2689
2690 =head2 Plugin C<dns>
2691
2692 =over 4
2693
2694 =item B<Interface> I<Interface>
2695
2696 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2697 option sets the interface that should be used. If this option is not set, or
2698 set to "any", the plugin will try to get packets from B<all> interfaces. This
2699 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2700
2701 =item B<IgnoreSource> I<IP-address>
2702
2703 Ignore packets that originate from this address.
2704
2705 =item B<SelectNumericQueryTypes> B<true>|B<false>
2706
2707 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2708
2709 =back
2710
2711 =head2 Plugin C<dpdkevents>
2712
2713 The I<dpdkevents plugin> collects events from DPDK such as link status of
2714 network ports and Keep Alive status of DPDK logical cores.
2715 In order to get Keep Alive events following requirements must be met:
2716 - DPDK >= 16.07
2717 - support for Keep Alive implemented in DPDK application. More details can
2718 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2719
2720 B<Synopsis:>
2721
2722  <Plugin "dpdkevents">
2723    <EAL>
2724      Coremask "0x1"
2725      MemoryChannels "4"
2726      FilePrefix "rte"
2727    </EAL>
2728    <Event "link_status">
2729      SendEventsOnUpdate true
2730      EnabledPortMask 0xffff
2731      PortName "interface1"
2732      PortName "interface2"
2733      SendNotification false
2734    </Event>
2735    <Event "keep_alive">
2736      SendEventsOnUpdate true
2737      LCoreMask "0xf"
2738      KeepAliveShmName "/dpdk_keepalive_shm_name"
2739      SendNotification false
2740    </Event>
2741  </Plugin>
2742
2743 B<Options:>
2744
2745
2746 =head3 The EAL block
2747
2748 =over 4
2749
2750 =item B<Coremask> I<Mask>
2751
2752 =item B<Memorychannels> I<Channels>
2753
2754 Number of memory channels per processor socket.
2755
2756 =item B<FilePrefix> I<File>
2757
2758 The prefix text used for hugepage filenames. The filename will be set to
2759 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2760
2761 =back
2762
2763 =head3 The Event block
2764
2765 The B<Event> block defines configuration for specific event. It accepts a
2766 single argument which specifies the name of the event.
2767
2768 =head4 Link Status event
2769
2770 =over 4
2771
2772 =item B<SendEventOnUpdate> I<true|false>
2773
2774 If set to true link status value will be dispatched only when it is
2775 different from previously read value. This is an optional argument - default
2776 value is true.
2777
2778 =item B<EnabledPortMask> I<Mask>
2779
2780 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2781 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2782 that all ports will be enabled. This is an optional argument - by default
2783 all ports are enabled.
2784
2785 =item B<PortName> I<Name>
2786
2787 A string containing an optional name for the enabled DPDK ports. Each PortName
2788 option should contain only one port name; specify as many PortName options as
2789 desired. Default naming convention will be used if PortName is blank. If there
2790 are less PortName options than there are enabled ports, the default naming
2791 convention will be used for the additional ports.
2792
2793 =item B<SendNotification> I<true|false>
2794
2795 If set to true, link status notifications are sent, instead of link status
2796 being collected as a statistic. This is an optional argument - default
2797 value is false.
2798
2799 =back
2800
2801 =head4 Keep Alive event
2802
2803 =over 4
2804
2805 =item B<SendEventOnUpdate> I<true|false>
2806
2807 If set to true keep alive value will be dispatched only when it is
2808 different from previously read value. This is an optional argument - default
2809 value is true.
2810
2811 =item B<LCoreMask> I<Mask>
2812
2813 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2814
2815 =item B<KeepAliveShmName> I<Name>
2816
2817 Shared memory name identifier that is used by secondary process to monitor
2818 the keep alive cores state.
2819
2820 =item B<SendNotification> I<true|false>
2821
2822 If set to true, keep alive notifications are sent, instead of keep alive
2823 information being collected as a statistic. This is an optional
2824 argument - default value is false.
2825
2826 =back
2827
2828 =head2 Plugin C<dpdkstat>
2829
2830 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2831 extended NIC stats API in DPDK.
2832
2833 B<Synopsis:>
2834
2835  <Plugin "dpdkstat">
2836    <EAL>
2837      Coremask "0x4"
2838      MemoryChannels "4"
2839      FilePrefix "rte"
2840      SocketMemory "1024"
2841      LogLevel "7"
2842      RteDriverLibPath "/usr/lib/dpdk-pmd"
2843    </EAL>
2844    SharedMemObj "dpdk_collectd_stats_0"
2845    EnabledPortMask 0xffff
2846    PortName "interface1"
2847    PortName "interface2"
2848  </Plugin>
2849
2850 B<Options:>
2851
2852 =head3 The EAL block
2853
2854 =over 4
2855
2856 =item B<Coremask> I<Mask>
2857
2858 A string containing an hexadecimal bit mask of the cores to run on. Note that
2859 core numbering can change between platforms and should be determined beforehand.
2860
2861 =item B<Memorychannels> I<Channels>
2862
2863 A string containing a number of memory channels per processor socket.
2864
2865 =item B<FilePrefix> I<File>
2866
2867 The prefix text used for hugepage filenames. The filename will be set to
2868 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2869
2870 =item B<SocketMemory> I<MB>
2871
2872 A string containing amount of Memory to allocate from hugepages on specific
2873 sockets in MB. This is an optional value.
2874
2875 =item B<LogLevel> I<LogLevel_number>
2876
2877 A string containing log level number. This parameter is optional.
2878 If parameter is not present then default value "7" - (INFO) is used.
2879 Value "8" - (DEBUG) can be set to enable debug traces.
2880
2881 =item B<RteDriverLibPath> I<Path>
2882
2883 A string containing path to shared pmd driver lib or path to directory,
2884 where shared pmd driver libs are available. This parameter is optional.
2885 This parameter enable loading of shared pmd driver libs from defined path.
2886 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2887 or    "/usr/lib/dpdk-pmd"
2888
2889 =back
2890
2891 =over 3
2892
2893 =item B<SharedMemObj> I<Mask>
2894
2895 A string containing the name of the shared memory object that should be used to
2896 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2897 Defaults to dpdk_collectd_stats if no other value is configured.
2898
2899 =item B<EnabledPortMask> I<Mask>
2900
2901 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2902 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2903 that all ports will be enabled. This is an optional argument - default
2904 is all ports enabled.
2905
2906 =item B<PortName> I<Name>
2907
2908 A string containing an optional name for the enabled DPDK ports. Each PortName
2909 option should contain only one port name; specify as many PortName options as
2910 desired. Default naming convention will be used if PortName is blank. If there
2911 are less PortName options than there are enabled ports, the default naming
2912 convention will be used for the additional ports.
2913
2914 =back
2915
2916 =head2 Plugin C<email>
2917
2918 =over 4
2919
2920 =item B<SocketFile> I<Path>
2921
2922 Sets the socket-file which is to be created.
2923
2924 =item B<SocketGroup> I<Group>
2925
2926 If running as root change the group of the UNIX-socket after it has been
2927 created. Defaults to B<collectd>.
2928
2929 =item B<SocketPerms> I<Permissions>
2930
2931 Change the file permissions of the UNIX-socket after it has been created. The
2932 permissions must be given as a numeric, octal value as you would pass to
2933 L<chmod(1)>. Defaults to B<0770>.
2934
2935 =item B<MaxConns> I<Number>
2936
2937 Sets the maximum number of connections that can be handled in parallel. Since
2938 this many threads will be started immediately setting this to a very high
2939 value will waste valuable resources. Defaults to B<5> and will be forced to be
2940 at most B<16384> to prevent typos and dumb mistakes.
2941
2942 =back
2943
2944 =head2 Plugin C<ethstat>
2945
2946 The I<ethstat plugin> collects information about network interface cards (NICs)
2947 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2948
2949 B<Synopsis:>
2950
2951  <Plugin "ethstat">
2952    Interface "eth0"
2953    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2954    Map "multicast" "if_multicast"
2955  </Plugin>
2956
2957 B<Options:>
2958
2959 =over 4
2960
2961 =item B<Interface> I<Name>
2962
2963 Collect statistical information about interface I<Name>.
2964
2965 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2966
2967 By default, the plugin will submit values as type C<derive> and I<type
2968 instance> set to I<Name>, the name of the metric as reported by the driver. If
2969 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2970 I<TypeInstance> will be used.
2971
2972 =item B<MappedOnly> B<true>|B<false>
2973
2974 When set to B<true>, only metrics that can be mapped to a I<type> will be
2975 collected, all other metrics will be ignored. Defaults to B<false>.
2976
2977 =back
2978
2979 =head2 Plugin C<exec>
2980
2981 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2982 contains valuable information on when the executable is executed and the
2983 output that is expected from it.
2984
2985 =over 4
2986
2987 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2988
2989 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2990
2991 Execute the executable I<Executable> as user I<User>. If the user name is
2992 followed by a colon and a group name, the effective group is set to that group.
2993 The real group and saved-set group will be set to the default group of that
2994 user. If no group is given the effective group ID will be the same as the real
2995 group ID.
2996
2997 Please note that in order to change the user and/or group the daemon needs
2998 superuser privileges. If the daemon is run as an unprivileged user you must
2999 specify the same user/group here. If the daemon is run with superuser
3000 privileges, you must supply a non-root user here.
3001
3002 The executable may be followed by optional arguments that are passed to the
3003 program. Please note that due to the configuration parsing numbers and boolean
3004 values may be changed. If you want to be absolutely sure that something is
3005 passed as-is please enclose it in quotes.
3006
3007 The B<Exec> and B<NotificationExec> statements change the semantics of the
3008 programs executed, i.E<nbsp>e. the data passed to them and the response
3009 expected from them. This is documented in great detail in L<collectd-exec(5)>.
3010
3011 =back
3012
3013 =head2 Plugin C<fhcount>
3014
3015 The C<fhcount> plugin provides statistics about used, unused and total number of
3016 file handles on Linux.
3017
3018 The I<fhcount plugin> provides the following configuration options:
3019
3020 =over 4
3021
3022 =item B<ValuesAbsolute> B<true>|B<false>
3023
3024 Enables or disables reporting of file handles usage in absolute numbers,
3025 e.g. file handles used. Defaults to B<true>.
3026
3027 =item B<ValuesPercentage> B<false>|B<true>
3028
3029 Enables or disables reporting of file handles usage in percentages, e.g.
3030 percent of file handles used. Defaults to B<false>.
3031
3032 =back
3033
3034 =head2 Plugin C<filecount>
3035
3036 The C<filecount> plugin counts the number of files in a certain directory (and
3037 its subdirectories) and their combined size. The configuration is very straight
3038 forward:
3039
3040   <Plugin "filecount">
3041     <Directory "/var/qmail/queue/mess">
3042       Instance "qmail-message"
3043     </Directory>
3044     <Directory "/var/qmail/queue/todo">
3045       Instance "qmail-todo"
3046     </Directory>
3047     <Directory "/var/lib/php5">
3048       Instance "php5-sessions"
3049       Name "sess_*"
3050     </Directory>
3051   </Plugin>
3052
3053 The example above counts the number of files in QMail's queue directories and
3054 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
3055 QMail has not yet looked at, the "message" queue holds the messages that were
3056 classified into "local" and "remote".
3057
3058 As you can see, the configuration consists of one or more C<Directory> blocks,
3059 each of which specifies a directory in which to count the files. Within those
3060 blocks, the following options are recognized:
3061
3062 =over 4
3063
3064 =item B<Plugin> I<Plugin>
3065
3066 Use I<Plugin> as the plugin name when submitting values.
3067 Defaults to B<filecount>.
3068
3069 =item B<Instance> I<Instance>
3070
3071 Sets the plugin instance to I<Instance>. If not given, the instance is set to
3072 the directory name with all slashes replaced by underscores and all leading
3073 underscores removed. Empty value is allowed.
3074
3075 =item B<Name> I<Pattern>
3076
3077 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3078 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3079 against the pattern, not the entire path. In case this makes it easier for you:
3080 This option has been named after the B<-name> parameter to L<find(1)>.
3081
3082 =item B<MTime> I<Age>
3083
3084 Count only files of a specific age: If I<Age> is greater than zero, only files
3085 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3086 a negative number, this is inversed. For example, if B<-60> is specified, only
3087 files that have been modified in the last minute will be counted.
3088
3089 The number can also be followed by a "multiplier" to easily specify a larger
3090 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3091 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3092 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3093 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3094 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3095 B<"12h">.
3096
3097 =item B<Size> I<Size>
3098
3099 Count only files of a specific size. When I<Size> is a positive number, only
3100 files that are at least this big are counted. If I<Size> is a negative number,
3101 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3102 I<Size> are counted.
3103
3104 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3105 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3106 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3107 note that there are 1000 bytes in a kilobyte, not 1024.
3108
3109 =item B<Recursive> I<true>|I<false>
3110
3111 Controls whether or not to recurse into subdirectories. Enabled by default.
3112
3113 =item B<IncludeHidden> I<true>|I<false>
3114
3115 Controls whether or not to include "hidden" files and directories in the count.
3116 "Hidden" files and directories are those, whose name begins with a dot.
3117 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3118
3119 =item B<RegularOnly> I<true>|I<false>
3120
3121 Controls whether or not to include only regular files in the count.
3122 Defaults to I<true>, i.e. by default non regular files are ignored.
3123
3124 =item B<FilesSizeType> I<Type>
3125
3126 Sets the type used to dispatch files combined size. Empty value ("") disables
3127 reporting. Defaults to B<bytes>.
3128
3129 =item B<FilesCountType> I<Type>
3130
3131 Sets the type used to dispatch number of files. Empty value ("") disables
3132 reporting. Defaults to B<files>.
3133
3134 =item B<TypeInstance> I<Instance>
3135
3136 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3137 (no plugin instance).
3138
3139 =back
3140
3141 =head2 Plugin C<GenericJMX>
3142
3143 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3144 L<collectd-java(5)>.
3145
3146 =head2 Plugin C<gmond>
3147
3148 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3149 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3150 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3151
3152 Synopsis:
3153
3154  <Plugin "gmond">
3155    MCReceiveFrom "239.2.11.71" "8649"
3156    <Metric "swap_total">
3157      Type "swap"
3158      TypeInstance "total"
3159      DataSource "value"
3160    </Metric>
3161    <Metric "swap_free">
3162      Type "swap"
3163      TypeInstance "free"
3164      DataSource "value"
3165    </Metric>
3166  </Plugin>
3167
3168 The following metrics are built-in:
3169
3170 =over 4
3171
3172 =item *
3173
3174 load_one, load_five, load_fifteen
3175
3176 =item *
3177
3178 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3179
3180 =item *
3181
3182 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3183
3184 =item *
3185
3186 bytes_in, bytes_out
3187
3188 =item *
3189
3190 pkts_in, pkts_out
3191
3192 =back
3193
3194 Available configuration options:
3195
3196 =over 4
3197
3198 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3199
3200 Sets sets the multicast group and UDP port to which to subscribe.
3201
3202 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3203
3204 =item E<lt>B<Metric> I<Name>E<gt>
3205
3206 These blocks add a new metric conversion to the internal table. I<Name>, the
3207 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3208
3209 =over 4
3210
3211 =item B<Type> I<Type>
3212
3213 Type to map this metric to. Required.
3214
3215 =item B<TypeInstance> I<Instance>
3216
3217 Type-instance to use. Optional.
3218
3219 =item B<DataSource> I<Name>
3220
3221 Data source to map this metric to. If the configured type has exactly one data
3222 source, this is optional. Otherwise the option is required.
3223
3224 =back
3225
3226 =back
3227
3228 =head2 Plugin C<gps>
3229
3230 The C<gps plugin> connects to gpsd on the host machine.
3231 The host, port, timeout and pause are configurable.
3232
3233 This is useful if you run an NTP server using a GPS for source and you want to
3234 monitor it.
3235
3236 Mind your GPS must send $--GSA for having the data reported!
3237
3238 The following elements are collected:
3239
3240 =over 4
3241
3242 =item B<satellites>
3243
3244 Number of satellites used for fix (type instance "used") and in view (type
3245 instance "visible"). 0 means no GPS satellites are visible.
3246
3247 =item B<dilution_of_precision>
3248
3249 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3250 It should be between 0 and 3.
3251 Look at the documentation of your GPS to know more.
3252
3253 =back
3254
3255 Synopsis:
3256
3257  LoadPlugin gps
3258  <Plugin "gps">
3259    # Connect to localhost on gpsd regular port:
3260    Host "127.0.0.1"
3261    Port "2947"
3262    # 15 ms timeout
3263    Timeout 0.015
3264    # PauseConnect of 5 sec. between connection attempts.
3265    PauseConnect 5
3266  </Plugin>
3267
3268 Available configuration options:
3269
3270 =over 4
3271
3272 =item B<Host> I<Host>
3273
3274 The host on which gpsd daemon runs. Defaults to B<localhost>.
3275
3276 =item B<Port> I<Port>
3277
3278 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3279
3280 =item B<Timeout> I<Seconds>
3281
3282 Timeout in seconds (default 0.015 sec).
3283
3284 The GPS data stream is fetch by the plugin form the daemon.
3285 It waits for data to be available, if none arrives it times out
3286 and loop for another reading.
3287 Mind to put a low value gpsd expects value in the micro-seconds area
3288 (recommended is 500 us) since the waiting function is blocking.
3289 Value must be between 500 us and 5 sec., if outside that range the
3290 default value is applied.
3291
3292 This only applies from gpsd release-2.95.
3293
3294 =item B<PauseConnect> I<Seconds>
3295
3296 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3297
3298 =back
3299
3300 =head2 Plugin C<gpu_nvidia>
3301
3302 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3303 NVML library. Currently collected are fan speed, core temperature, percent
3304 load, percent memory used, compute and memory frequencies, and power
3305 consumption.
3306
3307 =over 4
3308
3309 =item B<GPUIndex>
3310
3311 If one or more of these options is specified, only GPUs at that index (as
3312 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3313 If no instance of this option is specified, all GPUs are monitored.
3314
3315 =item B<IgnoreSelected>
3316
3317 If set to true, all detected GPUs B<except> the ones at indices specified by
3318 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3319 without any GPUIndex directives will result in B<no> statistics being
3320 collected.
3321
3322 =back
3323
3324 =head2 Plugin C<grpc>
3325
3326 The I<grpc> plugin provides an RPC interface to submit values to or query
3327 values from collectd based on the open source gRPC framework. It exposes an
3328 end-point for dispatching values to the daemon.
3329
3330 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3331
3332 =over 4
3333
3334 =item B<Server> I<Host> I<Port>
3335
3336 The B<Server> statement sets the address of a server to which to send metrics
3337 via the C<DispatchValues> function.
3338
3339 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3340
3341 Optionally, B<Server> may be specified as a configuration block which supports
3342 the following options:
3343
3344 =over 4
3345
3346 =item B<EnableSSL> B<false>|B<true>
3347
3348 Whether to require SSL for outgoing connections. Default: false.
3349
3350 =item B<SSLCACertificateFile> I<Filename>
3351
3352 =item B<SSLCertificateFile> I<Filename>
3353
3354 =item B<SSLCertificateKeyFile> I<Filename>
3355
3356 Filenames specifying SSL certificate and key material to be used with SSL
3357 connections.
3358
3359 =back
3360
3361 =item B<Listen> I<Host> I<Port>
3362
3363 The B<Listen> statement sets the network address to bind to. When multiple
3364 statements are specified, the daemon will bind to all of them. If none are
3365 specified, it defaults to B<0.0.0.0:50051>.
3366
3367 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3368
3369 Optionally, B<Listen> may be specified as a configuration block which
3370 supports the following options:
3371
3372 =over 4
3373
3374 =item B<EnableSSL> I<true>|I<false>
3375
3376 Whether to enable SSL for incoming connections. Default: false.
3377
3378 =item B<SSLCACertificateFile> I<Filename>
3379
3380 =item B<SSLCertificateFile> I<Filename>
3381
3382 =item B<SSLCertificateKeyFile> I<Filename>
3383
3384 Filenames specifying SSL certificate and key material to be used with SSL
3385 connections.
3386
3387 =item B<VerifyPeer> B<true>|B<false>
3388
3389 When enabled, a valid client certificate is required to connect to the server.
3390 When disabled, a client certifiacte is not requested and any unsolicited client
3391 certificate is accepted.
3392 Enabled by default.
3393
3394 =back
3395
3396 =back
3397
3398 =head2 Plugin C<hddtemp>
3399
3400 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3401 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3402 default values, see below. C<hddtemp> has to be running to work correctly. If
3403 C<hddtemp> is not running timeouts may appear which may interfere with other
3404 statistics..
3405
3406 The B<hddtemp> homepage can be found at
3407 L<http://www.guzu.net/linux/hddtemp.php>.
3408
3409 =over 4
3410
3411 =item B<Host> I<Hostname>
3412
3413 Hostname to connect to. Defaults to B<127.0.0.1>.
3414
3415 =item B<Port> I<Port>
3416
3417 TCP-Port to connect to. Defaults to B<7634>.
3418
3419 =back
3420
3421 =head2 Plugin C<hugepages>
3422
3423 To collect B<hugepages> information, collectd reads directories
3424 "/sys/devices/system/node/*/hugepages" and
3425 "/sys/kernel/mm/hugepages".
3426 Reading of these directories can be disabled by the following
3427 options (default is enabled).
3428
3429 =over 4
3430
3431 =item B<ReportPerNodeHP> B<true>|B<false>
3432
3433 If enabled, information will be collected from the hugepage
3434 counters in "/sys/devices/system/node/*/hugepages".
3435 This is used to check the per-node hugepage statistics on
3436 a NUMA system.
3437
3438 =item B<ReportRootHP> B<true>|B<false>
3439
3440 If enabled, information will be collected from the hugepage
3441 counters in "/sys/kernel/mm/hugepages".
3442 This can be used on both NUMA and non-NUMA systems to check
3443 the overall hugepage statistics.
3444
3445 =item B<ValuesPages> B<true>|B<false>
3446
3447 Whether to report hugepages metrics in number of pages.
3448 Defaults to B<true>.
3449
3450 =item B<ValuesBytes> B<false>|B<true>
3451
3452 Whether to report hugepages metrics in bytes.
3453 Defaults to B<false>.
3454
3455 =item B<ValuesPercentage> B<false>|B<true>
3456
3457 Whether to report hugepages metrics as percentage.
3458 Defaults to B<false>.
3459
3460 =back
3461
3462 =head2 Plugin C<intel_pmu>
3463
3464 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3465 Linux perf interface. All events are reported on a per core basis.
3466
3467 B<Synopsis:>
3468
3469   <Plugin intel_pmu>
3470     ReportHardwareCacheEvents true
3471     ReportKernelPMUEvents true
3472     ReportSoftwareEvents true
3473     EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3474     HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3475     Cores "0-3" "4,6" "[12-15]"
3476   </Plugin>
3477
3478 B<Options:>
3479
3480 =over 4
3481
3482 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3483
3484 Enable or disable measuring of hardware CPU cache events:
3485   - L1-dcache-loads
3486   - L1-dcache-load-misses
3487   - L1-dcache-stores
3488   - L1-dcache-store-misses
3489   - L1-dcache-prefetches
3490   - L1-dcache-prefetch-misses
3491   - L1-icache-loads
3492   - L1-icache-load-misses
3493   - L1-icache-prefetches
3494   - L1-icache-prefetch-misses
3495   - LLC-loads
3496   - LLC-load-misses
3497   - LLC-stores
3498   - LLC-store-misses
3499   - LLC-prefetches
3500   - LLC-prefetch-misses
3501   - dTLB-loads
3502   - dTLB-load-misses
3503   - dTLB-stores
3504   - dTLB-store-misses
3505   - dTLB-prefetches
3506   - dTLB-prefetch-misses
3507   - iTLB-loads
3508   - iTLB-load-misses
3509   - branch-loads
3510   - branch-load-misses
3511
3512 =item B<ReportKernelPMUEvents> B<false>|B<true>
3513
3514 Enable or disable measuring of the following events:
3515   - cpu-cycles
3516   - instructions
3517   - cache-references
3518   - cache-misses
3519   - branches
3520   - branch-misses
3521   - bus-cycles
3522
3523 =item B<ReportSoftwareEvents> B<false>|B<true>
3524
3525 Enable or disable measuring of software events provided by kernel:
3526   - cpu-clock
3527   - task-clock
3528   - context-switches
3529   - cpu-migrations
3530   - page-faults
3531   - minor-faults
3532   - major-faults
3533   - alignment-faults
3534   - emulation-faults
3535
3536 =item B<EventList> I<filename>
3537
3538 JSON performance counter event list file name. To be able to monitor all Intel
3539 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3540 event_download.py script to download event list for current CPU.
3541
3542 =item B<HardwareEvents> I<events>
3543
3544 This field is a list of event names or groups of comma separated event names.
3545 This option requires B<EventList> option to be configured.
3546
3547 =item B<Cores> I<cores groups>
3548
3549 All events are reported on a per core basis. Monitoring of the events can be
3550 configured for a group of cores (aggregated statistics). This field defines
3551 groups of cores on which to monitor supported events. The field is represented
3552 as list of strings with core group values. Each string represents a list of
3553 cores in a group. If a group is enclosed in square brackets each core is added
3554 individually to a separate group (that is statistics are not aggregated).
3555 Allowed formats are:
3556     0,1,2,3
3557     0-10,20-18
3558     1,3,5-8,10,0x10-12
3559     [4-15,32-63]
3560
3561 If an empty string is provided as value for this field default cores
3562 configuration is applied - that is separate group is created for each core.
3563
3564 =back
3565
3566 =head2 Plugin C<intel_rdt>
3567
3568 The I<intel_rdt> plugin collects information provided by monitoring features of
3569 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3570 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3571 information about utilization of shared resources. CMT monitors last level cache
3572 occupancy (LLC). MBM supports two types of events reporting local and remote
3573 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3574 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3575 reports the bandwidth of accessing the remote socket. Also this technology
3576 allows to monitor instructions per clock (IPC).
3577 Monitor events are hardware dependant. Monitoring capabilities are detected on
3578 plugin initialization and only supported events are monitored.
3579
3580 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3581 require an additional capability to be enabled if collectd is run as a service.
3582 Please refer to I<contrib/systemd.collectd.service> file for more details.
3583
3584 B<Synopsis:>
3585
3586   <Plugin "intel_rdt">
3587     Cores "0-2" "3,4,6" "8-10,15"
3588     Processes "sshd,qemu-system-x86" "bash"
3589   </Plugin>
3590
3591 B<Options:>
3592
3593 =over 4
3594
3595 =item B<Interval> I<seconds>
3596
3597 The interval within which to retrieve statistics on monitored events in seconds.
3598 For milliseconds divide the time by 1000 for example if the desired interval
3599 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3600 recommended to set interval higher than 1 sec.
3601
3602 =item B<Cores> I<cores groups>
3603
3604 Monitoring of the events can be configured for group of cores
3605 (aggregated statistics). This field defines groups of cores on which to monitor
3606 supported events. The field is represented as list of strings with core group
3607 values. Each string represents a list of cores in a group. Allowed formats are:
3608     0,1,2,3
3609     0-10,20-18
3610     1,3,5-8,10,0x10-12
3611
3612 If an empty string is provided as value for this field default cores
3613 configuration is applied - a separate group is created for each core.
3614
3615 =item B<Processes> I<process names groups>
3616
3617 Monitoring of the events can be configured for group of processes
3618 (aggregated statistics). This field defines groups of processes on which to
3619 monitor supported events. The field is represented as list of strings with
3620 process names group values. Each string represents a list of processes in a
3621 group. Allowed format is:
3622     sshd,bash,qemu
3623
3624 =back
3625
3626 B<Note:> By default global interval is used to retrieve statistics on monitored
3627 events. To configure a plugin specific interval use B<Interval> option of the
3628 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3629 example if the desired interval is 50ms, set interval to 0.05.
3630 Due to limited capacity of counters it is not recommended to set interval higher
3631 than 1 sec.
3632
3633 =head2 Plugin C<interface>
3634
3635 =over 4
3636
3637 =item B<Interface> I<Interface>
3638
3639 Select this interface. By default these interfaces will then be collected. For
3640 a more detailed description see B<IgnoreSelected> below.
3641
3642 See F</"IGNORELISTS"> for details.
3643
3644 =item B<IgnoreSelected> I<true>|I<false>
3645
3646 If no configuration is given, the B<interface>-plugin will collect data from
3647 all interfaces. This may not be practical, especially for loopback- and
3648 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3649 interfaces you're interested in. Sometimes, however, it's easier/preferred
3650 to collect all interfaces I<except> a few ones. This option enables you to
3651 do that: By setting B<IgnoreSelected> to I<true> the effect of
3652 B<Interface> is inverted: All selected interfaces are ignored and all
3653 other interfaces are collected.
3654
3655 It is possible to use regular expressions to match interface names, if the
3656 name is surrounded by I</.../> and collectd was compiled with support for
3657 regexps. This is useful if there's a need to collect (or ignore) data
3658 for a group of interfaces that are similarly named, without the need to
3659 explicitly list all of them (especially useful if the list is dynamic).
3660 Example:
3661
3662  Interface "lo"
3663  Interface "/^veth/"
3664  Interface "/^tun[0-9]+/"
3665  IgnoreSelected "true"
3666
3667 This will ignore the loopback interface, all interfaces with names starting
3668 with I<veth> and all interfaces with names starting with I<tun> followed by
3669 at least one digit.
3670
3671 =item B<ReportInactive> I<true>|I<false>
3672
3673 When set to I<false>, only interfaces with non-zero traffic will be
3674 reported. Note that the check is done by looking into whether a
3675 package was sent at any time from boot and the corresponding counter
3676 is non-zero. So, if the interface has been sending data in the past
3677 since boot, but not during the reported time-interval, it will still
3678 be reported.
3679
3680 The default value is I<true> and results in collection of the data
3681 from all interfaces that are selected by B<Interface> and
3682 B<IgnoreSelected> options.
3683
3684 =item B<UniqueName> I<true>|I<false>
3685
3686 Interface name is not unique on Solaris (KSTAT), interface name is unique
3687 only within a module/instance. Following tuple is considered unique:
3688    (ks_module, ks_instance, ks_name)
3689 If this option is set to true, interface name contains above three fields
3690 separated by an underscore. For more info on KSTAT, visit
3691 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3692
3693 This option is only available on Solaris.
3694
3695 =back
3696
3697 =head2 Plugin C<ipmi>
3698
3699 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3700 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3701
3702 The plugin configuration consists of one or more B<Instance> blocks which
3703 specify one I<ipmi> connection each. Each block requires one unique string
3704 argument as the instance name. If instances are not configured, an instance with
3705 the default option values will be created.
3706
3707 For backwards compatibility, any option other than B<Instance> block will trigger
3708 legacy config handling and it will be treated as an option within B<Instance>
3709 block. This support will go away in the next major version of Collectd.
3710
3711 Within the B<Instance> blocks, the following options are allowed:
3712
3713 =over 4
3714
3715 =item B<Address> I<Address>
3716
3717 Hostname or IP to connect to. If not specified, plugin will try to connect to
3718 local management controller (BMC).
3719
3720 =item B<Username> I<Username>
3721
3722 =item B<Password> I<Password>
3723
3724 The username and the password to use for the connection to remote BMC.
3725
3726 =item B<AuthType> I<MD5>|I<rmcp+>
3727
3728 Forces the authentication type to use for the connection to remote BMC.
3729 By default most secure type is seleted.
3730
3731 =item B<Host> I<Hostname>
3732
3733 Sets the B<host> field of dispatched values. Defaults to the global hostname
3734 setting.
3735
3736 =item B<Sensor> I<Sensor>
3737
3738 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3739
3740 See F</"IGNORELISTS"> for details.
3741
3742 =item B<IgnoreSelected> I<true>|I<false>
3743
3744 If no configuration if given, the B<ipmi> plugin will collect data from all
3745 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3746 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3747 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3748 all other sensors are collected.
3749
3750 =item B<NotifySensorAdd> I<true>|I<false>
3751
3752 If a sensor appears after initialization time of a minute a notification
3753 is sent.
3754
3755 =item B<NotifySensorRemove> I<true>|I<false>
3756
3757 If a sensor disappears a notification is sent.
3758
3759 =item B<NotifySensorNotPresent> I<true>|I<false>
3760
3761 If you have for example dual power supply and one of them is (un)plugged then
3762 a notification is sent.
3763
3764 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3765
3766 If a IPMI connection state changes after initialization time of a minute
3767 a notification is sent. Defaults to B<false>.
3768
3769 =item B<SELEnabled> I<true>|I<false>
3770
3771 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3772 and discrete events. When event is received the notification is sent.
3773 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3774 config options.
3775 Defaults to B<false>.
3776
3777 =item B<SELSensor> I<SELSensor>
3778
3779 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3780
3781 See F</"IGNORELISTS"> for details.
3782
3783 =item B<SELIgnoreSelected> I<true>|I<false>
3784
3785 If no configuration is given, the B<ipmi> plugin will pass events from all
3786 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3787 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3788 sensors are ignored and all events from other sensors are passed.
3789
3790 =item B<SELClearEvent> I<true>|I<false>
3791
3792 If SEL clear event is enabled, plugin will delete event from SEL list after
3793 it is received and successfully handled. In this case other tools that are
3794 subscribed for SEL events will receive an empty event.
3795 Defaults to B<false>.
3796
3797 =back
3798
3799 =head2 Plugin C<iptables>
3800
3801 =over 4
3802
3803 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3804
3805 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3806
3807 Select the iptables/ip6tables filter rules to count packets and bytes from.
3808
3809 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3810 of all rules which have a comment-match. The comment is then used as
3811 type-instance.
3812
3813 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3814 the I<n>th rule will be collected. Again, the comment (or the number) will be
3815 used as the type-instance.
3816
3817 If I<Name> is supplied, it will be used as the type-instance instead of the
3818 comment or the number.
3819
3820 =back
3821
3822 =head2 Plugin C<irq>
3823
3824 =over 4
3825
3826 =item B<Irq> I<Irq>
3827
3828 Select this irq. By default these irqs will then be collected. For a more
3829 detailed description see B<IgnoreSelected> below.
3830
3831 See F</"IGNORELISTS"> for details.
3832
3833 =item B<IgnoreSelected> I<true>|I<false>
3834
3835 If no configuration if given, the B<irq>-plugin will collect data from all
3836 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3837 can use the B<Irq>-option to pick the interrupt you're interested in.
3838 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3839 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3840 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3841 and all other interrupts are collected.
3842
3843 =back
3844
3845 =head2 Plugin C<java>
3846
3847 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3848 This section only discusses the syntax and semantic of the configuration
3849 options. For more in-depth information on the I<Java> plugin, please read
3850 L<collectd-java(5)>.
3851
3852 Synopsis:
3853
3854  <Plugin "java">
3855    JVMArg "-verbose:jni"
3856    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3857    LoadPlugin "org.collectd.java.Foobar"
3858    <Plugin "org.collectd.java.Foobar">
3859      # To be parsed by the plugin
3860    </Plugin>
3861  </Plugin>
3862
3863 Available configuration options:
3864
3865 =over 4
3866
3867 =item B<JVMArg> I<Argument>
3868
3869 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3870 exactly the way the arguments to the I<java> binary on the command line work.
3871 Execute C<javaE<nbsp>--help> for details.
3872
3873 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3874 any other options! When another option is found, the JVM will be started and
3875 later options will have to be ignored!
3876
3877 =item B<LoadPlugin> I<JavaClass>
3878
3879 Instantiates a new I<JavaClass> object. The constructor of this object very
3880 likely then registers one or more callback methods with the server.
3881
3882 See L<collectd-java(5)> for details.
3883
3884 When the first such option is found, the virtual machine (JVM) is created. This
3885 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3886 B<LoadPlugin> options!
3887
3888 =item B<Plugin> I<Name>
3889
3890 The entire block is passed to the Java plugin as an
3891 I<org.collectd.api.OConfigItem> object.
3892
3893 For this to work, the plugin has to register a configuration callback first,
3894 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3895 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3896 depends on the (Java) plugin registering the callback and is completely
3897 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3898
3899 =back
3900
3901 =head2 Plugin C<load>
3902
3903 The I<Load plugin> collects the system load. These numbers give a rough overview
3904 over the utilization of a machine. The system load is defined as the number of
3905 runnable tasks in the run-queue and is provided by many operating systems as a
3906 one, five or fifteen minute average.
3907
3908 The following configuration options are available:
3909
3910 =over 4
3911
3912 =item B<ReportRelative> B<false>|B<true>
3913
3914 When enabled, system load divided by number of available CPU cores is reported
3915 for intervals 1 min, 5 min and 15 min. Defaults to false.
3916
3917 =back
3918
3919
3920 =head2 Plugin C<logfile>
3921
3922 =over 4
3923
3924 =item B<LogLevel> B<debug|info|notice|warning|err>
3925
3926 Sets the log-level. If, for example, set to B<notice>, then all events with
3927 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3928
3929 Please note that B<debug> is only available if collectd has been compiled with
3930 debugging support.
3931
3932 =item B<File> I<File>
3933
3934 Sets the file to write log messages to. The special strings B<stdout> and
3935 B<stderr> can be used to write to the standard output and standard error
3936 channels, respectively. This, of course, only makes much sense when I<collectd>
3937 is running in foreground- or non-daemon-mode.
3938
3939 =item B<Timestamp> B<true>|B<false>
3940
3941 Prefix all lines printed by the current time. Defaults to B<true>.
3942
3943 =item B<PrintSeverity> B<true>|B<false>
3944
3945 When enabled, all lines are prefixed by the severity of the log message, for
3946 example "warning". Defaults to B<false>.
3947
3948 =back
3949
3950 B<Note>: There is no need to notify the daemon after moving or removing the
3951 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3952 for each line it writes.
3953
3954 =head2 Plugin C<log_logstash>
3955
3956 The I<log logstash plugin> behaves like the logfile plugin but formats
3957 messages as JSON events for logstash to parse and input.
3958
3959 =over 4
3960
3961 =item B<LogLevel> B<debug|info|notice|warning|err>
3962
3963 Sets the log-level. If, for example, set to B<notice>, then all events with
3964 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3965
3966 Please note that B<debug> is only available if collectd has been compiled with
3967 debugging support.
3968
3969 =item B<File> I<File>
3970
3971 Sets the file to write log messages to. The special strings B<stdout> and
3972 B<stderr> can be used to write to the standard output and standard error
3973 channels, respectively. This, of course, only makes much sense when I<collectd>
3974 is running in foreground- or non-daemon-mode.
3975
3976 =back
3977
3978 B<Note>: There is no need to notify the daemon after moving or removing the
3979 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3980 for each line it writes.
3981
3982 =head2 Plugin C<lpar>
3983
3984 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3985 virtualization technique for IBM POWER processors. It takes into account CPU
3986 time stolen from or donated to a partition, in addition to the usual user,
3987 system, I/O statistics.
3988
3989 The following configuration options are available:
3990
3991 =over 4
3992
3993 =item B<CpuPoolStats> B<false>|B<true>
3994
3995 When enabled, statistics about the processor pool are read, too. The partition
3996 needs to have pool authority in order to be able to acquire this information.
3997 Defaults to false.
3998
3999 =item B<ReportBySerial> B<false>|B<true>
4000
4001 If enabled, the serial of the physical machine the partition is currently
4002 running on is reported as I<hostname> and the logical hostname of the machine
4003 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
4004 used (just like other plugins) and the I<plugin instance> will be empty.
4005 Defaults to false.
4006
4007 =back
4008
4009 =head2 Plugin C<lua>
4010
4011 This plugin embeds a Lua interpreter into collectd and provides an interface
4012 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
4013
4014
4015 =head2 Plugin C<mbmon>
4016
4017 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
4018
4019 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
4020 B<Host> and B<Port> options can be used to change these values, see below.
4021 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
4022 timeouts may appear which may interfere with other statistics..
4023
4024 C<mbmon> must be run with the -r option ("print TAG and Value format");
4025 Debian's F</etc/init.d/mbmon> script already does this, other people
4026 will need to ensure that this is the case.
4027
4028 =over 4
4029
4030 =item B<Host> I<Hostname>
4031
4032 Hostname to connect to. Defaults to B<127.0.0.1>.
4033
4034 =item B<Port> I<Port>
4035
4036 TCP-Port to connect to. Defaults to B<411>.
4037
4038 =back
4039
4040 =head2 Plugin C<mcelog>
4041
4042 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
4043
4044 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
4045 mcelog server is running. When the server is running, the plugin will tail the
4046 specified logfile to retrieve machine check exception information and send a
4047 notification with the details from the logfile. The plugin will use the mcelog
4048 client protocol to retrieve memory related machine check exceptions. Note that
4049 for memory exceptions, notifications are only sent when there is a change in
4050 the number of corrected/uncorrected memory errors.
4051
4052 =head3 The Memory block
4053
4054 Note: these options cannot be used in conjunction with the logfile options, they are mutually
4055 exclusive.
4056
4057 =over 3
4058
4059 =item B<McelogClientSocket> I<Path>
4060 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
4061 Defaults to B<"/var/run/mcelog-client">.
4062
4063 =item B<PersistentNotification> B<true>|B<false>
4064 Override default configuration to only send notifications when sent when there
4065 is a change in the number of corrected/uncorrected memory errors. When set to
4066 true notifications will be sent for every read cycle. Default is false. Does
4067 not affect the stats being dispatched.
4068
4069 =back
4070
4071 =over 4
4072
4073 =item B<McelogLogfile> I<Path>
4074
4075 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
4076 cannot be used in conjunction with the memory block options, they are mutually
4077 exclusive.
4078
4079 =back
4080
4081 =head2 Plugin C<md>
4082
4083 The C<md plugin> collects information from Linux Software-RAID devices (md).
4084
4085 All reported values are of the type C<md_disks>. Reported type instances are
4086 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
4087 I<missing> (physically absent) disks.
4088
4089 =over 4
4090
4091 =item B<Device> I<Device>
4092
4093 Select md devices based on device name. The I<device name> is the basename of
4094 the device, i.e. the name of the block device without the leading C</dev/>.
4095 See B<IgnoreSelected> for more details.
4096
4097 See F</"IGNORELISTS"> for details.
4098
4099 =item B<IgnoreSelected> B<true>|B<false>
4100
4101 Invert device selection: If set to B<true>, all md devices B<except> those
4102 listed using B<Device> are collected. If B<false> (the default), only those
4103 listed are collected. If no configuration is given, the B<md> plugin will
4104 collect data from all md devices.
4105
4106 =back
4107
4108 =head2 Plugin C<memcachec>
4109
4110 The C<memcachec plugin> connects to a memcached server, queries one or more
4111 given I<pages> and parses the returned data according to user specification.
4112 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4113 plugins.
4114
4115 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4116 library. Please note that there is another library with a very similar name,
4117 libmemcache (notice the missing `d'), which is not applicable.
4118
4119 Synopsis of the configuration:
4120
4121  <Plugin "memcachec">
4122    <Page "plugin_instance">
4123      Server "localhost"
4124      Key "page_key"
4125      Plugin "plugin_name"
4126      <Match>
4127        Regex "(\\d+) bytes sent"
4128        DSType CounterAdd
4129        Type "ipt_octets"
4130        Instance "type_instance"
4131      </Match>
4132    </Page>
4133  </Plugin>
4134
4135 The configuration options are:
4136
4137 =over 4
4138
4139 =item E<lt>B<Page> I<Name>E<gt>
4140
4141 Each B<Page> block defines one I<page> to be queried from the memcached server.
4142 The block requires one string argument which is used as I<plugin instance>.
4143
4144 =item B<Server> I<Address>
4145
4146 Sets the server address to connect to when querying the page. Must be inside a
4147 B<Page> block.
4148
4149 =item B<Key> I<Key>
4150
4151 When connected to the memcached server, asks for the page I<Key>.
4152
4153 =item B<Plugin> I<Plugin>
4154
4155 Use I<Plugin> as the plugin name when submitting values.
4156 Defaults to C<memcachec>.
4157
4158 =item E<lt>B<Match>E<gt>
4159
4160 Match blocks define which strings to look for and how matches substrings are
4161 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4162
4163 =back
4164
4165 =head2 Plugin C<memcached>
4166
4167 The B<memcached plugin> connects to a memcached server and queries statistics
4168 about cache utilization, memory and bandwidth used.
4169 L<http://memcached.org/>
4170
4171  <Plugin "memcached">
4172    <Instance "name">
4173      #Host "memcache.example.com"
4174      Address "127.0.0.1"
4175      Port 11211
4176    </Instance>
4177  </Plugin>
4178
4179 The plugin configuration consists of one or more B<Instance> blocks which
4180 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4181 following options are allowed:
4182
4183 =over 4
4184
4185 =item B<Host> I<Hostname>
4186
4187 Sets the B<host> field of dispatched values. Defaults to the global hostname
4188 setting.
4189 For backwards compatibility, values are also dispatched with the global
4190 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4191 not set.
4192
4193 =item B<Address> I<Address>
4194
4195 Hostname or IP to connect to. For backwards compatibility, defaults to the
4196 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4197
4198 =item B<Port> I<Port>
4199
4200 TCP port to connect to. Defaults to B<11211>.
4201
4202 =item B<Socket> I<Path>
4203
4204 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4205 setting is given, the B<Address> and B<Port> settings are ignored.
4206
4207 =back
4208
4209 =head2 Plugin C<mic>
4210
4211 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4212 Intel's Many Integrated Core (MIC) systems.
4213
4214 B<Synopsis:>
4215
4216  <Plugin mic>
4217    ShowCPU true
4218    ShowCPUCores true
4219    ShowMemory true
4220
4221    ShowTemperatures true
4222    Temperature vddg
4223    Temperature vddq
4224    IgnoreSelectedTemperature true
4225
4226    ShowPower true
4227    Power total0
4228    Power total1
4229    IgnoreSelectedPower true
4230  </Plugin>
4231
4232 The following options are valid inside the B<PluginE<nbsp>mic> block:
4233
4234 =over 4
4235
4236 =item B<ShowCPU> B<true>|B<false>
4237
4238 If enabled (the default) a sum of the CPU usage across all cores is reported.
4239
4240 =item B<ShowCPUCores> B<true>|B<false>
4241
4242 If enabled (the default) per-core CPU usage is reported.
4243
4244 =item B<ShowMemory> B<true>|B<false>
4245
4246 If enabled (the default) the physical memory usage of the MIC system is
4247 reported.
4248
4249 =item B<ShowTemperatures> B<true>|B<false>
4250
4251 If enabled (the default) various temperatures of the MIC system are reported.
4252
4253 =item B<Temperature> I<Name>
4254
4255 This option controls which temperatures are being reported. Whether matching
4256 temperatures are being ignored or I<only> matching temperatures are reported
4257 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4258 temperatures are reported.
4259
4260 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4261
4262 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4263 (the default) only temperatures matching a B<Temperature> option are reported
4264 or, if no B<Temperature> option is specified, all temperatures are reported. If
4265 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4266 are reported.
4267
4268 Known temperature names are:
4269
4270 =over 4
4271
4272 =item die
4273
4274 Die of the CPU
4275
4276 =item devmem
4277
4278 Device Memory
4279
4280 =item fin
4281
4282 Fan In
4283
4284 =item fout
4285
4286 Fan Out
4287
4288 =item vccp
4289
4290 Voltage ccp
4291
4292 =item vddg
4293
4294 Voltage ddg
4295
4296 =item vddq
4297
4298 Voltage ddq
4299
4300 =back
4301
4302 =item B<ShowPower> B<true>|B<false>
4303
4304 If enabled (the default) various temperatures of the MIC system are reported.
4305
4306 =item B<Power> I<Name>
4307
4308 This option controls which power readings are being reported. Whether matching
4309 power readings are being ignored or I<only> matching power readings are reported
4310 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4311 power readings are reported.
4312
4313 =item B<IgnoreSelectedPower> B<false>|B<true>
4314
4315 Controls the behavior of the B<Power> setting above. If set to B<false>
4316 (the default) only power readings matching a B<Power> option are reported
4317 or, if no B<Power> option is specified, all power readings are reported. If
4318 set to B<true>, matching power readings are I<ignored> and all other power readings
4319 are reported.
4320
4321 Known power names are:
4322
4323 =over 4
4324
4325 =item total0
4326
4327 Total power utilization averaged over Time Window 0 (uWatts).
4328
4329 =item total1
4330
4331 Total power utilization averaged over Time Window 0 (uWatts).
4332
4333 =item inst
4334
4335 Instantaneous power (uWatts).
4336
4337 =item imax
4338
4339 Max instantaneous power (uWatts).
4340
4341 =item pcie
4342
4343 PCI-E connector power (uWatts).
4344
4345 =item c2x3
4346
4347 2x3 connector power (uWatts).
4348
4349 =item c2x4
4350
4351 2x4 connector power (uWatts).
4352
4353 =item vccp
4354
4355 Core rail (uVolts).
4356
4357 =item vddg
4358
4359 Uncore rail (uVolts).
4360
4361 =item vddq
4362
4363 Memory subsystem rail (uVolts).
4364
4365 =back
4366
4367 =back
4368
4369 =head2 Plugin C<memory>
4370
4371 The I<memory plugin> provides the following configuration options:
4372
4373 =over 4
4374
4375 =item B<ValuesAbsolute> B<true>|B<false>
4376
4377 Enables or disables reporting of physical memory usage in absolute numbers,
4378 i.e. bytes. Defaults to B<true>.
4379
4380 =item B<ValuesPercentage> B<false>|B<true>
4381
4382 Enables or disables reporting of physical memory usage in percentages, e.g.
4383 percent of physical memory used. Defaults to B<false>.
4384
4385 This is useful for deploying I<collectd> in a heterogeneous environment in
4386 which the sizes of physical memory vary.
4387
4388 =back
4389
4390 =head2 Plugin C<modbus>
4391
4392 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4393 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4394 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4395 floating point values (two registers interpreted as IEEE floats in big endian
4396 notation).
4397
4398 B<Synopsis:>
4399
4400  <Data "voltage-input-1">
4401    RegisterBase 0
4402    RegisterType float
4403    RegisterCmd ReadHolding
4404    Type voltage
4405    Instance "input-1"
4406    #Scale 1.0
4407    #Shift 0.0
4408  </Data>
4409
4410  <Data "voltage-input-2">
4411    RegisterBase 2
4412    RegisterType float
4413    RegisterCmd ReadHolding
4414    Type voltage
4415    Instance "input-2"
4416  </Data>
4417
4418  <Data "supply-temperature-1">
4419    RegisterBase 0
4420    RegisterType Int16
4421    RegisterCmd ReadHolding
4422    Type temperature
4423    Instance "temp-1"
4424  </Data>
4425
4426  <Host "modbus.example.com">
4427    Address "192.168.0.42"
4428    Port    "502"
4429    Interval 60
4430
4431    <Slave 1>
4432      Instance "power-supply"
4433      Collect  "voltage-input-1"
4434      Collect  "voltage-input-2"
4435    </Slave>
4436  </Host>
4437
4438  <Host "localhost">
4439    Device "/dev/ttyUSB0"
4440    Baudrate 38400
4441    Interval 20
4442
4443    <Slave 1>
4444      Instance "temperature"
4445      Collect  "supply-temperature-1"
4446    </Slave>
4447  </Host>
4448
4449 =over 4
4450
4451 =item E<lt>B<Data> I<Name>E<gt> blocks
4452
4453 Data blocks define a mapping between register numbers and the "types" used by
4454 I<collectd>.
4455
4456 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4457
4458 =over 4
4459
4460 =item B<RegisterBase> I<Number>
4461
4462 Configures the base register to read from the device. If the option
4463 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4464 register will be read (the register number is increased by one).
4465
4466 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4467
4468 Specifies what kind of data is returned by the device. This defaults to
4469 B<Uint16>.  If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4470 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4471 and B<RegisterBase+1> will be read and the data is combined into one
4472 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4473 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4474 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4475 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4476 registers are swapped with the most significant 16E<nbsp>bits in
4477 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4478 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4479 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4480 B<RegisterBase+3> will be read and the data combined into one
4481 64E<nbsp>value.
4482
4483 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4484
4485 Specifies register type to be collected from device. Works only with libmodbus
4486 2.9.2 or higher. Defaults to B<ReadHolding>.
4487
4488 =item B<Type> I<Type>
4489
4490 Specifies the "type" (data set) to use when dispatching the value to
4491 I<collectd>. Currently, only data sets with exactly one data source are
4492 supported.
4493
4494 =item B<Instance> I<Instance>
4495
4496 Sets the type instance to use when dispatching the value to I<Instance>. If
4497 unset, an empty string (no type instance) is used.
4498
4499 =item B<Scale> I<Value>
4500
4501 The values taken from device are multiplied by I<Value>. The field is optional
4502 and the default is B<1.0>.
4503
4504 =item B<Shift> I<Value>
4505
4506 I<Value> is added to values from device after they have been multiplied by
4507 B<Scale> value. The field is optional and the default value is B<0.0>.
4508
4509 =back
4510
4511 =item E<lt>B<Host> I<Name>E<gt> blocks
4512
4513 Host blocks are used to specify to which hosts to connect and what data to read
4514 from their "slaves". The string argument I<Name> is used as hostname when
4515 dispatching the values to I<collectd>.
4516
4517 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4518
4519 =over 4
4520
4521 =item B<Address> I<Hostname>
4522
4523 For Modbus/TCP, specifies the node name (the actual network address) used to
4524 connect to the host. This may be an IP address or a hostname. Please note that
4525 the used I<libmodbus> library only supports IPv4 at the moment.
4526
4527 =item B<Port> I<Service>
4528
4529 for Modbus/TCP, specifies the port used to connect to the host. The port can
4530 either be given as a number or as a service name. Please note that the
4531 I<Service> argument must be a string, even if ports are given in their numerical
4532 form. Defaults to "502".
4533
4534 =item B<Device> I<Devicenode>
4535
4536 For Modbus/RTU, specifies the path to the serial device being used.
4537
4538 =item B<Baudrate> I<Baudrate>
4539
4540 For Modbus/RTU, specifies the baud rate of the serial device.
4541 Note, connections currently support only 8/N/1.
4542
4543 =item B<UARTType> I<UARTType>
4544
4545 For Modbus/RTU, specifies the type of the serial device.
4546 RS232, RS422 and RS485 are supported. Defaults to RS232.
4547 Available only on Linux systems with libmodbus>=2.9.4.
4548
4549 =item B<Interval> I<Interval>
4550
4551 Sets the interval (in seconds) in which the values will be collected from this
4552 host. By default the global B<Interval> setting will be used.
4553
4554 =item E<lt>B<Slave> I<ID>E<gt>
4555
4556 Over each connection, multiple Modbus devices may be reached. The slave ID
4557 is used to specify which device should be addressed. For each device you want
4558 to query, one B<Slave> block must be given.
4559
4560 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4561
4562 =over 4
4563
4564 =item B<Instance> I<Instance>
4565
4566 Specify the plugin instance to use when dispatching the values to I<collectd>.
4567 By default "slave_I<ID>" is used.
4568
4569 =item B<Collect> I<DataName>
4570
4571 Specifies which data to retrieve from the device. I<DataName> must be the same
4572 string as the I<Name> argument passed to a B<Data> block. You can specify this
4573 option multiple times to collect more than one value from a slave. At least one
4574 B<Collect> option is mandatory.
4575
4576 =back
4577
4578 =back
4579
4580 =back
4581
4582 =head2 Plugin C<mqtt>
4583
4584 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4585 values from MQTT (B<Subscribe> blocks).
4586
4587 B<Synopsis:>
4588
4589  <Plugin mqtt>
4590    <Publish "name">
4591      Host "mqtt.example.com"
4592      Prefix "collectd"
4593    </Publish>
4594    <Subscribe "name">
4595      Host "mqtt.example.com"
4596      Topic "collectd/#"
4597    </Subscribe>
4598  </Plugin>
4599
4600 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4601 configuring the sending and receiving direction respectively. The plugin will
4602 register a write callback named C<mqtt/I<name>> where I<name> is the string
4603 argument given to the B<Publish> block. Both types of blocks share many but not
4604 all of the following options. If an option is valid in only one of the blocks,
4605 it will be mentioned explicitly.
4606
4607 B<Options:>
4608
4609 =over 4
4610
4611 =item B<Host> I<Hostname>
4612
4613 Hostname of the MQTT broker to connect to.
4614
4615 =item B<Port> I<Service>
4616
4617 Port number or service name of the MQTT broker to connect to.
4618
4619 =item B<User> I<UserName>
4620
4621 Username used when authenticating to the MQTT broker.
4622
4623 =item B<Password> I<Password>
4624
4625 Password used when authenticating to the MQTT broker.
4626
4627 =item B<ClientId> I<ClientId>
4628
4629 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4630
4631 =item B<QoS> [B<0>-B<2>]
4632
4633 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4634
4635 =over 4
4636
4637 =item B<0>
4638
4639 At most once
4640
4641 =item B<1>
4642
4643 At least once
4644
4645 =item B<2>
4646
4647 Exactly once
4648
4649 =back
4650
4651 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4652 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4653 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4654 on a message is larger than the maximum accepted QoS of a subscriber, the
4655 message's QoS will be downgraded.
4656
4657 =item B<Prefix> I<Prefix> (Publish only)
4658
4659 This plugin will use one topic per I<value list> which will looks like a path.
4660 I<Prefix> is used as the first path element and defaults to B<collectd>.
4661
4662 An example topic name would be:
4663
4664  collectd/cpu-0/cpu-user
4665
4666 =item B<Retain> B<false>|B<true> (Publish only)
4667
4668 Controls whether the MQTT broker will retain (keep a copy of) the last message
4669 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4670
4671 =item B<StoreRates> B<true>|B<false> (Publish only)
4672
4673 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4674 before sending. Defaults to B<true>.
4675
4676 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4677
4678 Controls whether the MQTT "cleans" the session up after the subscriber
4679 disconnects or if it maintains the subscriber's subscriptions and all messages
4680 that arrive while the subscriber is disconnected. Defaults to B<true>.
4681
4682 =item B<Topic> I<TopicName> (Subscribe only)
4683
4684 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4685 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4686 the B<collectd> branch.
4687
4688 =item B<CACert> I<file>
4689
4690 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4691 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4692 port of the MQTT broker.
4693 This option enables the use of TLS.
4694
4695 =item B<CertificateFile> I<file>
4696
4697 Path to the PEM-encoded certificate file to use as client certificate when
4698 connecting to the MQTT broker.
4699 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4700
4701 =item B<CertificateKeyFile> I<file>
4702
4703 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4704 Only valid if B<CACert> and B<CertificateFile> are also set.
4705
4706 =item B<TLSProtocol> I<protocol>
4707
4708 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4709 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4710 version is used which depends on the version of OpenSSL the Mosquitto library
4711 was linked against.
4712 Only valid if B<CACert> is set.
4713
4714 =item B<CipherSuite> I<ciphersuite>
4715
4716 A string describing the ciphers available for use. See L<ciphers(1)> and the
4717 C<openssl ciphers> utility for more information. If unset, the default ciphers
4718 will be used.
4719 Only valid if B<CACert> is set.
4720
4721 =back
4722
4723 =head2 Plugin C<mysql>
4724
4725 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4726 one or more databases when started and keeps the connection up as long as
4727 possible. When the connection is interrupted for whatever reason it will try
4728 to re-connect. The plugin will complain loudly in case anything goes wrong.
4729
4730 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4731 and collects information about MySQL network traffic, executed statements,
4732 requests, the query cache and threads by evaluating the
4733 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4734 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4735 Status Variables> for an explanation of these values.
4736
4737 Optionally, master and slave statistics may be collected in a MySQL
4738 replication setup. In that case, information about the synchronization state
4739 of the nodes are collected by evaluating the C<Position> return value of the
4740 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4741 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4742 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4743 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4744 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4745
4746 Synopsis:
4747
4748   <Plugin mysql>
4749     <Database foo>
4750       Host "hostname"
4751       User "username"
4752       Password "password"
4753       Port "3306"
4754       MasterStats true
4755       ConnectTimeout 10
4756       SSLKey "/path/to/key.pem"
4757       SSLCert "/path/to/cert.pem"
4758       SSLCA "/path/to/ca.pem"
4759       SSLCAPath "/path/to/cas/"
4760       SSLCipher "DHE-RSA-AES256-SHA"
4761     </Database>
4762
4763     <Database bar>
4764       Alias "squeeze"
4765       Host "localhost"
4766       Socket "/var/run/mysql/mysqld.sock"
4767       SlaveStats true
4768       SlaveNotifications true
4769     </Database>
4770
4771    <Database galera>
4772       Alias "galera"
4773       Host "localhost"
4774       Socket "/var/run/mysql/mysqld.sock"
4775       WsrepStats true
4776    </Database>
4777   </Plugin>
4778
4779 A B<Database> block defines one connection to a MySQL database. It accepts a
4780 single argument which specifies the name of the database. None of the other
4781 options are required. MySQL will use default values as documented in the
4782 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4783 B<MySQL reference manual>.
4784
4785 =over 4
4786
4787 =item B<Alias> I<Alias>
4788
4789 Alias to use as sender instead of hostname when reporting. This may be useful
4790 when having cryptic hostnames.
4791
4792 =item B<Host> I<Hostname>
4793
4794 Hostname of the database server. Defaults to B<localhost>.
4795
4796 =item B<User> I<Username>
4797
4798 Username to use when connecting to the database. The user does not have to be
4799 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4800 unless you want to collectd replication statistics (see B<MasterStats> and
4801 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4802 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4803
4804 =item B<Password> I<Password>
4805
4806 Password needed to log into the database.
4807
4808 =item B<Database> I<Database>
4809
4810 Select this database. Defaults to I<no database> which is a perfectly reasonable
4811 option for what this plugin does.
4812
4813 =item B<Port> I<Port>
4814
4815 TCP-port to connect to. The port must be specified in its numeric form, but it
4816 must be passed as a string nonetheless. For example:
4817
4818   Port "3306"
4819
4820 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4821 See the documentation for the C<mysql_real_connect> function for details.
4822
4823 =item B<Socket> I<Socket>
4824
4825 Specifies the path to the UNIX domain socket of the MySQL server. This option
4826 only has any effect, if B<Host> is set to B<localhost> (the default).
4827 Otherwise, use the B<Port> option above. See the documentation for the
4828 C<mysql_real_connect> function for details.
4829
4830 =item B<InnodbStats> I<true|false>
4831
4832 If enabled, metrics about the InnoDB storage engine are collected.
4833 Disabled by default.
4834
4835 =item B<MasterStats> I<true|false>
4836
4837 =item B<SlaveStats> I<true|false>
4838
4839 Enable the collection of master / slave statistics in a replication setup. In
4840 order to be able to get access to these statistics, the user needs special
4841 privileges. See the B<User> documentation above. Defaults to B<false>.
4842
4843 =item B<SlaveNotifications> I<true|false>
4844
4845 If enabled, the plugin sends a notification if the replication slave I/O and /
4846 or SQL threads are not running. Defaults to B<false>.
4847
4848 =item B<WsrepStats> I<true|false>
4849
4850  Enable the collection of wsrep plugin statistics, used in Master-Master
4851  replication setups like in MySQL Galera/Percona XtraDB Cluster.
4852  User needs only privileges to execute 'SHOW GLOBAL STATUS'
4853
4854 =item B<ConnectTimeout> I<Seconds>
4855
4856 Sets the connect timeout for the MySQL client.
4857
4858 =item B<SSLKey> I<Path>
4859
4860 If provided, the X509 key in PEM format.
4861
4862 =item B<SSLCert> I<Path>
4863
4864 If provided, the X509 cert in PEM format.
4865
4866 =item B<SSLCA> I<Path>
4867
4868 If provided, the CA file in PEM format (check OpenSSL docs).
4869
4870 =item B<SSLCAPath> I<Path>
4871
4872 If provided, the CA directory (check OpenSSL docs).
4873
4874 =item B<SSLCipher> I<String>
4875
4876 If provided, the SSL cipher to use.
4877
4878 =back
4879
4880 =head2 Plugin C<netapp>
4881
4882 The netapp plugin can collect various performance and capacity information
4883 from a NetApp filer using the NetApp API.
4884
4885 Please note that NetApp has a wide line of products and a lot of different
4886 software versions for each of these products. This plugin was developed for a
4887 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4888 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4889 model and software version but it is very hard to test this.
4890 If you have used this plugin with other models and/or software version, feel
4891 free to send us a mail to tell us about the results, even if it's just a short
4892 "It works".
4893
4894 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4895 basic authentication.
4896
4897 B<Do not use a regular user for this!> Create a special collectd user with just
4898 the minimum of capabilities needed. The user only needs the "login-http-admin"
4899 capability as well as a few more depending on which data will be collected.
4900 Required capabilities are documented below.
4901
4902 =head3 Synopsis
4903
4904  <Plugin "netapp">
4905    <Host "netapp1.example.com">
4906     Protocol      "https"
4907     Address       "10.0.0.1"
4908     Port          443
4909     User          "username"
4910     Password      "aef4Aebe"
4911     Interval      30
4912
4913     <WAFL>
4914       Interval 30
4915       GetNameCache   true
4916       GetDirCache    true
4917       GetBufferCache true
4918       GetInodeCache  true
4919     </WAFL>
4920
4921     <Disks>
4922       Interval 30
4923       GetBusy true
4924     </Disks>
4925
4926     <VolumePerf>
4927       Interval 30
4928       GetIO      "volume0"
4929       IgnoreSelectedIO      false
4930       GetOps     "volume0"
4931       IgnoreSelectedOps     false
4932       GetLatency "volume0"
4933       IgnoreSelectedLatency false
4934     </VolumePerf>
4935
4936     <VolumeUsage>
4937       Interval 30
4938       GetCapacity "vol0"
4939       GetCapacity "vol1"
4940       IgnoreSelectedCapacity false
4941       GetSnapshot "vol1"
4942       GetSnapshot "vol3"
4943       IgnoreSelectedSnapshot false
4944     </VolumeUsage>
4945
4946     <Quota>
4947       Interval 60
4948     </Quota>
4949
4950     <Snapvault>
4951       Interval 30
4952     </Snapvault>
4953
4954     <System>
4955       Interval 30
4956       GetCPULoad     true
4957       GetInterfaces  true
4958       GetDiskOps     true
4959       GetDiskIO      true
4960     </System>
4961
4962     <VFiler vfilerA>
4963       Interval 60
4964
4965       SnapVault true
4966       # ...
4967     </VFiler>
4968    </Host>
4969  </Plugin>
4970
4971 The netapp plugin accepts the following configuration options:
4972
4973 =over 4
4974
4975 =item B<Host> I<Name>
4976
4977 A host block defines one NetApp filer. It will appear in collectd with the name
4978 you specify here which does not have to be its real name nor its hostname (see
4979 the B<Address> option below).
4980
4981 =item B<VFiler> I<Name>
4982
4983 A B<VFiler> block may only be used inside a host block. It accepts all the
4984 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4985 will execute all NetApp API commands in the context of the specified
4986 VFiler(R). It will appear in collectd with the name you specify here which
4987 does not have to be its real name. The VFiler name may be specified using the
4988 B<VFilerName> option. If this is not specified, it will default to the name
4989 you specify here.
4990
4991 The VFiler block inherits all connection related settings from the surrounding
4992 B<Host> block (which appear before the B<VFiler> block) but they may be
4993 overwritten inside the B<VFiler> block.
4994
4995 This feature is useful, for example, when using a VFiler as SnapVault target
4996 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4997 available in the host filer (vfiler0) but only in the respective VFiler
4998 context.
4999
5000 =item B<Protocol> B<httpd>|B<http>
5001
5002 The protocol collectd will use to query this host.
5003
5004 Optional
5005
5006 Type: string
5007
5008 Default: https
5009
5010 Valid options: http, https
5011
5012 =item B<Address> I<Address>
5013
5014 The hostname or IP address of the host.
5015
5016 Optional
5017
5018 Type: string
5019
5020 Default: The "host" block's name.
5021
5022 =item B<Port> I<Port>
5023
5024 The TCP port to connect to on the host.
5025
5026 Optional
5027
5028 Type: integer
5029
5030 Default: 80 for protocol "http", 443 for protocol "https"
5031
5032 =item B<User> I<User>
5033
5034 =item B<Password> I<Password>
5035
5036 The username and password to use to login to the NetApp.
5037
5038 Mandatory
5039
5040 Type: string
5041
5042 =item B<VFilerName> I<Name>
5043
5044 The name of the VFiler in which context to execute API commands. If not
5045 specified, the name provided to the B<VFiler> block will be used instead.
5046
5047 Optional
5048
5049 Type: string
5050
5051 Default: name of the B<VFiler> block
5052
5053 B<Note:> This option may only be used inside B<VFiler> blocks.
5054
5055 =item B<Interval> I<Interval>
5056
5057 B<TODO>
5058
5059 =back
5060
5061 The following options decide what kind of data will be collected. You can
5062 either use them as a block and fine tune various parameters inside this block,
5063 use them as a single statement to just accept all default values, or omit it to
5064 not collect any data.
5065
5066 The following options are valid inside all blocks:
5067
5068 =over 4
5069
5070 =item B<Interval> I<Seconds>
5071
5072 Collect the respective statistics every I<Seconds> seconds. Defaults to the
5073 host specific setting.
5074
5075 =back
5076
5077 =head3 The System block
5078
5079 This will collect various performance data about the whole system.
5080
5081 B<Note:> To get this data the collectd user needs the
5082 "api-perf-object-get-instances" capability.
5083
5084 =over 4
5085
5086 =item B<Interval> I<Seconds>
5087
5088 Collect disk statistics every I<Seconds> seconds.
5089
5090 =item B<GetCPULoad> B<true>|B<false>
5091
5092 If you set this option to true the current CPU usage will be read. This will be
5093 the average usage between all CPUs in your NetApp without any information about
5094 individual CPUs.
5095
5096 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5097 returns in the "CPU" field.
5098
5099 Optional
5100
5101 Type: boolean
5102
5103 Default: true
5104
5105 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5106
5107 =item B<GetInterfaces> B<true>|B<false>
5108
5109 If you set this option to true the current traffic of the network interfaces
5110 will be read. This will be the total traffic over all interfaces of your NetApp
5111 without any information about individual interfaces.
5112
5113 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5114 in the "Net kB/s" field.
5115
5116 B<Or is it?>
5117
5118 Optional
5119
5120 Type: boolean
5121
5122 Default: true
5123
5124 Result: One value list of type "if_octects".
5125
5126 =item B<GetDiskIO> B<true>|B<false>
5127
5128 If you set this option to true the current IO throughput will be read. This
5129 will be the total IO of your NetApp without any information about individual
5130 disks, volumes or aggregates.
5131
5132 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5133 in the "DiskE<nbsp>kB/s" field.
5134
5135 Optional
5136
5137 Type: boolean
5138
5139 Default: true
5140
5141 Result: One value list of type "disk_octets".
5142
5143 =item B<GetDiskOps> B<true>|B<false>
5144
5145 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5146 iSCSI, etc. operations will be read. This will be the total number of
5147 operations on your NetApp without any information about individual volumes or
5148 aggregates.
5149
5150 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5151 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5152
5153 Optional
5154
5155 Type: boolean
5156
5157 Default: true
5158
5159 Result: A variable number of value lists of type "disk_ops_complex". Each type
5160 of operation will result in one value list with the name of the operation as
5161 type instance.
5162
5163 =back
5164
5165 =head3 The WAFL block
5166
5167 This will collect various performance data about the WAFL file system. At the
5168 moment this just means cache performance.
5169
5170 B<Note:> To get this data the collectd user needs the
5171 "api-perf-object-get-instances" capability.
5172
5173 B<Note:> The interface to get these values is classified as "Diagnostics" by
5174 NetApp. This means that it is not guaranteed to be stable even between minor
5175 releases.
5176
5177 =over 4
5178
5179 =item B<Interval> I<Seconds>
5180
5181 Collect disk statistics every I<Seconds> seconds.
5182
5183 =item B<GetNameCache> B<true>|B<false>
5184
5185 Optional
5186
5187 Type: boolean
5188
5189 Default: true
5190
5191 Result: One value list of type "cache_ratio" and type instance
5192 "name_cache_hit".
5193
5194 =item B<GetDirCache> B<true>|B<false>
5195
5196 Optional
5197
5198 Type: boolean
5199
5200 Default: true
5201
5202 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5203
5204 =item B<GetInodeCache> B<true>|B<false>
5205
5206 Optional
5207
5208 Type: boolean
5209
5210 Default: true
5211
5212 Result: One value list of type "cache_ratio" and type instance
5213 "inode_cache_hit".
5214
5215 =item B<GetBufferCache> B<true>|B<false>
5216
5217 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5218 in the "Cache hit" field.
5219
5220 Optional
5221
5222 Type: boolean
5223
5224 Default: true
5225
5226 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5227
5228 =back
5229
5230 =head3 The Disks block
5231
5232 This will collect performance data about the individual disks in the NetApp.
5233
5234 B<Note:> To get this data the collectd user needs the
5235 "api-perf-object-get-instances" capability.
5236
5237 =over 4
5238
5239 =item B<Interval> I<Seconds>
5240
5241 Collect disk statistics every I<Seconds> seconds.
5242
5243 =item B<GetBusy> B<true>|B<false>
5244
5245 If you set this option to true the busy time of all disks will be calculated
5246 and the value of the busiest disk in the system will be written.
5247
5248 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5249 in the "Disk util" field. Probably.
5250
5251 Optional
5252
5253 Type: boolean
5254
5255 Default: true
5256
5257 Result: One value list of type "percent" and type instance "disk_busy".
5258
5259 =back
5260
5261 =head3 The VolumePerf block
5262
5263 This will collect various performance data about the individual volumes.
5264
5265 You can select which data to collect about which volume using the following
5266 options. They follow the standard ignorelist semantic.
5267
5268 B<Note:> To get this data the collectd user needs the
5269 I<api-perf-object-get-instances> capability.
5270
5271 =over 4
5272
5273 =item B<Interval> I<Seconds>
5274
5275 Collect volume performance data every I<Seconds> seconds.
5276
5277 =item B<GetIO> I<Volume>
5278
5279 =item B<GetOps> I<Volume>
5280
5281 =item B<GetLatency> I<Volume>
5282
5283 Select the given volume for IO, operations or latency statistics collection.
5284 The argument is the name of the volume without the C</vol/> prefix.
5285
5286 Since the standard ignorelist functionality is used here, you can use a string
5287 starting and ending with a slash to specify regular expression matching: To
5288 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5289 expression:
5290
5291   GetIO "/^vol[027]$/"
5292
5293 If no regular expression is specified, an exact match is required. Both,
5294 regular and exact matching are case sensitive.
5295
5296 If no volume was specified at all for either of the three options, that data
5297 will be collected for all available volumes.
5298
5299 See F</"IGNORELISTS"> for details.
5300
5301 =item B<IgnoreSelectedIO> B<true>|B<false>
5302
5303 =item B<IgnoreSelectedOps> B<true>|B<false>
5304
5305 =item B<IgnoreSelectedLatency> B<true>|B<false>
5306
5307 When set to B<true>, the volumes selected for IO, operations or latency
5308 statistics collection will be ignored and the data will be collected for all
5309 other volumes.
5310
5311 When set to B<false>, data will only be collected for the specified volumes and
5312 all other volumes will be ignored.
5313
5314 If no volumes have been specified with the above B<Get*> options, all volumes
5315 will be collected regardless of the B<IgnoreSelected*> option.
5316
5317 Defaults to B<false>
5318
5319 =back
5320
5321 =head3 The VolumeUsage block
5322
5323 This will collect capacity data about the individual volumes.
5324
5325 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5326 capability.
5327
5328 =over 4
5329
5330 =item B<Interval> I<Seconds>
5331
5332 Collect volume usage statistics every I<Seconds> seconds.
5333
5334 =item B<GetCapacity> I<VolumeName>
5335
5336 The current capacity of the volume will be collected. This will result in two
5337 to four value lists, depending on the configuration of the volume. All data
5338 sources are of type "df_complex" with the name of the volume as
5339 plugin_instance.
5340
5341 There will be type_instances "used" and "free" for the number of used and
5342 available bytes on the volume.  If the volume has some space reserved for
5343 snapshots, a type_instance "snap_reserved" will be available.  If the volume
5344 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5345 number of bytes saved by the SIS feature.
5346
5347 B<Note:> The current NetApp API has a bug that results in this value being
5348 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5349 number which works most of the time.  If you see strange values here, bug
5350 NetApp support to fix this.
5351
5352 Repeat this option to specify multiple volumes.
5353
5354 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5355
5356 Specify whether to collect only the volumes selected by the B<GetCapacity>
5357 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5358 B<false>. However, if no B<GetCapacity> option is specified at all, all
5359 capacities will be selected anyway.
5360
5361 =item B<GetSnapshot> I<VolumeName>
5362
5363 Select volumes from which to collect snapshot information.
5364
5365 Usually, the space used for snapshots is included in the space reported as
5366 "used". If snapshot information is collected as well, the space used for
5367 snapshots is subtracted from the used space.
5368
5369 To make things even more interesting, it is possible to reserve space to be
5370 used for snapshots. If the space required for snapshots is less than that
5371 reserved space, there is "reserved free" and "reserved used" space in addition
5372 to "free" and "used". If the space required for snapshots exceeds the reserved
5373 space, that part allocated in the normal space is subtracted from the "used"
5374 space again.
5375
5376 Repeat this option to specify multiple volumes.
5377
5378 =item B<IgnoreSelectedSnapshot>
5379
5380 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5381 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5382 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5383 capacities will be selected anyway.
5384
5385 =back
5386
5387 =head3 The Quota block
5388
5389 This will collect (tree) quota statistics (used disk space and number of used
5390 files). This mechanism is useful to get usage information for single qtrees.
5391 In case the quotas are not used for any other purpose, an entry similar to the
5392 following in C</etc/quotas> would be sufficient:
5393
5394   /vol/volA/some_qtree tree - - - - -
5395
5396 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5397
5398 =over 4
5399
5400 =item B<Interval> I<Seconds>
5401
5402 Collect SnapVault(R) statistics every I<Seconds> seconds.
5403
5404 =back
5405
5406 =head3 The SnapVault block
5407
5408 This will collect statistics about the time and traffic of SnapVault(R)
5409 transfers.
5410
5411 =over 4
5412
5413 =item B<Interval> I<Seconds>
5414
5415 Collect SnapVault(R) statistics every I<Seconds> seconds.
5416
5417 =back
5418
5419 =head2 Plugin C<netlink>
5420
5421 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5422 statistics of various interface and routing aspects.
5423
5424 =over 4
5425
5426 =item B<Interface> I<Interface>
5427
5428 =item B<VerboseInterface> I<Interface>
5429
5430 Instruct the plugin to collect interface statistics. This is basically the same
5431 as the statistics provided by the C<interface> plugin (see above) but
5432 potentially much more detailed.
5433
5434 When configuring with B<Interface> only the basic statistics will be collected,
5435 namely octets, packets, and errors. These statistics are collected by
5436 the C<interface> plugin, too, so using both at the same time is no benefit.
5437
5438 When configured with B<VerboseInterface> all counters B<except> the basic ones
5439 will be collected, so that no data needs to be collected twice if you use the
5440 C<interface> plugin.
5441 This includes dropped packets, received multicast packets, collisions and a
5442 whole zoo of differentiated RX and TX errors. You can try the following command
5443 to get an idea of what awaits you:
5444
5445   ip -s -s link list
5446
5447 If I<Interface> is B<All>, all interfaces will be selected.
5448
5449 =item B<QDisc> I<Interface> [I<QDisc>]
5450
5451 =item B<Class> I<Interface> [I<Class>]
5452
5453 =item B<Filter> I<Interface> [I<Filter>]
5454
5455 Collect the octets and packets that pass a certain qdisc, class or filter.
5456
5457 QDiscs and classes are identified by their type and handle (or classid).
5458 Filters don't necessarily have a handle, therefore the parent's handle is used.
5459 The notation used in collectd differs from that used in tc(1) in that it
5460 doesn't skip the major or minor number if it's zero and doesn't print special
5461 ids by their name. So, for example, a qdisc may be identified by
5462 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5463 thus not displayed by tc(1).
5464
5465 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5466 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5467 associated with that interface will be collected.
5468
5469 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5470 used. This may lead to problems when more than one filter is attached to a
5471 qdisc or class. This isn't nice, but we don't know how this could be done any
5472 better. If you have a idea, please don't hesitate to tell us.
5473
5474 As with the B<Interface> option you can specify B<All> as the interface,
5475 meaning all interfaces.
5476
5477 Here are some examples to help you understand the above text more easily:
5478
5479   <Plugin netlink>
5480     VerboseInterface "All"
5481     QDisc "eth0" "pfifo_fast-1:0"
5482     QDisc "ppp0"
5483     Class "ppp0" "htb-1:10"
5484     Filter "ppp0" "u32-1:0"
5485   </Plugin>
5486
5487 See F</"IGNORELISTS"> for details.
5488
5489 =item B<IgnoreSelected>
5490
5491 The behavior is the same as with all other similar plugins: If nothing is
5492 selected at all, everything is collected. If some things are selected using the
5493 options described above, only these statistics are collected. If you set
5494 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5495 specified statistics will not be collected.
5496
5497 =back
5498
5499 =head2 Plugin C<network>
5500
5501 The Network plugin sends data to a remote instance of collectd, receives data
5502 from a remote instance, or both at the same time. Data which has been received
5503 from the network is usually not transmitted again, but this can be activated, see
5504 the B<Forward> option below.
5505
5506 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5507 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5508
5509 Both, B<Server> and B<Listen> can be used as single option or as block. When
5510 used as block, given options are valid for this socket only. The following
5511 example will export the metrics twice: Once to an "internal" server (without
5512 encryption and signing) and one to an external server (with cryptographic
5513 signature):
5514
5515  <Plugin "network">
5516    # Export to an internal server
5517    # (demonstrates usage without additional options)
5518    Server "collectd.internal.tld"
5519
5520    # Export to an external server
5521    # (demonstrates usage with signature options)
5522    <Server "collectd.external.tld">
5523      SecurityLevel "sign"
5524      Username "myhostname"
5525      Password "ohl0eQue"
5526    </Server>
5527  </Plugin>
5528
5529 =over 4
5530
5531 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5532
5533 The B<Server> statement/block sets the server to send datagrams to. The
5534 statement may occur multiple times to send each datagram to multiple
5535 destinations.
5536
5537 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5538 optional second argument specifies a port number or a service name. If not
5539 given, the default, B<25826>, is used.
5540
5541 The following options are recognized within B<Server> blocks:
5542
5543 =over 4
5544
5545 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5546
5547 Set the security you require for network communication. When the security level
5548 has been set to B<Encrypt>, data sent over the network will be encrypted using
5549 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5550 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5551 authentication code. When set to B<None>, data is sent without any security.
5552
5553 This feature is only available if the I<network> plugin was linked with
5554 I<libgcrypt>.
5555
5556 =item B<Username> I<Username>
5557
5558 Sets the username to transmit. This is used by the server to lookup the
5559 password. See B<AuthFile> below. All security levels except B<None> require
5560 this setting.
5561
5562 This feature is only available if the I<network> plugin was linked with
5563 I<libgcrypt>.
5564
5565 =item B<Password> I<Password>
5566
5567 Sets a password (shared secret) for this socket. All security levels except
5568 B<None> require this setting.
5569
5570 This feature is only available if the I<network> plugin was linked with
5571 I<libgcrypt>.
5572
5573 =item B<Interface> I<Interface name>
5574
5575 Set the outgoing interface for IP packets. This applies at least
5576 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5577 undefined or a non-existent interface name is specified, the default
5578 behavior is to let the kernel choose the appropriate interface. Be warned
5579 that the manual selection of an interface for unicast traffic is only
5580 necessary in rare cases.
5581
5582 =item B<BindAddress> I<IP Address>
5583
5584 Set the outgoing IP address for IP packets. This option can be used instead of
5585 the I<Interface> option to explicitly define the IP address which will be used
5586 to send Packets to the remote server.
5587
5588 =item B<ResolveInterval> I<Seconds>
5589
5590 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5591 useful to force a regular DNS lookup to support a high availability setup. If
5592 not specified, re-resolves are never attempted.
5593
5594 =back
5595
5596 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5597
5598 The B<Listen> statement sets the interfaces to bind to. When multiple
5599 statements are found the daemon will bind to multiple interfaces.
5600
5601 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5602 the argument is a multicast address the daemon will join that multicast group.
5603 The optional second argument specifies a port number or a service name. If not
5604 given, the default, B<25826>, is used.
5605
5606 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5607
5608 =over 4
5609
5610 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5611
5612 Set the security you require for network communication. When the security level
5613 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5614 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5615 signed and encrypted data is accepted. When set to B<None>, all data will be
5616 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5617 decrypted if possible.
5618
5619 This feature is only available if the I<network> plugin was linked with
5620 I<libgcrypt>.
5621
5622 =item B<AuthFile> I<Filename>
5623
5624 Sets a file in which usernames are mapped to passwords. These passwords are
5625 used to verify signatures and to decrypt encrypted network packets. If
5626 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5627 verified and encrypted packets are decrypted. Otherwise, signed data is
5628 accepted without checking the signature and encrypted data cannot be decrypted.
5629 For the other security levels this option is mandatory.
5630
5631 The file format is very simple: Each line consists of a username followed by a
5632 colon and any number of spaces followed by the password. To demonstrate, an
5633 example file could look like this:
5634
5635   user0: foo
5636   user1: bar
5637
5638 Each time a packet is received, the modification time of the file is checked
5639 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5640 the file is being read, it is locked using L<fcntl(2)>.
5641
5642 =item B<Interface> I<Interface name>
5643
5644 Set the incoming interface for IP packets explicitly. This applies at least
5645 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5646 undefined or a non-existent interface name is specified, the default
5647 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5648 traffic gets only accepted, if it arrives on the given interface.
5649
5650 =back
5651
5652 =item B<TimeToLive> I<1-255>
5653
5654 Set the time-to-live of sent packets. This applies to all, unicast and
5655 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5656 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5657 operating systems.
5658
5659 =item B<MaxPacketSize> I<1024-65535>
5660
5661 Set the maximum size for datagrams received over the network. Packets larger
5662 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5663 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5664 UDP.
5665
5666 On the server side, this limit should be set to the largest value used on
5667 I<any> client. Likewise, the value on the client must not be larger than the
5668 value on the server, or data will be lost.
5669
5670 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5671 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5672 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5673 server.
5674
5675 =item B<Forward> I<true|false>
5676
5677 If set to I<true>, write packets that were received via the network plugin to
5678 the sending sockets. This should only be activated when the B<Listen>- and
5679 B<Server>-statements differ. Otherwise packets may be send multiple times to
5680 the same multicast group. While this results in more network traffic than
5681 necessary it's not a huge problem since the plugin has a duplicate detection,
5682 so the values will not loop.
5683
5684 =item B<ReportStats> B<true>|B<false>
5685
5686 The network plugin cannot only receive and send statistics, it can also create
5687 statistics about itself. Collectd data included the number of received and
5688 sent octets and packets, the length of the receive queue and the number of
5689 values handled. When set to B<true>, the I<Network plugin> will make these
5690 statistics available. Defaults to B<false>.
5691
5692 =back
5693
5694 =head2 Plugin C<nfs>
5695
5696 The I<nfs plugin> collects information about the usage of the Network File
5697 System (NFS). It counts the number of procedure calls for each procedure,
5698 grouped by version and whether the system runs as server or client.
5699
5700 It is possibly to omit metrics for a specific NFS version by setting one or
5701 more of the following options to B<false> (all of them default to B<true>).
5702
5703 =over 4
5704
5705 =item B<ReportV2> B<true>|B<false>
5706
5707 =item B<ReportV3> B<true>|B<false>
5708
5709 =item B<ReportV4> B<true>|B<false>
5710
5711 =back
5712
5713 =head2 Plugin C<nginx>
5714
5715 This plugin collects the number of connections and requests handled by the
5716 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5717 queries the page provided by the C<ngx_http_stub_status_module> module, which
5718 isn't compiled by default. Please refer to
5719 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5720 how to compile and configure nginx and this module.
5721
5722 The following options are accepted by the C<nginx plugin>:
5723
5724 =over 4
5725
5726 =item B<URL> I<http://host/nginx_status>
5727
5728 Sets the URL of the C<ngx_http_stub_status_module> output.
5729
5730 =item B<User> I<Username>
5731
5732 Optional user name needed for authentication.
5733
5734 =item B<Password> I<Password>
5735
5736 Optional password needed for authentication.
5737
5738 =item B<VerifyPeer> B<true|false>
5739
5740 Enable or disable peer SSL certificate verification. See
5741 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5742
5743 =item B<VerifyHost> B<true|false>
5744
5745 Enable or disable peer host name verification. If enabled, the plugin checks
5746 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5747 certificate matches the host name provided by the B<URL> option. If this
5748 identity check fails, the connection is aborted. Obviously, only works when
5749 connecting to a SSL enabled server. Enabled by default.
5750
5751 =item B<CACert> I<File>
5752
5753 File that holds one or more SSL certificates. If you want to use HTTPS you will
5754 possibly need this option. What CA certificates come bundled with C<libcurl>
5755 and are checked by default depends on the distribution you use.
5756
5757 =item B<Timeout> I<Milliseconds>
5758
5759 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5760 milliseconds. By default, the configured B<Interval> is used to set the
5761 timeout.
5762
5763 =back
5764
5765 =head2 Plugin C<notify_desktop>
5766
5767 This plugin sends a desktop notification to a notification daemon, as defined
5768 in the Desktop Notification Specification. To actually display the
5769 notifications, B<notification-daemon> is required and B<collectd> has to be
5770 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5771 environment variables have to be set correctly) and the D-Bus message bus.
5772
5773 The Desktop Notification Specification can be found at
5774 L<http://www.galago-project.org/specs/notification/>.
5775
5776 =over 4
5777
5778 =item B<OkayTimeout> I<timeout>
5779
5780 =item B<WarningTimeout> I<timeout>
5781
5782 =item B<FailureTimeout> I<timeout>
5783
5784 Set the I<timeout>, in milliseconds, after which to expire the notification
5785 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5786 been specified, the displayed notification will not be closed at all - the
5787 user has to do so herself. These options default to 5000. If a negative number
5788 has been specified, the default is used as well.
5789
5790 =back
5791
5792 =head2 Plugin C<notify_email>
5793
5794 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5795 configured email address.
5796
5797 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5798
5799 Available configuration options:
5800
5801 =over 4
5802
5803 =item B<From> I<Address>
5804
5805 Email address from which the emails should appear to come from.
5806
5807 Default: C<root@localhost>
5808
5809 =item B<Recipient> I<Address>
5810
5811 Configures the email address(es) to which the notifications should be mailed.
5812 May be repeated to send notifications to multiple addresses.
5813
5814 At least one B<Recipient> must be present for the plugin to work correctly.
5815
5816 =item B<SMTPServer> I<Hostname>
5817
5818 Hostname of the SMTP server to connect to.
5819
5820 Default: C<localhost>
5821
5822 =item B<SMTPPort> I<Port>
5823
5824 TCP port to connect to.
5825
5826 Default: C<25>
5827
5828 =item B<SMTPUser> I<Username>
5829
5830 Username for ASMTP authentication. Optional.
5831
5832 =item B<SMTPPassword> I<Password>
5833
5834 Password for ASMTP authentication. Optional.
5835
5836 =item B<Subject> I<Subject>
5837
5838 Subject-template to use when sending emails. There must be exactly two
5839 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5840 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5841 with the hostname.
5842
5843 Default: C<Collectd notify: %s@%s>
5844
5845 =back
5846
5847 =head2 Plugin C<notify_nagios>
5848
5849 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5850 a I<passive service check result>.
5851
5852 Available configuration options:
5853
5854 =over 4
5855
5856 =item B<CommandFile> I<Path>
5857
5858 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5859
5860 =back
5861
5862 =head2 Plugin C<ntpd>
5863
5864 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5865 dispersion.
5866
5867 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5868 the wire - using B<mode 7> specific requests. This mode is deprecated with
5869 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5870 correctly with them, the ntp daemon must be explicitly configured to
5871 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5872 manual page for details.
5873
5874 Available configuration options for the C<ntpd> plugin:
5875
5876 =over 4
5877
5878 =item B<Host> I<Hostname>
5879
5880 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5881
5882 =item B<Port> I<Port>
5883
5884 UDP-Port to connect to. Defaults to B<123>.
5885
5886 =item B<ReverseLookups> B<true>|B<false>
5887
5888 Sets whether or not to perform reverse lookups on peers. Since the name or
5889 IP-address may be used in a filename it is recommended to disable reverse
5890 lookups. The default is to do reverse lookups to preserve backwards
5891 compatibility, though.
5892
5893 =item B<IncludeUnitID> B<true>|B<false>
5894
5895 When a peer is a refclock, include the unit ID in the I<type instance>.
5896 Defaults to B<false> for backward compatibility.
5897
5898 If two refclock peers use the same driver and this is B<false>, the plugin will
5899 try to write simultaneous measurements from both to the same type instance.
5900 This will result in error messages in the log and only one set of measurements
5901 making it through.
5902
5903 =back
5904
5905 =head2 Plugin C<nut>
5906
5907 =over 4
5908
5909 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5910
5911 Add a UPS to collect data from. The format is identical to the one accepted by
5912 L<upsc(8)>.
5913
5914 =item B<ForceSSL> B<true>|B<false>
5915
5916 Stops connections from falling back to unsecured if an SSL connection
5917 cannot be established. Defaults to false if undeclared.
5918
5919 =item B<VerifyPeer> I<true>|I<false>
5920
5921 If set to true, requires a CAPath be provided. Will use the CAPath to find
5922 certificates to use as Trusted Certificates to validate a upsd server certificate.
5923 If validation of the upsd server certificate fails, the connection will not be
5924 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5925 will override and set ForceSSL to true.
5926
5927 =item B<CAPath> I/path/to/certs/folder
5928
5929 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5930 The folder pointed at must contain certificate(s) named according to their hash.
5931 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5932 occur because two different certs have the same hash value, Y can be  incremented
5933 in order to avoid conflict. To create a symbolic link to a certificate the following
5934 command can be used from within the directory where the cert resides:
5935
5936 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5937
5938 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5939 generate links like the one described above for ALL certs in a given folder.
5940 Example usage:
5941 C<c_rehash /path/to/certs/folder>
5942
5943 =item B<ConnectTimeout> I<Milliseconds>
5944
5945 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5946 By default, the configured B<Interval> is used to set the timeout.
5947
5948 =back
5949
5950 =head2 Plugin C<olsrd>
5951
5952 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5953 the Optimized Link State Routing daemon and reads information about the current
5954 state of the meshed network.
5955
5956 The following configuration options are understood:
5957
5958 =over 4
5959
5960 =item B<Host> I<Host>
5961
5962 Connect to I<Host>. Defaults to B<"localhost">.
5963
5964 =item B<Port> I<Port>
5965
5966 Specifies the port to connect to. This must be a string, even if you give the
5967 port as a number rather than a service name. Defaults to B<"2006">.
5968
5969 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5970
5971 Specifies what information to collect about links, i.E<nbsp>e. direct
5972 connections of the daemon queried. If set to B<No>, no information is
5973 collected. If set to B<Summary>, the number of links and the average of all
5974 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5975 If set to B<Detail> LQ and NLQ are collected per link.
5976
5977 Defaults to B<Detail>.
5978
5979 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5980
5981 Specifies what information to collect about routes of the daemon queried. If
5982 set to B<No>, no information is collected. If set to B<Summary>, the number of
5983 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5984 metric and ETX are collected per route.
5985
5986 Defaults to B<Summary>.
5987
5988 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5989
5990 Specifies what information to collect about the global topology. If set to
5991 B<No>, no information is collected. If set to B<Summary>, the number of links
5992 in the entire topology and the average I<link quality> (LQ) is calculated.
5993 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5994
5995 Defaults to B<Summary>.
5996
5997 =back
5998
5999 =head2 Plugin C<onewire>
6000
6001 B<EXPERIMENTAL!> See notes below.
6002
6003 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
6004 L<http://owfs.org/> to read sensors connected via the onewire bus.
6005
6006 It can be used in two possible modes - standard or advanced.
6007
6008 In the standard mode only temperature sensors (sensors with the family code
6009 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
6010 other sensors you would like to have included, please send a sort request to
6011 the mailing list. You can select sensors to be read or to be ignored depending
6012 on the option B<IgnoreSelected>). When no list is provided the whole bus is
6013 walked and all sensors are read.
6014
6015 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
6016 experimental, below.
6017
6018 In the advanced mode you can configure any sensor to be read (only numerical
6019 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
6020 In this mode you have to list all the sensors. Neither default bus walk nor
6021 B<IgnoreSelected> are used here. Address and type (file) is extracted from
6022 the path automatically and should produce compatible structure with the "standard"
6023 mode (basically the path is expected as for example
6024 "/uncached/10.F10FCA000800/temperature" where it would extract address part
6025 "F10FCA000800" and the rest after the slash is considered the type - here
6026 "temperature").
6027 There are two advantages to this mode - you can access virtually any sensor
6028 (not just temperature), select whether to use cached or directly read values
6029 and it is slighlty faster. The downside is more complex configuration.
6030
6031 The two modes are distinguished automatically by the format of the address.
6032 It is not possible to mix the two modes. Once a full path is detected in any
6033 B<Sensor> then the whole addressing (all sensors) is considered to be this way
6034 (and as standard addresses will fail parsing they will be ignored).
6035
6036 =over 4
6037
6038 =item B<Device> I<Device>
6039
6040 Sets the device to read the values from. This can either be a "real" hardware
6041 device, such as a serial port or an USB port, or the address of the
6042 L<owserver(1)> socket, usually B<localhost:4304>.
6043
6044 Though the documentation claims to automatically recognize the given address
6045 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
6046 with that version, the following configuration worked for us:
6047
6048   <Plugin onewire>
6049     Device "-s localhost:4304"
6050   </Plugin>
6051
6052 This directive is B<required> and does not have a default value.
6053
6054 =item B<Sensor> I<Sensor>
6055
6056 In the standard mode selects sensors to collect or to ignore
6057 (depending on B<IgnoreSelected>, see below). Sensors are specified without
6058 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
6059 and B<not> include the leading C<10.> family byte and point.
6060 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
6061 sensors (see above) are read.
6062
6063 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
6064 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
6065 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
6066
6067 As there can be multiple devices on the bus you can list multiple sensor (use
6068 multiple B<Sensor> elements).
6069
6070 See F</"IGNORELISTS"> for details.
6071
6072 =item B<IgnoreSelected> I<true>|I<false>
6073
6074 If no configuration is given, the B<onewire> plugin will collect data from all
6075 sensors found. This may not be practical, especially if sensors are added and
6076 removed regularly. Sometimes, however, it's easier/preferred to collect only
6077 specific sensors or all sensors I<except> a few specified ones. This option
6078 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
6079 B<Sensor> is inverted: All selected interfaces are ignored and all other
6080 interfaces are collected.
6081
6082 Used only in the standard mode - see above.
6083
6084 =item B<Interval> I<Seconds>
6085
6086 Sets the interval in which all sensors should be read. If not specified, the
6087 global B<Interval> setting is used.
6088
6089 =back
6090
6091 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
6092 work with big setups. It works with one sensor being attached to one
6093 controller, but as soon as you throw in a couple more senors and maybe a hub
6094 or two, reading all values will take more than ten seconds (the default
6095 interval). We will probably add some separate thread for reading the sensors
6096 and some cache or something like that, but it's not done yet. We will try to
6097 maintain backwards compatibility in the future, but we can't promise. So in
6098 short: If it works for you: Great! But keep in mind that the config I<might>
6099 change, though this is unlikely. Oh, and if you want to help improving this
6100 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6101
6102 =head2 Plugin C<openldap>
6103
6104 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6105 server correctly. The backend database C<monitor> needs to be loaded and
6106 working. See slapd-monitor(5) for the details.
6107
6108 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6109 blocks. Each block requires one string argument as the instance name. For
6110 example:
6111
6112  <Plugin "openldap">
6113    <Instance "foo">
6114      URL "ldap://localhost/"
6115    </Instance>
6116    <Instance "bar">
6117      URL "ldaps://localhost/"
6118    </Instance>
6119  </Plugin>
6120
6121 The instance name will be used as the I<plugin instance>. To emulate the old
6122 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6123 plugin to work correctly, each instance name must be unique. This is not
6124 enforced by the plugin and it is your responsibility to ensure it is.
6125
6126 The following options are accepted within each B<Instance> block:
6127
6128 =over 4
6129
6130 =item B<URL> I<ldap://host/binddn>
6131
6132 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6133 I<mandatory>.
6134
6135 =item B<BindDN> I<BindDN>
6136
6137 Name in the form of an LDAP distinguished name intended to be used for
6138 authentication. Defaults to empty string to establish an anonymous authorization.
6139
6140 =item B<Password> I<Password>
6141
6142 Password for simple bind authentication. If this option is not set,
6143 unauthenticated bind operation is used.
6144
6145 =item B<StartTLS> B<true|false>
6146
6147 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6148 Disabled by default.
6149
6150 =item B<VerifyHost> B<true|false>
6151
6152 Enables or disables peer host name verification. If enabled, the plugin checks
6153 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6154 certificate matches the host name provided by the B<URL> option. If this
6155 identity check fails, the connection is aborted. Enabled by default.
6156
6157 =item B<CACert> I<File>
6158
6159 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6160 may possibly need this option. What CA certificates are checked by default
6161 depends on the distribution you use and can be changed with the usual ldap
6162 client configuration mechanisms. See ldap.conf(5) for the details.
6163
6164 =item B<Timeout> I<Seconds>
6165
6166 Sets the timeout value for ldap operations, in seconds. By default, the
6167 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6168 (infinite timeout).
6169
6170 =item B<Version> I<Version>
6171
6172 An integer which sets the LDAP protocol version number to use when connecting
6173 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6174
6175 =back
6176
6177 =head2 Plugin C<openvpn>
6178
6179 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6180 traffic statistics about connected clients.
6181
6182 To set up OpenVPN to write to the status file periodically, use the
6183 B<--status> option of OpenVPN.
6184
6185 So, in a nutshell you need:
6186
6187   openvpn $OTHER_OPTIONS \
6188     --status "/var/run/openvpn-status" 10
6189
6190 Available options:
6191
6192 =over 4
6193
6194 =item B<StatusFile> I<File>
6195
6196 Specifies the location of the status file.
6197
6198 =item B<ImprovedNamingSchema> B<true>|B<false>
6199
6200 When enabled, the filename of the status file will be used as plugin instance
6201 and the client's "common name" will be used as type instance. This is required
6202 when reading multiple status files. Enabling this option is recommended, but to
6203 maintain backwards compatibility this option is disabled by default.
6204
6205 =item B<CollectCompression> B<true>|B<false>
6206
6207 Sets whether or not statistics about the compression used by OpenVPN should be
6208 collected. This information is only available in I<single> mode. Enabled by
6209 default.
6210
6211 =item B<CollectIndividualUsers> B<true>|B<false>
6212
6213 Sets whether or not traffic information is collected for each connected client
6214 individually. If set to false, currently no traffic data is collected at all
6215 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6216
6217 =item B<CollectUserCount> B<true>|B<false>
6218
6219 When enabled, the number of currently connected clients or users is collected.
6220 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6221 can be configured independently from that option. Defaults to B<false>.
6222
6223 =back
6224
6225 =head2 Plugin C<oracle>
6226
6227 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6228 Oracle® Database and lets you execute SQL statements there. It is very similar
6229 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6230 plugin's documentation above for details.
6231
6232   <Plugin oracle>
6233     <Query "out_of_stock">
6234       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6235       <Result>
6236         Type "gauge"
6237         # InstancePrefix "foo"
6238         InstancesFrom "category"
6239         ValuesFrom "value"
6240       </Result>
6241     </Query>
6242     <Database "product_information">
6243       #Plugin "warehouse"
6244       ConnectID "db01"
6245       Username "oracle"
6246       Password "secret"
6247       Query "out_of_stock"
6248     </Database>
6249   </Plugin>
6250
6251 =head3 B<Query> blocks
6252
6253 The Query blocks are handled identically to the Query blocks of the "dbi"
6254 plugin. Please see its documentation above for details on how to specify
6255 queries.
6256
6257 =head3 B<Database> blocks
6258
6259 Database blocks define a connection to a database and which queries should be
6260 sent to that database. Each database needs a "name" as string argument in the
6261 starting tag of the block. This name will be used as "PluginInstance" in the
6262 values submitted to the daemon. Other than that, that name is not used.
6263
6264 =over 4
6265
6266 =item B<Plugin> I<Plugin>
6267
6268 Use I<Plugin> as the plugin name when submitting query results from
6269 this B<Database>. Defaults to C<oracle>.
6270
6271 =item B<ConnectID> I<ID>
6272
6273 Defines the "database alias" or "service name" to connect to. Usually, these
6274 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6275
6276 =item B<Host> I<Host>
6277
6278 Hostname to use when dispatching values for this database. Defaults to using
6279 the global hostname of the I<collectd> instance.
6280
6281 =item B<Username> I<Username>
6282
6283 Username used for authentication.
6284
6285 =item B<Password> I<Password>
6286
6287 Password used for authentication.
6288
6289 =item B<Query> I<QueryName>
6290
6291 Associates the query named I<QueryName> with this database connection. The
6292 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6293 blocks you want to refer to must be placed above the database block you want to
6294 refer to them from.
6295
6296 =back
6297
6298 =head2 Plugin C<ovs_events>
6299
6300 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6301 connected interfaces, dispatches the values to collectd and sends the
6302 notification whenever the link state change occurs. This plugin uses OVS
6303 database to get a link state change notification.
6304
6305 B<Synopsis:>
6306
6307  <Plugin "ovs_events">
6308    Port 6640
6309    Address "127.0.0.1"
6310    Socket "/var/run/openvswitch/db.sock"
6311    Interfaces "br0" "veth0"
6312    SendNotification true
6313    DispatchValues false
6314  </Plugin>
6315
6316 The plugin provides the following configuration options:
6317
6318 =over 4
6319
6320 =item B<Address> I<node>
6321
6322 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6323 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6324 option. See L<ovsdb-server(1)> for more details. The option may be either
6325 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6326 format. Defaults to C<localhost>.
6327
6328 =item B<Port> I<service>
6329
6330 TCP-port to connect to. Either a service name or a port number may be given.
6331 Defaults to B<6640>.
6332
6333 =item B<Socket> I<path>
6334
6335 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6336 plugin. To enable the interface, the OVS DB daemon should be running with
6337 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6338 option is set, B<Address> and B<Port> options are ignored.
6339
6340 =item B<Interfaces> [I<ifname> ...]
6341
6342 List of interface names to be monitored by this plugin. If this option is not
6343 specified or is empty then all OVS connected interfaces on all bridges are
6344 monitored.
6345
6346 Default: empty (all interfaces on all bridges are monitored)
6347
6348 =item B<SendNotification> I<true|false>
6349
6350 If set to true, OVS link notifications (interface status and OVS DB connection
6351 terminate) are sent to collectd. Default value is true.
6352
6353 =item B<DispatchValues> I<true|false>
6354
6355 Dispatch the OVS DB interface link status value with configured plugin interval.
6356 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6357 options are false, no OVS information will be provided by the plugin.
6358
6359 =back
6360
6361 B<Note:> By default, the global interval setting is used within which to
6362 retrieve the OVS link status. To configure a plugin-specific interval, please
6363 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6364 simple divide the time by 1000 for example if the desired interval is 50ms, set
6365 interval to 0.05.
6366
6367 =head2 Plugin C<ovs_stats>
6368
6369 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6370 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6371 statistics from OVSDB
6372
6373 B<Synopsis:>
6374
6375  <Plugin "ovs_stats">
6376    Port 6640
6377    Address "127.0.0.1"
6378    Socket "/var/run/openvswitch/db.sock"
6379    Bridges "br0" "br_ext"
6380    InterfaceStats false
6381  </Plugin>
6382
6383 The plugin provides the following configuration options:
6384
6385 =over 4
6386
6387 =item B<Address> I<node>
6388
6389 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6390 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6391 option. See L<ovsdb-server(1)> for more details. The option may be either
6392 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6393 format. Defaults to C<localhost>.
6394
6395 =item B<Port> I<service>
6396
6397 TCP-port to connect to. Either a service name or a port number may be given.
6398 Defaults to B<6640>.
6399
6400 =item B<Socket> I<path>
6401
6402 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6403 plugin. To enable the interface, the OVS DB daemon should be running with
6404 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6405 option is set, B<Address> and B<Port> options are ignored.
6406
6407 =item B<Bridges> [I<brname> ...]
6408
6409 List of OVS bridge names to be monitored by this plugin. If this option is
6410 omitted or is empty then all OVS bridges will be monitored.
6411
6412 Default: empty (monitor all bridges)
6413
6414 =item B<InterfaceStats> B<false>|B<true>
6415
6416 Indicates that the plugin should gather statistics for individual interfaces
6417 in addition to ports.  This can be useful when monitoring an OVS setup with
6418 bond ports, where you might wish to know individual statistics for the
6419 interfaces included in the bonds.  Defaults to B<false>.
6420
6421 =back
6422
6423 =head2 Plugin C<pcie_errors>
6424
6425 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6426 structure and from Advanced Error Reporting Extended Capability where available.
6427 At every read it polls config space of PCI Express devices and dispatches
6428 notification for every error that is set. It checks for new errors at every read.
6429 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6430 Errors are divided into categories indicated by type_instance: "correctable", and
6431 for uncorrectable errors "non_fatal" or "fatal".
6432 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6433
6434 B<Synopsis:>
6435
6436   <Plugin "pcie_errors">
6437     Source "sysfs"
6438     AccessDir "/sys/bus/pci"
6439     ReportMasked false
6440     PersistentNotifications false
6441   </Plugin>
6442
6443 B<Options:>
6444
6445 =over 4
6446
6447 =item B<Source> B<sysfs>|B<proc>
6448
6449 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6450 The default value is B<sysfs>.
6451
6452 =item B<AccessDir> I<dir>
6453
6454 Directory used to access device config space. It is optional and defaults to
6455 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6456
6457 =item B<ReportMasked> B<false>|B<true>
6458
6459 If true plugin will notify about errors that are set to masked in Error Mask register.
6460 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6461
6462 =item B<PersistentNotifications> B<false>|B<true>
6463
6464 If false plugin will dispatch notification only on set/clear of error.
6465 The ones already reported will be ignored. Defaults to B<false>.
6466
6467 =back
6468
6469 =head2 Plugin C<perl>
6470
6471 This plugin embeds a Perl-interpreter into collectd and provides an interface
6472 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6473
6474 =head2 Plugin C<pinba>
6475
6476 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6477 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6478 PHP-based webpage has been delivered, the extension will send a UDP packet
6479 containing timing information, peak memory usage and so on. The plugin will
6480 wait for such packets, parse them and account the provided information, which
6481 is then dispatched to the daemon once per interval.
6482
6483 Synopsis:
6484
6485  <Plugin pinba>
6486    Address "::0"
6487    Port "30002"
6488    # Overall statistics for the website.
6489    <View "www-total">
6490      Server "www.example.com"
6491    </View>
6492    # Statistics for www-a only
6493    <View "www-a">
6494      Host "www-a.example.com"
6495      Server "www.example.com"
6496    </View>
6497    # Statistics for www-b only
6498    <View "www-b">
6499      Host "www-b.example.com"
6500      Server "www.example.com"
6501    </View>
6502  </Plugin>
6503
6504 The plugin provides the following configuration options:
6505
6506 =over 4
6507
6508 =item B<Address> I<Node>
6509
6510 Configures the address used to open a listening socket. By default, plugin will
6511 bind to the I<any> address C<::0>.
6512
6513 =item B<Port> I<Service>
6514
6515 Configures the port (service) to bind to. By default the default Pinba port
6516 "30002" will be used. The option accepts service names in addition to port
6517 numbers and thus requires a I<string> argument.
6518
6519 =item E<lt>B<View> I<Name>E<gt> block
6520
6521 The packets sent by the Pinba extension include the hostname of the server, the
6522 server name (the name of the virtual host) and the script that was executed.
6523 Using B<View> blocks it is possible to separate the data into multiple groups
6524 to get more meaningful statistics. Each packet is added to all matching groups,
6525 so that a packet may be accounted for more than once.
6526
6527 =over 4
6528
6529 =item B<Host> I<Host>
6530
6531 Matches the hostname of the system the webserver / script is running on. This
6532 will contain the result of the L<gethostname(2)> system call. If not
6533 configured, all hostnames will be accepted.
6534
6535 =item B<Server> I<Server>
6536
6537 Matches the name of the I<virtual host>, i.e. the contents of the
6538 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6539 server names will be accepted.
6540
6541 =item B<Script> I<Script>
6542
6543 Matches the name of the I<script name>, i.e. the contents of the
6544 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6545 script names will be accepted.
6546
6547 =back
6548
6549 =back
6550
6551 =head2 Plugin C<ping>
6552
6553 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6554 configured hosts periodically and measures the network latency. Whenever the
6555 C<read> function of the plugin is called, it submits the average latency, the
6556 standard deviation and the drop rate for each host.
6557
6558 Available configuration options:
6559
6560 =over 4
6561
6562 =item B<Host> I<IP-address>
6563
6564 Host to ping periodically. This option may be repeated several times to ping
6565 multiple hosts.
6566
6567 =item B<Interval> I<Seconds>
6568
6569 Sets the interval in which to send ICMP echo packets to the configured hosts.
6570 This is B<not> the interval in which metrics are read from the plugin but the
6571 interval in which the hosts are "pinged". Therefore, the setting here should be
6572 smaller than or equal to the global B<Interval> setting. Fractional times, such
6573 as "1.24" are allowed.
6574
6575 Default: B<1.0>
6576
6577 =item B<Timeout> I<Seconds>
6578
6579 Time to wait for a response from the host to which an ICMP packet had been
6580 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6581 to be down or the packet to be dropped. This setting must be smaller than the
6582 B<Interval> setting above for the plugin to work correctly. Fractional
6583 arguments are accepted.
6584
6585 Default: B<0.9>
6586
6587 =item B<TTL> I<0-255>
6588
6589 Sets the Time-To-Live of generated ICMP packets.
6590
6591 =item B<Size> I<size>
6592
6593 Sets the size of the data payload in ICMP packet to specified I<size> (it
6594 will be filled with regular ASCII pattern). If not set, default 56 byte
6595 long string is used so that the packet size of an ICMPv4 packet is exactly
6596 64 bytes, similar to the behaviour of normal ping(1) command.
6597
6598 =item B<SourceAddress> I<host>
6599
6600 Sets the source address to use. I<host> may either be a numerical network
6601 address or a network hostname.
6602
6603 =item B<AddressFamily> I<af>
6604
6605 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6606 option will be ignored if you set a B<SourceAddress>.
6607
6608 =item B<Device> I<name>
6609
6610 Sets the outgoing network device to be used. I<name> has to specify an
6611 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6612 operating systems.
6613
6614 =item B<MaxMissed> I<Packets>
6615
6616 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6617 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6618
6619 Default: B<-1> (disabled)
6620
6621 =back
6622
6623 =head2 Plugin C<postgresql>
6624
6625 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6626 keeps a persistent connection to all configured databases and tries to
6627 reconnect if the connection has been interrupted. A database is configured by
6628 specifying a B<Database> block as described below. The default statistics are
6629 collected from PostgreSQL's B<statistics collector> which thus has to be
6630 enabled for this plugin to work correctly. This should usually be the case by
6631 default. See the section "The Statistics Collector" of the B<PostgreSQL
6632 Documentation> for details.
6633
6634 By specifying custom database queries using a B<Query> block as described
6635 below, you may collect any data that is available from some PostgreSQL
6636 database. This way, you are able to access statistics of external daemons
6637 which are available in a PostgreSQL database or use future or special
6638 statistics provided by PostgreSQL without the need to upgrade your collectd
6639 installation.
6640
6641 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6642 PostgreSQL databases as well. This has been implemented in a generic way. You
6643 need to specify an SQL statement which will then be executed by collectd in
6644 order to write the data (see below for details). The benefit of that approach
6645 is that there is no fixed database layout. Rather, the layout may be optimized
6646 for the current setup.
6647
6648 The B<PostgreSQL Documentation> manual can be found at
6649 L<http://www.postgresql.org/docs/manuals/>.
6650
6651   <Plugin postgresql>
6652     <Query magic>
6653       Statement "SELECT magic FROM wizard WHERE host = $1;"
6654       Param hostname
6655       <Result>
6656         Type gauge
6657         InstancePrefix "magic"
6658         ValuesFrom magic
6659       </Result>
6660     </Query>
6661
6662     <Query rt36_tickets>
6663       Statement "SELECT COUNT(type) AS count, type \
6664                         FROM (SELECT CASE \
6665                                      WHEN resolved = 'epoch' THEN 'open' \
6666                                      ELSE 'resolved' END AS type \
6667                                      FROM tickets) type \
6668                         GROUP BY type;"
6669       <Result>
6670         Type counter
6671         InstancePrefix "rt36_tickets"
6672         InstancesFrom "type"
6673         ValuesFrom "count"
6674       </Result>
6675     </Query>
6676
6677     <Writer sqlstore>
6678       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6679       StoreRates true
6680     </Writer>
6681
6682     <Database foo>
6683       Plugin "kingdom"
6684       Host "hostname"
6685       Port "5432"
6686       User "username"
6687       Password "secret"
6688       SSLMode "prefer"
6689       KRBSrvName "kerberos_service_name"
6690       Query magic
6691     </Database>
6692
6693     <Database bar>
6694       Interval 300
6695       Service "service_name"
6696       Query backends # predefined
6697       Query rt36_tickets
6698     </Database>
6699
6700     <Database qux>
6701       # ...
6702       Writer sqlstore
6703       CommitInterval 10
6704     </Database>
6705   </Plugin>
6706
6707 The B<Query> block defines one database query which may later be used by a
6708 database definition. It accepts a single mandatory argument which specifies
6709 the name of the query. The names of all queries have to be unique (see the
6710 B<MinVersion> and B<MaxVersion> options below for an exception to this
6711 rule).
6712
6713 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6714 B<Result> blocks may be used to extract multiple values from a single query.
6715
6716 The following configuration options are available to define the query:
6717
6718 =over 4
6719
6720 =item B<Statement> I<sql query statement>
6721
6722 Specify the I<sql query statement> which the plugin should execute. The string
6723 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6724 first, second, etc. parameter. The value of the parameters is specified by the
6725 B<Param> configuration option - see below for details. To include a literal
6726 B<$> character followed by a number, surround it with single quotes (B<'>).
6727
6728 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6729 allowed. Note, however, that only a single command may be used. Semicolons are
6730 allowed as long as a single non-empty command has been specified only.
6731
6732 The returned lines will be handled separately one after another.
6733
6734 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6735
6736 Specify the parameters which should be passed to the SQL query. The parameters
6737 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6738 they appear in the configuration file. The value of the parameter is
6739 determined depending on the value of the B<Param> option as follows:
6740
6741 =over 4
6742
6743 =item I<hostname>
6744
6745 The configured hostname of the database connection. If a UNIX domain socket is
6746 used, the parameter expands to "localhost".
6747
6748 =item I<database>
6749
6750 The name of the database of the current connection.
6751
6752 =item I<instance>
6753
6754 The name of the database plugin instance. See the B<Instance> option of the
6755 database specification below for details.
6756
6757 =item I<username>
6758
6759 The username used to connect to the database.
6760
6761 =item I<interval>
6762
6763 The interval with which this database is queried (as specified by the database
6764 specific or global B<Interval> options).
6765
6766 =back
6767
6768 Please note that parameters are only supported by PostgreSQL's protocol
6769 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6770
6771 =item B<PluginInstanceFrom> I<column>
6772
6773 Specify how to create the "PluginInstance" for reporting this query results.
6774 Only one column is supported. You may concatenate fields and string values in
6775 the query statement to get the required results.
6776
6777 =item B<MinVersion> I<version>
6778
6779 =item B<MaxVersion> I<version>
6780
6781 Specify the minimum or maximum version of PostgreSQL that this query should be
6782 used with. Some statistics might only be available with certain versions of
6783 PostgreSQL. This allows you to specify multiple queries with the same name but
6784 which apply to different versions, thus allowing you to use the same
6785 configuration in a heterogeneous environment.
6786
6787 The I<version> has to be specified as the concatenation of the major, minor
6788 and patch-level versions, each represented as two-decimal-digit numbers. For
6789 example, version 8.2.3 will become 80203.
6790
6791 =back
6792
6793 The B<Result> block defines how to handle the values returned from the query.
6794 It defines which column holds which value and how to dispatch that value to
6795 the daemon.
6796
6797 =over 4
6798
6799 =item B<Type> I<type>
6800
6801 The I<type> name to be used when dispatching the values. The type describes
6802 how to handle the data and where to store it. See L<types.db(5)> for more
6803 details on types and their configuration. The number and type of values (as
6804 selected by the B<ValuesFrom> option) has to match the type of the given name.
6805
6806 This option is mandatory.
6807
6808 =item B<InstancePrefix> I<prefix>
6809
6810 =item B<InstancesFrom> I<column0> [I<column1> ...]
6811
6812 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6813 B<InstancePrefix> defines a static prefix that will be prepended to all type
6814 instances. B<InstancesFrom> defines the column names whose values will be used
6815 to create the type instance. Multiple values will be joined together using the
6816 hyphen (C<->) as separation character.
6817
6818 The plugin itself does not check whether or not all built instances are
6819 different. It is your responsibility to assure that each is unique.
6820
6821 Both options are optional. If none is specified, the type instance will be
6822 empty.
6823
6824 =item B<ValuesFrom> I<column0> [I<column1> ...]
6825
6826 Names the columns whose content is used as the actual data for the data sets
6827 that are dispatched to the daemon. How many such columns you need is
6828 determined by the B<Type> setting as explained above. If you specify too many
6829 or not enough columns, the plugin will complain about that and no data will be
6830 submitted to the daemon.
6831
6832 The actual data type, as seen by PostgreSQL, is not that important as long as
6833 it represents numbers. The plugin will automatically cast the values to the
6834 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6835 L<strtod(3)> functions, so anything supported by those functions is supported
6836 by the plugin as well.
6837
6838 This option is required inside a B<Result> block and may be specified multiple
6839 times. If multiple B<ValuesFrom> options are specified, the columns are read
6840 in the given order.
6841
6842 =back
6843
6844 The following predefined queries are available (the definitions can be found
6845 in the F<postgresql_default.conf> file which, by default, is available at
6846 C<I<prefix>/share/collectd/>):
6847
6848 =over 4
6849
6850 =item B<backends>
6851
6852 This query collects the number of backends, i.E<nbsp>e. the number of
6853 connected clients.
6854
6855 =item B<transactions>
6856
6857 This query collects the numbers of committed and rolled-back transactions of
6858 the user tables.
6859
6860 =item B<queries>
6861
6862 This query collects the numbers of various table modifications (i.E<nbsp>e.
6863 insertions, updates, deletions) of the user tables.
6864
6865 =item B<query_plans>
6866
6867 This query collects the numbers of various table scans and returned tuples of
6868 the user tables.
6869
6870 =item B<table_states>
6871
6872 This query collects the numbers of live and dead rows in the user tables.
6873
6874 =item B<disk_io>
6875
6876 This query collects disk block access counts for user tables.
6877
6878 =item B<disk_usage>
6879
6880 This query collects the on-disk size of the database in bytes.
6881
6882 =back
6883
6884 In addition, the following detailed queries are available by default. Please
6885 note that each of those queries collects information B<by table>, thus,
6886 potentially producing B<a lot> of data. For details see the description of the
6887 non-by_table queries above.
6888
6889 =over 4
6890
6891 =item B<queries_by_table>
6892
6893 =item B<query_plans_by_table>
6894
6895 =item B<table_states_by_table>
6896
6897 =item B<disk_io_by_table>
6898
6899 =back
6900
6901 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6902 mandatory argument specifying the name of the writer. This will then be used
6903 in the B<Database> specification in order to activate the writer instance. The
6904 names of all writers have to be unique. The following options may be
6905 specified:
6906
6907 =over 4
6908
6909 =item B<Statement> I<sql statement>
6910
6911 This mandatory option specifies the SQL statement that will be executed for
6912 each submitted value. A single SQL statement is allowed only. Anything after
6913 the first semicolon will be ignored.
6914
6915 Nine parameters will be passed to the statement and should be specified as
6916 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6917 values are made available through those parameters:
6918
6919 =over 4
6920
6921 =item B<$1>
6922
6923 The timestamp of the queried value as an RFC 3339-formatted local time.
6924
6925 =item B<$2>
6926
6927 The hostname of the queried value.
6928
6929 =item B<$3>
6930
6931 The plugin name of the queried value.
6932
6933 =item B<$4>
6934
6935 The plugin instance of the queried value. This value may be B<NULL> if there
6936 is no plugin instance.
6937
6938 =item B<$5>
6939
6940 The type of the queried value (cf. L<types.db(5)>).
6941
6942 =item B<$6>
6943
6944 The type instance of the queried value. This value may be B<NULL> if there is
6945 no type instance.
6946
6947 =item B<$7>
6948
6949 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6950 sources of the submitted value-list).
6951
6952 =item B<$8>
6953
6954 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6955 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6956 B<StoreRates> is enabled (which is the default, see below), all types will be
6957 C<gauge>.
6958
6959 =item B<$9>
6960
6961 An array of the submitted values. The dimensions of the value name and value
6962 arrays match.
6963
6964 =back
6965
6966 In general, it is advisable to create and call a custom function in the
6967 PostgreSQL database for this purpose. Any procedural language supported by
6968 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6969 for details).
6970
6971 =item B<StoreRates> B<false>|B<true>
6972
6973 If set to B<true> (the default), convert counter values to rates. If set to
6974 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6975 number.
6976
6977 =back
6978
6979 The B<Database> block defines one PostgreSQL database for which to collect
6980 statistics. It accepts a single mandatory argument which specifies the
6981 database name. None of the other options are required. PostgreSQL will use
6982 default values as documented in the section "CONNECTING TO A DATABASE" in the
6983 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6984 the user collectd is run as and special environment variables. See the manpage
6985 for details.
6986
6987 =over 4
6988
6989 =item B<Interval> I<seconds>
6990
6991 Specify the interval with which the database should be queried. The default is
6992 to use the global B<Interval> setting.
6993
6994 =item B<CommitInterval> I<seconds>
6995
6996 This option may be used for database connections which have "writers" assigned
6997 (see above). If specified, it causes a writer to put several updates into a
6998 single transaction. This transaction will last for the specified amount of
6999 time. By default, each update will be executed in a separate transaction. Each
7000 transaction generates a fair amount of overhead which can, thus, be reduced by
7001 activating this option. The draw-back is, that data covering the specified
7002 amount of time will be lost, for example, if a single statement within the
7003 transaction fails or if the database server crashes.
7004
7005 =item B<Plugin> I<Plugin>
7006
7007 Use I<Plugin> as the plugin name when submitting query results from
7008 this B<Database>. Defaults to C<postgresql>.
7009
7010 =item B<Instance> I<name>
7011
7012 Specify the plugin instance name that should be used instead of the database
7013 name (which is the default, if this option has not been specified). This
7014 allows one to query multiple databases of the same name on the same host (e.g.
7015 when running multiple database server versions in parallel).
7016 The plugin instance name can also be set from the query result using
7017 the B<PluginInstanceFrom> option in B<Query> block.
7018
7019 =item B<Host> I<hostname>
7020
7021 Specify the hostname or IP of the PostgreSQL server to connect to. If the
7022 value begins with a slash, it is interpreted as the directory name in which to
7023 look for the UNIX domain socket.
7024
7025 This option is also used to determine the hostname that is associated with a
7026 collected data set. If it has been omitted or either begins with with a slash
7027 or equals B<localhost> it will be replaced with the global hostname definition
7028 of collectd. Any other value will be passed literally to collectd when
7029 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
7030
7031 =item B<Port> I<port>
7032
7033 Specify the TCP port or the local UNIX domain socket file extension of the
7034 server.
7035
7036 =item B<User> I<username>
7037
7038 Specify the username to be used when connecting to the server.
7039
7040 =item B<Password> I<password>
7041
7042 Specify the password to be used when connecting to the server.
7043
7044 =item B<ExpireDelay> I<delay>
7045
7046 Skip expired values in query output.
7047
7048 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
7049
7050 Specify whether to use an SSL connection when contacting the server. The
7051 following modes are supported:
7052
7053 =over 4
7054
7055 =item I<disable>
7056
7057 Do not use SSL at all.
7058
7059 =item I<allow>
7060
7061 First, try to connect without using SSL. If that fails, try using SSL.
7062
7063 =item I<prefer> (default)
7064
7065 First, try to connect using SSL. If that fails, try without using SSL.
7066
7067 =item I<require>
7068
7069 Use SSL only.
7070
7071 =back
7072
7073 =item B<Instance> I<name>
7074
7075 Specify the plugin instance name that should be used instead of the database
7076 name (which is the default, if this option has not been specified). This
7077 allows one to query multiple databases of the same name on the same host (e.g.
7078 when running multiple database server versions in parallel).
7079
7080 =item B<KRBSrvName> I<kerberos_service_name>
7081
7082 Specify the Kerberos service name to use when authenticating with Kerberos 5
7083 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
7084 B<PostgreSQL Documentation> for details.
7085
7086 =item B<Service> I<service_name>
7087
7088 Specify the PostgreSQL service name to use for additional parameters. That
7089 service has to be defined in F<pg_service.conf> and holds additional
7090 connection parameters. See the section "The Connection Service File" in the
7091 B<PostgreSQL Documentation> for details.
7092
7093 =item B<Query> I<query>
7094
7095 Specifies a I<query> which should be executed in the context of the database
7096 connection. This may be any of the predefined or user-defined queries. If no
7097 such option is given, it defaults to "backends", "transactions", "queries",
7098 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
7099 has been specified). Else, the specified queries are used only.
7100
7101 =item B<Writer> I<writer>
7102
7103 Assigns the specified I<writer> backend to the database connection. This
7104 causes all collected data to be send to the database using the settings
7105 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7106 below for details on how to selectively send data to certain plugins).
7107
7108 Each writer will register a flush callback which may be used when having long
7109 transactions enabled (see the B<CommitInterval> option above). When issuing
7110 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7111 transaction will be committed right away. Two different kinds of flush
7112 callbacks are available with the C<postgresql> plugin:
7113
7114 =over 4
7115
7116 =item B<postgresql>
7117
7118 Flush all writer backends.
7119
7120 =item B<postgresql->I<database>
7121
7122 Flush all writers of the specified I<database> only.
7123
7124 =back
7125
7126 =back
7127
7128 =head2 Plugin C<powerdns>
7129
7130 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7131 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7132 values, many of which are probably meaningless to most users, but may be useful
7133 for some. So you may chose which values to collect, but if you don't, some
7134 reasonable defaults will be collected.
7135
7136   <Plugin "powerdns">
7137     <Server "server_name">
7138       Collect "latency"
7139       Collect "udp-answers" "udp-queries"
7140       Socket "/var/run/pdns.controlsocket"
7141     </Server>
7142     <Recursor "recursor_name">
7143       Collect "questions"
7144       Collect "cache-hits" "cache-misses"
7145       Socket "/var/run/pdns_recursor.controlsocket"
7146     </Recursor>
7147     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7148   </Plugin>
7149
7150 =over 4
7151
7152 =item B<Server> and B<Recursor> block
7153
7154 The B<Server> block defines one authoritative server to query, the B<Recursor>
7155 does the same for an recursing server. The possible options in both blocks are
7156 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7157 and is required.
7158
7159 =over 4
7160
7161 =item B<Collect> I<Field>
7162
7163 Using the B<Collect> statement you can select which values to collect. Here,
7164 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7165 C<dlg-only-drops>, C<answers10-100>.
7166
7167 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7168 When querying the server a C<SHOW *> command is issued in any case, because
7169 that's the only way of getting multiple values out of the server at once.
7170 collectd then picks out the values you have selected. When querying the
7171 recursor, a command is generated to query exactly these values. So if you
7172 specify invalid fields when querying the recursor, a syntax error may be
7173 returned by the daemon and collectd may not collect any values at all.
7174
7175 If no B<Collect> statement is given, the following B<Server> values will be
7176 collected:
7177
7178 =over 4
7179
7180 =item latency
7181
7182 =item packetcache-hit
7183
7184 =item packetcache-miss
7185
7186 =item packetcache-size
7187
7188 =item query-cache-hit
7189
7190 =item query-cache-miss
7191
7192 =item recursing-answers
7193
7194 =item recursing-questions
7195
7196 =item tcp-answers
7197
7198 =item tcp-queries
7199
7200 =item udp-answers
7201
7202 =item udp-queries
7203
7204 =back
7205
7206 The following B<Recursor> values will be collected by default:
7207
7208 =over 4
7209
7210 =item noerror-answers
7211
7212 =item nxdomain-answers
7213
7214 =item servfail-answers
7215
7216 =item sys-msec
7217
7218 =item user-msec
7219
7220 =item qa-latency
7221
7222 =item cache-entries
7223
7224 =item cache-hits
7225
7226 =item cache-misses
7227
7228 =item questions
7229
7230 =back
7231
7232 Please note that up to that point collectd doesn't know what values are
7233 available on the server and values that are added do not need a change of the
7234 mechanism so far. However, the values must be mapped to collectd's naming
7235 scheme, which is done using a lookup table that lists all known values. If
7236 values are added in the future and collectd does not know about them, you will
7237 get an error much like this:
7238
7239   powerdns plugin: submit: Not found in lookup table: foobar = 42
7240
7241 In this case please file a bug report with the collectd team.
7242
7243 =item B<Socket> I<Path>
7244
7245 Configures the path to the UNIX domain socket to be used when connecting to the
7246 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7247 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7248 will be used for the recursor.
7249
7250 =back
7251
7252 =item B<LocalSocket> I<Path>
7253
7254 Querying the recursor is done using UDP. When using UDP over UNIX domain
7255 sockets, the client socket needs a name in the file system, too. You can set
7256 this local name to I<Path> using the B<LocalSocket> option. The default is
7257 C<I<prefix>/var/run/collectd-powerdns>.
7258
7259 =back
7260
7261 =head2 Plugin C<processes>
7262
7263 Collects information about processes of local system.
7264
7265 By default, with no process matches configured, only general statistics is
7266 collected: the number of processes in each state and fork rate.
7267
7268 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7269 These may also be a block in which further options may be specified.
7270
7271 The statistics collected for matched processes are:
7272  - size of the resident segment size (RSS)
7273  - user- and system-time used
7274  - number of processes
7275  - number of threads
7276  - number of open files (under Linux)
7277  - number of memory mapped files (under Linux)
7278  - io data (where available)
7279  - context switches (under Linux)
7280  - minor and major pagefaults
7281  - Delay Accounting information (Linux only, requires libmnl)
7282
7283 B<Synopsis:>
7284
7285  <Plugin processes>
7286    CollectFileDescriptor  true
7287    CollectContextSwitch   true
7288    CollectDelayAccounting false
7289    Process "name"
7290    ProcessMatch "name" "regex"
7291    <Process "collectd">
7292      CollectFileDescriptor  false
7293      CollectContextSwitch   false
7294      CollectDelayAccounting true
7295    </Process>
7296    <ProcessMatch "name" "regex">
7297      CollectFileDescriptor false
7298      CollectContextSwitch true
7299    </ProcessMatch>
7300  </Plugin>
7301
7302 =over 4
7303
7304 =item B<Process> I<Name>
7305
7306 Select more detailed statistics of processes matching this name.
7307
7308 Some platforms have a limit on the length of process names.
7309 I<Name> must stay below this limit.
7310
7311 =item B<ProcessMatch> I<name> I<regex>
7312
7313 Select more detailed statistics of processes matching the specified I<regex>
7314 (see L<regex(7)> for details). The statistics of all matching processes are
7315 summed up and dispatched to the daemon using the specified I<name> as an
7316 identifier. This allows one to "group" several processes together.
7317 I<name> must not contain slashes.
7318
7319 =item B<CollectContextSwitch> I<Boolean>
7320
7321 Collect the number of context switches for matched processes.
7322 Disabled by default.
7323
7324 =item B<CollectDelayAccounting> I<Boolean>
7325
7326 If enabled, collect Linux Delay Accounding information for matching processes.
7327 Delay Accounting provides the time processes wait for the CPU to become
7328 available, for I/O operations to finish, for pages to be swapped in and for
7329 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7330 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7331 Disabled by default.
7332
7333 This option is only available on Linux, requires the C<libmnl> library and
7334 requires the C<CAP_NET_ADMIN> capability at runtime.
7335
7336 =item B<CollectFileDescriptor> I<Boolean>
7337
7338 Collect number of file descriptors of matched processes.
7339 Disabled by default.
7340
7341 =item B<CollectMemoryMaps> I<Boolean>
7342
7343 Collect the number of memory mapped files of the process.
7344 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7345 the Linux kernel.
7346
7347 =back
7348
7349 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7350 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7351 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7352 reporting the corresponding processes only. Outside of B<Process> and
7353 B<ProcessMatch> blocks these options set the default value for subsequent
7354 matches.
7355
7356 =head2 Plugin C<protocols>
7357
7358 Collects a lot of information about various network protocols, such as I<IP>,
7359 I<TCP>, I<UDP>, etc.
7360
7361 Available configuration options:
7362
7363 =over 4
7364
7365 =item B<Value> I<Selector>
7366
7367 Selects whether or not to select a specific value. The string being matched is
7368 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7369 plugin instance and I<ValueName> will be used as type instance. An example of
7370 the string being used would be C<Tcp:RetransSegs>.
7371
7372 You can use regular expressions to match a large number of values with just one
7373 configuration option. To select all "extended" I<TCP> values, you could use the
7374 following statement:
7375
7376   Value "/^TcpExt:/"
7377
7378 Whether only matched values are selected or all matched values are ignored
7379 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7380 If no value is configured at all, all values will be selected.
7381
7382 See F</"IGNORELISTS"> for details.
7383
7384 =item B<IgnoreSelected> B<true>|B<false>
7385
7386 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7387 matching values will be ignored.
7388
7389 =back
7390
7391 =head2 Plugin C<python>
7392
7393 This plugin embeds a Python-interpreter into collectd and provides an interface
7394 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7395
7396 =head2 Plugin C<routeros>
7397
7398 The C<routeros> plugin connects to a device running I<RouterOS>, the
7399 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7400 I<librouteros> to connect and reads information about the interfaces and
7401 wireless connections of the device. The configuration supports querying
7402 multiple routers:
7403
7404   <Plugin "routeros">
7405     <Router>
7406       Host "router0.example.com"
7407       User "collectd"
7408       Password "secr3t"
7409       CollectInterface true
7410       CollectCPULoad true
7411       CollectMemory true
7412     </Router>
7413     <Router>
7414       Host "router1.example.com"
7415       User "collectd"
7416       Password "5ecret"
7417       CollectInterface true
7418       CollectRegistrationTable true
7419       CollectDF true
7420       CollectDisk true
7421       CollectHealth true
7422     </Router>
7423   </Plugin>
7424
7425 As you can see above, the configuration of the I<routeros> plugin consists of
7426 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7427 options are understood:
7428
7429 =over 4
7430
7431 =item B<Host> I<Host>
7432
7433 Hostname or IP-address of the router to connect to.
7434
7435 =item B<Port> I<Port>
7436
7437 Port name or port number used when connecting. If left unspecified, the default
7438 will be chosen by I<librouteros>, currently "8728". This option expects a
7439 string argument, even when a numeric port number is given.
7440
7441 =item B<User> I<User>
7442
7443 Use the user name I<User> to authenticate. Defaults to "admin".
7444
7445 =item B<Password> I<Password>
7446
7447 Set the password used to authenticate.
7448
7449 =item B<CollectInterface> B<true>|B<false>
7450
7451 When set to B<true>, interface statistics will be collected for all interfaces
7452 present on the device. Defaults to B<false>.
7453
7454 =item B<CollectRegistrationTable> B<true>|B<false>
7455
7456 When set to B<true>, information about wireless LAN connections will be
7457 collected. Defaults to B<false>.
7458
7459 =item B<CollectCPULoad> B<true>|B<false>
7460
7461 When set to B<true>, information about the CPU usage will be collected. The
7462 number is a dimensionless value where zero indicates no CPU usage at all.
7463 Defaults to B<false>.
7464
7465 =item B<CollectMemory> B<true>|B<false>
7466
7467 When enabled, the amount of used and free memory will be collected. How used
7468 memory is calculated is unknown, for example whether or not caches are counted
7469 as used space.
7470 Defaults to B<false>.
7471
7472 =item B<CollectDF> B<true>|B<false>
7473
7474 When enabled, the amount of used and free disk space will be collected.
7475 Defaults to B<false>.
7476
7477 =item B<CollectDisk> B<true>|B<false>
7478
7479 When enabled, the number of sectors written and bad blocks will be collected.
7480 Defaults to B<false>.
7481
7482 =item B<CollectHealth> B<true>|B<false>
7483
7484 When enabled, the health statistics will be collected. This includes the
7485 voltage and temperature on supported hardware.
7486 Defaults to B<false>.
7487
7488 =back
7489
7490 =head2 Plugin C<redis>
7491
7492 The I<Redis plugin> connects to one or more Redis servers, gathers
7493 information about each server's state and executes user-defined queries.
7494 For each server there is a I<Node> block which configures the connection
7495 parameters and set of user-defined queries for this node.
7496
7497   <Plugin redis>
7498     <Node "example">
7499         Host "localhost"
7500         Port "6379"
7501         #Socket "/var/run/redis/redis.sock"
7502         Timeout 2000
7503         ReportCommandStats false
7504         ReportCpuUsage true
7505         <Query "LLEN myqueue">
7506           #Database 0
7507           Type "queue_length"
7508           Instance "myqueue"
7509         </Query>
7510     </Node>
7511   </Plugin>
7512
7513 =over 4
7514
7515 =item B<Node> I<Nodename>
7516
7517 The B<Node> block identifies a new Redis node, that is a new Redis instance
7518 running in an specified host and port. The name for node is a canonical
7519 identifier which is used as I<plugin instance>. It is limited to
7520 128E<nbsp>characters in length.
7521
7522 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7523
7524 =item B<Host> I<Hostname>
7525
7526 The B<Host> option is the hostname or IP-address where the Redis instance is
7527 running on.
7528
7529 =item B<Port> I<Port>
7530
7531 The B<Port> option is the TCP port on which the Redis instance accepts
7532 connections. Either a service name of a port number may be given. Please note
7533 that numerical port numbers must be given as a string, too.
7534
7535 =item B<Socket> I<Path>
7536
7537 Connect to Redis using the UNIX domain socket at I<Path>. If this
7538 setting is given, the B<Hostname> and B<Port> settings are ignored.
7539
7540 =item B<Password> I<Password>
7541
7542 Use I<Password> to authenticate when connecting to I<Redis>.
7543
7544 =item B<Timeout> I<Milliseconds>
7545
7546 The B<Timeout> option set the socket timeout for node response. Since the Redis
7547 read function is blocking, you should keep this value as low as possible.
7548 It is expected what B<Timeout> values should be lower than B<Interval> defined
7549 globally.
7550
7551 Defaults to 2000 (2 seconds).
7552
7553 =item B<ReportCommandStats> B<false>|B<true>
7554
7555 Enables or disables reporting of statistics based on the command type, including
7556 rate of command calls and average CPU time consumed by command processing.
7557 Defaults to B<false>.
7558
7559 =item B<ReportCpuUsage> B<true>|B<false>
7560
7561 Enables or disables reporting of CPU consumption statistics.
7562 Defaults to B<true>.
7563
7564 =item B<Query> I<Querystring>
7565
7566 The B<Query> block identifies a query to execute against the redis server.
7567 There may be an arbitrary number of queries to execute. Each query should
7568 return single string or integer.
7569
7570 =item B<Type> I<Collectd type>
7571
7572 Within a query definition, a valid I<collectd type> to use as when submitting
7573 the result of the query. When not supplied, will default to B<gauge>.
7574
7575 Currently only types with one datasource are supported.
7576 See L<types.db(5)> for more details on types and their configuration.
7577
7578 =item B<Instance> I<Type instance>
7579
7580 Within a query definition, an optional type instance to use when submitting
7581 the result of the query. When not supplied will default to the escaped
7582 command, up to 128 chars.
7583
7584 =item B<Database> I<Index>
7585
7586 This index selects the Redis logical database to use for query. Defaults
7587 to C<0>.
7588
7589 =back
7590
7591 =head2 Plugin C<rrdcached>
7592
7593 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7594 to store values to RRD files in an efficient manner. The combination of the
7595 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7596 way the C<rrdtool> plugin works (see below). The added abstraction layer
7597 provides a number of benefits, though: Because the cache is not within
7598 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7599 restarted. This results in much shorter (if any) gaps in graphs, especially
7600 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7601 daemon so that it can flush values to disk automatically when needed. This
7602 allows one to integrate automated flushing of values into graphing solutions
7603 much more easily.
7604
7605 There are disadvantages, though: The daemon may reside on a different host, so
7606 it may not be possible for C<collectd> to create the appropriate RRD files
7607 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7608 different base directory, so relative paths may do weird stuff if you're not
7609 careful.
7610
7611 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7612 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7613 setting should be set to an absolute path, so that a changed base directory
7614 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7615
7616 =over 4
7617
7618 =item B<DaemonAddress> I<Address>
7619
7620 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7621 library. See L<rrdcached(1)> for details. Example:
7622
7623   <Plugin "rrdcached">
7624     DaemonAddress "unix:/var/run/rrdcached.sock"
7625   </Plugin>
7626
7627 =item B<DataDir> I<Directory>
7628
7629 Set the base directory in which the RRD files reside. If this is a relative
7630 path, it is relative to the working base directory of the C<rrdcached> daemon!
7631 Use of an absolute path is recommended.
7632
7633 =item B<CreateFiles> B<true>|B<false>
7634
7635 Enables or disables the creation of RRD files. If the daemon is not running
7636 locally, or B<DataDir> is set to a relative path, this will not work as
7637 expected. Default is B<true>.
7638
7639 =item B<CreateFilesAsync> B<false>|B<true>
7640
7641 When enabled, new RRD files are enabled asynchronously, using a separate thread
7642 that runs in the background. This prevents writes to block, which is a problem
7643 especially when many hundreds of files need to be created at once. However,
7644 since the purpose of creating the files asynchronously is I<not> to block until
7645 the file is available, values before the file is available will be discarded.
7646 When disabled (the default) files are created synchronously, blocking for a
7647 short while, while the file is being written.
7648
7649 =item B<StepSize> I<Seconds>
7650
7651 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7652 this setting is unset and the stepsize is set to the interval in which the data
7653 is collected. Do not use this option unless you absolutely have to for some
7654 reason. Setting this option may cause problems with the C<snmp plugin>, the
7655 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7656
7657 =item B<HeartBeat> I<Seconds>
7658
7659 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7660 in which case the heartbeat is set to twice the B<StepSize> which should equal
7661 the interval in which data is collected. Do not set this option unless you have
7662 a very good reason to do so.
7663
7664 =item B<RRARows> I<NumRows>
7665
7666 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7667 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7668 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7669 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7670 week, one month, and one year.
7671
7672 So for each timespan, it calculates how many PDPs need to be consolidated into
7673 one CDP by calculating:
7674   number of PDPs = timespan / (stepsize * rrarows)
7675
7676 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7677 default is 1200.
7678
7679 =item B<RRATimespan> I<Seconds>
7680
7681 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7682 more then one RRA. If this option is never used, the built-in default of (3600,
7683 86400, 604800, 2678400, 31622400) is used.
7684
7685 For more information on how RRA-sizes are calculated see B<RRARows> above.
7686
7687 =item B<XFF> I<Factor>
7688
7689 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7690 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7691 one (exclusive).
7692
7693 =item B<CollectStatistics> B<false>|B<true>
7694
7695 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7696 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7697
7698 Statistics are read via I<rrdcached>s socket using the STATS command.
7699 See L<rrdcached(1)> for details.
7700
7701 =back
7702
7703 =head2 Plugin C<rrdtool>
7704
7705 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7706 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7707 using these settings. If you don't want to dive into the depths of RRDtool, you
7708 can safely ignore these settings.
7709
7710 =over 4
7711
7712 =item B<DataDir> I<Directory>
7713
7714 Set the directory to store RRD files under. By default RRD files are generated
7715 beneath the daemon's working directory, i.e. the B<BaseDir>.
7716
7717 =item B<CreateFilesAsync> B<false>|B<true>
7718
7719 When enabled, new RRD files are enabled asynchronously, using a separate thread
7720 that runs in the background. This prevents writes to block, which is a problem
7721 especially when many hundreds of files need to be created at once. However,
7722 since the purpose of creating the files asynchronously is I<not> to block until
7723 the file is available, values before the file is available will be discarded.
7724 When disabled (the default) files are created synchronously, blocking for a
7725 short while, while the file is being written.
7726
7727 =item B<StepSize> I<Seconds>
7728
7729 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7730 this setting is unset and the stepsize is set to the interval in which the data
7731 is collected. Do not use this option unless you absolutely have to for some
7732 reason. Setting this option may cause problems with the C<snmp plugin>, the
7733 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7734
7735 =item B<HeartBeat> I<Seconds>
7736
7737 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7738 in which case the heartbeat is set to twice the B<StepSize> which should equal
7739 the interval in which data is collected. Do not set this option unless you have
7740 a very good reason to do so.
7741
7742 =item B<RRARows> I<NumRows>
7743
7744 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7745 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7746 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7747 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7748 week, one month, and one year.
7749
7750 So for each timespan, it calculates how many PDPs need to be consolidated into
7751 one CDP by calculating:
7752   number of PDPs = timespan / (stepsize * rrarows)
7753
7754 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7755 default is 1200.
7756
7757 =item B<RRATimespan> I<Seconds>
7758
7759 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7760 more then one RRA. If this option is never used, the built-in default of (3600,
7761 86400, 604800, 2678400, 31622400) is used.
7762
7763 For more information on how RRA-sizes are calculated see B<RRARows> above.
7764
7765 =item B<XFF> I<Factor>
7766
7767 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7768 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7769 one (exclusive).
7770
7771 =item B<CacheFlush> I<Seconds>
7772
7773 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7774 it writes all values for a certain RRD-file if the oldest value is older than
7775 (or equal to) the number of seconds specified by B<CacheTimeout>.
7776 That check happens on new values arriwal. If some RRD-file is not updated
7777 anymore for some reason (the computer was shut down, the network is broken,
7778 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7779 every I<Seconds> seconds the entire cache is searched for entries older than
7780 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7781 disk. Since scanning the entire cache is kind of expensive and does nothing
7782 under normal circumstances, this value should not be too small. 900 seconds
7783 might be a good value, though setting this to 7200 seconds doesn't normally
7784 do much harm either.
7785
7786 Defaults to 10x B<CacheTimeout>.
7787 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7788 above default is used.
7789
7790 =item B<CacheTimeout> I<Seconds>
7791
7792 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7793 save values in a cache, as described above. Writing multiple values at once
7794 reduces IO-operations and thus lessens the load produced by updating the files.
7795 The trade off is that the graphs kind of "drag behind" and that more memory is
7796 used.
7797
7798 =item B<WritesPerSecond> I<Updates>
7799
7800 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7801 will run serious performance problems. The B<CacheFlush> setting and the
7802 internal update queue assert that collectd continues to work just fine even
7803 under heavy load, but the system may become very unresponsive and slow. This is
7804 a problem especially if you create graphs from the RRD files on the same
7805 machine, for example using the C<graph.cgi> script included in the
7806 C<contrib/collection3/> directory.
7807
7808 This setting is designed for very large setups. Setting this option to a value
7809 between 25 and 80 updates per second, depending on your hardware, will leave
7810 the server responsive enough to draw graphs even while all the cached values
7811 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7812 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7813 written as fast as possible, so that web frontends have up to date data when
7814 generating graphs.
7815
7816 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7817 updates per second, writing all values to disk will take approximately
7818 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7819 "collection3" you'll end up with a responsive and fast system, up to date
7820 graphs and basically a "backup" of your values every hour.
7821
7822 =item B<RandomTimeout> I<Seconds>
7823
7824 When set, the actual timeout for each value is chosen randomly between
7825 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7826 intention is to avoid high load situations that appear when many values timeout
7827 at the same time. This is especially a problem shortly after the daemon starts,
7828 because all values were added to the internal cache at roughly the same time.
7829
7830 =back
7831
7832 =head2 Plugin C<sensors>
7833
7834 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7835 that all the needed modules have to be loaded and lm_sensors has to be
7836 configured (most likely by editing F</etc/sensors.conf>. Read
7837 L<sensors.conf(5)> for details.
7838
7839 The B<lm_sensors> homepage can be found at
7840 L<http://secure.netroedge.com/~lm78/>.
7841
7842 =over 4
7843
7844 =item B<SensorConfigFile> I<File>
7845
7846 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7847 the library's default will be used.
7848
7849 =item B<Sensor> I<chip-bus-address/type-feature>
7850
7851 Selects the name of the sensor which you want to collect or ignore, depending
7852 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7853 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7854 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7855
7856 See F</"IGNORELISTS"> for details.
7857
7858 =item B<IgnoreSelected> I<true>|I<false>
7859
7860 If no configuration if given, the B<sensors>-plugin will collect data from all
7861 sensors. This may not be practical, especially for uninteresting sensors.
7862 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7863 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7864 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7865 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7866 and all other sensors are collected.
7867
7868 =item B<UseLabels> I<true>|I<false>
7869
7870 Configures how sensor readings are reported. When set to I<true>, sensor
7871 readings are reported using their descriptive label (e.g. "VCore"). When set to
7872 I<false> (the default) the sensor name is used ("in0").
7873
7874 =back
7875
7876 =head2 Plugin C<sigrok>
7877
7878 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7879 supported by the L<sigrok|http://sigrok.org/> project.
7880
7881 B<Synopsis>
7882
7883  <Plugin sigrok>
7884    LogLevel 3
7885    <Device "AC Voltage">
7886       Driver "fluke-dmm"
7887       MinimumInterval 10
7888       Conn "/dev/ttyUSB2"
7889    </Device>
7890    <Device "Sound Level">
7891       Driver "cem-dt-885x"
7892       Conn "/dev/ttyUSB1"
7893    </Device>
7894  </Plugin>
7895
7896 =over 4
7897
7898 =item B<LogLevel> B<0-5>
7899
7900 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7901 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7902 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7903 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7904 their level, are always submitted to I<collectd> at its INFO log level.
7905
7906 =item E<lt>B<Device> I<Name>E<gt>
7907
7908 A sigrok-supported device, uniquely identified by this section's options. The
7909 I<Name> is passed to I<collectd> as the I<plugin instance>.
7910
7911 =item B<Driver> I<DriverName>
7912
7913 The sigrok driver to use for this device.
7914
7915 =item B<Conn> I<ConnectionSpec>
7916
7917 If the device cannot be auto-discovered, or more than one might be discovered
7918 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7919 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7920 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7921 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7922 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7923
7924 =item B<SerialComm> I<SerialSpec>
7925
7926 For serial devices with non-standard port settings, this option can be used
7927 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7928 This should not be necessary; drivers know how to communicate with devices they
7929 support.
7930
7931 =item B<MinimumInterval> I<Seconds>
7932
7933 Specifies the minimum time between measurement dispatches to I<collectd>, in
7934 seconds. Since some I<sigrok> supported devices can acquire measurements many
7935 times per second, it may be necessary to throttle these. For example, the
7936 I<RRD plugin> cannot process writes more than once per second.
7937
7938 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7939 device are always dispatched to I<collectd>. When throttled, unused
7940 measurements are discarded.
7941
7942 =back
7943
7944 =head2 Plugin C<smart>
7945
7946 The C<smart> plugin collects SMART information from physical
7947 disks. Values collectd include temperature, power cycle count, poweron
7948 time and bad sectors. Also, all SMART attributes are collected along
7949 with the normalized current value, the worst value, the threshold and
7950 a human readable value.
7951
7952 Using the following two options you can ignore some disks or configure the
7953 collection only of specific disks.
7954
7955 =over 4
7956
7957 =item B<Disk> I<Name>
7958
7959 Select the disk I<Name>. Whether it is collected or ignored depends on the
7960 B<IgnoreSelected> setting, see below. As with other plugins that use the
7961 daemon's ignorelist functionality, a string that starts and ends with a slash
7962 is interpreted as a regular expression. Examples:
7963
7964   Disk "sdd"
7965   Disk "/hda[34]/"
7966
7967 See F</"IGNORELISTS"> for details.
7968
7969 =item B<IgnoreSelected> B<true>|B<false>
7970
7971 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7972 statements, are ignored or if all other disks are ignored. The behavior
7973 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7974 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7975 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7976 is set to B<true>, all disks are collected B<except> the ones matched.
7977
7978 =item B<IgnoreSleepMode> B<true>|B<false>
7979
7980 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7981 This option disables the sleep mode check and allows the plugin to collect data
7982 from these disks anyway. This is useful in cases where libatasmart mistakenly
7983 reports disks as asleep because it has not been updated to incorporate support
7984 for newer idle states in the ATA spec.
7985
7986 =item B<UseSerial> B<true>|B<false>
7987
7988 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7989 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7990 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7991 storing data. This ensures that the data for a given disk will be kept together
7992 even if the kernel name changes.
7993
7994 =back
7995
7996 =head2 Plugin C<snmp>
7997
7998 Since the configuration of the C<snmp plugin> is a little more complicated than
7999 other plugins, its documentation has been moved to an own manpage,
8000 L<collectd-snmp(5)>. Please see there for details.
8001
8002 =head2 Plugin C<snmp_agent>
8003
8004 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
8005 from SNMP master agent and returns the data collected by read plugins.
8006 The I<snmp_agent> plugin handles requests only for OIDs specified in
8007 configuration file. To handle SNMP queries the plugin gets data from collectd
8008 and translates requested values from collectd's internal format to SNMP format.
8009 This plugin is a generic plugin and cannot work without configuration.
8010 For more details on AgentX subagent see
8011 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
8012
8013 B<Synopsis:>
8014
8015   <Plugin snmp_agent>
8016     <Data "memAvailReal">
8017       Plugin "memory"
8018       #PluginInstance "some"
8019       Type "memory"
8020       TypeInstance "free"
8021       OIDs "1.3.6.1.4.1.2021.4.6.0"
8022     </Data>
8023     <Table "ifTable">
8024       IndexOID "IF-MIB::ifIndex"
8025       SizeOID "IF-MIB::ifNumber"
8026       <Data "ifDescr">
8027         <IndexKey>
8028           Source "PluginInstance"
8029         </IndexKey>
8030         Plugin "interface"
8031         OIDs "IF-MIB::ifDescr"
8032       </Data>
8033       <Data "ifOctets">
8034         Plugin "interface"
8035         Type "if_octets"
8036         TypeInstance ""
8037         OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
8038       </Data>
8039     </Table>
8040     <Table "CPUAffinityTable">
8041       <Data "DomainName">
8042         <IndexKey>
8043           Source "PluginInstance"
8044         </IndexKey>
8045         Plugin "virt"
8046         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
8047       </Data>
8048       <Data "VCPU">
8049         Plugin "virt"
8050         <IndexKey>
8051           Source "TypeInstance"
8052           Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
8053           Group 1
8054         </IndexKey>
8055         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
8056       </Data>
8057       <Data "CPU">
8058         Plugin "virt"
8059         <IndexKey>
8060           Source "TypeInstance"
8061           Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
8062           Group 1
8063         </IndexKey>
8064         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
8065       </Data>
8066       <Data "CPUAffinity">
8067         Plugin "virt"
8068         Type "cpu_affinity"
8069         OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
8070       </Data>
8071     </Table>
8072   </Plugin>
8073
8074 There are two types of blocks that can be contained in the
8075 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
8076
8077 =head3 B<Data> block
8078
8079 The B<Data> block defines a list OIDs that are to be handled. This block can
8080 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
8081 block it reperesents table OIDs.
8082 The following options can be set:
8083
8084 =over 4
8085
8086 =item B<IndexKey> block
8087
8088 B<IndexKey> block contains all data needed for proper index build of snmp table.
8089 In case more than
8090 one table B<Data> block has B<IndexKey> block present then multiple key index is
8091 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
8092 be omitted.
8093
8094 =over 8
8095
8096 =item B<Source> I<String>
8097
8098 B<Source> can be set to one of the following values: "Hostname", "Plugin",
8099 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
8100 corresponding collectd metric is taken as a SNMP table index.
8101
8102 =item B<Regex> I<String>
8103
8104 B<Regex> option can also be used to parse strings or numbers out of
8105 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8106 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8107 as a table index.
8108
8109 =item B<Group> I<Number>
8110
8111 B<Group> number can be specified in case groups are used in regex.
8112
8113 =back
8114
8115 =item B<Plugin> I<String>
8116
8117 Read plugin name whose collected data will be mapped to specified OIDs.
8118
8119 =item B<PluginInstance> I<String>
8120
8121 Read plugin instance whose collected data will be mapped to specified OIDs.
8122 The field is optional and by default there is no plugin instance check.
8123 Allowed only if B<Data> block defines scalar data type.
8124
8125 =item B<Type> I<String>
8126
8127 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8128 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8129
8130 =item B<TypeInstance> I<String>
8131
8132 Collectd's type-instance that is to be used for specified OID.
8133
8134 =item B<OIDs> I<OID> [I<OID> ...]
8135
8136 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8137 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8138 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8139 configured should correspond to number of values in specified B<Type>.
8140 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8141 "rx" and "tx" values of "if_octets" type.
8142
8143 =item B<Scale> I<Value>
8144
8145 The values taken from collectd are multiplied by I<Value>. The field is optional
8146 and the default is B<1.0>.
8147
8148 =item B<Shift> I<Value>
8149
8150 I<Value> is added to values from collectd after they have been multiplied by
8151 B<Scale> value. The field is optional and the default value is B<0.0>.
8152
8153 =back
8154
8155 =head3 The B<Table> block
8156
8157 The B<Table> block defines a collection of B<Data> blocks that belong to one
8158 snmp table. In addition to multiple B<Data> blocks the following options can be
8159 set:
8160
8161 =over 4
8162
8163 =item B<IndexOID> I<OID>
8164
8165 OID that is handled by the plugin and is mapped to numerical index value that is
8166 generated by the plugin for each table record.
8167
8168 =item B<SizeOID> I<OID>
8169
8170 OID that is handled by the plugin. Returned value is the number of records in
8171 the table. The field is optional.
8172
8173 =back
8174
8175 =head2 Plugin C<statsd>
8176
8177 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8178 protocol and dispatches rates or other aggregates of these numbers
8179 periodically.
8180
8181 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8182 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8183 C<objects> respectively.
8184
8185 The following configuration options are valid:
8186
8187 =over 4
8188
8189 =item B<Host> I<Host>
8190
8191 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8192 "any" address, i.e. accept packets sent to any of the hosts addresses.
8193
8194 =item B<Port> I<Port>
8195
8196 UDP port to listen to. This can be either a service name or a port number.
8197 Defaults to C<8125>.
8198
8199 =item B<DeleteCounters> B<false>|B<true>
8200
8201 =item B<DeleteTimers> B<false>|B<true>
8202
8203 =item B<DeleteGauges> B<false>|B<true>
8204
8205 =item B<DeleteSets> B<false>|B<true>
8206
8207 These options control what happens if metrics are not updated in an interval.
8208 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8209 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8210 are unchanged. If set to B<True>, the such metrics are not dispatched and
8211 removed from the internal cache.
8212
8213 =item B<CounterSum> B<false>|B<true>
8214
8215 When enabled, creates a C<count> metric which reports the change since the last
8216 read. This option primarily exists for compatibility with the I<statsd>
8217 implementation by Etsy.
8218
8219 =item B<TimerPercentile> I<Percent>
8220
8221 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8222 that I<Percent> of all reported timers are smaller than or equal to the
8223 computed latency. This is useful for cutting off the long tail latency, as it's
8224 often done in I<Service Level Agreements> (SLAs).
8225
8226 Different percentiles can be calculated by setting this option several times.
8227 If none are specified, no percentiles are calculated / dispatched.
8228
8229 =item B<TimerLower> B<false>|B<true>
8230
8231 =item B<TimerUpper> B<false>|B<true>
8232
8233 =item B<TimerSum> B<false>|B<true>
8234
8235 =item B<TimerCount> B<false>|B<true>
8236
8237 Calculate and dispatch various values out of I<Timer> metrics received during
8238 an interval. If set to B<False>, the default, these values aren't calculated /
8239 dispatched.
8240
8241 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8242
8243 =back
8244
8245 =head2 Plugin C<swap>
8246
8247 The I<Swap plugin> collects information about used and available swap space. On
8248 I<Linux> and I<Solaris>, the following options are available:
8249
8250 =over 4
8251
8252 =item B<ReportByDevice> B<false>|B<true>
8253
8254 Configures how to report physical swap devices. If set to B<false> (the
8255 default), the summary over all swap devices is reported only, i.e. the globally
8256 used and available space over all devices. If B<true> is configured, the used
8257 and available space of each device will be reported separately.
8258
8259 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8260 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8261
8262 =item B<ReportBytes> B<false>|B<true>
8263
8264 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8265 I<swap I/O> is reported in pages. This option is available under Linux only.
8266
8267 =item B<ValuesAbsolute> B<true>|B<false>
8268
8269 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8270 available and used. Defaults to B<true>.
8271
8272 =item B<ValuesPercentage> B<false>|B<true>
8273
8274 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8275 available and free. Defaults to B<false>.
8276
8277 This is useful for deploying I<collectd> in a heterogeneous environment, where
8278 swap sizes differ and you want to specify generic thresholds or similar.
8279
8280 =item B<ReportIO> B<true>|B<false>
8281
8282 Enables or disables reporting swap IO. Defaults to B<true>.
8283
8284 This is useful for the cases when swap IO is not neccessary, is not available,
8285 or is not reliable.
8286
8287 =back
8288
8289 =head2 Plugin C<sysevent>
8290
8291 The I<sysevent> plugin monitors rsyslog messages.
8292
8293 B<Synopsis:>
8294
8295   <Plugin sysevent>
8296     Listen "192.168.0.2" "6666"
8297     BufferSize 1024
8298     BufferLength 10
8299     RegexFilter "regex"
8300   </Plugin>
8301
8302   rsyslog should be configured such that it sends data to the IP and port you
8303   include in the plugin configuration.  For example, given the configuration
8304   above, something like this would be set in /etc/rsyslog.conf:
8305
8306     if $programname != 'collectd' then
8307     *.* @192.168.0.2:6666
8308
8309   This plugin is designed to consume JSON rsyslog data, so a more complete
8310   rsyslog configuration would look like so (where we define a JSON template
8311   and use it when sending data to our IP and port):
8312
8313     $template ls_json,"{%timestamp:::date-rfc3339,jsonf:@timestamp%, \
8314     %source:::jsonf:@source_host%,\"@source\":\"syslog://%fromhost-ip:::json%\", \
8315     \"@message\":\"%timestamp% %app-name%:%msg:::json%\",\"@fields\": \
8316     {%syslogfacility-text:::jsonf:facility%,%syslogseverity:::jsonf:severity-num%, \
8317     %syslogseverity-text:::jsonf:severity%,%programname:::jsonf:program%, \
8318     %procid:::jsonf:processid%}}"
8319
8320     if $programname != 'collectd' then
8321     *.* @192.168.0.2:6666;ls_json
8322
8323   Please note that these rsyslog.conf examples are *not* complete, as rsyslog
8324   requires more than these options in the configuration file.  These examples
8325   are meant to demonstration the proper remote logging and JSON format syntax.
8326
8327 B<Options:>
8328
8329 =over 4
8330
8331 =item B<Listen> I<host> I<port>
8332
8333 Listen on this IP on this port for incoming rsyslog messages.
8334
8335 =item B<BufferSize> I<length>
8336
8337 Maximum allowed size for incoming rsyslog messages.  Messages that exceed
8338 this number will be truncated to this size.  Default is 4096 bytes.
8339
8340 =item B<BufferLength> I<length>
8341
8342 Maximum number of rsyslog events that can be stored in plugin's ring buffer.
8343 By default, this is set to 10.  Once an event has been read, its location
8344 becomes available for storing a new event.
8345
8346 =item B<RegexFilter> I<regex>
8347
8348 Enumerate a regex filter to apply to all incoming rsyslog messages.  If a
8349 message matches this filter, it will be published.
8350
8351 =back
8352
8353 =head2 Plugin C<syslog>
8354
8355 =over 4
8356
8357 =item B<LogLevel> B<debug|info|notice|warning|err>
8358
8359 Sets the log-level. If, for example, set to B<notice>, then all events with
8360 severity B<notice>, B<warning>, or B<err> will be submitted to the
8361 syslog-daemon.
8362
8363 Please note that B<debug> is only available if collectd has been compiled with
8364 debugging support.
8365
8366 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8367
8368 Controls which notifications should be sent to syslog. The default behaviour is
8369 not to send any. Less severe notifications always imply logging more severe
8370 notifications: Setting this to B<OKAY> means all notifications will be sent to
8371 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8372 notifications but will dismiss B<OKAY> notifications. Setting this option to
8373 B<FAILURE> will only send failures to syslog.
8374
8375 =back
8376
8377 =head2 Plugin C<table>
8378
8379 The C<table plugin> provides generic means to parse tabular data and dispatch
8380 user specified values. Values are selected based on column numbers. For
8381 example, this plugin may be used to get values from the Linux L<proc(5)>
8382 filesystem or CSV (comma separated values) files.
8383
8384   <Plugin table>
8385     <Table "/proc/slabinfo">
8386       #Plugin "slab"
8387       Instance "slabinfo"
8388       Separator " "
8389       <Result>
8390         Type gauge
8391         InstancePrefix "active_objs"
8392         InstancesFrom 0
8393         ValuesFrom 1
8394       </Result>
8395       <Result>
8396         Type gauge
8397         InstancePrefix "objperslab"
8398         InstancesFrom 0
8399         ValuesFrom 4
8400       </Result>
8401     </Table>
8402   </Plugin>
8403
8404 The configuration consists of one or more B<Table> blocks, each of which
8405 configures one file to parse. Within each B<Table> block, there are one or
8406 more B<Result> blocks, which configure which data to select and how to
8407 interpret it.
8408
8409 The following options are available inside a B<Table> block:
8410
8411 =over 4
8412
8413 =item B<Plugin> I<Plugin>
8414
8415 If specified, I<Plugin> is used as the plugin name when submitting values.
8416 Defaults to B<table>.
8417
8418 =item B<Instance> I<instance>
8419
8420 If specified, I<instance> is used as the plugin instance. If omitted, the
8421 filename of the table is used instead, with all special characters replaced
8422 with an underscore (C<_>).
8423
8424 =item B<Separator> I<string>
8425
8426 Any character of I<string> is interpreted as a delimiter between the different
8427 columns of the table. A sequence of two or more contiguous delimiters in the
8428 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8429 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8430 of a table - see its documentation for more details. This option is mandatory.
8431
8432 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8433 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8434 required because of collectd's config parsing.
8435
8436 =back
8437
8438 The following options are available inside a B<Result> block:
8439
8440 =over 4
8441
8442 =item B<Type> I<type>
8443
8444 Sets the type used to dispatch the values to the daemon. Detailed information
8445 about types and their configuration can be found in L<types.db(5)>. This
8446 option is mandatory.
8447
8448 =item B<InstancePrefix> I<prefix>
8449
8450 If specified, prepend I<prefix> to the type instance. If omitted, only the
8451 B<InstancesFrom> option is considered for the type instance.
8452
8453 =item B<InstancesFrom> I<column0> [I<column1> ...]
8454
8455 If specified, the content of the given columns (identified by the column
8456 number starting at zero) will be used to create the type instance for each
8457 row. Multiple values (and the instance prefix) will be joined together with
8458 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8459 option is considered for the type instance.
8460
8461 The plugin itself does not check whether or not all built instances are
8462 different. It’s your responsibility to assure that each is unique. This is
8463 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8464 sure that the table only contains one row.
8465
8466 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8467 will be empty.
8468
8469 =item B<ValuesFrom> I<column0> [I<column1> ...]
8470
8471 Specifies the columns (identified by the column numbers starting at zero)
8472 whose content is used as the actual data for the data sets that are dispatched
8473 to the daemon. How many such columns you need is determined by the B<Type>
8474 setting above. If you specify too many or not enough columns, the plugin will
8475 complain about that and no data will be submitted to the daemon. The plugin
8476 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8477 respectively, so anything supported by those functions is supported by the
8478 plugin as well. This option is mandatory.
8479
8480 =back
8481
8482 =head2 Plugin C<tail>
8483
8484 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8485 each line and dispatches found values. What is matched can be configured by the
8486 user using (extended) regular expressions, as described in L<regex(7)>.
8487
8488   <Plugin "tail">
8489     <File "/var/log/exim4/mainlog">
8490       Plugin "mail"
8491       Instance "exim"
8492       Interval 60
8493       <Match>
8494         Regex "S=([1-9][0-9]*)"
8495         DSType "CounterAdd"
8496         Type "ipt_bytes"
8497         Instance "total"
8498       </Match>
8499       <Match>
8500         Regex "\\<R=local_user\\>"
8501         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8502         DSType "CounterInc"
8503         Type "counter"
8504         Instance "local_user"
8505       </Match>
8506       <Match>
8507         Regex "l=([0-9]*\\.[0-9]*)"
8508         <DSType "Distribution">
8509           Percentile 99
8510           Bucket 0 100
8511           #BucketType "bucket"
8512         </DSType>
8513         Type "latency"
8514         Instance "foo"
8515       </Match>
8516     </File>
8517   </Plugin>
8518
8519 The config consists of one or more B<File> blocks, each of which configures one
8520 logfile to parse. Within each B<File> block, there are one or more B<Match>
8521 blocks, which configure a regular expression to search for.
8522
8523 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8524 the plugin name and instance respectively. So in the above example the plugin name
8525 C<mail-exim> would be used.
8526
8527 These options are applied for all B<Match> blocks that B<follow> it, until the
8528 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8529 instances from one logfile, handy when parsing syslog and the like.
8530
8531 The B<Interval> option allows you to define the length of time between reads. If
8532 this is not set, the default Interval will be used.
8533
8534 Each B<Match> block has the following options to describe how the match should
8535 be performed:
8536
8537 =over 4
8538
8539 =item B<Regex> I<regex>
8540
8541 Sets the regular expression to use for matching against a line. The first
8542 subexpression has to match something that can be turned into a number by
8543 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8544 below. Because B<extended> regular expressions are used, you do not need to use
8545 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8546 collectd's config parsing you need to escape backslashes, though. So if you
8547 want to match literal parentheses you need to do the following:
8548
8549   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8550
8551 =item B<ExcludeRegex> I<regex>
8552
8553 Sets an optional regular expression to use for excluding lines from the match.
8554 An example which excludes all connections from localhost from the match:
8555
8556   ExcludeRegex "127\\.0\\.0\\.1"
8557
8558 =item B<DSType> I<Type>
8559
8560 Sets how the values are cumulated. I<Type> is one of:
8561
8562 =over 4
8563
8564 =item B<GaugeAverage>
8565
8566 Calculate the average of all values matched during the interval.
8567
8568 =item B<GaugeMin>
8569
8570 Report the smallest value matched during the interval.
8571
8572 =item B<GaugeMax>
8573
8574 Report the greatest value matched during the interval.
8575
8576 =item B<GaugeLast>
8577
8578 Report the last value matched during the interval.
8579
8580 =item B<GaugePersist>
8581
8582 Report the last matching value. The metric is I<not> reset to C<NaN> at the end
8583 of an interval. It is continuously reported until another value is matched.
8584 This is intended for cases in which only state changes are reported, for
8585 example a thermometer that only reports the temperature when it changes.
8586
8587 =item B<CounterSet>
8588
8589 =item B<DeriveSet>
8590
8591 =item B<AbsoluteSet>
8592
8593 The matched number is a counter. Simply I<sets> the internal counter to this
8594 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8595
8596 =item B<GaugeAdd>
8597
8598 =item B<CounterAdd>
8599
8600 =item B<DeriveAdd>
8601
8602 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8603 matched number may be negative, which will effectively subtract from the
8604 internal counter.
8605
8606 =item B<GaugeInc>
8607
8608 =item B<CounterInc>
8609
8610 =item B<DeriveInc>
8611
8612 Increase the internal counter by one. These B<DSType> are the only ones that do
8613 not use the matched subexpression, but simply count the number of matched
8614 lines. Thus, you may use a regular expression without submatch in this case.
8615
8616 B<GaugeInc> is reset to I<zero> after every read, unlike other B<Gauge*>
8617 metrics which are reset to C<NaN>.
8618
8619 =item B<Distribution>
8620
8621 Type to do calculations based on the distribution of values, primarily
8622 calculating percentiles. This is primarily geared towards latency, but can be
8623 used for other metrics as well. The range of values tracked with this setting
8624 must be in the range (0–2^34) and can be fractional. Please note that neither
8625 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8626 distribution.
8627
8628 This option must be used together with the B<Percentile> and/or B<Bucket>
8629 options.
8630
8631 B<Synopsis:>
8632
8633   <DSType "Distribution">
8634     Percentile 99
8635     Bucket 0 100
8636     BucketType "bucket"
8637   </DSType>
8638
8639 =over 4
8640
8641 =item B<Percentile> I<Percent>
8642
8643 Calculate and dispatch the configured percentile, i.e. compute the value, so
8644 that I<Percent> of all matched values are smaller than or equal to the computed
8645 latency.
8646
8647 Metrics are reported with the I<type> B<Type> (the value of the above option)
8648 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8649
8650 This option may be repeated to calculate more than one percentile.
8651
8652 =item B<Bucket> I<lower_bound> I<upper_bound>
8653
8654 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8655 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8656 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8657 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8658 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8659 lower/upper bound.
8660
8661 To export the entire (0–inf) range without overlap, use the upper bound of the
8662 previous range as the lower bound of the following range. In other words, use
8663 the following schema:
8664
8665   Bucket   0   1
8666   Bucket   1   2
8667   Bucket   2   5
8668   Bucket   5  10
8669   Bucket  10  20
8670   Bucket  20  50
8671   Bucket  50   0
8672
8673 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8674 by default) and the I<type instance>
8675 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8676
8677 This option may be repeated to calculate more than one rate.
8678
8679 =item B<BucketType> I<Type>
8680
8681 Sets the type used to dispatch B<Bucket> metrics.
8682 Optional, by default C<bucket> will be used.
8683
8684 =back
8685
8686 =back
8687
8688 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8689 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8690 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8691 B<Derive*> types interpret the submatch as a signed integer using
8692 L<strtoll(3)>. B<CounterInc>, B<DeriveInc> and B<GaugeInc> do not use the
8693 submatch at all and it may be omitted in this case.
8694
8695 The B<Gauge*> types, unless noted otherwise, are reset to C<NaN> after being
8696 reported. In other words, B<GaugeAverage> reports the average of all values
8697 matched since the last metric was reported (or C<NaN> if there was no match).
8698
8699 =item B<Type> I<Type>
8700
8701 Sets the type used to dispatch this value. Detailed information about types and
8702 their configuration can be found in L<types.db(5)>.
8703
8704 =item B<Instance> I<TypeInstance>
8705
8706 This optional setting sets the type instance to use.
8707
8708 =back
8709
8710 =head2 Plugin C<tail_csv>
8711
8712 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8713 written by I<Snort>.
8714
8715 B<Synopsis:>
8716
8717  <Plugin "tail_csv">
8718    <Metric "snort-dropped">
8719        Type "percent"
8720        Instance "dropped"
8721        ValueFrom 1
8722    </Metric>
8723    <File "/var/log/snort/snort.stats">
8724        Plugin "snortstats"
8725        Instance "eth0"
8726        Interval 600
8727        Collect "snort-dropped"
8728        #TimeFrom 0
8729    </File>
8730  </Plugin>
8731
8732 The configuration consists of one or more B<Metric> blocks that define an index
8733 into the line of the CSV file and how this value is mapped to I<collectd's>
8734 internal representation. These are followed by one or more B<Instance> blocks
8735 which configure which file to read, in which interval and which metrics to
8736 extract.
8737
8738 =over 4
8739
8740 =item E<lt>B<Metric> I<Name>E<gt>
8741
8742 The B<Metric> block configures a new metric to be extracted from the statistics
8743 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8744 only used inside the B<Instance> blocks to refer to this block, so you can use
8745 one B<Metric> block for multiple CSV files.
8746
8747 =over 4
8748
8749 =item B<Type> I<Type>
8750
8751 Configures which I<Type> to use when dispatching this metric. Types are defined
8752 in the L<types.db(5)> file, see the appropriate manual page for more
8753 information on specifying types. Only types with a single I<data source> are
8754 supported by the I<tail_csv plugin>. The information whether the value is an
8755 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8756 I<Type's> definition.
8757
8758 =item B<Instance> I<TypeInstance>
8759
8760 If set, I<TypeInstance> is used to populate the type instance field of the
8761 created value lists. Otherwise, no type instance is used.
8762
8763 =item B<ValueFrom> I<Index>
8764
8765 Configure to read the value from the field with the zero-based index I<Index>.
8766 If the value is parsed as signed integer, unsigned integer or double depends on
8767 the B<Type> setting, see above.
8768
8769 =back
8770
8771 =item E<lt>B<File> I<Path>E<gt>
8772
8773 Each B<File> block represents one CSV file to read. There must be at least one
8774 I<File> block but there can be multiple if you have multiple CSV files.
8775
8776 =over 4
8777
8778 =item B<Plugin> I<Plugin>
8779
8780 Use I<Plugin> as the plugin name when submitting values.
8781 Defaults to C<tail_csv>.
8782
8783 =item B<Instance> I<PluginInstance>
8784
8785 Sets the I<plugin instance> used when dispatching the values.
8786
8787 =item B<Collect> I<Metric>
8788
8789 Specifies which I<Metric> to collect. This option must be specified at least
8790 once, and you can use this option multiple times to specify more than one
8791 metric to be extracted from this statistic file.
8792
8793 =item B<Interval> I<Seconds>
8794
8795 Configures the interval in which to read values from this instance / file.
8796 Defaults to the plugin's default interval.
8797
8798 =item B<TimeFrom> I<Index>
8799
8800 Rather than using the local time when dispatching a value, read the timestamp
8801 from the field with the zero-based index I<Index>. The value is interpreted as
8802 seconds since epoch. The value is parsed as a double and may be factional.
8803
8804 =back
8805
8806 =back
8807
8808 =head2 Plugin C<teamspeak2>
8809
8810 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8811 polls interesting global and virtual server data. The plugin can query only one
8812 physical server but unlimited virtual servers. You can use the following
8813 options to configure it:
8814
8815 =over 4
8816
8817 =item B<Host> I<hostname/ip>
8818
8819 The hostname or ip which identifies the physical server.
8820 Default: 127.0.0.1
8821
8822 =item B<Port> I<port>
8823
8824 The query port of the physical server. This needs to be a string.
8825 Default: "51234"
8826
8827 =item B<Server> I<port>
8828
8829 This option has to be added once for every virtual server the plugin should
8830 query. If you want to query the virtual server on port 8767 this is what the
8831 option would look like:
8832
8833   Server "8767"
8834
8835 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8836 use quotes around it! If no such statement is given only global information
8837 will be collected.
8838
8839 =back
8840
8841 =head2 Plugin C<ted>
8842
8843 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8844 measure power consumption. These devices are usually connected to a serial
8845 (RS232) or USB port. The plugin opens a configured device and tries to read the
8846 current energy readings. For more information on TED, visit
8847 L<http://www.theenergydetective.com/>.
8848
8849 Available configuration options:
8850
8851 =over 4
8852
8853 =item B<Device> I<Path>
8854
8855 Path to the device on which TED is connected. collectd will need read and write
8856 permissions on that file.
8857
8858 Default: B</dev/ttyUSB0>
8859
8860 =item B<Retries> I<Num>
8861
8862 Apparently reading from TED is not that reliable. You can therefore configure a
8863 number of retries here. You only configure the I<retries> here, to if you
8864 specify zero, one reading will be performed (but no retries if that fails); if
8865 you specify three, a maximum of four readings are performed. Negative values
8866 are illegal.
8867
8868 Default: B<0>
8869
8870 =back
8871
8872 =head2 Plugin C<tcpconns>
8873
8874 The C<tcpconns plugin> counts the number of currently established TCP
8875 connections based on the local port and/or the remote port. Since there may be
8876 a lot of connections the default if to count all connections with a local port,
8877 for which a listening socket is opened. You can use the following options to
8878 fine-tune the ports you are interested in:
8879
8880 =over 4
8881
8882 =item B<ListeningPorts> I<true>|I<false>
8883
8884 If this option is set to I<true>, statistics for all local ports for which a
8885 listening socket exists are collected. The default depends on B<LocalPort> and
8886 B<RemotePort> (see below): If no port at all is specifically selected, the
8887 default is to collect listening ports. If specific ports (no matter if local or
8888 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8889 the selected ports will be collected unless this option is set to I<true>
8890 specifically.
8891
8892 =item B<LocalPort> I<Port>
8893
8894 Count the connections to a specific local port. This can be used to see how
8895 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8896 You have to specify the port in numeric form, so for the mailserver example
8897 you'd need to set B<25>.
8898
8899 =item B<RemotePort> I<Port>
8900
8901 Count the connections to a specific remote port. This is useful to see how
8902 much a remote service is used. This is most useful if you want to know how many
8903 connections a local service has opened to remote services, e.E<nbsp>g. how many
8904 connections a mail server or news server has to other mail or news servers, or
8905 how many connections a web proxy holds to web servers. You have to give the
8906 port in numeric form.
8907
8908 =item B<AllPortsSummary> I<true>|I<false>
8909
8910 If this option is set to I<true> a summary of statistics from all connections
8911 are collected. This option defaults to I<false>.
8912
8913 =back
8914
8915 =head2 Plugin C<thermal>
8916
8917 =over 4
8918
8919 =item B<ForceUseProcfs> I<true>|I<false>
8920
8921 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8922 C<sysfs> interface. If that is not available, the plugin falls back to the
8923 C<procfs> interface. By setting this option to I<true>, you can force the
8924 plugin to use the latter. This option defaults to I<false>.
8925
8926 =item B<Device> I<Device>
8927
8928 Selects the name of the thermal device that you want to collect or ignore,
8929 depending on the value of the B<IgnoreSelected> option. This option may be
8930 used multiple times to specify a list of devices.
8931
8932 See F</"IGNORELISTS"> for details.
8933
8934 =item B<IgnoreSelected> I<true>|I<false>
8935
8936 Invert the selection: If set to true, all devices B<except> the ones that
8937 match the device names specified by the B<Device> option are collected. By
8938 default only selected devices are collected if a selection is made. If no
8939 selection is configured at all, B<all> devices are selected.
8940
8941 =back
8942
8943 =head2 Plugin C<threshold>
8944
8945 The I<Threshold plugin> checks values collected or received by I<collectd>
8946 against a configurable I<threshold> and issues I<notifications> if values are
8947 out of bounds.
8948
8949 Documentation for this plugin is available in the L<collectd-threshold(5)>
8950 manual page.
8951
8952 =head2 Plugin C<tokyotyrant>
8953
8954 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8955 couple metrics: number of records, and database size on disk.
8956
8957 =over 4
8958
8959 =item B<Host> I<Hostname/IP>
8960
8961 The hostname or IP which identifies the server.
8962 Default: B<127.0.0.1>
8963
8964 =item B<Port> I<Service/Port>
8965
8966 The query port of the server. This needs to be a string, even if the port is
8967 given in its numeric form.
8968 Default: B<1978>
8969
8970 =back
8971
8972 =head2 Plugin C<turbostat>
8973
8974 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8975 Intel processors by using I<Model Specific Registers>.
8976
8977 =over 4
8978
8979 =item B<CoreCstates> I<Bitmask(Integer)>
8980
8981 Bit mask of the list of core C-states supported by the processor.
8982 This option should only be used if the automated detection fails.
8983 Default value extracted from the CPU model and family.
8984
8985 Currently supported C-states (by this plugin): 3, 6, 7
8986
8987 B<Example:>
8988
8989   All states (3, 6 and 7):
8990   (1<<3) + (1<<6) + (1<<7) = 392
8991
8992 =item B<PackageCstates> I<Bitmask(Integer)>
8993
8994 Bit mask of the list of packages C-states supported by the processor. This
8995 option should only be used if the automated detection fails. Default value
8996 extracted from the CPU model and family.
8997
8998 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8999
9000 B<Example:>
9001
9002   States 2, 3, 6 and 7:
9003   (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
9004
9005 =item B<SystemManagementInterrupt> I<true>|I<false>
9006
9007 Boolean enabling the collection of the I/O System-Management Interrupt counter.
9008 This option should only be used if the automated detection fails or if you want
9009 to disable this feature.
9010
9011 =item B<DigitalTemperatureSensor> I<true>|I<false>
9012
9013 Boolean enabling the collection of the temperature of each core. This option
9014 should only be used if the automated detection fails or if you want to disable
9015 this feature.
9016
9017 =item B<TCCActivationTemp> I<Temperature>
9018
9019 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
9020 temperature is used when collecting the temperature of cores or packages. This
9021 option should only be used if the automated detection fails. Default value
9022 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
9023
9024 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
9025
9026 Bit mask of the list of elements to be thermally monitored. This option should
9027 only be used if the automated detection fails or if you want to disable some
9028 collections. The different bits of this bit mask accepted by this plugin are:
9029
9030 =over 4
9031
9032 =item 0 ('1'): Package
9033
9034 =item 1 ('2'): DRAM
9035
9036 =item 2 ('4'): Cores
9037
9038 =item 3 ('8'): Embedded graphic device
9039
9040 =back
9041
9042 =item B<LogicalCoreNames> I<true>|I<false>
9043
9044 Boolean enabling the use of logical core numbering for per core statistics.
9045 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
9046 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
9047 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
9048 more than one, where I<n> is the n-th core of package I<m>.
9049
9050 =item B<RestoreAffinityPolicy> I<AllCPUs>|I<Restore>
9051
9052 Reading data from CPU has side-effect: collectd process's CPU affinity mask
9053 changes. After reading data is completed, affinity mask needs to be restored.
9054 This option allows to set restore policy.
9055
9056 B<AllCPUs> (the default): Restore the affinity by setting affinity to any/all
9057 CPUs.
9058
9059 B<Restore>: Save affinity using sched_getaffinity() before reading data and
9060 restore it after.
9061
9062 On some systems, sched_getaffinity() will fail due to inconsistency of the CPU
9063 set size between userspace and kernel. In these cases plugin will detect the
9064 unsuccessful call and fail with an error, preventing data collection.
9065 Most of configurations does not need to save affinity as Collectd process is
9066 allowed to run on any/all available CPUs.
9067
9068 If you need to save and restore affinity and get errors like 'Unable to save
9069 the CPU affinity', setting 'possible_cpus' kernel boot option may also help.
9070
9071 See following links for details:
9072
9073 L<https://github.com/collectd/collectd/issues/1593>
9074 L<https://sourceware.org/bugzilla/show_bug.cgi?id=15630>
9075 L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
9076
9077 =back
9078
9079 =head2 Plugin C<unixsock>
9080
9081 =over 4
9082
9083 =item B<SocketFile> I<Path>
9084
9085 Sets the socket-file which is to be created.
9086
9087 =item B<SocketGroup> I<Group>
9088
9089 If running as root change the group of the UNIX-socket after it has been
9090 created. Defaults to B<collectd>.
9091
9092 =item B<SocketPerms> I<Permissions>
9093
9094 Change the file permissions of the UNIX-socket after it has been created. The
9095 permissions must be given as a numeric, octal value as you would pass to
9096 L<chmod(1)>. Defaults to B<0770>.
9097
9098 =item B<DeleteSocket> B<false>|B<true>
9099
9100 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
9101 with the given name already exists. If I<collectd> crashes a socket file may be
9102 left over, preventing the daemon from opening a new socket when restarted.
9103 Since this is potentially dangerous, this defaults to B<false>.
9104
9105 =back
9106
9107 =head2 Plugin C<uuid>
9108
9109 This plugin, if loaded, causes the Hostname to be taken from the machine's
9110 UUID. The UUID is a universally unique designation for the machine, usually
9111 taken from the machine's BIOS. This is most useful if the machine is running in
9112 a virtual environment such as Xen, in which case the UUID is preserved across
9113 shutdowns and migration.
9114
9115 The following methods are used to find the machine's UUID, in order:
9116
9117 =over 4
9118
9119 =item *
9120
9121 Check I</etc/uuid> (or I<UUIDFile>).
9122
9123 =item *
9124
9125 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
9126 present.
9127
9128 =item *
9129
9130 Check for UUID from C<dmidecode> / SMBIOS.
9131
9132 =item *
9133
9134 Check for UUID from Xen hypervisor.
9135
9136 =back
9137
9138 If no UUID can be found then the hostname is not modified.
9139
9140 =over 4
9141
9142 =item B<UUIDFile> I<Path>
9143
9144 Take the UUID from the given file (default I</etc/uuid>).
9145
9146 =back
9147
9148 =head2 Plugin C<varnish>
9149
9150 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
9151 It collects a subset of the values displayed by L<varnishstat(1)>, and
9152 organizes them in categories which can be enabled or disabled. Currently only
9153 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
9154 meaning of each metric can be found in L<varnish-counters(7)>.
9155
9156 Synopsis:
9157
9158  <Plugin "varnish">
9159    <Instance "example">
9160      CollectBackend     true
9161      CollectBan         false
9162      CollectCache       true
9163      CollectConnections true
9164      CollectDirectorDNS false
9165      CollectESI         false
9166      CollectFetch       false
9167      CollectHCB         false
9168      CollectObjects     false
9169      CollectPurge       false
9170      CollectSession     false
9171      CollectSHM         true
9172      CollectSMA         false
9173      CollectSMS         false
9174      CollectSM          false
9175      CollectStruct      false
9176      CollectTotals      false
9177      CollectUptime      false
9178      CollectVCL         false
9179      CollectVSM         false
9180      CollectWorkers     false
9181      CollectLock        false
9182      CollectMempool     false
9183      CollectManagement  false
9184      CollectSMF         false
9185      CollectVBE         false
9186      CollectMSE         false
9187    </Instance>
9188  </Plugin>
9189
9190 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9191 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9192 will collectd statistics from the default "varnishd" instance (this should work
9193 fine in most cases).
9194
9195 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9196
9197 =over 4
9198
9199 =item B<CollectBackend> B<true>|B<false>
9200
9201 Back-end connection statistics, such as successful, reused,
9202 and closed connections. True by default.
9203
9204 =item B<CollectBan> B<true>|B<false>
9205
9206 Statistics about ban operations, such as number of bans added, retired, and
9207 number of objects tested against ban operations. Only available with Varnish
9208 3.x and above. False by default.
9209
9210 =item B<CollectCache> B<true>|B<false>
9211
9212 Cache hits and misses. True by default.
9213
9214 =item B<CollectConnections> B<true>|B<false>
9215
9216 Number of client connections received, accepted and dropped. True by default.
9217
9218 =item B<CollectDirectorDNS> B<true>|B<false>
9219
9220 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9221 default.
9222
9223 =item B<CollectESI> B<true>|B<false>
9224
9225 Edge Side Includes (ESI) parse statistics. False by default.
9226
9227 =item B<CollectFetch> B<true>|B<false>
9228
9229 Statistics about fetches (HTTP requests sent to the backend). False by default.
9230
9231 =item B<CollectHCB> B<true>|B<false>
9232
9233 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9234 divided into locked and unlocked look-ups. False by default.
9235
9236 =item B<CollectObjects> B<true>|B<false>
9237
9238 Statistics on cached objects: number of objects expired, nuked (prematurely
9239 expired), saved, moved, etc. False by default.
9240
9241 =item B<CollectPurge> B<true>|B<false>
9242
9243 Statistics about purge operations, such as number of purges added, retired, and
9244 number of objects tested against purge operations. Only available with Varnish
9245 2.x. False by default.
9246
9247 =item B<CollectSession> B<true>|B<false>
9248
9249 Client session statistics. Number of past and current sessions, session herd and
9250 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9251 metrics found in the Connections and Threads sections with previous versions of
9252 Varnish have been moved here.
9253
9254 =item B<CollectSHM> B<true>|B<false>
9255
9256 Statistics about the shared memory log, a memory region to store
9257 log messages which is flushed to disk when full. True by default.
9258
9259 =item B<CollectSMA> B<true>|B<false>
9260
9261 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9262 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9263 only the one used by the Varnish instance. Only available with Varnish 2.x.
9264 False by default.
9265
9266 =item B<CollectSMS> B<true>|B<false>
9267
9268 synth (synthetic content) storage statistics. This storage
9269 component is used internally only. False by default.
9270
9271 =item B<CollectSM> B<true>|B<false>
9272
9273 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9274 in varnish 4.x. use CollectSMF.
9275 False by default.
9276
9277 =item B<CollectStruct> B<true>|B<false>
9278
9279 Current varnish internal state statistics. Number of current sessions, objects
9280 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9281 default.
9282
9283 =item B<CollectTotals> B<true>|B<false>
9284
9285 Collects overview counters, such as the number of sessions created,
9286 the number of requests and bytes transferred. False by default.
9287
9288 =item B<CollectUptime> B<true>|B<false>
9289
9290 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9291
9292 =item B<CollectVCL> B<true>|B<false>
9293
9294 Number of total (available + discarded) VCL (config files). False by default.
9295
9296 =item B<CollectVSM> B<true>|B<false>
9297
9298 Collect statistics about Varnish's shared memory usage (used by the logging and
9299 statistics subsystems). Only available with Varnish 4.x. False by default.
9300
9301 =item B<CollectWorkers> B<true>|B<false>
9302
9303 Collect statistics about worker threads. False by default.
9304
9305 =item B<CollectVBE> B<true>|B<false>
9306
9307 Backend counters. Only available with Varnish 4.x. False by default.
9308
9309 =item B<CollectSMF> B<true>|B<false>
9310
9311 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9312 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9313 instance. Used to be called SM in Varnish 2.x. False by default.
9314
9315 =item B<CollectManagement> B<true>|B<false>
9316
9317 Management process counters. Only available with Varnish 4.x. False by default.
9318
9319 =item B<CollectLock> B<true>|B<false>
9320
9321 Lock counters. Only available with Varnish 4.x. False by default.
9322
9323 =item B<CollectMempool> B<true>|B<false>
9324
9325 Memory pool counters. Only available with Varnish 4.x. False by default.
9326
9327 =item B<CollectMSE> B<true>|B<false>
9328
9329 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9330 Varnish, replacing the traditional malloc and file storages. Only available
9331 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9332 one used by the Varnish instance. False by default.
9333
9334 =back
9335
9336 =head2 Plugin C<virt>
9337
9338 This plugin allows CPU, disk, network load and other metrics to be collected for
9339 virtualized guests on the machine. The statistics are collected through libvirt
9340 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9341 installing any additional software on guests, especially I<collectd>, which runs
9342 only on the host system.
9343
9344 Only I<Connection> is required.
9345
9346 Consider the following example config:
9347
9348  <Plugin "virt">
9349    Connection "qemu:///system"
9350    HostnameFormat "hostname"
9351    InterfaceFormat "address"
9352    PluginInstanceFormat "name"
9353  </Plugin>
9354
9355 It will generate the following values:
9356
9357   node42.example.com/virt-instance-0006f26c/disk_octets-vda
9358   node42.example.com/virt-instance-0006f26c/disk_ops-vda
9359   node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe
9360   node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe
9361   node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe
9362   node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe
9363   node42.example.com/virt-instance-0006f26c/memory-actual_balloon
9364   node42.example.com/virt-instance-0006f26c/memory-available
9365   node42.example.com/virt-instance-0006f26c/memory-last_update
9366   node42.example.com/virt-instance-0006f26c/memory-major_fault
9367   node42.example.com/virt-instance-0006f26c/memory-minor_fault
9368   node42.example.com/virt-instance-0006f26c/memory-rss
9369   node42.example.com/virt-instance-0006f26c/memory-swap_in
9370   node42.example.com/virt-instance-0006f26c/memory-swap_out
9371   node42.example.com/virt-instance-0006f26c/memory-total
9372   node42.example.com/virt-instance-0006f26c/memory-unused
9373   node42.example.com/virt-instance-0006f26c/memory-usable
9374   node42.example.com/virt-instance-0006f26c/virt_cpu_total
9375   node42.example.com/virt-instance-0006f26c/virt_vcpu-0
9376
9377 You can get information on the metric's units from the online libvirt documentation.
9378 For instance, I<virt_cpu_total> is in nanoseconds.
9379
9380 =over 4
9381
9382 =item B<Connection> I<uri>
9383
9384 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9385
9386  Connection "xen:///"
9387
9388 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9389
9390 =item B<RefreshInterval> I<seconds>
9391
9392 Refresh the list of domains and devices every I<seconds>. The default is 60
9393 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9394 the list of domains and devices to be refreshed on every iteration.
9395
9396 Refreshing the devices in particular is quite a costly operation, so if your
9397 virtualization setup is static you might consider increasing this. If this
9398 option is set to 0, refreshing is disabled completely.
9399
9400 =item B<Domain> I<name>
9401
9402 =item B<BlockDevice> I<name:dev>
9403
9404 =item B<InterfaceDevice> I<name:dev>
9405
9406 =item B<IgnoreSelected> B<true>|B<false>
9407
9408 Select which domains and devices are collected.
9409
9410 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9411 disk/network devices are collected.
9412
9413 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9414 domains and disk/network devices are ignored, while the rest are collected.
9415
9416 The domain name and device names may use a regular expression, if the name is
9417 surrounded by I</.../> and collectd was compiled with support for regexps.
9418
9419 The default is to collect statistics for all domains and all their devices.
9420
9421 B<Note:> B<BlockDevice> and B<InterfaceDevice> options are related to
9422 corresponding B<*Format> options. Specifically, B<BlockDevice> filtering depends
9423 on B<BlockDeviceFormat> setting - if user wants to filter block devices by
9424 'target' name then B<BlockDeviceFormat> option has to be set to 'target' and
9425 B<BlockDevice> option must be set to a valid block device target
9426 name("/:hdb/"). Mixing formats and filter values from different worlds (i.e.,
9427 using 'target' name as B<BlockDevice> value with B<BlockDeviceFormat> set to
9428 'source') may lead to unexpected results (all devices filtered out or all
9429 visible, depending on the value of B<IgnoreSelected> option).
9430 Similarly, option B<InterfaceDevice> is related to B<InterfaceFormat> setting
9431 (i.e., when user wants to use MAC address as a filter then B<InterfaceFormat>
9432 has to be set to 'address' - using wrong type here may filter out all of the
9433 interfaces).
9434
9435 B<Example 1:>
9436
9437 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9438 will be collected:
9439
9440  BlockDevice "/:hdb/"
9441  IgnoreSelected "true"
9442  BlockDeviceFormat "target"
9443
9444 B<Example 2:>
9445
9446 Collect metrics only for block device on 'baremetal0' domain when its
9447 'source' matches given path:
9448
9449  BlockDevice "baremetal0:/var/lib/libvirt/images/baremetal0.qcow2"
9450  BlockDeviceFormat source
9451
9452 As you can see it is possible to filter devices/interfaces using
9453 various formats - for block devices 'target' or 'source' name can be
9454 used.  Interfaces can be filtered using 'name', 'address' or 'number'.
9455
9456 B<Example 3:>
9457
9458 Collect metrics only for domains 'baremetal0' and 'baremetal1' and
9459 ignore any other domain:
9460
9461  Domain "baremetal0"
9462  Domain "baremetal1"
9463
9464 It is possible to filter multiple block devices/domains/interfaces by
9465 adding multiple filtering entries in separate lines.
9466
9467 =item B<BlockDeviceFormat> B<target>|B<source>
9468
9469 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9470 seen by the guest will be used for reporting metrics.
9471 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9472 domain.
9473
9474 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9475 using the path of the source, e.g. an image file.
9476 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9477 domain.
9478
9479 B<Example:>
9480
9481 If the domain XML have the following device defined:
9482
9483   <disk type='block' device='disk'>
9484     <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9485     <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9486     <target dev='sda' bus='scsi'/>
9487     <boot order='2'/>
9488     <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9489   </disk>
9490
9491 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9492 to C<sda>.
9493 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9494 to C<var_lib_libvirt_images_image1.qcow2>.
9495
9496 B<Note:> this option determines also what field will be used for
9497 filtering over block devices (filter value in B<BlockDevice>
9498 will be applied to target or source). More info about filtering
9499 block devices can be found in the description of B<BlockDevice>.
9500
9501 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9502
9503 The B<BlockDeviceFormatBasename> controls whether the full path or the
9504 L<basename(1)> of the source is being used as the I<type instance> when
9505 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9506
9507 B<Example:>
9508
9509 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9510 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9511 be set to C<var_lib_libvirt_images_image1.qcow2>.
9512 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9513 set to C<image1.qcow2>.
9514
9515 =item B<HostnameFormat> B<name|uuid|hostname|metadata...>
9516
9517 When the virt plugin logs data, it sets the hostname of the collected data
9518 according to this setting. The default is to use the guest name as provided by
9519 the hypervisor, which is equal to setting B<name>.
9520
9521 B<uuid> means use the guest's UUID. This is useful if you want to track the
9522 same guest across migrations.
9523
9524 B<hostname> means to use the global B<Hostname> setting, which is probably not
9525 useful on its own because all guests will appear to have the same name. This is
9526 useful in conjunction with B<PluginInstanceFormat> though.
9527
9528 B<metadata> means use information from guest's metadata. Use
9529 B<HostnameMetadataNS> and B<HostnameMetadataXPath> to localize this information.
9530
9531 You can also specify combinations of these fields. For example B<name uuid>
9532 means to concatenate the guest name and UUID (with a literal colon character
9533 between, thus I<"foo:1234-1234-1234-1234">).
9534
9535 At the moment of writing (collectd-5.5), hostname string is limited to 62
9536 characters. In case when combination of fields exceeds 62 characters,
9537 hostname will be truncated without a warning.
9538
9539 =item B<InterfaceFormat> B<name>|B<address>|B<number>
9540
9541 When the virt plugin logs interface data, it sets the name of the collected
9542 data according to this setting. The default is to use the path as provided by
9543 the hypervisor (the "dev" property of the target node), which is equal to
9544 setting B<name>.
9545
9546 B<address> means use the interface's mac address. This is useful since the
9547 interface path might change between reboots of a guest or across migrations.
9548
9549 B<number> means use the interface's number in guest.
9550
9551 B<Note:> this option determines also what field will be used for
9552 filtering over interface device (filter value in B<InterfaceDevice>
9553 will be applied to name, address or number).  More info about filtering
9554 interfaces can be found in the description of B<InterfaceDevice>.
9555
9556 =item B<PluginInstanceFormat> B<name|uuid|metadata|none>
9557
9558 When the virt plugin logs data, it sets the plugin_instance of the collected
9559 data according to this setting. The default is to not set the plugin_instance.
9560
9561 B<name> means use the guest's name as provided by the hypervisor.
9562 B<uuid> means use the guest's UUID.
9563 B<metadata> means use information from guest's metadata.
9564
9565 You can also specify combinations of the B<name> and B<uuid> fields.
9566 For example B<name uuid> means to concatenate the guest name and UUID
9567 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9568
9569 =item B<HostnameMetadataNS> B<string>
9570
9571 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9572 selects in which metadata namespace we will pick the hostname. The default is
9573 I<http://openstack.org/xmlns/libvirt/nova/1.0>.
9574
9575 =item B<HostnameMetadataXPath> B<string>
9576
9577 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9578 describes where the hostname is located in the libvirt metadata. The default is
9579 I</instance/name/text()>.
9580
9581 =item B<ReportBlockDevices> B<true>|B<false>
9582
9583 Enabled by default. Allows to disable stats reporting of block devices for
9584 whole plugin.
9585
9586 =item B<ReportNetworkInterfaces> B<true>|B<false>
9587
9588 Enabled by default. Allows to disable stats reporting of network interfaces for
9589 whole plugin.
9590
9591 =item B<ExtraStats> B<string>
9592
9593 Report additional extra statistics. The default is no extra statistics, preserving
9594 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9595 allows the plugin to reported more detailed statistics about the behaviour of
9596 Virtual Machines. The argument is a space-separated list of selectors.
9597
9598 Currently supported selectors are:
9599
9600 =over 4
9601
9602 =item B<cpu_util>: report CPU utilization per domain in percentage.
9603
9604 =item B<disk>: report extra statistics like number of flush operations and total
9605 service time for read, write and flush operations. Requires libvirt API version
9606 I<0.9.5> or later.
9607
9608 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9609 I<0.9.10> or later.
9610
9611 =item B<domain_state>: report domain state and reason as 'domain_state' metric.
9612
9613 =item B<fs_info>: report file system information as a notification. Requires
9614 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9615 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9616 version supports retrieving  file system information.
9617
9618 =item B<job_stats_background>: report statistics about progress of a background
9619 job on a domain. Only one type of job statistics can be collected at the same time.
9620 Requires libvirt API version I<1.2.9> or later.
9621
9622 =item B<job_stats_completed>: report statistics about a recently completed job on
9623 a domain. Only one type of job statistics can be collected at the same time.
9624 Requires libvirt API version I<1.2.9> or later.
9625
9626 =item B<memory>: report statistics about memory usage details, provided
9627 by libvirt virDomainMemoryStats() function.
9628
9629 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9630 Requires libvirt API version I<0.9.11> or later.
9631
9632 =item B<perf>: report performance monitoring events. To collect performance
9633 metrics they must be enabled for domain and supported by the platform. Requires
9634 libvirt API version I<1.3.3> or later.
9635 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9636
9637 =item B<vcpu>: report domain virtual CPUs utilisation.
9638
9639 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9640
9641 =item B<disk_physical>: report 'disk_physical' statistic for disk device.
9642 B<Note>: This statistic is only reported for disk devices with 'source'
9643 property available.
9644
9645 =item B<disk_allocation>: report 'disk_allocation' statistic for disk device.
9646 B<Note>: This statistic is only reported for disk devices with 'source'
9647 property available.
9648
9649 =item B<disk_capacity>: report 'disk_capacity' statistic for disk device.
9650 B<Note>: This statistic is only reported for disk devices with 'source'
9651 property available.
9652
9653 =back
9654
9655 =item B<PersistentNotification> B<true>|B<false>
9656
9657 Override default configuration to only send notifications when there is a change
9658 in the lifecycle state of a domain. When set to true notifications will be sent
9659 for every read cycle. Default is false. Does not affect the stats being
9660 dispatched.
9661
9662 =item B<Instances> B<integer>
9663
9664 How many read instances you want to use for this plugin. The default is one,
9665 and the sensible setting is a multiple of the B<ReadThreads> value.
9666
9667 This option is only useful when domains are specially tagged.
9668 If you are not sure, just use the default setting.
9669
9670 The reader instance will only query the domains with attached matching tag.
9671 Tags should have the form of 'virt-X' where X is the reader instance number,
9672 starting from 0.
9673
9674 The special-purpose reader instance #0, guaranteed to be always present,
9675 will query all the domains with missing or unrecognized tag, so no domain will
9676 ever be left out.
9677
9678 Domain tagging is done with a custom attribute in the libvirt domain metadata
9679 section. Value is selected by an XPath I</domain/metadata/ovirtmap/tag/text()>
9680 expression in the I<http://ovirt.org/ovirtmap/tag/1.0> namespace.
9681 (XPath and namespace values are not configurable yet).
9682
9683 Tagging could be used by management applications to evenly spread the
9684 load among the reader threads, or to pin on the same threads all
9685 the libvirt domains which use the same shared storage, to minimize
9686 the disruption in presence of storage outages.
9687
9688 =back
9689
9690 =head2 Plugin C<vmem>
9691
9692 The C<vmem> plugin collects information about the usage of virtual memory.
9693 Since the statistics provided by the Linux kernel are very detailed, they are
9694 collected very detailed. However, to get all the details, you have to switch
9695 them on manually. Most people just want an overview over, such as the number of
9696 pages read from swap space.
9697
9698 =over 4
9699
9700 =item B<Verbose> B<true>|B<false>
9701
9702 Enables verbose collection of information. This will start collecting page
9703 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9704 Part of these statistics are collected on a "per zone" basis.
9705
9706 =back
9707
9708 =head2 Plugin C<vserver>
9709
9710 This plugin doesn't have any options. B<VServer> support is only available for
9711 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9712 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9713 need to apply the patches and compile your own kernel, which will then provide
9714 the F</proc/virtual> filesystem that is required by this plugin.
9715
9716 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9717
9718 B<Note>: The traffic collected by this plugin accounts for the amount of
9719 traffic passing a socket which might be a lot less than the actual on-wire
9720 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9721 collect on-wire traffic you could, for example, use the logging facilities of
9722 iptables to feed data for the guest IPs into the iptables plugin.
9723
9724 =head2 Plugin C<write_graphite>
9725
9726 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9727 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9728 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9729 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9730 of at most 1428 bytes to minimize the number of network packets.
9731
9732 Synopsis:
9733
9734  <Plugin write_graphite>
9735    <Node "example">
9736      Host "localhost"
9737      Port "2003"
9738      Protocol "tcp"
9739      LogSendErrors true
9740      Prefix "collectd"
9741      UseTags false
9742      ReverseHost false
9743    </Node>
9744  </Plugin>
9745
9746 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9747 blocks. Inside the B<Node> blocks, the following options are recognized:
9748
9749 =over 4
9750
9751 =item B<Host> I<Address>
9752
9753 Hostname or address to connect to. Defaults to C<localhost>.
9754
9755 =item B<Port> I<Service>
9756
9757 Service name or port number to connect to. Defaults to C<2003>.
9758
9759 =item B<Protocol> I<String>
9760
9761 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9762
9763 =item B<ReconnectInterval> I<Seconds>
9764
9765 When set to non-zero, forces the connection to the Graphite backend to be
9766 closed and re-opend periodically. This behavior is desirable in environments
9767 where the connection to the Graphite backend is done through load balancers,
9768 for example. When set to zero, the default, the connetion is kept open for as
9769 long as possible.
9770
9771 =item B<LogSendErrors> B<false>|B<true>
9772
9773 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9774 If set to B<false>, it will not log the errors. This is especially useful when
9775 using Protocol UDP since many times we want to use the "fire-and-forget"
9776 approach and logging errors fills syslog with unneeded messages.
9777
9778 =item B<Prefix> I<String>
9779
9780 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9781 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9782
9783 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9784 below).
9785
9786 =item B<Postfix> I<String>
9787
9788 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9789 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9790 (before the first ; that separates the name from the tags).
9791
9792 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9793 below).
9794
9795 =item B<EscapeCharacter> I<Char>
9796
9797 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9798 in the identifier. The B<EscapeCharacter> option determines which character
9799 dots, whitespace and control characters are replaced with. Defaults to
9800 underscore (C<_>).
9801
9802 =item B<StoreRates> B<false>|B<true>
9803
9804 If set to B<true> (the default), convert counter values to rates. If set to
9805 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9806 number.
9807
9808 =item B<SeparateInstances> B<false>|B<true>
9809
9810 If set to B<true>, the plugin instance and type instance will be in their own
9811 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9812 default), the plugin and plugin instance (and likewise the type and type
9813 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9814
9815 Option value is not used when B<UseTags> is I<true>.
9816
9817 =item B<AlwaysAppendDS> B<false>|B<true>
9818
9819 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9820 identifier. If set to B<false> (the default), this is only done when there is
9821 more than one DS.
9822
9823 =item B<PreserveSeparator> B<false>|B<true>
9824
9825 If set to B<false> (the default) the C<.> (dot) character is replaced with
9826 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9827 is preserved, i.e. passed through.
9828
9829 Option value is not used when B<UseTags> is I<true>.
9830
9831 =item B<DropDuplicateFields> B<false>|B<true>
9832
9833 If set to B<true>, detect and remove duplicate components in Graphite metric
9834 names. For example, the metric name  C<host.load.load.shortterm> will
9835 be shortened to C<host.load.shortterm>.
9836
9837 =item B<UseTags> B<false>|B<true>
9838
9839 If set to B<true>, Graphite metric names will be generated as tagged series.
9840 This allows for much more flexibility than the traditional hierarchical layout.
9841
9842 Example:
9843 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9844
9845 You can use B<Postfix> option to add more tags by specifying it like
9846 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9847 version 1.1.x.
9848
9849 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9850 are not used.
9851
9852 Default value: B<false>.
9853
9854 =item B<ReverseHost> B<false>|B<true>
9855
9856 If set to B<true>, the (dot separated) parts of the B<host> field of the
9857 I<value list> will be rewritten in reverse order. The rewrite happens I<before>
9858 special characters are replaced with the B<EscapeCharacter>.
9859
9860 This option might be convenient if the metrics are presented with Graphite in a
9861 DNS like tree structure (probably without replacing dots in hostnames).
9862
9863 Example:
9864  Hostname "node3.cluster1.example.com"
9865  LoadPlugin "cpu"
9866  LoadPlugin "write_graphite"
9867  <Plugin "write_graphite">
9868   <Node "graphite.example.com">
9869    EscapeCharacter "."
9870    ReverseHost true
9871   </Node>
9872  </Plugin>
9873
9874  result on the wire: com.example.cluster1.node3.cpu-0.cpu-idle 99.900993 1543010932
9875
9876 Default value: B<false>.
9877
9878 =back
9879
9880 =head2 Plugin C<write_log>
9881
9882 The C<write_log> plugin writes metrics as INFO log messages.
9883
9884 This plugin supports two output formats: I<Graphite> and I<JSON>.
9885
9886 Synopsis:
9887
9888  <Plugin write_log>
9889    Format Graphite
9890  </Plugin>
9891
9892 =over 4
9893
9894 =item B<Format> I<Format>
9895
9896 The output format to use. Can be one of C<Graphite> or C<JSON>.
9897
9898 =back
9899
9900 =head2 Plugin C<write_tsdb>
9901
9902 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9903 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9904 state daemon that ingests metrics and stores them in HBase. The plugin uses
9905 I<TCP> over the "line based" protocol with a default port 4242. The data will
9906 be sent in blocks of at most 1428 bytes to minimize the number of network
9907 packets.
9908
9909 Synopsis:
9910
9911  <Plugin write_tsdb>
9912    ResolveInterval 60
9913    ResolveJitter 60
9914    <Node "example">
9915      Host "tsd-1.my.domain"
9916      Port "4242"
9917      HostTags "status=production"
9918    </Node>
9919  </Plugin>
9920
9921 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9922 blocks and global directives.
9923
9924 Global directives are:
9925
9926 =over 4
9927
9928 =item B<ResolveInterval> I<seconds>
9929
9930 =item B<ResolveJitter> I<seconds>
9931
9932 When I<collectd> connects to a TSDB node, it will request the hostname from
9933 DNS. This can become a problem if the TSDB node is unavailable or badly
9934 configured because collectd will request DNS in order to reconnect for every
9935 metric, which can flood your DNS. So you can cache the last value for
9936 I<ResolveInterval> seconds.
9937 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9938
9939 You can also define a jitter, a random interval to wait in addition to
9940 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9941 hostname at the same time when the connection fails.
9942 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9943
9944 B<Note:> If the DNS resolution has already been successful when the socket
9945 closes, the plugin will try to reconnect immediately with the cached
9946 information. DNS is queried only when the socket is closed for a longer than
9947 I<ResolveInterval> + I<ResolveJitter> seconds.
9948
9949 =back
9950
9951 Inside the B<Node> blocks, the following options are recognized:
9952
9953 =over 4
9954
9955 =item B<Host> I<Address>
9956
9957 Hostname or address to connect to. Defaults to C<localhost>.
9958
9959 =item B<Port> I<Service>
9960
9961 Service name or port number to connect to. Defaults to C<4242>.
9962
9963
9964 =item B<HostTags> I<String>
9965
9966 When set, I<HostTags> is added to the end of the metric. It is intended to be
9967 used for name=value pairs that the TSD will tag the metric with. Dots and
9968 whitespace are I<not> escaped in this string.
9969
9970 =item B<StoreRates> B<false>|B<true>
9971
9972 If set to B<true>, convert counter values to rates. If set to B<false>
9973 (the default) counter values are stored as is, as an increasing
9974 integer number.
9975
9976 =item B<AlwaysAppendDS> B<false>|B<true>
9977
9978 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9979 identifier. If set to B<false> (the default), this is only done when there is
9980 more than one DS.
9981
9982 =back
9983
9984 =head2 Plugin C<write_mongodb>
9985
9986 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9987 NoSQL database.
9988
9989 B<Synopsis:>
9990
9991  <Plugin "write_mongodb">
9992    <Node "default">
9993      Host "localhost"
9994      Port "27017"
9995      Timeout 1000
9996      StoreRates true
9997    </Node>
9998  </Plugin>
9999
10000 The plugin can send values to multiple instances of I<MongoDB> by specifying
10001 one B<Node> block for each instance. Within the B<Node> blocks, the following
10002 options are available:
10003
10004 =over 4
10005
10006 =item B<Host> I<Address>
10007
10008 Hostname or address to connect to. Defaults to C<localhost>.
10009
10010 =item B<Port> I<Service>
10011
10012 Service name or port number to connect to. Defaults to C<27017>.
10013
10014 =item B<Timeout> I<Milliseconds>
10015
10016 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
10017 Setting this option to zero means no timeout, which is the default.
10018
10019 =item B<StoreRates> B<false>|B<true>
10020
10021 If set to B<true> (the default), convert counter values to rates. If set to
10022 B<false> counter values are stored as is, i.e. as an increasing integer
10023 number.
10024
10025 =item B<Database> I<Database>
10026
10027 =item B<User> I<User>
10028
10029 =item B<Password> I<Password>
10030
10031 Sets the information used when authenticating to a I<MongoDB> database. The
10032 fields are optional (in which case no authentication is attempted), but if you
10033 want to use authentication all three fields must be set.
10034
10035 =back
10036
10037 =head2 Plugin C<write_prometheus>
10038
10039 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
10040 using I<Prometheus>.
10041
10042 B<Options:>
10043
10044 =over 4
10045
10046 =item B<Host> I<Host>
10047
10048 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
10049 "any" address, i.e. accept packets sent to any of the hosts addresses.
10050
10051 This option is supported only for libmicrohttpd newer than 0.9.0.
10052
10053 =item B<Port> I<Port>
10054
10055 Port the embedded webserver should listen on. Defaults to B<9103>.
10056
10057 =item B<StalenessDelta> I<Seconds>
10058
10059 Time in seconds after which I<Prometheus> considers a metric "stale" if it
10060 hasn't seen any update for it. This value must match the setting in Prometheus.
10061 It defaults to B<300> seconds (5 minutes), same as Prometheus.
10062
10063 B<Background:>
10064
10065 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
10066 which time a metric without updates is considered "stale". This setting
10067 effectively puts an upper limit on the interval in which metrics are reported.
10068
10069 When the I<write_prometheus plugin> encounters a metric with an interval
10070 exceeding this limit, it will inform you, the user, and provide the metric to
10071 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
10072 metric "fresh" each time it is scraped, with the time of the scrape being
10073 considered the time of the update. The result is that there appear more
10074 datapoints in I<Prometheus> than were actually created, but at least the metric
10075 doesn't disappear periodically.
10076
10077 =back
10078
10079 =head2 Plugin C<write_http>
10080
10081 This output plugin submits values to an HTTP server using POST requests and
10082 encoding metrics with JSON or using the C<PUTVAL> command described in
10083 L<collectd-unixsock(5)>.
10084
10085 Synopsis:
10086
10087  <Plugin "write_http">
10088    <Node "example">
10089      URL "http://example.com/post-collectd"
10090      User "collectd"
10091      Password "weCh3ik0"
10092      Format JSON
10093    </Node>
10094  </Plugin>
10095
10096 The plugin can send values to multiple HTTP servers by specifying one
10097 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
10098 block, the following options are available:
10099
10100 =over 4
10101
10102 =item B<URL> I<URL>
10103
10104 URL to which the values are submitted to. Mandatory.
10105
10106 =item B<User> I<Username>
10107
10108 Optional user name needed for authentication.
10109
10110 =item B<Password> I<Password>
10111
10112 Optional password needed for authentication.
10113
10114 =item B<VerifyPeer> B<true>|B<false>
10115
10116 Enable or disable peer SSL certificate verification. See
10117 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
10118
10119 =item B<VerifyHost> B<true|false>
10120
10121 Enable or disable peer host name verification. If enabled, the plugin checks if
10122 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
10123 matches the host name provided by the B<URL> option. If this identity check
10124 fails, the connection is aborted. Obviously, only works when connecting to a
10125 SSL enabled server. Enabled by default.
10126
10127 =item B<CACert> I<File>
10128
10129 File that holds one or more SSL certificates. If you want to use HTTPS you will
10130 possibly need this option. What CA certificates come bundled with C<libcurl>
10131 and are checked by default depends on the distribution you use.
10132
10133 =item B<CAPath> I<Directory>
10134
10135 Directory holding one or more CA certificate files. You can use this if for
10136 some reason all the needed CA certificates aren't in the same file and can't be
10137 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
10138 OpenSSL.
10139
10140 =item B<ClientKey> I<File>
10141
10142 File that holds the private key in PEM format to be used for certificate-based
10143 authentication.
10144
10145 =item B<ClientCert> I<File>
10146
10147 File that holds the SSL certificate to be used for certificate-based
10148 authentication.
10149
10150 =item B<ClientKeyPass> I<Password>
10151
10152 Password required to load the private key in B<ClientKey>.
10153
10154 =item B<Header> I<Header>
10155
10156 A HTTP header to add to the request.  Multiple headers are added if this option is specified more than once.  Example:
10157
10158   Header "X-Custom-Header: custom_value"
10159
10160 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
10161
10162 Define which SSL protocol version must be used. By default C<libcurl> will
10163 attempt to figure out the remote SSL protocol version. See
10164 L<curl_easy_setopt(3)> for more details.
10165
10166 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
10167
10168 Format of the output to generate. If set to B<Command>, will create output that
10169 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
10170 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
10171 , will create output in the KairosDB format.
10172
10173 Defaults to B<Command>.
10174
10175 =item B<Attribute> I<String> I<String>
10176
10177 Only available for the KAIROSDB output format.
10178
10179 Consider the two given strings to be the key and value of an additional tag for
10180 each metric being sent out.
10181
10182 You can add multiple B<Attribute>.
10183
10184 =item B<TTL> I<Int>
10185
10186 Only available for the KAIROSDB output format.
10187
10188 Sets the Cassandra ttl for the data points.
10189
10190 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
10191
10192 =item B<Prefix> I<String>
10193
10194 Only available for the KAIROSDB output format.
10195
10196 Sets the metrics prefix I<string>. Defaults to I<collectd>.
10197
10198 =item B<Metrics> B<true>|B<false>
10199
10200 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
10201
10202 =item B<Notifications> B<false>|B<true>
10203
10204 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
10205
10206 =item B<StoreRates> B<true|false>
10207
10208 If set to B<true>, convert counter values to rates. If set to B<false> (the
10209 default) counter values are stored as is, i.e. as an increasing integer number.
10210
10211 =item B<BufferSize> I<Bytes>
10212
10213 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
10214 requests will be generated, but more metrics will be batched / metrics are
10215 cached for longer before being sent, introducing additional delay until they
10216 are available on the server side. I<Bytes> must be at least 1024 and cannot
10217 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
10218 Defaults to C<4096>.
10219
10220 =item B<LowSpeedLimit> I<Bytes per Second>
10221
10222 Sets the minimal transfer rate in I<Bytes per Second> below which the
10223 connection with the HTTP server will be considered too slow and aborted. All
10224 the data submitted over this connection will probably be lost. Defaults to 0,
10225 which means no minimum transfer rate is enforced.
10226
10227 =item B<Timeout> I<Timeout>
10228
10229 Sets the maximum time in milliseconds given for HTTP POST operations to
10230 complete. When this limit is reached, the POST operation will be aborted, and
10231 all the data in the current send buffer will probably be lost. Defaults to 0,
10232 which means the connection never times out.
10233
10234 =item B<LogHttpError> B<false>|B<true>
10235
10236 Enables printing of HTTP error code to log. Turned off by default.
10237
10238 The C<write_http> plugin regularly submits the collected values to the HTTP
10239 server. How frequently this happens depends on how much data you are collecting
10240 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
10241 slightly below this interval, which you can estimate by monitoring the network
10242 traffic between collectd and the HTTP server.
10243
10244 =back
10245
10246 =head2 Plugin C<write_kafka>
10247
10248 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
10249 queue.
10250 Synopsis:
10251
10252  <Plugin "write_kafka">
10253    Property "metadata.broker.list" "broker1:9092,broker2:9092"
10254    <Topic "collectd">
10255      Format JSON
10256    </Topic>
10257  </Plugin>
10258
10259 The following options are understood by the I<write_kafka plugin>:
10260
10261 =over 4
10262
10263 =item E<lt>B<Topic> I<Name>E<gt>
10264
10265 The plugin's configuration consists of one or more B<Topic> blocks. Each block
10266 is given a unique I<Name> and specifies one kafka producer.
10267 Inside the B<Topic> block, the following per-topic options are
10268 understood:
10269
10270 =over 4
10271
10272 =item B<Property> I<String> I<String>
10273
10274 Configure the named property for the current topic. Properties are
10275 forwarded to the kafka producer library B<librdkafka>.
10276
10277 =item B<Key> I<String>
10278
10279 Use the specified string as a partitioning key for the topic. Kafka breaks
10280 topic into partitions and guarantees that for a given topology, the same
10281 consumer will be used for a specific key. The special (case insensitive)
10282 string B<Random> can be used to specify that an arbitrary partition should
10283 be used.
10284
10285 =item B<Format> B<Command>|B<JSON>|B<Graphite>
10286
10287 Selects the format in which messages are sent to the broker. If set to
10288 B<Command> (the default), values are sent as C<PUTVAL> commands which are
10289 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
10290
10291 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
10292 an easy and straight forward exchange format.
10293
10294 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
10295 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
10296
10297 =item B<StoreRates> B<true>|B<false>
10298
10299 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
10300 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
10301 default), no conversion is performed. Otherwise the conversion is performed
10302 using the internal value cache.
10303
10304 Please note that currently this option is only used if the B<Format> option has
10305 been set to B<JSON>.
10306
10307 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10308
10309 A prefix can be added in the metric name when outputting in the I<Graphite>
10310 format.
10311
10312 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10313 Metric name will be
10314 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>>
10315
10316 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10317
10318 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10319
10320 A postfix can be added in the metric name when outputting in the I<Graphite>
10321 format.
10322
10323 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10324 Metric name will be
10325 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>>
10326
10327 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10328 name (before the first ; that separates the name from the tags).
10329
10330 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10331
10332 Specify a character to replace dots (.) in the host part of the metric name.
10333 In I<Graphite> metric name, dots are used as separators between different
10334 metric parts (host, plugin, type).
10335 Default is C<_> (I<Underscore>).
10336
10337 =item B<GraphiteSeparateInstances> B<false>|B<true>
10338
10339 If set to B<true>, the plugin instance and type instance will be in their own
10340 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10341 default), the plugin and plugin instance (and likewise the type and type
10342 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10343
10344 Option value is not used when B<GraphiteUseTags> is I<true>.
10345
10346 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10347
10348 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10349 identifier. If set to B<false> (the default), this is only done when there is
10350 more than one DS.
10351
10352 =item B<GraphitePreserveSeparator> B<false>|B<true>
10353
10354 If set to B<false> (the default) the C<.> (dot) character is replaced with
10355 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10356 is preserved, i.e. passed through.
10357
10358 Option value is not used when B<GraphiteUseTags> is I<true>.
10359
10360 =item B<GraphiteUseTags> B<false>|B<true>
10361
10362 If set to B<true> Graphite metric names will be generated as tagged series.
10363
10364 Default value: B<false>.
10365
10366 =item B<StoreRates> B<true>|B<false>
10367
10368 If set to B<true> (the default), convert counter values to rates. If set to
10369 B<false> counter values are stored as is, i.e. as an increasing integer number.
10370
10371 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10372 converted values will have "rate" appended to the data source type, e.g.
10373 C<ds_type:derive:rate>.
10374
10375 =back
10376
10377 =item B<Property> I<String> I<String>
10378
10379 Configure the kafka producer through properties, you almost always will
10380 want to set B<metadata.broker.list> to your Kafka broker list.
10381
10382 =back
10383
10384 =head2 Plugin C<write_redis>
10385
10386 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10387
10388 Synopsis:
10389
10390   <Plugin "write_redis">
10391     <Node "example">
10392         Host "localhost"
10393         Port "6379"
10394         Timeout 1000
10395         Prefix "collectd/"
10396         Database 1
10397         MaxSetSize -1
10398         MaxSetDuration -1
10399         StoreRates true
10400     </Node>
10401   </Plugin>
10402
10403 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10404 the timestamp as the score. Retrieving a date range can then be done using the
10405 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10406 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10407 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10408 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10409 with the B<Database> parameter (default is C<0>). See
10410 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10411 details.
10412
10413 The information shown in the synopsis above is the I<default configuration>
10414 which is used by the plugin if no configuration is present.
10415
10416 The plugin can send values to multiple instances of I<Redis> by specifying
10417 one B<Node> block for each instance. Within the B<Node> blocks, the following
10418 options are available:
10419
10420 =over 4
10421
10422 =item B<Node> I<Nodename>
10423
10424 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10425 instance running on a specified host and port. The node name is a
10426 canonical identifier which is used as I<plugin instance>. It is limited to
10427 51E<nbsp>characters in length.
10428
10429 =item B<Host> I<Hostname>
10430
10431 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10432 running on.
10433
10434 =item B<Port> I<Port>
10435
10436 The B<Port> option is the TCP port on which the Redis instance accepts
10437 connections. Either a service name of a port number may be given. Please note
10438 that numerical port numbers must be given as a string, too.
10439
10440 =item B<Timeout> I<Milliseconds>
10441
10442 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10443
10444 =item B<Prefix> I<Prefix>
10445
10446 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10447 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10448 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10449 is recommended but not required to include a trailing slash in I<Prefix>.
10450
10451 =item B<Database> I<Index>
10452
10453 This index selects the redis database to use for writing operations. Defaults
10454 to C<0>.
10455
10456 =item B<MaxSetSize> I<Items>
10457
10458 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10459 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10460
10461 =item B<MaxSetDuration> I<Seconds>
10462
10463 The B<MaxSetDuration> option limits the duration of items that the
10464 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10465 is the default behavior.
10466
10467 =item B<StoreRates> B<true>|B<false>
10468
10469 If set to B<true> (the default), convert counter values to rates. If set to
10470 B<false> counter values are stored as is, i.e. as an increasing integer number.
10471
10472 =back
10473
10474 =head2 Plugin C<write_riemann>
10475
10476 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10477 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10478 I<Riemann> using UDP packets.
10479
10480 Synopsis:
10481
10482  <Plugin "write_riemann">
10483    <Node "example">
10484      Host "localhost"
10485      Port "5555"
10486      Protocol UDP
10487      StoreRates true
10488      AlwaysAppendDS false
10489      TTLFactor 2.0
10490    </Node>
10491    Tag "foobar"
10492    Attribute "foo" "bar"
10493  </Plugin>
10494
10495 The following options are understood by the I<write_riemann plugin>:
10496
10497 =over 4
10498
10499 =item E<lt>B<Node> I<Name>E<gt>
10500
10501 The plugin's configuration consists of one or more B<Node> blocks. Each block
10502 is given a unique I<Name> and specifies one connection to an instance of
10503 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10504 understood:
10505
10506 =over 4
10507
10508 =item B<Host> I<Address>
10509
10510 Hostname or address to connect to. Defaults to C<localhost>.
10511
10512 =item B<Port> I<Service>
10513
10514 Service name or port number to connect to. Defaults to C<5555>.
10515
10516 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10517
10518 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10519 B<TCP>.
10520
10521 =item B<TLSCertFile> I<Path>
10522
10523 When using the B<TLS> protocol, path to a PEM certificate to present
10524 to remote host.
10525
10526 =item B<TLSCAFile> I<Path>
10527
10528 When using the B<TLS> protocol, path to a PEM CA certificate to
10529 use to validate the remote hosts's identity.
10530
10531 =item B<TLSKeyFile> I<Path>
10532
10533 When using the B<TLS> protocol, path to a PEM private key associated
10534 with the certificate defined by B<TLSCertFile>.
10535
10536 =item B<Batch> B<true>|B<false>
10537
10538 If set to B<true> and B<Protocol> is set to B<TCP>,
10539 events will be batched in memory and flushed at
10540 regular intervals or when B<BatchMaxSize> is exceeded.
10541
10542 Notifications are not batched and sent as soon as possible.
10543
10544 When enabled, it can occur that events get processed by the Riemann server
10545 close to or after their expiration time. Tune the B<TTLFactor> and
10546 B<BatchMaxSize> settings according to the amount of values collected, if this
10547 is an issue.
10548
10549 Defaults to true
10550
10551 =item B<BatchMaxSize> I<size>
10552
10553 Maximum payload size for a riemann packet. Defaults to 8192
10554
10555 =item B<BatchFlushTimeout> I<seconds>
10556
10557 Maximum amount of seconds to wait in between to batch flushes.
10558 No timeout by default.
10559
10560 =item B<StoreRates> B<true>|B<false>
10561
10562 If set to B<true> (the default), convert counter values to rates. If set to
10563 B<false> counter values are stored as is, i.e. as an increasing integer number.
10564
10565 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10566 converted values will have "rate" appended to the data source type, e.g.
10567 C<ds_type:derive:rate>.
10568
10569 =item B<AlwaysAppendDS> B<false>|B<true>
10570
10571 If set to B<true>, append the name of the I<Data Source> (DS) to the
10572 "service", i.e. the field that, together with the "host" field, uniquely
10573 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10574 only done when there is more than one DS.
10575
10576 =item B<TTLFactor> I<Factor>
10577
10578 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10579 event is considered active. I<collectd> populates this field based on the
10580 metrics interval setting. This setting controls the factor with which the
10581 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10582 know exactly what you're doing, you should only increase this setting from its
10583 default value.
10584
10585 =item B<Notifications> B<false>|B<true>
10586
10587 If set to B<true>, create riemann events for notifications. This is B<true>
10588 by default. When processing thresholds from write_riemann, it might prove
10589 useful to avoid getting notification events.
10590
10591 =item B<CheckThresholds> B<false>|B<true>
10592
10593 If set to B<true>, attach state to events based on thresholds defined
10594 in the B<Threshold> plugin. Defaults to B<false>.
10595
10596 =item B<EventServicePrefix> I<String>
10597
10598 Add the given string as a prefix to the event service name.
10599 If B<EventServicePrefix> not set or set to an empty string (""),
10600 no prefix will be used.
10601
10602 =back
10603
10604 =item B<Tag> I<String>
10605
10606 Add the given string as an additional tag to the metric being sent to
10607 I<Riemann>.
10608
10609 =item B<Attribute> I<String> I<String>
10610
10611 Consider the two given strings to be the key and value of an additional
10612 attribute for each metric being sent out to I<Riemann>.
10613
10614 =back
10615
10616 =head2 Plugin C<write_sensu>
10617
10618 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10619 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10620 a local I<Sensu> client using a TCP socket.
10621
10622 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10623 parameter so it is not possible to use one collectd instance as a gateway for
10624 others. Each collectd host must pair with one I<Sensu> client.
10625
10626 Synopsis:
10627
10628  <Plugin "write_sensu">
10629    <Node "example">
10630      Host "localhost"
10631      Port "3030"
10632      StoreRates true
10633      AlwaysAppendDS false
10634      MetricHandler "influx"
10635      MetricHandler "default"
10636      NotificationHandler "flapjack"
10637      NotificationHandler "howling_monkey"
10638      Notifications true
10639    </Node>
10640    Tag "foobar"
10641    Attribute "foo" "bar"
10642  </Plugin>
10643
10644 The following options are understood by the I<write_sensu plugin>:
10645
10646 =over 4
10647
10648 =item E<lt>B<Node> I<Name>E<gt>
10649
10650 The plugin's configuration consists of one or more B<Node> blocks. Each block
10651 is given a unique I<Name> and specifies one connection to an instance of
10652 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10653 understood:
10654
10655 =over 4
10656
10657 =item B<Host> I<Address>
10658
10659 Hostname or address to connect to. Defaults to C<localhost>.
10660
10661 =item B<Port> I<Service>
10662
10663 Service name or port number to connect to. Defaults to C<3030>.
10664
10665 =item B<StoreRates> B<true>|B<false>
10666
10667 If set to B<true> (the default), convert counter values to rates. If set to
10668 B<false> counter values are stored as is, i.e. as an increasing integer number.
10669
10670 This will be reflected in the C<collectd_data_source_type> tag: If
10671 B<StoreRates> is enabled, converted values will have "rate" appended to the
10672 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
10673
10674 =item B<AlwaysAppendDS> B<false>|B<true>
10675
10676 If set the B<true>, append the name of the I<Data Source> (DS) to the
10677 "service", i.e. the field that, together with the "host" field, uniquely
10678 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10679 only done when there is more than one DS.
10680
10681 =item B<Notifications> B<false>|B<true>
10682
10683 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10684 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10685
10686 =item B<Metrics> B<false>|B<true>
10687
10688 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10689 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10690
10691
10692 =item B<Separator> I<String>
10693
10694 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10695
10696 =item B<MetricHandler> I<String>
10697
10698 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10699 several of them, one per line. Defaults to no handler.
10700
10701 =item B<NotificationHandler> I<String>
10702
10703 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10704 add several of them, one per line. Defaults to no handler.
10705
10706 =item B<EventServicePrefix> I<String>
10707
10708 Add the given string as a prefix to the event service name.
10709 If B<EventServicePrefix> not set or set to an empty string (""),
10710 no prefix will be used.
10711
10712 =back
10713
10714 =item B<Tag> I<String>
10715
10716 Add the given string as an additional tag to the metric being sent to
10717 I<Sensu>.
10718
10719 =item B<Attribute> I<String> I<String>
10720
10721 Consider the two given strings to be the key and value of an additional
10722 attribute for each metric being sent out to I<Sensu>.
10723
10724 =back
10725
10726 =head2 Plugin C<write_stackdriver>
10727
10728 The C<write_stackdriver> plugin writes metrics to the
10729 I<Google Stackdriver Monitoring> service.
10730
10731 This plugin supports two authentication methods: When configured, credentials
10732 are read from the JSON credentials file specified with B<CredentialFile>.
10733 Alternatively, when running on
10734 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10735 I<metadata server> and used to authenticate to GCM.
10736
10737 B<Synopsis:>
10738
10739  <Plugin write_stackdriver>
10740    CredentialFile "/path/to/service_account.json"
10741    <Resource "global">
10742      Label "project_id" "monitored_project"
10743    </Resource>
10744  </Plugin>
10745
10746 =over 4
10747
10748 =item B<CredentialFile> I<file>
10749
10750 Path to a JSON credentials file holding the credentials for a GCP service
10751 account.
10752
10753 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10754 Credentials>. That means which credentials are used depends on the environment:
10755
10756 =over 4
10757
10758 =item
10759
10760 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10761 variable is specified it should point to a JSON file that defines the
10762 credentials.
10763
10764 =item
10765
10766 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10767 checked. This where credentials used by the I<gcloud> command line utility are
10768 stored. You can use C<gcloud auth application-default login> to create these
10769 credentials.
10770
10771 Please note that these credentials are often of your personal account, not a
10772 service account, and are therefore unfit to be used in a production
10773 environment.
10774
10775 =item
10776
10777 When running on GCE, the built-in service account associated with the virtual
10778 machine instance is used.
10779 See also the B<Email> option below.
10780
10781 =back
10782
10783 =item B<Project> I<Project>
10784
10785 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10786 I<Project ID> is a string identifying the GCP project, which you can chose
10787 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10788 number. You can look up both on the I<Developer Console>.
10789
10790 This setting is optional. If not set, the project ID is read from the
10791 credentials file or determined from the GCE's metadata service.
10792
10793 =item B<Email> I<Email> (GCE only)
10794
10795 Choses the GCE I<Service Account> used for authentication.
10796
10797 Each GCE instance has a C<default> I<Service Account> but may also be
10798 associated with additional I<Service Accounts>. This is often used to restrict
10799 the permissions of services running on the GCE instance to the required
10800 minimum. The I<write_stackdriver plugin> requires the
10801 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10802 Accounts> are available, this option selects which one is used by
10803 I<write_stackdriver plugin>.
10804
10805 =item B<Resource> I<ResourceType>
10806
10807 Configures the I<Monitored Resource> to use when storing metrics.
10808 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10809 available at L<https://cloud.google.com/monitoring/api/resources>.
10810
10811 This block takes one string argument, the I<ResourceType>. Inside the block are
10812 one or more B<Label> options which configure the resource labels.
10813
10814 This block is optional. The default value depends on the runtime environment:
10815 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10816 resource type ist used:
10817
10818 =over 4
10819
10820 =item
10821
10822 B<On GCE>, defaults to the equivalent of this config:
10823
10824   <Resource "gce_instance">
10825     Label "project_id" "<project_id>"
10826     Label "instance_id" "<instance_id>"
10827     Label "zone" "<zone>"
10828   </Resource>
10829
10830 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10831 metadata service.
10832
10833 =item
10834
10835 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10836
10837   <Resource "global">
10838     Label "project_id" "<Project>"
10839   </Resource>
10840
10841 Where I<Project> refers to the value of the B<Project> option or the project ID
10842 inferred from the B<CredentialFile>.
10843
10844 =back
10845
10846 =item B<Url> I<Url>
10847
10848 URL of the I<Stackdriver Monitoring> API. Defaults to
10849 C<https://monitoring.googleapis.com/v3>.
10850
10851 =back
10852
10853 =head2 Plugin C<write_syslog>
10854
10855 The C<write_syslog> plugin writes data in I<syslog> format log messages.
10856 It implements the basic syslog protocol, RFC 5424, extends it with
10857 content-based filtering, rich filtering capabilities,
10858 flexible configuration options and adds features such as using TCP for transport.
10859 The plugin can connect to a I<Syslog> daemon, like syslog-ng and rsyslog, that will
10860 ingest metrics, transform and ship them to the specified output.
10861 The plugin uses I<TCP> over the "line based" protocol with a default port 44514.
10862 The data will be sent in blocks of at most 1428 bytes to minimize the number of
10863 network packets.
10864
10865 Synopsis:
10866
10867  <Plugin write_syslog>
10868    ResolveInterval 60
10869    ResolveJitter 60
10870    <Node "example">
10871      Host "syslog-1.my.domain"
10872      Port "44514"
10873      Prefix "collectd"
10874      MessageFormat "human"
10875      HostTags ""
10876    </Node>
10877  </Plugin>
10878
10879 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
10880 blocks and global directives.
10881
10882 Global directives are:
10883
10884 =over 4
10885
10886 =item B<ResolveInterval> I<seconds>
10887
10888 =item B<ResolveJitter> I<seconds>
10889
10890 When I<collectd> connects to a syslog node, it will request the hostname from
10891 DNS. This can become a problem if the syslog node is unavailable or badly
10892 configured because collectd will request DNS in order to reconnect for every
10893 metric, which can flood your DNS. So you can cache the last value for
10894 I<ResolveInterval> seconds.
10895 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10896
10897 You can also define a jitter, a random interval to wait in addition to
10898 I<ResolveInterval>. This prevents all your collectd servers to resolve the
10899 hostname at the same time when the connection fails.
10900 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10901
10902 B<Note:> If the DNS resolution has already been successful when the socket
10903 closes, the plugin will try to reconnect immediately with the cached
10904 information. DNS is queried only when the socket is closed for a longer than
10905 I<ResolveInterval> + I<ResolveJitter> seconds.
10906
10907 =back
10908
10909 Inside the B<Node> blocks, the following options are recognized:
10910
10911 =over 4
10912
10913 =item B<Host> I<Address>
10914
10915 Hostname or address to connect to. Defaults to C<localhost>.
10916
10917 =item B<Port> I<Service>
10918
10919 Service name or port number to connect to. Defaults to C<44514>.
10920
10921
10922 =item B<HostTags> I<String>
10923
10924 When set, I<HostTags> is added to the end of the metric.
10925 It is intended to be used for adding additional metadata to tag the metric with.
10926 Dots and whitespace are I<not> escaped in this string.
10927
10928 Examples:
10929
10930 When MessageFormat is set to "human".
10931
10932   ["prefix1" "example1"="example1_v"]["prefix2" "example2"="example2_v"]"
10933
10934 When MessageFormat is set to "JSON", text should be in JSON format.
10935 Escaping the quotation marks is required.
10936
10937   HostTags "\"prefix1\": {\"example1\":\"example1_v\",\"example2\":\"example2_v\"}"
10938
10939 =item B<MessageFormat> I<String>
10940
10941 I<MessageFormat> selects the format in which messages are sent to the
10942 syslog deamon, human or JSON. Defaults to human.
10943
10944 Syslog message format:
10945
10946 <priority>VERSION ISOTIMESTAMP HOSTNAME APPLICATION PID MESSAGEID STRUCTURED-DATA MSG
10947
10948 The difference between the message formats are in the STRUCTURED-DATA and MSG parts.
10949
10950 Human format:
10951
10952   <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID
10953   ["collectd" "value": "v1" "plugin"="plugin_v" "plugin_instance"="plugin_instance_v"
10954   "type_instance"="type_instance_v" "type"="type_v" "ds_name"="ds_name_v" "interval"="interval_v" ]
10955   "host_tag_example"="host_tag_example_v" plugin_v.type_v.ds_name_v="v1"
10956
10957 JSON format:
10958
10959   <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID STRUCTURED-DATA
10960   {
10961     "collectd": {
10962     "time": time_as_epoch, "interval": interval_v, "plugin": "plugin_v",
10963     "plugin_instance": "plugin_instance_v", "type":"type_v",
10964     "type_instance": "type_instance_v", "plugin_v": {"type_v": v1}
10965     } , "host":"host_v", "host_tag_example": "host_tag_example_v"
10966   }
10967
10968 =item B<StoreRates> B<false>|B<true>
10969
10970 If set to B<true>, convert counter values to rates. If set to B<false>
10971 (the default) counter values are stored as is, as an increasing
10972 integer number.
10973
10974 =item B<AlwaysAppendDS> B<false>|B<true>
10975
10976 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10977 identifier. If set to B<false> (the default), this is only done when there is
10978 more than one DS.
10979
10980 =item B<Prefix> I<String>
10981
10982 When set, I<Prefix> is added to all metrics names as a prefix. It is intended in
10983 case you want to be able to define the source of the specific metric. Dots and
10984 whitespace are I<not> escaped in this string.
10985
10986 =back
10987
10988 =head2 Plugin C<xencpu>
10989
10990 This plugin collects metrics of hardware CPU load for machine running Xen
10991 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10992 Result is reported using the C<percent> type, for each CPU (core).
10993
10994 This plugin doesn't have any options (yet).
10995
10996 =head2 Plugin C<zookeeper>
10997
10998 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10999 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
11000 client port.
11001
11002 B<Synopsis:>
11003
11004  <Plugin "zookeeper">
11005    Host "127.0.0.1"
11006    Port "2181"
11007  </Plugin>
11008
11009 =over 4
11010
11011 =item B<Host> I<Address>
11012
11013 Hostname or address to connect to. Defaults to C<localhost>.
11014
11015 =item B<Port> I<Service>
11016
11017 Service name or port number to connect to. Defaults to C<2181>.
11018
11019 =back
11020
11021 =head1 THRESHOLD CONFIGURATION
11022
11023 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
11024 we mean that the values are not only stored or sent somewhere, but that they
11025 are judged and, if a problem is recognized, acted upon. The only action
11026 collectd takes itself is to generate and dispatch a "notification". Plugins can
11027 register to receive notifications and perform appropriate further actions.
11028
11029 Since systems and what you expect them to do differ a lot, you can configure
11030 B<thresholds> for your values freely. This gives you a lot of flexibility but
11031 also a lot of responsibility.
11032
11033 Every time a value is out of range a notification is dispatched. This means
11034 that the idle percentage of your CPU needs to be less then the configured
11035 threshold only once for a notification to be generated. There's no such thing
11036 as a moving average or similar - at least not now.
11037
11038 Also, all values that match a threshold are considered to be relevant or
11039 "interesting". As a consequence collectd will issue a notification if they are
11040 not received for B<Timeout> iterations. The B<Timeout> configuration option is
11041 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
11042 "2" (the default) and some hosts sends it's CPU statistics to the server every
11043 60 seconds, a notification will be dispatched after about 120 seconds. It may
11044 take a little longer because the timeout is checked only once each B<Interval>
11045 on the server.
11046
11047 When a value comes within range again or is received after it was missing, an
11048 "OKAY-notification" is dispatched.
11049
11050 Here is a configuration example to get you started. Read below for more
11051 information.
11052
11053  <Plugin threshold>
11054    <Type "foo">
11055      WarningMin    0.00
11056      WarningMax 1000.00
11057      FailureMin    0.00
11058      FailureMax 1200.00
11059      Invert false
11060      Instance "bar"
11061    </Type>
11062
11063    <Plugin "interface">
11064      Instance "eth0"
11065      <Type "if_octets">
11066        FailureMax 10000000
11067        DataSource "rx"
11068      </Type>
11069    </Plugin>
11070
11071    <Host "hostname">
11072      <Type "cpu">
11073        Instance "idle"
11074        FailureMin 10
11075      </Type>
11076
11077      <Plugin "memory">
11078        <Type "memory">
11079          Instance "cached"
11080          WarningMin 100000000
11081        </Type>
11082      </Plugin>
11083    </Host>
11084  </Plugin>
11085
11086 There are basically two types of configuration statements: The C<Host>,
11087 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
11088 configured. The C<Plugin> and C<Type> blocks may be specified further using the
11089 C<Instance> option. You can combine the block by nesting the blocks, though
11090 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
11091 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
11092 C<Type> may not contain other blocks. If multiple blocks apply to the same
11093 value the most specific block is used.
11094
11095 The other statements specify the threshold to configure. They B<must> be
11096 included in a C<Type> block. Currently the following statements are recognized:
11097
11098 =over 4
11099
11100 =item B<FailureMax> I<Value>
11101
11102 =item B<WarningMax> I<Value>
11103
11104 Sets the upper bound of acceptable values. If unset defaults to positive
11105 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
11106 will be created. If the value is greater than B<WarningMax> but less than (or
11107 equal to) B<FailureMax> a B<WARNING> notification will be created.
11108
11109 =item B<FailureMin> I<Value>
11110
11111 =item B<WarningMin> I<Value>
11112
11113 Sets the lower bound of acceptable values. If unset defaults to negative
11114 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
11115 be created. If the value is less than B<WarningMin> but greater than (or equal
11116 to) B<FailureMin> a B<WARNING> notification will be created.
11117
11118 =item B<DataSource> I<DSName>
11119
11120 Some data sets have more than one "data source". Interesting examples are the
11121 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
11122 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
11123 system load data set, C<load>, even has three data sources: C<shortterm>,
11124 C<midterm>, and C<longterm>.
11125
11126 Normally, all data sources are checked against a configured threshold. If this
11127 is undesirable, or if you want to specify different limits for each data
11128 source, you can use the B<DataSource> option to have a threshold apply only to
11129 one data source.
11130
11131 =item B<Invert> B<true>|B<false>
11132
11133 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
11134 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
11135 B<WarningMax>) are not okay. Defaults to B<false>.
11136
11137 =item B<Persist> B<true>|B<false>
11138
11139 Sets how often notifications are generated. If set to B<true> one notification
11140 will be generated for each value that is out of the acceptable range. If set to
11141 B<false> (the default) then a notification is only generated if a value is out
11142 of range but the previous value was okay.
11143
11144 This applies to missing values, too: If set to B<true> a notification about a
11145 missing value is generated once every B<Interval> seconds. If set to B<false>
11146 only one such notification is generated until the value appears again.
11147
11148 =item B<Percentage> B<true>|B<false>
11149
11150 If set to B<true>, the minimum and maximum values given are interpreted as
11151 percentage value, relative to the other data sources. This is helpful for
11152 example for the "df" type, where you may want to issue a warning when less than
11153 5E<nbsp>% of the total space is available. Defaults to B<false>.
11154
11155 =item B<Hits> I<Number>
11156
11157 Delay creating the notification until the threshold has been passed I<Number>
11158 times. When a notification has been generated, or when a subsequent value is
11159 inside the threshold, the counter is reset. If, for example, a value is
11160 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
11161 will be dispatched at most once every 30E<nbsp>seconds.
11162
11163 This is useful when short bursts are not a problem. If, for example, 100% CPU
11164 usage for up to a minute is normal (and data is collected every
11165 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
11166
11167 =item B<Hysteresis> I<Number>
11168
11169 When set to non-zero, a hysteresis value is applied when checking minimum and
11170 maximum bounds. This is useful for values that increase slowly and fluctuate a
11171 bit while doing so. When these values come close to the threshold, they may
11172 "flap", i.e. switch between failure / warning case and okay case repeatedly.
11173
11174 If, for example, the threshold is configures as
11175
11176   WarningMax 100.0
11177   Hysteresis 1.0
11178
11179 then a I<Warning> notification is created when the value exceeds I<101> and the
11180 corresponding I<Okay> notification is only created once the value falls below
11181 I<99>, thus avoiding the "flapping".
11182
11183 =back
11184
11185 =head1 FILTER CONFIGURATION
11186
11187 Starting with collectd 4.6 there is a powerful filtering infrastructure
11188 implemented in the daemon. The concept has mostly been copied from
11189 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
11190 terminology, so that users that are familiar with iptables feel right at home.
11191
11192 =head2 Terminology
11193
11194 The following are the terms used in the remainder of the filter configuration
11195 documentation. For an ASCII-art schema of the mechanism, see
11196 L<"General structure"> below.
11197
11198 =over 4
11199
11200 =item B<Match>
11201
11202 A I<match> is a criteria to select specific values. Examples are, of course, the
11203 name of the value or it's current value.
11204
11205 Matches are implemented in plugins which you have to load prior to using the
11206 match. The name of such plugins starts with the "match_" prefix.
11207
11208 =item B<Target>
11209
11210 A I<target> is some action that is to be performed with data. Such actions
11211 could, for example, be to change part of the value's identifier or to ignore
11212 the value completely.
11213
11214 Some of these targets are built into the daemon, see L<"Built-in targets">
11215 below. Other targets are implemented in plugins which you have to load prior to
11216 using the target. The name of such plugins starts with the "target_" prefix.
11217
11218 =item B<Rule>
11219
11220 The combination of any number of matches and at least one target is called a
11221 I<rule>. The target actions will be performed for all values for which B<all>
11222 matches apply. If the rule does not have any matches associated with it, the
11223 target action will be performed for all values.
11224
11225 =item B<Chain>
11226
11227 A I<chain> is a list of rules and possibly default targets. The rules are tried
11228 in order and if one matches, the associated target will be called. If a value
11229 is handled by a rule, it depends on the target whether or not any subsequent
11230 rules are considered or if traversal of the chain is aborted, see
11231 L<"Flow control"> below. After all rules have been checked, the default targets
11232 will be executed.
11233
11234 =back
11235
11236 =head2 General structure
11237
11238 The following shows the resulting structure:
11239
11240  +---------+
11241  ! Chain   !
11242  +---------+
11243       !
11244       V
11245  +---------+  +---------+  +---------+  +---------+
11246  ! Rule    !->! Match   !->! Match   !->! Target  !
11247  +---------+  +---------+  +---------+  +---------+
11248       !
11249       V
11250  +---------+  +---------+  +---------+
11251  ! Rule    !->! Target  !->! Target  !
11252  +---------+  +---------+  +---------+
11253       !
11254       V
11255       :
11256       :
11257       !
11258       V
11259  +---------+  +---------+  +---------+
11260  ! Rule    !->! Match   !->! Target  !
11261  +---------+  +---------+  +---------+
11262       !
11263       V
11264  +---------+
11265  ! Default !
11266  ! Target  !
11267  +---------+
11268
11269 =head2 Flow control
11270
11271 There are four ways to control which way a value takes through the filter
11272 mechanism:
11273
11274 =over 4
11275
11276 =item B<jump>
11277
11278 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
11279 process the value with another chain. When the called chain finishes, usually
11280 the next target or rule after the jump is executed.
11281
11282 =item B<stop>
11283
11284 The stop condition, signaled for example by the built-in target B<stop>, causes
11285 all processing of the value to be stopped immediately.
11286
11287 =item B<return>
11288
11289 Causes processing in the current chain to be aborted, but processing of the
11290 value generally will continue. This means that if the chain was called via
11291 B<Jump>, the next target or rule after the jump will be executed. If the chain
11292 was not called by another chain, control will be returned to the daemon and it
11293 may pass the value to another chain.
11294
11295 =item B<continue>
11296
11297 Most targets will signal the B<continue> condition, meaning that processing
11298 should continue normally. There is no special built-in target for this
11299 condition.
11300
11301 =back
11302
11303 =head2 Synopsis
11304
11305 The configuration reflects this structure directly:
11306
11307  PostCacheChain "PostCache"
11308  <Chain "PostCache">
11309    <Rule "ignore_mysql_show">
11310      <Match "regex">
11311        Plugin "^mysql$"
11312        Type "^mysql_command$"
11313        TypeInstance "^show_"
11314      </Match>
11315      <Target "stop">
11316      </Target>
11317    </Rule>
11318    <Target "write">
11319      Plugin "rrdtool"
11320    </Target>
11321  </Chain>
11322
11323 The above configuration example will ignore all values where the plugin field
11324 is "mysql", the type is "mysql_command" and the type instance begins with
11325 "show_". All other values will be sent to the C<rrdtool> write plugin via the
11326 default target of the chain. Since this chain is run after the value has been
11327 added to the cache, the MySQL C<show_*> command statistics will be available
11328 via the C<unixsock> plugin.
11329
11330 =head2 List of configuration options
11331
11332 =over 4
11333
11334 =item B<PreCacheChain> I<ChainName>
11335
11336 =item B<PostCacheChain> I<ChainName>
11337
11338 Configure the name of the "pre-cache chain" and the "post-cache chain". The
11339 argument is the name of a I<chain> that should be executed before and/or after
11340 the values have been added to the cache.
11341
11342 To understand the implications, it's important you know what is going on inside
11343 I<collectd>. The following diagram shows how values are passed from the
11344 read-plugins to the write-plugins:
11345
11346    +---------------+
11347    !  Read-Plugin  !
11348    +-------+-------+
11349            !
11350  + - - - - V - - - - +
11351  : +---------------+ :
11352  : !   Pre-Cache   ! :
11353  : !     Chain     ! :
11354  : +-------+-------+ :
11355  :         !         :
11356  :         V         :
11357  : +-------+-------+ :  +---------------+
11358  : !     Cache     !--->!  Value Cache  !
11359  : !     insert    ! :  +---+---+-------+
11360  : +-------+-------+ :      !   !
11361  :         !   ,------------'   !
11362  :         V   V     :          V
11363  : +-------+---+---+ :  +-------+-------+
11364  : !  Post-Cache   +--->! Write-Plugins !
11365  : !     Chain     ! :  +---------------+
11366  : +---------------+ :
11367  :                   :
11368  :  dispatch values  :
11369  + - - - - - - - - - +
11370
11371 After the values are passed from the "read" plugins to the dispatch functions,
11372 the pre-cache chain is run first. The values are added to the internal cache
11373 afterwards. The post-cache chain is run after the values have been added to the
11374 cache. So why is it such a huge deal if chains are run before or after the
11375 values have been added to this cache?
11376
11377 Targets that change the identifier of a value list should be executed before
11378 the values are added to the cache, so that the name in the cache matches the
11379 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
11380 this cache to receive a list of all available values. If you change the
11381 identifier after the value list has been added to the cache, this may easily
11382 lead to confusion, but it's not forbidden of course.
11383
11384 The cache is also used to convert counter values to rates. These rates are, for
11385 example, used by the C<value> match (see below). If you use the rate stored in
11386 the cache B<before> the new value is added, you will use the old, B<previous>
11387 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
11388 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
11389 command.
11390
11391 Last but not last, the B<stop> target makes a difference: If the pre-cache
11392 chain returns the stop condition, the value will not be added to the cache and
11393 the post-cache chain will not be run.
11394
11395 =item B<Chain> I<Name>
11396
11397 Adds a new chain with a certain name. This name can be used to refer to a
11398 specific chain, for example to jump to it.
11399
11400 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
11401
11402 =item B<Rule> [I<Name>]
11403
11404 Adds a new rule to the current chain. The name of the rule is optional and
11405 currently has no meaning for the daemon.
11406
11407 Within the B<Rule> block, there may be any number of B<Match> blocks and there
11408 must be at least one B<Target> block.
11409
11410 =item B<Match> I<Name>
11411
11412 Adds a match to a B<Rule> block. The name specifies what kind of match should
11413 be performed. Available matches depend on the plugins that have been loaded.
11414
11415 The arguments inside the B<Match> block are passed to the plugin implementing
11416 the match, so which arguments are valid here depends on the plugin being used.
11417 If you do not need any to pass any arguments to a match, you can use the
11418 shorter syntax:
11419
11420  Match "foobar"
11421
11422 Which is equivalent to:
11423
11424  <Match "foobar">
11425  </Match>
11426
11427 =item B<Target> I<Name>
11428
11429 Add a target to a rule or a default target to a chain. The name specifies what
11430 kind of target is to be added. Which targets are available depends on the
11431 plugins being loaded.
11432
11433 The arguments inside the B<Target> block are passed to the plugin implementing
11434 the target, so which arguments are valid here depends on the plugin being used.
11435 If you do not need any to pass any arguments to a target, you can use the
11436 shorter syntax:
11437
11438  Target "stop"
11439
11440 This is the same as writing:
11441
11442  <Target "stop">
11443  </Target>
11444
11445 =back
11446
11447 =head2 Built-in targets
11448
11449 The following targets are built into the core daemon and therefore need no
11450 plugins to be loaded:
11451
11452 =over 4
11453
11454 =item B<return>
11455
11456 Signals the "return" condition, see the L<"Flow control"> section above. This
11457 causes the current chain to stop processing the value and returns control to
11458 the calling chain. The calling chain will continue processing targets and rules
11459 just after the B<jump> target (see below). This is very similar to the
11460 B<RETURN> target of iptables, see L<iptables(8)>.
11461
11462 This target does not have any options.
11463
11464 Example:
11465
11466  Target "return"
11467
11468 =item B<stop>
11469
11470 Signals the "stop" condition, see the L<"Flow control"> section above. This
11471 causes processing of the value to be aborted immediately. This is similar to
11472 the B<DROP> target of iptables, see L<iptables(8)>.
11473
11474 This target does not have any options.
11475
11476 Example:
11477
11478  Target "stop"
11479
11480 =item B<write>
11481
11482 Sends the value to "write" plugins.
11483
11484 Available options:
11485
11486 =over 4
11487
11488 =item B<Plugin> I<Name>
11489
11490 Name of the write plugin to which the data should be sent. This option may be
11491 given multiple times to send the data to more than one write plugin. If the
11492 plugin supports multiple instances, the plugin's instance(s) must also be
11493 specified.
11494
11495 =back
11496
11497 If no plugin is explicitly specified, the values will be sent to all available
11498 write plugins.
11499
11500 Single-instance plugin example:
11501
11502  <Target "write">
11503    Plugin "rrdtool"
11504  </Target>
11505
11506 Multi-instance plugin example:
11507
11508  <Plugin "write_graphite">
11509    <Node "foo">
11510    ...
11511    </Node>
11512    <Node "bar">
11513    ...
11514    </Node>
11515  </Plugin>
11516   ...
11517  <Target "write">
11518    Plugin "write_graphite/foo"
11519  </Target>
11520
11521 =item B<jump>
11522
11523 Starts processing the rules of another chain, see L<"Flow control"> above. If
11524 the end of that chain is reached, or a stop condition is encountered,
11525 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11526 next target or the next rule. This is similar to the B<-j> command line option
11527 of iptables, see L<iptables(8)>.
11528
11529 Available options:
11530
11531 =over 4
11532
11533 =item B<Chain> I<Name>
11534
11535 Jumps to the chain I<Name>. This argument is required and may appear only once.
11536
11537 =back
11538
11539 Example:
11540
11541  <Target "jump">
11542    Chain "foobar"
11543  </Target>
11544
11545 =back
11546
11547 =head2 Available matches
11548
11549 =over 4
11550
11551 =item B<regex>
11552
11553 Matches a value using regular expressions.
11554
11555 Available options:
11556
11557 =over 4
11558
11559 =item B<Host> I<Regex>
11560
11561 =item B<Plugin> I<Regex>
11562
11563 =item B<PluginInstance> I<Regex>
11564
11565 =item B<Type> I<Regex>
11566
11567 =item B<TypeInstance> I<Regex>
11568
11569 =item B<MetaData> I<String> I<Regex>
11570
11571 Match values where the given regular expressions match the various fields of
11572 the identifier of a value. If multiple regular expressions are given, B<all>
11573 regexen must match for a value to match.
11574
11575 =item B<Invert> B<false>|B<true>
11576
11577 When set to B<true>, the result of the match is inverted, i.e. all value lists
11578 where all regular expressions apply are not matched, all other value lists are
11579 matched. Defaults to B<false>.
11580
11581 =back
11582
11583 Example:
11584
11585  <Match "regex">
11586    Host "customer[0-9]+"
11587    Plugin "^foobar$"
11588  </Match>
11589
11590 =item B<timediff>
11591
11592 Matches values that have a time which differs from the time on the server.
11593
11594 This match is mainly intended for servers that receive values over the
11595 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11596 is very sensitive to the timestamp used when updating the RRD files. In
11597 particular, the time must be ever increasing. If a misbehaving client sends one
11598 packet with a timestamp far in the future, all further packets with a correct
11599 time will be ignored because of that one packet. What's worse, such corrupted
11600 RRD files are hard to fix.
11601
11602 This match lets one match all values B<outside> a specified time range
11603 (relative to the server's time), so you can use the B<stop> target (see below)
11604 to ignore the value, for example.
11605
11606 Available options:
11607
11608 =over 4
11609
11610 =item B<Future> I<Seconds>
11611
11612 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11613 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11614 non-zero.
11615
11616 =item B<Past> I<Seconds>
11617
11618 Matches all values that are I<behind> of the server's time by I<Seconds> or
11619 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11620 non-zero.
11621
11622 =back
11623
11624 Example:
11625
11626  <Match "timediff">
11627    Future  300
11628    Past   3600
11629  </Match>
11630
11631 This example matches all values that are five minutes or more ahead of the
11632 server or one hour (or more) lagging behind.
11633
11634 =item B<value>
11635
11636 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11637 values. If a data-set consists of more than one data-source, all data-sources
11638 must match the specified ranges for a positive match.
11639
11640 Available options:
11641
11642 =over 4
11643
11644 =item B<Min> I<Value>
11645
11646 Sets the smallest value which still results in a match. If unset, behaves like
11647 negative infinity.
11648
11649 =item B<Max> I<Value>
11650
11651 Sets the largest value which still results in a match. If unset, behaves like
11652 positive infinity.
11653
11654 =item B<Invert> B<true>|B<false>
11655
11656 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11657 no-match is returned and vice versa. Please note that the B<Invert> setting
11658 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11659 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11660
11661 =item B<DataSource> I<DSName> [I<DSName> ...]
11662
11663 Select one or more of the data sources. If no data source is configured, all
11664 data sources will be checked. If the type handled by the match does not have a
11665 data source of the specified name(s), this will always result in no match
11666 (independent of the B<Invert> setting).
11667
11668 =item B<Satisfy> B<Any>|B<All>
11669
11670 Specifies how checking with several data sources is performed. If set to
11671 B<Any>, the match succeeds if one of the data sources is in the configured
11672 range. If set to B<All> the match only succeeds if all data sources are within
11673 the configured range. Default is B<All>.
11674
11675 Usually B<All> is used for positive matches, B<Any> is used for negative
11676 matches. This means that with B<All> you usually check that all values are in a
11677 "good" range, while with B<Any> you check if any value is within a "bad" range
11678 (or outside the "good" range).
11679
11680 =back
11681
11682 Either B<Min> or B<Max>, but not both, may be unset.
11683
11684 Example:
11685
11686  # Match all values smaller than or equal to 100. Matches only if all data
11687  # sources are below 100.
11688  <Match "value">
11689    Max 100
11690    Satisfy "All"
11691  </Match>
11692
11693  # Match if the value of any data source is outside the range of 0 - 100.
11694  <Match "value">
11695    Min   0
11696    Max 100
11697    Invert true
11698    Satisfy "Any"
11699  </Match>
11700
11701 =item B<empty_counter>
11702
11703 Matches all values with one or more data sources of type B<COUNTER> and where
11704 all counter values are zero. These counters usually I<never> increased since
11705 they started existing (and are therefore uninteresting), or got reset recently
11706 or overflowed and you had really, I<really> bad luck.
11707
11708 Please keep in mind that ignoring such counters can result in confusing
11709 behavior: Counters which hardly ever increase will be zero for long periods of
11710 time. If the counter is reset for some reason (machine or service restarted,
11711 usually), the graph will be empty (NAN) for a long time. People may not
11712 understand why.
11713
11714 =item B<hashed>
11715
11716 Calculates a hash value of the host name and matches values according to that
11717 hash value. This makes it possible to divide all hosts into groups and match
11718 only values that are in a specific group. The intended use is in load
11719 balancing, where you want to handle only part of all data and leave the rest
11720 for other servers.
11721
11722 The hashing function used tries to distribute the hosts evenly. First, it
11723 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11724
11725   hash_value = 0;
11726   for (i = 0; host[i] != 0; i++)
11727     hash_value = (hash_value * 251) + host[i];
11728
11729 The constant 251 is a prime number which is supposed to make this hash value
11730 more random. The code then checks the group for this host according to the
11731 I<Total> and I<Match> arguments:
11732
11733   if ((hash_value % Total) == Match)
11734     matches;
11735   else
11736     does not match;
11737
11738 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11739 groups), then the least significant bit of the hash value will be the XOR of
11740 all least significant bits in the host name. One consequence is that when you
11741 have two hosts, "server0.example.com" and "server1.example.com", where the host
11742 name differs in one digit only and the digits differ by one, those hosts will
11743 never end up in the same group.
11744
11745 Available options:
11746
11747 =over 4
11748
11749 =item B<Match> I<Match> I<Total>
11750
11751 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11752 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11753 be smaller than I<Total>. I<Total> must be at least one, although only values
11754 greater than one really do make any sense.
11755
11756 You can repeat this option to match multiple groups, for example:
11757
11758   Match 3 7
11759   Match 5 7
11760
11761 The above config will divide the data into seven groups and match groups three
11762 and five. One use would be to keep every value on two hosts so that if one
11763 fails the missing data can later be reconstructed from the second host.
11764
11765 =back
11766
11767 Example:
11768
11769  # Operate on the pre-cache chain, so that ignored values are not even in the
11770  # global cache.
11771  <Chain "PreCache">
11772    <Rule>
11773      <Match "hashed">
11774        # Divide all received hosts in seven groups and accept all hosts in
11775        # group three.
11776        Match 3 7
11777      </Match>
11778      # If matched: Return and continue.
11779      Target "return"
11780    </Rule>
11781    # If not matched: Return and stop.
11782    Target "stop"
11783  </Chain>
11784
11785 =back
11786
11787 =head2 Available targets
11788
11789 =over 4
11790
11791 =item B<notification>
11792
11793 Creates and dispatches a notification.
11794
11795 Available options:
11796
11797 =over 4
11798
11799 =item B<Message> I<String>
11800
11801 This required option sets the message of the notification. The following
11802 placeholders will be replaced by an appropriate value:
11803
11804 =over 4
11805
11806 =item B<%{host}>
11807
11808 =item B<%{plugin}>
11809
11810 =item B<%{plugin_instance}>
11811
11812 =item B<%{type}>
11813
11814 =item B<%{type_instance}>
11815
11816 These placeholders are replaced by the identifier field of the same name.
11817
11818 =item B<%{ds:>I<name>B<}>
11819
11820 These placeholders are replaced by a (hopefully) human readable representation
11821 of the current rate of this data source. If you changed the instance name
11822 (using the B<set> or B<replace> targets, see below), it may not be possible to
11823 convert counter values to rates.
11824
11825 =back
11826
11827 Please note that these placeholders are B<case sensitive>!
11828
11829 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11830
11831 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11832 used.
11833
11834 =back
11835
11836 Example:
11837
11838   <Target "notification">
11839     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11840     Severity "WARNING"
11841   </Target>
11842
11843 =item B<replace>
11844
11845 Replaces parts of the identifier using regular expressions.
11846
11847 Available options:
11848
11849 =over 4
11850
11851 =item B<Host> I<Regex> I<Replacement>
11852
11853 =item B<Plugin> I<Regex> I<Replacement>
11854
11855 =item B<PluginInstance> I<Regex> I<Replacement>
11856
11857 =item B<TypeInstance> I<Regex> I<Replacement>
11858
11859 =item B<MetaData> I<String> I<Regex> I<Replacement>
11860
11861 =item B<DeleteMetaData> I<String> I<Regex>
11862
11863 Match the appropriate field with the given regular expression I<Regex>. If the
11864 regular expression matches, that part that matches is replaced with
11865 I<Replacement>. If multiple places of the input buffer match a given regular
11866 expression, only the first occurrence will be replaced.
11867
11868 You can specify each option multiple times to use multiple regular expressions
11869 one after another.
11870
11871 =back
11872
11873 Example:
11874
11875  <Target "replace">
11876    # Replace "example.net" with "example.com"
11877    Host "\\<example.net\\>" "example.com"
11878
11879    # Strip "www." from hostnames
11880    Host "\\<www\\." ""
11881  </Target>
11882
11883 =item B<set>
11884
11885 Sets part of the identifier of a value to a given string.
11886
11887 Available options:
11888
11889 =over 4
11890
11891 =item B<Host> I<String>
11892
11893 =item B<Plugin> I<String>
11894
11895 =item B<PluginInstance> I<String>
11896
11897 =item B<TypeInstance> I<String>
11898
11899 =item B<MetaData> I<String> I<String>
11900
11901 Set the appropriate field to the given string. The strings for plugin instance,
11902 type instance, and meta data may be empty, the strings for host and plugin may
11903 not be empty. It's currently not possible to set the type of a value this way.
11904
11905 The following placeholders will be replaced by an appropriate value:
11906
11907 =over 4
11908
11909 =item B<%{host}>
11910
11911 =item B<%{plugin}>
11912
11913 =item B<%{plugin_instance}>
11914
11915 =item B<%{type}>
11916
11917 =item B<%{type_instance}>
11918
11919 These placeholders are replaced by the identifier field of the same name.
11920
11921 =item B<%{meta:>I<name>B<}>
11922
11923 These placeholders are replaced by the meta data value with the given name.
11924
11925 =back
11926
11927 Please note that these placeholders are B<case sensitive>!
11928
11929 =item B<DeleteMetaData> I<String>
11930
11931 Delete the named meta data field.
11932
11933 =back
11934
11935 Example:
11936
11937  <Target "set">
11938    PluginInstance "coretemp"
11939    TypeInstance "core3"
11940  </Target>
11941
11942 =back
11943
11944 =head2 Backwards compatibility
11945
11946 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11947 B<Chain> block, it will behave as it used to. This is equivalent to the
11948 following configuration:
11949
11950  <Chain "PostCache">
11951    Target "write"
11952  </Chain>
11953
11954 If you specify a B<PostCacheChain>, the B<write> target will not be added
11955 anywhere and you will have to make sure that it is called where appropriate. We
11956 suggest to add the above snippet as default target to your "PostCache" chain.
11957
11958 =head2 Examples
11959
11960 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11961 be an FQDN.
11962
11963  <Chain "PreCache">
11964    <Rule "no_fqdn">
11965      <Match "regex">
11966        Host "^[^\.]*$"
11967      </Match>
11968      Target "stop"
11969    </Rule>
11970    Target "write"
11971  </Chain>
11972
11973 =head1 IGNORELISTS
11974
11975 B<Ignorelists> are a generic framework to either ignore some metrics or report
11976 specific metrics only. Plugins usually provide one or more options to specify
11977 the items (mounts points, devices, ...) and the boolean option
11978 C<IgnoreSelected>.
11979
11980 =over 4
11981
11982 =item B<Select> I<String>
11983
11984 Selects the item I<String>. This option often has a plugin specific name, e.g.
11985 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11986 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11987 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11988
11989 By default, this option is doing a case-sensitive full-string match. The
11990 following config will match C<foo>, but not C<Foo>:
11991
11992   Select "foo"
11993
11994 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11995 I<regular expression>. For example, so match all item starting with C<foo>, use
11996 could use the following syntax:
11997
11998   Select "/^foo/"
11999
12000 The regular expression is I<not> anchored, i.e. the following config will match
12001 C<foobar>, C<barfoo> and C<AfooZ>:
12002
12003   Select "/foo/"
12004
12005 The B<Select> option may be repeated to select multiple items.
12006
12007 =item B<IgnoreSelected> B<true>|B<false>
12008
12009 If set to B<true>, matching metrics are I<ignored> and all other metrics are
12010 collected. If set to B<false>, matching metrics are I<collected> and all other
12011 metrics are ignored.
12012
12013 =back
12014
12015 =head1 SEE ALSO
12016
12017 L<collectd(1)>,
12018 L<collectd-exec(5)>,
12019 L<collectd-perl(5)>,
12020 L<collectd-unixsock(5)>,
12021 L<types.db(5)>,
12022 L<hddtemp(8)>,
12023 L<iptables(8)>,
12024 L<kstat(3KSTAT)>,
12025 L<mbmon(1)>,
12026 L<psql(1)>,
12027 L<regex(7)>,
12028 L<rrdtool(1)>,
12029 L<sensors(1)>
12030
12031 =head1 AUTHOR
12032
12033 Florian Forster E<lt>octo@collectd.orgE<gt>
12034
12035 =cut