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 Battery status (I<battery>)
  20
  21 =item
  22
  23 CPU utilization (I<cpu>)
  24
  25 =item
  26
  27 Mountpoint usage (I<df>)
  28
  29 =item
  30
  31 Disk and partition usage/throughput (I<disk>)
  32
  33 =item
  34
  35 Harddisk temperatures (I<hddtemp>)
  36
  37 =item
  38
  39 System load averages (I<load>)
  40
  41 =item
  42
  43 Memory usage (I<memory>)
  44
  45 =item
  46
  47 MySQL statistics (I<mysql>)
  48
  49 =item
  50
  51 NFS utilization (I<nfs>, Linux only)
  52
  53 =item
  54
  55 Network latency (I<ping>)
  56
  57 =item
  58
  59 Number of processes (I<processes>, Linux only)
  60
  61 =item
  62
  63 lm_sensors information (I<sensors>, Linux only)
  64
  65 =item
  66
  67 Serial port traffic (I<serial>, Linux only)
  68
  69 =item
  70
  71 Swap usage (I<swap>)
  72
  73 =item
  74
  75 Tape drive usage (I<tape>, Solaris only)
  76
  77 =item
  78
  79 Network traffic (I<traffic>)
  80
  81 =item
  82
  83 Number of users logged into the system (I<users>)
  84
  85 =item
  86
  87 System ressources used by VServers (I<vserver>)
  88
  89 =back
  90
  91 =head1 OPTIONS
  92
  93 =over 4
  94
  95 =item B<-C> I<E<lt>config-fileE<gt>>
  96
  97 Specify an alternative config file. This is the place to go when you wish to
  98 change B<collectd>'s behavior. The path may be relative to the current working
  99 directory.
 100
 101 =item B<-f>
 102
 103 Don't fork to the background. I<collectd> will also B<not> close standard file
 104 descriptors, detach from the session nor write a pid file. This is mainly
 105 thought for 'supervisioning' init replacements such as I<runit>.
 106
 107 =item B<-h>
 108
 109 Output usage information and exit.
 110
 111 =back
 112
 113 =head1 MODES
 114
 115 collectd can operate in three different operating modes. The modes are
 116 described below.
 117
 118 The simplest mode is the so called B<local mode>. Data is collected locally and
 119 written in RRD files that reside in I<DataDir>. This is the default mode when
 120 collectd is linked against C<librrd>.
 121
 122 The other two modes, B<client mode> and B<server mode>, are used to send data
 123 over a network and receive it again.
 124
 125 In B<client mode> the daemon collects the data locally and sends it's results
 126 to one or more network addresses. No RRD files are written in this case. This
 127 is the only mode available if collectd is not linked against C<librrd>.
 128
 129 If started in B<server mode> the daemon will listen on one or more interfaces
 130 and write the data it receives to RRD files. No data is collected locally.
 131
 132 Please refer to L<collectd.conf(5)> for the configuration options and default
 133 values.
 134
 135 =head1 SPECIAL PLUGINS
 136
 137 =head2 cpufreq
 138
 139 This module reads F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for
 140 the first CPU installed) to get the current CPU frequency. If this file does
 141 not exist make sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a
 142 similar tool is installed.
 143
 144 =head2 mysql
 145
 146 Requires B<mysqlclient> to be installed. It connects to the database when
 147 started and keeps the connection up as long as possible. When the connection is
 148 interrupted for whatever reason it will try to re-connect. The syslog will
 149 contain loud complaints in case anything goes wrong.
 150
 151 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
 152 C<Com_*> and C<Handler_*> which correspond to F<traffic-mysql.rrd>,
 153 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
 154 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
 155 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
 156 I<5.2.4. Server Status Variables> for an explanation of these values.
 157
 158 =head2 sensors
 159
 160 The B<sensors> module uses lm_sensors to retrieve sensor-values. This means
 161 that all the needed modules have to be loaded and lm_sensors has to be
 162 configured (most likely by editing F</etc/sensors.conf>. Read
 163 L<sensors.conf(5)> for details.
 164
 165 The B<lm_sensors> homepage can be found at
 166 L<http://secure.netroedge.com/~lm78/>.
 167
 168 =head2 hddtemp
 169
 170 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
 171 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
 172 default values. See L<collectd.conf(5)> for details. C<hddtemp> has to be
 173 running to work correctly. If C<hddtemp> is not running timeouts may appear
 174 which may interfere with other statistics..
 175
 176 The B<hddtemp> homepage can be found at
 177 L<http://www.guzu.net/linux/hddtemp.php>.
 178
 179 =head2 vserver
 180
 181 B<VServer> support is only available for Linux. It cannot yet be found in a
 182 vanilla kernel, though. To make use of this plugin you need a kernel that has
 183 B<VServer> support built in, i.e. you need to apply the patches and compile
 184 your own kernel, which will then provide the /proc/virtual filesystem that is
 185 required by this plugin.
 186
 187 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
 188
 189 =head1 RRD FILES
 190
 191 The RRD files are created automatically with the following RRAs:
 192
 193   RRA:AVERAGE:0.0:1:1500
 194   RRA:AVERAGE:0.2:6:1500
 195   RRA:AVERAGE:0.1:180:1680
 196   RRA:AVERAGE:0.1:2160:1520
 197   RRA:MIN:0.0:1:1500
 198   RRA:MIN:0.2:6:1500
 199   RRA:MIN:0.1:180:1680
 200   RRA:MIN:0.1:2160:1520
 201   RRA:MAX:0.0:1:1500
 202   RRA:MAX:0.2:6:1500
 203   RRA:MAX:0.1:180:1680
 204   RRA:MAX:0.1:2160:1520
 205
 206 By default collectd uses a 10 second I<step>. Thus the RRAs contain the
 207 following timespans. If you've changed the I<step> at compile time you will
 208 have calculate resolution and timespan yourself.
 209
 210   PDP per CDP | Resolution | Data points |  Timespan
 211   ------------+------------+-------------+----------
 212             1 | 10 seconds !        1500 !   4 hours
 213             6 |  1 minute  |        1500 |  25 hours
 214           180 | 30 minutes |        1680 |  35 days
 215          2160 |  6 hours   |        1520 | 380 days
 216
 217 The DS'es depend on the module creating the RRD files:
 218
 219 =over 4
 220
 221 =item Battery charge (F<battery-I<E<lt>nameE<gt>>/charge.rrd>)
 222
 223   DS:charge:GAUGE:25:0:U
 224
 225 =item Battery current (F<battery-I<E<lt>nameE<gt>>/current.rrd>)
 226
 227   DS:current:GAUGE:25:U:U
 228
 229 =item Battery voltage (F<battery-I<E<lt>nameE<gt>>/voltage.rrd>)
 230
 231   DS:voltage:GAUGE:25:U:U
 232
 233 =item CPU (F<cpu-I<E<lt>numE<gt>>.rrd>)
 234
 235   DS:user:COUNTER:25:0:100
 236   DS:nice:COUNTER:25:0:100
 237   DS:syst:COUNTER:25:0:100
 238   DS:idle:COUNTER:25:0:100
 239   DS:wait:COUNTER:25:0:100
 240
 241 =item Mountpoints (F<df-I<E<lt>pathE<gt>>.rrd>)
 242
 243   DS:used:GAUGE:25:0:U
 244   DS:free:GAUGE:25:0:U
 245
 246 =item Diskstats (F<disk-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 247
 248   DS:rcount:COUNTER:25:0:U
 249   DS:rmerged:COUNTER:25:0:U
 250   DS:rbytes:COUNTER:25:0:U
 251   DS:rtime:COUNTER:25:0:U
 252   DS:wcount:COUNTER:25:0:U
 253   DS:wmerged:COUNTER:25:0:U
 254   DS:wbytes:COUNTER:25:0:U
 255   DS:wtime:COUNTER:25:0:U
 256
 257 =item Diskstats (F<partition-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 258
 259   DS:rcount:COUNTER:25:0:U
 260   DS:rbytes:COUNTER:25:0:U
 261   DS:wcount:COUNTER:25:0:U
 262   DS:wbytes:COUNTER:25:0:U
 263
 264 =item HDD Temperature (F<hddtemp-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 265
 266   DS:value:GAUGE:25:U:U
 267
 268 =item System load (F<load.rrd>)
 269
 270   DS:shortterm:GAUGE:25:0:100
 271   DS:midterm:GAUGE:25:0:100
 272   DS:longterm:GAUGE:25:0:100
 273
 274 =item Memory usage (F<memory.rrd>)
 275
 276   DS:used:GAUGE:25:0:9223372036854775807
 277   DS:free:GAUGE:25:0:9223372036854775807
 278   DS:buffers:GAUGE:25:0:9223372036854775807
 279   DS:cached:GAUGE:25:0:9223372036854775807
 280
 281 =item MySQL commands and handlers (F<mysql_commands-I<E<lt>commandE<gt>>.rrd> and F<mysql_handler-I<E<lt>handlerE<gt>>.rrd>)
 282
 283   DS:value:COUNTER:25:0:U
 284
 285 =item MySQL query cache (F<mysql_qcache.rrd>)
 286
 287   DS:hits:COUNTER:25:0:U
 288   DS:inserts:COUNTER:25:0:U
 289   DS:not_cached:COUNTER:25:0:U
 290   DS:lowmem_prunes:COUNTER:25:0:U
 291   DS:queries_in_cache:GAUGE:25:0:U
 292
 293 =item MySQL threads (F<mysql_threads.rrd>)
 294
 295   DS:running:GAUGE:25:0:U
 296   DS:connected:GAUGE:25:0:U
 297   DS:cached:GAUGE:25:0:U
 298   DS:created:COUNTER:25:0:U
 299
 300 =item NFSv2 Procedures (F<nfs2_procedures-I<(client|server)>.rrd>)
 301
 302   DS:null:COUNTER:25:0:U
 303   DS:getattr:COUNTER:25:0:U
 304   DS:setattr:COUNTER:25:0:U
 305   DS:root:COUNTER:25:0:U
 306   DS:lookup:COUNTER:25:0:U
 307   DS:readlink:COUNTER:25:0:U
 308   DS:read:COUNTER:25:0:U
 309   DS:wrcache:COUNTER:25:0:U
 310   DS:write:COUNTER:25:0:U
 311   DS:create:COUNTER:25:0:U
 312   DS:remove:COUNTER:25:0:U
 313   DS:rename:COUNTER:25:0:U
 314   DS:link:COUNTER:25:0:U
 315   DS:symlink:COUNTER:25:0:U
 316   DS:mkdir:COUNTER:25:0:U
 317   DS:rmdir:COUNTER:25:0:U
 318   DS:readdir:COUNTER:25:0:U
 319   DS:fsstat:COUNTER:25:0:U
 320
 321 =item NFSv3 Procedures (F<nfs3_procedures-I<(client|server)>.rrd>)
 322
 323   DS:null:COUNTER:25:0:U
 324   DS:getattr:COUNTER:25:0:U
 325   DS:setattr:COUNTER:25:0:U
 326   DS:lookup:COUNTER:25:0:U
 327   DS:access:COUNTER:25:0:U
 328   DS:readlink:COUNTER:25:0:U
 329   DS:read:COUNTER:25:0:U
 330   DS:write:COUNTER:25:0:U
 331   DS:create:COUNTER:25:0:U
 332   DS:mkdir:COUNTER:25:0:U
 333   DS:symlink:COUNTER:25:0:U
 334   DS:mknod:COUNTER:25:0:U
 335   DS:remove:COUNTER:25:0:U
 336   DS:rmdir:COUNTER:25:0:U
 337   DS:rename:COUNTER:25:0:U
 338   DS:link:COUNTER:25:0:U
 339   DS:readdir:COUNTER:25:0:U
 340   DS:readdirplus:COUNTER:25:0:U
 341   DS:fsstat:COUNTER:25:0:U
 342   DS:fsinfo:COUNTER:25:0:U
 343   DS:pathconf:COUNTER:25:0:U
 344   DS:commit:COUNTER:25:0:U
 345
 346 =item Network latency / Ping (F<ping-I<E<lt>hostnameE<gt>>.rrd>)
 347
 348   DS:ping:GAUGE:25:0:65535
 349
 350 =item Processes (F<processes.rrd>)
 351
 352   DS:running:GAUGE:25:0:65535
 353   DS:sleeping:GAUGE:25:0:65535
 354   DS:zombies:GAUGE:25:0:65535
 355   DS:stopped:GAUGE:25:0:65535
 356   DS:paging:GAUGE:25:0:65535
 357   DS:blocked:GAUGE:25:0:65535
 358
 359 =item lm_sensors (F<sensors-I<E<lt>chipE<gt>>-I<E<lt>featureE<gt>>.rrd>)
 360
 361   DS:value:GAUGE:25:U:U
 362
 363 =item Serial port traffic (F<serial-I<E<lt>numE<gt>>.rrd>)
 364
 365   DS:incoming:COUNTER:25:0:U
 366   DS:outgoing:COUNTER:25:0:U
 367
 368 =item Swap usage (F<swap.rrd>)
 369
 370   DS:used:GAUGE:25:0:1099511627776
 371   DS:free:GAUGE:25:0:1099511627776
 372   DS:cached:GAUGE:25:0:1099511627776
 373   DS:resv:GAUGE:25:0:1099511627776
 374
 375 =item Tape drive usage (F<tape-I<E<lt>nameE<gt>>.rrd>)
 376
 377   DS:rcount:COUNTER:25:0:
 378   DS:rmerged:COUNTER:25:0:U
 379   DS:rbytes:COUNTER:25:0:U
 380   DS:rtime:COUNTER:25:0:U
 381   DS:wcount:COUNTER:25:0:U
 382   DS:wmerged:COUNTER:25:0:U
 383   DS:wbytes:COUNTER:25:0:U
 384   DS:wtime:COUNTER:25:0:U
 385
 386 =item Network traffic (F<traffic-I<E<lt>nameE<gt>>.rrd>)
 387
 388   DS:incoming:COUNTER:25:0:U
 389   DS:outgoing:COUNTER:25:0:U
 390
 391 =item Users (F<users.rrd>)
 392
 393   DS:users:GAUGE:25:0:65535
 394
 395 =item VServer load (F<vserver-I<E<lt>xidE<gt>>/load.rrd>)
 396
 397   DS:shortterm:GAUGE:25:0:100
 398   DS:midterm:GAUGE:25:0:100
 399   DS:longterm:GAUGE:25:0:100
 400
 401 =item VServer threads (F<vserver-I<E<lt>xidE<gt>>/threads.rrd>)
 402
 403   DS:total:GAUGE:25:0:65535
 404   DS:running:GAUGE:25:0:65535
 405   DS:uninterruptible:GAUGE:25:0:65535
 406   DS:onhold:GAUGE:25:0:65535
 407
 408 =item VServer network traffic (F<vserver-I<E<lt>xidE<gt>>/traffic-I<E<lt>nameE<gt>>.rrd>)
 409
 410   DS:incoming:COUNTER:25:0:9223372036854775807
 411   DS:outgoing:COUNTER:25:0:9223372036854775807
 412   DS:failed:COUNTER:25:0:9223372036854775807
 413
 414 =item VServer processes (F<vserver-I<E<lt>xidE<gt>>/vs_processes.rrd>)
 415
 416   DS:total:GAUGE:25:0:65535
 417
 418 =item VServer memory usage (F<vserver-I<E<lt>xidE<gt>>/vs_memory.rrd>)
 419
 420   DS:vm:GAUGE:25:0:9223372036854775807
 421   DS:vml:GAUGE:25:0:9223372036854775807
 422   DS:rss:GAUGE:25:0:9223372036854775807
 423   DS:anon:GAUGE:25:0:9223372036854775807
 424
 425 =back
 426
 427 =head1 SEE ALSO
 428
 429 L<collectd.conf(5)>, L<rrdtool(1)>, L<sensors(1)>, L<hddtemp(8)>,
 430 L<kstat(3KSTAT)>
 431
 432 =head1 AUTHOR
 433
 434 Florian Forster E<lt>octo@verplant.orgE<gt>
 435
 436 =cut