Timing object returned by ITracer.begin_trace to end the timing of an execution block and record the associated trace.
Description
The TraceTiming class is used to create the timing object returned by ITracer.begin_trace to end the timing of and execution block and record the associated trace.
Constructors
Creates a new instance of the timing callback object.
TraceTiming(IContext context, String component, String operation, ITracer tracer)
- context: IContext - (optional) a context to trace execution through a call chain.
- component: String - an associated component name
- operation: String - an associated operation name
- tracer: ITracer - a callback that shall be called when endTiming is called.
Instance methods
endFailure
Ends timing of a failed block, calculates elapsed time and records the associated trace.
void endFailure(Exception error)
- error: Exception - an error object associated with this trace.
endTrace
Ends timing of an execution block, calculates the elapsed time and records the associated trace.
endTrace()
Examples
{@code
TraceTiming timing = tracer.beginTrace("mymethod.exec_time");
try {
...
timing.endTrace();
} catch (Exception err) {
timing.endFailure(err);
}
}