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