(options: {
readonly start: number
readonly width: number
readonly count: number
}): ReadonlyArray<number>Creates histogram bucket boundaries from a linear sequence and appends positive infinity.
Details
Generates count - 1 finite boundaries using start + width + index for
each zero-based index, then applies the same normalization as
boundariesFromIterable: non-positive values are removed, duplicates are
collapsed, and Infinity is appended.
Example (Creating linear boundaries)
import { Data, Effect, Metric } from "effect"
class BoundaryError extends Data.TaggedError("BoundaryError")<{
readonly operation: string
}> {}
// Create boundaries for response time histogram
const responseBoundaries = Metric.linearBoundaries({
start: 0, // Starting point
width: 100, // Offset used for the first boundary
count: 5 // Creates 4 boundaries + infinity
})
console.log(responseBoundaries) // [100, 101, 102, 103, Infinity]
// Create a histogram using these boundaries
const responseTimeHistogram = Metric.histogram("api_response_time", {
description: "API response time distribution",
boundaries: responseBoundaries
})
const program = Effect.gen(function*() {
// Record some response times
yield* Metric.update(responseTimeHistogram, 85)
yield* Metric.update(responseTimeHistogram, 101)
yield* Metric.update(responseTimeHistogram, 450)
const value = yield* Metric.value(responseTimeHistogram)
return value
})boundaries
Source effect/Metric.ts:33956 lines
export const const linearBoundaries: (options: {
readonly start: number
readonly width: number
readonly count: number
}) => ReadonlyArray<number>
Creates histogram bucket boundaries from a linear sequence and appends
positive infinity.
Details
Generates count - 1 finite boundaries using start + width + index for
each zero-based index, then applies the same normalization as
boundariesFromIterable: non-positive values are removed, duplicates are
collapsed, and Infinity is appended.
Example (Creating linear boundaries)
import { Data, Effect, Metric } from "effect"
class BoundaryError extends Data.TaggedError("BoundaryError")<{
readonly operation: string
}> {}
// Create boundaries for response time histogram
const responseBoundaries = Metric.linearBoundaries({
start: 0, // Starting point
width: 100, // Offset used for the first boundary
count: 5 // Creates 4 boundaries + infinity
})
console.log(responseBoundaries) // [100, 101, 102, 103, Infinity]
// Create a histogram using these boundaries
const responseTimeHistogram = Metric.histogram("api_response_time", {
description: "API response time distribution",
boundaries: responseBoundaries
})
const program = Effect.gen(function*() {
// Record some response times
yield* Metric.update(responseTimeHistogram, 85)
yield* Metric.update(responseTimeHistogram, 101)
yield* Metric.update(responseTimeHistogram, 450)
const value = yield* Metric.value(responseTimeHistogram)
return value
})
linearBoundaries = (options: {
readonly start: number
readonly width: number
readonly count: number
}
start: numberstart: number
readonly width: numberwidth: number
readonly count: numbercount: number
}): interface ReadonlyArray<T>ReadonlyArray<number> =>
const boundariesFromIterable: (
iterable: Iterable<number>
) => ReadonlyArray<number>
Creates histogram bucket boundaries from an iterable set of values.
Details
Processes any iterable of numbers by removing duplicates, filtering out
non-positive values, and automatically appending positive infinity as the
final boundary.
Example (Creating boundaries from values)
import { Data, Effect, Metric } from "effect"
class BoundaryError extends Data.TaggedError("BoundaryError")<{
readonly operation: string
}> {}
// Create boundaries from an array of custom values
const customBoundaries = Metric.boundariesFromIterable([
10,
25,
50,
100,
250,
500,
1000
])
console.log(customBoundaries) // [10, 25, 50, 100, 250, 500, 1000, Infinity]
// Automatically removes duplicates and negative values
const messyBoundaries = Metric.boundariesFromIterable([
-5,
0,
10,
10,
25,
25,
50,
-1
])
console.log(messyBoundaries) // [10, 25, 50, Infinity]
// Works with any iterable (Set, generator functions, etc.)
const setBoundaries = Metric.boundariesFromIterable(
new Set([100, 200, 300, 200, 100])
)
console.log(setBoundaries) // [100, 200, 300, Infinity]
// Use with histogram metric
const responseTimeHistogram = Metric.histogram("response_times", {
description: "API response time distribution",
boundaries: customBoundaries
})
const program = Effect.gen(function*() {
yield* Metric.update(responseTimeHistogram, 75) // Goes in 50-100ms bucket
yield* Metric.update(responseTimeHistogram, 150) // Goes in 100-250ms bucket
const value = yield* Metric.value(responseTimeHistogram)
return value
})
boundariesFromIterable(import ArrArr.makeBy(options: {
readonly start: number
readonly width: number
readonly count: number
}
count: numbercount - 1, (n: anyn) => options: {
readonly start: number
readonly width: number
readonly count: number
}
start: numberstart + n: anyn + options: {
readonly start: number
readonly width: number
readonly count: number
}
width: numberwidth))