Meßschnittstelle  

An der Meßschnittstelle stellt ein Meßobjekt den instrumentierten Anwendungen acht Operationen zur Verfügung, über die z.B. Informationen über den Beginn und das Ende von Transaktionen übermittelt werden können. Es handelt sich um Klassenoperationen, um den einfachen Zugriff aus der gesamten Anwendung heraus zu gestatten. Die Meßschnittstelle ist abhängig von der jeweils verwendeten Programmiersprache. Abbildung  faßt die angebotenen Operationen programmiersprachenunabhängig zusammen.

 

Abbildung:  Spezifikation der Meßschnittstelle

31#31

Der folgende Abschnitt gibt eine detaillierte Beschreibung der einzelnen Operationen und ihrer Parameter:

• startBTA(btaName: String, userName: String, bausteinName: String, bausteinID: OID)
  Aufruf, der den Beginn einer BTA  anzeigt. StartBTA wird unmittelbar nach einer Benutzerinteraktion aufgerufen, die den Beginn einer BTA darstellt.

  Parameter:
  

  • btaName: String

    Eindeutiger Name des Typs der BTA .
    Der Name der BTA wird durch den Anwendungsentwickler  beim Customizing des Eingabebausteins vergeben.

  • userName: String

    Name des Benutzers, der die BTA angestoßen hat.

  • bausteinName: String

    Name des Eingabebausteins, in dem die Benutzerinteraktion stattfand. Der Name des Bausteins wird vom Bausteinentwickler  beim Entwurf des Bausteins festgelegt.

  • bausteinID: OID

    Identifikator der ausführenden Instanz des Bausteins. Dieser kann erst zur Laufzeit dynamisch bestimmt werden.

  Bei Entgegennahme eines startBTA-Aufrufs generiert das Meßobjekt einen eindeutigen Identifikator für die BTA und bestimmt die aktuelle Zeit sowie den aktuellen Kontrollfluß. Die Zuordnung von BTA zu Kontrollfluß wird festgehalten. Die ermittelten sowie die übergebenen Informationen werden gemeinsam abgespeichert.

• stopBTA(status: String, info: String)
  Aufruf, der den Zeitpunkt der Präsentation des Ergebnisses einer BTA anzeigt. StopBTA wird unmittelbar vor der Benutzerinteraktion aufgerufen, die das Ergebnis der BTA  dem Benutzer präsentiert.

  Parameter:

  • status: String

    Gibt an, ob die BTA  erfolgreich oder nicht erfolgreich abgeschlossen wurde. Erfolgreiche Bearbeitung wird durch Success, nicht erfolgreiche durch Failure repräsentiert. Läßt sich der Erfolg der Bearbeitung nicht angegeben, so ist unknown zu übergeben.

  • info: String
    Zur Übergabe beliebiger weiterer Information z.B. hinsichtlich Fehlerursache etc.
  Das Meßobjekt muß bei Aufruf von stopBTA anhand des Kontrollflusses die Zuordnung zu einer BTA herstellen. Der aktuelle Zeitpunkt sowie der übergebene Wert für den Erfolg der BTA wird gespeichert. Im Falle mehrerer Aufrufe von stopBTA innerhalb derselben BTA ist der letzte Aufruf als der korrekte Zeitpunkt der Ergebnispräsentation zu betrachten. Dies ist bereits im Meßobjekt möglich, da, wie in Abschnitt  beschrieben, davon auszugehen ist, daß alle Aufrufe von stopBTA auf demselben System erfolgen.
• startTA(bausteinName: String, bausteinID: OID, parentTA: UUID=0)
  Aufruf, um den Beginn einer Subtransaktion  anzuzeigen. Wird unmittelbar vor Aufruf einer Operation eines Bausteins aufgerufen.

  Parameter:

  • bausteinName: String

    Name des aufgerufenen Bausteins.
    Der Name des Bausteins wird vom Bausteinentwickler beim Entwurf des Bausteins festgelegt. Zum Zeitpunkt der Anwendungserstellung ist der Name des aufgerufenen Bausteins bereits bekannt und kann automatisch von der Entwicklungsumgebung  eingefügt werden.

  • bausteinID: OID

    Identifikator der ausführenden Instanz des aufgerufenen Bausteins. Dieser kann erst zur Laufzeit dynamisch bestimmt werden.

  • parentTA: UUID=0

    Optionaler Parameter, der einen eindeutigen Identifikator der übergeordneten Transaktion enthält. Im Falle aktiv er Bausteine sowie Kommunikation über Prozeßgrenzen in Verbindung mit dem initiatedTA-Aufruf verwendet, um eine korrekte Zuordnung zu gestatten.

  Beim Aufruf von startTA wird vom Meßobjekt anhand des aktuellen Kontrollflusses die Zuordnung zu einer BTA hergestellt. Die aktuelle Zeit sowie die übergebenen Informationen werden abgespeichert.
