tsung.1.sgml

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry>
  <refentryinfo>
    <address>
      <email>nicolas.niclausse@niclux.org</email>
    </address>
    <author>
      <firstname>Nicolas</firstname>
      <surname>Niclausse</surname>
    </author>
    <date>January 2004</date>
    <copyright>
      <year>2004</year>
      <holder>Nicolas Niclausse</holder>
    </copyright>
  </refentryinfo>

  <refmeta>
    <refentrytitle>tsung</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>tsung</refname>
    <refpurpose>
A distributed multi-protocol load testing tool.
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>tsung</command>
      <arg><option>-f</option> configuration file</arg>
      <arg><option>-l</option> log file</arg>
      <arg><option>-r</option> command</arg>
      <arg><option>-p</option> plugin</arg>
      <arg>start|stop|restart|debug|status|recorder|stop_recorder</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>description</title>
    <para>
      <command>tsung</command> is a distributed load testing
      tool.  It is protocol-independent and can currently be used to
      stress and benchmark HTTP, PostgreSQL and Jabber servers.</para>

    <para> It simulates user behaviour using an XML description file,
    reports many measurements in real time (statistics can be
    customized with transactions, and graphics generated using
    gnuplot).  </para>

    <para>For HTTP, it supports 1.0 and 1.1, has a proxy mode to
    record sessions, supports GET and POST methods, Cookies, and Basic
    WWW-authentication. It also has support for SSL.  </para>

    <para> There are two applications builtin with this script: the load testing tool, and the proxy recorder.
    </para>
    <para>
      Several config examples can be found in
      <filename>/usr/share/doc/tsung/examples/</filename>.
      </para>

    <variablelist>
      <varlistentry>
        <term><option>start</option></term>
        <listitem>
          <para>start tsung load testing</filename></para>
        </listitem>
        <term><option>debug</option></term>
        <listitem>
          <para>start tsung with an erlang shell</filename></para>
        </listitem>
        <term><option>stop</option></term>
        <listitem>
          <para>stop tsung</filename></para>
        </listitem>
        <term><option>recorder</option></term>
        <listitem>
          <para>start the proxy recorder (listening port is 8090). By default the HTTP recorder is started. With the -p option, you can select another plugin. The resulting files will be created as <filename>~/.tsung/tsung_recorderYYYMMDD-HH:MM.xml</filename>; if it doesn't work, take a look at <filename>~/.tsung/log/tsung.log-tsunami_recorder@hostname</filename> </para>
        </listitem>
        <term><option>stop_recorder</option></term>
        <listitem>
          <para>stop the proxy recorder</filename></para>
        </listitem>
        <term><option>status</option></term>
        <listitem>
          <para>print current status of tsung</filename></para>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>
  <refsect1>
    <title>manual</title> <para>A manual should be available at
    <filename>/usr/share/doc/tsung/user_manual.html</filename>. It
    is also available online at
    <address>http://tsung.erlang-projects.org/user_manual.html</address>
    </para>
  </refsect1>

  <refsect1>
    <title>options</title>
    <variablelist>
      <varlistentry>
        <term><option>-f</option></term>
        <listitem>
          <para>specifies the configuration file to use. The default file name is <filename>~/.tsung/tsung.xml</filename></para>
        </listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-l</option></term>
        <listitem>
          <para>specifies the log file to use. The default log file name is <filename>~/tsung/log/tsung.log</filename></para>
        </listitem>
      </varlistentry>
    </variablelist>
      <varlistentry>
      <term><option>-r</option></term>
      <listitem>
        <para> Specifies an alternative to ssh (rsh for ex.) for starting a slave node on a remote host</para>
      </listitem>
    </varlistentry>
      <varlistentry>
      <term><option>-p</option></term>
      <listitem>
        <para> Specifies the plugin used for the recorder. Default is http, available: http, pgsql</para>
      </listitem>
    </varlistentry>
  </variablelist>
  </refsect1>

  <refsect1>
    <title>Bugs</title> <para> Please reports bugs to the mailing list
    <email>tsung-users@process-one.net</email>, see
    <address>https://lists.process-one.net/mailman/listinfo/tsung-users</address> for
    archives.
    </para>
  </refsect1>

  <refsect1>
    <title>see also</title>
    <para><filename>erlang</filename><manvolnum>3</manvolnum>
    </para>
  </refsect1>

  <refsect1>
    <title>Authors</title>
    <para>
        <command>Tsung</command> is written by <author>Nicolas Niclausse</author>
      <email>nicolas@niclux.org</email>. Contributors list
      is available in
      <filename>/usr/share/doc/tsung/CONTRIBUTORS</filename>
  </refsect1>
  
</refentry>