CompositeTracer

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

NewCompositeTracer

NewCompositeTracer creates a new instance of the tracer.

NewCompositeTracer() *CompositeTracer

NewCompositeTracerFromReferences

Creates a new instance of the tracer.

NewCompositeTracerFromReferences(ctx context.Context, references cref.IReferences) *CompositeTracer

• ctx: context.Context - operation context.
• references: cref.IReferences - references to locate the component dependencies.

Fields

Methods

BeginTrace

Begings recording an operation trace

(c *CompositeTracer) BeginTrace(ctx context.Context, context string, component string, operation string) *TraceTiming

• ctx: context.Context - operation context.
• context: string - (optional) a context to trace execution through a call chain.
• component: string - name of the called component
• operation: string - name of the executed operation.
• return: *TraceTiming - trace timing object.

Failure

Records an operation failure with its name, duration and error

(c *CompositeTracer) Failure(ctx context.Context, context IContext, component string, operation string, err error, duration int64)

• ctx: context.Context - operation context.
• context: IContext - (optional) a context to trace execution through a call chain.
• component: string - name of the called component
• operation: string - name of the executed operation.
• err: error - error object associated with this trace.
• duration: int64 - execution duration in milliseconds.

SetReferences

Sets references to dependent components.

(c *CompositeTracer) SetReferences(ctx context.Context, references cref.IReferences

• ctx: context.Context - operation context.
• references: cref.IReferences - references to locate the component’s dependencies.

Trace

Records an operation trace with its name and duration

(c *CompositeTracer) Trace(ctx context.Context, context IContext, component string, operation string, duration int64)

• ctx: context.Context - operation context.
• context: IContext - (optional) a context to trace execution through a call chain.
• component: string - name of the called component
• operation: string - name of the executed operation.
• duration: int64 - execution duration in milliseconds.

Examples

type MyComponent struct {
	tracer *CompositeTracer
}
func NewMyComponent() *MyComponent{
	return &MyComponent{
		tracer: NewCompositeTracer(nil);
	}
}
func (c* MyComponent) SetReferences(ctx context.Context, references IReferences) {
	c.tracer.SetReferences(references)
	...
}
public MyMethod(ctx context.Context, correlatonId string) {
	timing := c.tracer.BeginTrace(ctx, context, "mycomponent", "mymethod");
	...
	defer timing.EndTrace(ctx);
	if err != nil {
		timing.EndFailure(ctx, err);
	}
}

See also

• ITracer