monitoring.sgml

H.323网守实现

<!-- French translation from monitoring.sgml v1.3 -->

<sect>Surveillance du Gatekeeper
<label id="monitor">
<p>
<sect1>Port d'&#233;tat
<p>
Le port d'&#233;tat est l'interface externe pour surveiller et contr&#244;ler le
gatekeeper.
Via cette interface, le gatekeeper enverra des messages &#224; propos des appels en
cours de tous les clients connect&#233;s et recevra des commandes.

<p>
Les messages envoy&#233;s par le gatekeeper au port d'&#233;tat sont regroup&#233;s
en trois <bf/niveaux de trace de sortie/:
<itemize>
<item>Niveau 0
	<quote>
	Notifications de rechargement et r&#233;ponses directes aux commandes saisies.
	</quote>
<item>Niveau 1
	<quote>
	Notifications de rechargement, r&#233;ponses directes aux commandes saisies, CDRs
	et Requ&#234;tes de Routage.
	</quote>
<item>Niveau 2
	<quote>
	Trace tout (notification des rechargement, r&#233;ponses directes aux commandes
	saisies, CDRs, Requ&#234;tes de Routage, RAS, ...). Il s'agit du niveau de
	trace par <bf/d&#233;faut/.
	</quote>
</itemize>
Le client connect&#233; au port d'&#233;tat peut choisir le niveau de trace par lequel
il est int&#233;ress&#233;.

<p>
L'interface est un simple port TCP (par d&#233;faut: 7000), vous pouvez vous connecter
avec telnet ou un autre client. Une exemple d'autre client est l'IHM Java, connue sous
le nom de GnuGk ACD.

<sect2>Domaines d'Application
<p>
Ce que vous fa&#238;tes avec les pouvoirs de l'Interface d'Etat d&#233;pend de vous,
mais voici quelques id&#233;es:
<itemize>
<item>Surveillance d'Appel
<item>Surveillande des terminaux enregistr&#233;s
<item>Interface Utilisateur Graphique
<quote>
Voir GkGUI.
</quote>
<item>Routage d'Appel
<quote>
Voir GnuGk ACD.
</quote>
<item>Applications de Facturation
<quote>
Analyser les messages CDR et les transmettre &#224; l'application de facturation.
</quote>
<item>Interfacer des extensions externes
<quote>
Si vous ne voulez pas publier le code source de ces fonctions suppl&#233;mentaires,
publiez juste le noyau de la fonction et interfacez vous avec au travers de
l'interface d'&#233;tat et conservez les parties externes priv&#233;es.
</quote>
</itemize>
<p>
<sect2>Exemples
<p>
Supposons que vous &#234;tes juste int&#233;ress&#233;s par les CDRs (enregistrement
des d&#233;tails des appels) et vous voulez les traiter en lot &#224; intervalles
r&#233;guliers.

Voici un script Perl simple (<tt/gnugk_cdr.pl/) qui lance le gatekeeper et un client
tr&#232;s simple pour l'Interface d'Etat et &#233;crit juste les CDRs dans un fichier
de log. Vous aurez besoin de le modifier un peu pour qu'il corresponde &#224; vos
besoins.

<verb>
#!/usr/bin/perl
# sample program that demonstrates how to write the CDRs to a log file
use strict;
use IO::Socket;
use IO::Handle;

my $logfile = "/home/jan/cdr.log";	# CHANGE THIS
my $gk_host = "localhost";
my $gk_port = 7000;
my $gk_pid;

if ($gk_pid = fork()) {
	# parent will listen to gatekeeper status
	sleep(1);	# wait for gk to start
	my $sock = IO::Socket::INET->new(PeerAddr => $gk_host, PeerPort => $gk_port, Proto => 'tcp');
	if (!defined $sock) {
		die "Can't connect to gatekeeper at $gk_host:$gk_port";
	}
	$SIG{HUP} = sub { kill 1, $gk_pid; };	# pass HUP to gatekeeper
	$SIG{INT} = sub { close (CDRFILE); kill 2, $gk_pid; };	# close file when terminated

	open (CDRFILE, ">>$logfile");
	CDRFILE->autoflush(1);	# don't buffer output
	while (!$sock->eof()) {
		my $msg = $sock->getline();
		$msg = (split(/;/, $msg))[0];	# remove junk at end of line
		my $msgtype = (split(/\|/, $msg))[0];
		if ($msgtype eq "CDR") {
			print CDRFILE "$msg\n";
		}
	}
	close (CDRFILE);
} else {
	# child starts gatekeeper
	exec("gnugk");
}
</verb>
<p>
Rappelez-vous qu'il ne s'agit que d'un exemple pour montrer l'utilisation du port
d'&#233;tat.
Vous pouvez utiliser le module FileAcct pour tracer les CDRs dans un syst&#232;me
de production.

<sect2>IHM pour le Gatekeeper
<p>
Il y a plusieurs Interfaces Home Machine (IHM - GUI) pour le gatekeeper.

<itemize>
<item>Java GUI<p>
D&#233;velopp&#233; par Jan Willamowius.
Vous pouvez surveiller les enregistrements et les appels qui passent par le gatekeeper.
Un clic droit sur un bouton vous donne un menu d&#233;roulant pour ce terminal.

Cette IHM fonctionne avec Java 1.0 pr&#233;sent dans la plupart des navigateurs web.
Pour des raisons de s&#233;curit&#233; l'IHM doit fonctionner comme une application
autonome ou &#234;tre mise &#224; disposition par un serveur web sur le m&#234;me
num&#233;ro IP que le gatekeeper (vous ne pouvez pas le lancer en tant qu'applet
depuis un fichier local).

