effect 4.0.1 → 4.0.2

package/src/Metric.ts

@@ -8,6 +8,7 @@
  * histogram boundaries, registry snapshots, text dumps, and controls for
  * enabling runtime metrics.
  *
+ * @stability stable
  * @since 2.0.0
  */
 
@@ -105,6 +106,7 @@ import type { Contravariant, Covariant } from "./Types.ts"
  * ] // => [1, 128, 1]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -183,6 +185,7 @@ export interface Metric<in Input, out State> extends Pipeable {
  * const counts = [result.requests.count, result.bytes.count] // => [6, 1024n]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -243,6 +246,7 @@ export interface Counter<in Input extends number | bigint> extends Metric<Input,
  * const counts = [result.requests.total, result.errors.total, result.bytes.total] // => [3, 3, 1024000n]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -317,6 +321,7 @@ export interface CounterState<in Input extends number | bigint> {
  * const values = [result.statusAnalysis.mostFrequent, result.actionAnalysis.mostFrequent] // => ["200", "login"]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -401,6 +406,7 @@ export interface Frequency extends Metric<string, FrequencyState> {}
  * mostCommon.map(({ key, count }) => [key, count]) // => [["200", 3], ["click", 3]]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -462,6 +468,7 @@ export interface FrequencyState {
  * const values = [result.memory.currentValue, result.disk.currentValue] // => [704, 5000000000n]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -530,6 +537,7 @@ export interface Gauge<in Input extends number | bigint> extends Metric<Input, G
  * values // => [23.1, 5000000000n, 15]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -618,6 +626,7 @@ export interface GaugeState<in Input extends number | bigint> {
  * values // => [4, 445, 118]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -705,6 +714,7 @@ export interface Histogram<Input> extends Metric<Input, HistogramState> {}
  * values // => [5, 50, 750, 1295]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -810,6 +820,7 @@ export interface HistogramState {
  * counts // => [5, 1461, 3]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -892,6 +903,7 @@ export interface Summary<Input> extends Metric<Input, SummaryState> {}
  * values // => [7, 45, 890, 1879]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -945,6 +957,7 @@ export interface SummaryState {
  * const values = [result.counter.count, result.gauge.value] // => [1, 12]
  * ```
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Metric {
@@ -1555,6 +1568,7 @@ export declare namespace Metric {
  * const key = result // => { keyValue: "effect/Metric/CurrentMetricAttributes", keyType: "string", isConstant: true }
  * ```
  *
+ * @stability stable
  * @category constants
  * @since 4.0.0
  */
