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

package/dist/esm/telemetry/constants.js

@@ -0,0 +1,397 @@
+// The telemetry slice's plain values (issue #702). Zod-free by rule: a browser
+// that only needs a limit, an enum list or a type never pulls the schemas, and
+// with them zod, into its bundle (test/no-zod-in-constants.test.ts).
+//
+// Every number and list here is the one the schemas validate with: the
+// schemas import them, so a limit cannot drift between what the API enforces
+// and what the web form offers. Moved verbatim from the API's DTO files and
+// the web's hand-written mirrors; no value changed.
+// =============================================================================
+// Settings (`telemetry` system-settings namespace)
+// =============================================================================
+/**
+ * `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 const TELEMETRY_INSTANCE_ID_PATTERN = /^[a-z0-9][a-z0-9._-]{0,62}$/;
+/**
+ * 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 const TELEMETRY_LIMITS = {
+    /** `retentionDays`, in days. */
+    retentionDays: {
+        /** Fewest accepted. */
+        min: 1,
+        /** Most accepted. */
+        max: 3650,
+    },
+    /** `query.maxRows`, in rows. */
+    maxRows: {
+        /** Fewest accepted. */
+        min: 1,
+        /** Most accepted. */
+        max: 100000,
+    },
+    /** `query.timeoutSeconds`, in seconds. */
+    timeoutSeconds: {
+        /** Fewest accepted. */
+        min: 1,
+        /** Most accepted. */
+        max: 120,
+    },
+    /** `assistant.maxResultRowsToModel`, in rows. */
+    maxResultRowsToModel: {
+        /** Fewest accepted. */
+        min: 1,
+        /** Most accepted. */
+        max: 100,
+    },
+    /** `assistant.maxSteps`, in tool-call rounds (the AI runtime's own loop ceiling). */
+    maxSteps: {
+        /** Fewest accepted. */
+        min: 1,
+        /** Most accepted. */
+        max: 20,
+    },
+};
+// =============================================================================
+// Explorer (`/api/admin/telemetry/query`, `/schema`, `/export`)
+// =============================================================================
+/**
+ * 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 const TELEMETRY_SQL_MAX_LENGTH = 20_000;
+/**
+ * The absolute ceiling a query's `maxRows` may ask for; the
+ * `telemetry.query.maxRows` setting clamps it further.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_QUERY_MAX_ROWS_CEILING = 100_000;
+/**
+ * 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 const TELEMETRY_COLUMN_TYPES = [
+    'bool',
+    'int2',
+    'int4',
+    'int8',
+    'float4',
+    'float8',
+    'numeric',
+    'text',
+    'bytea',
+    'date',
+    'time',
+    'timestamp',
+    'json',
+    'unknown',
+];
+/**
+ * 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 const TELEMETRY_SEMANTIC_TYPES = ['TAG', 'FIELD', 'TIMESTAMP'];
+/**
+ * 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 const TELEMETRY_EXPORT_FORMATS = ['csv', 'ndjson', 'xlsx', 'parquet'];
+// =============================================================================
+// GreptimeDB connection (`/api/admin/telemetry/connection`)
+// =============================================================================
+/**
+ * Where the connection in force comes from: `stored` (saved on the admin
+ * page), `environment` (the deployment's own GreptimeDB) or `none`.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_CONNECTION_SOURCES = ['stored', 'environment', 'none'];
+/**
+ * `auto`: the GreptimeDB deployed with the application; `custom`: a host an
+ * administrator chose.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_CONNECTION_HOST_MODES = ['auto', 'custom'];
+/**
+ * GreptimeDB's Postgres-wire port and database when nothing says otherwise:
+ * what a custom connection that omits them gets.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_CONNECTION_DEFAULTS = {
+    /** GreptimeDB's Postgres-wire default port. */
+    pgPort: 4003,
+    /** GreptimeDB's default database. */
+    database: 'public',
+};
+/**
+ * A connection's database name: a plain identifier, because retention
+ * interpolates it unquoted into `ALTER DATABASE`.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_DATABASE_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/;
+/**
+ * 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 const TELEMETRY_HOSTNAME_PATTERN = /^[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?(?:\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*$/;
+// =============================================================================
+// Telemetry services (`/api/admin/telemetry/stack`)
+// =============================================================================
+/**
+ * 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 const TELEMETRY_STACK_AGENT_STATES = ['available', 'unavailable', 'unauthorized', 'not_configured'];
+/**
+ * A telemetry container's state, as the deployment agent reports it;
+ * `missing` when it has never been created.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_STACK_SERVICE_STATES = [
+    'running',
+    'restarting',
+    'exited',
+    'created',
+    'paused',
+    'dead',
+    'missing',
+];
+/**
+ * A telemetry container's health check result (absent, `null`, when it has
+ * none or is not running).
+ *
+ * @stability stable
+ */
+export const TELEMETRY_STACK_SERVICE_HEALTH = ['healthy', 'unhealthy', 'starting'];
+/**
+ * The status of the latest stack deploy job: the queue's own statuses.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_STACK_DEPLOY_STATUSES = ['pending', 'running', 'succeeded', 'failed'];
+// =============================================================================
+// Dashboard (`/api/admin/telemetry/dashboard/*`)
+// =============================================================================
+/**
+ * The relative windows every dashboard route accepts as `range`.
+ *
+ * @stability stable
+ */
+export const DASHBOARD_RANGES = ['15m', '1h', '6h', '24h', '7d'];
+/**
+ * The length of each {@link DASHBOARD_RANGES} window, in milliseconds.
+ *
+ * @stability stable
+ */
+export const DASHBOARD_RANGE_MS = {
+    /** 15 minutes. */
+    '15m': 15 * 60_000,
+    /** 1 hour. */
+    '1h': 60 * 60_000,
+    /** 6 hours. */
+    '6h': 6 * 60 * 60_000,
+    /** 24 hours. */
+    '24h': 24 * 60 * 60_000,
+    /** 7 days. */
+    '7d': 7 * 24 * 60 * 60_000,
+};
+/**
+ * The window a dashboard route reads when the query names none.
+ *
+ * @stability stable
+ */
+export const DEFAULT_DASHBOARD_RANGE = '1h';
+/**
+ * The longest absolute window (`from` to `to`) a dashboard route accepts: 30 days.
+ *
+ * @stability stable
+ */
+export const DASHBOARD_MAX_SPAN_MS = 30 * 24 * 60 * 60_000;
+/**
+ * How far past now `to` may be (clock skew between browser and server): 1 minute.
+ *
+ * @stability stable
+ */
+export const DASHBOARD_FUTURE_SKEW_MS = 60_000;
+/**
+ * The target bucket counts a dashboard route accepts as `buckets` (strings:
+ * every query value arrives as one).
+ *
+ * @stability stable
+ */
+export const DASHBOARD_BUCKET_COUNTS = ['30', '60'];
+/**
+ * The longest `service`, `instance` or `host` filter value.
+ *
+ * @stability stable
+ */
+export const DASHBOARD_FILTER_VALUE_MAX = 200;
+/**
+ * The longest `cursor` the events route accepts.
+ *
+ * @stability stable
+ */
+export const DASHBOARD_CURSOR_MAX = 512;
+/**
+ * The longest `q` (log body search) the events route accepts.
+ *
+ * @stability stable
+ */
+export const DASHBOARD_SEARCH_MAX_LENGTH = 200;
+/**
+ * The severities the events route filters on, in `severity`'s comma list.
+ *
+ * @stability stable
+ */
+export const DASHBOARD_EVENT_SEVERITIES = ['error', 'warn', 'info'];
+/**
+ * The `timeseries` route's panels: `api` (status classes, p95) or `logs`
+ * (severity bands).
+ *
+ * @stability stable
+ */
+export const DASHBOARD_PANELS = ['api', 'logs'];
+/**
+ * The `top` route's kinds: `routes` (by 5xx, then 4xx except 401, then p95)
+ * or `errors` (log messages).
+ *
+ * @stability stable
+ */
+export const DASHBOARD_TOP_KINDS = ['routes', 'errors'];
+/**
+ * The summary's overall verdict levels, in increasing severity, `no_data`
+ * last.
+ *
+ * @stability stable
+ */
+export const VERDICT_LEVELS = ['healthy', 'degraded', 'critical', 'no_data'];
+/**
+ * The display units of metric tiles, series and table columns (`/metrics`).
+ *
+ * @stability stable
+ */
+export const METRIC_UNITS = [
+    '%',
+    'bytes',
+    'bytes/s',
+    'count',
+    'per_s',
+    'per_min',
+    'ms',
+    'seconds',
+    'hours',
+    'days',
+    'cores',
+    'load',
+    'timestamp',
+    'text',
+    'boolean',
+];
+/**
+ * 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 const METRIC_GROUP_ID_PATTERN = /^[a-z][a-z0-9_]*$/;
+/**
+ * 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 const PLATFORM_METRIC_GROUPS = ['host', 'database', 'queue', 'nodes', 'uptime', 'pipeline'];
+// =============================================================================
+// Assistant (`/api/admin/telemetry/assistant/stream`)
+// =============================================================================
+/**
+ * The longest question the assistant accepts, in characters (after trimming).
+ *
+ * @stability stable
+ */
+export const TELEMETRY_ASSISTANT_QUESTION_MAX = 4_000;
+/**
+ * The most earlier turns a request may carry in `history`.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_ASSISTANT_HISTORY_MAX_TURNS = 20;
+/**
+ * The longest `content` of one `history` turn, in characters.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_ASSISTANT_HISTORY_CONTENT_MAX = 8_000;
+/**
+ * Who wrote a `history` turn.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_ASSISTANT_TURN_ROLES = ['user', 'assistant'];
+/**
+ * The tools the assistant may call; each `step` event names one.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_ASSISTANT_TOOLS = [
+    'list_tables',
+    'describe_table',
+    'run_query',
+    'get_app_context',
+    'health_overview',
+    'get_trace',
+    'metrics_overview',
+    'compare_nodes',
+];
+/**
+ * The outcome of an investigation, in its report's `status`.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_ASSISTANT_REPORT_STATUSES = ['issue_found', 'no_issue_found', 'inconclusive', 'no_data'];
+/**
+ * A report finding's severity, most severe first.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_ASSISTANT_SEVERITIES = ['critical', 'high', 'medium', 'low', 'info'];
+/**
+ * How sure a report is of its root cause.
+ *
+ * @stability stable
+ */
+export const TELEMETRY_ASSISTANT_CONFIDENCES = ['high', 'medium', 'low'];
+//# sourceMappingURL=constants.js.map

