9 Tracing (Ablaufverfolgung)

Die Abarbeitung im Dialog Manager kann mit Hilfe verschiedener Kommandozeilen-Switches automatisch mitprotokolliert und Fehler erkannt werden.

9.1 Beschreibung des Tracing

Mit Hilfe der Tracing-Einrichtung können Dialog Manager-Anwendungen ausgetestet und Fehler beseitigt werden. Die Trace-Datei beinhaltet alle ausgeführten Regeln, alle aufgerufenen Anwendungsfunktionen und alle aufgerufenen Dialog Manager-Funktionen mit ihren gegenwärtigen Parametern (bitte vergleichen Sie hierzu auch das Handbuch „C-Schnittstelle - Grundlagen“). Des weiteren werden protokolliert:

• Eingebaute Funktionen mit Seiteneffekten (z.B. create)
• Setvalues (immer - nicht nur, wenn ein changed-Ereignis erzeugt worden ist)
• Aufrufe an Format- und Canvas-Funktionen
• DM-Aufrufe in Netzwerk-Anwendungen auf der Server-Seite

Die Datei sieht allgemein wie folgt aus:

[<Abkürzung>]Aktion

In <Aktion> steht die Erklärung dazu, was gerade gemacht wurde.

Die <Abkürzung> steht dafür, was der Dialog Manager gemacht hat. Folgende Codes können hier vorkommen:

9.2 Konfigurierung des Tracing

Bei der Bearbeitung sehr großer Dialoge werden auch die Tracedateien entsprechend groß. Aus diesem Grund kann das Tracing konfiguriert werden. Die Möglichkeit das Tracing an- und auszuschalten (setup.tracing := true/false) ist dabei zusätzlich verfügbar.

Die Konfigurierbarkeit des Tracing ermöglicht es, das Tracing für spezielle Trace-Ereignisse abzustellen. Dies kann z.B. nützlich sein für Schleifen oder andere trace-intensive Regeln bzw. Programmcodes. Sie können die Trace-Ereignisse am Setup-Objekt abstellen. Das Attribut .tracing wird mit einem String indiziert:

setup.tracing["<Abkürzung>"] := false;

Beispiel

setup.tracing["RR"] := false;

Diese Definition stellt alle Rückgabewerte von benannten Regeln ab.

Beim Abstellen bestimmter Trace-Ereignisse – z.B. ["RC"] (Aufruf einer benannten Regel) – können Sie auch einen Gruppierungseffekt erreichen: in dem eben genannten Beispiel werden neben den Aufrufen benannter Regeln auch die Rückgabewerte benannter Regeln unterdrückt. (s. unten Tabelle Spalte Gruppierung.)

Anmerkung

Bitte beachten Sie, dass folgende Trace-Ereignisse nicht abzustellen sind:

• Wichtige Trace-Ereignisse (siehe Tabelle unten, Spalte Abstellbar durch Benutzer.)
• Trace-Ereignisse via DM_TraceMessage

Warnung

Falls Sie die Unterstützung des IDM-Supports benötigen sollten, empfehlen wir Ihnen, nicht zu viele Trace-Messages abzustellen. Ansonsten kann Ihnen eventuell nicht effizient geholfen werden, da aufgrund des Fehlens entscheidender Trace-Messages keine ausreichende Analyse möglich ist.

Im Folgenden finden Sie entsprechende Programmiertipps.

Richtig

variable boolean I_NEED_HELP_FROM_ISA_SUPPORT := true;
...
rule MyCode()
{
  TraceEvent("RC", false);
  ...
}

rule TraceEvent(string TraceTag, boolean Value)
{
  !! Check the global variable for support.
  if ( not I_NEED_HELP_FROM_ISA_SUPPORT ) then
    setup.tracing[TraceTag] := Value;
  endif
}

Falsch

rule MyCode()
{
  !! Do not look for help in your rules without a trace.
  !! Nobody knows which rule was called!
  setup.tracing["RC"] := false;
  ...
}

In der folgenden Tabelle ist zusammengefasst, wie Trace-Ereignisse in der Tracedatei gruppiert und eingerückt werden. Außerdem ist angegeben, ob die Trace-Meldungen vom Benutzer abgestellt werden können. In der Tabelle bedeuten:

• Abkürzung des jeweiligen Trace-Ereignisses – bitte vergleichen Sie dazu das Kapitel „Beschreibung des Tracing“.
• Gruppierung: Trace-Ereignis, welches das in der ersten Spalte stehende Trace-Ereignis mit an- bzw. ausstellt.

