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

Domain overview

Added in v1.0.0


Table of contents


schemas

Counter

Signature

export declare const Counter: any

Added in v1.0.0

ExternalSpan

Signature

export declare const ExternalSpan: any

Added in v1.0.0

ExternalSpan (interface)

Signature

export interface ExternalSpan extends Schema.Schema.Type<typeof ExternalSpan> {}

Added in v1.0.0

ExternalSpanFrom (interface)

Signature

export interface ExternalSpanFrom extends Schema.Schema.Encoded<typeof ExternalSpan> {}

Added in v1.0.0

Frequency

Signature

export declare const Frequency: any

Added in v1.0.0

Gauge

Signature

export declare const Gauge: any

Added in v1.0.0

Histogram

Signature

export declare const Histogram: any

Added in v1.0.0

Metric

Signature

export declare const Metric: any

Added in v1.0.0

Metric (type alias)

Signature

export type Metric = Schema.Schema.Type<typeof Metric>

Added in v1.0.0

MetricFrom (type alias)

Signature

export type MetricFrom = Schema.Schema.Encoded<typeof Metric>

Added in v1.0.0

MetricLabel

Signature

export declare const MetricLabel: any

Added in v1.0.0

MetricsRequest

Signature

export declare const MetricsRequest: any

Added in v1.0.0

MetricsSnapshot

Signature

export declare const MetricsSnapshot: any

Added in v1.0.0

MetricsSnapshot (type alias)

Signature

export type MetricsSnapshot = Schema.Schema.Type<typeof MetricsSnapshot>

Added in v1.0.0

MetricsSnapshotFrom (type alias)

Signature

export type MetricsSnapshotFrom = Schema.Schema.Encoded<typeof MetricsSnapshot>

Added in v1.0.0

ParentSpan

Signature

export declare const ParentSpan: any

Added in v1.0.0

ParentSpan (type alias)

Signature

export type ParentSpan = Span | ExternalSpan

Added in v1.0.0

ParentSpanFrom (type alias)

Signature

export type ParentSpanFrom = SpanFrom | ExternalSpanFrom

Added in v1.0.0

Ping

Signature

export declare const Ping: any

Added in v1.0.0

Pong

Signature

export declare const Pong: any

Added in v1.0.0

Request

Signature

export declare const Request: any

Added in v1.0.0

Request (type alias)

Signature

export type Request = Schema.Schema.Type<typeof Request>

Added in v1.0.0

Request (namespace)

Added in v1.0.0

WithoutPing (type alias)

Signature

export type WithoutPing = Exclude<Request, { readonly _tag: "Ping" }>

Added in v1.0.0

Response

Signature

export declare const Response: any

Added in v1.0.0

Response (type alias)

Signature

export type Response = Schema.Schema.Type<typeof Response>

Added in v1.0.0

Response (namespace)

Added in v1.0.0

WithoutPong (type alias)

Signature

export type WithoutPong = Exclude<Response, { readonly _tag: "Pong" }>

Added in v1.0.0

Span

Signature

export declare const Span: Schema.Schema<Span, SpanFrom>

Added in v1.0.0

Span (interface)

Signature

export interface Span {
  readonly _tag: "Span"
  readonly spanId: string
  readonly traceId: string
  readonly name: string
  readonly sampled: boolean
  readonly attributes: ReadonlyMap<string, unknown>
  readonly parent: Option<ParentSpan>
  readonly status:
    | {
        readonly _tag: "Started"
        readonly startTime: bigint
      }
    | {
        readonly _tag: "Ended"
        readonly startTime: bigint
        readonly endTime: bigint
      }
}

Added in v1.0.0

SpanEvent

Signature

export declare const SpanEvent: Schema.Schema<
  SpanEvent,
  {
    readonly _tag: "SpanEvent"
    readonly spanId: string
    readonly traceId: string
    readonly name: string
    readonly attributes: { readonly [x: string]: unknown }
    readonly startTime: string
  }
>

Added in v1.0.0

SpanEvent (interface)

Signature

export interface SpanEvent {
  readonly _tag: "SpanEvent"
  readonly spanId: string
  readonly traceId: string
  readonly name: string
  readonly attributes: { readonly [x: string]: unknown }
  readonly startTime: bigint
}

Added in v1.0.0

SpanFrom (interface)

Signature

export interface SpanFrom {
  readonly _tag: "Span"
  readonly spanId: string
  readonly traceId: string
  readonly name: string
  readonly sampled: boolean
  readonly attributes: ReadonlyArray<readonly [string, unknown]>
  readonly parent: Schema.OptionEncoded<ParentSpanFrom>
  readonly status:
    | {
        readonly _tag: "Started"
        readonly startTime: string
      }
    | {
        readonly _tag: "Ended"
        readonly startTime: string
        readonly endTime: string
      }
}

Added in v1.0.0

SpanStatus

Signature

export declare const SpanStatus: any

Added in v1.0.0

SpanStatusEnded

Signature

export declare const SpanStatusEnded: any

Added in v1.0.0

SpanStatusStarted

Signature

export declare const SpanStatusStarted: any

Added in v1.0.0

Summary

Signature

export declare const Summary: any

Added in v1.0.0

metric

Signature

export declare const metric: <Tag extends string, S, IS, R>(tag: Tag, state: Schema.Schema<S, IS, R>) => any

Added in v1.0.0