# $Id$

  IDX-TSUNAMI LISEZMOI
  IDEALX
  ____________________________________________________________

  Table des matires


  1. Introduction

     1.1 Gnralits
     1.2 Qu'est-ce que ce logiciel fait?

  2. Installation

     2.1 Dpendances
     2.2 Compilation et Installation
     2.3 Problmes/Bugs
     2.4 Portabilit

  ______________________________________________________________________

  1.  Introduction

  1.1.  Gnralits

  Ce document donne un rapide descriptifs de IDX-TSUNAMI.

  Les information de Copyright sont disponibles dans le fichier "COPYING."

  1.2.  Qu'est-ce que ce logiciel fait?

  Le propos de IDX-TSUNAMI est de simuler des utilisateurs afin de
  tester la monte en charge et les performances d'applications
  client/serveur (bases sur IP). Actuellement, seul le protocole
  Jabber est implment et test, mais IDX-TSUNAMI est trs facilement
  extensible (voir le fichier doc/Design_fr.txt pour une description
  de l'implmentation et des possibilits d'extensions). IDX-TSUNAMI
  utilise le langage Erlang.

  Ce logiciel est capable de simuler plusieurs milliers d'utilisateurs
  simultanment, et ceux-ci peuvent tre rpartis sur plusieurs
  machines. Plus de 10000 utilisateurs peuvent tre simuls sur une
  seule machine; la limite suprieure dpend du type de hardware et
  galement de l'activit des clients simuls.

  L'ide est de simuler le comportement d'un client rel en utilisant
  un modle de type stochastique, ceci afin de reproduire le trafic
  plus fidlement que peuvent le faire de simple modles dterministes.

  Un utilisateur est caractris par:
      - le temps coul entre chacun de ses messages/requtes ("think time");
      - le nombre de requtes effectues lors d'une session;
      - le type et les paramtres paramtres des requtes  (par exemple
        le type et la taille du message pour Jabber).

  Un autre paramtre est le taux d'arrive des clients (ie. le nombre
  de clients arrivant sur le systme -- dmarrant leur session -- par
  unit de temps).

  Dans l'implmentation actuelle, la taux d'arrive des clients et le
  temps entre message d'un mme client ("think time") sont modliss
  par une distribution exponentielle (par consquent, le processus
  d'arrive est un processus de Poisson).

  Le trafic peut tre "loggu" dans des fichiers, afin de pouvoir
  effectuer toutes sortes de calculs (temps de rponse) aprs coup. Un
  script (calculant notamment les moyennes, cart-type et mdiane des
  temps de rponse) est fourni pour le protocole Jabber.

  2.  Installation

  2.1.  Dpendances
  
  - ncessite Erlang/OTP R7B-0 ou suprieur (test avec la version R7B-2)
    (http://www.erlang.org/download.html)

  - perl5 (pour utiliser les scripts)
	
  - gnuplot (optionnel, utilis pour les sorties graphiques du script 
    analyse_msg.pl)

  2.2.  Compilation et Installation

  diter les fichiers Makefile et idx-tsunami.pl si vous voulez
  changer le chemin par dfaut (/usr/local/idx-tsunami/).

  diter src/tsunami.rel.src si votre version d'Erlang n'est pas R7B-2 
  (les numros de version des modules erts, kernel et stdlib sont
  diffrents d'une version d'Erlang  l'autre).

  make
  make install

  Comment l'utiliser:
    1a/ diter le fichier etc/idx-tsunamirc (toutes les options sont
    dcrites en commentaires).

    1b/ Lire le fichier doc/Jabber.txt pour des informations spcifiques  
    Jabber.

    2/ utilisez le script "idx-tsunami.pl --start" pour dmarrer les
    clients simuls.

    3/ Lorsque c'est termin (idx-tsunami.pl --stop pour forcer) Le
    script analyse_msg.pl gnre une synthse des temps de rponses
    (ncessite un monitoring full ou light); ce script peut galement
    gnrer des graphes avec l'option --plot.
  
  2.3.  Problmes/Bugs
 
    Envoyez vos questions/rapports de bugs aux auteurs (cf. fichier
    CONTRIBUTORS).
 
  2.4.  Portabilit

    Ce logiciel n'a t test que sous Linux. Il devrait nanmoins
    fonctionner sous toute plate-forme support par Erlang (Solaris et
    FreeBSD en particulier).