@@ -1602,6 +1616,7 @@ export const CurrentMetricAttributesKey = "effect/Metric/CurrentMetricAttributes
  * const actual = attributes // => { service: "api", version: "1.0" }
  * ```
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -1614,6 +1629,7 @@ const MetricRegistryKey = "effect/Metric/MetricRegistry"
 /**
  * The registry used to store metric metadata and hooks.
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -1642,6 +1658,7 @@ export type MetricRegistry = Map<string, Metric.Metadata<any, any>>
  * @see {@link snapshot} for reading all registered metrics from the current `Effect` context
  * @see {@link snapshotUnsafe} for reading all registered metrics from an explicit `Context`
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -2017,6 +2034,7 @@ class MetricTransform<in Input, out State, in Input2> extends Metric$<Input2, St
  * Metric.isMetric({ name: "requests" }) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -2077,6 +2095,7 @@ export const isMetric = (u: unknown): u is Metric<never, unknown> =>
  * const counts = [result.requestValue.count, result.eventValue.count, result.bytesValue.count] // => [6, 1, 1024n]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2135,6 +2154,7 @@ export const counter: {
    * const counts = [result.requestValue.count, result.eventValue.count, result.bytesValue.count] // => [6, 1, 1024n]
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 2.0.0
    */
@@ -2201,6 +2221,7 @@ export const counter: {
    * const counts = [result.requestValue.count, result.eventValue.count, result.bytesValue.count] // => [6, 1, 1024n]
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 2.0.0
    */
@@ -2277,6 +2298,7 @@ export const counter: {
  * const values = [result.memoryValue.value, result.cpuValue.value, result.diskValue.value] // => [800, 75, 1024000000n]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2343,6 +2365,7 @@ export const gauge: {
    * const values = [result.memoryValue.value, result.cpuValue.value, result.diskValue.value] // => [800, 75, 1024000000n]
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 2.0.0
    */
@@ -2416,6 +2439,7 @@ export const gauge: {
    * const values = [result.memoryValue.value, result.cpuValue.value, result.diskValue.value] // => [800, 75, 1024000000n]
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 2.0.0
    */
@@ -2507,6 +2531,7 @@ export const gauge: {
  * counts // => [3, 2, 2]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2586,6 +2611,7 @@ export const frequency = (name: string, options?: {
  * values // => [5, 500, 3]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2662,6 +2688,7 @@ export const histogram = (name: string, options: {
  * const payloadValues = [payload.count, payload.min, payload.max, payload.sum] // => [4, 1.2, 15.6, 26]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2714,6 +2741,7 @@ export const summary = (name: string, options: {
  * const metadata = [responseTimesSummary.id, responseTimesSummary.type] // => ["response_times_summary", "Summary"]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -2767,6 +2795,7 @@ export const summaryWithTimestamp = (name: string, options: {
  * ) // => { count: 1, min: 120, max: 120, sum: 120 }
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2827,6 +2856,7 @@ export const timer = (name: string, options?: {
  * ) // => { requestCount: 1, count: 1, min: 750, max: 750, average: 750 }
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -2877,6 +2907,7 @@ export const value = <Input, State>(
  * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [22, 15]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 3.6.5
  */
@@ -2920,6 +2951,7 @@ export const modify: {
    * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [22, 15]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 3.6.5
    */
@@ -2963,6 +2995,7 @@ export const modify: {
    * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [22, 15]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 3.6.5
    */
@@ -3007,6 +3040,7 @@ export const modify: {
    * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [22, 15]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 3.6.5
    */
@@ -3050,6 +3084,7 @@ export const modify: {
    * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [22, 15]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 3.6.5
    */
@@ -3107,6 +3142,7 @@ export const modify: {
  * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [67.8, 2, 3]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -3158,6 +3194,7 @@ export const update: {
    * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [67.8, 2, 3]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -3209,6 +3246,7 @@ export const update: {
    * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [67.8, 2, 3]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -3261,6 +3299,7 @@ export const update: {
    * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [67.8, 2, 3]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -3312,6 +3351,7 @@ export const update: {
    * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => [67.8, 2, 3]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -3352,6 +3392,7 @@ export const update: {
  * const values = [value.count, value.sum] // => [1, 250]
  * ```
  *
+ * @stability stable
  * @category annotations
  * @since 2.0.0
  */
