Adapter für Echtzeitüberwachung von Anwendungen konfigurieren

Der generische Protokolladapter stellt eine Klasse Outputter bereit, mit der von Ihrem Adapter generierte CBE-Objekte an einen Protokollagenten gesendet werden können. Log and Trace Analyzer kann mit dem Protokollagenten verbunden werden, um das Anwendungsprotokoll in Echtzeit zu überwachen und zu analysieren.

Voraussetzungen:

Führen Sie folgende Schritte aus, um Ihren Adapter für die Überwachung zu konfigurieren:

Die Outputter-Komponente konfigurieren

Hinweis: Beim Erstellen einer neuen Adapterkonfigurationsdatei wird diese 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 Outputter-Komponente in der Adapterkonfigurationsdatei muss für die Verwendung der Klasse CBELogOutputter aktualisiert werden, die die CBE-Objekte in einen Protokollagenten schreibt. Sie können entweder die vorhandene Outputter-Komponente aktualisieren oder eine neue Outputter-Komponente hinzufügen.

Gehen Sie wie folgt vor, um eine neue Outputter-Komponente hinzuzufügen:

  1. Wählen Sie zum Bearbeiten der Adapterkonfigurationsdatei diese Datei im Navigatorfenster aus. Klicken Sie mit der rechten Maustaste, und wählen Sie Öffnen mit > Editor für Adapterkonfiguration aus. Die Datei wird im Editor geöffnet.
  2. Erweitern Sie im Fenster Adapterkonfigurationseditor den Knoten Adapter > Konfiguration > Ausführungskontext.
  3. Klicken Sie mit der rechten Maustaste auf das Kontextexemplar, und wählen Sie Hinzufügen > Outputter aus. In dem Kontextexemplar wird ein neuer Outputter erstellt.
  4. Wählen Sie im Feld Outputter-Typ die Option LoggingAgentOutputter aus.
  5. Klicken Sie auf die Eigenschaft agentName. Die Details der Eigenschaft werden im rechten Teilfenster angezeigt.
  6. Aktualisieren Sie den Wert der Eigenschaft mit dem Namen des gewünschten Protokollagenten. Dies ist der Name, der in Log and Trace Analyzer als zu überwachender Protokollagent angezeigt wird.
  7. Wenn der Outputter mit dem Schreiben der CBEs in den Protokollagenten warten soll, müssen Sie die Eigenschaft waitUntilLoggingTime hinzufügen und für ihren Wert eine Zeit in Millisekunden festlegen. Klicken Sie zum Hinzufügen der Eigenschaft mit der rechten Maustaste auf den neu erstellten Outputter, und wählen Sie Hinzufügen > Eigenschaft aus. Unter dem neuen Outputter-Knoten wird eine neue Eigenschaft erstellt.
  8. Zum Aktivieren der Klasse CBELogOutputter müssen Sie die zugeordnete Outputter-Komponente in der Basiskontextimplementierung des Kontexts erstellen. Öffnen Sie Kontexte > Kontext für Basisimplementierung.
  9. Klicken Sie mit der rechten Maustaste auf Kontext für Basisimplementierung, und wählen Sie Hinzufügen > Komponente aus. Dem Kontext wird eine neue Komponente hinzugefügt.
  10. Konfigurieren Sie die neue Komponente mit den folgenden Werten:
    Name: Der Name des Outputters in dem Kontext. Beispiel: Logging Agent Outputter
    Beschreibung: Die Beschreibung der Funktion des Outputters.
    Ausführbare Klasse: org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter
    Protokollebene: Die Ebene der internen Protokollierung, die die Outputter-Komponente verwenden sollte. Diese Ebene basiert auf den Schweregradwerten von CommonBaseEvent. Je höher die Zahl, desto höher ist der Schweregrad der Nachricht. Die für die Protokollebene angegebene Zahl bewirkt, dass nur interne Outputter-Nachrichten mit diesem Schweregrad und darüber von der Outputter-Komponente protokolliert werden. Der Wert 71 oder höher bedeutet, dass keine internen Outputter-Nachrichten protokolliert werden. Der Wert 0 bedeutet, dass der Outputter interne Outputter-Nachrichten aller Schweregrade protokolliert. Der empfohlene Wert ist 50. Das bedeutet, dass nur kritische und schwerwiegende interne Outputter-Fehlernachrichten protokolliert werden.
    Aufgabenbereich: Outputter
    Eindeutige ID: Muss auf den im Kontextexemplar in Schritt 3 definierten Outputter verweisen. Wählen Sie mit Hilfe der Schaltfläche Durchsuchen die korrekte ID aus.
  11. Speichern Sie die Änderungen der Adapterkonfigurationsdatei.

