Skip to content

MetricState

25 exports Added in v2.0.0 Source

Constructors

counter

Added in v2.0.0 Source

Signature

declare const counter: {
  (count: number): Counter<number>;
  (count: bigint): Counter<bigint>;
};

frequency

Added in v2.0.0 Source

Signature

declare const frequency: (occurrences: ReadonlyMap<string, number>) => MetricState.Frequency;

gauge

Added in v2.0.0 Source

Signature

declare const gauge: {
  (count: number): Gauge<number>;
  (count: bigint): Gauge<bigint>;
};

histogram

Added in v2.0.0 Source

Signature

declare const histogram: (options: {
  readonly buckets: ReadonlyArray<readonly [number, number]>;
  readonly count: number;
  readonly max: number;
  readonly min: number;
  readonly sum: number;
}) => MetricState.Histogram;

summary

Added in v2.0.0 Source

Signature

declare const summary: (options: {
  readonly count: number;
  readonly error: number;
  readonly max: number;
  readonly min: number;
  readonly quantiles: ReadonlyArray<readonly [number, Option.Option<number>]>;
  readonly sum: number;
}) => MetricState.Summary;

Models

MetricState interface

Added in v2.0.0 Source

A MetricState describes the state of a metric. The type parameter of a metric state corresponds to the type of the metric key (MetricStateType). This phantom type parameter is used to tie keys to their expected states.

Signature

interface MetricState<in A> extends Variance<A>, Equal, Pipeable {}

Other

MetricState

Added in v2.0.0 Source

Refinements

Signature

declare const isCounterState: (u: unknown) => u is MetricState.Counter<number | bigint>;

Signature

declare const isFrequencyState: (u: unknown) => u is MetricState.Frequency;

isGaugeState

Added in v2.0.0 Source

Signature

declare const isGaugeState: (u: unknown) => u is MetricState.Gauge<number | bigint>;

Signature

declare const isHistogramState: (u: unknown) => u is MetricState.Histogram;

Signature

declare const isMetricState: (u: unknown) => u is MetricState.Counter<number | bigint>;

Signature

declare const isSummaryState: (u: unknown) => u is MetricState.Summary;

Symbols

Signature

declare const CounterStateTypeId: unique symbol;

CounterStateTypeId type

Added in v2.0.0 Source

Signature

type CounterStateTypeId = typeof CounterStateTypeId;

Signature

declare const FrequencyStateTypeId: unique symbol;

FrequencyStateTypeId type

Added in v2.0.0 Source

Signature

type FrequencyStateTypeId = typeof FrequencyStateTypeId;

Signature

declare const GaugeStateTypeId: unique symbol;

GaugeStateTypeId type

Added in v2.0.0 Source

Signature

type GaugeStateTypeId = typeof GaugeStateTypeId;

Signature

declare const HistogramStateTypeId: unique symbol;

HistogramStateTypeId type

Added in v2.0.0 Source

Signature

type HistogramStateTypeId = typeof HistogramStateTypeId;

Signature

declare const MetricStateTypeId: unique symbol;

MetricStateTypeId type

Added in v2.0.0 Source

Signature

type MetricStateTypeId = typeof MetricStateTypeId;

Signature

declare const SummaryStateTypeId: unique symbol;

SummaryStateTypeId type

Added in v2.0.0 Source

Signature

type SummaryStateTypeId = typeof SummaryStateTypeId;