• Einrückung:

  =	keine Einrückung
  >	nach rechts
  <	nach links

9.3 Zeitstempel bei der Ablaufverfolgung

Mit Hilfe der Option ‑IDMtracetime <Nr> kann während des Programmablaufes der absolute oder relative Zeitbedarf von Funktionen und Regeln mitprotokolliert werden. Dadurch ist es möglich, Stellen zu identifizieren, die sehr Zeit intensiv sind und daher sich für diese Funktionen oder Regeln entsprechende Tuningmaßnahmen lohnen können.

Es gibt drei Arten der Zeitmessung, die über den Parameter <Nr> eingestellt werden können:

0

Im Tracefile werden keine Zeiten aufgeführt

1

Dieser Wert kennzeichnet den Starttime-Modus. Bei diesem Modus werden alle Start- und Endezeiten mitprotokolliert, der Zeitverbrauch für einen einzelnen Aufbau kann dann aus der Differenz berechnet werden. Dabei wird in diesem Modus ausschließlich die System- und die Benutzerzeit betrachtet.

In diesem Modus erscheinen im Tracefile am Zeilenanfang die Zeiten im Format [hh:mm:ss:uuu]:

• hh = Stunden
• mm = Minuten
• ss = Sekunden
• uuu = Millisekunden

2

Dieser Wert kennzeichnet den Tracetime-Modus. In diesem Modus wird der Zeitunterschied zum letzten mitprotokollierten Aufruf gegeben. In diesem Modus kann also relativ einfach erkannt werden, wie viel Zeit für einzelne Aktionen verbraucht wird.

In diesem Modus erscheinen im Tracefile die Zeitdifferenz zur letzten Trace-Ausgabe im Format [ss:uuu] am Zeilenanfang:

• ss = Sekunden
• uuu = Millisekunden

3

Dieser Wert kennzeichnet den Realtime-Modus. In diesem Fall wird für jede zu protokollierende Aktion die reale Zeit (Uhrzeit) im Tracefile abgelegt.

In diesem Modus erscheinen im Tracefile die Realzeit im Format [hh:mm:ss] am Zeilenanfang:

• hh = Stunden
• mm = Minuten
• ss = Sekunden

9.4 Safety-Tracing

Verfügbarkeit

Der Safety-Modus des Tracing ist in den DM Versionen A.05.01.g3 und A.05.01.h sowie ab A.05.02.e verfügbar.

Das Safety-Tracing ist ein besonderer Modus des Tracefiles. Um das Mitlaufen des Tracefiles auch bei längeren Anwendungssitzungen mit möglichst geringen Performanzeinbußen und Ressourcenverbrauch zu ermöglichen, wird in diesem Modus ein Tracing in einen begrenzten Ringpuffer, der im Speicher gehalten wird, durchgeführt. Hierzu muss statt der Option ‑IDMtracefile <filepath> entweder ‑IDMstracefile <filepath> verwendet werden oder zusätzlich zu ‑IDMtracefile <filepath> der Safety-Modus über ‑IDMstrace eingeschaltet werden.

Bezogen auf den Ringpuffer heißt begrenzt, dass die Zeilenzahl und die Anzahl der Zeichen pro Zeile (ohne Einrückung) beschränkt sind. Außerdem wird eine Kürzung bei der Ausgabe von Stringwerten (typischerweise in "…" gesetzt) vorgenommen und die Stringlänge in [ ] angehängt. Die Begrenzungen können über die Option ‑IDMstraceopts beeinflusst werden. Für die hierarchische Einrückung im Tracefile werden zwei Leerzeichen verwendet. Dies kann nicht durch die Option ‑IDMindent beeinflusst werden. Sind die ausgegebenen Zeilen nicht zusammenhängend, so ist dies durch eine Zwischenzeile mit einem Doppelpunkt kenntlich gemacht. Ein Überschreiten der maximalen Zeilenlänge ist durch eine Tilde (~) am Zeilenende gekennzeichnet.

Der Inhalt des Ringpuffers wird erst beim Beenden der Anwendung in die Trace-Datei geschrieben. Um das Speichern auch bei Abstürzen zu gewährleisten, ist ein aktiver Exception-Catcher (siehe Kapitel „Exception-Catcher“) nötig.

Ein Abschalten des Tracing oder der Ausgabe bestimmter Tracecodes ist beim Safety-Tracing nicht möglich.

Beim Safety-Tracing gelten folgende Begrenzungen: