Class OpenCensusSpanWrapper

Package version

An implementation of OpenTelemetry Span that wraps an OpenCensus Span.

Hierarchy

OpenCensusSpanWrapper

Implements

Span

Index

Constructors

constructor

Methods

Constructors

constructor

new OpenCensusSpanWrapper(span: OpenCensusSpan): OpenCensusSpanWrapper
new OpenCensusSpanWrapper(tracer: OpenCensusTracerWrapper, name: string, options?: SpanOptions, context?: OTContext): OpenCensusSpanWrapper

- Defined in tracers/opencensus/openCensusSpanWrapper.ts:57
Wraps an existing OpenCensus Span

Parameters
- span: OpenCensusSpan
  
  A Span or RootSpan from OpenCensus
Returns OpenCensusSpanWrapper
- Defined in tracers/opencensus/openCensusSpanWrapper.ts:63
Create a new OpenCensus Span and wrap it.

Parameters
- tracer: OpenCensusTracerWrapper
  
  The OpenCensus tracer that has been wrapped in OpenCensusTracerWrapper
- name: string
  
  The name of the Span
- Optional options: SpanOptions
  
  Options for the Span
- Optional context: OTContext
  
  The context for the Span.
Returns OpenCensusSpanWrapper

Methods

addEvent

addEvent(_name: string, _attributes?: SpanAttributes): this

- Defined in tracers/opencensus/openCensusSpanWrapper.ts:154
Adds an event to the Span

Parameters
- _name: string
- Optional _attributes: SpanAttributes
Returns this

context

context(): SpanContext

Implementation of Span.context
- Defined in tracers/opencensus/openCensusSpanWrapper.ts:119
Returns the SpanContext associated with this Span.

Returns SpanContext

end

end(_endTime?: undefined | number): void

- Defined in tracers/opencensus/openCensusSpanWrapper.ts:112
Marks the end of Span execution.

Parameters
- Optional _endTime: undefined | number
Returns void

getWrappedSpan

getWrappedSpan(): OpenCensusSpan

- Defined in tracers/opencensus/openCensusSpanWrapper.ts:55
The underlying OpenCensus Span

Returns OpenCensusSpan

isRecording

isRecording(): boolean

Implementation of Span.isRecording
- Defined in tracers/opencensus/openCensusSpanWrapper.ts:192
Returns whether this span will be recorded

Returns boolean

recordException

recordException(_exception: Exception, _time?: TimeInput): void

Implementation of Span.recordException
- Defined in tracers/opencensus/openCensusSpanWrapper.ts:203
Sets exception as a span event

Parameters
- _exception: Exception
- Optional _time: TimeInput
Returns void

setAttribute

setAttribute(key: string, value: unknown): this

- Defined in tracers/opencensus/openCensusSpanWrapper.ts:135
Sets an attribute on the Span

Parameters
- key: string
  
  The attribute key
- value: unknown
  
  The attribute value
Returns this

setAttributes

setAttributes(attributes: SpanAttributes): this

Implementation of Span.setAttributes
- Defined in tracers/opencensus/openCensusSpanWrapper.ts:144
Sets attributes on the Span

Parameters
- attributes: SpanAttributes
  
  The attributes to add
Returns this

setStatus

setStatus(status: SpanStatus): this

Implementation of Span.setStatus
- Defined in tracers/opencensus/openCensusSpanWrapper.ts:162
Sets a status on the span. Overrides the default of SpanStatusCode.OK.

Parameters
- status: SpanStatus
  
  The status to set.
Returns this

updateName

updateName(name: string): this

Implementation of Span.updateName
- Defined in tracers/opencensus/openCensusSpanWrapper.ts:184
Updates the name of the Span

Parameters
- name: string
  
  The new Span name
Returns this

Generated using TypeDoc