Skip to content
Newer
Older
100644 198 lines (186 sloc) 5.95 KB
272e833 @nniclausse update docs
nniclausse authored
1 .\\" auto-generated by docbook2man-spec $Revision: 1.1 $
2 .TH "TSPLOT" "1" "February 2007" "" ""
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
3 .SH NAME
4 tsplot \- Plot several tsung logs on the same charts, for comparison purpose.
5 .SH SYNOPSIS
272e833 @nniclausse update docs
nniclausse authored
6 .sp
7 \fBtsplot\fR [ \fB-c configuration file\fR ] [ \fB-d images output directory\fR ] [ \fB-v verbose\fR ] [ \fBlegend logfile\fR ]
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
8 .SH "DESCRIPTION"
9 .PP
10 Tsung comes with a plotting tool using
11 \fBgnuplot\fR, producing some graphs from the
12 \fItsung.log\fR file data.
13 \fBtsplot\fR is able to plot data from several
14 \fItsung.log\fR files onto the same charts serie,
15 for further comparison and analyze.
16 .SH "OPTIONS"
17 .PP
18 .TP
19 \fB-c\fR
20 .TP
21 \fB--config\fR
272e833 @nniclausse update docs
nniclausse authored
22 specifies the configuration file to use. Default is \fIhttp.en.plots.conf\fR.
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
23 .TP
24 \fB-d\fR
25 .TP
26 \fB--outdir\fR
27 directory where \fBtsplot\fR saves the images
272e833 @nniclausse update docs
nniclausse authored
28 it produces, defaults to \fI/tmp/tsung\fR.
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
29 .TP
30 \fB-v\fR
31 .TP
32 \fB--verbose\fR
33 makes \fBtsplot\fR very verbose about
34 what it does.
35 .SH "CONFIGURATION"
36 .PP
37 The configuration file of \fBtsplot\fR allows to
38 define the plots you want to obtain, from their label to the
39 data they will show. The configuration file adopts a
40 \fI\&.ini\fR file syntax, each section defining a
41 chart.
42 .PP
43 \fBtsplot\fR comes with two sample configuration
5f115b1 @nniclausse generated from sgml
nniclausse authored
44 files, namely \fIhttp.plots.en.conf\fR and
272e833 @nniclausse update docs
nniclausse authored
45 \fIpgsql.plots.en.conf\fR. They respectively define
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
46 charts to be plotted for a \fBtsung\fR HTTP test
5f115b1 @nniclausse generated from sgml
nniclausse authored
47 and a \fBtsung\fR PGSQL test.
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
48 .PP
49 A \fBDEFAULT\fR section may be provided, any
50 element configured here may then be overriden into a specific
51 plot section.
52 .PP
53 Another configuration file is used by \fBtsplot\fR:
54 the \fItsung/stats.conf\fR one. It's used to
55 define by type the statistics to be read into
56 \fBtsung\fR log files, and you shouldn't need to
57 edit it, short of adding support for new
58 \fBtsung\fR statistics.
59 .PP
60 Common settings, to be found into \fBDEFAULT\fR
61 section or any specific chart section.
62 .TP
63 \fBencoding\fR
64 set here the encoding used thereafter in the file, for
65 labels and titles.
66 .TP
67 \fBdpi\fR
68 dpi setting of produced charts images
69 .TP
70 \fBtn_dpi\fR
71 dpi setting of produced charts thumbnail images
72 .TP
73 \fBimgtype\fR
74 type of chart image to produce, as in
75 \fIpng\fR or \fIps\fR
76
77 A complete list might be obtained on the
78 \fBpython-matplotlib\fR website,
79 http://matplotlib.sourceforge.net/
80 .TP
81 \fBxlabel\fR
82 default label for horizontal axe, often you want seconds
83 or minutes, depending on xfactor.
84
85 Please note you can also set some defaults for ylabel, but
86 this seems not to be a good idea in practise.
87 .TP
88 \fBxfactor\fR
89 tsung logs statistics in its logfile every 10 seconds. By
90 default, charts will not scale this and have seconds as
91 horizontal axis units. By setting an xfactor of 60, you
92 have a minute precision on horizontal axis.
93 .TP
94 \fByfactor\fR
95 same as xfactor, but for vertical axis.
96
97 Depending on the data you obtain with your tests, you may
98 want to adapt the vertical scale of your plotting. For
99 example, the \fBpage.mean\fR statistic is
272e833 @nniclausse update docs
nniclausse authored
100 logged in milliseconds by \fBtsung\fR. You
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
101 may want to display seconds if this unit better fits your
102 measures. Then simply set \fByfactor =
272e833 @nniclausse update docs
nniclausse authored
103 1000\fR.
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
104 .TP
105 \fBstyles\fR
106 set here any number of \fBmatplotlib\fR
107 styles you want to use, separated by spaces, as available
108 here:
109 http://matplotlib.sourceforge.net/matplotlib.pylab.html#-plot.
110
111 For exemple, set \fBstyles = b- g+ r- cx\fR
112 for plotting first dataset (see \fBstats\fR
113 below) with a blue solid line, second with green plus
114 symbols, third with a red line and last with cyan cross
115 symbols.
116
117 This could fit a \fBstats = 200.count
118 400.count\fR stats setting when plotting two
119 \fBtsung\fR logs.
120 .PP
121 You then can define any number of plot, one by section, and give
122 them an arbitrary name. The name must be unique, and will be
123 used for naming output images.
124 .PP
272e833 @nniclausse update docs
nniclausse authored
125 .PP
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
126 Any option available in DEFAULT section is also available in any
127 specific chart section, with the same meaning and effect. The
128 specific setting will systematically override the DEFAULT one.
272e833 @nniclausse update docs
nniclausse authored
129 .PP
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
130 .TP
131 \fBtitle\fR
132 Title of the chart, as printed into the resulting image.
133 .TP
134 \fBstats\fR
135 The statistics properties to use for this plotting, as
136 named in the \fItsung/stats\fR
137 configuration file. Please see this bundled file for a
138 list of what is available.
139
140 Tsung provide several types of statistics, as documented
141 here:
142 http://tsung.erlang-projects.org/user_manual.html#htoc53. The
143 two main types of statistics used are
272e833 @nniclausse update docs
nniclausse authored
144 \fBsample\fR and \fBcounter\fR. A
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
145 third one is \fBgauge\fR but is only use for a
146 single statistic (users).
147
148 sample provides count, mean, stdvar, max, min and gmean
149 (global mean)
150 properties, and counter provides only count and
151 totalcount. gauge provide count and max.
152
153 The stats setting can accept several
154 \fBstat.property\fR elements, separated by
155 spaces.
156
157 Examples: \fBstats = users.count\fR to plot
158 the number of simultaneously connected users, and
159 \fBstats = 200.count 400.count\fR to plot
160 given HTTP return codes count, both on the same chart.
161
162 Please notice \fBtsplot\fR is currently
163 limited to use only one horizontal and only one vertical
164 scales. \fBmatplotlib\fR is able to define
165 some more complex drawings, but \fBtsplot\fR
166 is not yet able to benefit from this.
167 .TP
168 \fBlegend\fR
169 Legend prefix, which will be followed by the legend given
170 on command line.
171
172 Each plot on a chart has a legend entry, you configure
173 here the meaning of the plot (say 'concurrent users') and
174 \fBtsplot\fR will add it the name of the data
175 serie being plotted (say 'scenario x'). You'd obtain this
176 legend: 'concurrent users scenario x'.
177 .TP
178 \fBylabel\fR
179 label for vertical axe
180 .SH "CONFIGURATION EXAMPLE"
181 .PP
182 Please see the given configuration examples which should be
183 distributed in
5f115b1 @nniclausse generated from sgml
nniclausse authored
184 \fI/usr/share/doc/tsung/tsung-plotter/http.plots.en.conf\fR
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
185 and
272e833 @nniclausse update docs
nniclausse authored
186 \fI/usr/share/doc/tsung/tsung-plotter/pgsql.plots.en.conf\fR.
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
187 .SH "BUGS"
188 .PP
189 Please reports bugs to the mailing list
272e833 @nniclausse update docs
nniclausse authored
190 <tsung-users@process-one.net> or in the bug
191 tracker <URL:https://support.process-one.net/browse/TSUN>,
192 see also <URL:https://lists.process-one.net/mailman/listinfo/tsung-users> for
fb11e0f @nniclausse - include tsung-plotter tool from Dimitri Fontaine (TSUN-89)
nniclausse authored
193 archives.
194 .SH "AUTHORS"
195 .PP
272e833 @nniclausse update docs
nniclausse authored
196 \fBtsplot\fR is written by Dimitri Fontaine
197 <dim@tapoueh.org>.
Something went wrong with that request. Please try again.