Adapter für unmittelbare Anwendungsüberwachung konfigurieren

Der generische Protokolladapter stellt eine Ausgabeprogrammklasse zur Verfügung, die es ermöglicht, die vom Adapter generierten Common Base Event-Objekte an einen Protokollierungsagenten zu senden. Die Protokoll- und Traceanalysefunktion kann dem Protokollierungsagenten zugeordnet werden, um das Anwendungsprotokoll in Echtzeit zu überwachen und zu analysieren.

Voraussetzungen:

Um den Adapter für die Überwachung zu konfigurieren, sind die folgenden Schritte erforderlich:

Ausgabeprogrammkomponente konfigurieren

Hinweis: Eine neu erstellte Adapterkonfigurationsdatei wird standardmäßig für die Verwendung der Klasse 'CBELogOutputter' konfiguriert. Wenn Sie diese Einstellung nicht geändert haben, können Sie diese Prozedur überspringen.

Die Ausgabeprogrammkomponente in der Adapterkonfigurationsdatei muss entsprechend aktualisiert werden, damit sie die Klasse 'CBELogOutputter' verwendet, die die Common Base Event-Objekte an einen Protokollierungsagenten schreibt. Sie können entweder die vorhandene Ausgabeprogrammkomponente aktualisieren oder eine neue Ausgabeprogrammkomponente hinzufügen.

Um eine neue Ausgabeprogrammkomponente hinzuzufügen, gehen Sie wie folgt vor:

  1. Um die Adapterkonfigurationsdatei zu bearbeiten, wählen Sie die Adapterkonfigurationsdatei im Teilfenster 'Navigator' aus. Klicken Sie die rechte Maustaste an und wählen Sie Öffnen mit > Editor für Adapterkonfiguration aus. Die Datei wird dann im Editor geöffnet.
  2. Erweitern Sie im Fenster 'Editor für Adapterkonfiguration' den Knoten Adapter > Konfiguration > Kontextexemplar.
  3. Klicken Sie das Kontextexemplar mit der rechten Maustaste an und wählen Sie Hinzufügen > Ausgabeprogramm aus. Im Kontextexemplar wird dann ein neues Ausgabeprogramm erstellt.
  4. Wählen Sie im Feld Ausgabeprogrammtyp die Option LoggingAgentOutputter aus.
  5. Klicken Sie die Eigenschaft agentName (Agentenname) an. Die Details zu dieser Eigenschaft werden dann im rechten Teilfenster angezeigt.
  6. Aktualisieren Sie den Wert der Eigenschaft mit dem Namen des gewünschten Protokollierungsagenten. Dies ist der Name, der in der Protokoll- und Traceanalysefunktion als zu überwachender Protokollierungsagent angezeigt wird.
  7. Wenn das Ausgabeprogramm warten soll, bevor es Common Base Events an den Protokollagenten schreibt, müssen Sie die Eigenschaft waitUntilLoggingTime hinzufügen und den Wert dieser Eigenschaft auf die gewünschte Zeit in Millisekunden einstellen. Um die Eigenschaft hinzuzufügen, klicken Sie das neu erstellte Ausgabeprogramm mit der rechten Maustaste an und wählen Sie Hinzufügen > Eigenschaft aus. Unterhalb des Knotens 'Ausgabeprogramm' wird eine neue Eigenschaft erstellt.
  8. Um die Klasse 'CBELogOutputter' zu aktivieren, müssen Sie die zugeordnete Ausgabeprogrammkomponente für 'Kontexte: Basiskontextimplementierung' erstellen. Öffnen Sie hierzu entsprechend Kontexte > Kontext: Basiskontextimplementierung.
  9. Klicken Sie Kontext: Basiskontextimplementierung mit der rechten Maustaste an und wählen Sie Hinzufügen > Komponente aus. Dem Kontext wird dann eine neue Komponente hinzugefügt.
  10. Konfigurieren Sie die neue Komponente anhand der folgenden Werte:
    Name: Name des Ausgabeprogramms im Kontext
    Beschreibung: Beschreibung der Funktion dieses Ausgabeprogramms
    Ausführbare Klasse: org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter
    Protokollebene:Die Ebene der internen Protokollierung, die die Ausgabeprogrammkomponente verwenden sollte.
    Ein Wert von 99 bedeutet, dass das Ausgabeprogramm keine Nachrichten protokolliert.
    Ein Wert von 0 bedeutet, dass das Ausgabeprogramm Nachrichten aller Wertigkeiten protokolliert.
    Der empfohlene Wert ist 50 und bedeutet, dass nur kritische oder fatale interne Ausgabeprogrammfehlernachrichten protokolliert werden.
    Berechtigungsklasse: Ausgabeprogramm
    Eindeutige ID: Muss auf das Ausgabeprogramm verweisen, das im Kontextexemplar in Schritt 3 definiert wurde. Verwenden Sie die Schaltfläche Durchsuchen, um die korrekte ID auszuwählen.
  11. Speichern Sie die Änderungen an der Adapterkonfigurationsdatei.

