Skip to content

Domain

36 exports Added in v1.0.0 Source

Schemas

Counter

Added in v1.0.0 Source

Signature

declare const Counter: Struct<{
  readonly _tag: Literal<"Counter">;
  readonly description: any;
  readonly name: String;
  state: any;
  readonly tags: $Array<
    Struct<{
      readonly key: String;
      readonly value: String;
    }>
  >;
}>;

ExternalSpan

Added in v1.0.0 Source

Signature

declare const ExternalSpan: Struct<{
  readonly _tag: Literal<"ExternalSpan">;
  readonly sampled: Boolean;
  readonly spanId: String;
  readonly traceId: String;
}>;

ExternalSpan interface

Added in v1.0.0 Source

Signature

interface ExternalSpan extends Type<typeof ExternalSpan> {}

ExternalSpanFrom interface

Added in v1.0.0 Source

Signature

interface ExternalSpanFrom extends Encoded<
  Struct<{
    readonly _tag: Literal<"ExternalSpan">;
    readonly sampled: Boolean;
    readonly spanId: String;
    readonly traceId: String;
  }>
> {}

Frequency

Added in v1.0.0 Source

Signature

declare const Frequency: Struct<{
  readonly _tag: Literal<"Frequency">;
  readonly description: any;
  readonly name: String;
  state: any;
  readonly tags: $Array<
    Struct<{
      readonly key: String;
      readonly value: String;
    }>
  >;
}>;

Gauge

Added in v1.0.0 Source

Signature

declare const Gauge: Struct<{
  readonly _tag: Literal<"Gauge">;
  readonly description: any;
  readonly name: String;
  state: any;
  readonly tags: $Array<
    Struct<{
      readonly key: String;
      readonly value: String;
    }>
  >;
}>;

Histogram

Added in v1.0.0 Source

Signature

declare const Histogram: Struct<{
  readonly _tag: Literal<"Histogram">;
  readonly description: any;
  readonly name: String;
  state: any;
  readonly tags: $Array<
    Struct<{
      readonly key: String;
      readonly value: String;
    }>
  >;
}>;

metric

Added in v1.0.0 Source

Signature

declare function metric<Tag extends string, S, IS, R>(
  tag: Tag,
  state: any,
): Struct<{
  readonly _tag: Literal<Tag>;
  readonly description: any;
  readonly name: String;
  state: any;
  readonly tags: $Array<
    Struct<{
      readonly key: String;
      readonly value: String;
    }>
  >;
}>;

Metric

Added in v1.0.0 Source

Signature

declare const Metric: Union<readonly Array<Constraint>>

Metric type

Added in v1.0.0 Source

Signature

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

MetricFrom type

Added in v1.0.0 Source

Signature

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

MetricLabel

Added in v1.0.0 Source

Signature

declare const MetricLabel: Struct<{
  readonly key: String;
  readonly value: String;
}>;

Signature

declare const MetricsRequest: Struct<{
  readonly _tag: Literal<"MetricsRequest">;
}>;

Signature

declare const MetricsSnapshot: Struct<{
  readonly _tag: Literal<"MetricsSnapshot">;
  readonly metrics: $Array<Union<readonly Array<Constraint>>>;
}>

MetricsSnapshot type

Added in v1.0.0 Source

Signature

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

MetricsSnapshotFrom type

Added in v1.0.0 Source

Signature

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

ParentSpan

Added in v1.0.0 Source

Signature

declare const ParentSpan: Union<any>;

ParentSpan type

Added in v1.0.0 Source

Signature

type ParentSpan = Span | ExternalSpan;

ParentSpanFrom type

Added in v1.0.0 Source

Signature

type ParentSpanFrom = SpanFrom | ExternalSpanFrom;

Ping

Added in v1.0.0 Source

Signature

declare const Ping: Struct<{
  readonly _tag: Literal<"Ping">;
}>;

Pong

Added in v1.0.0 Source

Signature

declare const Pong: Struct<{
  readonly _tag: Literal<"Pong">;
}>;

Request

Added in v1.0.0 Source

Signature

declare const Request: Union<readonly Array<Constraint>>

Request

Added in v1.0.0 Source

Request type

Added in v1.0.0 Source

Signature

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

Response

Added in v1.0.0 Source

Signature

declare const Response: Union<readonly Array<Constraint>>

Response

Added in v1.0.0 Source

Response type

Added in v1.0.0 Source

Signature

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

Span

Added in v1.0.0 Source

Signature

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

Span interface

Added in v1.0.0 Source

Signature

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

SpanEvent

Added in v1.0.0 Source

Signature

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

SpanEvent interface

Added in v1.0.0 Source

Signature

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

SpanFrom interface

Added in v1.0.0 Source

Signature

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

SpanStatus

Added in v1.0.0 Source

Signature

declare const SpanStatus: Union<readonly Array<Constraint>>

Signature

declare const SpanStatusEnded: Struct<{
  readonly _tag: Literal<"Ended">;
  readonly endTime: BigInt;
  readonly startTime: BigInt;
}>;

Signature

declare const SpanStatusStarted: Struct<{
  readonly _tag: Literal<"Started">;
  readonly startTime: BigInt;
}>;

Summary

Added in v1.0.0 Source

Signature

declare const Summary: Struct<{
  readonly _tag: Literal<"Summary">;
  readonly description: any;
  readonly name: String;
  state: any;
  readonly tags: $Array<
    Struct<{
      readonly key: String;
      readonly value: String;
    }>
  >;
}>;