Das Kontextexemplar konfigurieren

Wenn der Protokollparser die Protokolldatei ununterbrochen überwachen soll, müssen Sie die Eigenschaften des Kontextexemplars der Adapterkonfigurationsdatei für den Dauerbetrieb aktualisieren.

  1. Wählen Sie zum Bearbeiten der Adapterkonfigurationsdatei diese Datei in der Perspektive Navigator aus. Klicken Sie mit der rechten Maustaste, und wählen Sie Öffnen mit > Editor für Adapterkonfiguration aus. Die Datei wird im Editor geöffnet.
  2. Wählen Sie im Editierfenster Adapter > Konfiguration > Ausführungskontext aus. Die Details des Kontextexemplars werden im rechten Teilfenster angezeigt.
  3. Wählen Sie das Markierungsfeld Fortlaufende Operation aus.
  4. Konfigurieren Sie die Felder Maximale Leerlaufzeit und Anhalteintervall wie erforderlich.
  5. Speichern Sie die Änderungen der Adapterkonfigurationsdatei.

Einen Java-Prozess zur Ausführung des Adapters starten

Der von Ihnen erstellte Protokolladapter kann extern über eine Stapeldatei (in einer Windows-Umgebung) oder über eine Shellprozedur (in einer Nicht-Windows-Umgebung) ausgeführt werden. Nachstehend finden Sie Beispieldateien, mit denen Sie den Java-Prozess starten können, der Ihren Protokolladapter ausführt.
Hinweis: Damit der mit dem generischen Protokolladapter erstellte Protokollagent verbunden und überwacht werden kann, muss Agent Controller auf dem System installiert sein, auf dem der generische Protokolladapter ausgeführt werden soll, und vor dem generischen Protokolladapter gestartet werden.

Windows-Stapeldatei:

@rem VERWENDUNG: runregex
@rem ZWECK: Veranschaulicht das Leistungsspektrum der GLA-Laufzeit mit Hilfe einer Beispieladapterdatei und einer Beispielprotokolldatei.
@rem ANWEISUNGEN: Ändern Sie bei der Ausführung in einer GLA-Laufzeitumgebung den Wert der Umgebungsvariablen %GLA_HOME% in den absoluten Pfad der dekomprimierten GLA-Laufzeit.
@rem HINWEIS: Erstellen Sie bei der Ausführung in einem Plug-in (z. B. Eclipse) ein temporäres Arbeitsverzeichnis, und ändern Sie den Wert der Umgebungsvariablen %GLA_HOME% in den
@rem          absoluten Pfad des neuen temporären Arbeitsverzeichnisses. Erstellen Sie außerdem das Verzeichnis %GLA_HOME%\config, und kopieren Sie den Inhalt des Plug-ins org.eclipse.hyades.logging.adapter.config
@rem          in das neue Verzeichnis %GLA_HOME%\config. Erstellen Sie abschließend das Verzeichnis %GLA_HOME%\lib, und kopieren Sie folgende JAR-Dateien in das neue Verzeichnis %GLA_HOME%\lib:
@rem                    Plug-in                 |     JAR-Datei
@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 MY_DIRECTORY=MyAdapter
SET CONFIG_FILE=%GLA_HOME%\config\%MY_DIRECTORY%\myadapter.adapter
PUSHD %GLA_HOME%\config\%MY_DIRECTORY%\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_example.sh
# ZWECK: Veranschaulicht das Leistungsspektrum der GLA-Laufzeit mit Hilfe einer Beispieladapterdatei und einer Beispielprotokolldatei.
# ANWEISUNGEN: Ändern Sie bei der Ausführung in einer GLA-Laufzeitumgebung den Wert der Umgebungsvariablen $GLA_HOME in den absoluten Pfad der dekomprimierten GLA-Laufzeit.
# HINWEIS: Erstellen Sie bei der Ausführung in einem Plug-in (z. B. Eclipse) ein temporäres Arbeitsverzeichnis, und ändern Sie den Wert der Umgebungsvariablen $GLA_HOME in den
#          absoluten Pfad des neuen temporären Arbeitsverzeichnisses. Erstellen Sie außerdem das Verzeichnis $GLA_HOME/config, und kopieren Sie den Inhalt des Plug-ins com.ibm.etools.logging.adapter.config
#          in das neue Verzeichnis $GLA_HOME/config. Erstellen Sie abschließend das Verzeichnis $GLA_HOME/lib, und kopieren Sie folgende JAR-Dateien in das neue Verzeichnis $GLA_HOME/lib:
# Plug-in | JAR-Datei
# ---------------------------------------------------
# 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

