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