src/collectd.pod

   1 =head1 NAME
   2
   3 collectd - System statistics collection daemon
   4
   5 =head1 SYNOPSIS
   6
   7 collectd I<[options]>
   8
   9 =head1 DESCRIPTION
  10
  11 collectd is a daemon that collects various system statistics periodically and
  12 stores them into RRD-files. Which data is collected depends on compile-time
  13 settings. The following features may be available:
  14
  15 =over 4
  16
  17 =item
  18
  19 Apache and lighttpd server statistics (I<apache>)
  20
  21 =item
  22
  23 Apple hardware sensors (I<apple_sensors>, Darwin only)
  24
  25 =item
  26
  27 Battery status (I<battery>)
  28
  29 =item
  30
  31 CPU utilization (I<cpu>)
  32
  33 =item
  34
  35 Mountpoint usage (I<df>)
  36
  37 =item
  38
  39 Disk and partition usage/throughput (I<disk>)
  40
  41 =item
  42
  43 DNS traffic (I<dns>)
  44
  45 =item
  46
  47 Email usage (I<email>)
  48
  49 =item
  50
  51 Harddisk temperatures (I<hddtemp>)
  52
  53 =item
  54
  55 Irq (I<irq>)
  56
  57 =item
  58
  59 System load averages (I<load>)
  60
  61 =item
  62
  63 Motherboard monitor (I<mbmon>)
  64
  65 =item
  66
  67 Memory usage (I<memory>)
  68
  69 =item
  70
  71 MySQL statistics (I<mysql>)
  72
  73 =item
  74
  75 NFS utilization (I<nfs>, Linux only)
  76
  77 =item
  78
  79 Network latency (I<ping>)
  80
  81 =item
  82
  83 Number of processes (I<processes>, Linux only)
  84
  85 =item
  86
  87 lm_sensors information (I<sensors>, Linux only)
  88
  89 =item
  90
  91 Serial port traffic (I<serial>, Linux only)
  92
  93 =item
  94
  95 Swap usage (I<swap>)
  96
  97 =item
  98
  99 Tape drive usage (I<tape>, Solaris only)
 100
 101 =item
 102
 103 Network traffic (I<traffic>)
 104
 105 =item
 106
 107 Number of users logged into the system (I<users>)
 108
 109 =item
 110
 111 System ressources used by VServers (I<vserver>)
 112
 113 =item
 114
 115 Wireless network stats (I<wireless>)
 116
 117 =back
 118
 119 =head1 OPTIONS
 120
 121 =over 4
 122
 123 =item B<-C> I<E<lt>config-fileE<gt>>
 124
 125 Specify an alternative config file. This is the place to go when you wish to
 126 change B<collectd>'s behavior. The path may be relative to the current working
 127 directory.
 128
 129 =item B<-P> I<E<lt>pid-fileE<gt>>
 130
 131 Specify an alternative pid file. This overwrites any settings in the config
 132 file. This is thought for init-scripts that require the PID-file in a certain
 133 directory to work correctly. For everyday-usage use the B<PIDFile>
 134 config-option.
 135
 136 =item B<-f>
 137
 138 Don't fork to the background. I<collectd> will also B<not> close standard file
 139 descriptors, detach from the session nor write a pid file. This is mainly
 140 thought for 'supervisioning' init replacements such as I<runit>.
 141
 142 =item B<-h>
 143
 144 Output usage information and exit.
 145
 146 =back
 147
 148 =head1 MODES
 149
 150 collectd can operate in four different operating modes. The modes are described
 151 below.
 152
 153 The simplest mode is the so called B<local mode>. Data is collected locally and
 154 written in RRD files that reside in I<DataDir>. This is the default mode when
 155 collectd is linked against C<librrd>.
 156
 157 The modes B<client mode> and B<server mode> are used to send data over a
 158 network and receive it again.
 159
 160 In B<client mode> the daemon collects the data locally and sends its results
 161 to one or more network addresses. No RRD files are written locally in this
 162 case. If collectd is not linked against C<librrd> this is the default mode.
 163
 164 If started in B<server mode> the daemon will listen on one or more interfaces
 165 and write the data it receives to RRD files. No data is collected locally.
 166
 167 In the last mode, B<log mode>, data is collected locally and written in
 168 text files that reside in I<DataDir>.
 169
 170 Please refer to L<collectd.conf(5)> for the configuration options and default
 171 values.
 172
 173 =head1 SPECIAL PLUGINS
 174
 175 =head2 apache
 176
 177 This module connects to an Apache or lighttpd webserver and expects the output
 178 produced by B<mod_status.c>. If requires B<libcurl> to set up the HTTP
 179 connection and issue the request(s). The following is a sample config for the
 180 Apache webserver. Under Apache, the use of C<ExtendedStatus on> is mandatory.
 181
 182   ExtendedStatus on
 183   <IfModule mod_status.c>
 184     <Location /mod_status>
 185       SetHandler server-status
 186     </Location>
 187   </IfModule>
 188
 189 This plugin requires further configuration. Please read L<collectd.conf(5)>.
 190
 191 =head2 cpufreq
 192
 193 This module reads F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for
 194 the first CPU installed) to get the current CPU frequency. If this file does
 195 not exist make sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a
 196 similar tool is installed and an "cpu governor" (that's kernel module) is
 197 loaded.
 198
 199 =head2 email
 200
 201 This plugin collects data indirectly by providing a UNIX socket that external
 202 programs can connect to. A simple line based protocol is used to communicate
 203 with the plugin:
 204
 205 E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
 206
 207   e:<type>:<size>
 208
 209 If C<size> is less than or equal to zero, C<size> is ignored.
 210
 211 Spam score:
 212
 213   s:<value>
 214
 215 Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
 216
 217   c:<type1>[,<type2>,...]
 218
 219 Each line is limited to 256 characters (including the newline character).
 220 Longer lines will be ignored.
 221
 222 =head2 exec
 223
 224 The C<exec> plugin forks of an executable and reads back values that it writes
 225 to C<STDOUT>. The executable is forked kind of as L<init> does: It is forked
 226 once and not again until it exits. If it exited, it will be forked again after
 227 at most I<Interval> seconds. It is perfectly legal for the executable to run
 228 for a long time and continuously write values to C<STDOUT>.
 229
 230 The forked executable is expected to print values to C<STDOUT>. The expected
 231 format is as follows:
 232
 233 =over 4
 234
 235 =item
 236
 237 Each line beginning with a C<#> (hash mark) is ignored.
 238
 239 =item
 240
 241 Any other line must be of the form C<I<type>,I<type-instance>,I<value>>, where
 242 I<type> is either B<counter> or B<gauge>, I<type-instance> may not contain
 243 C<,> (comma), C</> (slash) and C<\0> (null byte) and I<value> is either an
 244 integer (if I<type> is B<counter>) or a floating-point number (if I<type> is
 245 B<gauge>).
 246
 247 =back
 248
 249 The values are always considered to be "fresh", i.E<nbsp>e. the time is set to
 250 "now".
 251
 252 When collectd exits it sends a B<SIGTERM> to all still running
 253 child-processes upon which they have to quit.
 254
 255 =head2 mysql
 256
 257 Requires B<mysqlclient> to be installed. It connects to the database when
 258 started and keeps the connection up as long as possible. When the connection is
 259 interrupted for whatever reason it will try to re-connect. The syslog will
 260 contain loud complaints in case anything goes wrong.
 261
 262 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
 263 C<Com_*> and C<Handler_*> which correspond to F<traffic-mysql.rrd>,
 264 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
 265 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
 266 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
 267 I<5.2.4. Server Status Variables> for an explanation of these values.
 268
 269 =head2 perl
 270
 271 The C<perl plugin> includes a Perl-interpreter in collectd and provides
 272 Perl-equvalents of the plugin-functions. This makes it possible to write
 273 plugins in Perl.
 274
 275 There are two more comlex types you need to know about:
 276
 277 =over 4
 278
 279 =item Data-Set
 280
 281 A data-set is a list of one or more data-sources. Each data-source defines a
 282 name, type, min- and max-value and the data-set wraps them up into one
 283 structure. The general layout looks like this:
 284
 285   [{
 286     name => 'data_source_name',
 287     type => DS_TYPE_COUNTER || DS_TYPE_GAUGE
 288     min  => value || undef,
 289     max  => value || undef
 290   }, ...]
 291
 292 =item Value-List
 293
 294 A value-list is one structure which features an array of values and fields to
 295 identify the values, i. e. time and host, plugin name and plugin-instance as
 296 well as a type and type-instance. Since the "type" is not included in the
 297 value-list but is passed as an extra argument, the general layout looks like
 298 this:
 299
 300   {
 301     values => [123, 0.5],
 302     time   => time (),
 303     host   => 'localhost',
 304     plugin => 'myplugin',
 305     plugin_instance => '',
 306     type_instance   => ''
 307   }
 308
 309 =back
 310
 311 The following functions provide the C-interface to Perl-modules:
 312
 313 =over 4
 314
 315 =item B<plugin_register> (I<type>, I<name>, I<data>)
 316
 317 Registers a callback-function or data-set.
 318
 319 I<type> can be one of:
 320
 321 =over 4
 322
 323 =item TYPE_INIT
 324
 325 =item TYPE_READ
 326
 327 =item TYPE_WRITE
 328
 329 =item TYPE_LOG
 330
 331 =item TYPE_SHUTDOWN
 332
 333 =item TYPE_DATASET
 334
 335 =back
 336
 337 I<name> is the name of the callback-function or the type of the data-set,
 338 depending on the value of I<type>. (Please note that the type of the data-set
 339 is the value passed as I<name> here and has nothing to do with the I<type>
 340 argument which simply tells B<plugin_register> what is being registered.)
 341
 342 The last argument, I<data>, is either a function- or an array-reference. If
 343 I<type> is B<TYPE_DATASET>, then the I<data> argument must be an
 344 array-reference which points to an array of hashes. Each hash describes one
 345 data-source. For the exact layout see B<Data-Set> above.
 346
 347 If the I<type> argument is any of the other types (B<TYPE_INIT>, B<TYPE_READ>,
 348 ...) when I<data> is expected to be a funtion reference. These functions are
 349 called in the various stages of the daemon and are passed the following
 350 arguments:
 351
 352 =over 4
 353
 354 =item TYPE_INIT
 355
 356 =item TYPE_READ
 357
 358 =item TYPE_SHUTDOWN
 359
 360 No arguments are passed
 361
 362 =item TYPE_WRITE
 363
 364 The arguments passed are I<type>, I<data-set>, and I<value-list>. I<type> is a
 365 string. For the layout of I<data-set> and I<value-list> see above.
 366
 367 =item TYPE_LOG
 368
 369 The arguments are I<log-level> and I<message>. The log level is small for
 370 important messages and high for less important messages. The least important
 371 level is B<LOG_DEBUG>, the most important level is B<LOG_ERR>. In between there
 372 are (from least to most important): B<LOG_INFO>, B<LOG_NOTICE>, and
 373 B<LOG_WARNING>. I<message> is simply a string B<without> a newline at the end.
 374
 375 =back
 376
 377 =item B<plugin_unregister> (I<type>, I<plugin>)
 378
 379 Removes a callback or data-set from collectd's internal list of
 380 functionsE<nbsp>/ datasets.
 381
 382 =item B<plugin_dispatch_values> (I<type>, I<value-list>)
 383
 384 Submits a I<value-list> of type I<type> to the daemon. If the data-set I<type>
 385 is found (and the number of values matches the number of data-sources) then the
 386 type, data-set and value-list is passed to all write-callbacks that are
 387 registered with the daemon.
 388
 389 =item B<plugin_log> (I<log-level>, I<message>)
 390
 391 TODO.
 392
 393 =back
 394
 395 =head2 sensors
 396
 397 The B<sensors> module uses lm_sensors to retrieve sensor-values. This means
 398 that all the needed modules have to be loaded and lm_sensors has to be
 399 configured (most likely by editing F</etc/sensors.conf>. Read
 400 L<sensors.conf(5)> for details.
 401
 402 The B<lm_sensors> homepage can be found at
 403 L<http://secure.netroedge.com/~lm78/>.
 404
 405 =head2 mbmon
 406
 407 The B<mbmon> module uses mbmon to retrieve temperature, voltage, etc.
 408
 409 collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>.
 410 The B<Host> and B<Port> options can be used to change these
 411 default values. See L<collectd.conf(5)> for details. C<mbmon> has to be
 412 running to work correctly. If C<mbmon> is not running timeouts may appear
 413 which may interfere with other statistics..
 414
 415 C<mbmon> must be run with the -r option ("print TAG and Value format");
 416 Debian's /etc/init.d/mbmon script already does this, other people
 417 will need to ensure that this is the case.
 418
 419 =head2 hddtemp
 420
 421 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
 422 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
 423 default values. See L<collectd.conf(5)> for details. C<hddtemp> has to be
 424 running to work correctly. If C<hddtemp> is not running timeouts may appear
 425 which may interfere with other statistics..
 426
 427 The B<hddtemp> homepage can be found at
 428 L<http://www.guzu.net/linux/hddtemp.php>.
 429
 430 =head2 vserver
 431
 432 B<VServer> support is only available for Linux. It cannot yet be found in a
 433 vanilla kernel, though. To make use of this plugin you need a kernel that has
 434 B<VServer> support built in, i.e. you need to apply the patches and compile
 435 your own kernel, which will then provide the /proc/virtual filesystem that is
 436 required by this plugin.
 437
 438 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
 439
 440 =head1 RRD FILES
 441
 442 The RRD files are created automatically. The size of the RRAs depend on the
 443 compile time settings of I<step> and I<width>. With the default values (I<step>
 444 = B<10>, I<width> = B<1200>) the following RRAs are created:
 445
 446   RRA:AVERAGE:0.1:1:8640
 447   RRA:AVERAGE:0.1:50:1210
 448   RRA:AVERAGE:0.1:223:1202
 449   RRA:AVERAGE:0.1:2635:1201
 450   RRA:MIN:0.1:1:8640
 451   RRA:MIN:0.1:50:1210
 452   RRA:MIN:0.1:223:1202
 453   RRA:MIN:0.1:2635:1201
 454   RRA:MAX:0.1:1:8640
 455   RRA:MAX:0.1:50:1210
 456   RRA:MAX:0.1:223:1202
 457   RRA:MAX:0.1:2635:1201
 458
 459 By default collectd uses a 10 second I<step>. Thus the RRAs contain the
 460 following timespans. If you've changed the I<step> at compile time you will
 461 have calculate resolution and timespan yourself.
 462
 463   PDP per CDP |  Resolution  | Data points | Timespan
 464   ------------+--------------+-------------+---------
 465             1 | 10.0 seconds !        8640 ! 1 day
 466            50 |  8.3 minutes |        1210 | 1 week
 467           223 | 37.2 minutes |        1202 | 1 month
 468          2635 |  7.3 hours   |        1201 | 1 year
 469
 470 The DS'es depend on the module creating the RRD files:
 471
 472 =over 4
 473
 474 =item Apache traffic (F<apache/apache_bytes.rrd>)
 475
 476   DS:count:COUNTER:HEARTBEAT:0:134217728
 477
 478 =item Apache requests (F<apache/apache_requests.rrd>)
 479
 480   DS:count:COUNTER:HEARTBEAT:0:1048576
 481
 482 =item Apache scoreboard (F<apache/apache_scoreboard-I<E<lt>nameE<gt>>.rrd>)
 483
 484   DS:count:GAUGE:HEARTBEAT:0:U
 485
 486 =item Apple temperature sensor (F<apple_sensors/temperature-I<E<lt>nameE<gt>>.rrd>)
 487
 488   DS:value:GAUGE:HEARTBEAT:U:U
 489
 490 =item Apple fanspeed sensor (F<apple_sensors/fanspeed-I<E<lt>nameE<gt>>.rrd>)
 491
 492   DS:value:GAUGE:HEARTBEAT:U:U
 493
 494 =item Battery charge (F<battery-I<E<lt>nameE<gt>>/charge.rrd>)
 495
 496   DS:charge:GAUGE:HEARTBEAT:0:U
 497
 498 =item Battery current (F<battery-I<E<lt>nameE<gt>>/current.rrd>)
 499
 500   DS:current:GAUGE:HEARTBEAT:U:U
 501
 502 =item Battery voltage (F<battery-I<E<lt>nameE<gt>>/voltage.rrd>)
 503
 504   DS:voltage:GAUGE:HEARTBEAT:U:U
 505
 506 =item CPU (F<cpu-I<E<lt>numE<gt>>.rrd>)
 507
 508   DS:user:COUNTER:HEARTBEAT:0:100
 509   DS:nice:COUNTER:HEARTBEAT:0:100
 510   DS:syst:COUNTER:HEARTBEAT:0:100
 511   DS:idle:COUNTER:HEARTBEAT:0:100
 512   DS:wait:COUNTER:HEARTBEAT:0:100
 513
 514 =item CPU frequency (F<cpufreq-I<E<lt>numE<gt>>.rrd>)
 515
 516   DS:value:GAUGE:HEARTBEAT:0:U
 517
 518 =item Mountpoints (F<df-I<E<lt>pathE<gt>>.rrd>)
 519
 520   DS:used:GAUGE:HEARTBEAT:0:U
 521   DS:free:GAUGE:HEARTBEAT:0:U
 522
 523 =item Diskstats (F<disk-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 524
 525   DS:rcount:COUNTER:HEARTBEAT:0:U
 526   DS:rmerged:COUNTER:HEARTBEAT:0:U
 527   DS:rbytes:COUNTER:HEARTBEAT:0:U
 528   DS:rtime:COUNTER:HEARTBEAT:0:U
 529   DS:wcount:COUNTER:HEARTBEAT:0:U
 530   DS:wmerged:COUNTER:HEARTBEAT:0:U
 531   DS:wbytes:COUNTER:HEARTBEAT:0:U
 532   DS:wtime:COUNTER:HEARTBEAT:0:U
 533
 534 =item Diskstats (F<partition-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 535
 536   DS:rcount:COUNTER:HEARTBEAT:0:U
 537   DS:rbytes:COUNTER:HEARTBEAT:0:U
 538   DS:wcount:COUNTER:HEARTBEAT:0:U
 539   DS:wbytes:COUNTER:HEARTBEAT:0:U
 540
 541 =item E-Mail count (F<email/email-I<E<lt>typeE<gt>>.rrd>)
 542
 543   DS:count:GAUGE:HEARTBEAT:0:U
 544
 545 =item E-Mail size (F<email/email_size-I<E<lt>typeE<gt>>.rrd>)
 546
 547   DS:size:GAUGE:HEARTBEAT:0:U
 548
 549 =item HDD Temperature (F<hddtemp-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 550
 551   DS:value:GAUGE:HEARTBEAT:U:U
 552
 553 =item Irq (F<irq-I<E<lt>irqnumberE<gt>>.rrd>)
 554
 555   DS:value:COUNTER:HEARTBEAT:0:65535
 556
 557 =item System load (F<load.rrd>)
 558
 559   DS:shortterm:GAUGE:HEARTBEAT:0:100
 560   DS:midterm:GAUGE:HEARTBEAT:0:100
 561   DS:longterm:GAUGE:HEARTBEAT:0:100
 562
 563 =item Memory usage (F<memory.rrd>)
 564
 565   DS:used:GAUGE:HEARTBEAT:0:9223372036854775807
 566   DS:free:GAUGE:HEARTBEAT:0:9223372036854775807
 567   DS:buffers:GAUGE:HEARTBEAT:0:9223372036854775807
 568   DS:cached:GAUGE:HEARTBEAT:0:9223372036854775807
 569
 570 =item MySQL commands and handlers (F<mysql_commands-I<E<lt>commandE<gt>>.rrd> and F<mysql_handler-I<E<lt>handlerE<gt>>.rrd>)
 571
 572   DS:value:COUNTER:HEARTBEAT:0:U
 573
 574 =item MySQL query cache (F<mysql_qcache.rrd>)
 575
 576   DS:hits:COUNTER:HEARTBEAT:0:U
 577   DS:inserts:COUNTER:HEARTBEAT:0:U
 578   DS:not_cached:COUNTER:HEARTBEAT:0:U
 579   DS:lowmem_prunes:COUNTER:HEARTBEAT:0:U
 580   DS:queries_in_cache:GAUGE:HEARTBEAT:0:U
 581
 582 =item MySQL threads (F<mysql_threads.rrd>)
 583
 584   DS:running:GAUGE:HEARTBEAT:0:U
 585   DS:connected:GAUGE:HEARTBEAT:0:U
 586   DS:cached:GAUGE:HEARTBEAT:0:U
 587   DS:created:COUNTER:HEARTBEAT:0:U
 588
 589 =item NFSv2 Procedures (F<nfs2_procedures-I<(client|server)>.rrd>)
 590
 591   DS:null:COUNTER:HEARTBEAT:0:U
 592   DS:getattr:COUNTER:HEARTBEAT:0:U
 593   DS:setattr:COUNTER:HEARTBEAT:0:U
 594   DS:root:COUNTER:HEARTBEAT:0:U
 595   DS:lookup:COUNTER:HEARTBEAT:0:U
 596   DS:readlink:COUNTER:HEARTBEAT:0:U
 597   DS:read:COUNTER:HEARTBEAT:0:U
 598   DS:wrcache:COUNTER:HEARTBEAT:0:U
 599   DS:write:COUNTER:HEARTBEAT:0:U
 600   DS:create:COUNTER:HEARTBEAT:0:U
 601   DS:remove:COUNTER:HEARTBEAT:0:U
 602   DS:rename:COUNTER:HEARTBEAT:0:U
 603   DS:link:COUNTER:HEARTBEAT:0:U
 604   DS:symlink:COUNTER:HEARTBEAT:0:U
 605   DS:mkdir:COUNTER:HEARTBEAT:0:U
 606   DS:rmdir:COUNTER:HEARTBEAT:0:U
 607   DS:readdir:COUNTER:HEARTBEAT:0:U
 608   DS:fsstat:COUNTER:HEARTBEAT:0:U
 609
 610 =item NFSv3 Procedures (F<nfs3_procedures-I<(client|server)>.rrd>)
 611
 612   DS:null:COUNTER:HEARTBEAT:0:U
 613   DS:getattr:COUNTER:HEARTBEAT:0:U
 614   DS:setattr:COUNTER:HEARTBEAT:0:U
 615   DS:lookup:COUNTER:HEARTBEAT:0:U
 616   DS:access:COUNTER:HEARTBEAT:0:U
 617   DS:readlink:COUNTER:HEARTBEAT:0:U
 618   DS:read:COUNTER:HEARTBEAT:0:U
 619   DS:write:COUNTER:HEARTBEAT:0:U
 620   DS:create:COUNTER:HEARTBEAT:0:U
 621   DS:mkdir:COUNTER:HEARTBEAT:0:U
 622   DS:symlink:COUNTER:HEARTBEAT:0:U
 623   DS:mknod:COUNTER:HEARTBEAT:0:U
 624   DS:remove:COUNTER:HEARTBEAT:0:U
 625   DS:rmdir:COUNTER:HEARTBEAT:0:U
 626   DS:rename:COUNTER:HEARTBEAT:0:U
 627   DS:link:COUNTER:HEARTBEAT:0:U
 628   DS:readdir:COUNTER:HEARTBEAT:0:U
 629   DS:readdirplus:COUNTER:HEARTBEAT:0:U
 630   DS:fsstat:COUNTER:HEARTBEAT:0:U
 631   DS:fsinfo:COUNTER:HEARTBEAT:0:U
 632   DS:pathconf:COUNTER:HEARTBEAT:0:U
 633   DS:commit:COUNTER:HEARTBEAT:0:U
 634
 635 =item Network latency / Ping (F<ping-I<E<lt>hostnameE<gt>>.rrd>)
 636
 637   DS:ping:GAUGE:HEARTBEAT:0:65535
 638
 639 =item Processes (F<processes.rrd>)
 640
 641   DS:running:GAUGE:HEARTBEAT:0:65535
 642   DS:sleeping:GAUGE:HEARTBEAT:0:65535
 643   DS:zombies:GAUGE:HEARTBEAT:0:65535
 644   DS:stopped:GAUGE:HEARTBEAT:0:65535
 645   DS:paging:GAUGE:HEARTBEAT:0:65535
 646   DS:blocked:GAUGE:HEARTBEAT:0:65535
 647
 648 =item lm_sensors fanspeed sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/fanspeed-I<E<lt>instE<gt>>.rrd>)
 649
 650   DS:value:GAUGE:HEARTBEAT:U:U
 651
 652 =item lm_sensors temperature sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/temperature-I<E<lt>instE<gt>>.rrd>)
 653
 654   DS:value:GAUGE:HEARTBEAT:U:U
 655
 656 =item lm_sensors voltage sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/voltage-I<E<lt>instE<gt>>.rrd>)
 657
 658   DS:voltage:GAUGE:HEARTBEAT:U:U
 659
 660 =item Serial port traffic (F<serial-I<E<lt>numE<gt>>.rrd>)
 661
 662   DS:incoming:COUNTER:HEARTBEAT:0:U
 663   DS:outgoing:COUNTER:HEARTBEAT:0:U
 664
 665 =item Spam score (F<email/spam_score.rrd>)
 666
 667   DS:score:GAUGE:HEARTBEAT:0:U
 668
 669 =item Spam checks (F<email/spam_check-I<E<lt>typeE<gt>>.rrd>)
 670
 671   DS:hits:GAUGE:HEARTBEAT:0:U
 672
 673 =item Swap usage (F<swap.rrd>)
 674
 675   DS:used:GAUGE:HEARTBEAT:0:1099511627776
 676   DS:free:GAUGE:HEARTBEAT:0:1099511627776
 677   DS:cached:GAUGE:HEARTBEAT:0:1099511627776
 678   DS:resv:GAUGE:HEARTBEAT:0:1099511627776
 679
 680 =item Tape drive usage (F<tape-I<E<lt>nameE<gt>>.rrd>)
 681
 682   DS:rcount:COUNTER:HEARTBEAT:0:
 683   DS:rmerged:COUNTER:HEARTBEAT:0:U
 684   DS:rbytes:COUNTER:HEARTBEAT:0:U
 685   DS:rtime:COUNTER:HEARTBEAT:0:U
 686   DS:wcount:COUNTER:HEARTBEAT:0:U
 687   DS:wmerged:COUNTER:HEARTBEAT:0:U
 688   DS:wbytes:COUNTER:HEARTBEAT:0:U
 689   DS:wtime:COUNTER:HEARTBEAT:0:U
 690
 691 =item Network traffic (F<traffic-I<E<lt>interfaceE<gt>>.rrd>)
 692
 693   DS:incoming:COUNTER:HEARTBEAT:0:U
 694   DS:outgoing:COUNTER:HEARTBEAT:0:U
 695
 696 =item Interface packets (F<if_packets-I<E<lt>interfaceE<gt>>.rrd>)
 697
 698   DS:rx:COUNTER:HEARTBEAT:0:U
 699   DS:tx:COUNTER:HEARTBEAT:0:U
 700
 701 =item Interface errors (F<if_errors-I<E<lt>interfaceE<gt>>.rrd>)
 702
 703   DS:rx:COUNTER:HEARTBEAT:0:U
 704   DS:tx:COUNTER:HEARTBEAT:0:U
 705
 706 =item Users (F<users.rrd>)
 707
 708   DS:users:GAUGE:HEARTBEAT:0:65535
 709
 710 =item VServer load (F<vserver-I<E<lt>xidE<gt>>/load.rrd>)
 711
 712   DS:shortterm:GAUGE:HEARTBEAT:0:100
 713   DS:midterm:GAUGE:HEARTBEAT:0:100
 714   DS:longterm:GAUGE:HEARTBEAT:0:100
 715
 716 =item VServer threads (F<vserver-I<E<lt>xidE<gt>>/threads.rrd>)
 717
 718   DS:total:GAUGE:HEARTBEAT:0:65535
 719   DS:running:GAUGE:HEARTBEAT:0:65535
 720   DS:uninterruptible:GAUGE:HEARTBEAT:0:65535
 721   DS:onhold:GAUGE:HEARTBEAT:0:65535
 722
 723 =item VServer network traffic (F<vserver-I<E<lt>xidE<gt>>/traffic-I<E<lt>nameE<gt>>.rrd>)
 724
 725   DS:incoming:COUNTER:HEARTBEAT:0:9223372036854775807
 726   DS:outgoing:COUNTER:HEARTBEAT:0:9223372036854775807
 727   DS:failed:COUNTER:HEARTBEAT:0:9223372036854775807
 728
 729 =item VServer processes (F<vserver-I<E<lt>xidE<gt>>/vs_processes.rrd>)
 730
 731   DS:total:GAUGE:HEARTBEAT:0:65535
 732
 733 =item VServer memory usage (F<vserver-I<E<lt>xidE<gt>>/vs_memory.rrd>)
 734
 735   DS:vm:GAUGE:HEARTBEAT:0:9223372036854775807
 736   DS:vml:GAUGE:HEARTBEAT:0:9223372036854775807
 737   DS:rss:GAUGE:HEARTBEAT:0:9223372036854775807
 738   DS:anon:GAUGE:HEARTBEAT:0:9223372036854775807
 739
 740 =item Wireless link quality (F<wireless-I<E<lt>interfaceE<gt>>.rrd>)
 741
 742   DS:quality:GAUGE:HEARTBEAT:0:U
 743   DS:power:GAUGE:HEARTBEAT:U:0
 744   DS:noise:GAUGE:HEARTBEAT:U:0
 745
 746 =back
 747
 748 =head1 SEE ALSO
 749
 750 L<collectd.conf(5)>, L<rrdtool(1)>, L<sensors(1)>, L<hddtemp(8)>,
 751 L<mbmon(1)>,
 752 L<kstat(3KSTAT)>
 753
 754 =head1 AUTHOR
 755
 756 Florian Forster E<lt>octo@verplant.orgE<gt>
 757
 758 =cut