Class TraceAgent

TraceAgent exposes a number of methods to create trace spans and propagate trace context across asynchronous boundaries.

Hierarchy

TraceAgent

Implements

TraceAgent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TraceAgent(name: string): TraceAgent

- Defined in trace-api.ts:67
Constructs a new TraceAgent instance.

Parameters
- name: string
  
  A string identifying this TraceAgent instance in logs.
Returns TraceAgent

Properties

constants

constants: object = Constants

Type declaration

labels

labels: object = TraceLabels

Type declaration

policy

policy: TracePolicy | null = null

spanTypes

spanTypes: SpanType = SpanType

Methods

createChildSpan

createChildSpan(options?: SpanOptions): Span

Implementation of TraceAgent.createChildSpan
- Defined in trace-api.ts:206
Parameters
- Optional options: SpanOptions
Returns Span

Private disable

disable(): void

- Defined in trace-api.ts:99
Disable this instance. This function is only for internal use and unit tests.

Returns void

Private enable

enable(config: TraceAgentConfig, logger: Logger): void

- Defined in trace-api.ts:87
Enables this instance. This function is only for internal use and unit tests. A separate TraceWriter instance should be initialized beforehand.

Parameters
- config: TraceAgentConfig
  
  An object specifying how this instance should be configured.
- logger: Logger
  
  A logger object.
Returns void

enhancedDatabaseReportingEnabled

enhancedDatabaseReportingEnabled(): boolean

Implementation of TraceAgent.enhancedDatabaseReportingEnabled
- Defined in trace-api.ts:118
Returns boolean

getCurrentContextId

getCurrentContextId(): string | null

Implementation of TraceAgent.getCurrentContextId
- Defined in trace-api.ts:181
Returns string | null

getCurrentRootSpan

getCurrentRootSpan(): RootSpan

Implementation of TraceAgent.getCurrentRootSpan
- Defined in trace-api.ts:174
Returns RootSpan

getProjectId

getProjectId(): Promise<string>

Implementation of TraceAgent.getProjectId
- Defined in trace-api.ts:188
Returns Promise<string>

getResponseTraceContext

getResponseTraceContext(incomingTraceContext: string | null, isTraced: boolean): string

Implementation of TraceAgent.getResponseTraceContext
- Defined in trace-api.ts:253
Parameters
- incomingTraceContext: string | null
- isTraced: boolean
Returns string

getWriterProjectId

getWriterProjectId(): string | null

Implementation of TraceAgent.getWriterProjectId
- Defined in trace-api.ts:197
Returns string | null

Private isActive

isActive(): boolean

- Defined in trace-api.ts:114
Returns whether the TraceAgent instance is active. This function is only for internal use and unit tests; under normal circumstances it will always return true.

Returns boolean

isRealSpan

isRealSpan(span: Span): boolean

Implementation of TraceAgent.isRealSpan
- Defined in trace-api.ts:249
Parameters
- span: Span
Returns boolean

runInRootSpan

runInRootSpan<T>(options: RootSpanOptions, fn: function): T

- Defined in trace-api.ts:122
Type parameters
- T
Parameters
- options: RootSpanOptions
- fn: function
  - - (span: RootSpan): T
    - Parameters
      - span: RootSpan
      Returns T
Returns T

wrap

wrap<T>(fn: Func<T>): Func<T>

Implementation of TraceAgent.wrap
- Defined in trace-api.ts:267
Type parameters
- T
Parameters
- fn: Func<T>
Returns Func<T>

wrapEmitter

wrapEmitter(emitter: EventEmitter): void

Implementation of TraceAgent.wrapEmitter
- Defined in trace-api.ts:275
Parameters
- emitter: EventEmitter
Returns void

Generated using TypeDoc