Interface Span<Context>

Span interface

interface Span<Context = any> {
    addEvent(name: string, attributes?: Attributes): void;
    end(): void;
    recordException(exception: Exception, time?: Time): void;
    setAttribute(key: string, value: AttributeValue): void;
    setAttributes(attributes: Attributes): void;
    setSpanOnContext(ctx: Context): Context;
}

Type Parameters

Context = any

Index

Methods

addEvent end recordException setAttribute setAttributes setSpanOnContext

Methods

addEvent

addEvent(name: string, attributes?: Attributes): void
addEvent adds an event to the span.
Parameters
- name: string
  event name
- Optionalattributes: Attributes
  event attributes
Returns void
- Defined in interfaces/telemetry.ts:127

end

end(): void
end ends the span.

Note: spans must be ended so that they can be exported.

Returns void
- Defined in interfaces/telemetry.ts:142

recordException

recordException(exception: Exception, time?: Time): void
recordException records an exception on the span.
Parameters
- exception: Exception
  exception to record
- Optionaltime: Time
  time to record the exception
Returns void
- Defined in interfaces/telemetry.ts:135

setAttribute

setAttribute(key: string, value: AttributeValue): void
setAttribute sets an attribute on the span.
Parameters
- key: string
  attribute key
- value: AttributeValue
  attribute value
Returns void
- Defined in interfaces/telemetry.ts:112

setAttributes

setAttributes(attributes: Attributes): void
setAttributes sets multiple attributes on the span.
Parameters
- attributes: Attributes
  attributes to set
Returns void
- Defined in interfaces/telemetry.ts:119

setSpanOnContext

setSpanOnContext(ctx: Context): Context
setSpanOnContext sets the span on the context. This is useful when you want to propagate the span across the application.
Parameters
- ctx: Context
  context to set the span on
Returns Context
- the context with the span set on it
- Defined in interfaces/telemetry.ts:104