Skip to main content

%Trace.Span

class %Trace.Span extends %Trace.AbstractSpan

Tracks and manages a Trace Span object. Spans MUST be created by calling Tracer:StartSpan()

Property Inventory

Method Inventory

Properties

property IsRecording as %Boolean [ InitialExpression = 1 ];
Value which indicates if the Span is "recording", i.e. any data related to the Span wil be recorded. This is set to 1 when the Span is created (StartSpan) and 0 when span.End() is called.
Property methods: IsRecordingDisplayToLogical(), IsRecordingGet(), IsRecordingIsValid(), IsRecordingLogicalToDisplay(), IsRecordingNormalize(), IsRecordingSet()

Methods

method AddEvent(name As %String, timestamp As %String, attributes As %String)
Add an Event related to this Span. Pass 'attributes' by reference as an array(key, value). 'timestamp' is in $ZTS format, and will be set to current $ZTS if left null.
Add a Link for another Span. Pass 'attributes' by reference as an array(key, value)
method End(EndTime As %String = $zts)
End and record Span. EndTime is optional, in $ZTS format (defaults to current time).
method SetStatus(status As %String)
Update the Status of the Span. Only 'Unset', 'Ok', 'Error' allowed.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab