IPS_GetTraces

 array IPS_GetTraces (int $ObjektID) 

Parameterliste

Rückgabewert

Ein Array mit Trace-Einträgen. Die Reihenfolge der Einträge ist nicht garantiert. Jeder Eintrag enthält folgende Informationen als key => value Paare:

Sendertabelle

Beschreibung

Diese Funktion ist nur für den internen Gebrauch vorgesehen und kann sich jederzeit ohne Ankündigung ändern oder entfallen.

Der Kernel zeichnet in Traces auf, was was ausgelöst hat: Jeder Eintrag steht für einen Vorgang – z.B. das Schreiben einer Variable, das dadurch ausgelöste Ereignis, dessen Aktion bzw. Skript, ein RequestAction, einen Timer oder eine Anfrage an den WebServer – und verweist über ParentID auf den Eintrag, der ihn verursacht hat, sowie über ChildIDs auf die Einträge, die er selbst verursacht hat. So entsteht für jede Ursache ein Baum, mit dem sich nachvollziehen lässt, warum sich z.B. eine Variable geändert hat.

Die Funktion liefert alle aufbewahrten Einträge des Objekts ObjektID zusammen mit allen Einträgen ihrer Ursachenketten (Eltern, Großeltern, … bis zum Anfang der Kette). Einträge, die in mehreren Ketten vorkommen, sind nur einmal enthalten. Das Ergebnis ist eine flache Liste; die Baumstruktur lässt sich über TraceID, ParentID und ChildIDs wiederherstellen. Das Ergebnis entspricht somit IPS_GetTraceList für jede ID aus IPS_GetTraceIDList. Für ein Objekt ohne Traces wird ein leeres Array geliefert. Wird als ObjektID 1 übergeben, werden die Ketten aller aufbewahrten Einträge geliefert.

Die Funktion ist für den Abruf über die JSON-RPC Schnittstelle vorgesehen, z.B. für die Anzeige in der Konsole. In PHP-Skripten steht sie nicht zur Verfügung ("This function is not available for PHP") – dort kann das Ergebnis über IPS_GetTraceIDList und IPS_GetTraceList ermittelt werden.

Traces werden nur im Arbeitsspeicher gehalten und gehen bei einem Neustart verloren. Pro Objekt werden die letzten 25 Einträge aufbewahrt, für Einträge ohne Objekt (z.B. WebServer) insgesamt die letzten 1000. Ein älterer Eintrag bleibt so lange erhalten, wie noch ein aufbewahrter Eintrag von ihm abstammt, damit Ketten vollständig bleiben. Beim Löschen eines Objekts werden seine Einträge entfernt. Zeichenketten in Data werden auf 100 Bytes gekürzt und mit "..." markiert.

Ist eine Kette tiefer als 100 Einträge, geht der Kernel von einer Endlosschleife aus (z.B. ein Ereignis, das seine eigene Auslösevariable schreibt) und bricht den Vorgang mit "Insight trace depth exceeded 100. Assuming an endless loop. Aborting. Reverse Chain: …" ab.

Beispiel

$rpc = new JSONRPC("http://user:password@127.0.0.1:3777/api/");
print_r($rpc->IPS_GetTraces(10018));

/* liefert z.B.:
Array
(
    [0] => Array
        (
            [ChildIDs] => Array
            (
            )
            [Data] => Array
            (
                [OldValue] => 0
                [Value] => 5
                [VariableID] => 10018
            )
            [Depth] => 1
            [ExecutionUser] => @admin
            [ObjectID] => 10018
            [ParentID] => 0
            [Sender] => Variable
            [TimeStamp] => 1700000000
            [TraceID] => 1
        )
    [1] => Array
        (
            [ChildIDs] => Array
            (
            )
            [Data] => Array
            (
                [OldValue] => 5
                [Value] => 7
                [VariableID] => 10018
            )
            [Depth] => 1
            [ExecutionUser] => @admin
            [ObjectID] => 10018
            [ParentID] => 0
            [Sender] => Variable
            [TimeStamp] => 1700000000
            [TraceID] => 2
        )
)
*/