Tracer
Annotations
DisablePropagation
Added in v3.12.0
Source
Signature
declare const DisablePropagation: Reference<DisablePropagation, boolean>;DisablePropagation interface
Added in v3.12.0
Source
Signature
interface DisablePropagation {
readonly _: typeof _;
}Constructors
externalSpan
Added in v2.0.0
Source
Signature
declare const externalSpan: (options: {
readonly context?: Context.Context<never>;
readonly sampled?: boolean;
readonly spanId: string;
readonly traceId: string;
}) => ExternalSpan;Signature
declare const make: (options: Omit<Tracer, typeof TracerTypeId>) => Tracer;tracerWith
Added in v2.0.0
Source
Signature
declare const tracerWith: <A, E, R>(
f: (tracer: Tracer) => Effect.Effect<A, E, R>,
) => Effect.Effect<A, E, R>;Models
Signature
type AnySpan = Span | ExternalSpan;ExternalSpan interface
Added in v2.0.0
Source
Signature
interface ExternalSpan {
readonly _tag: "ExternalSpan";
readonly context: Context<never>;
readonly sampled: boolean;
readonly spanId: string;
readonly traceId: string;
}Signature
interface Span {
readonly _tag: "Span";
readonly attributes: ReadonlyMap<string, unknown>;
readonly context: Context<never>;
readonly kind: SpanKind;
readonly links: readonly Array<SpanLink>;
readonly name: string;
readonly parent: Option<AnySpan>;
readonly sampled: boolean;
readonly spanId: string;
readonly status: SpanStatus;
readonly traceId: string;
addLinks(links: readonly Array<SpanLink>): void;
attribute(key: string, value: unknown): void;
end(endTime: bigint, exit: Exit<unknown, unknown>): void;
event(name: string, startTime: bigint, attributes?: Record<string, unknown>): void;
}Signature
type SpanKind = "internal" | "server" | "client" | "producer" | "consumer";Signature
interface SpanLink {
readonly _tag: "SpanLink";
readonly attributes: Readonly<Record<string, unknown>>;
readonly span: AnySpan;
}SpanOptions interface
Added in v3.1.0
Source
Signature
interface SpanOptions {
readonly attributes?: Record<string, unknown>;
readonly captureStackTrace?: boolean | LazyArg<string | undefined>;
readonly context?: Context<never>;
readonly kind?: SpanKind;
readonly links?: readonly Array<SpanLink>;
readonly parent?: AnySpan;
readonly root?: boolean;
}SpanStatus type
Added in v2.0.0
Source
Signature
type SpanStatus =
| {
_tag: "Started";
startTime: bigint;
}
| {
_tag: "Ended";
endTime: bigint;
exit: Exit.Exit<unknown, unknown>;
startTime: bigint;
};Other
Signature
interface Tracer {
readonly [TracerTypeId]: typeof TracerTypeId;
context<X>(f: () => X, fiber: RuntimeFiber<any, any>): X;
span(name: string, parent: Option<AnySpan>, context: Context<never>, links: readonly Array<SpanLink>, startTime: bigint, kind: SpanKind, options?: SpanOptions): Span;
}TracerTypeId
Added in v2.0.0
Source
Signature
declare const TracerTypeId: unique symbol;TracerTypeId type
Added in v2.0.0
Source
Signature
type TracerTypeId = typeof TracerTypeId;