YOUR_DIRECTORY=MY_DIRECTORY
export MY_DIRECTORY

CONFIG_FILE="$GLA_HOME/config/$MY_DIRECTORY/myadapter.adapter"
export CONFIG_FILE

CUR_DIR=`pwd`
export CUR_DIR

cd "$GLA_HOME/config/$MY_DIRECTORY

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 so, dass der Java-Prozess gestartet werden kann, der Ihren Protokolladapter ausführt.

Das Anwendungsprotokoll in Echtzeit überwachen

Jetzt sind Sie für die Überwachung des Anwendungsprotokolls in Echtzeit bereit.

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

      Aktiviertes Markierungsfeld 'Protokollierung aktivieren' im Teilfenster mit den Benutzervorgaben für die Profilermittlung und Protokollierung

    4. Wählen Sie OK aus, um die Änderungen zu übernehmen.
  2. Klicken Sie in der Funktionsleiste der Perspektive Profilermittlung und Protokollierung auf Profilermittlung Symbol des Profilermittlungstools, und wählen Sie Profil aus. Der Assistent für Profile wird geöffnet.
  3. Wählen Sie Zuordnen - Java-Prozess aus, und klicken Sie unten in der Liste auf die Schaltfläche Neu. Eine neue Java-Prozesskonfiguration wird erstellt.
  4. Klicken Sie auf die Registerkarte Hosts, und wählen Sie den Host aus, auf dem sich das Anwendungsprotokoll befindet. Verschieben Sie ihn dazu mit der Pfeiltaste in das Teilfenster Ausgewählte Agenten.
    Hinweis: Damit Agent Controller ein Anwendungsprotokoll in Echtzeit überwachen kann, muss das Produkt auf demselben System ausgeführt werden wie die Anwendung.
  5. Klicken Sie auf die Registerkarte Agenten, und wählen Sie den konfigurierten Protokollagenten mit den Pfeiltasten aus.

    Im Assistenten mit den Benutzervorgaben für die Profilermittlung befindet sich der vom Benutzer erstellte Protokollagent im linken Teilfenster

  6. Klicken Sie auf Anwenden.
  7. Klicken Sie auf Profil, um eine Verbindung zum Protokollagenten herzustellen.
  8. Wählen Sie in der Sicht Profilermittlung - Überwachung der Perspektive Profilermittlung und Protokollierung den Protokollagenten aus.
  9. Klicken Sie mit der rechten Maustaste auf den Protokollagenten, und wählen Sie Überwachung starten aus.
  10. Klicken Sie mit der rechten Maustaste auf den Protokollagenten, und wählen Sie Öffnen mit > Sicht 'Protokoll' aus. Die Protokollereignisse werden aus dem Anwendungsprotokoll in die Sicht Protokoll geladen.

 

Zugehörige Konzepte
Generischer Hyades-Protokolladapter: Übersicht
Spezifikation des Common Base Event-Formats

Zugehörige Tasks
Einen Protokollparser erstellen

Zugehörige Verweise
Struktur der Adapterkonfigurationsdatei
Adapterkonfigurationseditor
Grammatik regulärer Ausdrücke