Kontextexemplar konfigurieren

Soll der Protokollparser die Protokolldatei ununterbrochen überwachen, müssen Sie die Eigenschaften des Kontextexemplars in der Adapterkonfigurationsdatei entsprechend für unterbrechungsfreie Operation aktualisieren.

  1. Um die Adapterkonfigurationsdatei zu bearbeiten, wählen Sie die Adapterkonfigurationsdatei in der Perspektive 'Navigator' aus. Klicken Sie die rechte Maustaste an und wählen Sie Öffnen mit > Editor für Adapterkonfiguration aus. Die Datei wird dann im Editor geöffnet.
  2. Wählen Sie im Editierfenster nacheinander die Optionen Adapter > Konfiguration > Kontextexemplar aus. Die Details zum Kontextexemplar werden dann im rechten Teilfenster angezeigt.
  3. Wählen Sie das Markierungsfeld Unterbrechungsfreie Operation aus.
  4. Konfigurieren Sie die Felder 'Maximale Leerlaufzeit' und 'Pausenintervall' entsprechend Ihren Anforderungen.
  5. Speichern Sie die Änderungen an der Adapterkonfigurationsdatei.

Java-Prozess zum Ausführen des Adapters starten

Der von Ihnen erstellte Protokolladapter kann entweder extern über eine Stapeldatei in der Windows-Umgebung oder über ein Shell-Script in Nicht-Windows-Umgebungen ausgeführt werden. Nachstehend finden Sie einige Beispieldateien, die Sie verwenden können, um den Java-Prozess zu starten, der Ihren Protokolladapter ausführt.
Hinweis: Um den vom generischen Protokolladapter erstellten Protokollagenten zuzuordnen und zu überwachen, muss ein Hyades Agent Controller auf dem System installiert werden, auf dem der generische Protokolladapter laufen soll. Er muss vor dem Start des generischen Protokolladapters gestartet werden.

Windows-Stapeldatei:

@rem SYNTAX:  runregex 
@rem ZWECK: Illustriert die funktionalen Leistungsmerkmale der Laufzeit des generischen Protokolladapters (GLA)
@rem Hierfür wird eine Beispielsadapterdatei und eine Beispielsprotokolldatei verwendet.
@rem ANNAHMEN: Diese Stapeldatei nimmt an, dass die GLA-Laufzeit und die benötigten Dateien
@rem in der folgenden Verzeichnisstruktur gespeichert sind:
@rem %GLA_HOME%\config - Konfigurationsdateien des GLA-Adapters
@rem %GLA_HOME%\lib - GLA-Laufzeit und erforderliche JAR-Dateien
@rem %GLA_HOME%\schema - Schemadateien für GLA-Adapterkonfiguration
@rem ANWEISUNGEN:
@rem Wenn die GLA-Laufzeit und die erforderlichen Dateien so wie oben im Abschnitt
@rem Annahmen dargestellt hinterlegt sind, ändern Sie den Wert der Umgebungsvariablen %GLA_HOME%
@rem zum absoluten Pfad der Position, an der die GLA-Laufzeit
@rem und erforderliche Dateien gespeichert sind.
@rem Wenn die Dateien der GLA-Laufzeit in einer Plug-in-Umgebung gespeichert sind (z.B. Eclipse),
@rem befolgen Sie bitte die folgenden Anweisungen:
@rem 1) Erstellen Sie ein temporäres Verzeichnis zur Speicherung der GLA-Laufzeit und der erforderlichen Dateien.
@rem 2) Erstellen Sie die Verzeichnisse config, lib und schema im temporären
@rem Verzeichnis, das in Schritt 1) erstellt wurde
@rem 3) Ändern Sie den Wert der Umgebungsvariable %GLA_HOME% zum
@rem absoluten Pfad des temporären Verzeichnisses, das in Schritt 1) erstellt wurde
@rem 4) Kopieren Sie die Adapterdateien, die Sie ausführen möchten, in das Verzeichnis %GLA_HOME%\config.
@rem Wenn Sie beispielsweise die Apache-Adapterdateien ausführen möchten, dann kopieren Sie das
@rem Apache-Verzeichnis des Plug-ins org.eclipse.hyades.logging.adapter.config
@rem mit all seinen Inhalten in das Verzeichnis %GLA_HOME%\config.
@rem 5) Kopieren Sie die Inhalte des Schemaverzeichnisses des Plug-ins
@rem org.eclipse.hyades.logging.adapter in das Verzeichnis %GLA_HOME%\schema.
@rem 6) Kopieren Sie die folgenden JAR-Dateien in das Verzeichnis %GLA_HOME%\lib
@rem Plug-in | JAR 
@rem --------------------------------------------------- 
@rem org.eclipse.hyades.logging.adapter | hgla.jar 
@rem org.eclipse.hyades.logging.core | hlcbe101.jar 
@rem org.eclipse.hyades.logging.core | hlcore.jar 
@rem org.eclipse.hyades.execution.remote | hexr.jar 
@rem org.eclipse.emf.ecore | ecore.jar 
@rem org.eclipse.emf.common | common.jar 

