CompositeTracer

Aggregates all tracers from component references under a single component. It allows to record traces and conveniently send them to multiple destinations.

Implements: ITracer, IReferenceable

Description

The CompositeTracer class allows you to aggregate all tracers from component references under a single component.

References

  • *:tracer:*:*:1.0 - (optional) ITracer components to pass operation tracessource

Constructors

Creates a new instance of the tracer.

CompositeTracer([IReferences? references])

  • references: IReferences? - references to locate the component dependencies.

Fields

_tracers

List of tracers

_tracers: List<ITracer>

Instance methods

beginTrace

Begings recording an operation trace

@override

TraceTiming beginTrace(String? correlationId, String component, String operation)

  • correlationId: String? - (optional) transaction id to trace execution through call chain.
  • component: String - name of the called component
  • operation: String - name of the executed operation.
  • return: TraceTiming - a trace timing object.

failure

Records an operation failure with its name, duration and error

@override

void failure(String? correlationId, String component, String operation, Exception error, int duration)

  • correlationId: String? - (optional) transaction id to trace execution through call chain.
  • component: String - name of the called component
  • operation: String - name of the executed operation.
  • error: Exception - an error object associated with this trace.
  • duration: int - execution duration in milliseconds.

setReferences

Sets references to dependent components.

@override

void setReferences(IReferences references)

  • references: IReferences - references to locate the component dependencies.

trace

Records an operation trace with its name and duration

void trace(String? correlationId, String component, String operation, int duration)

  • correlationId: String? - (optional) transaction id to trace execution through call chain.
  • component: String - a name of called component
  • operation: String - a name of the executed operation.
  • duration: int - execution duration in milliseconds.

Examples

class MyComponent implements IReferenceable {
    var _tracer = CompositeTracer();
    void setReferences(IReferences references) {
        _tracer.setReferences(references);
        ...
    }
    void myMethod(String correlatonId) {
        var timing = _tracer.beginTrace(correlationId, "mycomponent", "mymethod");
        try {
            ...
            timing.endTrace();
        } catch (err) {
            timing.endFailure(err);
        }
    }
}

See also