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

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

@@ -0,0 +1,814 @@
+/**
+ * `telemetry.instanceId`: 1-63 characters, lowercase letters, digits, `.`,
+ * `_` or `-`, starting with a letter or digit (a DNS label's bound, valid
+ * unquoted in a PromQL matcher and a SQL literal alike).
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_INSTANCE_ID_PATTERN: RegExp;
+/**
+ * The inclusive bounds of every numeric `telemetry` setting:
+ * `retentionDays`, `query.maxRows`, `query.timeoutSeconds`,
+ * `assistant.maxResultRowsToModel` and `assistant.maxSteps`. The settings
+ * schema is built from these numbers.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_LIMITS: {
+    /** `retentionDays`, in days. */
+    readonly retentionDays: {
+        /** Fewest accepted. */
+        readonly min: 1;
+        /** Most accepted. */
+        readonly max: 3650;
+    };
+    /** `query.maxRows`, in rows. */
+    readonly maxRows: {
+        /** Fewest accepted. */
+        readonly min: 1;
+        /** Most accepted. */
+        readonly max: 100000;
+    };
+    /** `query.timeoutSeconds`, in seconds. */
+    readonly timeoutSeconds: {
+        /** Fewest accepted. */
+        readonly min: 1;
+        /** Most accepted. */
+        readonly max: 120;
+    };
+    /** `assistant.maxResultRowsToModel`, in rows. */
+    readonly maxResultRowsToModel: {
+        /** Fewest accepted. */
+        readonly min: 1;
+        /** Most accepted. */
+        readonly max: 100;
+    };
+    /** `assistant.maxSteps`, in tool-call rounds (the AI runtime's own loop ceiling). */
+    readonly maxSteps: {
+        /** Fewest accepted. */
+        readonly min: 1;
+        /** Most accepted. */
+        readonly max: 20;
+    };
+};
+/**
+ * The longest SQL text `POST /api/admin/telemetry/query` and `/export`
+ * accept. Telemetry queries are hand-written or model-written, never
+ * generated in bulk.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_SQL_MAX_LENGTH = 20000;
+/**
+ * The absolute ceiling a query's `maxRows` may ask for; the
+ * `telemetry.query.maxRows` setting clamps it further.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_QUERY_MAX_ROWS_CEILING = 100000;
+/**
+ * The simplified PostgreSQL-wire type of a query result column. `int8` and
+ * `numeric` values arrive as strings, `timestamp`/`date`/`time` as the
+ * server's text, `json` parsed and `bytea` as base64.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_COLUMN_TYPES: readonly ["bool", "int2", "int4", "int8", "float4", "float8", "numeric", "text", "bytea", "date", "time", "timestamp", "json", "unknown"];
+/**
+ * One of {@link TELEMETRY_COLUMN_TYPES}.
+ *
+ * @stability stable
+ */
+export type TelemetryColumnType = (typeof TELEMETRY_COLUMN_TYPES)[number];
+/**
+ * GreptimeDB's role for a schema column, as `GET /api/admin/telemetry/schema`
+ * reports it in `semanticType` (which is typed as a string on the wire).
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_SEMANTIC_TYPES: readonly ["TAG", "FIELD", "TIMESTAMP"];
+/**
+ * One of {@link TELEMETRY_SEMANTIC_TYPES}.
+ *
+ * @stability stable
+ */
+export type TelemetrySemanticType = (typeof TELEMETRY_SEMANTIC_TYPES)[number];
+/**
+ * The formats `POST /api/admin/telemetry/export` produces, in the order the
+ * wire enum has always listed them. A menu that wants another order keeps its
+ * own display list over this one.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_EXPORT_FORMATS: readonly ["csv", "ndjson", "xlsx", "parquet"];
+/**
+ * One of {@link TELEMETRY_EXPORT_FORMATS}.
+ *
+ * @stability stable
+ */
+export type TelemetryExportFormat = (typeof TELEMETRY_EXPORT_FORMATS)[number];
+/**
+ * Where the connection in force comes from: `stored` (saved on the admin
+ * page), `environment` (the deployment's own GreptimeDB) or `none`.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_CONNECTION_SOURCES: readonly ["stored", "environment", "none"];
+/**
+ * One of {@link TELEMETRY_CONNECTION_SOURCES}.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionSource = (typeof TELEMETRY_CONNECTION_SOURCES)[number];
+/**
+ * `auto`: the GreptimeDB deployed with the application; `custom`: a host an
+ * administrator chose.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_CONNECTION_HOST_MODES: readonly ["auto", "custom"];
+/**
+ * One of {@link TELEMETRY_CONNECTION_HOST_MODES}.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionHostMode = (typeof TELEMETRY_CONNECTION_HOST_MODES)[number];
+/**
+ * GreptimeDB's Postgres-wire port and database when nothing says otherwise:
+ * what a custom connection that omits them gets.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_CONNECTION_DEFAULTS: {
+    /** GreptimeDB's Postgres-wire default port. */
+    readonly pgPort: 4003;
+    /** GreptimeDB's default database. */
+    readonly database: "public";
+};
+/**
+ * A connection's database name: a plain identifier, because retention
+ * interpolates it unquoted into `ALTER DATABASE`.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_DATABASE_PATTERN: RegExp;
+/**
+ * A connection's hostname: RFC 1123 labels, plus `_` (Docker Compose service
+ * names use it). No scheme, port or path. An IP address is accepted
+ * separately.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_HOSTNAME_PATTERN: RegExp;
+/**
+ * Whether the API can reach the deployment agent that manages the telemetry
+ * containers: `available`, `unavailable` (configured, not reachable),
+ * `unauthorized` (it refused the API's token) or `not_configured`.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_STACK_AGENT_STATES: readonly ["available", "unavailable", "unauthorized", "not_configured"];
+/**
+ * One of {@link TELEMETRY_STACK_AGENT_STATES}.
+ *
+ * @stability stable
+ */
+export type TelemetryStackAgentState = (typeof TELEMETRY_STACK_AGENT_STATES)[number];
+/**
+ * A telemetry container's state, as the deployment agent reports it;
+ * `missing` when it has never been created.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_STACK_SERVICE_STATES: readonly ["running", "restarting", "exited", "created", "paused", "dead", "missing"];
+/**
+ * One of {@link TELEMETRY_STACK_SERVICE_STATES}.
+ *
+ * @stability stable
+ */
+export type TelemetryStackServiceState = (typeof TELEMETRY_STACK_SERVICE_STATES)[number];
+/**
+ * A telemetry container's health check result (absent, `null`, when it has
+ * none or is not running).
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_STACK_SERVICE_HEALTH: readonly ["healthy", "unhealthy", "starting"];
+/**
+ * One of {@link TELEMETRY_STACK_SERVICE_HEALTH}.
+ *
+ * @stability stable
+ */
+export type TelemetryStackServiceHealth = (typeof TELEMETRY_STACK_SERVICE_HEALTH)[number];
+/**
+ * The status of the latest stack deploy job: the queue's own statuses.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_STACK_DEPLOY_STATUSES: readonly ["pending", "running", "succeeded", "failed"];
+/**
+ * One of {@link TELEMETRY_STACK_DEPLOY_STATUSES}.
+ *
+ * @stability stable
+ */
+export type TelemetryStackDeployStatus = (typeof TELEMETRY_STACK_DEPLOY_STATUSES)[number];
+/**
+ * The relative windows every dashboard route accepts as `range`.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_RANGES: readonly ["15m", "1h", "6h", "24h", "7d"];
+/**
+ * One of {@link DASHBOARD_RANGES}.
+ *
+ * @stability stable
+ */
+export type DashboardRange = (typeof DASHBOARD_RANGES)[number];
+/**
+ * The length of each {@link DASHBOARD_RANGES} window, in milliseconds.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_RANGE_MS: Record<DashboardRange, number>;
+/**
+ * The window a dashboard route reads when the query names none.
+ *
+ * @stability stable
+ */
+export declare const DEFAULT_DASHBOARD_RANGE: DashboardRange;
+/**
+ * The longest absolute window (`from` to `to`) a dashboard route accepts: 30 days.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_MAX_SPAN_MS: number;
+/**
+ * How far past now `to` may be (clock skew between browser and server): 1 minute.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_FUTURE_SKEW_MS = 60000;
+/**
+ * The target bucket counts a dashboard route accepts as `buckets` (strings:
+ * every query value arrives as one).
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_BUCKET_COUNTS: readonly ["30", "60"];
+/**
+ * One of {@link DASHBOARD_BUCKET_COUNTS}.
+ *
+ * @stability stable
+ */
+export type DashboardBucketCount = (typeof DASHBOARD_BUCKET_COUNTS)[number];
+/**
+ * The longest `service`, `instance` or `host` filter value.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_FILTER_VALUE_MAX = 200;
+/**
+ * The longest `cursor` the events route accepts.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_CURSOR_MAX = 512;
+/**
+ * The longest `q` (log body search) the events route accepts.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_SEARCH_MAX_LENGTH = 200;
+/**
+ * The severities the events route filters on, in `severity`'s comma list.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_EVENT_SEVERITIES: readonly ["error", "warn", "info"];
+/**
+ * One of {@link DASHBOARD_EVENT_SEVERITIES}.
+ *
+ * @stability stable
+ */
+export type DashboardEventSeverity = (typeof DASHBOARD_EVENT_SEVERITIES)[number];
+/**
+ * The `timeseries` route's panels: `api` (status classes, p95) or `logs`
+ * (severity bands).
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_PANELS: readonly ["api", "logs"];
+/**
+ * One of {@link DASHBOARD_PANELS}.
+ *
+ * @stability stable
+ */
+export type DashboardPanel = (typeof DASHBOARD_PANELS)[number];
+/**
+ * The pattern every dashboard panel id matches (`api`, `signups`): a lowercase
+ * letter, then up to 47 lowercase letters, digits, `_` or `-`. The panel set is
+ * open: the platform registers `api` and `logs`, an app registers its own
+ * (`registerDashboardPanel`).
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_PANEL_ID_PATTERN: RegExp;
+/**
+ * The most bytes a dashboard panel's `payload` may serialise to.
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_PANEL_PAYLOAD_MAX_BYTES = 262144;
+/**
+ * The `top` route's kinds: `routes` (by 5xx, then 4xx except 401, then p95)
+ * or `errors` (log messages).
+ *
+ * @stability stable
+ */
+export declare const DASHBOARD_TOP_KINDS: readonly ["routes", "errors"];
+/**
+ * One of {@link DASHBOARD_TOP_KINDS}.
+ *
+ * @stability stable
+ */
+export type DashboardTopKind = (typeof DASHBOARD_TOP_KINDS)[number];
+/**
+ * The summary's overall verdict levels, in increasing severity, `no_data`
+ * last.
+ *
+ * @stability stable
+ */
+export declare const VERDICT_LEVELS: readonly ["healthy", "degraded", "critical", "no_data"];
+/**
+ * One of {@link VERDICT_LEVELS}.
+ *
+ * @stability stable
+ */
+export type VerdictLevel = (typeof VERDICT_LEVELS)[number];
+/**
+ * The display units the platform registers itself, as the `unit` of metric
+ * tiles, series and table columns (`/metrics`). The live set is the API's unit
+ * registry (`registerMetricUnit`): an app adds its own (`usd`, `tokens`), and
+ * the wire accepts any id matching {@link METRIC_UNIT_ID_PATTERN}.
+ *
+ * @stability stable
+ */
+export declare const BUILTIN_METRIC_UNITS: readonly ["%", "bytes", "bytes/s", "count", "per_s", "per_min", "ms", "seconds", "hours", "days", "cores", "load", "timestamp", "text", "boolean"];
+/**
+ * The platform's own display units; the same list as
+ * {@link BUILTIN_METRIC_UNITS}, kept under its original name.
+ *
+ * @deprecated Use {@link BUILTIN_METRIC_UNITS}; the unit set is open since an
+ *   app can register its own.
+ * @stability stable
+ */
+export declare const METRIC_UNITS: readonly ["%", "bytes", "bytes/s", "count", "per_s", "per_min", "ms", "seconds", "hours", "days", "cores", "load", "timestamp", "text", "boolean"];
+/**
+ * One of {@link BUILTIN_METRIC_UNITS}.
+ *
+ * @stability stable
+ */
+export type BuiltinMetricUnit = (typeof BUILTIN_METRIC_UNITS)[number];
+/**
+ * A metric unit id: a built-in one or any id an app registered. The union keeps
+ * the built-in ids in autocompletion and accepts any other string.
+ *
+ * @stability stable
+ */
+export type MetricUnit = BuiltinMetricUnit | (string & {});
+/**
+ * The pattern every metric unit id matches: a lowercase letter or `%`, then up
+ * to 31 lowercase letters, digits, `_`, `/`, `%` or `-`.
+ *
+ * @stability stable
+ */
+export declare const METRIC_UNIT_ID_PATTERN: RegExp;
+/**
+ * How the web formats a value of a unit: `number` (grouped digits, `decimals`,
+ * `suffix`), `percent`, `bytes` (binary units), `duration-ms`, `duration-s`,
+ * `currency` (ISO 4217 `currency`), and the non-numeric `text`, `boolean` and
+ * `timestamp`.
+ *
+ * @stability stable
+ */
+export declare const METRIC_UNIT_FORMATS: readonly ["number", "percent", "bytes", "duration-ms", "duration-s", "currency", "text", "boolean", "timestamp"];
+/**
+ * One of {@link METRIC_UNIT_FORMATS}.
+ *
+ * @stability stable
+ */
+export type MetricUnitFormat = (typeof METRIC_UNIT_FORMATS)[number];
+/**
+ * The bounds of a unit descriptor and of a group's presentation. The schemas
+ * are built from these numbers, so what the API enforces is what the web may
+ * rely on.
+ *
+ * @stability stable
+ */
+export declare const METRIC_PRESENTATION_LIMITS: {
+    /** The longest unit `label` or `suffix`, in characters. */
+    readonly unitLabel: 40;
+    /** The longest unit `suffix`. */
+    readonly unitSuffix: 12;
+    /** The most fraction digits a unit may ask for. */
+    readonly unitDecimals: 6;
+    /** The longest label, title or status word in a presentation. */
+    readonly label: 80;
+    /** The longest metric, table or column key. */
+    readonly key: 64;
+    /** The most tiles. */
+    readonly tiles: 24;
+    /** The most charts (`series` entries). */
+    readonly charts: 8;
+    /** The most metrics in one chart. */
+    readonly chartMetrics: 8;
+    /** The most colour overrides in one chart. */
+    readonly chartColors: 8;
+    /** The most tables. */
+    readonly tables: 8;
+    /** The most columns in one table. */
+    readonly columns: 24;
+    /** The most virtual columns. */
+    readonly virtualColumns: 8;
+    /** The most options in a table's "Top N" select. */
+    readonly topNOptions: 6;
+    /** The largest N. */
+    readonly topNMax: 500;
+};
+/**
+ * The colours a presentation may name: a STATUS colour (`ok`, `warn`, `crit`,
+ * `info`, `neutral`: what a value means) or a categorical chart SERIES colour
+ * (`series-1` to `series-8`). They are theme tokens (`palette.status`,
+ * `palette.chart.series`), never a CSS colour, so an app restyles them in its
+ * theme and a presentation cannot inject a style.
+ *
+ * @stability stable
+ */
+export declare const PRESENTATION_COLOR_TOKENS: readonly ["ok", "warn", "crit", "info", "neutral", "series-1", "series-2", "series-3", "series-4", "series-5", "series-6", "series-7", "series-8"];
+/**
+ * One of {@link PRESENTATION_COLOR_TOKENS}.
+ *
+ * @stability stable
+ */
+export type ThemeColorToken = (typeof PRESENTATION_COLOR_TOKENS)[number];
+/**
+ * The expressions of a virtual table column: `ratio` (`a / b` as a percentage),
+ * `delta` (`a - b`) and `rate` (`a` per second over the window).
+ *
+ * @stability stable
+ */
+export declare const VIRTUAL_COLUMN_EXPRESSIONS: readonly ["ratio", "delta", "rate"];
+/**
+ * One of {@link VIRTUAL_COLUMN_EXPRESSIONS}.
+ *
+ * @stability stable
+ */
+export type VirtualColumnExpression = (typeof VIRTUAL_COLUMN_EXPRESSIONS)[number];
+/**
+ * The row orders a presentation may ask of a table: `problems-first` (failing
+ * rows, `up === false` or a flag, before healthy ones) and `value-desc` (the
+ * table's first value column, largest first, rows with no value last; the
+ * order a "Top N" is meant for). Both are stable.
+ *
+ * @stability stable
+ */
+export declare const PRESENTATION_TABLE_SORTS: readonly ["problems-first", "value-desc"];
+/**
+ * One of {@link PRESENTATION_TABLE_SORTS}.
+ *
+ * @stability stable
+ */
+export type PresentationTableSort = (typeof PRESENTATION_TABLE_SORTS)[number];
+/**
+ * How a presentation renders a table cell: `utilization-bar` (a percentage as
+ * a bar), `status` (a boolean as an icon and a word) or `fraction` (`used / total`).
+ *
+ * @stability stable
+ */
+export declare const PRESENTATION_COLUMN_DISPLAYS: readonly ["utilization-bar", "status", "fraction"];
+/**
+ * One of {@link PRESENTATION_COLUMN_DISPLAYS}.
+ *
+ * @stability stable
+ */
+export type PresentationColumnDisplay = (typeof PRESENTATION_COLUMN_DISPLAYS)[number];
+/**
+ * The pattern every metric group id matches (lower snake case). Group ids are
+ * an open set: the platform registers six, an app may register more.
+ *
+ * @stability stable
+ */
+export declare const METRIC_GROUP_ID_PATTERN: RegExp;
+/**
+ * The metric groups the platform itself registers, in dashboard order. The
+ * live set is whatever `GET /api/admin/telemetry/dashboard/metric-groups`
+ * lists.
+ *
+ * @stability stable
+ */
+export declare const PLATFORM_METRIC_GROUPS: readonly ["host", "database", "queue", "nodes", "uptime", "pipeline"];
+/**
+ * A metric unit: its `id`, a human `label`, and how the web formats a value of
+ * it (`format`, plus `currency` for `currency`, `decimals` and `suffix` for
+ * `number`).
+ *
+ * @example
+ * ```ts
+ * { id: 'usd', label: 'US dollars', format: 'currency', currency: 'USD', decimals: 2 }
+ * ```
+ *
+ * @stability experimental
+ */
+export interface MetricUnitDescriptor {
+    /** The id a family, ratio, table column or presentation names as its `unit`. */
+    id: string;
+    /** A human name (`US dollars`). */
+    label: string;
+    /** How a value is formatted. */
+    format: MetricUnitFormat;
+    /** The ISO 4217 code of a `currency` unit (`USD`). Required for `currency`, refused otherwise. */
+    currency?: string;
+    /** Fraction digits to show (0 to 6). Default: the format's own. */
+    decimals?: number;
+    /** Text after a `number` value (`/s`, ` nudges`). */
+    suffix?: string;
+}
+/**
+ * One headline tile: the metric (a family or ratio key, with the
+ * `.<tileGroup>` suffix of a family that emits one tile per group value), and
+ * optionally its label, unit and colour.
+ *
+ * @stability experimental
+ */
+export interface PresentationTile {
+    /** The family or ratio key (or `<family>.<value>` of a family with `tileGroups`). */
+    metric: string;
+    /** Replaces the tile's label. */
+    label?: string;
+    /** Replaces the tile's unit (a registered unit id). */
+    unit?: string;
+    /** Draws the value in this theme colour. */
+    color?: ThemeColorToken;
+}
+/**
+ * One line chart: the metrics (family or ratio keys) drawn together, and a
+ * colour per `groupBy` value (a status colour for an outcome, say).
+ *
+ * @stability experimental
+ */
+export interface PresentationSeries {
+    /** The chart's title: its accessible name. */
+    title: string;
+    /** The family or ratio keys drawn, in legend order. They share one unit. */
+    metrics: string[];
+    /** Theme colours by `groupBy` value (`succeeded: 'ok'`); other lines take the series palette. */
+    colors?: Record<string, ThemeColorToken>;
+}
+/**
+ * A table's "Top N" row limit: a number N (offers `Top N` and `All`, starting at
+ * N), or `{ options, default }` for a select with several counts.
+ *
+ * @stability experimental
+ */
+export type PresentationTopN = number | {
+    /** The counts offered, ascending, optionally ending in `'all'`. */
+    options: Array<number | 'all'>;
+    /** The count shown until the viewer chooses (one of `options`). */
+    default: number | 'all';
+};
+/**
+ * How one table cell is drawn instead of by its unit: `utilization-bar` (a
+ * percentage as a bar, warning from `warnAt`, critical from `criticalAt`),
+ * `status` (a boolean as an icon AND a word; `invert` reads `false` as good)
+ * or `fraction` (`used / total` of two columns).
+ *
+ * @stability experimental
+ */
+export type PresentationColumnDisplayDef = {
+    /** A percentage drawn as a bar. */
+    kind: 'utilization-bar';
+    /** The percentage from which the bar turns to the warning colour. */
+    warnAt?: number;
+    /** The percentage from which the bar turns to the critical colour. */
+    criticalAt?: number;
+} | {
+    /** A boolean drawn as an icon and a word. */
+    kind: 'status';
+    /** The word for a good value (`Up`). */
+    okText: string;
+    /** The word for a bad value (`Down`). */
+    badText: string;
+    /** Read `false` as good (a "none eligible" flag). */
+    invert?: boolean;
+} | {
+    /** Two columns drawn as `first / second`. */
+    kind: 'fraction';
+    /** Exactly two columns, shown as `first / second`. */
+    of: string[];
+};
+/**
+ * One column of a table: a response column key (or a virtual column id, or a
+ * `fraction` column's own key), its header and how it is drawn. A column the
+ * response lacks is skipped, never drawn empty.
+ *
+ * @stability experimental
+ */
+export interface PresentationColumn {
+    /** A response column key, a virtual column id, or a free key for a `fraction` column. */
+    key: string;
+    /** Replaces the column's header. */
+    label?: string;
+    /** Draws the cell as a bar, a status or a fraction instead of by its unit. */
+    display?: PresentationColumnDisplayDef;
+}
+/**
+ * One per-key table of a group: the table key, its row limit, its row order
+ * (`problems-first` puts failing rows, `up === false` or a flag, first) and
+ * its columns (default: every column of the response).
+ *
+ * @stability experimental
+ */
+export interface PresentationTable {
+    /** The group's table key. */
+    metric: string;
+    /** Replaces the table's title. */
+    label?: string;
+    /** A "Top N" row limit. Absent: every row is drawn. */
+    topN?: PresentationTopN;
+    /** `problems-first`: failing rows before healthy ones; `value-desc`: the first value column, largest first. Stable. Absent: the API's order. */
+    sort?: PresentationTableSort;
+    /** The columns, in order. Absent: every column of the response. */
+    columns?: PresentationColumn[];
+}
+/**
+ * A column computed in the browser from other columns of a table's rows:
+ * `ratio` (`a / b` as a percentage), `delta` (`a - b`), `rate` (`a` per second
+ * over the window). A row where an input is missing, or a ratio's divisor is
+ * zero, reads "—".
+ *
+ * @stability experimental
+ */
+export interface PresentationVirtualColumn {
+    /** The column id: a key for `columns`. */
+    id: string;
+    /** The header. */
+    label: string;
+    /** What it computes. */
+    expression: VirtualColumnExpression;
+    /** The input columns: two for `ratio` and `delta`, one for `rate`. */
+    of: string[];
+    /** Only this table (default: every table that has every input column). */
+    table?: string;
+    /** The result's unit (default: `%` for a ratio, `per_s` for a rate, the first input's for a delta). */
+    unit?: string;
+}
+/**
+ * How a metric group's dashboard section looks. Every part is optional: an
+ * omitted part gets the default (every tile, one chart per series key, every
+ * table); a present part, even an empty array, is exactly what is drawn.
+ *
+ * @example
+ * ```ts
+ * const presentation: MetricGroupPresentation = {
+ *   tiles: [{ metric: 'aiSpend', label: 'AI spend', unit: 'usd', color: 'warn' }],
+ *   tables: [{ metric: 'features', topN: 5 }],
+ * };
+ * ```
+ *
+ * @stability experimental
+ */
+export interface MetricGroupPresentation {
+    /** The headline tiles, in order. */
+    tiles?: PresentationTile[];
+    /** The line charts, in order. */
+    series?: PresentationSeries[];
+    /** The tables, in order. */
+    tables?: PresentationTable[];
+    /** Columns computed in the browser. */
+    virtualColumns?: PresentationVirtualColumn[];
+}
+/**
+ * The presentation of the six platform groups, keyed by group id. The
+ * platform's metric-group declarations take theirs from here, and the web falls
+ * back to these when an API does not serve a presentation, so a section looks
+ * the same against any API version.
+ *
+ * @stability experimental
+ */
+export declare const PLATFORM_METRIC_PRESENTATIONS: Readonly<Record<(typeof PLATFORM_METRIC_GROUPS)[number], MetricGroupPresentation>>;
+/**
+ * The longest question the assistant accepts, in characters (after trimming).
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_QUESTION_MAX = 4000;
+/**
+ * The most earlier turns a request may carry in `history`.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_HISTORY_MAX_TURNS = 20;
+/**
+ * The longest `content` of one `history` turn, in characters.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_HISTORY_CONTENT_MAX = 8000;
+/**
+ * Who wrote a `history` turn.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_TURN_ROLES: readonly ["user", "assistant"];
+/**
+ * The tools the platform gives the assistant; each `step` event names one. An
+ * app adds its own (`registerTelemetryAssistantTool`): a step event's `tool`
+ * may be any name matching {@link TELEMETRY_ASSISTANT_TOOL_NAME_PATTERN}.
+ *
+ * @stability stable
+ */
+export declare const BUILTIN_TELEMETRY_ASSISTANT_TOOLS: readonly ["list_tables", "describe_table", "run_query", "get_app_context", "health_overview", "get_trace", "metrics_overview", "compare_nodes"];
+/**
+ * The platform's own assistant tools; the same list as
+ * {@link BUILTIN_TELEMETRY_ASSISTANT_TOOLS}, kept under its original name.
+ *
+ * @deprecated Use {@link BUILTIN_TELEMETRY_ASSISTANT_TOOLS}; the tool set is
+ *   open since an app can register its own.
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_TOOLS: readonly ["list_tables", "describe_table", "run_query", "get_app_context", "health_overview", "get_trace", "metrics_overview", "compare_nodes"];
+/**
+ * One of {@link BUILTIN_TELEMETRY_ASSISTANT_TOOLS}.
+ *
+ * @stability stable
+ */
+export type BuiltinTelemetryAssistantToolName = (typeof BUILTIN_TELEMETRY_ASSISTANT_TOOLS)[number];
+/**
+ * A tool the assistant called: a built-in one or an app's. The union keeps the
+ * built-in names in autocompletion and accepts any other string.
+ *
+ * @stability stable
+ */
+export type TelemetryAssistantToolName = BuiltinTelemetryAssistantToolName | (string & {});
+/**
+ * The pattern every assistant tool name matches: a lowercase letter, then up to
+ * 47 lowercase letters, digits or `_` (a valid function name for every model
+ * provider).
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_TOOL_NAME_PATTERN: RegExp;
+/**
+ * The longest `extraInstructions` an app may append to the assistant's system
+ * prompt, in characters.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_EXTRA_INSTRUCTIONS_MAX = 4000;
+/**
+ * The outcome of an investigation, in its report's `status`.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_REPORT_STATUSES: readonly ["issue_found", "no_issue_found", "inconclusive", "no_data"];
+/**
+ * One of {@link TELEMETRY_ASSISTANT_REPORT_STATUSES}.
+ *
+ * @stability stable
+ */
+export type TelemetryAssistantReportStatus = (typeof TELEMETRY_ASSISTANT_REPORT_STATUSES)[number];
+/**
+ * A report finding's severity, most severe first.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_SEVERITIES: readonly ["critical", "high", "medium", "low", "info"];
+/**
+ * One of {@link TELEMETRY_ASSISTANT_SEVERITIES}.
+ *
+ * @stability stable
+ */
+export type TelemetryAssistantSeverity = (typeof TELEMETRY_ASSISTANT_SEVERITIES)[number];
+/**
+ * How sure a report is of its root cause.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_ASSISTANT_CONFIDENCES: readonly ["high", "medium", "low"];
+/**
+ * One of {@link TELEMETRY_ASSISTANT_CONFIDENCES}.
+ *
+ * @stability stable
+ */
+export type TelemetryAssistantConfidence = (typeof TELEMETRY_ASSISTANT_CONFIDENCES)[number];
+/**
+ * The entries of a telemetry enum schema, as `z.enum` types them: each value
+ * keyed by itself (`TelemetryEnumEntries<DashboardRange>` is
+ * `{ '15m': '15m', … }`). Named so a schema's type reads as a reference.
+ *
+ * @stability stable
+ */
+export type TelemetryEnumEntries<T extends string> = {
+    [K in T]: K;
+};
+//# sourceMappingURL=constants.d.ts.map