@marinoscar/platform-contract 0.0.0-stage → 0.1.0-next.3

package/dist/cjs/telemetry/dashboard.d.ts

@@ -0,0 +1,826 @@
+import { z } from 'zod';
+/**
+ * The window fields {@link refineWindow} reads.
+ *
+ * @stability stable
+ */
+export interface DashboardWindowInput {
+    /** A relative window. */
+    range?: string;
+    /** An absolute window start. */
+    from?: string;
+    /** An absolute window end. */
+    to?: string;
+}
+/**
+ * The cross-field rules of a dashboard window, as a `superRefine`: `range`
+ * or `from`+`to` (never both, never one of the pair), `from < to`, `to` at
+ * most 1 minute in the future and a span of at most 30 days. Every dashboard
+ * query schema applies it; an app's own dashboard query applies it too.
+ *
+ * @stability stable
+ */
+export declare function refineWindow(value: DashboardWindowInput, ctx: z.RefinementCtx): void;
+/**
+ * The query every dashboard route shares: `range` or `from`+`to`, `service`,
+ * `instance` and `buckets`, with {@link refineWindow}.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardQuerySchema: z.ZodObject<{
+    range: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"15m" | "1h" | "6h" | "24h" | "7d">>>;
+    from: z.ZodOptional<z.ZodISODateTime>;
+    to: z.ZodOptional<z.ZodISODateTime>;
+    service: z.ZodOptional<z.ZodString>;
+    instance: z.ZodOptional<z.ZodString>;
+    buckets: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"30" | "60">>>;
+}, z.core.$strip>;
+/**
+ * The query every dashboard route shares.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardQuery = z.infer<typeof telemetryDashboardQuerySchema>;
+/**
+ * `GET …/dashboard/timeseries` query: the common query plus `panel`
+ * (`api` or `logs`).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardTimeseriesQuerySchema: z.ZodObject<{
+    panel: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"api" | "logs">>;
+    range: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"15m" | "1h" | "6h" | "24h" | "7d">>>;
+    from: z.ZodOptional<z.ZodISODateTime>;
+    to: z.ZodOptional<z.ZodISODateTime>;
+    service: z.ZodOptional<z.ZodString>;
+    instance: z.ZodOptional<z.ZodString>;
+    buckets: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"30" | "60">>>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/timeseries` query.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardTimeseriesQuery = z.infer<typeof telemetryDashboardTimeseriesQuerySchema>;
+/**
+ * `GET …/dashboard/top` query: the common query plus `kind` (`routes` or
+ * `errors`).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardTopQuerySchema: z.ZodObject<{
+    kind: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"routes" | "errors">>;
+    range: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"15m" | "1h" | "6h" | "24h" | "7d">>>;
+    from: z.ZodOptional<z.ZodISODateTime>;
+    to: z.ZodOptional<z.ZodISODateTime>;
+    service: z.ZodOptional<z.ZodString>;
+    instance: z.ZodOptional<z.ZodString>;
+    buckets: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"30" | "60">>>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/top` query.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardTopQuery = z.infer<typeof telemetryDashboardTopQuerySchema>;
+/**
+ * `GET …/dashboard/events` query: the common query plus `severity` (a comma
+ * list of {@link DASHBOARD_EVENT_SEVERITIES}), `q` (a log body substring) and
+ * `cursor`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardEventsQuerySchema: z.ZodObject<{
+    severity: z.ZodOptional<z.ZodString>;
+    q: z.ZodOptional<z.ZodString>;
+    cursor: z.ZodOptional<z.ZodString>;
+    range: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"15m" | "1h" | "6h" | "24h" | "7d">>>;
+    from: z.ZodOptional<z.ZodISODateTime>;
+    to: z.ZodOptional<z.ZodISODateTime>;
+    service: z.ZodOptional<z.ZodString>;
+    instance: z.ZodOptional<z.ZodString>;
+    buckets: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"30" | "60">>>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/events` query.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardEventsQuery = z.infer<typeof telemetryDashboardEventsQuerySchema>;
+/**
+ * A metric group id as the contract knows it: any lower snake-case id
+ * ({@link METRIC_GROUP_ID_PATTERN}). The set is open; a server checks it
+ * against what it registered.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const metricGroupIdSchema: z.ZodString;
+/**
+ * A metric group id.
+ *
+ * @stability stable
+ */
+export type MetricGroupId = z.infer<typeof metricGroupIdSchema>;
+/**
+ * What {@link metricGroupQuerySchema} checks and documents.
+ *
+ * @stability stable
+ */
+export interface MetricGroupQueryOptions<G extends string> {
+    /** The ids published in the OpenAPI document (the enum and the description), in dashboard order. */
+    documented: readonly G[];
+    /** Whether `id` is a registered group, read live. */
+    isKnown: (id: unknown) => id is G;
+    /** The registered ids, read live, for the error message. */
+    knownIds: () => readonly string[];
+}
+/**
+ * The `/metrics` `group` query value of a server with a registry: checked
+ * against the LIVE set (`isKnown`), so a group registered after the schema
+ * was built is accepted, and DOCUMENTED as the enum of `documented`, exactly
+ * as a `z.enum` would be, so the OpenAPI document reads the same.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare function metricGroupQuerySchema<G extends string>(options: MetricGroupQueryOptions<G>): z.ZodType<G, string>;
+/**
+ * Builds the `GET …/dashboard/metrics` query schema around a `group` schema:
+ * the common query plus `group` and `host`, with {@link refineWindow}.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare function createTelemetryDashboardMetricsQuerySchema<G extends z.ZodType<string, string>>(group: G): z.ZodObject<{
+    group: G;
+    host: z.ZodOptional<z.ZodString>;
+    range: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"15m" | "1h" | "6h" | "24h" | "7d">>>;
+    from: z.ZodOptional<z.ZodISODateTime>;
+    to: z.ZodOptional<z.ZodISODateTime>;
+    service: z.ZodOptional<z.ZodString>;
+    instance: z.ZodOptional<z.ZodString>;
+    buckets: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"30" | "60">>>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/metrics` query, with `group` any metric group id
+ * ({@link metricGroupIdSchema}).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardMetricsQuerySchema: z.ZodObject<{
+    group: z.ZodString;
+    host: z.ZodOptional<z.ZodString>;
+    range: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"15m" | "1h" | "6h" | "24h" | "7d">>>;
+    from: z.ZodOptional<z.ZodISODateTime>;
+    to: z.ZodOptional<z.ZodISODateTime>;
+    service: z.ZodOptional<z.ZodString>;
+    instance: z.ZodOptional<z.ZodString>;
+    buckets: z.ZodOptional<z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"30" | "60">>>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/metrics` query.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetricsQuery = z.infer<typeof telemetryDashboardMetricsQuerySchema>;
+/**
+ * The fields every dashboard response except `/metrics` starts with:
+ * `range` (`from`, `to`, `bucketSeconds`), `generatedAt`, `truncated` and
+ * `sql` (the statement or statements run, primary first).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardEnvelopeSchema: z.ZodObject<{
+    range: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        bucketSeconds: z.ZodNumber;
+    }, z.core.$strip>;
+    generatedAt: z.ZodString;
+    truncated: z.ZodBoolean;
+    sql: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+}, z.core.$strip>;
+/**
+ * The fields every dashboard response except `/metrics` starts with.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardEnvelope = z.infer<typeof telemetryDashboardEnvelopeSchema>;
+/**
+ * One tile: `key`, `label`, `value`, `previous` (the previous window of equal
+ * length), `unit` and `sparkline` (one value per bucket, `null` a gap).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardTileSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    value: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    previous: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    unit: z.ZodString;
+    sparkline: z.ZodArray<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+/**
+ * One tile.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardTile = z.infer<typeof telemetryDashboardTileSchema>;
+/**
+ * One unknown API route of the summary (#650): `method`, the normalized
+ * `route`, `count`, and how many were `bearer` or `anonymous`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const unknownRouteSchema: z.ZodObject<{
+    method: z.ZodNullable<z.ZodString>;
+    route: z.ZodNullable<z.ZodString>;
+    count: z.ZodNumber;
+    bearer: z.ZodNumber;
+    anonymous: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * One unknown API route of the summary.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardUnknownRoute = z.infer<typeof unknownRouteSchema>;
+/**
+ * Requests to API routes that do not exist (#650): totals, the previous
+ * window's, the top routes and the statements run.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardUnknownRoutesSchema: z.ZodObject<{
+    requests: z.ZodNumber;
+    bearer: z.ZodNumber;
+    anonymous: z.ZodNumber;
+    previousRequests: z.ZodNumber;
+    previousBearer: z.ZodNumber;
+    topRoutes: z.ZodArray<z.ZodObject<{
+        method: z.ZodNullable<z.ZodString>;
+        route: z.ZodNullable<z.ZodString>;
+        count: z.ZodNumber;
+        bearer: z.ZodNumber;
+        anonymous: z.ZodNumber;
+    }, z.core.$strip>>;
+    truncated: z.ZodBoolean;
+    sql: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Requests to API routes that do not exist.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardUnknownRoutes = z.infer<typeof telemetryDashboardUnknownRoutesSchema>;
+/**
+ * `GET …/dashboard/summary`: the envelope plus `verdict` (`level` and
+ * `reasons`), `tiles`, `runtime` (optional) and `unknownRoutes` (optional).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardSummarySchema: z.ZodObject<{
+    verdict: z.ZodObject<{
+        level: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"healthy" | "degraded" | "critical" | "no_data">>;
+        reasons: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>;
+    tiles: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        value: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        previous: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        unit: z.ZodString;
+        sparkline: z.ZodArray<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>;
+    runtime: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        value: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        previous: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        unit: z.ZodString;
+        sparkline: z.ZodArray<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+    unknownRoutes: z.ZodOptional<z.ZodObject<{
+        requests: z.ZodNumber;
+        bearer: z.ZodNumber;
+        anonymous: z.ZodNumber;
+        previousRequests: z.ZodNumber;
+        previousBearer: z.ZodNumber;
+        topRoutes: z.ZodArray<z.ZodObject<{
+            method: z.ZodNullable<z.ZodString>;
+            route: z.ZodNullable<z.ZodString>;
+            count: z.ZodNumber;
+            bearer: z.ZodNumber;
+            anonymous: z.ZodNumber;
+        }, z.core.$strip>>;
+        truncated: z.ZodBoolean;
+        sql: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+    range: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        bucketSeconds: z.ZodNumber;
+    }, z.core.$strip>;
+    generatedAt: z.ZodString;
+    truncated: z.ZodBoolean;
+    sql: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/summary`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardSummary = z.infer<typeof telemetryDashboardSummarySchema>;
+/**
+ * One `api` timeseries bucket: `t`, the status classes and `p95Ms`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const apiBucketSchema: z.ZodObject<{
+    t: z.ZodString;
+    s2xx: z.ZodNumber;
+    s3xx: z.ZodNumber;
+    s4xx: z.ZodNumber;
+    s5xx: z.ZodNumber;
+    p95Ms: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * One `api` timeseries bucket.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardApiBucket = z.infer<typeof apiBucketSchema>;
+/**
+ * One `logs` timeseries bucket: `t` and the severity bands.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const logsBucketSchema: z.ZodObject<{
+    t: z.ZodString;
+    error: z.ZodNumber;
+    warn: z.ZodNumber;
+    info: z.ZodNumber;
+    other: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * One `logs` timeseries bucket.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardLogsBucket = z.infer<typeof logsBucketSchema>;
+/**
+ * `GET …/dashboard/timeseries`: the envelope plus `panel` and `buckets` (api
+ * buckets for `api`, logs buckets for `logs`).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardTimeseriesSchema: z.ZodObject<{
+    panel: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"api" | "logs">>;
+    buckets: z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
+        t: z.ZodString;
+        s2xx: z.ZodNumber;
+        s3xx: z.ZodNumber;
+        s4xx: z.ZodNumber;
+        s5xx: z.ZodNumber;
+        p95Ms: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>, z.ZodArray<z.ZodObject<{
+        t: z.ZodString;
+        error: z.ZodNumber;
+        warn: z.ZodNumber;
+        info: z.ZodNumber;
+        other: z.ZodNumber;
+    }, z.core.$strip>>]>;
+    range: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        bucketSeconds: z.ZodNumber;
+    }, z.core.$strip>;
+    generatedAt: z.ZodString;
+    truncated: z.ZodBoolean;
+    sql: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/timeseries`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardTimeseries = z.infer<typeof telemetryDashboardTimeseriesSchema>;
+/**
+ * One route of `top?kind=routes`: request counts, 5xx `errors`, 4xx
+ * `clientErrors`, `unknownRequests`, `unknown` and `p95Ms`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const topRouteSchema: z.ZodObject<{
+    method: z.ZodNullable<z.ZodString>;
+    route: z.ZodNullable<z.ZodString>;
+    count: z.ZodNumber;
+    errors: z.ZodNumber;
+    errorRatePct: z.ZodNumber;
+    clientErrors: z.ZodNumber;
+    unknownRequests: z.ZodNumber;
+    unknown: z.ZodBoolean;
+    p95Ms: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * One route of `top?kind=routes`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardTopRoute = z.infer<typeof topRouteSchema>;
+/**
+ * One error message of `top?kind=errors`: `message`, `count`, first and last
+ * seen, a sample trace and the `service`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const topErrorSchema: z.ZodObject<{
+    message: z.ZodNullable<z.ZodString>;
+    count: z.ZodNumber;
+    firstSeen: z.ZodNullable<z.ZodString>;
+    lastSeen: z.ZodNullable<z.ZodString>;
+    sampleTraceId: z.ZodNullable<z.ZodString>;
+    service: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * One error message of `top?kind=errors`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardTopError = z.infer<typeof topErrorSchema>;
+/**
+ * `GET …/dashboard/top`: the envelope plus `kind` and `items` (routes for
+ * `routes`, errors for `errors`).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardTopSchema: z.ZodObject<{
+    kind: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"routes" | "errors">>;
+    items: z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
+        method: z.ZodNullable<z.ZodString>;
+        route: z.ZodNullable<z.ZodString>;
+        count: z.ZodNumber;
+        errors: z.ZodNumber;
+        errorRatePct: z.ZodNumber;
+        clientErrors: z.ZodNumber;
+        unknownRequests: z.ZodNumber;
+        unknown: z.ZodBoolean;
+        p95Ms: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>, z.ZodArray<z.ZodObject<{
+        message: z.ZodNullable<z.ZodString>;
+        count: z.ZodNumber;
+        firstSeen: z.ZodNullable<z.ZodString>;
+        lastSeen: z.ZodNullable<z.ZodString>;
+        sampleTraceId: z.ZodNullable<z.ZodString>;
+        service: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>]>;
+    range: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        bucketSeconds: z.ZodNumber;
+    }, z.core.$strip>;
+    generatedAt: z.ZodString;
+    truncated: z.ZodBoolean;
+    sql: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/top`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardTop = z.infer<typeof telemetryDashboardTopSchema>;
+/**
+ * One log event: `timestamp` (full precision, UTC), `severity`, `service`,
+ * `body`, `traceId` and `spanId`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const dashboardEventSchema: z.ZodObject<{
+    timestamp: z.ZodString;
+    severity: z.ZodString;
+    service: z.ZodNullable<z.ZodString>;
+    body: z.ZodNullable<z.ZodString>;
+    traceId: z.ZodNullable<z.ZodString>;
+    spanId: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * One log event.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardEvent = z.infer<typeof dashboardEventSchema>;
+/**
+ * `GET …/dashboard/events`: the envelope plus `items` and `nextCursor`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardEventsSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        timestamp: z.ZodString;
+        severity: z.ZodString;
+        service: z.ZodNullable<z.ZodString>;
+        body: z.ZodNullable<z.ZodString>;
+        traceId: z.ZodNullable<z.ZodString>;
+        spanId: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+    range: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        bucketSeconds: z.ZodNumber;
+    }, z.core.$strip>;
+    generatedAt: z.ZodString;
+    truncated: z.ZodBoolean;
+    sql: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/events`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardEvents = z.infer<typeof telemetryDashboardEventsSchema>;
+/**
+ * `GET …/dashboard/filters`: the envelope plus the `services`, `instances`
+ * and `hosts` seen in the window.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardFiltersSchema: z.ZodObject<{
+    services: z.ZodArray<z.ZodString>;
+    instances: z.ZodArray<z.ZodString>;
+    hosts: z.ZodArray<z.ZodString>;
+    range: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        bucketSeconds: z.ZodNumber;
+    }, z.core.$strip>;
+    generatedAt: z.ZodString;
+    truncated: z.ZodBoolean;
+    sql: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/filters`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardFilters = z.infer<typeof telemetryDashboardFiltersSchema>;
+/**
+ * One point of a metric series: `t` (bucket start) and `v` (`null` where
+ * nothing was measured).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const metricPointSchema: z.ZodObject<{
+    t: z.ZodString;
+    v: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * One point of a metric series.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetricPoint = z.infer<typeof metricPointSchema>;
+/**
+ * One metric series: `key`, `label`, `unit`, `dimension`, `groupBy` and
+ * `points` (one per bucket).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const metricSeriesSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    unit: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"boolean" | "text" | "timestamp" | "%" | "bytes" | "bytes/s" | "count" | "per_s" | "per_min" | "ms" | "seconds" | "hours" | "days" | "cores" | "load">>;
+    dimension: z.ZodNullable<z.ZodString>;
+    groupBy: z.ZodNullable<z.ZodString>;
+    points: z.ZodArray<z.ZodObject<{
+        t: z.ZodString;
+        v: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * One metric series.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetricSeries = z.infer<typeof metricSeriesSchema>;
+/**
+ * One column of a metric table: `key`, `label` and `unit`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const metricColumnSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    unit: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"boolean" | "text" | "timestamp" | "%" | "bytes" | "bytes/s" | "count" | "per_s" | "per_min" | "ms" | "seconds" | "hours" | "days" | "cores" | "load">>;
+}, z.core.$strip>;
+/**
+ * One column of a metric table.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetricColumn = z.infer<typeof metricColumnSchema>;
+/**
+ * One cell of a metric table row: a string, number, boolean or `null`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const metricCellSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+/**
+ * One cell of a metric table row.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetricCell = z.infer<typeof metricCellSchema>;
+/**
+ * One per-key metric table: `key`, `label`, `columns` and `rows`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const metricTableSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        unit: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"boolean" | "text" | "timestamp" | "%" | "bytes" | "bytes/s" | "count" | "per_s" | "per_min" | "ms" | "seconds" | "hours" | "days" | "cores" | "load">>;
+    }, z.core.$strip>>;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+}, z.core.$strip>;
+/**
+ * One per-key metric table.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetricTable = z.infer<typeof metricTableSchema>;
+/**
+ * Builds the `GET …/dashboard/metrics` response schema around a `group`
+ * schema: `range`, `generatedAt`, `truncated`, `sql`, `group`, `available`,
+ * `tiles`, `series`, `tables`, `skipped` and the optional `freshMs`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare function createTelemetryDashboardMetricsSchema<G extends z.ZodType<string>>(group: G): z.ZodObject<{
+    range: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        bucketSeconds: z.ZodNumber;
+    }, z.core.$strip>;
+    generatedAt: z.ZodString;
+    truncated: z.ZodBoolean;
+    sql: z.ZodArray<z.ZodString>;
+    group: G;
+    available: z.ZodBoolean;
+    tiles: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        value: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        previous: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        unit: z.ZodString;
+        sparkline: z.ZodArray<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>;
+    series: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        unit: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"boolean" | "text" | "timestamp" | "%" | "bytes" | "bytes/s" | "count" | "per_s" | "per_min" | "ms" | "seconds" | "hours" | "days" | "cores" | "load">>;
+        dimension: z.ZodNullable<z.ZodString>;
+        groupBy: z.ZodNullable<z.ZodString>;
+        points: z.ZodArray<z.ZodObject<{
+            t: z.ZodString;
+            v: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    tables: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        columns: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            label: z.ZodString;
+            unit: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"boolean" | "text" | "timestamp" | "%" | "bytes" | "bytes/s" | "count" | "per_s" | "per_min" | "ms" | "seconds" | "hours" | "days" | "cores" | "load">>;
+        }, z.core.$strip>>;
+        rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    }, z.core.$strip>>;
+    skipped: z.ZodArray<z.ZodString>;
+    freshMs: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/metrics`, with `group` any metric group id
+ * ({@link metricGroupIdSchema}).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardMetricsSchema: z.ZodObject<{
+    range: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        bucketSeconds: z.ZodNumber;
+    }, z.core.$strip>;
+    generatedAt: z.ZodString;
+    truncated: z.ZodBoolean;
+    sql: z.ZodArray<z.ZodString>;
+    group: z.ZodString;
+    available: z.ZodBoolean;
+    tiles: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        value: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        previous: z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        unit: z.ZodString;
+        sparkline: z.ZodArray<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>;
+    series: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        unit: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"boolean" | "text" | "timestamp" | "%" | "bytes" | "bytes/s" | "count" | "per_s" | "per_min" | "ms" | "seconds" | "hours" | "days" | "cores" | "load">>;
+        dimension: z.ZodNullable<z.ZodString>;
+        groupBy: z.ZodNullable<z.ZodString>;
+        points: z.ZodArray<z.ZodObject<{
+            t: z.ZodString;
+            v: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    tables: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        columns: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            label: z.ZodString;
+            unit: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"boolean" | "text" | "timestamp" | "%" | "bytes" | "bytes/s" | "count" | "per_s" | "per_min" | "ms" | "seconds" | "hours" | "days" | "cores" | "load">>;
+        }, z.core.$strip>>;
+        rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    }, z.core.$strip>>;
+    skipped: z.ZodArray<z.ZodString>;
+    freshMs: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/metrics`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetrics = z.infer<typeof telemetryDashboardMetricsSchema>;
+/**
+ * One registered metric group: `id`, `label`, `title` and `order`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardMetricGroupSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    title: z.ZodString;
+    order: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * One registered metric group.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetricGroup = z.infer<typeof telemetryDashboardMetricGroupSchema>;
+/**
+ * `GET …/dashboard/metric-groups`: `data`, every registered group in
+ * dashboard order.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDashboardMetricGroupsSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        title: z.ZodString;
+        order: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * `GET …/dashboard/metric-groups`.
+ *
+ * @stability stable
+ */
+export type TelemetryDashboardMetricGroups = z.infer<typeof telemetryDashboardMetricGroupsSchema>;
+//# sourceMappingURL=dashboard.d.ts.map