6d5720000630adbb1b0ef50b77f1c1ffd58cf151
1 =head1 NAME
3 collectd - System statistics collection daemon
5 =head1 SYNOPSIS
7 collectd I<[options]>
9 =head1 DESCRIPTION
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:
15 =over 4
17 =item
19 Battery status (I<battery>)
21 =item
23 CPU utilization (I<cpu>)
25 =item
27 Mountpoint usage (I<df>)
29 =item
31 Disk and partition usage/throughput (I<disk>)
33 =item
35 Harddisk temperatures (I<hddtemp>)
37 =item
39 System load averages (I<load>)
41 =item
43 Memory usage (I<memory>)
45 =item
47 MySQL statistics (I<mysql>)
49 =item
51 NFS utilization (I<nfs>, Linux only)
53 =item
55 Network latency (I<ping>)
57 =item
59 Number of processes (I<processes>, Linux only)
61 =item
63 lm_sensors information (I<sensors>, Linux only)
65 =item
67 Serial port traffic (I<serial>, Linux only)
69 =item
71 Swap usage (I<swap>)
73 =item
75 Tape drive usage (I<tape>, Solaris only)
77 =item
79 Network traffic (I<traffic>)
81 =item
83 Number of users logged into the system (I<users>)
85 =back
87 =head1 OPTIONS
89 =over 4
91 =item B<-C> I<E<lt>config-fileE<gt>>
93 Specify an alternative config file. This is the place to go when you wish to
94 change B<collectd>'s behavior. The path may be relative to the current working
95 directory.
97 =item B<-f>
99 Don't fork to the background. I<collectd> will also B<not> close standard file
100 descriptors, detach from the session nor write a pid file. This is mainly
101 thought for 'supervisioning' init replacements such as I<runit>.
103 =item B<-h>
105 Output usage information and exit.
107 =back
109 =head1 MODES
111 collectd can operate in three different operating modes. The modes are
112 described below.
114 The simplest mode is the so called B<local mode>. Data is collected locally and
115 written in RRD files that reside in I<DataDir>. This is the default mode when
116 collectd is linked against C<librrd>.
118 The other modes, B<client mode> and B<server mode>, are used to send data over
119 a network and receive it again.
121 In B<client mode> the daemon collects the data locally and sends its results
122 to one or more network addresses. No RRD files are written in this case. This
123 is the only mode available if collectd is not linked against C<librrd>.
125 If started in B<server mode> the daemon will listen on one or more interfaces
126 and write the data it receives to RRD files. No data is collected locally.
128 In the last mode, B<log mode>, data is collected locally and written in
129 text files that reside in I<DataDir>.
131 Please refer to L<collectd.conf(5)> for the configuration options and default
132 values.
134 =head1 SPECIAL PLUGINS
136 =head2 cpufreq
138 This module reads F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for
139 the first CPU installed) to get the current CPU frequency. If this file does
140 not exist make sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a
141 similar tool is installed.
143 =head2 mysql
145 Requires B<mysqlclient> to be installed. It connects to the database when
146 started and keeps the connection up as long as possible. When the connection is
147 interrupted for whatever reason it will try to re-connect. The syslog will
148 contain loud complaints in case anything goes wrong.
150 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
151 C<Com_*> and C<Handler_*> which correspond to F<traffic-mysql.rrd>,
152 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
153 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
154 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
155 I<5.2.4. Server Status Variables> for an explanation of these values.
157 =head2 sensors
159 The B<sensors> module uses lm_sensors to retrieve sensor-values. This means
160 that all the needed modules have to be loaded and lm_sensors has to be
161 configured (most likely by editing F</etc/sensors.conf>. Read
162 L<sensors.conf(5)> for details.
164 The B<lm_sensors> homepage can be found at
165 L<http://secure.netroedge.com/~lm78/>.
167 =head2 hddtemp
169 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
170 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
171 default values. See L<collectd.conf(5)> for details. C<hddtemp> has to be
172 running to work correctly. If C<hddtemp> is not running timeouts may appear
173 which may interfere with other statistics..
175 The B<hddtemp> homepage can be found at
176 L<http://www.guzu.net/linux/hddtemp.php>.
178 =head1 RRD FILES
180 The RRD files are created automatically with the following RRAs:
182 RRA:AVERAGE:0.2:6:1500
183 RRA:AVERAGE:0.1:180:1680
184 RRA:AVERAGE:0.1:2160:1520
185 RRA:MIN:0.2:6:1500
186 RRA:MIN:0.1:180:1680
187 RRA:MIN:0.1:2160:1520
188 RRA:MAX:0.2:6:1500
189 RRA:MAX:0.1:180:1680
190 RRA:MAX:0.1:2160:1520
192 Since collectd uses a 10 second I<step> the RRAs contain the following
193 timespans:
195 Resolution | Data points | Timespan
196 -----------+-------------+----------
197 60 seconds | 1500 | 25 hours
198 30 minutes | 1680 | 35 days
199 6 hours | 1520 | 380 days
201 The DS'es depend on the module creating the RRD files:
203 =over 4
205 =item Battery charge (F<battery-I<E<lt>nameE<gt>>/charge.rrd>)
207 DS:charge:GAUGE:25:0:U
209 =item Battery current (F<battery-I<E<lt>nameE<gt>>/current.rrd>)
211 DS:current:GAUGE:25:U:U
213 =item Battery voltage (F<battery-I<E<lt>nameE<gt>>/voltage.rrd>)
215 DS:voltage:GAUGE:25:U:U
217 =item CPU (F<cpu-I<E<lt>numE<gt>>.rrd>)
219 DS:user:COUNTER:25:0:100
220 DS:nice:COUNTER:25:0:100
221 DS:syst:COUNTER:25:0:100
222 DS:idle:COUNTER:25:0:100
223 DS:wait:COUNTER:25:0:100
225 =item Mountpoints (F<df-I<E<lt>pathE<gt>>.rrd>)
227 DS:used:GAUGE:25:0:U
228 DS:free:GAUGE:25:0:U
230 =item Diskstats (F<disk-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
232 DS:rcount:COUNTER:25:0:U
233 DS:rmerged:COUNTER:25:0:U
234 DS:rbytes:COUNTER:25:0:U
235 DS:rtime:COUNTER:25:0:U
236 DS:wcount:COUNTER:25:0:U
237 DS:wmerged:COUNTER:25:0:U
238 DS:wbytes:COUNTER:25:0:U
239 DS:wtime:COUNTER:25:0:U
241 =item Diskstats (F<partition-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
243 DS:rcount:COUNTER:25:0:U
244 DS:rbytes:COUNTER:25:0:U
245 DS:wcount:COUNTER:25:0:U
246 DS:wbytes:COUNTER:25:0:U
248 =item HDD Temperature (F<hddtemp-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
250 DS:value:GAUGE:25:U:U
252 =item System load (F<load.rrd>)
254 DS:shortterm:GAUGE:25:0:100
255 DS:midterm:GAUGE:25:0:100
256 DS:longterm:GAUGE:25:0:100
258 =item Memory usage (F<memory.rrd>)
260 DS:used:GAUGE:25:0:9223372036854775807
261 DS:free:GAUGE:25:0:9223372036854775807
262 DS:buffers:GAUGE:25:0:9223372036854775807
263 DS:cached:GAUGE:25:0:9223372036854775807
265 =item MySQL commands and handlers (F<mysql_commands-I<E<lt>commandE<gt>>.rrd> and F<mysql_handler-I<E<lt>handlerE<gt>>.rrd>)
267 DS:value:COUNTER:25:0:U
269 =item MySQL query cache (F<mysql_qcache.rrd>)
271 DS:hits:COUNTER:25:0:U
272 DS:inserts:COUNTER:25:0:U
273 DS:not_cached:COUNTER:25:0:U
274 DS:lowmem_prunes:COUNTER:25:0:U
275 DS:queries_in_cache:GAUGE:25:0:U
277 =item MySQL threads (F<mysql_threads.rrd>)
279 DS:running:GAUGE:25:0:U
280 DS:connected:GAUGE:25:0:U
281 DS:cached:GAUGE:25:0:U
282 DS:created:COUNTER:25:0:U
284 =item NFSv2 Procedures (F<nfs2_procedures-I<(client|server)>.rrd>)
286 DS:null:COUNTER:25:0:U
287 DS:getattr:COUNTER:25:0:U
288 DS:setattr:COUNTER:25:0:U
289 DS:root:COUNTER:25:0:U
290 DS:lookup:COUNTER:25:0:U
291 DS:readlink:COUNTER:25:0:U
292 DS:read:COUNTER:25:0:U
293 DS:wrcache:COUNTER:25:0:U
294 DS:write:COUNTER:25:0:U
295 DS:create:COUNTER:25:0:U
296 DS:remove:COUNTER:25:0:U
297 DS:rename:COUNTER:25:0:U
298 DS:link:COUNTER:25:0:U
299 DS:symlink:COUNTER:25:0:U
300 DS:mkdir:COUNTER:25:0:U
301 DS:rmdir:COUNTER:25:0:U
302 DS:readdir:COUNTER:25:0:U
303 DS:fsstat:COUNTER:25:0:U
305 =item NFSv3 Procedures (F<nfs3_procedures-I<(client|server)>.rrd>)
307 DS:null:COUNTER:25:0:U
308 DS:getattr:COUNTER:25:0:U
309 DS:setattr:COUNTER:25:0:U
310 DS:lookup:COUNTER:25:0:U
311 DS:access:COUNTER:25:0:U
312 DS:readlink:COUNTER:25:0:U
313 DS:read:COUNTER:25:0:U
314 DS:write:COUNTER:25:0:U
315 DS:create:COUNTER:25:0:U
316 DS:mkdir:COUNTER:25:0:U
317 DS:symlink:COUNTER:25:0:U
318 DS:mknod:COUNTER:25:0:U
319 DS:remove:COUNTER:25:0:U
320 DS:rmdir:COUNTER:25:0:U
321 DS:rename:COUNTER:25:0:U
322 DS:link:COUNTER:25:0:U
323 DS:readdir:COUNTER:25:0:U
324 DS:readdirplus:COUNTER:25:0:U
325 DS:fsstat:COUNTER:25:0:U
326 DS:fsinfo:COUNTER:25:0:U
327 DS:pathconf:COUNTER:25:0:U
328 DS:commit:COUNTER:25:0:U
330 =item Network latency / Ping (F<ping-I<E<lt>hostnameE<gt>>.rrd>)
332 DS:ping:GAUGE:25:0:65535
334 =item Processes (F<processes.rrd>)
336 DS:running:GAUGE:25:0:65535
337 DS:sleeping:GAUGE:25:0:65535
338 DS:zombies:GAUGE:25:0:65535
339 DS:stopped:GAUGE:25:0:65535
340 DS:paging:GAUGE:25:0:65535
341 DS:blocked:GAUGE:25:0:65535
343 =item lm_sensors (F<sensors-I<E<lt>chipE<gt>>-I<E<lt>featureE<gt>>.rrd>)
345 DS:value:GAUGE:25:U:U
347 =item Serial port traffic (F<serial-I<E<lt>numE<gt>>.rrd>)
349 DS:incoming:COUNTER:25:0:U
350 DS:outgoing:COUNTER:25:0:U
352 =item Swap usage (F<swap.rrd>)
354 DS:used:GAUGE:25:0:1099511627776
355 DS:free:GAUGE:25:0:1099511627776
356 DS:cached:GAUGE:25:0:1099511627776
357 DS:resv:GAUGE:25:0:1099511627776
359 =item Tape drive usage (F<tape-I<E<lt>nameE<gt>>.rrd>)
361 DS:rcount:COUNTER:25:0:
362 DS:rmerged:COUNTER:25:0:U
363 DS:rbytes:COUNTER:25:0:U
364 DS:rtime:COUNTER:25:0:U
365 DS:wcount:COUNTER:25:0:U
366 DS:wmerged:COUNTER:25:0:U
367 DS:wbytes:COUNTER:25:0:U
368 DS:wtime:COUNTER:25:0:U
370 =item Network traffic (F<traffic-I<E<lt>nameE<gt>>.rrd>)
372 DS:incoming:COUNTER:25:0:U
373 DS:outgoing:COUNTER:25:0:U
375 =item Users (F<users.rrd>)
377 DS:users:GAUGE:25:0:65535
379 =back
381 =head1 SEE ALSO
383 L<collectd.conf(5)>, L<rrdtool(1)>, L<sensors(1)>, L<hddtemp(8)>,
384 L<kstat(3KSTAT)>
386 =head1 AUTHOR
388 Florian Forster E<lt>octo@verplant.orgE<gt>
390 =cut