Import darkstat 3.0.712
[darkstat] / darkstat.8
1 .\"
2 .\" darkstat 3
3 .\" Copyright 2001-2008, Emil Mikulic.
4 .\"
5 .\" You may use, modify and redistribute this file under the terms of the
6 .\" GNU General Public License version 2. (see COPYING.GPL)
7 .\"
8 .TH darkstat 8 "September 2008" "darkstat 3"
9 .SH NAME
10 darkstat \- network statistics gatherer
11 .\"
12 .SH SYNOPSIS
13 .B darkstat
14 [
15 .BI \-i " interface"
16 ] [
17 .BI \-r " file"
18 ] [
19 .BI \-\-pppoe
20 ] [
21 .BI \-\-verbose
22 ] [
23 .BI \-\-no\-daemon
24 ] [
25 .BI \-\-no\-promisc
26 ] [
27 .BI \-\-no\-dns
28 ] [
29 .BI \-\-no\-macs
30 ] [
31 .BI \-p " port"
32 ] [
33 .BI \-b " bindaddr"
34 ] [
35 .BI \-f " filter"
36 ] [
37 .BI \-l " network/netmask"
38 ] [
39 .BI \-\-chroot " dir"
40 ] [
41 .BI \-\-user " username"
42 ] [
43 .BI \-\-daylog " filename"
44 ] [
45 .BI \-\-import " filename"
46 ] [
47 .BI \-\-export " filename"
48 ] [
49 .BI \-\-pidfile " filename"
50 ] [
51 .BI \-\-hosts\-max " count"
52 ] [
53 .BI \-\-hosts\-keep " count"
54 ] [
55 .BI \-\-ports\-max " count"
56 ] [
57 .BI \-\-ports\-keep " count"
58 ] [
59 .BI \-\-highest\-port " port"
60 ]
61 .\"
62 .SH DESCRIPTION
63 .I darkstat
64 is a packet sniffer that runs as a background process on
65 a cable/DSL router, gathers all sorts of statistics about network usage,
66 and serves them over HTTP.
67
68 All settings are passed on the commandline.
69 .\"
70 .SH OPTIONS
71 .\"
72 .TP
73 .BI \-i " interface"
74 Capture traffic on the specified network interface.
75 This is the only mandatory commandline argument.
76 .\"
77 .TP
78 .BI \-r " file"
79 Instead of capturing live traffic, read it from a
80 .BR pcap (3)
81 capture file.
82 This is only useful for development and benchmarking.
83 The
84 .BI \-r
85 and
86 .BI \-i
87 arguments are mutually exclusive.
88 .\"
89 .TP
90 .BI \-\-pppoe
91 Don't use this.
92 .RS
93
94 Instead, capture on the tunnel interface that your PPPoE software
95 provides, for example \fBtun0\fR on \fIFreeBSD\fR, \fBpppoe0\fR on
96 \fIOpenBSD\fR or \fINetBSD\fR.
97
98 If you really must, you can capture on an Ethernet interface and pass
99 this argument to have \fIdarkstat\fR decode PPPoE frames and ignore
100 everything else.
101 Make sure you also specify your local address with the \fB\-l\fR
102 argument.
103 .RE
104 .\"
105 .TP
106 .BI \-\-verbose
107 Print debugging messages to the terminal.
108 .\"
109 .TP
110 .BI \-\-no\-daemon
111 Do not detach from the controlling terminal;
112 stay in the foreground.
113 .\"
114 .TP
115 .BI \-\-no\-promisc
116 Do not use promiscuous mode to capture.
117 Note that an interface may already be in promiscuous mode.
118 If this is a problem, use an appropriate
119 .BR bpf (4)
120 filter.
121 .\"
122 .TP
123 .BI \-\-no\-dns
124 Do not resolve IPs to host names.
125 This can significantly reduce memory footprint on small systems
126 as an extra process is created for DNS resolving.
127 .\"
128 .TP
129 .BI \-\-no\-macs
130 Do not display MAC addresses in hosts table.
131 .\"
132 .TP
133 .BI \-p " port"
134 Bind the web interface to the specified port.
135 The default is 667.
136 .\"
137 .TP
138 .BI \-b " bindaddr"
139 Bind the web interface to the specified address.
140 The default is to listen on all interfaces.
141 .\"
142 .TP
143 .BI \-f " filter"
144 Use the specified filter expression when capturing traffic.
145 The filter syntax is beyond the scope of this manual page;
146 please refer to the
147 .BR tcpdump (1)
148 documentation.
149 .\"
150 .TP
151 .BI \-l " network/netmask"
152 Define a "local network" according to the network and netmask addresses.
153 All traffic entering or leaving this network will be graphed, as opposed
154 to the default behaviour of only graphing traffic to and from the local
155 host.
156 .RS
157
158 The rule is that if \fBip_addr & netmask == network\fR,
159 then that address is considered local.
160 See the usage example below.
161 .RE
162 .\"
163 .TP
164 .BI \-\-chroot " dir"
165 Force \fIdarkstat\fR to \fBchroot()\fR into the specified directory.
166 Without this argument, a default directory will be used, which is
167 determined at build time.
168 Usually \fI/var/empty\fR or \fI/var/lib/empty\fR.
169 .RS
170
171 For security reasons, this directory should be empty, and the user that
172 \fIdarkstat\fR is running as should not have write access to it.
173
174 However, if you wish to use \fB\-\-daylog\fR or \fB\-\-export\fR,
175 \fIdarkstat\fR will need write access to the chroot.
176 If you are uncomfortable with the security implications, don't
177 use any functionality that requires write access.
178 .RE
179 .\"
180 .TP
181 .BI \-\-user " username"
182 Force \fIdarkstat\fR to drop privileges to the \fBuid\fR and \fBgid\fR of
183 the specified user.
184 Without this argument, a default value will be used, which is set at
185 build time.
186 Usually \fBnobody\fR.
187 .RS
188
189 For security reasons, this should not be \fBroot\fR.
190 .RE
191 .\"
192 .TP
193 .BI \-\-daylog " filename"
194 .RS
195 Log daily traffic statistics into the named file, relative to the
196 chroot directory.
197 If you wish to use \fB\-\-daylog\fR, you must first specify a
198 \fB\-\-chroot\fR directory, and it must be writeable by the
199 \fIdarkstat\fR user.
200 A writeable chroot has security implications; if you are uncomfortable
201 with this, do not use the \fB\-\-daylog\fR functionality.
202
203 If the daylog argument is not specified, no logging is performed.
204
205 The daylog format is:
206
207 localtime|time_t|bytes_in|bytes_out|pkts_in|pkts_outs
208
209 Lines starting with a # are comments stating when logging started and
210 stopped.
211 .RE
212 .\"
213 .TP
214 .BI \-\-import " filename"
215 Upon starting, import a \fIdarkstat\fR database from the named file,
216 relative to the chroot directory.
217 If you wish to use \fB\-\-import\fR, you must first specify a
218 \fB\-\-chroot\fR directory.
219 If the import is unsuccessful, \fIdarkstat\fR will start with an empty
220 database.
221 .\"
222 .TP
223 .BI \-\-export " filename"
224 On shutdown, and upon receiving SIGUSR1, export the in-memory database
225 to the named file, relative to the chroot directory.
226 If you wish to use \fB\-\-export\fR, you must first specify a
227 \fB\-\-chroot\fR directory, and it must be writeable by the
228 \fIdarkstat\fR user.
229 A writeable chroot has security implications - if you are uncomfortable
230 with this, do not use the \fB\-\-export\fR functionality.
231 .\"
232 .TP
233 .BI \-\-pidfile " filename"
234 .RS
235 Creates a file containing the process ID of \fIdarkstat\fR.
236 This file will be unlinked upon clean shutdown.
237 As with all pidfiles, if \fIdarkstat\fR dies uncleanly, a stale pidfile
238 can be left over.
239
240 For example, start \fIdarkstat\fR with:
241 .IP
242 darkstat \-i fxp0 \-\-chroot /var/run/darkstat \-\-pidfile darkstat.pid
243 .PP
244 And stop with:
245 .IP
246 kill `cat /var/run/darkstat/darkstat.pid`
247 .PP
248 By default,
249 .BR kill (1)
250 will send SIGTERM, which will cause \fIdarkstat\fR to shut down cleanly.
251 .RE
252 .\"
253 .TP
254 .BI \-\-hosts\-max " count"
255 The maximum number of hosts that will be kept in the hosts table.
256 This is used to limit how much accounting data will be kept in memory.
257 .\"
258 .TP
259 .BI \-\-hosts\-keep " count"
260 When the hosts table hits
261 .BI \-\-hosts\-max
262 and traffic is seen from a new host, we clean out the hosts table,
263 keeping only the top
264 .BI \-\-hosts\-keep
265 number of hosts, sorted by total traffic.
266 .\"
267 .TP
268 .BI \-\-ports\-max " count"
269 The maximum number of ports that will be tracked for each host.
270 This is used to limit how much accounting data will be kept in memory.
271 .\"
272 .TP
273 .BI \-\-ports\-keep " count"
274 When a ports table fills up, this many ports are kept and the rest are
275 discarded.
276 .\"
277 .TP
278 .BI \-\-highest\-port " port"
279 Ports that are numerically higher than this will not appear in the
280 per-host ports tables, although their traffic will still be accounted
281 for.
282 This can be used to hide ephemeral ports.
283 By default, all ports are tracked.
284 .\"
285 .\" --------------------------------------------------------------------
286 .SH USAGE EXAMPLES
287 To gather statistics on the
288 .I fxp0
289 interface:
290 .IP
291 darkstat \-i fxp0
292 .PP
293 .\"
294 We want to account for traffic on the Internet-facing interface,
295 but only serve web pages to our private local network where we have the
296 IP address 192.168.0.1:
297 .IP
298 darkstat \-i fxp0 \-b 192.168.0.1
299 .PP
300 .\"
301 We want to serve web pages on the standard HTTP port:
302 .IP
303 darkstat \-i fxp0 \-p 80
304 .PP
305 .\"
306 We are on Optus (cable) and don't want to account for the constant ARP
307 traffic we are receiving:
308 .IP
309 darkstat \-i fxp0 \-f "not arp"
310 .PP
311 .\"
312 We only want to account for SSH traffic:
313 .IP
314 darkstat \-i fxp0 \-f "port 22"
315 .PP
316 .\"
317 We don't want to account for network internal traffic:
318 .IP
319 darkstat \-i fxp0 \-f "not (src net 192.168.0 and dst net 192.168.0)"
320 .PP
321 .\"
322 (For a full reference on filter syntax, refer to the
323 .BR tcpdump (1)
324 manpage)
325 .PP
326 .\"
327 We have a network consisting of a gateway server (192.168.1.1) and a few
328 workstations (192.168.1.2, 192.168.1.3, etc.) and we want to graph all
329 traffic entering and leaving the local network, not just the gateway
330 server (which is running \fIdarkstat\fR):
331 .IP
332 darkstat \-i fxp0 \-l 192.168.1.0/255.255.255.0
333 .\"
334 .SH SIGNALS
335 To shut
336 .I darkstat
337 down cleanly, send a SIGTERM or SIGINT signal to the
338 .I darkstat
339 parent process.
340 .PP
341 Sending the SIGUSR1 signal will cause \fIdarkstat\fR to empty out its
342 in-memory database.
343 If an \fB\-\-export\fR file was set, it will first save the database to
344 file.
345 .PP
346 .\"
347 .SH FREQUENTLY ASKED QUESTIONS
348 .SS How many bytes does each bar on the graph represent?
349 Hover your mouse cursor over a bar and you should get a tooltip
350 saying exactly how many bytes in and out the bar represents.
351 .\"
352 .SS Why aren't there labels / tics / a scale on the graphs?
353 Because implementing them is hard.
354 And doing so \fIcorrectly\fR, and in a way that works across all
355 browsers, looks pretty much impossible.
356
357 I might attempt it some day.
358 In the meantime, patches would be gladly accepted.
359 .\"
360 .SS Why are the graphs blank?  All the bars are zero.
361 The graphs only show traffic in/out of the local host, which is
362 determined by getting the IP address of the interface you're sniffing
363 on.
364
365 You can use the \fB\-l\fR argument to override the local address for
366 accounting purposes.
367 You can also use it to do accounting for a whole subnet by specifying
368 an appropriate netmask.
369 .\"
370 .SH SEE ALSO
371 .BR tcpdump (1)
372 .\"
373 .SH HISTORY
374 .I darkstat
375 was written in 2001, largely as a result of a certain Australian
376 cable Internet provider introducing a 3GB monthly traffic limit.
377 .\"
378 .SH AUTHORS
379 Emil Mikulic and others. (see the AUTHORS and THANKS files)
380 .\"
381 .SH WEBSITE
382 http://dmr.ath.cx/net/darkstat/