File: OutputFormats.html

package info (click to toggle)
collectl 3.7.4-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,624 kB
  • ctags: 119
  • sloc: perl: 14,928; sh: 429; makefile: 11
file content (71 lines) | stat: -rw-r--r-- 3,968 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<html>
<head>
<link rel=stylesheet href="style.css" type="text/css">
<title>Output Formats</title>
</head>

<body>
<center><h1>Output Formats</h1></center>
<p>
<h3>Basic Formatting</h3>
By design, collectl gathers more data than is possible to display in an efficient, easy to read,
compact form.  However, most user want their data displayed in such a form for easy
interpretation.  Therefore, collectl will attempt to display all data in a single line, often
choosing a subset of the complete data for each subsystem.  If the user has selected too
many systems, each line may exceed the display width and wrap.  When this happens either make the
terminal window wider (maybe even using a smaller font) or choose less subsystems.
This is referred to as <i>brief</i> format and is collectl's display format of choice and
therefore the default.  <i>Verbose</i> mode displays more information and results in multiple
lines of output.
<p>
Collectl will try its best to select a format consistent with the user's selection
criteria, using <i>brief</i> mode whenever possible unless explicitly told no to do so.
However there are several instances
when this mode doesn't make sense.  For example, detail data will always be displayed in
<i>verbose</i> mode since it takes multiple lines for each sample.  When this occurs, collectl
will automatically use <i>verbose</i> which can also be manually forced for non-detail 
data using <i>--verbose</i>.
<p>
One should note that these formats are not just for interactive use and can also applied
to playback mode as well.
<p>
An additional feature of <i>brief</i> output is <i>subtotal</i> mode.  If one hits the 
<i>enter</i> key at
any time, the next line of output will be the subtotals (or averages on non-counters)
of all columns since
the start of collectl OR the last time the counters were zeroed.  To zero the
counters enter <i>Z</i> followed by a <i>carriage return</i>.  
Furthermore, if you type <i>A</i> followed by the <i>enter</i> key, the averages
will be reported.  The averages/totals can also be displayed during playback
in brief mode by specifying <i>-oA</i>.
<p>
To get a better idea of what the output actually looks like, see the <a href=Examples.html>examples</a>.
<p>
You can even export your own <a href=Export.html> custom output</a>.
<p>
<h3>Additional Control</h3>
There are several switches that provide even more control over the look of the output in addition
to <i>--verbose</i> as described above.  They are:
<ul>
<li>--home moves the cursor to the home position before displaying verbose output at the start
of each interval.  Only available in interactive mode, this results in a look-and-feel similar
to the <i>top</i> command.
<li>--procfilt and --slabfilt effect the output format for those respective output formats
in that these typically cause a much smaller number of processes or slabs (if used in 
conjunction with --slabopts S) to be displayed, sometimes as little as a line
or two and it was felt repeating the interval header when only processes or slabs are the only data
being reporting, was too distracting and so it left off.  Be sure to try it with -oT for better
clarity.
<li>--top is very similar to the linux <i>top</i> command in that it shows a small subset of processes
sorted by the top consumers of the cpu, I/O or even page faults.  You can even use -s to add 
subsystems to the display in brief or verbose mode as well.  By default this format sorts by
the top CPU users but you can choose virtually field.  If you choose one of the <i>slab</i> field
names it will show the top slabs sorted by that field name.
</ul>
The best way to really understand how these work in conjunction with each other is to try them
out.  And don't forget you can use <i>--top</i> with playback too!

<table width=100%><tr><td align=right><i>updated Feb 21, 2011</i></td></tr></colgroup></table>

</body>
</html>