effect 2.0.0-next.44 → 2.0.0-next.46

package/src/MetricBoundaries.ts

@@ -0,0 +1,70 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Chunk from "./Chunk"
+import type * as Equal from "./Equal"
+import * as internal from "./internal/metric/boundaries"
+import type { Pipeable } from "./Pipeable"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const MetricBoundariesTypeId: unique symbol = internal.MetricBoundariesTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type MetricBoundariesTypeId = typeof MetricBoundariesTypeId
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface MetricBoundaries extends Equal.Equal, Pipeable {
+  readonly [MetricBoundariesTypeId]: MetricBoundariesTypeId
+  readonly values: Chunk.Chunk<number>
+}
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isMetricBoundaries: (u: unknown) => u is MetricBoundaries = internal.isMetricBoundaries
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const fromChunk: (chunk: Chunk.Chunk<number>) => MetricBoundaries = internal.fromChunk
+
+/**
+ * A helper method to create histogram bucket boundaries for a histogram
+ * with linear increasing values.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const linear: (
+  options: {
+    readonly start: number
+    readonly width: number
+    readonly count: number
+  }
+) => MetricBoundaries = internal.linear
+
+/**
+ * A helper method to create histogram bucket boundaries for a histogram
+ * with exponentially increasing values.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const exponential: (
+  options: {
+    readonly start: number
+    readonly factor: number
+    readonly count: number
+  }
+) => MetricBoundaries = internal.exponential

package/src/MetricHook.ts

@@ -0,0 +1,139 @@
+/**
+ * @since 2.0.0
+ */
+import type { LazyArg } from "./Function"
+import * as internal from "./internal/metric/hook"
+import type * as MetricKey from "./MetricKey"
+import type * as MetricState from "./MetricState"
+import type { Pipeable } from "./Pipeable"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const MetricHookTypeId: unique symbol = internal.MetricHookTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type MetricHookTypeId = typeof MetricHookTypeId
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface MetricHook<In, Out> extends MetricHook.Variance<In, Out>, Pipeable {
+  readonly get: () => Out
+  readonly update: (input: In) => void
+}
+
+/**
+ * @since 2.0.0
+ */
+export declare namespace MetricHook {
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Root = MetricHook<any, MetricState.MetricState.Untyped>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Untyped = MetricHook<any, any>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Counter<A extends (number | bigint)> = MetricHook<A, MetricState.MetricState.Counter<A>>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Gauge<A extends (number | bigint)> = MetricHook<A, MetricState.MetricState.Gauge<A>>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Frequency = MetricHook<string, MetricState.MetricState.Frequency>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Histogram = MetricHook<number, MetricState.MetricState.Histogram>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Summary = MetricHook<readonly [number, number], MetricState.MetricState.Summary>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export interface Variance<In, Out> {
+    readonly [MetricHookTypeId]: {
+      readonly _In: (_: In) => void
+      readonly _Out: (_: never) => Out
+    }
+  }
+}
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const make: <In, Out>(options: {
+  readonly get: LazyArg<Out>
+  readonly update: (input: In) => void
+}) => MetricHook<In, Out> = internal.make
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const counter: <A extends (number | bigint)>(key: MetricKey.MetricKey.Counter<A>) => MetricHook.Counter<A> =
+  internal.counter
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const frequency: (_key: MetricKey.MetricKey.Frequency) => MetricHook.Frequency = internal.frequency
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const gauge: {
+  (key: MetricKey.MetricKey.Gauge<number>, startAt: number): MetricHook.Gauge<number>
+  (key: MetricKey.MetricKey.Gauge<bigint>, startAt: bigint): MetricHook.Gauge<bigint>
+} = internal.gauge
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const histogram: (key: MetricKey.MetricKey.Histogram) => MetricHook.Histogram = internal.histogram
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const summary: (key: MetricKey.MetricKey.Summary) => MetricHook.Summary = internal.summary
+
+/**
+ * @since 2.0.0
+ * @category utils
+ */
+export const onUpdate: {
+  <In, Out>(f: (input: In) => void): (self: MetricHook<In, Out>) => MetricHook<In, Out>
+  <In, Out>(self: MetricHook<In, Out>, f: (input: In) => void): MetricHook<In, Out>
+} = internal.onUpdate

package/src/MetricKey.ts