• stopTA(status: String, info: String)
  Aufruf, um das Ende einer Subtransaktion  anzuzeigen. Wird unmittelbar nach Rückkehr des Aufrufs einer Operation eines Bausteins aufgerufen.

  Parameter:

  • status: String

    Gibt an, ob die Subtransaktion erfolgreich beendet wurde oder nicht.
    Erfolgreiche Bearbeitung wird durch Success, nicht erfolgreiche durch Failure repräsentiert. Läßt sich der Erfolg der Bearbeitung nicht angegeben, so ist unknown zu übergeben.

  • info: String
    Zur Übergabe beliebiger weiterer Information z.B. hinsichtlich Fehlerursache etc.

  Bei Aufruf von stopTA wird vom Meßobjekt anhand des aktuellen Kontrollflusses die Zuordnung zu einer BTA hergestellt. Der aktuelle Zeitpunkt sowie die Information über Erfolg bzw. Mißerfolg der Subtransaktion werden gespeichert.
• addControlFlow(newControlFlow: ThreadID, target: OID)
  Aufruf, um dem Meßobjekt anzuzeigen, daß ein weiterer Kontrollfluß an der Erbringung einer BTA  beteiligt ist.

  Parameter:

  • newControlFlow: ThreadID

    Identifikator des neuen Kontrollflusses, der an der Erbringung der BTA  beteiligt wird.

  • target: OID
    Identifikator des Bausteins, der im zu starteten Kontrollfluß ausgeführt werden soll.

  Bei Aufruf von addControlFlow stellt das Meßobjekt die Zuordnung des neuen Kontrollflusses zur im aktuellen Kontrollfluß ausgeführten BTA her. Der aktuelle Zeitpunkt wird als der Beginn einer neuen Subtransaktion gespeichert. Dies kann (muß aber nicht) durch einen internen Aufruf von startTA erfolgen.
• removeControlFlow(status: String, reason: String)

  Aufruf, um dem Meßobjekt anzuzeigen, daß ein Kontrollfluß nicht weiter an der Erbringung einer BTA  beteiligt ist.

  Parameter:

  • status: String
    Gibt an, ob das Verlassen der Bearbeitung ein erfolgreiches oder nicht erfolgreiches Ende einer Subtransaktion darstellt.
    Erfolgreiche Bearbeitung wird durch Success, nicht erfolgreiche durch Failure repräsentiert. Läßt sich der Erfolg der Bearbeitung nicht angegeben, so ist unknown zu übergeben.
  • reason: String
    Grund für das Verlassen der Bearbeitung der BTA (beliebiger Text). Beispiele hierfür sind Ende des Kontrollflusses oder Rückkehr zur Oberfläche.

  Bei Aufruf von removeControlFlow löst das Meßobjekt die Zuordnung des aktuellen Kontrollflusses zur aktuellen BTA. Der aktuelle Zeitpunkt wird als das Ende einer Subtransaktion gespeichert. Dies kann (muß aber nicht) durch einen internen Aufruf von stopTA erfolgen.

• initiatedTA(isAsynchronous: Boolean):UUID
  Aufruf, um dem Meßobjekt anzuzeigen, daß eine Transaktion angestoßen wurde, die in einem nicht automatisch korrelierbaren Kontrollfluß ausgeführt wird. Wird beispielsweise bei der Instrumentierung von aktiv en Bausteinen oder bei der Kommunikation über Prozeß- und Systemgrenzen verwendet.

  Parameter:

  • isAsynchronous: Boolean

    Gibt an, ob die Transaktion synchron oder asynchron angestoßen wurde.

  Rückgabewert:
  • UUID

    Ein global eindeutiger Identifikator.

  Bei Aufruf von initiatedTA wird ein global eindeutiger Identifikator generiert und zurückgebeben. Dieser wird gemeinsam mit dem aktuellen Zeitpunkt sowie der Information über synchronen oder asynchronen Anstoß der Transaktion gespeichert, um eine spätere Zuordnung von startTA-Aufrufen mit demselben Identifikator zu ermöglichen.

• logInfo(info: String)
  Aufruf zur Übergabe beliebiger Log-Information eines Bausteins an das Managementsystem.

  Parameter:

  • info
    Freier Text, der vom Bausteinentwickler festgelegt werden kann.
  Beim Aufruf von logInfo bestimmt das Meßobjekt anhand des aktuellen Kontrollflusses die aktuelle BTA und speichert den übergebenen String gemeinsam mit dem aktuellen Zeitpunkt ab.