Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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