Le programme est disponible &#224;
<url url="http://www.gnugk.org/h323gui.html" name="GnuGk Java GUI">

<item>GkGUI<p>
Un nouveau programme Java autonome d&#233;velopp&#233; par
<url url="http://www.citron.com.tw/" name="Citron Network Inc.">
Il n&#233;cessite Java 1.4. Les nouvelles fonctions comprennent:

<itemize>
<item>Surveillance de plusieurs gatekeeper simultan&#233;ment.
<item>Deux modes d'affichage: Liste de Boutons ou Arbre.
<item>Enregistrement des D&#233;tails d'Appel (CDR) et statistiques.
<item>GK Status Log.
<item>Couleurs diff&#233;rentes pour diff&#233;rents types de terminaux.
<item>Modification de la configuration du gatekeeper.
<item>D&#233;senregistrement forc&#233; de terminaux.
<item>Sauvegarde et imprime le log d'&#233;tat et CDR.
</itemize>

Le GkGUI est distribu&#233; sous GNU General Public License, disponible &#224;
<url url="http://www.gnugk.org/h323develop.html#java" name="GnuGk Development">
</itemize>

<sect1>Commandes (R&#233;f&#233;rence)
<p>
Cette section liste toutes les commandes que vous pouvez &#233;mettre sur le port
d'&#233;tat (manuellement ou avec une application externe). Les commandes ne tiennent
pas compte de la casse (majuscules / minuscules). Mais certains param&#232;tres
peuvent en tenir compte.
<p>
La commande <tt/help/ ou <tt/h/ affichera la liste de toutes les commandes disponibles.
<p>
<itemize>
<item><tt/Reload/
<p>Recharge la configuration.

<item><tt/Version/, <tt/v/
<p>Afficher la version et des informations sur l'OS du gatekeeper.

<item><tt/Statistics/, <tt/s/
<p>Affiche des informations statistiques du gatekeeper.
<descrip>
<tag/Exemple:/
<tscreen><verb>
Statistics
-- Endpoint Statistics --
Total Endpoints: 21  Terminals: 17  Gateways: 4  NATed: 2
Cached Endpoints: 1  Terminals: 1  Gateways: 0
-- Call Statistics --
Current Calls: 1 Active: 1 From Neighbor: 0 From Parent: 0
Total Calls: 1539  Successful: 1076  From Neighbor: 60  From Parent: 5
Startup: Fri, 21 Jun 2002 10:50:22 +0800   Running: 11 days 04:22:59
;
</verb></tscreen>
</descrip>

<item><tt/PrintAllRegistrations/, <tt/r/, <tt/?/
<p>Affiche tous les terminaux enregistr&#233;s.
<descrip>
<tag/Format:/
<tscreen><verb>
AllRegistrations
RCF|IP:Port|Aliases|Terminal_Type|EndpointID
...
Number of Endpoints: n
;
</verb></tscreen>
<tag/Exemple:/
<tscreen><verb>
AllRegistrations
RCF|10.1.1.10:1720|800:dialedDigits=Wei:h323_ID|terminal|1289_endp
RCF|10.0.1.43:1720|613:dialedDigits=Jacky Tsai:h323_ID|terminal|1328_endp
RCF|10.0.1.55:1720|705:dialedDigits=Sherry Liu:h323_ID|terminal|1333_endp
Number of Endpoints: 3
;
</verb></tscreen>
</descrip>

<item><tt/PrintAllRegistrationsVerbose/, <tt/rv/, <tt/??/
<p>Affiche des d&#233;tails sur tous les terminaux enregistr&#233;s.
<descrip>
<tag/Format:/
<tscreen><verb>
AllRegistrations
RCF|IP:Port|Aliases|Terminal_Type|EndpointID
Registration_Time C(Active_Call/Connected_Call/Total_Call) &lt;r&gt;
[Prefixes: ##] (gateway only)
...
Number of Endpoints: n
;
</verb></tscreen>
<tag/Exemple:/
<tscreen><verb>
AllRegistrations
RCF|10.0.1.8:1720|Accel-GW2:h323_ID|gateway|1322_endp
Wed, 26 Jun 2002 16:40:03 +0800 C(1/5/33) &lt;1&gt;
Prefixes: 09,002
RCF|10.1.1.10:1720|800:dialedDigits=Wei:h323_ID|terminal|1289_endp
Wed, 26 Jun 2002 16:40:55 +0800 C(0/32/39) &lt;1&gt;
RCF|10.0.1.66:1720|716:dialedDigits=Vicky:h323_ID|terminal|1425_endp
Wed, 26 Jun 2002 16:40:58 +0800 C(1/47/53) &lt;1&gt;
Number of Endpoints: 2
;
</verb></tscreen>
</descrip>

<item><tt/PrintCurrentCalls/, <tt/c/, <tt/!/
<p>Affiche tous les appels en cours en utilisant la m&#234;me syntaxe ACF que lors de
l'&#233;tablissement de l'appel.
<descrip>
<tag/Format:/
<tscreen><verb>
CurrentCalls
Call No. # | CallID | Call_Duration | Left_Time
Dialed_Number
ACF|Caller_IP:Port|Caller_EPID|CRV|DestinationInfo|SrcInfo|IsAnswered;
ACF|Callee_IP:Port|Callee_EPID|CRV|DestinationInfo|SrcInfo|IsAnswered;
...
Number of Calls: Current_Call Active: Active_Call From Neighbor: Call_From_Neighbor \
From Parent: Call_From_Parent
;
</verb></tscreen>
<tag/Exemple:/
<tscreen><verb>
CurrentCalls
Call No. 29 | CallID bd c6 17 ff aa ea 18 10 85 95 44 45 53 54 77 77 | 109 | 491
Dial 0953378875:dialedDigits
ACF|10.0.1.49:1720|4048_CGK1|25263|frank:h323_ID|gunter:h323_ID|false;
ACF|10.1.1.1:1720|4037_CGK1|25263|gunter:h323_ID|frank:h323_ID|true;
Call No. 30 | CallID 70 0e dd c0 9a cf 11 5e 00 01 00 05 5d f9 28 4d | 37 | 563
Dial 0938736860:dialedDigits
ACF|10.0.1.48:1032|4041_CGK1|11896|sue:h323_ID|peter:h323_ID|false;
ACF|10.1.1.1:1720|4037_CGK1|11896|peter:h323_ID|sue:h323_ID|true;
Number of Calls: 2 Active: 2 From Neighbor: 0 From Parent: 0
;
</verb></tscreen>
</descrip>

<item><tt/PrintCurrentCallsVerbose/, <tt/cv/, <tt/!!/
<p>Affiche des d&#233;tails sur tous les appels en cours.
<descrip>
<tag/Format:/
<tscreen><verb>
CurrentCalls
Call No. # | CallID | Call_Duration | Left_Time
Dialed_Number
ACF|Caller_IP:Port|Caller_EPID|CRV|DestinationInfo|SrcInfo|IsAnswered;
ACF|Callee_IP:Port|Callee_EPID|CRV|DestinationInfo|SrcInfo|IsAnswered;
# Caller_Aliases|Callee_Aliases|Bandwidth|Connected_Time &lt;r&gt;
...
Number of Calls: Current_Call Active: Active_Call From NB: Call_From_Neighbor
;
</verb></tscreen>
<tag/Exemple:/
<tscreen><verb>
CurrentCalls
Call No. 48 | CallID 7d 5a f1 0a ad ea 18 10 89 16 00 50 fc 3f 0c f5 | 30 | 570
Dial 0225067272:dialedDigits
ACF|10.0.1.200:1720|1448_endp|19618|frank:h323_ID|gunter:h323_ID|false;
ACF|10.0.1.7:1720|1325_endp|19618|gunter:h323_ID|frank:h323_ID|true;
# Sherry:h323_ID|Accel-GW1:h323_ID|200000|Wed, 26 Jun 2002 17:29:55 +0800 &lt;2&gt;
Number of Calls: 1 Active: 1 From NB: 0
;
</verb></tscreen>
</descrip>

<item><tt/Find/, <tt/f/
<p>Trouve un terminal enregistr&#233; par un alias ou un pr&#233;fixe.
<descrip>
<tag/Format:/
<tscreen><verb>
Find Alias
RCF|IP:Port|Aliases|Terminal_Type|EndpointID
;
</verb></tscreen>
<tag/Exemple:/
<tscreen><verb>
f 800
RCF|10.1.1.10:1720|800:dialedDigits=Wei:h323_ID|terminal|1289_endp
;
f 801