@marinoscar/platform-contract 0.0.0-stage → 0.1.0-next.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +33 -0
- package/LICENSE +21 -0
- package/README.md +145 -2
- package/dist/cjs/doctor/constants.d.ts +59 -0
- package/dist/cjs/doctor/constants.d.ts.map +1 -0
- package/dist/cjs/doctor/constants.js +57 -0
- package/dist/cjs/doctor/constants.js.map +1 -0
- package/dist/cjs/doctor/index.d.ts +5 -0
- package/dist/cjs/doctor/index.d.ts.map +1 -0
- package/dist/cjs/doctor/index.js +24 -0
- package/dist/cjs/doctor/index.js.map +1 -0
- package/dist/cjs/doctor/schemas.d.ts +186 -0
- package/dist/cjs/doctor/schemas.d.ts.map +1 -0
- package/dist/cjs/doctor/schemas.js +183 -0
- package/dist/cjs/doctor/schemas.js.map +1 -0
- package/dist/cjs/index.d.ts +13 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +16 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/telemetry/assistant.d.ts +173 -0
- package/dist/cjs/telemetry/assistant.d.ts.map +1 -0
- package/dist/cjs/telemetry/assistant.js +43 -0
- package/dist/cjs/telemetry/assistant.js.map +1 -0
- package/dist/cjs/telemetry/config.d.ts +92 -0
- package/dist/cjs/telemetry/config.d.ts.map +1 -0
- package/dist/cjs/telemetry/config.js +101 -0
- package/dist/cjs/telemetry/config.js.map +1 -0
- package/dist/cjs/telemetry/connection.d.ts +355 -0
- package/dist/cjs/telemetry/connection.d.ts.map +1 -0
- package/dist/cjs/telemetry/connection.js +451 -0
- package/dist/cjs/telemetry/connection.js.map +1 -0
- package/dist/cjs/telemetry/constants.d.ts +442 -0
- package/dist/cjs/telemetry/constants.d.ts.map +1 -0
- package/dist/cjs/telemetry/constants.js +400 -0
- package/dist/cjs/telemetry/constants.js.map +1 -0
- package/dist/cjs/telemetry/dashboard.d.ts +826 -0
- package/dist/cjs/telemetry/dashboard.d.ts.map +1 -0
- package/dist/cjs/telemetry/dashboard.js +697 -0
- package/dist/cjs/telemetry/dashboard.js.map +1 -0
- package/dist/cjs/telemetry/enum.d.ts +5 -0
- package/dist/cjs/telemetry/enum.d.ts.map +1 -0
- package/dist/cjs/telemetry/enum.js +12 -0
- package/dist/cjs/telemetry/enum.js.map +1 -0
- package/dist/cjs/telemetry/index.d.ts +5 -0
- package/dist/cjs/telemetry/index.d.ts.map +1 -0
- package/dist/cjs/telemetry/index.js +128 -0
- package/dist/cjs/telemetry/index.js.map +1 -0
- package/dist/cjs/telemetry/query.d.ts +147 -0
- package/dist/cjs/telemetry/query.d.ts.map +1 -0
- package/dist/cjs/telemetry/query.js +141 -0
- package/dist/cjs/telemetry/query.js.map +1 -0
- package/dist/cjs/telemetry/schemas.d.ts +17 -0
- package/dist/cjs/telemetry/schemas.d.ts.map +1 -0
- package/dist/cjs/telemetry/schemas.js +89 -0
- package/dist/cjs/telemetry/schemas.js.map +1 -0
- package/dist/cjs/telemetry/settings.d.ts +65 -0
- package/dist/cjs/telemetry/settings.d.ts.map +1 -0
- package/dist/cjs/telemetry/settings.js +77 -0
- package/dist/cjs/telemetry/settings.js.map +1 -0
- package/dist/cjs/telemetry/stack.d.ts +87 -0
- package/dist/cjs/telemetry/stack.d.ts.map +1 -0
- package/dist/cjs/telemetry/stack.js +93 -0
- package/dist/cjs/telemetry/stack.js.map +1 -0
- package/dist/cjs/telemetry/status.d.ts +65 -0
- package/dist/cjs/telemetry/status.d.ts.map +1 -0
- package/dist/cjs/telemetry/status.js +65 -0
- package/dist/cjs/telemetry/status.js.map +1 -0
- package/dist/esm/doctor/constants.d.ts +59 -0
- package/dist/esm/doctor/constants.d.ts.map +1 -0
- package/dist/esm/doctor/constants.js +54 -0
- package/dist/esm/doctor/constants.js.map +1 -0
- package/dist/esm/doctor/index.d.ts +5 -0
- package/dist/esm/doctor/index.d.ts.map +1 -0
- package/dist/esm/doctor/index.js +10 -0
- package/dist/esm/doctor/index.js.map +1 -0
- package/dist/esm/doctor/schemas.d.ts +186 -0
- package/dist/esm/doctor/schemas.d.ts.map +1 -0
- package/dist/esm/doctor/schemas.js +180 -0
- package/dist/esm/doctor/schemas.js.map +1 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +13 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/telemetry/assistant.d.ts +173 -0
- package/dist/esm/telemetry/assistant.d.ts.map +1 -0
- package/dist/esm/telemetry/assistant.js +40 -0
- package/dist/esm/telemetry/assistant.js.map +1 -0
- package/dist/esm/telemetry/config.d.ts +92 -0
- package/dist/esm/telemetry/config.d.ts.map +1 -0
- package/dist/esm/telemetry/config.js +98 -0
- package/dist/esm/telemetry/config.js.map +1 -0
- package/dist/esm/telemetry/connection.d.ts +355 -0
- package/dist/esm/telemetry/connection.d.ts.map +1 -0
- package/dist/esm/telemetry/connection.js +447 -0
- package/dist/esm/telemetry/connection.js.map +1 -0
- package/dist/esm/telemetry/constants.d.ts +442 -0
- package/dist/esm/telemetry/constants.d.ts.map +1 -0
- package/dist/esm/telemetry/constants.js +397 -0
- package/dist/esm/telemetry/constants.js.map +1 -0
- package/dist/esm/telemetry/dashboard.d.ts +826 -0
- package/dist/esm/telemetry/dashboard.d.ts.map +1 -0
- package/dist/esm/telemetry/dashboard.js +690 -0
- package/dist/esm/telemetry/dashboard.js.map +1 -0
- package/dist/esm/telemetry/enum.d.ts +5 -0
- package/dist/esm/telemetry/enum.d.ts.map +1 -0
- package/dist/esm/telemetry/enum.js +9 -0
- package/dist/esm/telemetry/enum.js.map +1 -0
- package/dist/esm/telemetry/index.d.ts +5 -0
- package/dist/esm/telemetry/index.d.ts.map +1 -0
- package/dist/esm/telemetry/index.js +10 -0
- package/dist/esm/telemetry/index.js.map +1 -0
- package/dist/esm/telemetry/query.d.ts +147 -0
- package/dist/esm/telemetry/query.d.ts.map +1 -0
- package/dist/esm/telemetry/query.js +138 -0
- package/dist/esm/telemetry/query.js.map +1 -0
- package/dist/esm/telemetry/schemas.d.ts +17 -0
- package/dist/esm/telemetry/schemas.d.ts.map +1 -0
- package/dist/esm/telemetry/schemas.js +12 -0
- package/dist/esm/telemetry/schemas.js.map +1 -0
- package/dist/esm/telemetry/settings.d.ts +65 -0
- package/dist/esm/telemetry/settings.d.ts.map +1 -0
- package/dist/esm/telemetry/settings.js +74 -0
- package/dist/esm/telemetry/settings.js.map +1 -0
- package/dist/esm/telemetry/stack.d.ts +87 -0
- package/dist/esm/telemetry/stack.d.ts.map +1 -0
- package/dist/esm/telemetry/stack.js +90 -0
- package/dist/esm/telemetry/stack.js.map +1 -0
- package/dist/esm/telemetry/status.d.ts +65 -0
- package/dist/esm/telemetry/status.d.ts.map +1 -0
- package/dist/esm/telemetry/status.js +62 -0
- package/dist/esm/telemetry/status.js.map +1 -0
- package/package.json +78 -4
|
@@ -0,0 +1,442 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `telemetry.instanceId`: 1-63 characters, lowercase letters, digits, `.`,
|
|
3
|
+
* `_` or `-`, starting with a letter or digit (a DNS label's bound, valid
|
|
4
|
+
* unquoted in a PromQL matcher and a SQL literal alike).
|
|
5
|
+
*
|
|
6
|
+
* @stability stable
|
|
7
|
+
*/
|
|
8
|
+
export declare const TELEMETRY_INSTANCE_ID_PATTERN: RegExp;
|
|
9
|
+
/**
|
|
10
|
+
* The inclusive bounds of every numeric `telemetry` setting:
|
|
11
|
+
* `retentionDays`, `query.maxRows`, `query.timeoutSeconds`,
|
|
12
|
+
* `assistant.maxResultRowsToModel` and `assistant.maxSteps`. The settings
|
|
13
|
+
* schema is built from these numbers.
|
|
14
|
+
*
|
|
15
|
+
* @stability stable
|
|
16
|
+
*/
|
|
17
|
+
export declare const TELEMETRY_LIMITS: {
|
|
18
|
+
/** `retentionDays`, in days. */
|
|
19
|
+
readonly retentionDays: {
|
|
20
|
+
/** Fewest accepted. */
|
|
21
|
+
readonly min: 1;
|
|
22
|
+
/** Most accepted. */
|
|
23
|
+
readonly max: 3650;
|
|
24
|
+
};
|
|
25
|
+
/** `query.maxRows`, in rows. */
|
|
26
|
+
readonly maxRows: {
|
|
27
|
+
/** Fewest accepted. */
|
|
28
|
+
readonly min: 1;
|
|
29
|
+
/** Most accepted. */
|
|
30
|
+
readonly max: 100000;
|
|
31
|
+
};
|
|
32
|
+
/** `query.timeoutSeconds`, in seconds. */
|
|
33
|
+
readonly timeoutSeconds: {
|
|
34
|
+
/** Fewest accepted. */
|
|
35
|
+
readonly min: 1;
|
|
36
|
+
/** Most accepted. */
|
|
37
|
+
readonly max: 120;
|
|
38
|
+
};
|
|
39
|
+
/** `assistant.maxResultRowsToModel`, in rows. */
|
|
40
|
+
readonly maxResultRowsToModel: {
|
|
41
|
+
/** Fewest accepted. */
|
|
42
|
+
readonly min: 1;
|
|
43
|
+
/** Most accepted. */
|
|
44
|
+
readonly max: 100;
|
|
45
|
+
};
|
|
46
|
+
/** `assistant.maxSteps`, in tool-call rounds (the AI runtime's own loop ceiling). */
|
|
47
|
+
readonly maxSteps: {
|
|
48
|
+
/** Fewest accepted. */
|
|
49
|
+
readonly min: 1;
|
|
50
|
+
/** Most accepted. */
|
|
51
|
+
readonly max: 20;
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* The longest SQL text `POST /api/admin/telemetry/query` and `/export`
|
|
56
|
+
* accept. Telemetry queries are hand-written or model-written, never
|
|
57
|
+
* generated in bulk.
|
|
58
|
+
*
|
|
59
|
+
* @stability stable
|
|
60
|
+
*/
|
|
61
|
+
export declare const TELEMETRY_SQL_MAX_LENGTH = 20000;
|
|
62
|
+
/**
|
|
63
|
+
* The absolute ceiling a query's `maxRows` may ask for; the
|
|
64
|
+
* `telemetry.query.maxRows` setting clamps it further.
|
|
65
|
+
*
|
|
66
|
+
* @stability stable
|
|
67
|
+
*/
|
|
68
|
+
export declare const TELEMETRY_QUERY_MAX_ROWS_CEILING = 100000;
|
|
69
|
+
/**
|
|
70
|
+
* The simplified PostgreSQL-wire type of a query result column. `int8` and
|
|
71
|
+
* `numeric` values arrive as strings, `timestamp`/`date`/`time` as the
|
|
72
|
+
* server's text, `json` parsed and `bytea` as base64.
|
|
73
|
+
*
|
|
74
|
+
* @stability stable
|
|
75
|
+
*/
|
|
76
|
+
export declare const TELEMETRY_COLUMN_TYPES: readonly ["bool", "int2", "int4", "int8", "float4", "float8", "numeric", "text", "bytea", "date", "time", "timestamp", "json", "unknown"];
|
|
77
|
+
/**
|
|
78
|
+
* One of {@link TELEMETRY_COLUMN_TYPES}.
|
|
79
|
+
*
|
|
80
|
+
* @stability stable
|
|
81
|
+
*/
|
|
82
|
+
export type TelemetryColumnType = (typeof TELEMETRY_COLUMN_TYPES)[number];
|
|
83
|
+
/**
|
|
84
|
+
* GreptimeDB's role for a schema column, as `GET /api/admin/telemetry/schema`
|
|
85
|
+
* reports it in `semanticType` (which is typed as a string on the wire).
|
|
86
|
+
*
|
|
87
|
+
* @stability stable
|
|
88
|
+
*/
|
|
89
|
+
export declare const TELEMETRY_SEMANTIC_TYPES: readonly ["TAG", "FIELD", "TIMESTAMP"];
|
|
90
|
+
/**
|
|
91
|
+
* One of {@link TELEMETRY_SEMANTIC_TYPES}.
|
|
92
|
+
*
|
|
93
|
+
* @stability stable
|
|
94
|
+
*/
|
|
95
|
+
export type TelemetrySemanticType = (typeof TELEMETRY_SEMANTIC_TYPES)[number];
|
|
96
|
+
/**
|
|
97
|
+
* The formats `POST /api/admin/telemetry/export` produces, in the order the
|
|
98
|
+
* wire enum has always listed them. A menu that wants another order keeps its
|
|
99
|
+
* own display list over this one.
|
|
100
|
+
*
|
|
101
|
+
* @stability stable
|
|
102
|
+
*/
|
|
103
|
+
export declare const TELEMETRY_EXPORT_FORMATS: readonly ["csv", "ndjson", "xlsx", "parquet"];
|
|
104
|
+
/**
|
|
105
|
+
* One of {@link TELEMETRY_EXPORT_FORMATS}.
|
|
106
|
+
*
|
|
107
|
+
* @stability stable
|
|
108
|
+
*/
|
|
109
|
+
export type TelemetryExportFormat = (typeof TELEMETRY_EXPORT_FORMATS)[number];
|
|
110
|
+
/**
|
|
111
|
+
* Where the connection in force comes from: `stored` (saved on the admin
|
|
112
|
+
* page), `environment` (the deployment's own GreptimeDB) or `none`.
|
|
113
|
+
*
|
|
114
|
+
* @stability stable
|
|
115
|
+
*/
|
|
116
|
+
export declare const TELEMETRY_CONNECTION_SOURCES: readonly ["stored", "environment", "none"];
|
|
117
|
+
/**
|
|
118
|
+
* One of {@link TELEMETRY_CONNECTION_SOURCES}.
|
|
119
|
+
*
|
|
120
|
+
* @stability stable
|
|
121
|
+
*/
|
|
122
|
+
export type TelemetryConnectionSource = (typeof TELEMETRY_CONNECTION_SOURCES)[number];
|
|
123
|
+
/**
|
|
124
|
+
* `auto`: the GreptimeDB deployed with the application; `custom`: a host an
|
|
125
|
+
* administrator chose.
|
|
126
|
+
*
|
|
127
|
+
* @stability stable
|
|
128
|
+
*/
|
|
129
|
+
export declare const TELEMETRY_CONNECTION_HOST_MODES: readonly ["auto", "custom"];
|
|
130
|
+
/**
|
|
131
|
+
* One of {@link TELEMETRY_CONNECTION_HOST_MODES}.
|
|
132
|
+
*
|
|
133
|
+
* @stability stable
|
|
134
|
+
*/
|
|
135
|
+
export type TelemetryConnectionHostMode = (typeof TELEMETRY_CONNECTION_HOST_MODES)[number];
|
|
136
|
+
/**
|
|
137
|
+
* GreptimeDB's Postgres-wire port and database when nothing says otherwise:
|
|
138
|
+
* what a custom connection that omits them gets.
|
|
139
|
+
*
|
|
140
|
+
* @stability stable
|
|
141
|
+
*/
|
|
142
|
+
export declare const TELEMETRY_CONNECTION_DEFAULTS: {
|
|
143
|
+
/** GreptimeDB's Postgres-wire default port. */
|
|
144
|
+
readonly pgPort: 4003;
|
|
145
|
+
/** GreptimeDB's default database. */
|
|
146
|
+
readonly database: "public";
|
|
147
|
+
};
|
|
148
|
+
/**
|
|
149
|
+
* A connection's database name: a plain identifier, because retention
|
|
150
|
+
* interpolates it unquoted into `ALTER DATABASE`.
|
|
151
|
+
*
|
|
152
|
+
* @stability stable
|
|
153
|
+
*/
|
|
154
|
+
export declare const TELEMETRY_DATABASE_PATTERN: RegExp;
|
|
155
|
+
/**
|
|
156
|
+
* A connection's hostname: RFC 1123 labels, plus `_` (Docker Compose service
|
|
157
|
+
* names use it). No scheme, port or path. An IP address is accepted
|
|
158
|
+
* separately.
|
|
159
|
+
*
|
|
160
|
+
* @stability stable
|
|
161
|
+
*/
|
|
162
|
+
export declare const TELEMETRY_HOSTNAME_PATTERN: RegExp;
|
|
163
|
+
/**
|
|
164
|
+
* Whether the API can reach the deployment agent that manages the telemetry
|
|
165
|
+
* containers: `available`, `unavailable` (configured, not reachable),
|
|
166
|
+
* `unauthorized` (it refused the API's token) or `not_configured`.
|
|
167
|
+
*
|
|
168
|
+
* @stability stable
|
|
169
|
+
*/
|
|
170
|
+
export declare const TELEMETRY_STACK_AGENT_STATES: readonly ["available", "unavailable", "unauthorized", "not_configured"];
|
|
171
|
+
/**
|
|
172
|
+
* One of {@link TELEMETRY_STACK_AGENT_STATES}.
|
|
173
|
+
*
|
|
174
|
+
* @stability stable
|
|
175
|
+
*/
|
|
176
|
+
export type TelemetryStackAgentState = (typeof TELEMETRY_STACK_AGENT_STATES)[number];
|
|
177
|
+
/**
|
|
178
|
+
* A telemetry container's state, as the deployment agent reports it;
|
|
179
|
+
* `missing` when it has never been created.
|
|
180
|
+
*
|
|
181
|
+
* @stability stable
|
|
182
|
+
*/
|
|
183
|
+
export declare const TELEMETRY_STACK_SERVICE_STATES: readonly ["running", "restarting", "exited", "created", "paused", "dead", "missing"];
|
|
184
|
+
/**
|
|
185
|
+
* One of {@link TELEMETRY_STACK_SERVICE_STATES}.
|
|
186
|
+
*
|
|
187
|
+
* @stability stable
|
|
188
|
+
*/
|
|
189
|
+
export type TelemetryStackServiceState = (typeof TELEMETRY_STACK_SERVICE_STATES)[number];
|
|
190
|
+
/**
|
|
191
|
+
* A telemetry container's health check result (absent, `null`, when it has
|
|
192
|
+
* none or is not running).
|
|
193
|
+
*
|
|
194
|
+
* @stability stable
|
|
195
|
+
*/
|
|
196
|
+
export declare const TELEMETRY_STACK_SERVICE_HEALTH: readonly ["healthy", "unhealthy", "starting"];
|
|
197
|
+
/**
|
|
198
|
+
* One of {@link TELEMETRY_STACK_SERVICE_HEALTH}.
|
|
199
|
+
*
|
|
200
|
+
* @stability stable
|
|
201
|
+
*/
|
|
202
|
+
export type TelemetryStackServiceHealth = (typeof TELEMETRY_STACK_SERVICE_HEALTH)[number];
|
|
203
|
+
/**
|
|
204
|
+
* The status of the latest stack deploy job: the queue's own statuses.
|
|
205
|
+
*
|
|
206
|
+
* @stability stable
|
|
207
|
+
*/
|
|
208
|
+
export declare const TELEMETRY_STACK_DEPLOY_STATUSES: readonly ["pending", "running", "succeeded", "failed"];
|
|
209
|
+
/**
|
|
210
|
+
* One of {@link TELEMETRY_STACK_DEPLOY_STATUSES}.
|
|
211
|
+
*
|
|
212
|
+
* @stability stable
|
|
213
|
+
*/
|
|
214
|
+
export type TelemetryStackDeployStatus = (typeof TELEMETRY_STACK_DEPLOY_STATUSES)[number];
|
|
215
|
+
/**
|
|
216
|
+
* The relative windows every dashboard route accepts as `range`.
|
|
217
|
+
*
|
|
218
|
+
* @stability stable
|
|
219
|
+
*/
|
|
220
|
+
export declare const DASHBOARD_RANGES: readonly ["15m", "1h", "6h", "24h", "7d"];
|
|
221
|
+
/**
|
|
222
|
+
* One of {@link DASHBOARD_RANGES}.
|
|
223
|
+
*
|
|
224
|
+
* @stability stable
|
|
225
|
+
*/
|
|
226
|
+
export type DashboardRange = (typeof DASHBOARD_RANGES)[number];
|
|
227
|
+
/**
|
|
228
|
+
* The length of each {@link DASHBOARD_RANGES} window, in milliseconds.
|
|
229
|
+
*
|
|
230
|
+
* @stability stable
|
|
231
|
+
*/
|
|
232
|
+
export declare const DASHBOARD_RANGE_MS: Record<DashboardRange, number>;
|
|
233
|
+
/**
|
|
234
|
+
* The window a dashboard route reads when the query names none.
|
|
235
|
+
*
|
|
236
|
+
* @stability stable
|
|
237
|
+
*/
|
|
238
|
+
export declare const DEFAULT_DASHBOARD_RANGE: DashboardRange;
|
|
239
|
+
/**
|
|
240
|
+
* The longest absolute window (`from` to `to`) a dashboard route accepts: 30 days.
|
|
241
|
+
*
|
|
242
|
+
* @stability stable
|
|
243
|
+
*/
|
|
244
|
+
export declare const DASHBOARD_MAX_SPAN_MS: number;
|
|
245
|
+
/**
|
|
246
|
+
* How far past now `to` may be (clock skew between browser and server): 1 minute.
|
|
247
|
+
*
|
|
248
|
+
* @stability stable
|
|
249
|
+
*/
|
|
250
|
+
export declare const DASHBOARD_FUTURE_SKEW_MS = 60000;
|
|
251
|
+
/**
|
|
252
|
+
* The target bucket counts a dashboard route accepts as `buckets` (strings:
|
|
253
|
+
* every query value arrives as one).
|
|
254
|
+
*
|
|
255
|
+
* @stability stable
|
|
256
|
+
*/
|
|
257
|
+
export declare const DASHBOARD_BUCKET_COUNTS: readonly ["30", "60"];
|
|
258
|
+
/**
|
|
259
|
+
* One of {@link DASHBOARD_BUCKET_COUNTS}.
|
|
260
|
+
*
|
|
261
|
+
* @stability stable
|
|
262
|
+
*/
|
|
263
|
+
export type DashboardBucketCount = (typeof DASHBOARD_BUCKET_COUNTS)[number];
|
|
264
|
+
/**
|
|
265
|
+
* The longest `service`, `instance` or `host` filter value.
|
|
266
|
+
*
|
|
267
|
+
* @stability stable
|
|
268
|
+
*/
|
|
269
|
+
export declare const DASHBOARD_FILTER_VALUE_MAX = 200;
|
|
270
|
+
/**
|
|
271
|
+
* The longest `cursor` the events route accepts.
|
|
272
|
+
*
|
|
273
|
+
* @stability stable
|
|
274
|
+
*/
|
|
275
|
+
export declare const DASHBOARD_CURSOR_MAX = 512;
|
|
276
|
+
/**
|
|
277
|
+
* The longest `q` (log body search) the events route accepts.
|
|
278
|
+
*
|
|
279
|
+
* @stability stable
|
|
280
|
+
*/
|
|
281
|
+
export declare const DASHBOARD_SEARCH_MAX_LENGTH = 200;
|
|
282
|
+
/**
|
|
283
|
+
* The severities the events route filters on, in `severity`'s comma list.
|
|
284
|
+
*
|
|
285
|
+
* @stability stable
|
|
286
|
+
*/
|
|
287
|
+
export declare const DASHBOARD_EVENT_SEVERITIES: readonly ["error", "warn", "info"];
|
|
288
|
+
/**
|
|
289
|
+
* One of {@link DASHBOARD_EVENT_SEVERITIES}.
|
|
290
|
+
*
|
|
291
|
+
* @stability stable
|
|
292
|
+
*/
|
|
293
|
+
export type DashboardEventSeverity = (typeof DASHBOARD_EVENT_SEVERITIES)[number];
|
|
294
|
+
/**
|
|
295
|
+
* The `timeseries` route's panels: `api` (status classes, p95) or `logs`
|
|
296
|
+
* (severity bands).
|
|
297
|
+
*
|
|
298
|
+
* @stability stable
|
|
299
|
+
*/
|
|
300
|
+
export declare const DASHBOARD_PANELS: readonly ["api", "logs"];
|
|
301
|
+
/**
|
|
302
|
+
* One of {@link DASHBOARD_PANELS}.
|
|
303
|
+
*
|
|
304
|
+
* @stability stable
|
|
305
|
+
*/
|
|
306
|
+
export type DashboardPanel = (typeof DASHBOARD_PANELS)[number];
|
|
307
|
+
/**
|
|
308
|
+
* The `top` route's kinds: `routes` (by 5xx, then 4xx except 401, then p95)
|
|
309
|
+
* or `errors` (log messages).
|
|
310
|
+
*
|
|
311
|
+
* @stability stable
|
|
312
|
+
*/
|
|
313
|
+
export declare const DASHBOARD_TOP_KINDS: readonly ["routes", "errors"];
|
|
314
|
+
/**
|
|
315
|
+
* One of {@link DASHBOARD_TOP_KINDS}.
|
|
316
|
+
*
|
|
317
|
+
* @stability stable
|
|
318
|
+
*/
|
|
319
|
+
export type DashboardTopKind = (typeof DASHBOARD_TOP_KINDS)[number];
|
|
320
|
+
/**
|
|
321
|
+
* The summary's overall verdict levels, in increasing severity, `no_data`
|
|
322
|
+
* last.
|
|
323
|
+
*
|
|
324
|
+
* @stability stable
|
|
325
|
+
*/
|
|
326
|
+
export declare const VERDICT_LEVELS: readonly ["healthy", "degraded", "critical", "no_data"];
|
|
327
|
+
/**
|
|
328
|
+
* One of {@link VERDICT_LEVELS}.
|
|
329
|
+
*
|
|
330
|
+
* @stability stable
|
|
331
|
+
*/
|
|
332
|
+
export type VerdictLevel = (typeof VERDICT_LEVELS)[number];
|
|
333
|
+
/**
|
|
334
|
+
* The display units of metric tiles, series and table columns (`/metrics`).
|
|
335
|
+
*
|
|
336
|
+
* @stability stable
|
|
337
|
+
*/
|
|
338
|
+
export declare const METRIC_UNITS: readonly ["%", "bytes", "bytes/s", "count", "per_s", "per_min", "ms", "seconds", "hours", "days", "cores", "load", "timestamp", "text", "boolean"];
|
|
339
|
+
/**
|
|
340
|
+
* One of {@link METRIC_UNITS}.
|
|
341
|
+
*
|
|
342
|
+
* @stability stable
|
|
343
|
+
*/
|
|
344
|
+
export type MetricUnit = (typeof METRIC_UNITS)[number];
|
|
345
|
+
/**
|
|
346
|
+
* The pattern every metric group id matches (lower snake case). Group ids are
|
|
347
|
+
* an open set: the platform registers six, an app may register more.
|
|
348
|
+
*
|
|
349
|
+
* @stability stable
|
|
350
|
+
*/
|
|
351
|
+
export declare const METRIC_GROUP_ID_PATTERN: RegExp;
|
|
352
|
+
/**
|
|
353
|
+
* The metric groups the platform itself registers, in dashboard order. The
|
|
354
|
+
* live set is whatever `GET /api/admin/telemetry/dashboard/metric-groups`
|
|
355
|
+
* lists.
|
|
356
|
+
*
|
|
357
|
+
* @stability stable
|
|
358
|
+
*/
|
|
359
|
+
export declare const PLATFORM_METRIC_GROUPS: readonly ["host", "database", "queue", "nodes", "uptime", "pipeline"];
|
|
360
|
+
/**
|
|
361
|
+
* The longest question the assistant accepts, in characters (after trimming).
|
|
362
|
+
*
|
|
363
|
+
* @stability stable
|
|
364
|
+
*/
|
|
365
|
+
export declare const TELEMETRY_ASSISTANT_QUESTION_MAX = 4000;
|
|
366
|
+
/**
|
|
367
|
+
* The most earlier turns a request may carry in `history`.
|
|
368
|
+
*
|
|
369
|
+
* @stability stable
|
|
370
|
+
*/
|
|
371
|
+
export declare const TELEMETRY_ASSISTANT_HISTORY_MAX_TURNS = 20;
|
|
372
|
+
/**
|
|
373
|
+
* The longest `content` of one `history` turn, in characters.
|
|
374
|
+
*
|
|
375
|
+
* @stability stable
|
|
376
|
+
*/
|
|
377
|
+
export declare const TELEMETRY_ASSISTANT_HISTORY_CONTENT_MAX = 8000;
|
|
378
|
+
/**
|
|
379
|
+
* Who wrote a `history` turn.
|
|
380
|
+
*
|
|
381
|
+
* @stability stable
|
|
382
|
+
*/
|
|
383
|
+
export declare const TELEMETRY_ASSISTANT_TURN_ROLES: readonly ["user", "assistant"];
|
|
384
|
+
/**
|
|
385
|
+
* The tools the assistant may call; each `step` event names one.
|
|
386
|
+
*
|
|
387
|
+
* @stability stable
|
|
388
|
+
*/
|
|
389
|
+
export declare const TELEMETRY_ASSISTANT_TOOLS: readonly ["list_tables", "describe_table", "run_query", "get_app_context", "health_overview", "get_trace", "metrics_overview", "compare_nodes"];
|
|
390
|
+
/**
|
|
391
|
+
* One of {@link TELEMETRY_ASSISTANT_TOOLS}.
|
|
392
|
+
*
|
|
393
|
+
* @stability stable
|
|
394
|
+
*/
|
|
395
|
+
export type TelemetryAssistantToolName = (typeof TELEMETRY_ASSISTANT_TOOLS)[number];
|
|
396
|
+
/**
|
|
397
|
+
* The outcome of an investigation, in its report's `status`.
|
|
398
|
+
*
|
|
399
|
+
* @stability stable
|
|
400
|
+
*/
|
|
401
|
+
export declare const TELEMETRY_ASSISTANT_REPORT_STATUSES: readonly ["issue_found", "no_issue_found", "inconclusive", "no_data"];
|
|
402
|
+
/**
|
|
403
|
+
* One of {@link TELEMETRY_ASSISTANT_REPORT_STATUSES}.
|
|
404
|
+
*
|
|
405
|
+
* @stability stable
|
|
406
|
+
*/
|
|
407
|
+
export type TelemetryAssistantReportStatus = (typeof TELEMETRY_ASSISTANT_REPORT_STATUSES)[number];
|
|
408
|
+
/**
|
|
409
|
+
* A report finding's severity, most severe first.
|
|
410
|
+
*
|
|
411
|
+
* @stability stable
|
|
412
|
+
*/
|
|
413
|
+
export declare const TELEMETRY_ASSISTANT_SEVERITIES: readonly ["critical", "high", "medium", "low", "info"];
|
|
414
|
+
/**
|
|
415
|
+
* One of {@link TELEMETRY_ASSISTANT_SEVERITIES}.
|
|
416
|
+
*
|
|
417
|
+
* @stability stable
|
|
418
|
+
*/
|
|
419
|
+
export type TelemetryAssistantSeverity = (typeof TELEMETRY_ASSISTANT_SEVERITIES)[number];
|
|
420
|
+
/**
|
|
421
|
+
* How sure a report is of its root cause.
|
|
422
|
+
*
|
|
423
|
+
* @stability stable
|
|
424
|
+
*/
|
|
425
|
+
export declare const TELEMETRY_ASSISTANT_CONFIDENCES: readonly ["high", "medium", "low"];
|
|
426
|
+
/**
|
|
427
|
+
* One of {@link TELEMETRY_ASSISTANT_CONFIDENCES}.
|
|
428
|
+
*
|
|
429
|
+
* @stability stable
|
|
430
|
+
*/
|
|
431
|
+
export type TelemetryAssistantConfidence = (typeof TELEMETRY_ASSISTANT_CONFIDENCES)[number];
|
|
432
|
+
/**
|
|
433
|
+
* The entries of a telemetry enum schema, as `z.enum` types them: each value
|
|
434
|
+
* keyed by itself (`TelemetryEnumEntries<DashboardRange>` is
|
|
435
|
+
* `{ '15m': '15m', … }`). Named so a schema's type reads as a reference.
|
|
436
|
+
*
|
|
437
|
+
* @stability stable
|
|
438
|
+
*/
|
|
439
|
+
export type TelemetryEnumEntries<T extends string> = {
|
|
440
|
+
[K in T]: K;
|
|
441
|
+
};
|
|
442
|
+
//# sourceMappingURL=constants.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/telemetry/constants.ts"],"names":[],"mappings":"AAaA;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B,EAAE,MAAsC,CAAC;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB;IAC3B,gCAAgC;;QAE9B,uBAAuB;;QAEvB,qBAAqB;;;IAGvB,gCAAgC;;QAE9B,uBAAuB;;QAEvB,qBAAqB;;;IAGvB,0CAA0C;;QAExC,uBAAuB;;QAEvB,qBAAqB;;;IAGvB,iDAAiD;;QAE/C,uBAAuB;;QAEvB,qBAAqB;;;IAGvB,qFAAqF;;QAEnF,uBAAuB;;QAEvB,qBAAqB;;;CAGf,CAAC;AAMX;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,QAAS,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,SAAU,CAAC;AAExD;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,2IAezB,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,wCAAyC,CAAC;AAE/E;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9E;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,+CAAgD,CAAC;AAEtF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAM9E;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,4CAA6C,CAAC;AAEvF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtF;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,6BAA8B,CAAC;AAE3E;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,OAAO,+BAA+B,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3F;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B;IACxC,+CAA+C;;IAE/C,qCAAqC;;CAE7B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,EAAE,MAAmC,CAAC;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,EAAE,MACoE,CAAC;AAM9G;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,yEAA0E,CAAC;AAEpH;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,CAAC,CAAC;AAErF;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,sFAQjC,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,8BAA8B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,+CAAgD,CAAC;AAE5F;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,OAAO,8BAA8B,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1F;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,wDAAyD,CAAC;AAEtG;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,+BAA+B,CAAC,CAAC,MAAM,CAAC,CAAC;AAM1F;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,2CAA4C,CAAC;AAE1E;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,CAW7D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,cAAqB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,QAAwB,CAAC;AAE3D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,QAAS,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,uBAAwB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,MAAM,CAAC;AAE/C;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,oCAAqC,CAAC;AAE7E;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,0BAA2B,CAAC;AAEzD;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,+BAAgC,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,cAAc,yDAA0D,CAAC;AAEtF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D;;;;GAIG;AACH,eAAO,MAAM,YAAY,oJAgBf,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAA4B,CAAC;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,uEAAwE,CAAC;AAM5G;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,OAAQ,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,qCAAqC,KAAK,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,uCAAuC,OAAQ,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,gCAAiC,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,iJAS5B,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpF;;;;GAIG;AACH,eAAO,MAAM,mCAAmC,uEAAwE,CAAC;AAEzH;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,OAAO,mCAAmC,CAAC,CAAC,MAAM,CAAC,CAAC;AAElG;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,wDAAyD,CAAC;AAErG;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,8BAA8B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzF;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,oCAAqC,CAAC;AAElF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,OAAO,+BAA+B,CAAC,CAAC,MAAM,CAAC,CAAC;AAM5F;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI;KAAG,CAAC,IAAI,CAAC,GAAG,CAAC;CAAE,CAAC"}
|