package/dist/esm/telemetry/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/telemetry/constants.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,+EAA+E;AAC/E,qEAAqE;AACrE,EAAE;AACF,uEAAuE;AACvE,6EAA6E;AAC7E,4EAA4E;AAC5E,oDAAoD;AAEpD,gFAAgF;AAChF,mDAAmD;AACnD,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAW,6BAA6B,CAAC;AAEnF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,gCAAgC;IAChC,aAAa,EAAE;QACb,uBAAuB;QACvB,GAAG,EAAE,CAAC;QACN,qBAAqB;QACrB,GAAG,EAAE,IAAI;KACV;IACD,gCAAgC;IAChC,OAAO,EAAE;QACP,uBAAuB;QACvB,GAAG,EAAE,CAAC;QACN,qBAAqB;QACrB,GAAG,EAAE,MAAM;KACZ;IACD,0CAA0C;IAC1C,cAAc,EAAE;QACd,uBAAuB;QACvB,GAAG,EAAE,CAAC;QACN,qBAAqB;QACrB,GAAG,EAAE,GAAG;KACT;IACD,iDAAiD;IACjD,oBAAoB,EAAE;QACpB,uBAAuB;QACvB,GAAG,EAAE,CAAC;QACN,qBAAqB;QACrB,GAAG,EAAE,GAAG;KACT;IACD,qFAAqF;IACrF,QAAQ,EAAE;QACR,uBAAuB;QACvB,GAAG,EAAE,CAAC;QACN,qBAAqB;QACrB,GAAG,EAAE,EAAE;KACR;CACO,CAAC;AAEX,gFAAgF;AAChF,gEAAgE;AAChE,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,OAAO,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,WAAW;IACX,MAAM;IACN,SAAS;CACD,CAAC;AASX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,CAAU,CAAC;AAS/E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAU,CAAC;AAStF,gFAAgF;AAChF,4DAA4D;AAC5D,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,QAAQ,EAAE,aAAa,EAAE,MAAM,CAAU,CAAC;AASvF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAU,CAAC;AAS3E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,+CAA+C;IAC/C,MAAM,EAAE,IAAI;IACZ,qCAAqC;IACrC,QAAQ,EAAE,QAAQ;CACV,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAW,0BAA0B,CAAC;AAE7E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GACrC,2GAA2G,CAAC;AAE9G,gFAAgF;AAChF,oDAAoD;AACpD,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,gBAAgB,CAAU,CAAC;AASpH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,SAAS;IACT,YAAY;IACZ,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,MAAM;IACN,SAAS;CACD,CAAC;AASX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAU,CAAC;AAS5F;;;;GAIG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAStG,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAEhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAU,CAAC;AAS1E;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAmC;IAChE,kBAAkB;IAClB,KAAK,EAAE,EAAE,GAAG,MAAM;IAClB,cAAc;IACd,IAAI,EAAE,EAAE,GAAG,MAAM;IACjB,eAAe;IACf,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,MAAM;IACrB,gBAAgB;IAChB,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,MAAM;IACvB,cAAc;IACd,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM;CAC3B,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAmB,IAAI,CAAC;AAE5D;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;AAE3D;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,IAAI,CAAU,CAAC;AAS7D;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAE9C;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,CAAC;AAExC;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,CAAC;AAE/C;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AAS7E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,CAAU,CAAC;AASzD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAC;AASjE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC;AAStF;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,GAAG;IACH,OAAO;IACP,SAAS;IACT,OAAO;IACP,OAAO;IACP,SAAS;IACT,IAAI;IACJ,SAAS;IACT,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,WAAW;IACX,MAAM;IACN,SAAS;CACD,CAAC;AASX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAW,mBAAmB,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAU,CAAC;AAE5G,gFAAgF;AAChF,sDAAsD;AACtD,gFAAgF;AAEhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,KAAK,CAAC;AAEtD;;;;GAIG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,EAAE,CAAC;AAExD;;;;GAIG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,KAAK,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,MAAM,EAAE,WAAW,CAAU,CAAC;AAE7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,aAAa;IACb,gBAAgB;IAChB,WAAW;IACX,iBAAiB;IACjB,iBAAiB;IACjB,WAAW;IACX,kBAAkB;IAClB,eAAe;CACP,CAAC;AASX;;;;GAIG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,aAAa,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,CAAU,CAAC;AASzH;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAU,CAAC;AASrG;;;;GAIG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAU,CAAC"}