Interface ITracer

Interface for tracer components that capture operation traces.

Hierarchy

ITracer

Implemented by

Index

Methods

Methods

beginTrace

beginTrace(correlationId: string, component: string, operation: string): TraceTiming

- Defined in trace/ITracer.ts:38
Begings recording an operation trace

Parameters
- 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.
Returns TraceTiming

a trace timing object.

failure

failure(correlationId: string, component: string, operation: string, error: Error, duration: number): void

- Defined in trace/ITracer.ts:28
Records an operation failure with its name, duration and error

Parameters
- 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.
- error: Error
  
  an error object associated with this trace.
- duration: number
  
  execution duration in milliseconds.
Returns void

trace

trace(correlationId: string, component: string, operation: string, duration: number): void

- Defined in trace/ITracer.ts:17
Records an operation trace with its name and duration

Parameters
- 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: number
  
  execution duration in milliseconds.
Returns void

Generated using TypeDoc