1TSPLOT(1)                                                            TSPLOT(1)
2
3
4

NAME

6       tsplot  -  Plot  several  tsung logs on the same charts, for comparison
7       purpose.
8

SYNOPSIS

10       tsplot [ -c configuration file ]  [ -d images output directory ]  [  -v
11       verbose ]  [ legend logfile ]
12

DESCRIPTION

14       Tsung  comes  with a plotting tool using gnuplot, producing some graphs
15       from the tsung.log file data.  tsplot is able to plot data from several
16       tsung.log  files onto the same charts serie, for further comparison and
17       analyze.
18

OPTIONS

20       -c
21
22       --config
23              specifies  the   configuration   file   to   use.   Default   is
24              http.en.plots.conf.
25
26       -d
27
28       --outdir
29              directory where tsplot saves the images it produces, defaults to
30              /tmp/tsung.
31
32       -v
33
34       --verbose
35              makes tsplot very verbose about what it does.
36

CONFIGURATION

38       The configuration file of tsplot allows one to  define  the  plots  you
39       want  to  obtain, from their label to the data they will show. The con‐
40       figuration file adopts a .ini file  syntax,  each  section  defining  a
41       chart.
42
43       tsplot    comes   with   two   sample   configuration   files,   namely
44       http.plots.en.conf and pgsql.plots.en.conf.  They  respectively  define
45       charts to be plotted for a tsung HTTP test and a tsung PGSQL test.
46
47       A DEFAULT section may be provided, any element configured here may then
48       be overridden into a specific plot section.
49
50       Another configuration file is used by tsplot: the tsung/stats.conf one.
51       It's  used  to  define by type the statistics to be read into tsung log
52       files, and you shouldn't need to edit it, short of adding  support  for
53       new tsung statistics.
54
55       Common settings, to be found into DEFAULT section or any specific chart
56       section.
57
58       encoding
59              set here the encoding used thereafter in the  file,  for  labels
60              and titles.
61
62       dpi    dpi setting of produced charts images
63
64       tn_dpi dpi setting of produced charts thumbnail images
65
66       imgtype
67              type of chart image to produce, as in png or ps
68
69              A  complete list might be obtained on the python-matplotlib web‐
70              site, http://matplotlib.sourceforge.net/
71
72       xlabel default label for horizontal axe, often you want seconds or min‐
73              utes, depending on xfactor.
74
75              Please  note you can also set some defaults for ylabel, but this
76              seems not to be a good idea in practise.
77
78       xfactor
79              tsung logs statistics  in  its  logfile  every  10  seconds.  By
80              default, charts will not scale this and have seconds as horizon‐
81              tal axis units. By setting an xfactor of 60, you have  a  minute
82              precision on horizontal axis.
83
84       yfactor
85              same as xfactor, but for vertical axis.
86
87              Depending  on  the data you obtain with your tests, you may want
88              to adapt the vertical scale of your plotting. For  example,  the
89              page.mean  statistic is logged in milliseconds by tsung. You may
90              want to display seconds if this unit better fits your  measures.
91              Then simply set yfactor = 1000.
92
93       styles set  here any number of matplotlib styles you want to use, sepa‐
94              rated by spaces, as  available  here:  http://matplotlib.source
95              forge.net/matplotlib.pylab.html#-plot.
96
97              For exemple, set styles = b- g+ r- cx for plotting first dataset
98              (see stats below) with a blue solid line, second with green plus
99              symbols, third with a red line and last with cyan cross symbols.
100
101              This  could fit a stats = 200.count 400.count stats setting when
102              plotting two tsung logs.
103
104       You then can define any number of plot, one by section, and  give  them
105       an arbitrary name. The name must be unique, and will be used for naming
106       output images.
107
108       Any option available in DEFAULT section is also available in  any  spe‐
109       cific  chart  section,  with  the same meaning and effect. The specific
110       setting will systematically override the DEFAULT one.
111
112       title  Title of the chart, as printed into the resulting image.
113
114       stats  The statistics properties to use for this plotting, as named  in
115              the tsung/stats configuration file. Please see this bundled file
116              for a list of what is available.
117
118              Tsung provide several types of statistics, as  documented  here:
119              http://tsung.erlang-projects.org/user_manual.html#htoc53.    The
120              two main types of statistics used  are  sample  and  counter.  A
121              third  one  is  gauge  but  is  only  use for a single statistic
122              (users).
123
124              sample provides count, mean, stdvar, max, min and gmean  (global
125              mean)  properties,  and  counter  provides only count and total‐
126              count. gauge provide count and max.
127
128              The stats setting can  accept  several  stat.property  elements,
129              separated by spaces.
130
131              Examples:  stats  = users.count to plot the number of simultane‐
132              ously connected users, and stats = 200.count 400.count  to  plot
133              given HTTP return codes count, both on the same chart.
134
135              Please  notice tsplot is currently limited to use only one hori‐
136              zontal and only one  vertical  scales.  matplotlib  is  able  to
137              define some more complex drawings, but tsplot is not yet able to
138              benefit from this.
139
140       legend Legend prefix, which will be followed by  the  legend  given  on
141              command line.
142
143              Each  plot on a chart has a legend entry, you configure here the
144              meaning of the plot (say 'concurrent users') and tsplot will add
145              it  the name of the data serie being plotted (say 'scenario x').
146              You'd obtain this legend: 'concurrent users scenario x'.
147
148       ylabel label for vertical axe
149

CONFIGURATION EXAMPLE

151       Please see the given configuration examples which should be distributed
152       in       /usr/share/doc/tsung/tsung-plotter/http.plots.en.conf      and
153       /usr/share/doc/tsung/tsung-plotter/pgsql.plots.en.conf.
154

BUGS

156       Please reports bugs to the mailing  list  <tsung-users@process-one.net>
157       or     in     the     bug     tracker     <URL:https://support.process-
158       one.net/browse/TSUN>,     see     also      <URL:https://lists.process-
159       one.net/mailman/listinfo/tsung-users> for archives.
160

AUTHORS

162       tsplot is written by Dimitri Fontaine <dim@tapoueh.org>.
163
164
165
166                                 February 2007                       TSPLOT(1)
Impressum