Monitoring-Funktionen im Archiv-Server

M o n i t o r i n g -F u n k t i o n e n i m
A r c h i v -S e r v e r
B e d ie n u n g s a n le itu n g
Version 1.3
2003-01-29
SEAL Systems
2
Copyright
Copyright
Dieses Dokument, einschließlich aller seiner Teile, ist urheberrechtlich geschützt. Jede Verwertung ohne vorherige schriftliche Zustimmung der SEAL Systems ist unzulässig und
strafbar. Dies gilt insbesondere für Vervielfältigungen, Übersetzungen, Mikroverfilmung und
die Speicherung und Verarbeitung in elektronischen Systemen.
Alle Produktnamen sind eingetragene Warenzeichen der betreffenden Firmen.
Copyright 2003 SEAL Systems, Röttenbach
Änderungen
3
Änderungen
Version
D a tu m
A u t or
Ä nd eru ng
1.0
04.10.96
kb
erstellt
1.1
08.10.96
kb
Erweiterung: Monitoring-Level über Schlüsselworte
einstellbar
1.2
25.02.97
ck
kleinere Korrekturen
1.3
01.02.99
gl
editiert
20.09.00
gl
editiert
Diese
Seite
bleibt
frei!
Inhaltsverzeichnis
5
Inhaltsverzeichnis
1
E in le it u n g ...................................................................................................................................................... 8
2
B e s c h r e ib u n g ................................................................................................................................................. 9
2.1 Aufbau der Protokolldatei .........................................................................................................................9
2.2 Einträge in der Archiv.def...................................................................................................................9
2.2.1
Der Abschnitt [MONITORING]......................................................................................................9
2.2.2
Der Abschnitt [MONITORINGATTRIBUTES]............................................................................10
2.3 Funktionen ...............................................................................................................................................11
2.3.1
Neue Funktionen in Conf.c ............................................................................................................11
2.3.2
Funktionen in Mon.c ......................................................................................................................11
L i t e r a t u r v e r z e i c h n i s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
T a b e l l e n v e r z e i c h n i s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
S t i c h w o r t v e r z e i c h n i s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Diese
Seite
bleibt
frei!
Einleitung
7
1 E in le itu n g
Dieses Dokument beschreibt die in den Archivserver integrierten Monitoringfunktionen. Ziel
der Monitoringfunktionen ist es, dem Kunden eine Protokolldatei zur Verfügung zu stellen, in
der alle Zugriffe auf das Archiv protokolliert werden. Diese Protokolldatei kann so z.B. zu
Abrechnungszwecken benutzt werden.
Für das PLOSSYS@rchiv existiert bereits ein Protokollmechanismus, der alle durchgeführten
Aktionen im Server in der Datei $RARHOME/rarlog/<Kunde>.log protokolliert. Der
Umfang des Protokolls ist abhängig von der Umgebungsvariable RARLOGLEVEL. Hat diese
den Wert 2, dann erfolgt die Ausgabe weiterer Debuginformationen. Es werden bis auf die
identifizierenden Daten alle benötigten Daten ausgegeben. Die Form, in der die Ausgabe
erfolgt, ist für eine einfache Auswertung der Datei durch den Kunden nicht geeignet.
8
Beschreibung
2 B e s c h r e ib u n g
Zur Zeit wird die Monitoring - Funktion durch entsprechende Einträge in der Archiv.def gesteuert. Es ist vorgesehen, die Aktivierung dieser Funktionen durch die Lizenzprüfung vornehmen zu lassen. Die Zeilen der Monitoringdatei haben folgenden Aufbau:
Es werden Datum und Uhrzeit des Zugriffs eingetragen. User und Node werden eingetragen,
wie sie vom Client übergeben wurden. Es folgt die Art des Zugriffs. Bei Suchabfragen wird
die Abfrage, bei allen anderen Zugriffen werden die Werte der vorher bestimmten Attribute
ausgegeben.
2. 1 A u f b a u d e r P r o t o k o l l d a t e i
Die Protokolldatei ist eine Textdatei, die in jeder Zeile einen Archivzugriff protokolliert. Die
Zeile hat folgendes Format:
<Datum Uhrzeit> <Node> <User> <Aktion>(<Suchabfrage> |
(<Attribut> {<Attribut> ...}))
Beispiel:
25.09.1996 16:25:30 SEPPDOS19 KARSTEN SUCHE SNR == “8526899“
oder
25.09.1996 16:25:31 SEPPDOS19 KARSTEN AENDERN 8526899 EZG 2 2
Die Trennung der einzelnen Werte erfolgt durch ein Tabulatorzeichen.
Mögliche Werte für <Aktion> sind:
Suche, Ändern, Löschen, Archivieren, Dearchivieren, Hinzufügen, Entfernen, Ersetzen und
Nachfrage.
2. 2 E i n t r ä g e i n d e r Archiv.def
In der Archiv.def müssen die zwei Abschnitte [MONITORING] und [MONITORINGATTRIBUTES] vorhanden sein.
2. 2. 1
D e r A b s c h n itt [M O N I T O R I N G ]
Der Abschnitt Monitoring steuert die Monitoring-Funktionen. Ist dieser Abschnitt in der
Archiv.def vorhanden, dann wird die Monitoring-Funktion aktiviert. Der Abschnitt
enthält zwei Einträge:
• MONITORINGFILE: Dieser Eintrag bestimmt den Pfad und den Namen der Datei, in der
die Monitoringausgaben erfolgen sollen. Bei der Initialisierung des Monitoring-Moduls
wird geprüft, ob die Datei erstellbar ist. Kann die Datei nicht erstellt werden, dann wird die
Monitoringfunktion ausgeschaltet. Es erfolgt beim Starten des Servers eine entsprechende
Meldung.
Beschreibung
9
• MONITORINGLEVEL: Intern ist der Monitoringlevel eine Zahl, die bestimmt, welche
Aktionen protokolliert werden sollen. Es werden 9 Aktionen unterschieden, jeder dieser
Aktionen ist ein bestimmter Wert zugeordnet. Die Summe dieser Werte bestimmt das
Monitoringlevel.
Folgende Tabelle beschreibt die möglichen Aktionen und deren Werte:
Aktion
Suche
Ändern
Löschen
Archivieren
Dearchivieren
Hinzufügen
Wegnehmen
Ersetzen
Nachfrage
Alle Aktionen
S c h l ü s s e l w or t
SUCHE
AENDERN
LOESCHEN
ARCHIVIEREN
DEARCHIVIEREN
HINZUFUEGEN
WEGNEHMEN
ERSETZEN
NACHFRAGE
ALLES
I nte r ne r W
1
2
4
8
16
32
64
128
256
511
e r t
Tabelle 1: Schlüsselworte und Werte des Monitoringlevels
Soll die Protokollierung aller Aktionen aktiviert werden, so muß der Monitoringlevel den
Wert 511 haben. Soll z.B. die Protokollierung der einzelnen Suchen nicht durchgeführt
werden, so ist der Wert auf 510 zu setzten. Ist der Wert nicht gesetzt oder hat er einen
ungültigen Wert, so wird er automatisch auf den Maximalwert gesetzt.
Extern, also in der Zeile MONITORINGLEVEL der Archiv.def, werden diese Aktionen
durch die Angabe von Schlüsselworten aktiviert (siehe Tabelle 1). Die einzelnen
Schlüsselworte werden durch Leerzeichen getrennt nacheinander aufgelistet. Sollen alle
Aktionen protokolliert werden, so kann statt der gesamten Liste auch nur das Schlüsselwort
„ALLES“ verwendet werden.
2 .2 .2
D e r Ab s c h nitt [ M O N I T O R I N G AT T R I B U T E S ]
Dieser Abschnitt enthält zeilenweise eine Liste mit Bezeichnern der Attribute, deren Werte
bei der Protokollierung mit ausgeben werden sollen. Die Reihenfolge der Attribute bestimmt
die Reihenfolge im Protokoll. Jedes Attribut kann nur einmal genannt werden, die
Schreibweise der Bezeichner muß der aus dem Abschnitt [ATTRIBUTES] entsprechen.
Ungültige Einträge werden in einer Fehlermeldung ausgegeben und ignoriert.
10
Beschreibung
Beispiel
[MONITORING]
MONITORINGFILE
MONITORINGLEVEL
/home/d1/karsten/moni.log
SUCHE AENDERN ARCHIVIEREN
[MONITORINGATTRIBUTES]
SNR
UART
BLATT
UST
2.3 F u n k t i o n e n
Die Funktionen, die das Monitoring durchführen, sind im neuen Modul mon.c und mon.h
enthalten. Die Funktionen, die zum Herauslesen der Konfiguration aus der Archiv.def benötigt
werden, sind im Modul conf.c realisiert.
2.3.1
N e u e F u n k t i o n e n i n C o n f .c
ConfGetMonAttCount liefert die Anzahl der zu protokollierenden Attribute zurück.
ConfGetMonFileName liefert in dem zu übergebenen Pointer auf einem String den
Namen und Pfad der Monitoringdatei zurück.
ConfGetMonAttribList muß ein Pointer auf ein Feld der Größe ATTRIBUTES_MAX
aus Integerwerten der übergeben werden. Jede Position in diesem Feld entspricht
einem möglichen Attributwert, der ausgegeben werden soll. Die Positionen werden mit
„-1“ initialisiert. Soll ein Attribut ausgegeben werden, dann hat die entsprechende
Position einen Wert größer 0. Die Reihenfolge, in der die Attribute ausgegeben werden
sollen, wird durch den Wert an der Position bestimmt. Das zuerst auszugebende
Attribut hat den Wert 1, das nächste 2 usw.
ConfGetMonLevel liefert
Monitoringlevel zurück.
als
Rückgabewert
den
unter
2.2.2
beschriebenen
ConfGetMonEnabled liefert TRUE zurück, wenn die Monitoringfunktion durch Einträge
in der Archiv.def eingeschaltet ist, sonst FALSE.
2.3.2 F u n k t i o n e n i n M o n .c
MonInit initialisiert das Monitoringmodul. Diese Funktion liefert als Rückgabewert TRUE
zurück, wenn die Monitoringfunktion aktiviert ist und die Initialisierung erfolgreich
durchgeführt wurde und FALSE, wenn die Monitoringfunktion nicht aktiviert ist oder
bei der Initialisierung Probleme auftraten. Es wird geprüft, ob die in der Archiv.def
angegebene Monitoringdatei erzeugt oder auf sie schreibend zugegriffen werden kann.
Weiter wird der Monitoringlevel geprüft. Falls dieser einen nicht gültigen Wert hat,
wird er auf den Maximalwert gesetzt.
Beschreibung
11
MonClose schließt das Monitoringmodul, gibt evtl. allozierte Speicherbereiche frei usw..
MonWriteQuery protokolliert eine Suchabfrage in der Datei. Es müssen Zeiger auf den
Knoten, den User und auf die Abfrage übergeben werden. Datum und Uhrzeit werden
von der Funktion hinzugefügt.
MonWrite protokolliert einen Archivzugriff in der Datei. Es müssen Zeiger auf den Knoten,
den User, auf die Aktion und auf ein Feld mit den Attributwerten übergeben werden.
Datum und Uhrzeit werden von der Funktion hinzugefügt. Es werden die Attribute
entsprechend der Attributliste protokolliert (siehe auch ConfGetMonAttribList).
12
Literaturverzeichnis
Literaturverzeichnis
[1] PLOSSYS n e t d o m e , Benutzerhandbuch, SEAL Systems
[2] PLOSSYS I n t e g r i e r t e K o n s o l e , Benutzerdokumentation, SEAL Systems
[3] Pl o t t e r ü b e r w a c h u n g V C ON , Dokumentation, SEAL Systems
[4] PLOSSYS@ r c h i v , Benutzerhandbuch, SEAL Systems
[5] K u r z d o k u m e n t a t i o n f ü r PA D 3 . 0 , SEAL Systems
[6] I n s t a l l a t i o n s a n l e i t u n g f ü r PA D 3 . 2 . X , SEAL Systems
[7] PA D K o n f i g u r a t i o n s t a b e l l e n , SEAL Systems
[8] D D E C LI - D D E C o m a n d Li n e I n t e r f a c e , PAD, SEAL Systems
[9] PA D Sk r i p t -/ D D E -A n s t e u e r u n g , PAD, SEAL Systems
[10] PLOSSYS/ PA D I n t e g r a t i o n s s c h n i t t s t e l l e n , SEAL Systems
[11] PLOSSYS PC / W i n d o w s -I n t e g r a t i o n , SEAL Systems
[12] R a s t e r t o o l s , Kurzbeschreibung, SEAL Systems
[13] K a l i b r i e r u n g s f a k t o r e n , Benutzerdokumentation zur Bedienoberfläche, SEAL Systems
[14] G R I B S-G K S, Benutzerhandbuch, SEAL Systems
[15] G R I B S-G K S-B i l d d a t e i , Benutzerdokumentation, SEAL Systems
[16] G R I B S-G K S-Z e i c h e n s a t z p a k e t , SEAL Systems
Tabellenverzeichnis
13
Tabellenverzeichnis
Tabelle 1: Schlüsselworte und Werte des Monitoringlevels.....................................................10
14
Stichwortverzeichnis
Stichwortverzeichnis
A
Archiv.def 8, 9, 10
Attribut 8, 9, 10
Attribute 8, 9, 10
ATTRIBUTES_MAX 10
C
conf.c 10
ConfGetMonAttCount 10
ConfGetMonAttribList 10, 11
ConfGetMonEnabled 10
ConfGetMonFileName 10
ConfGetMonLevel 10
Copyright 2
D
Datum und Uhrzeit 8, 11
K
Knoten 11
M
mon.c 10
mon.h 10
MonClose 11
MonInit 10
Monitoringdatei 8, 10
MONITORINGFILE 8, 10
MONITORINGLEVEL 9, 10
MonWrite 11
MonWriteQuery 11
N
Node 8
R
RARLOGLEVEL 7
S
Schlüsselwort 9
T
Tabulatorzeichen 8
U
User 8, 11
W
Warenzeichen 2