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): OpenCensusSpanWrapper

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:350
Wraps an existing OpenCensus Span

Parameters
- span: OpenCensusSpan
  
  A Span or RootSpan from OpenCensus
Returns OpenCensusSpanWrapper
- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:355
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
Returns OpenCensusSpanWrapper

Methods

addEvent

addEvent(name: string, attributes?: Attributes): this

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:389
Adds an event to the Span

Parameters
- name: string
  
  The name of the event
- Optional attributes: Attributes
  
  The associated attributes to add for this event
Returns this

addLink

addLink(spanContext: SpanContext, attributes?: Attributes): this

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:395
Adds a link to the Span.

Parameters
- spanContext: SpanContext
  
  the context of the linked span
- Optional attributes: Attributes
  
  attributes to be added that are associated with the link
Returns this

context

context(): SpanContext

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:372
Returns the SpanContext associated with this Span.

Returns SpanContext

end

end(_endTime?: undefined | number): void

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:368
Marks the end of Span execution.

Parameters
- Optional _endTime: undefined | number
Returns void

getWrappedSpan

getWrappedSpan(): OpenCensusSpan

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:350
The underlying OpenCensus Span

Returns OpenCensusSpan

isRecordingEvents

isRecordingEvents(): boolean

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:409
Returns whether this span will be recorded

Returns boolean

setAttribute

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

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:378
Sets an attribute on the Span

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

setAttributes

setAttributes(attributes: Attributes): this

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:383
Sets attributes on the Span

Parameters
- attributes: Attributes
  
  the attributes to add
Returns this

setStatus

setStatus(status: Status): this

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:400
Sets a status on the span. Overrides the default of CanonicalCode.OK.

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

updateName

updateName(name: string): this

- Defined in home/vsts/work/1/s/sdk/core/core-tracing/types/core-tracing.d.ts:405
Updates the name of the Span

Parameters
- name: string
  
  the new Span name
Returns this

Generated using TypeDoc