%Trace.AbstractSpan

abstract class %Trace.AbstractSpan extends %Library.RegisteredObject

Tracks and manages a Trace Span object.

Property Inventory

Attributes
Context
EndTime
Events
IsRecording
Links
Name
Parent
SpanKind
StartTime
Status

Method Inventory

AddEvent()
AddLink()
End()
SetStatus()

Properties

property Attributes as array of %String;

Additional attributes (key-value pairs) to help describe the Span.

Property methods: AttributesBuildValueArray(), AttributesCollectionToDisplay(), AttributesCollectionToOdbc(), AttributesDisplayToCollection(), AttributesDisplayToLogical(), AttributesGet(), AttributesGetObject(), AttributesGetObjectId(), AttributesGetSwizzled(), AttributesIsValid(), AttributesLogicalToDisplay(), AttributesLogicalToOdbc(), AttributesNormalize(), AttributesOdbcToCollection(), AttributesSet(), AttributesSetObject(), AttributesSetObjectId()

property Context as %Trace.SpanContext;

Set by IRIS, uniquely identifies the Span

Property methods: ContextGet(), ContextGetSwizzled(), ContextIsValid(), ContextNewObject(), ContextSet()

property EndTime as %String;

End time of Span (in $ZTS format).

Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeLogicalToOdbc(), EndTimeNormalize(), EndTimeSet()

property Events as list of %Trace.SpanEvent;

Events related to this Span

Property methods: EventsBuildValueArray(), EventsCollectionToDisplay(), EventsCollectionToOdbc(), EventsDisplayToCollection(), EventsGet(), EventsGetObject(), EventsGetObjectId(), EventsGetSwizzled(), EventsIsValid(), EventsOdbcToCollection(), EventsSet(), EventsSetObject(), EventsSetObjectId()

property IsRecording as %Boolean [ InitialExpression = 0 ];

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()

property Links as list of %Trace.SpanLink;

Links to other Spans

Property methods: LinksBuildValueArray(), LinksCollectionToDisplay(), LinksCollectionToOdbc(), LinksDisplayToCollection(), LinksGet(), LinksGetObject(), LinksGetObjectId(), LinksGetSwizzled(), LinksIsValid(), LinksOdbcToCollection(), LinksSet(), LinksSetObject(), LinksSetObjectId()

property Name as %String;

The span name, e.g. web service endpoint or function name

Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

property Parent as %Trace.SpanContext;

Parent span, null for root span

Property methods: ParentGet(), ParentGetSwizzled(), ParentIsValid(), ParentNewObject(), ParentSet()

property SpanKind as %String (VALUELIST = "Internal, Server, Client, Producer, Consumer") [ InitialExpression = "Internal" ];

Values: Internal (default), Server, Client, Producer, Consumer Describes the relationship between the Span, its parents, and its children in a Trace

Property methods: SpanKindDisplayToLogical(), SpanKindGet(), SpanKindIsValid(), SpanKindLogicalToDisplay(), SpanKindLogicalToOdbc(), SpanKindNormalize(), SpanKindSet()

property StartTime as %String;

Start time of Span (in $ZTS format).

Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeLogicalToOdbc(), StartTimeNormalize(), StartTimeSet()

property Status as %String (VALUELIST = "Unset, Ok, Error") [ InitialExpression = "Unset" ];

Status of Span. Values: Unset (default), Ok, Error.

Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()

Methods

abstract 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.

abstract method AddLink(context As %Trace.SpanContext, attributes As %String)

Add a Link for another Span. Pass 'attributes' by reference as an array(key, value)

abstract method End(EndTime As %String)

End Span.

abstract method SetStatus(status As %String)

Update the Status of the Span. Only 'Unset', 'Ok', 'Error' allowed.

Subclasses

%Trace.Span