GetMicrofrontendsInGroupChecks

The checks to evaluate. An empty array means nothing is evaluated.

Example Usage

import { GetMicrofrontendsInGroupChecks } from "@vercel/sdk/models/getmicrofrontendsingroupbuildmachineelasticreason.js";

let value: GetMicrofrontendsInGroupChecks = {
  type: "error-rate-5xx",
  minSampleSize: 100,
  excludeStatusCodes: [
    503,
  ],
  excludePaths: [
    "/api/health",
  ],
  ingestWatermarkSeconds: 30,
};

Fields

Field	Type	Required	Description	Example
type	models.GetMicrofrontendsInGroupMicrofrontendsResponse200ApplicationJSONResponseBodyProjectsRollingReleaseType	:heavy_check_mark:	The metric this check evaluates.
minSampleSize	number	:heavy_minus_sign:	Minimum number of requests required in the window before the check can fail. Below this, the check is inconclusive rather than failing, so low-traffic stages don't gate on noise. Defaults to 100 when omitted.	100
excludeStatusCodes	number[]	:heavy_minus_sign:	Response status codes to ignore entirely — dropped from both the numerator (errors) and the denominator (total requests). Defaults to [] when omitted.	[ 503 ]
excludePaths	string[]	:heavy_minus_sign:	Request paths to ignore entirely — dropped from both the numerator (errors) and the denominator (total requests). Defaults to [] when omitted.	[ "/api/health" ]
ingestWatermarkSeconds	number	:heavy_minus_sign:	Seconds of ingest lag to allow for: the query's upper bound is now() - this value, so the check never reads a window that is still filling. Defaults to 30 when omitted.	30