SET GLA_HOME=d:\GenericLogAdapter 
SET CONFIG_FILE=%GLA_HOME%\config\my.adapter 
@PUSHD %GLA_HOME%\config\ 
java -DGLA_HOME="%GLA_HOME%" -classpath "%GLA_HOME%\lib\hgla.jar;%GLA_HOME%\lib\hexr.jar;%GLA_HOME%\lib\hlcbe101.jar;%GLA_HOME%\lib\ecore.jar;%GLA_HOME%\lib\common.jar;%GLA_HOME%\lib\hlcore.jar" org.eclipse.hyades.logging.adapter.Adapter -ac "%CONFIG_FILE%" -cc "%CONFIG_FILE%" 
POPD


Nicht-Windows-Stapeldatei:
#!/bin/sh 
# VERWENDUNG: runregex.sh
# ZWECK: Illustriert die funktionalen Leistungsmerkmale der Laufzeit des generischen Protokolladapters (GLA)
# Hierfür wird eine Beispielsadapterdatei und eine Beispielsprotokolldatei verwendet.
# ANNAHMEN: Dieses Schalenelement (Shell) nimmt an, dass die GLA-Laufzeit und die benötigten Dateien
# in der folgenden Verzeichnisstruktur gespeichert sind:
# %GLA_HOME%/config - GLA-Adapterkonfigurationsdateien
# %GLA_HOME%/lib - GLA-Laufzeit und erforderliche JAR-Dateien
# %GLA_HOME%/schema - Schemadateien für GLA-Adapterkonfiguration
# ANWEISUNGEN:
# Wenn die GLA-Laufzeit und die erforderlichen Dateien so wie oben im Abschnitt
# Annahmen dargestellt hinterlegt sind, ändern Sie den Wert der Umgebungsvariablen %GLA_HOME%
# zum absoluten Pfad der Position an der die GLA-Laufzeit
# und erforderliche Dateien gespeichert sind.
# Wenn die Dateien der GLA-Laufzeit in einer Plug-in-Umgebung gespeichert sind (z.B. Eclipse),
# befolgen Sie bitte die folgenden Anweisungen:
# 1) Erstellen Sie ein temporäres Verzeichnis zur Speicherung der GLA-Laufzeit und der erforderlichen Dateien.
# 2) Erstellen Sie die Verzeichnisse config, lib und schema im temporären
# Verzeichnis, das in Schritt 1) erstellt wurde
# 3) Ändern Sie den Wert der Umgebungsvariable %GLA_HOME% zum
# absoluten Pfad des temporären Verzeichnisses, das in Schritt 1) erstellt wurde
# 4) Kopieren Sie die Adapterdateien, die Sie ausführen möchten, in das Verzeichnis  %GLA_HOME%/config.
# Wenn Sie beispielsweise die Apache-Adapterdateien ausführen möchten, dann kopieren Sie das
# Apache-Verzeichnis des Plug-ins org.eclipse.hyades.logging.adapter.config
# mit all seinen Inhalten in das Verzeichnis %GLA_HOME%/config.
# 5) Kopieren Sie die Inhalte des Schemaverzeichnisses des Plug-ins
# org.eclipse.hyades.logging.adapter in das Verzeichnis %GLA_HOME%/schema.
# 6) Kopieren Sie die folgenden JAR-Dateien in das Verzeichnis %GLA_HOME%/lib
# Plug-in | JAR 
# --------------------------------------------------- 
# org.eclipse.hyades.logging.adapter | hgla.jar 
# org.eclipse.hyades.logging.core | hlcbe101.jar 
# org.eclipse.hyades.logging.core | hlcore.jar 
# org.eclipse.hyades.execution.remote | hexr.jar 
# org.eclipse.emf.ecore | ecore.jar 
# org.eclipse.emf.common | common.jar 

