Class TestSpan

Package version

A mock span useful for testing.

Hierarchy

NoOpSpan
- TestSpan

Implements

Span

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TestSpan(parentTracer: Tracer, name: string, context: SpanContext, kind: SpanKind, parentSpanId?: undefined | string, startTime?: TimeInput): TestSpan

- Defined in tracers/test/testSpan.ts:56
Starts a new Span.

Parameters
- parentTracer: Tracer
- name: string
  
  The name of the span.
- context: SpanContext
  
  The SpanContext this span belongs to
- kind: SpanKind
  
  The SpanKind of this Span
- Optional parentSpanId: undefined | string
  
  The identifier of the parent Span
- Default value startTime: TimeInput = Date.now()
  
  The startTime of the event (defaults to now)
Returns TestSpan

Properties

attributes

attributes: SpanAttributes

Known attributes, if any.

endCalled

endCalled: boolean

True if end() has been called on the Span

kind

The Span's kind

name

name: string

The Span's current name

Optional parentSpanId

parentSpanId: undefined | string

The id of the parent Span, if any.

startTime

startTime: TimeInput

The start time of the Span

status

status: SpanStatus

The Span's current status

Methods

addEvent

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

Inherited from NoOpSpan.addEvent
- Defined in tracers/noop/noOpSpan.ts:60
Adds an event to the Span

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

context

context(): SpanContext

Implementation of Span.context

Overrides NoOpSpan.context
- Defined in tracers/test/testSpan.ts:99
Returns the SpanContext associated with this Span.

Returns SpanContext

end

end(_endTime?: undefined | number): void

Overrides NoOpSpan.end
- Defined in tracers/test/testSpan.ts:108
Marks the end of Span execution.

Parameters
- Optional _endTime: undefined | number
  
  The time to use as the Span's end time. Defaults to the current time.
Returns void

isRecording

isRecording(): boolean

Implementation of Span.isRecording

Overrides NoOpSpan.isRecording
- Defined in tracers/test/testSpan.ts:124
Returns whether this span will be recorded

Returns boolean

recordException

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

Implementation of Span.recordException

Inherited from NoOpSpan.recordException
- Defined in tracers/noop/noOpSpan.ts:93
Sets exception as a span event

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

setAttribute

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

Implementation of Span.setAttribute

Overrides NoOpSpan.setAttribute
- Defined in tracers/test/testSpan.ts:133
Sets an attribute on the Span

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

setAttributes

setAttributes(attributes: SpanAttributes): this

Implementation of Span.setAttributes

Overrides NoOpSpan.setAttributes
- Defined in tracers/test/testSpan.ts:142
Sets attributes on the Span

Parameters
- attributes: SpanAttributes
  
  The attributes to add
Returns this

setStatus

setStatus(status: SpanStatus): this

Implementation of Span.setStatus

Overrides NoOpSpan.setStatus
- Defined in tracers/test/testSpan.ts:116
Sets a status on the span. Overrides the default of SpanStatusCode.OK.

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

tracer

tracer(): Tracer

- Defined in tracers/test/testSpan.ts:92
Returns the Tracer that created this Span

Returns Tracer

updateName

updateName(_name: string): this

Implementation of Span.updateName

Inherited from NoOpSpan.updateName
- Defined in tracers/noop/noOpSpan.ts:76
Updates the name of the Span

Parameters
- _name: string
  
  the new Span name
Returns this

Generated using TypeDoc