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 dir</arg>
      <arg><option>-m</option> filename</arg>
      <arg><option>-r</option> command</arg>
      <arg><option>-v</option></arg>
      <arg><option>-6</option></arg>
      <arg><option>-h</option></arg>
      <arg>start|stop|debug|status</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, WebDAV, LDAP, PostgreSQL, MySQL and Jabber/XMPP 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>
      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</para>
        </listitem>
      </varlistentry>
       <varlistentry>
        <term><option>debug</option></term>
        <listitem>
          <para>start tsung with an interactive erlang shell</para>
        </listitem>
      </varlistentry>
       <varlistentry>
        <term><option>stop</option></term>
        <listitem>
          <para>stop tsung</para>
        </listitem>
      </varlistentry>
       <varlistentry>
       <term><option>status</option></term>
        <listitem>
          <para>print current status of a running instance of tsung (must be run on the controller host)</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 filename</option></term>
        <listitem>
          <para>specifies the configuration file to use. The default
          file name is <filename>~/.tsung/tsung.xml</filename>. Use - for standard input</para></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l logdir</option></term>
        <listitem>
          <para>Specifies the log directory to use. The default log dir name is <filename>~/.tsung/log/YYYYMMDD-HHMM/</filename></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-m monitoring_file</option></term>
        <listitem>
          <para>Specifies the monitoring log file name to use. The
          default log file name
          is <filename>tsung.log</filename>. Use - for standard output</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-r command</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>-i id</option></term>
        <listitem>
          <para> set controller id (default is empty). Needed to start
            several controllers on the same host.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-F</option></term>
        <listitem>
          <para>Use long names for erlang nodes (FQDN)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-m</option></term>
        <listitem>
          <para>Enable erlang smp on client nodes</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option></term>
        <listitem>
          <para> Show version</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-6</option></term>
        <listitem>
          <para> Use IPv6 for tsung internal communications</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <listitem>
          <para> Show usage</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><citerefentry><refentrytitle>erlang</refentrytitle><manvolnum>3</manvolnum></citerefentry>
    </para>
  </refsect1>

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