Skip to main content Link Search Menu Expand Document (external link)
effect

Tracer.ts overview

Since v1.0.0

Exports Grouped by Category

accessors

currentOtelSpan

Get the current OpenTelemetry span.

Works with both the official OpenTelemetry API (via Tracer.layer, NodeSdk.layer, etc.) and the lightweight OTLP module (OtlpTracer.layer).

When using OTLP, the returned span is a wrapper that conforms to the OpenTelemetry Span interface.

Signature

declare const currentOtelSpan: Effect<Otel.Span, NoSuchElementException, never>

Source

Since v1.0.0

constructors

make

Signature

declare const make: Effect<EffectTracer, never, OtelTracer>

Source

Since v1.0.0

makeExternalSpan

Signature

declare const makeExternalSpan: (options: {
  readonly traceId: string
  readonly spanId: string
  readonly traceFlags?: number | undefined
  readonly traceState?: string | Otel.TraceState | undefined
}) => ExternalSpan

Source

Since v1.0.0

layers

layer

Signature

declare const layer: Layer<OtelTracer, never, OtelTracerProvider | Resource>

Source

Since v1.0.0

layerGlobal

Signature

declare const layerGlobal: Layer<OtelTracer, never, Resource>

Source

Since v1.0.0

layerGlobalTracer

Signature

declare const layerGlobalTracer: Layer<OtelTracer, never, Resource>

Source

Since v1.0.0

layerTracer

Signature

declare const layerTracer: Layer<OtelTracer, never, OtelTracerProvider | Resource>

Source

Since v1.0.0

layerWithoutOtelTracer

Signature

declare const layerWithoutOtelTracer: Layer<never, never, OtelTracer>

Source

Since v1.0.0

propagation

withSpanContext

Set the effect’s parent span from the given opentelemetry SpanContext.

This is handy when you set up OpenTelemetry outside of Effect and want to attach to a parent span.

Signature

declare const withSpanContext: {
  (spanContext: Otel.SpanContext): <A, E, R>(effect: Effect<A, E, R>) => Effect<A, E, Exclude<R, ParentSpan>>
  <A, E, R>(effect: Effect<A, E, R>, spanContext: Otel.SpanContext): Effect<A, E, Exclude<R, ParentSpan>>
}

Source

Since v1.0.0

tags

OtelTraceFlags

Signature

declare const OtelTraceFlags: Tag<OtelTraceFlags, Otel.TraceFlags>

Source

Since v1.0.0

OtelTraceFlags (interface)

Signature

export interface OtelTraceFlags {
  readonly _: unique symbol
}

Source

Since v1.0.0

OtelTraceState

Signature

declare const OtelTraceState: Tag<OtelTraceState, Otel.TraceState>

Source

Since v1.0.0

OtelTraceState (interface)

Signature

export interface OtelTraceState {
  readonly _: unique symbol
}

Source

Since v1.0.0

OtelTracer

Signature

declare const OtelTracer: Tag<OtelTracer, Otel.Tracer>

Source

Since v1.0.0

OtelTracer (interface)

Signature

export interface OtelTracer {
  readonly _: unique symbol
}

Source

Since v1.0.0

OtelTracerProvider

Signature

declare const OtelTracerProvider: Tag<OtelTracerProvider, Otel.TracerProvider>

Source

Since v1.0.0

OtelTracerProvider (interface)

Signature

export interface OtelTracerProvider {
  readonly _: unique symbol
}

Source

Since v1.0.0