capt_get_packet(): check for key press only every 20ms
[iptraf-ng.git] / Documentation / detstats.html
blobdd83f7de7c0b529ac92f487f5fad2e8c9bd5e211
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >Detailed Interface Statistics</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.64
9 "><LINK
10 REL="HOME"
11 TITLE="IPTraf User's Manual"
12 HREF="manual.html"><LINK
13 REL="UP"
14 TITLE="Network Interface Statistics"
15 HREF="netstats.html"><LINK
16 REL="PREVIOUS"
17 TITLE="Network Interface Statistics"
18 HREF="netstats.html"><LINK
19 REL="NEXT"
20 TITLE="Statistical Breakdowns"
21 HREF="statbreakdowns.html"></HEAD
22 ><BODY
23 CLASS="SECT1"
24 BGCOLOR="#FFFFFF"
25 TEXT="#000000"
26 LINK="#0000FF"
27 VLINK="#840084"
28 ALINK="#0000FF"
29 ><DIV
30 CLASS="NAVHEADER"
31 ><TABLE
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >IPTraf User's Manual</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="netstats.html"
49 >&#60;&#60;&#60; Previous</A
50 ></TD
51 ><TD
52 WIDTH="80%"
53 ALIGN="center"
54 VALIGN="bottom"
55 >Network Interface Statistics</TD
56 ><TD
57 WIDTH="10%"
58 ALIGN="right"
59 VALIGN="bottom"
60 ><A
61 HREF="statbreakdowns.html"
62 >Next &#62;&#62;&#62;</A
63 ></TD
64 ></TR
65 ></TABLE
66 ><HR
67 ALIGN="LEFT"
68 WIDTH="100%"></DIV
69 ><DIV
70 CLASS="SECT1"
71 ><H1
72 CLASS="SECT1"
73 ><A
74 NAME="DETSTATS"
75 >Detailed Interface Statistics</A
76 ></H1
77 ><P
78 > The third menu option displays packet statistics for any
79 selected interface. It provides basically the same information
80 as the <I
81 CLASS="EMPHASIS"
82 >General interface statistics</I
84 option, with additional details.
85 This facility provides the following information:</P
86 ><P
87 ></P
88 ><UL
89 COMPACT="COMPACT"
90 ><LI
91 STYLE="list-style-type: disc"
92 ><P
93 > Total packet and byte counts</P
94 ></LI
95 ><LI
96 STYLE="list-style-type: disc"
97 ><P
98 > IP packet and byte counts</P
99 ></LI
100 ><LI
101 STYLE="list-style-type: disc"
103 > TCP packet and byte counts</P
104 ></LI
105 ><LI
106 STYLE="list-style-type: disc"
108 > UDP packet and byte count</P
109 ></LI
110 ><LI
111 STYLE="list-style-type: disc"
113 > ICMP packet and byte counts</P
114 ></LI
115 ><LI
116 STYLE="list-style-type: disc"
118 > Other IP-type packet and byte counts</P
119 ></LI
120 ><LI
121 STYLE="list-style-type: disc"
123 > Non-IP packet and byte counts</P
124 ></LI
125 ><LI
126 STYLE="list-style-type: disc"
128 > Checksum error count</P
129 ></LI
130 ><LI
131 STYLE="list-style-type: disc"
133 > Interface activity</P
134 ></LI
135 ><LI
136 STYLE="list-style-type: disc"
138 > Broadcast packet and byte counts</P
139 ></LI
140 ></UL
142 > All IP byte counts (IP, TCP, UDP, ICMP, other IP) include IP header data
143 and payload. The data link header is not included. The full frame length
144 (including data-link header) is included in the non-IP and Total
145 byte count. All data-link headers are also included in the Total byte
146 counts.</P
147 ><DIV
148 CLASS="FIGURE"
150 NAME="AEN1145"
151 ></A
153 ><IMG
154 SRC="iptraf-dstat1.png"></P
157 >Figure 2. The detailed interface statistics screen</B
158 ></P
159 ></DIV
161 > The upper portion of the screen
162 contains the packet and byte counts for all IP and
163 non-IP packets intercepted on the interface. The lower portion
164 contains the total, incoming, and outgoing interface data rates.</P
166 > This facility also displays incoming and outgoing counts and data rates.
167 The packet size breakdown in versions prior to 2.0.0 has been moved
168 to its own facility under <I
169 CLASS="EMPHASIS"
170 >Statistical breakdowns.../By packet
171 size</I
172 > as described in <A
173 HREF="statbreakdowns.html#PKTSIZE"
174 >Chapter 5</A
175 >.</P
177 > An outgoing packet is one that exits your interface, regardless
178 of whether it originated from your machine or came
179 from another machine and was routed through yours. An incoming packet is
180 one that enters your interface, either addressed
181 to you directly, broadcast, multicast, or captured promiscuously.</P
183 > The rate indicators can be set to display kbits/s or kbytes/s with the
185 CLASS="EMPHASIS"
186 >Activity mode</I
187 > configuration option.</P
188 ><DIV
189 CLASS="NOTE"
191 ></P
192 ><TABLE
193 CLASS="NOTE"
194 WIDTH="100%"
195 BORDER="0"
196 ><TR
197 ><TD
198 WIDTH="25"
199 ALIGN="CENTER"
200 VALIGN="TOP"
201 ><IMG
202 SRC="./stylesheet-images/note.gif"
203 HSPACE="5"
204 ALT="Note"></TD
205 ><TH
206 ALIGN="LEFT"
207 VALIGN="CENTER"
209 >Note</B
210 ></TH
211 ></TR
212 ><TR
213 ><TD
214 >&nbsp;</TD
215 ><TD
216 ALIGN="LEFT"
217 VALIGN="TOP"
219 > Buffering and some other factors may affect the data rates, notably
220 the outgoing rate, causing it to reflect a higher figure than the actual
221 rate at which the interface is sending.</P
222 ></TD
223 ></TR
224 ></TABLE
225 ></DIV
227 > The figures are logged at regular intervals if logging is enabled. The
228 default log file name at the prompt is
230 CLASS="FILENAME"
231 >iface_stats_detailed-<TT
232 CLASS="REPLACEABLE"
234 >iface</I
235 ></TT
236 >.log</TT
238 where iface is the selected interface for this session (for example,
240 CLASS="FILENAME"
241 >iface_stats_detailed-eth0.log</TT
242 >).</P
244 > If you wish to start this facility directly
245 from the command line, you can specify the
247 CLASS="COMPUTEROUTPUT"
248 >-d</TT
249 > parameter and an interface
250 to monitor. For example,</P
251 ><TABLE
252 BORDER="0"
253 BGCOLOR="#E0E0E0"
254 WIDTH="100%"
255 ><TR
256 ><TD
257 ><PRE
258 CLASS="SYNOPSIS"
259 >iptraf -d eth0</PRE
260 ></TD
261 ></TR
262 ></TABLE
264 > starts the statistics for <TT
265 CLASS="FILENAME"
266 >eth0</TT
267 >. The interface must be specified, or
268 IPTraf will not start the facility.</P
270 > When started from the command line, the log filename and log interval can be
271 specified with the <TT
272 CLASS="COMPUTEROUTPUT"
273 >-L</TT
274 > and <TT
275 CLASS="COMPUTEROUTPUT"
276 >-I</TT
278 parameters respectively. See the <A
279 HREF="cmdline.html"
280 >Command-line Parameters</A
282 section above for more information.</P
283 ><DIV
284 CLASS="NOTE"
286 ></P
287 ><TABLE
288 CLASS="NOTE"
289 WIDTH="100%"
290 BORDER="0"
291 ><TR
292 ><TD
293 WIDTH="25"
294 ALIGN="CENTER"
295 VALIGN="TOP"
296 ><IMG
297 SRC="./stylesheet-images/note.gif"
298 HSPACE="5"
299 ALT="Note"></TD
300 ><TH
301 ALIGN="LEFT"
302 VALIGN="CENTER"
304 >Note</B
305 ></TH
306 ></TR
307 ><TR
308 ><TD
309 >&nbsp;</TD
310 ><TD
311 ALIGN="LEFT"
312 VALIGN="TOP"
314 > In both the general and detailed statistics screens, as well as
315 in the IP traffic monitor, the packet counts are for
316 actual network packets (layer 2), not the logical IP packets (layer 3)
317 that may be reconstructed after fragmentation. That means, if a
318 packet was fragmented into four pieces, and these four fragments pass
319 over your interface, the packet counts will indicate four separate
320 packets.
322 ></TD
323 ></TR
324 ></TABLE
325 ></DIV
327 > The figure for the IP checksum errors is a packet count only, because the
328 corrupted IP header cannot be relied upon to give a correct IP
329 packet length value.</P
331 > This facility's output is also affected by IPTraf's <A
332 HREF="filters.html"
333 >filters</A
334 >. See Chapter 7 for more information
335 on filters.</P
337 > Pressing X or Q takes you back to the main menu (if this
338 facility was started with the command-line option, X or Q drops you back
339 to the shell).</P
340 ></DIV
341 ><DIV
342 CLASS="NAVFOOTER"
343 ><HR
344 ALIGN="LEFT"
345 WIDTH="100%"><TABLE
346 WIDTH="100%"
347 BORDER="0"
348 CELLPADDING="0"
349 CELLSPACING="0"
350 ><TR
351 ><TD
352 WIDTH="33%"
353 ALIGN="left"
354 VALIGN="top"
356 HREF="netstats.html"
357 >&#60;&#60;&#60; Previous</A
358 ></TD
359 ><TD
360 WIDTH="34%"
361 ALIGN="center"
362 VALIGN="top"
364 HREF="manual.html"
365 >Home</A
366 ></TD
367 ><TD
368 WIDTH="33%"
369 ALIGN="right"
370 VALIGN="top"
372 HREF="statbreakdowns.html"
373 >Next &#62;&#62;&#62;</A
374 ></TD
375 ></TR
376 ><TR
377 ><TD
378 WIDTH="33%"
379 ALIGN="left"
380 VALIGN="top"
381 >Network Interface Statistics</TD
382 ><TD
383 WIDTH="34%"
384 ALIGN="center"
385 VALIGN="top"
387 HREF="netstats.html"
388 >Up</A
389 ></TD
390 ><TD
391 WIDTH="33%"
392 ALIGN="right"
393 VALIGN="top"
394 >Statistical Breakdowns</TD
395 ></TR
396 ></TABLE
397 ></DIV
398 ></BODY
399 ></HTML