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