Skip to main content

readEnvelope

@forge/monorepo


@forge/monorepo / backend/src / readEnvelope

Function: readEnvelope()

readEnvelope(steps, budget?): Envelope

Defined in: backend/src/loadtest/metrics.ts:282

Read an envelope off a staircase of load steps.

The first failing step is the one reported, not the worst: an operator needs the point at which behaviour starts to go wrong, and later steps are already past it. And the mode is read from that step rather than from the whole run, because a system that queues at 40/s and errors at 80/s degrades gracefully — the abrupt behaviour further out is a different fact.

Parameters

steps

readonly LoadStep[]

budget?

LoadBudget = DEFAULT_LOAD_BUDGET

Returns

Envelope