@@ -3386,6 +3427,7 @@ export const mapInput: {
    * const values = [value.count, value.sum] // => [1, 250]
    * ```
    *
+   * @stability stable
    * @category annotations
    * @since 2.0.0
    */
@@ -3420,6 +3462,7 @@ export const mapInput: {
    * const values = [value.count, value.sum] // => [1, 250]
    * ```
    *
+   * @stability stable
    * @category annotations
    * @since 2.0.0
    */
@@ -3458,6 +3501,7 @@ export const mapInput: {
    * const values = [value.count, value.sum] // => [1, 250]
    * ```
    *
+   * @stability stable
    * @category annotations
    * @since 2.0.0
    */
@@ -3492,6 +3536,7 @@ export const mapInput: {
    * const values = [value.count, value.sum] // => [1, 250]
    * ```
    *
+   * @stability stable
    * @category annotations
    * @since 2.0.0
    */
@@ -3542,6 +3587,7 @@ export const mapInput: {
  * const count = value.count // => 3
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -3578,6 +3624,7 @@ export const withConstantInput: {
    * const count = value.count // => 3
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -3614,6 +3661,7 @@ export const withConstantInput: {
    * const count = value.count // => 3
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -3651,6 +3699,7 @@ export const withConstantInput: {
    * const count = value.count // => 3
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -3687,6 +3736,7 @@ export const withConstantInput: {
    * const count = value.count // => 3
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -3747,6 +3797,7 @@ export const withConstantInput: {
  * await Effect.runPromise(Effect.provideService(result, Metric.MetricRegistry, new Map())) // => [2, 1]
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -3805,6 +3856,7 @@ export const withAttributes: {
    * await Effect.runPromise(Effect.provideService(result, Metric.MetricRegistry, new Map())) // => [2, 1]
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -3863,6 +3915,7 @@ export const withAttributes: {
    * await Effect.runPromise(Effect.provideService(result, Metric.MetricRegistry, new Map())) // => [2, 1]
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -3922,6 +3975,7 @@ export const withAttributes: {
    * await Effect.runPromise(Effect.provideService(result, Metric.MetricRegistry, new Map())) // => [2, 1]
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -3980,6 +4034,7 @@ export const withAttributes: {
    * await Effect.runPromise(Effect.provideService(result, Metric.MetricRegistry, new Map())) // => [2, 1]
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -4040,6 +4095,7 @@ export const withAttributes: {
  * const ids = snapshots.map((snapshot) => snapshot.id).sort() // => ["http_requests", "response_time_ms"]
  * ```
  *
+ * @stability stable
  * @category snapshotting
  * @since 2.0.0
  */
@@ -4099,6 +4155,7 @@ export const snapshot: Effect<ReadonlyArray<Metric.Snapshot>> = InternalEffect.m
  * included // => [true, true, true]
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 4.0.0
  */
@@ -4167,6 +4224,7 @@ export const dump: Effect<string> = InternalEffect.flatMap(InternalEffect.contex
  * await Effect.runPromise(Effect.provideService(program, Metric.MetricRegistry, new Map())) // => ["http_requests"]
  * ```
  *
+ * @stability stable
  * @category snapshotting
  * @since 4.0.0
  */
@@ -4256,6 +4314,7 @@ const attributesToString = (attributes: Metric.AttributeSet): string => {
  * Metric.boundariesFromIterable([-5, 0, 10, 10, 25, 50]) // => [10, 25, 50, Infinity]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -4281,6 +4340,7 @@ export const boundariesFromIterable = (iterable: Iterable<number>): ReadonlyArra
  * Metric.linearBoundaries({ start: 10, width: 20, count: 5 }) // => [10, 30, 50, 70, Infinity]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -4307,6 +4367,7 @@ export const linearBoundaries = (options: {
  * Metric.exponentialBoundaries({ start: 1, factor: 2, count: 5 }) // => [1, 2, 4, 8, Infinity]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -4346,6 +4407,7 @@ const fiberFailures = counter("child_fiber_failures", {
  * Metric.FiberRuntimeMetricsKey // => "effect/Metric/FiberRuntimeMetrics"
  * ```
  *
+ * @stability stable
  * @category constants
  * @since 4.0.0
  */
@@ -4374,6 +4436,7 @@ export const FiberRuntimeMetricsKey: "effect/Metric/FiberRuntimeMetrics" = Inter
  * events // => ["start", "success"]
  * ```
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -4413,6 +4476,7 @@ export interface FiberRuntimeMetricsService {
  * const isDefault = result // => true
  * ```
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -4435,6 +4499,7 @@ export const FiberRuntimeMetrics = Context.Reference<FiberRuntimeMetricsService
  * ] // => ["function", "function"]
  * ```
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -4475,6 +4540,7 @@ export const FiberRuntimeMetricsImpl: FiberRuntimeMetricsService = {
  * await Effect.runPromise(Effect.provide(program, Metric.enableRuntimeMetricsLayer)) // => true
  * ```
  *
+ * @stability stable
  * @category layers
  * @since 4.0.0
  */
@@ -4514,6 +4580,7 @@ export const enableRuntimeMetricsLayer = Layer.succeed(FiberRuntimeMetrics)(Fibe
  * const values = [result.counterValue.count, result.metricsEnabled] // => [1, false]
  * ```
  *
+ * @stability stable
  * @category layers
  * @since 4.0.0
  */
@@ -4541,6 +4608,7 @@ export const disableRuntimeMetricsLayer = Layer.succeed(FiberRuntimeMetrics)(und
  * await Effect.runPromise(Metric.enableRuntimeMetrics(program)) // => true
  * ```
  *
+ * @stability stable
  * @category providing services
  * @since 4.0.0
  */
@@ -4570,6 +4638,7 @@ export const enableRuntimeMetrics: <A, E, R>(self: Effect<A, E, R>) => Effect<A,
  * await Effect.runPromise(Metric.disableRuntimeMetrics(program)) // => true
  * ```
  *
+ * @stability stable
  * @category providing services
  * @since 4.0.0
  */