X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.pod;h=4919f550948f2332dac08a09f0b59bb58a16d21b;hb=4c3b690f915df7b56170cee189096949adedefe5;hp=459199471a2e5ac40fc6a710e56c18474562a250;hpb=2dfe97fd3c1ded52936cd974d5584a202c23761a;p=collectd.git diff --git a/src/collectd.pod b/src/collectd.pod index 45919947..4919f550 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -16,6 +16,14 @@ settings. The following features may be available: =item +Apache server stats (I) + +=item + +Apple hardware sensors (I, Darwin only) + +=item + Battery status (I) =item @@ -32,6 +40,14 @@ Disk and partition usage/throughput (I) =item +DNS traffic (I) + +=item + +Email usage (I) + +=item + Harddisk temperatures (I) =item @@ -82,6 +98,14 @@ Network traffic (I) Number of users logged into the system (I) +=item + +System ressources used by VServers (I) + +=item + +Wireless network stats (I) + =back =head1 OPTIONS @@ -94,6 +118,13 @@ Specify an alternative config file. This is the place to go when you wish to change B's behavior. The path may be relative to the current working directory. +=item B<-P> Ipid-fileE> + +Specify an alternative pid file. This overwrites any settings in the config +file. This is thought for init-scripts that require the PID-file in a certain +directory to work correctly. For everyday-usage use the B +config-option. + =item B<-f> Don't fork to the background. I will also B close standard file @@ -108,34 +139,54 @@ Output usage information and exit. =head1 MODES -collectd can operate in three different operating modes. The modes are -described below. +collectd can operate in four different operating modes. The modes are described +below. The simplest mode is the so called B. Data is collected locally and written in RRD files that reside in I. This is the default mode when collectd is linked against C. -The other two modes, B and B, are used to send data -over a network and receive it again. +The modes B and B are used to send data over a +network and receive it again. -In B the daemon collects the data locally and sends it's results -to one or more network addresses. No RRD files are written in this case. This -is the only mode available if collectd is not linked against C. +In B the daemon collects the data locally and sends its results +to one or more network addresses. No RRD files are written locally in this +case. If collectd is not linked against C this is the default mode. If started in B the daemon will listen on one or more interfaces and write the data it receives to RRD files. No data is collected locally. +In the last mode, B, data is collected locally and written in +text files that reside in I. + Please refer to L for the configuration options and default values. =head1 SPECIAL PLUGINS +=head2 apache + +This module connects to an Apache webserver and expects the output produced by +B. If requires B to set up the HTTP connection and issue +the request(s). The following is a sample config for the Apache webserver. The +use of C is mandatory. + + ExtendedStatus on + + + SetHandler server-status + + + +This plugin requires further configuration. Please read L. + =head2 cpufreq This module reads F (for the first CPU installed) to get the current CPU frequency. If this file does not exist make sure B (L) or a -similar tool is installed. +similar tool is installed and an "cpu governor" (that's kernel module) is +loaded. =head2 mysql @@ -172,206 +223,301 @@ which may interfere with other statistics.. The B homepage can be found at L. -=head1 RRD FILES +=head2 vserver -The RRD files are created automatically with the following RRAs: +B support is only available for Linux. It cannot yet be found in a +vanilla kernel, though. To make use of this plugin you need a kernel that has +B support built in, i.e. you need to apply the patches and compile +your own kernel, which will then provide the /proc/virtual filesystem that is +required by this plugin. - RRA:AVERAGE:0.2:6:1500 - RRA:AVERAGE:0.1:180:1680 - RRA:AVERAGE:0.1:2160:1520 - RRA:MIN:0.2:6:1500 - RRA:MIN:0.1:180:1680 - RRA:MIN:0.1:2160:1520 - RRA:MAX:0.2:6:1500 - RRA:MAX:0.1:180:1680 - RRA:MAX:0.1:2160:1520 +The B homepage can be found at L. -Since collectd uses a 10 second I the RRAs contain the following -timespans: +=head1 RRD FILES - Resolution | Data points | Timespan - -----------+-------------+---------- - 60 seconds | 1500 | 25 hours - 30 minutes | 1680 | 35 days - 6 hours | 1520 | 380 days +The RRD files are created automatically. The size of the RRAs depend on the +compile time settings of I and I. With the default values (I += B<10>, I = B<1200>) the following RRAs are created: + + RRA:AVERAGE:0.1:1:8640 + RRA:AVERAGE:0.1:50:1210 + RRA:AVERAGE:0.1:223:1202 + RRA:AVERAGE:0.1:2635:1201 + RRA:MIN:0.1:1:8640 + RRA:MIN:0.1:50:1210 + RRA:MIN:0.1:223:1202 + RRA:MIN:0.1:2635:1201 + RRA:MAX:0.1:1:8640 + RRA:MAX:0.1:50:1210 + RRA:MAX:0.1:223:1202 + RRA:MAX:0.1:2635:1201 + +By default collectd uses a 10 second I. Thus the RRAs contain the +following timespans. If you've changed the I at compile time you will +have calculate resolution and timespan yourself. + + PDP per CDP | Resolution | Data points | Timespan + ------------+--------------+-------------+--------- + 1 | 10.0 seconds ! 8640 ! 1 day + 50 | 8.3 minutes | 1210 | 1 week + 223 | 37.2 minutes | 1202 | 1 month + 2635 | 7.3 hours | 1201 | 1 year The DS'es depend on the module creating the RRD files: =over 4 +=item Apache traffic (F) + + DS:count:COUNTER:HEARTBEAT:0:134217728 + +=item Apache requests (F) + + DS:count:COUNTER:HEARTBEAT:0:1048576 + +=item Apache scoreboard (FnameE>.rrd>) + + DS:count:GAUGE:HEARTBEAT:0:U + +=item Apple temperature sensor (FnameE>.rrd>) + + DS:value:GAUGE:HEARTBEAT:U:U + +=item Apple fanspeed sensor (FnameE>.rrd>) + + DS:value:GAUGE:HEARTBEAT:U:U + =item Battery charge (FnameE>/charge.rrd>) - DS:charge:GAUGE:25:0:U + DS:charge:GAUGE:HEARTBEAT:0:U =item Battery current (FnameE>/current.rrd>) - DS:current:GAUGE:25:U:U + DS:current:GAUGE:HEARTBEAT:U:U =item Battery voltage (FnameE>/voltage.rrd>) - DS:voltage:GAUGE:25:U:U + DS:voltage:GAUGE:HEARTBEAT:U:U =item CPU (FnumE>.rrd>) - DS:user:COUNTER:25:0:100 - DS:nice:COUNTER:25:0:100 - DS:syst:COUNTER:25:0:100 - DS:idle:COUNTER:25:0:100 - DS:wait:COUNTER:25:0:100 + DS:user:COUNTER:HEARTBEAT:0:100 + DS:nice:COUNTER:HEARTBEAT:0:100 + DS:syst:COUNTER:HEARTBEAT:0:100 + DS:idle:COUNTER:HEARTBEAT:0:100 + DS:wait:COUNTER:HEARTBEAT:0:100 + +=item CPU frequency (FnumE>.rrd>) + + DS:value:GAUGE:HEARTBEAT:0:U =item Mountpoints (FpathE>.rrd>) - DS:used:GAUGE:25:0:U - DS:free:GAUGE:25:0:U + DS:used:GAUGE:HEARTBEAT:0:U + DS:free:GAUGE:HEARTBEAT:0:U =item Diskstats (FmajorE>-IminorE>.rrd>) - DS:rcount:COUNTER:25:0:U - DS:rmerged:COUNTER:25:0:U - DS:rbytes:COUNTER:25:0:U - DS:rtime:COUNTER:25:0:U - DS:wcount:COUNTER:25:0:U - DS:wmerged:COUNTER:25:0:U - DS:wbytes:COUNTER:25:0:U - DS:wtime:COUNTER:25:0:U + DS:rcount:COUNTER:HEARTBEAT:0:U + DS:rmerged:COUNTER:HEARTBEAT:0:U + DS:rbytes:COUNTER:HEARTBEAT:0:U + DS:rtime:COUNTER:HEARTBEAT:0:U + DS:wcount:COUNTER:HEARTBEAT:0:U + DS:wmerged:COUNTER:HEARTBEAT:0:U + DS:wbytes:COUNTER:HEARTBEAT:0:U + DS:wtime:COUNTER:HEARTBEAT:0:U =item Diskstats (FmajorE>-IminorE>.rrd>) - DS:rcount:COUNTER:25:0:U - DS:rbytes:COUNTER:25:0:U - DS:wcount:COUNTER:25:0:U - DS:wbytes:COUNTER:25:0:U + DS:rcount:COUNTER:HEARTBEAT:0:U + DS:rbytes:COUNTER:HEARTBEAT:0:U + DS:wcount:COUNTER:HEARTBEAT:0:U + DS:wbytes:COUNTER:HEARTBEAT:0:U =item HDD Temperature (FmajorE>-IminorE>.rrd>) - DS:value:GAUGE:25:U:U + DS:value:GAUGE:HEARTBEAT:U:U =item System load (F) - DS:shortterm:GAUGE:25:0:100 - DS:midterm:GAUGE:25:0:100 - DS:longterm:GAUGE:25:0:100 + DS:shortterm:GAUGE:HEARTBEAT:0:100 + DS:midterm:GAUGE:HEARTBEAT:0:100 + DS:longterm:GAUGE:HEARTBEAT:0:100 =item Memory usage (F) - DS:used:GAUGE:25:0:9223372036854775807 - DS:free:GAUGE:25:0:9223372036854775807 - DS:buffers:GAUGE:25:0:9223372036854775807 - DS:cached:GAUGE:25:0:9223372036854775807 + DS:used:GAUGE:HEARTBEAT:0:9223372036854775807 + DS:free:GAUGE:HEARTBEAT:0:9223372036854775807 + DS:buffers:GAUGE:HEARTBEAT:0:9223372036854775807 + DS:cached:GAUGE:HEARTBEAT:0:9223372036854775807 =item MySQL commands and handlers (FcommandE>.rrd> and FhandlerE>.rrd>) - DS:value:COUNTER:25:0:U + DS:value:COUNTER:HEARTBEAT:0:U =item MySQL query cache (F) - DS:hits:COUNTER:25:0:U - DS:inserts:COUNTER:25:0:U - DS:not_cached:COUNTER:25:0:U - DS:lowmem_prunes:COUNTER:25:0:U - DS:queries_in_cache:GAUGE:25:0:U + DS:hits:COUNTER:HEARTBEAT:0:U + DS:inserts:COUNTER:HEARTBEAT:0:U + DS:not_cached:COUNTER:HEARTBEAT:0:U + DS:lowmem_prunes:COUNTER:HEARTBEAT:0:U + DS:queries_in_cache:GAUGE:HEARTBEAT:0:U =item MySQL threads (F) - DS:running:GAUGE:25:0:U - DS:connected:GAUGE:25:0:U - DS:cached:GAUGE:25:0:U - DS:created:COUNTER:25:0:U + DS:running:GAUGE:HEARTBEAT:0:U + DS:connected:GAUGE:HEARTBEAT:0:U + DS:cached:GAUGE:HEARTBEAT:0:U + DS:created:COUNTER:HEARTBEAT:0:U =item NFSv2 Procedures (F.rrd>) - DS:null:COUNTER:25:0:U - DS:getattr:COUNTER:25:0:U - DS:setattr:COUNTER:25:0:U - DS:root:COUNTER:25:0:U - DS:lookup:COUNTER:25:0:U - DS:readlink:COUNTER:25:0:U - DS:read:COUNTER:25:0:U - DS:wrcache:COUNTER:25:0:U - DS:write:COUNTER:25:0:U - DS:create:COUNTER:25:0:U - DS:remove:COUNTER:25:0:U - DS:rename:COUNTER:25:0:U - DS:link:COUNTER:25:0:U - DS:symlink:COUNTER:25:0:U - DS:mkdir:COUNTER:25:0:U - DS:rmdir:COUNTER:25:0:U - DS:readdir:COUNTER:25:0:U - DS:fsstat:COUNTER:25:0:U + DS:null:COUNTER:HEARTBEAT:0:U + DS:getattr:COUNTER:HEARTBEAT:0:U + DS:setattr:COUNTER:HEARTBEAT:0:U + DS:root:COUNTER:HEARTBEAT:0:U + DS:lookup:COUNTER:HEARTBEAT:0:U + DS:readlink:COUNTER:HEARTBEAT:0:U + DS:read:COUNTER:HEARTBEAT:0:U + DS:wrcache:COUNTER:HEARTBEAT:0:U + DS:write:COUNTER:HEARTBEAT:0:U + DS:create:COUNTER:HEARTBEAT:0:U + DS:remove:COUNTER:HEARTBEAT:0:U + DS:rename:COUNTER:HEARTBEAT:0:U + DS:link:COUNTER:HEARTBEAT:0:U + DS:symlink:COUNTER:HEARTBEAT:0:U + DS:mkdir:COUNTER:HEARTBEAT:0:U + DS:rmdir:COUNTER:HEARTBEAT:0:U + DS:readdir:COUNTER:HEARTBEAT:0:U + DS:fsstat:COUNTER:HEARTBEAT:0:U =item NFSv3 Procedures (F.rrd>) - DS:null:COUNTER:25:0:U - DS:getattr:COUNTER:25:0:U - DS:setattr:COUNTER:25:0:U - DS:lookup:COUNTER:25:0:U - DS:access:COUNTER:25:0:U - DS:readlink:COUNTER:25:0:U - DS:read:COUNTER:25:0:U - DS:write:COUNTER:25:0:U - DS:create:COUNTER:25:0:U - DS:mkdir:COUNTER:25:0:U - DS:symlink:COUNTER:25:0:U - DS:mknod:COUNTER:25:0:U - DS:remove:COUNTER:25:0:U - DS:rmdir:COUNTER:25:0:U - DS:rename:COUNTER:25:0:U - DS:link:COUNTER:25:0:U - DS:readdir:COUNTER:25:0:U - DS:readdirplus:COUNTER:25:0:U - DS:fsstat:COUNTER:25:0:U - DS:fsinfo:COUNTER:25:0:U - DS:pathconf:COUNTER:25:0:U - DS:commit:COUNTER:25:0:U + DS:null:COUNTER:HEARTBEAT:0:U + DS:getattr:COUNTER:HEARTBEAT:0:U + DS:setattr:COUNTER:HEARTBEAT:0:U + DS:lookup:COUNTER:HEARTBEAT:0:U + DS:access:COUNTER:HEARTBEAT:0:U + DS:readlink:COUNTER:HEARTBEAT:0:U + DS:read:COUNTER:HEARTBEAT:0:U + DS:write:COUNTER:HEARTBEAT:0:U + DS:create:COUNTER:HEARTBEAT:0:U + DS:mkdir:COUNTER:HEARTBEAT:0:U + DS:symlink:COUNTER:HEARTBEAT:0:U + DS:mknod:COUNTER:HEARTBEAT:0:U + DS:remove:COUNTER:HEARTBEAT:0:U + DS:rmdir:COUNTER:HEARTBEAT:0:U + DS:rename:COUNTER:HEARTBEAT:0:U + DS:link:COUNTER:HEARTBEAT:0:U + DS:readdir:COUNTER:HEARTBEAT:0:U + DS:readdirplus:COUNTER:HEARTBEAT:0:U + DS:fsstat:COUNTER:HEARTBEAT:0:U + DS:fsinfo:COUNTER:HEARTBEAT:0:U + DS:pathconf:COUNTER:HEARTBEAT:0:U + DS:commit:COUNTER:HEARTBEAT:0:U =item Network latency / Ping (FhostnameE>.rrd>) - DS:ping:GAUGE:25:0:65535 + DS:ping:GAUGE:HEARTBEAT:0:65535 =item Processes (F) - DS:running:GAUGE:25:0:65535 - DS:sleeping:GAUGE:25:0:65535 - DS:zombies:GAUGE:25:0:65535 - DS:stopped:GAUGE:25:0:65535 - DS:paging:GAUGE:25:0:65535 - DS:blocked:GAUGE:25:0:65535 + DS:running:GAUGE:HEARTBEAT:0:65535 + DS:sleeping:GAUGE:HEARTBEAT:0:65535 + DS:zombies:GAUGE:HEARTBEAT:0:65535 + DS:stopped:GAUGE:HEARTBEAT:0:65535 + DS:paging:GAUGE:HEARTBEAT:0:65535 + DS:blocked:GAUGE:HEARTBEAT:0:65535 + +=item lm_sensors fanspeed sensor (FinstE>.rrd> or FchipE>/fanspeed-IinstE>.rrd>) + + DS:value:GAUGE:HEARTBEAT:U:U + +=item lm_sensors temperature sensor (FinstE>.rrd> or FchipE>/temperature-IinstE>.rrd>) -=item lm_sensors (FchipE>-IfeatureE>.rrd>) + DS:value:GAUGE:HEARTBEAT:U:U - DS:value:GAUGE:25:U:U +=item lm_sensors voltage sensor (FinstE>.rrd> or FchipE>/voltage-IinstE>.rrd>) + + DS:voltage:GAUGE:HEARTBEAT:U:U =item Serial port traffic (FnumE>.rrd>) - DS:incoming:COUNTER:25:0:U - DS:outgoing:COUNTER:25:0:U + DS:incoming:COUNTER:HEARTBEAT:0:U + DS:outgoing:COUNTER:HEARTBEAT:0:U =item Swap usage (F) - DS:used:GAUGE:25:0:1099511627776 - DS:free:GAUGE:25:0:1099511627776 - DS:cached:GAUGE:25:0:1099511627776 - DS:resv:GAUGE:25:0:1099511627776 + DS:used:GAUGE:HEARTBEAT:0:1099511627776 + DS:free:GAUGE:HEARTBEAT:0:1099511627776 + DS:cached:GAUGE:HEARTBEAT:0:1099511627776 + DS:resv:GAUGE:HEARTBEAT:0:1099511627776 =item Tape drive usage (FnameE>.rrd>) - DS:rcount:COUNTER:25:0: - DS:rmerged:COUNTER:25:0:U - DS:rbytes:COUNTER:25:0:U - DS:rtime:COUNTER:25:0:U - DS:wcount:COUNTER:25:0:U - DS:wmerged:COUNTER:25:0:U - DS:wbytes:COUNTER:25:0:U - DS:wtime:COUNTER:25:0:U + DS:rcount:COUNTER:HEARTBEAT:0: + DS:rmerged:COUNTER:HEARTBEAT:0:U + DS:rbytes:COUNTER:HEARTBEAT:0:U + DS:rtime:COUNTER:HEARTBEAT:0:U + DS:wcount:COUNTER:HEARTBEAT:0:U + DS:wmerged:COUNTER:HEARTBEAT:0:U + DS:wbytes:COUNTER:HEARTBEAT:0:U + DS:wtime:COUNTER:HEARTBEAT:0:U + +=item Network traffic (FinterfaceE>.rrd>) + + DS:incoming:COUNTER:HEARTBEAT:0:U + DS:outgoing:COUNTER:HEARTBEAT:0:U -=item Network traffic (FnameE>.rrd>) +=item Interface packets (FinterfaceE>.rrd>) - DS:incoming:COUNTER:25:0:U - DS:outgoing:COUNTER:25:0:U + DS:rx:COUNTER:HEARTBEAT:0:U + DS:tx:COUNTER:HEARTBEAT:0:U + +=item Interface errors (FinterfaceE>.rrd>) + + DS:rx:COUNTER:HEARTBEAT:0:U + DS:tx:COUNTER:HEARTBEAT:0:U =item Users (F) - DS:users:GAUGE:25:0:65535 + DS:users:GAUGE:HEARTBEAT:0:65535 + +=item VServer load (FxidE>/load.rrd>) + + DS:shortterm:GAUGE:HEARTBEAT:0:100 + DS:midterm:GAUGE:HEARTBEAT:0:100 + DS:longterm:GAUGE:HEARTBEAT:0:100 + +=item VServer threads (FxidE>/threads.rrd>) + + DS:total:GAUGE:HEARTBEAT:0:65535 + DS:running:GAUGE:HEARTBEAT:0:65535 + DS:uninterruptible:GAUGE:HEARTBEAT:0:65535 + DS:onhold:GAUGE:HEARTBEAT:0:65535 + +=item VServer network traffic (FxidE>/traffic-InameE>.rrd>) + + DS:incoming:COUNTER:HEARTBEAT:0:9223372036854775807 + DS:outgoing:COUNTER:HEARTBEAT:0:9223372036854775807 + DS:failed:COUNTER:HEARTBEAT:0:9223372036854775807 + +=item VServer processes (FxidE>/vs_processes.rrd>) + + DS:total:GAUGE:HEARTBEAT:0:65535 + +=item VServer memory usage (FxidE>/vs_memory.rrd>) + + DS:vm:GAUGE:HEARTBEAT:0:9223372036854775807 + DS:vml:GAUGE:HEARTBEAT:0:9223372036854775807 + DS:rss:GAUGE:HEARTBEAT:0:9223372036854775807 + DS:anon:GAUGE:HEARTBEAT:0:9223372036854775807 + +=item Wireless link quality (FinterfaceE>.rrd>) + + DS:quality:GAUGE:HEARTBEAT:0:U + DS:power:GAUGE:HEARTBEAT:U:0 + DS:noise:GAUGE:HEARTBEAT:U:0 =back