GLA_HOME=/home/eclipse/GenericLogAdapter 
export GLA_HOME 

CONFIG_FILE="$GLA_HOME/config/my.adapter" 
export KONFIGURATIONSDATEI 

AKTUELLES_VERZEICHNIS=`pwd` 
export AKTUELLES_VERZEICHNIS 

cd "$GLA_HOME/config" 

java -DGLA_HOME="$GLA_HOME" -classpath "$GLA_HOME/lib/hgla.jar:$GLA_HOME/lib/hexr.jar:$GLA_HOME/lib/hlcbe101.jar:$GLA_HOME/lib/ecore.jar:$GLA_HOME/lib/common.jar:$GLA_HOME/lib/hlcore.jar" org.eclipse.hyades.logging.adapter.Adapter -ac "$CONFIG_FILE" -cc "$CONFIG_FILE" 

cd "$CUR_DIR"
Konfigurieren Sie die Datei entsprechend Ihren Anforderungen, um den Java-Prozess zu starten, der Ihren Adapter ausführt.

Anwendungsprotokoll unmittelbar überwachen

Sie können das Anwendungsprotokoll nun unmittelbar überwachen.

  1. Stellen Sie sicher, dass die Protokollierung in den Benutzervorgaben aktiviert ist.
    1. Wählen Sie in der Hauptsymbolleiste die Optionen Fenster > Benutzervorgaben aus. Der Assistent 'Benutzervorgaben' wird geöffnet.
    2. Wählen Sie im linken Teilfenster Profilermittlung und Protokollierung aus. Die Benutzervorgaben für Profilermittlung und Protokollierung werden dann im rechten Teilfenster geladen.
    3. Wählen Sie Protokollierung aktivieren unter den Optionen für Profilermittlung und Protokollierung aus.

      Ausgewähltes Markierungsfeld 'Protokollierung aktivieren' im Teilfenster mit den Benutzervorgaben für Profilermittlung und Protokollierung

    4. Wählen Sie OK aus, um die Änderungen anzuwenden.
  2. Klicken Sie in der Symbolleiste der Perspektive 'Profilermittlung und Protokollierung' auf 'Profilermittlung' Symbol des Profilermittlungstools und wählen Sie Profil aus. Der Profilassistent wird geöffnet.
  3. Wählen Sie Zuordnen - Java-Prozess aus, und klicken Sie anschließend die Schaltfläche Neu am Ende der Liste an. Es wird eine neue Java-Prozesskonfiguration erstellt.
  4. Klicken Sie die Registerkarte Hosts an und wählen Sie den Host aus, auf dem sich das Anwendungsprotokoll befindet.
    Hinweis: Um das Anwendungsprotokoll unmittelbar überwachen zu können, muss der Agent Controller auf demselben System wie die Anwendung aktiv sein.
  5. Klicken Sie die Registerkarte Agenten an, und verwenden Sie die Pfeiltasten, um den von Ihnen konfigurierten Protokollierungsagent auszuwählen.

    Im Assistenten 'Benutzervorgaben für Profilermittlung' befindet sich der vom Benutzer erstellte Protokollierungsagent im linken Teilfenster

  6. Klicken Sie auf Anwenden.
  7. Klicken Sie auf Profil, um die Zuordnung zum Protokollagenten herzustellen.
  8. Wählen Sie in der Perspektive 'Profilermittlung und Protokollierung' der Sicht 'Profilermittlung - Überwachung' den Protokollierungsagenten aus.
  9. Klicken Sie den Agenten mit der rechten Maustaste an und wählen Sie Überwachung starten aus.
  10. Klicken Sie den Agenten mit der rechten Maustaste an und wählen Sie Öffnen mit > Sicht 'Protokoll' aus. Die Protokollereignisse aus dem Anwendungsprotokoll werden in die Sicht 'Protokoll' geladen.
    Hinweis: Wenn in der Sicht 'Protokoll' keine Protokollsätze angezeigt werden, klicken Sie auf die Schaltfläche Ansichten aktualisieren im oberen Teil des Teilfensters 'Profilermittlungsüberwachung'.

 

Verwandte Konzepte
Übersicht über generischen Protokolladapter
Spezifikation des Common Base Event-Formats

Verwandte Tasks
Protokollparser erstellen

Verwandte Verweise
Struktur der Adapterkonfigurationsdatei
Editor für Adapterkonfiguration
Grammatik von regulären Ausdrücken