@@ -0,0 +1,227 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Chunk from "./Chunk"
+import type * as Duration from "./Duration"
+import type * as Equal from "./Equal"
+import type * as HashSet from "./HashSet"
+import * as internal from "./internal/metric/key"
+import type * as MetricBoundaries from "./MetricBoundaries"
+import type * as MetricKeyType from "./MetricKeyType"
+import type * as MetricLabel from "./MetricLabel"
+import type * as Option from "./Option"
+import type { Pipeable } from "./Pipeable"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const MetricKeyTypeId: unique symbol = internal.MetricKeyTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type MetricKeyTypeId = typeof MetricKeyTypeId
+
+/**
+ * A `MetricKey` is a unique key associated with each metric. The key is based
+ * on a combination of the metric type, the name and tags associated with the
+ * metric, an optional description of the key, and any other information to
+ * describe a metric, such as the boundaries of a histogram. In this way, it is
+ * impossible to ever create different metrics with conflicting keys.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+export interface MetricKey<Type extends MetricKeyType.MetricKeyType<any, any>>
+  extends MetricKey.Variance<Type>, Equal.Equal, Pipeable
+{
+  readonly name: string
+  readonly keyType: Type
+  readonly description: Option.Option<string>
+  readonly tags: HashSet.HashSet<MetricLabel.MetricLabel>
+}
+
+/**
+ * @since 2.0.0
+ */
+export declare namespace MetricKey {
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Untyped = MetricKey<any>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Counter<A extends (number | bigint)> = MetricKey<MetricKeyType.MetricKeyType.Counter<A>>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Gauge<A extends (number | bigint)> = MetricKey<MetricKeyType.MetricKeyType.Gauge<A>>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Frequency = MetricKey<MetricKeyType.MetricKeyType.Frequency>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Histogram = MetricKey<MetricKeyType.MetricKeyType.Histogram>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Summary = MetricKey<MetricKeyType.MetricKeyType.Summary>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export interface Variance<Type> {
+    readonly [MetricKeyTypeId]: {
+      _Type: (_: never) => Type
+    }
+  }
+}
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isMetricKey: (u: unknown) => u is MetricKey<MetricKeyType.MetricKeyType<unknown, unknown>> =
+  internal.isMetricKey
+
+/**
+ * Creates a metric key for a counter, with the specified name.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const counter: {
+  (
+    name: string,
+    options?: {
+      readonly description?: string
+      readonly bigint?: false
+      readonly incremental?: boolean
+    }
+  ): MetricKey.Counter<number>
+  (
+    name: string,
+    options: {
+      readonly description?: string
+      readonly bigint: true
+      readonly incremental?: boolean
+    }
+  ): MetricKey.Counter<bigint>
+} = internal.counter
+
+/**
+ * Creates a metric key for a categorical frequency table, with the specified
+ * name.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const frequency: (name: string, description?: string) => MetricKey.Frequency = internal.frequency
+
+/**
+ * Creates a metric key for a gauge, with the specified name.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const gauge: {
+  (name: string, options?: { readonly description?: string; readonly bigint?: false }): MetricKey.Gauge<number>
+  (name: string, options: { readonly description?: string; readonly bigint: true }): MetricKey.Gauge<bigint>
+} = internal.gauge
+
+/**
+ * Creates a metric key for a histogram, with the specified name and boundaries.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const histogram: (
+  name: string,
+  boundaries: MetricBoundaries.MetricBoundaries,
+  description?: string
+) => MetricKey.Histogram = internal.histogram
+
+/**
+ * Creates a metric key for a summary, with the specified name, maxAge,
+ * maxSize, error, and quantiles.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const summary: (
+  options: {
+    readonly name: string
+    readonly maxAge: Duration.DurationInput
+    readonly maxSize: number
+    readonly error: number
+    readonly quantiles: Chunk.Chunk<number>
+    readonly description?: string
+  }
+) => MetricKey.Summary = internal.summary
+
+/**
+ * Returns a new `MetricKey` with the specified tag appended.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const tagged: {
+  (
+    key: string,
+    value: string
+  ): <Type extends MetricKeyType.MetricKeyType<any, any>>(self: MetricKey<Type>) => MetricKey<Type>
+  <Type extends MetricKeyType.MetricKeyType<any, any>>(
+    self: MetricKey<Type>,
+    key: string,
+    value: string
+  ): MetricKey<Type>
+} = internal.tagged
+
+/**
+ * Returns a new `MetricKey` with the specified tags appended.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const taggedWithLabels: {
+  (
+    extraTags: Iterable<MetricLabel.MetricLabel>
+  ): <Type extends MetricKeyType.MetricKeyType<any, any>>(self: MetricKey<Type>) => MetricKey<Type>
+  <Type extends MetricKeyType.MetricKeyType<any, any>>(
+    self: MetricKey<Type>,
+    extraTags: Iterable<MetricLabel.MetricLabel>
+  ): MetricKey<Type>
+} = internal.taggedWithLabels
+
+/**
+ * Returns a new `MetricKey` with the specified tags appended.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const taggedWithLabelSet: {
+  (
+    extraTags: HashSet.HashSet<MetricLabel.MetricLabel>
+  ): <Type extends MetricKeyType.MetricKeyType<any, any>>(self: MetricKey<Type>) => MetricKey<Type>
+  <Type extends MetricKeyType.MetricKeyType<any, any>>(
+    self: MetricKey<Type>,
+    extraTags: HashSet.HashSet<MetricLabel.MetricLabel>
+  ): MetricKey<Type>
+} = internal.taggedWithLabelSet

package/src/MetricKeyType.ts

@@ -0,0 +1,257 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Chunk from "./Chunk"
+import type * as Duration from "./Duration"
+import type * as Equal from "./Equal"
+import * as internal from "./internal/metric/keyType"
+import type * as MetricBoundaries from "./MetricBoundaries"
+import type * as MetricState from "./MetricState"
+import type { Pipeable } from "./Pipeable"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const MetricKeyTypeTypeId: unique symbol = internal.MetricKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type MetricKeyTypeTypeId = typeof MetricKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const CounterKeyTypeTypeId: unique symbol = internal.CounterKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type CounterKeyTypeTypeId = typeof CounterKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const FrequencyKeyTypeTypeId: unique symbol = internal.FrequencyKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type FrequencyKeyTypeTypeId = typeof FrequencyKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const GaugeKeyTypeTypeId: unique symbol = internal.GaugeKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type GaugeKeyTypeTypeId = typeof GaugeKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const HistogramKeyTypeTypeId: unique symbol = internal.HistogramKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type HistogramKeyTypeTypeId = typeof HistogramKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const SummaryKeyTypeTypeId: unique symbol = internal.SummaryKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type SummaryKeyTypeTypeId = typeof SummaryKeyTypeTypeId
+
+/**
+ * @since 2.0.0
+ * @category modelz
+ */
+export interface MetricKeyType<In, Out> extends MetricKeyType.Variance<In, Out>, Equal.Equal, Pipeable {}
+
+/**
+ * @since 2.0.0
+ */
+export declare namespace MetricKeyType {
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Untyped = MetricKeyType<any, any>
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Counter<A extends (number | bigint)> = MetricKeyType<A, MetricState.MetricState.Counter<A>> & {
+    readonly [CounterKeyTypeTypeId]: CounterKeyTypeTypeId
+    readonly incremental: boolean
+    readonly bigint: boolean
+  }
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Frequency = MetricKeyType<string, MetricState.MetricState.Frequency> & {
+    readonly [FrequencyKeyTypeTypeId]: FrequencyKeyTypeTypeId
+  }
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Gauge<A extends (number | bigint)> = MetricKeyType<A, MetricState.MetricState.Gauge<A>> & {
+    readonly [GaugeKeyTypeTypeId]: GaugeKeyTypeTypeId
+    readonly bigint: boolean
+  }
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Histogram = MetricKeyType<number, MetricState.MetricState.Histogram> & {
+    readonly [HistogramKeyTypeTypeId]: HistogramKeyTypeTypeId
+    readonly boundaries: MetricBoundaries.MetricBoundaries
+  }
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type Summary = MetricKeyType<readonly [number, number], MetricState.MetricState.Summary> & {
+    readonly [SummaryKeyTypeTypeId]: SummaryKeyTypeTypeId
+    readonly maxAge: Duration.Duration
+    readonly maxSize: number
+    readonly error: number
+    readonly quantiles: Chunk.Chunk<number>
+  }
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export interface Variance<In, Out> {
+    readonly [MetricKeyTypeTypeId]: {
+      readonly _In: (_: In) => void
+      readonly _Out: (_: never) => Out
+    }
+  }
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type InType<Type extends MetricKeyType<any, any>> = [Type] extends [
+    {
+      readonly [MetricKeyTypeTypeId]: {
+        readonly _In: (_: infer In) => void
+      }
+    }
+  ] ? In
+    : never
+
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export type OutType<Type extends MetricKeyType<any, any>> = [Type] extends [
+    {
+      readonly [MetricKeyTypeTypeId]: {
+        readonly _Out: (_: never) => infer Out
+      }
+    }
+  ] ? Out
+    : never
+}
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const counter: <A extends number | bigint>() => MetricKeyType.Counter<A> = internal.counter
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const frequency: MetricKeyType.Frequency = internal.frequency
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const gauge: <A extends number | bigint>() => MetricKeyType.Gauge<A> = internal.gauge
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const histogram: (boundaries: MetricBoundaries.MetricBoundaries) => MetricKeyType.Histogram = internal.histogram
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const summary: (
+  options: {
+    readonly maxAge: Duration.DurationInput
+    readonly maxSize: number
+    readonly error: number
+    readonly quantiles: Chunk.Chunk<number>
+  }
+) => MetricKeyType.Summary = internal.summary
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isMetricKeyType: (u: unknown) => u is MetricKeyType<unknown, unknown> = internal.isMetricKeyType
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isCounterKey: (u: unknown) => u is MetricKeyType.Counter<number | bigint> = internal.isCounterKey
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isFrequencyKey: (u: unknown) => u is MetricKeyType.Frequency = internal.isFrequencyKey
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isGaugeKey: (u: unknown) => u is MetricKeyType.Gauge<number | bigint> = internal.isGaugeKey
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isHistogramKey: (u: unknown) => u is MetricKeyType.Histogram = internal.isHistogramKey
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isSummaryKey: (u: unknown) => u is MetricKeyType.Summary = internal.isSummaryKey