@platformatic/nitro 3.73.0-alpha.0 → 4.0.0-alpha.2
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/config.d.ts +759 -825
- package/eslint.config.js +3 -5
- package/index.d.ts +8 -1
- package/index.js +9 -9
- package/lib/capability.js +28 -41
- package/lib/factory.js +12 -0
- package/lib/schema.js +7 -3
- package/package.json +14 -13
- package/schema.js +7 -0
- package/schema.json +180 -390
package/config.d.ts
CHANGED
|
@@ -5,909 +5,843 @@
|
|
|
5
5
|
* and run json-schema-to-typescript to regenerate this file.
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
+
export type ApplicationEntry = {
|
|
9
|
+
[k: string]: unknown;
|
|
10
|
+
};
|
|
11
|
+
|
|
8
12
|
export interface PlatformaticNitroConfig {
|
|
9
13
|
$schema?: string;
|
|
10
14
|
module?: string;
|
|
11
|
-
logger?:
|
|
15
|
+
logger?: AppLoggerOptions;
|
|
16
|
+
server?: AppServerOptions;
|
|
17
|
+
watch?: WatchOptions | boolean | string;
|
|
18
|
+
application?: BuildableApplicationOptions;
|
|
19
|
+
runtime?: {
|
|
20
|
+
preload?: string | string[];
|
|
21
|
+
extensions?: string | ExtensionEntry | (string | ExtensionEntry1)[];
|
|
22
|
+
basePath?: string;
|
|
23
|
+
services?: ApplicationEntry[];
|
|
24
|
+
workers?: number | string | WorkersOptions;
|
|
25
|
+
workersRestartDelay?: number | string;
|
|
26
|
+
logger?: AppLoggerOptions1;
|
|
27
|
+
reuseTcpPorts?: boolean;
|
|
28
|
+
startTimeout?: number;
|
|
29
|
+
restartOnError?: boolean | number;
|
|
30
|
+
exitOnUnhandledErrors?: boolean | number;
|
|
31
|
+
gracefulShutdown?: GracefulShutdownOptions;
|
|
32
|
+
health?: HealthOptions;
|
|
33
|
+
healthProbes?: boolean | string | HealthProbesOptions;
|
|
34
|
+
undici?: UndiciOptions;
|
|
35
|
+
httpCache?: boolean | HttpCacheOptions;
|
|
36
|
+
watch?: boolean | string;
|
|
37
|
+
managementApi?: boolean | string | ManagementApiOptions;
|
|
38
|
+
management?:
|
|
39
|
+
| boolean
|
|
40
|
+
| {
|
|
41
|
+
enabled?: boolean;
|
|
42
|
+
operations?: string[];
|
|
43
|
+
};
|
|
44
|
+
metrics?: boolean | MetricsOptions;
|
|
45
|
+
tracing?: TelemetryOptions;
|
|
46
|
+
inspectorOptions?: {
|
|
47
|
+
host?: string;
|
|
48
|
+
port?: number;
|
|
49
|
+
breakFirstLine?: boolean;
|
|
50
|
+
watchDisabled?: boolean;
|
|
51
|
+
[k: string]: unknown;
|
|
52
|
+
};
|
|
53
|
+
applicationTimeout?: number | string;
|
|
54
|
+
startupConcurrency?: number | string;
|
|
55
|
+
messagingTimeout?: number | string;
|
|
56
|
+
env?: {
|
|
57
|
+
[k: string]: string;
|
|
58
|
+
};
|
|
59
|
+
envfile?: string;
|
|
12
60
|
/**
|
|
13
|
-
*
|
|
61
|
+
* When set to true, the configuration loading fails if a {PLT_*} placeholder references an environment variable which is not set. When set to "warn", a warning listing the missing variables is logged but the placeholders are still replaced with an empty string. Defaults to false.
|
|
14
62
|
*/
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
63
|
+
strictEnv?: boolean | string;
|
|
64
|
+
sourceMaps?: boolean;
|
|
65
|
+
nodeModulesSourceMaps?: string[];
|
|
66
|
+
policies?: {
|
|
67
|
+
deny: {
|
|
68
|
+
/**
|
|
69
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
70
|
+
* via the `patternProperty` "^.*$".
|
|
71
|
+
*/
|
|
72
|
+
[k: string]: string | [string, ...string[]];
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
compileCache?: boolean | CompileCacheOptions;
|
|
76
|
+
application?: {
|
|
77
|
+
reuseTcpPorts?: boolean;
|
|
78
|
+
workers?: number | string | ApplicationWorkersOptions;
|
|
79
|
+
health?: ApplicationHealthOptions;
|
|
80
|
+
/**
|
|
81
|
+
* Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.
|
|
82
|
+
*/
|
|
83
|
+
restartOnError?: boolean | number;
|
|
84
|
+
arguments?: string[];
|
|
85
|
+
env?: {
|
|
86
|
+
[k: string]: string;
|
|
87
|
+
};
|
|
88
|
+
envfile?: string;
|
|
89
|
+
sourceMaps?: boolean;
|
|
90
|
+
nodeModulesSourceMaps?: string[];
|
|
91
|
+
packageManager?: "npm" | "pnpm" | "yarn";
|
|
92
|
+
preload?: string | string[];
|
|
93
|
+
nodeOptions?: string;
|
|
94
|
+
execArgv?: string[];
|
|
95
|
+
permissions?: PermissionsOptions;
|
|
96
|
+
tracing?: ApplicationTelemetryOverrides;
|
|
97
|
+
compileCache?: boolean | CompileCacheOptions1;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
vite?: {
|
|
101
|
+
configFile?: string | boolean;
|
|
102
|
+
devServer?: {
|
|
103
|
+
strict?: boolean;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
nitro?: {
|
|
107
|
+
outputDirectory?: string;
|
|
108
|
+
entrypoint?: string;
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
export interface AppLoggerOptions {
|
|
112
|
+
/**
|
|
113
|
+
* A standard Pino log level or a level defined in customLevels.
|
|
114
|
+
*/
|
|
115
|
+
level?: string;
|
|
116
|
+
transport?:
|
|
117
|
+
| {
|
|
118
|
+
target?: string;
|
|
119
|
+
options?: {
|
|
120
|
+
[k: string]: unknown;
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
| {
|
|
124
|
+
targets?: {
|
|
18
125
|
target?: string;
|
|
19
126
|
options?: {
|
|
20
127
|
[k: string]: unknown;
|
|
21
128
|
};
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
129
|
+
level?: string;
|
|
130
|
+
}[];
|
|
131
|
+
options?: {
|
|
132
|
+
[k: string]: unknown;
|
|
133
|
+
};
|
|
134
|
+
};
|
|
135
|
+
pipeline?: {
|
|
136
|
+
target?: string;
|
|
137
|
+
options?: {
|
|
138
|
+
[k: string]: unknown;
|
|
139
|
+
};
|
|
140
|
+
};
|
|
141
|
+
formatters?: {
|
|
142
|
+
path: string;
|
|
143
|
+
};
|
|
144
|
+
timestamp?: "epochTime" | "unixTime" | "nullTime" | "isoTime";
|
|
145
|
+
redact?: {
|
|
146
|
+
paths: string[];
|
|
147
|
+
censor?: string;
|
|
148
|
+
/**
|
|
149
|
+
* Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false.
|
|
150
|
+
*/
|
|
151
|
+
remove?: boolean;
|
|
152
|
+
};
|
|
153
|
+
base?: {
|
|
154
|
+
[k: string]: unknown;
|
|
155
|
+
} | null;
|
|
156
|
+
messageKey?: string;
|
|
157
|
+
customLevels?: {
|
|
158
|
+
[k: string]: unknown;
|
|
159
|
+
};
|
|
160
|
+
/**
|
|
161
|
+
* The numeric value of the level defined in level, when it is not one of the standard pino levels.
|
|
162
|
+
*/
|
|
163
|
+
levelVal?: number;
|
|
164
|
+
/**
|
|
165
|
+
* Only use the levels defined in customLevels and omit the standard pino ones.
|
|
166
|
+
*/
|
|
167
|
+
useOnlyCustomLevels?: boolean;
|
|
168
|
+
/**
|
|
169
|
+
* How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC.
|
|
170
|
+
*/
|
|
171
|
+
levelComparison?: "ASC" | "DESC";
|
|
172
|
+
/**
|
|
173
|
+
* A string prefixed to every message, including the ones of child loggers.
|
|
174
|
+
*/
|
|
175
|
+
msgPrefix?: string;
|
|
176
|
+
/**
|
|
177
|
+
* The key under which any logged object is placed.
|
|
178
|
+
*/
|
|
179
|
+
nestedKey?: string;
|
|
180
|
+
/**
|
|
181
|
+
* The key used for the serialized error in the log object. Defaults to err.
|
|
182
|
+
*/
|
|
183
|
+
errorKey?: string;
|
|
184
|
+
/**
|
|
185
|
+
* The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5.
|
|
186
|
+
*/
|
|
187
|
+
depthLimit?: number;
|
|
188
|
+
/**
|
|
189
|
+
* The stringification limit of properties or elements when logging a circular object or array. Defaults to 100.
|
|
190
|
+
*/
|
|
191
|
+
edgeLimit?: number;
|
|
192
|
+
/**
|
|
193
|
+
* Terminate each log line with \r\n instead of \n. Defaults to false.
|
|
194
|
+
*/
|
|
195
|
+
crlf?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* Set to false to disable logging entirely. Defaults to true.
|
|
198
|
+
*/
|
|
199
|
+
enabled?: boolean;
|
|
200
|
+
openTelemetryExporter?: {
|
|
201
|
+
protocol: "grpc" | "http";
|
|
202
|
+
url: string;
|
|
203
|
+
};
|
|
204
|
+
[k: string]: unknown;
|
|
205
|
+
}
|
|
206
|
+
export interface AppServerOptions {
|
|
207
|
+
hostname?: string;
|
|
208
|
+
port?: number | string;
|
|
209
|
+
/**
|
|
210
|
+
* Configures how the port is assigned when the application runs multiple workers. When set to shared (the default), all workers listen on the same port (which requires SO_REUSEPORT support). When set to perWorkerIncrement, each worker listens on its own port, starting from port (worker 0) and incrementing by one for each additional worker.
|
|
211
|
+
*/
|
|
212
|
+
portAssignment?: "shared" | "perWorkerIncrement";
|
|
213
|
+
/**
|
|
214
|
+
* The maximum length of the queue of pending connections
|
|
215
|
+
*/
|
|
216
|
+
backlog?: number;
|
|
217
|
+
https?: HttpsOptions;
|
|
218
|
+
}
|
|
219
|
+
export interface HttpsOptions {
|
|
220
|
+
allowHTTP1?: boolean;
|
|
221
|
+
key:
|
|
222
|
+
| string
|
|
223
|
+
| {
|
|
224
|
+
path?: string;
|
|
225
|
+
}
|
|
226
|
+
| (
|
|
227
|
+
| string
|
|
228
|
+
| {
|
|
229
|
+
path?: string;
|
|
230
|
+
}
|
|
231
|
+
)[];
|
|
232
|
+
cert:
|
|
233
|
+
| string
|
|
234
|
+
| {
|
|
235
|
+
path?: string;
|
|
236
|
+
}
|
|
237
|
+
| (
|
|
238
|
+
| string
|
|
239
|
+
| {
|
|
240
|
+
path?: string;
|
|
241
|
+
}
|
|
242
|
+
)[];
|
|
243
|
+
requestCert?: boolean;
|
|
244
|
+
rejectUnauthorized?: boolean;
|
|
245
|
+
}
|
|
246
|
+
export interface WatchOptions {
|
|
247
|
+
enabled?: boolean | string;
|
|
248
|
+
/**
|
|
249
|
+
* @minItems 1
|
|
250
|
+
*/
|
|
251
|
+
allow?: [string, ...string[]];
|
|
252
|
+
ignore?: string[];
|
|
253
|
+
}
|
|
254
|
+
export interface BuildableApplicationOptions {
|
|
255
|
+
basePath?: string;
|
|
256
|
+
outputDirectory?: string;
|
|
257
|
+
include?: string[];
|
|
258
|
+
commands?: {
|
|
259
|
+
install?: string;
|
|
260
|
+
build?: string;
|
|
261
|
+
development?: string;
|
|
262
|
+
production?: string;
|
|
263
|
+
};
|
|
264
|
+
changeDirectoryBeforeExecution?: boolean;
|
|
265
|
+
preferLocalCommands?: boolean;
|
|
266
|
+
processSpawner?: string;
|
|
267
|
+
}
|
|
268
|
+
export interface ExtensionEntry {
|
|
269
|
+
path: string;
|
|
270
|
+
options?: {
|
|
271
|
+
[k: string]: unknown;
|
|
272
|
+
};
|
|
273
|
+
build?: boolean;
|
|
274
|
+
}
|
|
275
|
+
export interface ExtensionEntry1 {
|
|
276
|
+
path: string;
|
|
277
|
+
options?: {
|
|
278
|
+
[k: string]: unknown;
|
|
279
|
+
};
|
|
280
|
+
build?: boolean;
|
|
281
|
+
}
|
|
282
|
+
export interface WorkersOptions {
|
|
283
|
+
static?: number;
|
|
284
|
+
dynamic?: boolean;
|
|
285
|
+
minimum?: number;
|
|
286
|
+
maximum?: number;
|
|
287
|
+
total?: number;
|
|
288
|
+
maxMemory?: number;
|
|
289
|
+
eluThreshold?: number;
|
|
290
|
+
heapThresholdMb?: number;
|
|
291
|
+
processIntervalMs?: number;
|
|
292
|
+
maxScaleUpStep?: number;
|
|
293
|
+
redistributionMs?: number;
|
|
294
|
+
alphaUp?: number;
|
|
295
|
+
alphaDown?: number;
|
|
296
|
+
betaUp?: number;
|
|
297
|
+
betaDown?: number;
|
|
298
|
+
cooldowns?: {
|
|
299
|
+
scaleUpAfterScaleUpMs?: number;
|
|
300
|
+
scaleUpAfterScaleDownMs?: number;
|
|
301
|
+
scaleDownAfterScaleUpMs?: number;
|
|
302
|
+
scaleDownAfterScaleDownMs?: number;
|
|
303
|
+
};
|
|
304
|
+
}
|
|
305
|
+
export interface AppLoggerOptions1 {
|
|
306
|
+
/**
|
|
307
|
+
* A standard Pino log level or a level defined in customLevels.
|
|
308
|
+
*/
|
|
309
|
+
level?: string;
|
|
310
|
+
transport?:
|
|
311
|
+
| {
|
|
312
|
+
target?: string;
|
|
313
|
+
options?: {
|
|
314
|
+
[k: string]: unknown;
|
|
315
|
+
};
|
|
316
|
+
}
|
|
317
|
+
| {
|
|
318
|
+
targets?: {
|
|
319
|
+
target?: string;
|
|
31
320
|
options?: {
|
|
32
321
|
[k: string]: unknown;
|
|
33
322
|
};
|
|
323
|
+
level?: string;
|
|
324
|
+
}[];
|
|
325
|
+
options?: {
|
|
326
|
+
[k: string]: unknown;
|
|
34
327
|
};
|
|
35
|
-
pipeline?: {
|
|
36
|
-
target?: string;
|
|
37
|
-
options?: {
|
|
38
|
-
[k: string]: unknown;
|
|
39
328
|
};
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
};
|
|
44
|
-
timestamp?: "epochTime" | "unixTime" | "nullTime" | "isoTime";
|
|
45
|
-
redact?: {
|
|
46
|
-
paths: string[];
|
|
47
|
-
censor?: string;
|
|
48
|
-
/**
|
|
49
|
-
* Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false.
|
|
50
|
-
*/
|
|
51
|
-
remove?: boolean;
|
|
52
|
-
};
|
|
53
|
-
base?: {
|
|
54
|
-
[k: string]: unknown;
|
|
55
|
-
} | null;
|
|
56
|
-
messageKey?: string;
|
|
57
|
-
customLevels?: {
|
|
329
|
+
pipeline?: {
|
|
330
|
+
target?: string;
|
|
331
|
+
options?: {
|
|
58
332
|
[k: string]: unknown;
|
|
59
333
|
};
|
|
334
|
+
};
|
|
335
|
+
formatters?: {
|
|
336
|
+
path: string;
|
|
337
|
+
};
|
|
338
|
+
timestamp?: "epochTime" | "unixTime" | "nullTime" | "isoTime";
|
|
339
|
+
redact?: {
|
|
340
|
+
paths: string[];
|
|
341
|
+
censor?: string;
|
|
60
342
|
/**
|
|
61
|
-
*
|
|
343
|
+
* Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false.
|
|
62
344
|
*/
|
|
63
|
-
|
|
345
|
+
remove?: boolean;
|
|
346
|
+
};
|
|
347
|
+
base?: {
|
|
348
|
+
[k: string]: unknown;
|
|
349
|
+
} | null;
|
|
350
|
+
messageKey?: string;
|
|
351
|
+
customLevels?: {
|
|
352
|
+
[k: string]: unknown;
|
|
353
|
+
};
|
|
354
|
+
/**
|
|
355
|
+
* The numeric value of the level defined in level, when it is not one of the standard pino levels.
|
|
356
|
+
*/
|
|
357
|
+
levelVal?: number;
|
|
358
|
+
/**
|
|
359
|
+
* Only use the levels defined in customLevels and omit the standard pino ones.
|
|
360
|
+
*/
|
|
361
|
+
useOnlyCustomLevels?: boolean;
|
|
362
|
+
/**
|
|
363
|
+
* How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC.
|
|
364
|
+
*/
|
|
365
|
+
levelComparison?: "ASC" | "DESC";
|
|
366
|
+
/**
|
|
367
|
+
* A string prefixed to every message, including the ones of child loggers.
|
|
368
|
+
*/
|
|
369
|
+
msgPrefix?: string;
|
|
370
|
+
/**
|
|
371
|
+
* The key under which any logged object is placed.
|
|
372
|
+
*/
|
|
373
|
+
nestedKey?: string;
|
|
374
|
+
/**
|
|
375
|
+
* The key used for the serialized error in the log object. Defaults to err.
|
|
376
|
+
*/
|
|
377
|
+
errorKey?: string;
|
|
378
|
+
/**
|
|
379
|
+
* The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5.
|
|
380
|
+
*/
|
|
381
|
+
depthLimit?: number;
|
|
382
|
+
/**
|
|
383
|
+
* The stringification limit of properties or elements when logging a circular object or array. Defaults to 100.
|
|
384
|
+
*/
|
|
385
|
+
edgeLimit?: number;
|
|
386
|
+
/**
|
|
387
|
+
* Terminate each log line with \r\n instead of \n. Defaults to false.
|
|
388
|
+
*/
|
|
389
|
+
crlf?: boolean;
|
|
390
|
+
/**
|
|
391
|
+
* Set to false to disable logging entirely. Defaults to true.
|
|
392
|
+
*/
|
|
393
|
+
enabled?: boolean;
|
|
394
|
+
openTelemetryExporter?: {
|
|
395
|
+
protocol: "grpc" | "http";
|
|
396
|
+
url: string;
|
|
397
|
+
};
|
|
398
|
+
[k: string]: unknown;
|
|
399
|
+
}
|
|
400
|
+
export interface GracefulShutdownOptions {
|
|
401
|
+
runtime: number | string;
|
|
402
|
+
application: number | string;
|
|
403
|
+
/**
|
|
404
|
+
* Add Connection: close header to HTTP responses during graceful shutdown
|
|
405
|
+
*/
|
|
406
|
+
closeConnections?: boolean;
|
|
407
|
+
}
|
|
408
|
+
export interface HealthOptions {
|
|
409
|
+
enabled?: boolean | string;
|
|
410
|
+
interval?: number | string;
|
|
411
|
+
gracePeriod?: number | string;
|
|
412
|
+
maxUnhealthyChecks?: number | string;
|
|
413
|
+
maxELU?: number | string;
|
|
414
|
+
maxEventLoopDelay?: number | string;
|
|
415
|
+
maxEventLoopDelayP99?: number | string;
|
|
416
|
+
maxHeapUsed?: number | string;
|
|
417
|
+
maxHeapTotal?: number | string;
|
|
418
|
+
maxYoungGeneration?: number | string;
|
|
419
|
+
codeRangeSize?: number | string;
|
|
420
|
+
bufferPoolSize?: number | string;
|
|
421
|
+
defaultHighWaterMark?: number | string;
|
|
422
|
+
}
|
|
423
|
+
export interface HealthProbesOptions {
|
|
424
|
+
enabled?: boolean | string;
|
|
425
|
+
hostname?: string;
|
|
426
|
+
port?: number | string;
|
|
427
|
+
readiness?:
|
|
428
|
+
| boolean
|
|
429
|
+
| {
|
|
430
|
+
endpoint?: string;
|
|
431
|
+
success?: {
|
|
432
|
+
statusCode?: number;
|
|
433
|
+
body?: string;
|
|
434
|
+
};
|
|
435
|
+
fail?: {
|
|
436
|
+
statusCode?: number;
|
|
437
|
+
body?: string;
|
|
438
|
+
};
|
|
439
|
+
};
|
|
440
|
+
liveness?:
|
|
441
|
+
| boolean
|
|
442
|
+
| {
|
|
443
|
+
endpoint?: string;
|
|
444
|
+
success?: {
|
|
445
|
+
statusCode?: number;
|
|
446
|
+
body?: string;
|
|
447
|
+
};
|
|
448
|
+
fail?: {
|
|
449
|
+
statusCode?: number;
|
|
450
|
+
body?: string;
|
|
451
|
+
};
|
|
452
|
+
};
|
|
453
|
+
}
|
|
454
|
+
export interface UndiciOptions {
|
|
455
|
+
agentOptions?: {
|
|
456
|
+
[k: string]: unknown;
|
|
457
|
+
};
|
|
458
|
+
interceptors?:
|
|
459
|
+
| {
|
|
460
|
+
module: string;
|
|
461
|
+
options: {
|
|
462
|
+
[k: string]: unknown;
|
|
463
|
+
};
|
|
464
|
+
[k: string]: unknown;
|
|
465
|
+
}[]
|
|
466
|
+
| {
|
|
467
|
+
Client?: {
|
|
468
|
+
module: string;
|
|
469
|
+
options: {
|
|
470
|
+
[k: string]: unknown;
|
|
471
|
+
};
|
|
472
|
+
[k: string]: unknown;
|
|
473
|
+
}[];
|
|
474
|
+
Pool?: {
|
|
475
|
+
module: string;
|
|
476
|
+
options: {
|
|
477
|
+
[k: string]: unknown;
|
|
478
|
+
};
|
|
479
|
+
[k: string]: unknown;
|
|
480
|
+
}[];
|
|
481
|
+
Agent?: {
|
|
482
|
+
module: string;
|
|
483
|
+
options: {
|
|
484
|
+
[k: string]: unknown;
|
|
485
|
+
};
|
|
486
|
+
[k: string]: unknown;
|
|
487
|
+
}[];
|
|
488
|
+
[k: string]: unknown;
|
|
489
|
+
};
|
|
490
|
+
[k: string]: unknown;
|
|
491
|
+
}
|
|
492
|
+
export interface HttpCacheOptions {
|
|
493
|
+
store?: string;
|
|
494
|
+
/**
|
|
495
|
+
* @minItems 1
|
|
496
|
+
*/
|
|
497
|
+
methods?: [string, ...string[]];
|
|
498
|
+
cacheTagsHeader?: string;
|
|
499
|
+
maxSize?: number;
|
|
500
|
+
maxEntrySize?: number;
|
|
501
|
+
maxCount?: number;
|
|
502
|
+
/**
|
|
503
|
+
* Whitelist of origins to cache. Supports exact strings and regex patterns (e.g., "/https:\\/\\/.*\\.example\\.com/").
|
|
504
|
+
*/
|
|
505
|
+
origins?: string[];
|
|
506
|
+
/**
|
|
507
|
+
* Default cache duration in seconds for responses without explicit expiration headers.
|
|
508
|
+
*/
|
|
509
|
+
cacheByDefault?: number;
|
|
510
|
+
/**
|
|
511
|
+
* Cache type. "shared" caches may be shared between users, "private" caches are user-specific.
|
|
512
|
+
*/
|
|
513
|
+
type?: "shared" | "private";
|
|
514
|
+
[k: string]: unknown;
|
|
515
|
+
}
|
|
516
|
+
export interface ManagementApiOptions {
|
|
517
|
+
logs?: {
|
|
518
|
+
maxSize?: number;
|
|
519
|
+
};
|
|
520
|
+
/**
|
|
521
|
+
* Custom path for the control socket. If not specified, uses the default platform-specific location.
|
|
522
|
+
*/
|
|
523
|
+
socket?: string;
|
|
524
|
+
}
|
|
525
|
+
export interface MetricsOptions {
|
|
526
|
+
port?: number | string;
|
|
527
|
+
enabled?: boolean | string;
|
|
528
|
+
hostname?: string;
|
|
529
|
+
endpoint?: string;
|
|
530
|
+
https?: HttpsOptions1;
|
|
531
|
+
auth?: {
|
|
532
|
+
username: string;
|
|
533
|
+
password: string;
|
|
534
|
+
};
|
|
535
|
+
labels?: {
|
|
536
|
+
[k: string]: string;
|
|
537
|
+
};
|
|
538
|
+
/**
|
|
539
|
+
* The label name to use for the application identifier in metrics (e.g., applicationId, serviceId)
|
|
540
|
+
*/
|
|
541
|
+
applicationLabel?: string;
|
|
542
|
+
/**
|
|
543
|
+
* Enable outgoing HTTP client request duration metrics
|
|
544
|
+
*/
|
|
545
|
+
httpClientMetrics?: boolean | string;
|
|
546
|
+
readiness?:
|
|
547
|
+
| boolean
|
|
548
|
+
| {
|
|
549
|
+
endpoint?: string;
|
|
550
|
+
success?: {
|
|
551
|
+
statusCode?: number;
|
|
552
|
+
body?: string;
|
|
553
|
+
};
|
|
554
|
+
fail?: {
|
|
555
|
+
statusCode?: number;
|
|
556
|
+
body?: string;
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
liveness?:
|
|
560
|
+
| boolean
|
|
561
|
+
| {
|
|
562
|
+
endpoint?: string;
|
|
563
|
+
success?: {
|
|
564
|
+
statusCode?: number;
|
|
565
|
+
body?: string;
|
|
566
|
+
};
|
|
567
|
+
fail?: {
|
|
568
|
+
statusCode?: number;
|
|
569
|
+
body?: string;
|
|
570
|
+
};
|
|
571
|
+
};
|
|
572
|
+
/**
|
|
573
|
+
* @deprecated
|
|
574
|
+
* Deprecated. Health probe timeout configuration is no longer used.
|
|
575
|
+
*/
|
|
576
|
+
healthChecksTimeouts?: number | string;
|
|
577
|
+
plugins?: string[];
|
|
578
|
+
timeout?: number | string;
|
|
579
|
+
/**
|
|
580
|
+
* Configuration for exporting metrics to an OTLP endpoint
|
|
581
|
+
*/
|
|
582
|
+
otlpExporter?: {
|
|
64
583
|
/**
|
|
65
|
-
*
|
|
584
|
+
* Enable or disable OTLP metrics export
|
|
66
585
|
*/
|
|
67
|
-
|
|
586
|
+
enabled?: boolean | string;
|
|
68
587
|
/**
|
|
69
|
-
*
|
|
588
|
+
* OTLP endpoint URL (e.g., http://collector:4318/v1/metrics)
|
|
70
589
|
*/
|
|
71
|
-
|
|
590
|
+
endpoint: string;
|
|
72
591
|
/**
|
|
73
|
-
*
|
|
592
|
+
* Interval in milliseconds between metric pushes
|
|
74
593
|
*/
|
|
75
|
-
|
|
594
|
+
interval?: number | string;
|
|
76
595
|
/**
|
|
77
|
-
*
|
|
596
|
+
* Additional HTTP headers for authentication
|
|
78
597
|
*/
|
|
79
|
-
|
|
598
|
+
headers?: {
|
|
599
|
+
[k: string]: string;
|
|
600
|
+
};
|
|
80
601
|
/**
|
|
81
|
-
*
|
|
602
|
+
* Service name for OTLP resource attributes
|
|
82
603
|
*/
|
|
83
|
-
|
|
604
|
+
serviceName?: string;
|
|
605
|
+
/**
|
|
606
|
+
* Service version for OTLP resource attributes
|
|
607
|
+
*/
|
|
608
|
+
serviceVersion?: string;
|
|
609
|
+
};
|
|
610
|
+
/**
|
|
611
|
+
* Configuration for forwarding user OpenTelemetry metrics to an OTLP endpoint
|
|
612
|
+
*/
|
|
613
|
+
opentelemetry?: {
|
|
84
614
|
/**
|
|
85
|
-
*
|
|
615
|
+
* Enable or disable OpenTelemetry metrics forwarding
|
|
86
616
|
*/
|
|
87
|
-
|
|
617
|
+
enabled?: boolean | string;
|
|
88
618
|
/**
|
|
89
|
-
*
|
|
619
|
+
* OTLP metrics endpoint URL (e.g., http://collector:4318/v1/metrics)
|
|
90
620
|
*/
|
|
91
|
-
|
|
621
|
+
endpoint: string;
|
|
92
622
|
/**
|
|
93
|
-
*
|
|
623
|
+
* Interval in milliseconds between metric forwards
|
|
94
624
|
*/
|
|
95
|
-
|
|
625
|
+
interval?: number | string;
|
|
96
626
|
/**
|
|
97
|
-
*
|
|
627
|
+
* Additional HTTP headers for authentication
|
|
98
628
|
*/
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
protocol: "grpc" | "http";
|
|
102
|
-
url: string;
|
|
629
|
+
headers?: {
|
|
630
|
+
[k: string]: string;
|
|
103
631
|
};
|
|
104
|
-
[k: string]: unknown;
|
|
105
632
|
};
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
633
|
+
/**
|
|
634
|
+
* Custom labels to add to HTTP metrics (http_request_all_duration_seconds). Each label extracts its value from an HTTP request header.
|
|
635
|
+
*/
|
|
636
|
+
httpCustomLabels?: {
|
|
637
|
+
/**
|
|
638
|
+
* The label name to use in metrics
|
|
639
|
+
*/
|
|
640
|
+
name: string;
|
|
109
641
|
/**
|
|
110
|
-
*
|
|
642
|
+
* The HTTP request header to extract the value from
|
|
111
643
|
*/
|
|
112
|
-
|
|
644
|
+
header: string;
|
|
113
645
|
/**
|
|
114
|
-
*
|
|
646
|
+
* Default value when header is missing (defaults to "unknown")
|
|
115
647
|
*/
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
648
|
+
default?: string;
|
|
649
|
+
}[];
|
|
650
|
+
}
|
|
651
|
+
export interface HttpsOptions1 {
|
|
652
|
+
allowHTTP1?: boolean;
|
|
653
|
+
key:
|
|
654
|
+
| string
|
|
655
|
+
| {
|
|
656
|
+
path?: string;
|
|
657
|
+
}
|
|
658
|
+
| (
|
|
120
659
|
| string
|
|
121
660
|
| {
|
|
122
661
|
path?: string;
|
|
123
662
|
}
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
663
|
+
)[];
|
|
664
|
+
cert:
|
|
665
|
+
| string
|
|
666
|
+
| {
|
|
667
|
+
path?: string;
|
|
668
|
+
}
|
|
669
|
+
| (
|
|
131
670
|
| string
|
|
132
671
|
| {
|
|
133
672
|
path?: string;
|
|
134
673
|
}
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
674
|
+
)[];
|
|
675
|
+
requestCert?: boolean;
|
|
676
|
+
rejectUnauthorized?: boolean;
|
|
677
|
+
}
|
|
678
|
+
export interface TelemetryOptions {
|
|
679
|
+
enabled?: boolean | string;
|
|
680
|
+
/**
|
|
681
|
+
* The name of the application. Defaults to the folder name if not specified.
|
|
682
|
+
*/
|
|
683
|
+
applicationName: string;
|
|
684
|
+
/**
|
|
685
|
+
* The version of the application (optional)
|
|
686
|
+
*/
|
|
687
|
+
version?: string;
|
|
688
|
+
/**
|
|
689
|
+
* An array of paths to skip when creating spans. Useful for health checks and other endpoints that do not need to be traced.
|
|
690
|
+
*/
|
|
691
|
+
skip?: {
|
|
692
|
+
/**
|
|
693
|
+
* The path to skip. Can be a string or a regex.
|
|
694
|
+
*/
|
|
695
|
+
path?: string;
|
|
696
|
+
/**
|
|
697
|
+
* HTTP method to skip
|
|
698
|
+
*/
|
|
699
|
+
method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
700
|
+
[k: string]: unknown;
|
|
701
|
+
}[];
|
|
702
|
+
exporter?:
|
|
146
703
|
| {
|
|
147
|
-
|
|
704
|
+
type?: "console" | "otlp" | "zipkin" | "memory" | "file";
|
|
148
705
|
/**
|
|
149
|
-
*
|
|
706
|
+
* Options for the exporter. These are passed directly to the exporter.
|
|
150
707
|
*/
|
|
151
|
-
allow?: [string, ...string[]];
|
|
152
|
-
ignore?: string[];
|
|
153
|
-
}
|
|
154
|
-
| boolean
|
|
155
|
-
| string;
|
|
156
|
-
application?: {
|
|
157
|
-
basePath?: string;
|
|
158
|
-
outputDirectory?: string;
|
|
159
|
-
include?: string[];
|
|
160
|
-
commands?: {
|
|
161
|
-
install?: string;
|
|
162
|
-
build?: string;
|
|
163
|
-
development?: string;
|
|
164
|
-
production?: string;
|
|
165
|
-
};
|
|
166
|
-
entrypointPort?: number;
|
|
167
|
-
changeDirectoryBeforeExecution?: boolean;
|
|
168
|
-
preferLocalCommands?: boolean;
|
|
169
|
-
processSpawner?: string;
|
|
170
|
-
};
|
|
171
|
-
runtime?: {
|
|
172
|
-
preload?: string | string[];
|
|
173
|
-
extensions?:
|
|
174
|
-
| string
|
|
175
|
-
| {
|
|
176
|
-
path: string;
|
|
177
|
-
options?: {
|
|
178
|
-
[k: string]: unknown;
|
|
179
|
-
};
|
|
180
|
-
build?: boolean;
|
|
181
|
-
}
|
|
182
|
-
| (
|
|
183
|
-
| string
|
|
184
|
-
| {
|
|
185
|
-
path: string;
|
|
186
|
-
options?: {
|
|
187
|
-
[k: string]: unknown;
|
|
188
|
-
};
|
|
189
|
-
build?: boolean;
|
|
190
|
-
}
|
|
191
|
-
)[];
|
|
192
|
-
basePath?: string;
|
|
193
|
-
services?: {
|
|
194
|
-
[k: string]: unknown;
|
|
195
|
-
}[];
|
|
196
|
-
workers?:
|
|
197
|
-
| number
|
|
198
|
-
| string
|
|
199
|
-
| {
|
|
200
|
-
static?: number;
|
|
201
|
-
dynamic?: boolean;
|
|
202
|
-
minimum?: number;
|
|
203
|
-
maximum?: number;
|
|
204
|
-
total?: number;
|
|
205
|
-
maxMemory?: number;
|
|
206
|
-
cooldown?: number;
|
|
207
|
-
gracePeriod?: number;
|
|
208
|
-
scaleUpELU?: number;
|
|
209
|
-
scaleDownELU?: number;
|
|
210
|
-
[k: string]: unknown;
|
|
211
|
-
};
|
|
212
|
-
workersRestartDelay?: number | string;
|
|
213
|
-
logger?: {
|
|
214
|
-
/**
|
|
215
|
-
* The log level. It must be one of the standard pino levels (fatal, error, warn, info, debug, trace, silent) or, when customLevels is set, one of the custom levels.
|
|
216
|
-
*/
|
|
217
|
-
level?: string;
|
|
218
|
-
transport?:
|
|
219
|
-
| {
|
|
220
|
-
target?: string;
|
|
221
|
-
options?: {
|
|
222
|
-
[k: string]: unknown;
|
|
223
|
-
};
|
|
224
|
-
}
|
|
225
|
-
| {
|
|
226
|
-
targets?: {
|
|
227
|
-
target?: string;
|
|
228
|
-
options?: {
|
|
229
|
-
[k: string]: unknown;
|
|
230
|
-
};
|
|
231
|
-
level?: string;
|
|
232
|
-
}[];
|
|
233
|
-
options?: {
|
|
234
|
-
[k: string]: unknown;
|
|
235
|
-
};
|
|
236
|
-
};
|
|
237
|
-
pipeline?: {
|
|
238
|
-
target?: string;
|
|
239
708
|
options?: {
|
|
240
|
-
[k: string]: unknown;
|
|
241
|
-
};
|
|
242
|
-
};
|
|
243
|
-
formatters?: {
|
|
244
|
-
path: string;
|
|
245
|
-
};
|
|
246
|
-
timestamp?: "epochTime" | "unixTime" | "nullTime" | "isoTime";
|
|
247
|
-
redact?: {
|
|
248
|
-
paths: string[];
|
|
249
|
-
censor?: string;
|
|
250
|
-
/**
|
|
251
|
-
* Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false.
|
|
252
|
-
*/
|
|
253
|
-
remove?: boolean;
|
|
254
|
-
};
|
|
255
|
-
base?: {
|
|
256
|
-
[k: string]: unknown;
|
|
257
|
-
} | null;
|
|
258
|
-
messageKey?: string;
|
|
259
|
-
customLevels?: {
|
|
260
|
-
[k: string]: unknown;
|
|
261
|
-
};
|
|
262
|
-
/**
|
|
263
|
-
* The numeric value of the level defined in level, when it is not one of the standard pino levels.
|
|
264
|
-
*/
|
|
265
|
-
levelVal?: number;
|
|
266
|
-
/**
|
|
267
|
-
* Only use the levels defined in customLevels and omit the standard pino ones.
|
|
268
|
-
*/
|
|
269
|
-
useOnlyCustomLevels?: boolean;
|
|
270
|
-
/**
|
|
271
|
-
* How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC.
|
|
272
|
-
*/
|
|
273
|
-
levelComparison?: "ASC" | "DESC";
|
|
274
|
-
/**
|
|
275
|
-
* A string prefixed to every message, including the ones of child loggers.
|
|
276
|
-
*/
|
|
277
|
-
msgPrefix?: string;
|
|
278
|
-
/**
|
|
279
|
-
* The key under which any logged object is placed.
|
|
280
|
-
*/
|
|
281
|
-
nestedKey?: string;
|
|
282
|
-
/**
|
|
283
|
-
* The key used for the serialized error in the log object. Defaults to err.
|
|
284
|
-
*/
|
|
285
|
-
errorKey?: string;
|
|
286
|
-
/**
|
|
287
|
-
* The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5.
|
|
288
|
-
*/
|
|
289
|
-
depthLimit?: number;
|
|
290
|
-
/**
|
|
291
|
-
* The stringification limit of properties or elements when logging a circular object or array. Defaults to 100.
|
|
292
|
-
*/
|
|
293
|
-
edgeLimit?: number;
|
|
294
|
-
/**
|
|
295
|
-
* Terminate each log line with \r\n instead of \n. Defaults to false.
|
|
296
|
-
*/
|
|
297
|
-
crlf?: boolean;
|
|
298
|
-
/**
|
|
299
|
-
* Set to false to disable logging entirely. Defaults to true.
|
|
300
|
-
*/
|
|
301
|
-
enabled?: boolean;
|
|
302
|
-
openTelemetryExporter?: {
|
|
303
|
-
protocol: "grpc" | "http";
|
|
304
|
-
url: string;
|
|
305
|
-
};
|
|
306
|
-
[k: string]: unknown;
|
|
307
|
-
};
|
|
308
|
-
server?: {
|
|
309
|
-
hostname?: string;
|
|
310
|
-
port?: number | string;
|
|
311
|
-
/**
|
|
312
|
-
* Configures how entrypoint server worker ports are assigned. When set to shared, all workers listen on the same port. When set to perWorkerIncrement, each worker will use its own port, starting from port (worker 0).
|
|
313
|
-
*/
|
|
314
|
-
portAssignment?: "shared" | "perWorkerIncrement";
|
|
315
|
-
/**
|
|
316
|
-
* The maximum length of the queue of pending connections
|
|
317
|
-
*/
|
|
318
|
-
backlog?: number;
|
|
319
|
-
http2?: boolean;
|
|
320
|
-
https?: {
|
|
321
|
-
allowHTTP1?: boolean;
|
|
322
|
-
key:
|
|
323
|
-
| string
|
|
324
|
-
| {
|
|
325
|
-
path?: string;
|
|
326
|
-
}
|
|
327
|
-
| (
|
|
328
|
-
| string
|
|
329
|
-
| {
|
|
330
|
-
path?: string;
|
|
331
|
-
}
|
|
332
|
-
)[];
|
|
333
|
-
cert:
|
|
334
|
-
| string
|
|
335
|
-
| {
|
|
336
|
-
path?: string;
|
|
337
|
-
}
|
|
338
|
-
| (
|
|
339
|
-
| string
|
|
340
|
-
| {
|
|
341
|
-
path?: string;
|
|
342
|
-
}
|
|
343
|
-
)[];
|
|
344
|
-
requestCert?: boolean;
|
|
345
|
-
rejectUnauthorized?: boolean;
|
|
346
|
-
};
|
|
347
|
-
};
|
|
348
|
-
reuseTcpPorts?: boolean;
|
|
349
|
-
startTimeout?: number;
|
|
350
|
-
restartOnError?: boolean | number;
|
|
351
|
-
exitOnUnhandledErrors?: boolean | number;
|
|
352
|
-
gracefulShutdown?: {
|
|
353
|
-
runtime: number | string;
|
|
354
|
-
application: number | string;
|
|
355
|
-
/**
|
|
356
|
-
* Add Connection: close header to HTTP responses during graceful shutdown
|
|
357
|
-
*/
|
|
358
|
-
closeConnections?: boolean;
|
|
359
|
-
};
|
|
360
|
-
health?: {
|
|
361
|
-
enabled?: boolean | string;
|
|
362
|
-
interval?: number | string;
|
|
363
|
-
gracePeriod?: number | string;
|
|
364
|
-
maxUnhealthyChecks?: number | string;
|
|
365
|
-
maxELU?: number | string;
|
|
366
|
-
maxEventLoopDelay?: number | string;
|
|
367
|
-
maxEventLoopDelayP99?: number | string;
|
|
368
|
-
maxHeapUsed?: number | string;
|
|
369
|
-
maxHeapTotal?: number | string;
|
|
370
|
-
maxYoungGeneration?: number | string;
|
|
371
|
-
codeRangeSize?: number | string;
|
|
372
|
-
bufferPoolSize?: number | string;
|
|
373
|
-
defaultHighWaterMark?: number | string;
|
|
374
|
-
};
|
|
375
|
-
healthProbes?:
|
|
376
|
-
| boolean
|
|
377
|
-
| string
|
|
378
|
-
| {
|
|
379
|
-
enabled?: boolean | string;
|
|
380
|
-
hostname?: string;
|
|
381
|
-
port?: number | string;
|
|
382
|
-
readiness?:
|
|
383
|
-
| boolean
|
|
384
|
-
| {
|
|
385
|
-
endpoint?: string;
|
|
386
|
-
success?: {
|
|
387
|
-
statusCode?: number;
|
|
388
|
-
body?: string;
|
|
389
|
-
};
|
|
390
|
-
fail?: {
|
|
391
|
-
statusCode?: number;
|
|
392
|
-
body?: string;
|
|
393
|
-
};
|
|
394
|
-
};
|
|
395
|
-
liveness?:
|
|
396
|
-
| boolean
|
|
397
|
-
| {
|
|
398
|
-
endpoint?: string;
|
|
399
|
-
success?: {
|
|
400
|
-
statusCode?: number;
|
|
401
|
-
body?: string;
|
|
402
|
-
};
|
|
403
|
-
fail?: {
|
|
404
|
-
statusCode?: number;
|
|
405
|
-
body?: string;
|
|
406
|
-
};
|
|
407
|
-
};
|
|
408
|
-
};
|
|
409
|
-
undici?: {
|
|
410
|
-
agentOptions?: {
|
|
411
|
-
[k: string]: unknown;
|
|
412
|
-
};
|
|
413
|
-
interceptors?:
|
|
414
|
-
| {
|
|
415
|
-
module: string;
|
|
416
|
-
options: {
|
|
417
|
-
[k: string]: unknown;
|
|
418
|
-
};
|
|
419
|
-
[k: string]: unknown;
|
|
420
|
-
}[]
|
|
421
|
-
| {
|
|
422
|
-
Client?: {
|
|
423
|
-
module: string;
|
|
424
|
-
options: {
|
|
425
|
-
[k: string]: unknown;
|
|
426
|
-
};
|
|
427
|
-
[k: string]: unknown;
|
|
428
|
-
}[];
|
|
429
|
-
Pool?: {
|
|
430
|
-
module: string;
|
|
431
|
-
options: {
|
|
432
|
-
[k: string]: unknown;
|
|
433
|
-
};
|
|
434
|
-
[k: string]: unknown;
|
|
435
|
-
}[];
|
|
436
|
-
Agent?: {
|
|
437
|
-
module: string;
|
|
438
|
-
options: {
|
|
439
|
-
[k: string]: unknown;
|
|
440
|
-
};
|
|
441
|
-
[k: string]: unknown;
|
|
442
|
-
}[];
|
|
443
|
-
[k: string]: unknown;
|
|
444
|
-
};
|
|
445
|
-
[k: string]: unknown;
|
|
446
|
-
};
|
|
447
|
-
httpCache?:
|
|
448
|
-
| boolean
|
|
449
|
-
| {
|
|
450
|
-
store?: string;
|
|
451
|
-
/**
|
|
452
|
-
* @minItems 1
|
|
453
|
-
*/
|
|
454
|
-
methods?: [string, ...string[]];
|
|
455
|
-
cacheTagsHeader?: string;
|
|
456
|
-
maxSize?: number;
|
|
457
|
-
maxEntrySize?: number;
|
|
458
|
-
maxCount?: number;
|
|
459
|
-
/**
|
|
460
|
-
* Whitelist of origins to cache. Supports exact strings and regex patterns (e.g., "/https:\\/\\/.*\\.example\\.com/").
|
|
461
|
-
*/
|
|
462
|
-
origins?: string[];
|
|
463
709
|
/**
|
|
464
|
-
*
|
|
710
|
+
* The URL to send the traces to. Not used for console or memory exporters.
|
|
465
711
|
*/
|
|
466
|
-
|
|
712
|
+
url?: string;
|
|
467
713
|
/**
|
|
468
|
-
*
|
|
714
|
+
* Headers to send to the exporter. Not used for console or memory exporters.
|
|
469
715
|
*/
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
};
|
|
473
|
-
watch?: boolean | string;
|
|
474
|
-
managementApi?:
|
|
475
|
-
| boolean
|
|
476
|
-
| string
|
|
477
|
-
| {
|
|
478
|
-
logs?: {
|
|
479
|
-
maxSize?: number;
|
|
716
|
+
headers?: {
|
|
717
|
+
[k: string]: unknown;
|
|
480
718
|
};
|
|
481
719
|
/**
|
|
482
|
-
*
|
|
720
|
+
* The path to write the traces to. Only for file exporter.
|
|
483
721
|
*/
|
|
484
|
-
|
|
485
|
-
};
|
|
486
|
-
management?:
|
|
487
|
-
| boolean
|
|
488
|
-
| {
|
|
489
|
-
enabled?: boolean;
|
|
490
|
-
operations?: string[];
|
|
491
|
-
};
|
|
492
|
-
metrics?:
|
|
493
|
-
| boolean
|
|
494
|
-
| {
|
|
495
|
-
port?: number | string;
|
|
496
|
-
enabled?: boolean | string;
|
|
497
|
-
hostname?: string;
|
|
498
|
-
endpoint?: string;
|
|
499
|
-
https?: {
|
|
500
|
-
allowHTTP1?: boolean;
|
|
501
|
-
key:
|
|
502
|
-
| string
|
|
503
|
-
| {
|
|
504
|
-
path?: string;
|
|
505
|
-
}
|
|
506
|
-
| (
|
|
507
|
-
| string
|
|
508
|
-
| {
|
|
509
|
-
path?: string;
|
|
510
|
-
}
|
|
511
|
-
)[];
|
|
512
|
-
cert:
|
|
513
|
-
| string
|
|
514
|
-
| {
|
|
515
|
-
path?: string;
|
|
516
|
-
}
|
|
517
|
-
| (
|
|
518
|
-
| string
|
|
519
|
-
| {
|
|
520
|
-
path?: string;
|
|
521
|
-
}
|
|
522
|
-
)[];
|
|
523
|
-
requestCert?: boolean;
|
|
524
|
-
rejectUnauthorized?: boolean;
|
|
525
|
-
};
|
|
526
|
-
auth?: {
|
|
527
|
-
username: string;
|
|
528
|
-
password: string;
|
|
529
|
-
};
|
|
530
|
-
labels?: {
|
|
531
|
-
[k: string]: string;
|
|
532
|
-
};
|
|
722
|
+
path?: string;
|
|
533
723
|
/**
|
|
534
|
-
* The
|
|
724
|
+
* The OTLP transport protocol to use. Only for the otlp exporter. Defaults to http.
|
|
535
725
|
*/
|
|
536
|
-
|
|
726
|
+
protocol?: "http" | "grpc";
|
|
537
727
|
/**
|
|
538
|
-
*
|
|
728
|
+
* Alias for protocol. Only for the otlp exporter. Defaults to http.
|
|
539
729
|
*/
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
};
|
|
553
|
-
};
|
|
554
|
-
liveness?:
|
|
555
|
-
| boolean
|
|
556
|
-
| {
|
|
557
|
-
endpoint?: string;
|
|
558
|
-
success?: {
|
|
559
|
-
statusCode?: number;
|
|
560
|
-
body?: string;
|
|
561
|
-
};
|
|
562
|
-
fail?: {
|
|
563
|
-
statusCode?: number;
|
|
564
|
-
body?: string;
|
|
565
|
-
};
|
|
566
|
-
};
|
|
730
|
+
transport?: "http" | "grpc";
|
|
731
|
+
[k: string]: unknown;
|
|
732
|
+
};
|
|
733
|
+
additionalProperties?: never;
|
|
734
|
+
[k: string]: unknown;
|
|
735
|
+
}[]
|
|
736
|
+
| {
|
|
737
|
+
type?: "console" | "otlp" | "zipkin" | "memory" | "file";
|
|
738
|
+
/**
|
|
739
|
+
* Options for the exporter. These are passed directly to the exporter.
|
|
740
|
+
*/
|
|
741
|
+
options?: {
|
|
567
742
|
/**
|
|
568
|
-
*
|
|
569
|
-
* Deprecated. Health probe timeout configuration is no longer used.
|
|
743
|
+
* The URL to send the traces to. Not used for console or memory exporters.
|
|
570
744
|
*/
|
|
571
|
-
|
|
572
|
-
plugins?: string[];
|
|
573
|
-
timeout?: number | string;
|
|
745
|
+
url?: string;
|
|
574
746
|
/**
|
|
575
|
-
*
|
|
747
|
+
* Headers to send to the exporter. Not used for console or memory exporters.
|
|
576
748
|
*/
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
* Enable or disable OTLP metrics export
|
|
580
|
-
*/
|
|
581
|
-
enabled?: boolean | string;
|
|
582
|
-
/**
|
|
583
|
-
* OTLP endpoint URL (e.g., http://collector:4318/v1/metrics)
|
|
584
|
-
*/
|
|
585
|
-
endpoint: string;
|
|
586
|
-
/**
|
|
587
|
-
* Interval in milliseconds between metric pushes
|
|
588
|
-
*/
|
|
589
|
-
interval?: number | string;
|
|
590
|
-
/**
|
|
591
|
-
* Additional HTTP headers for authentication
|
|
592
|
-
*/
|
|
593
|
-
headers?: {
|
|
594
|
-
[k: string]: string;
|
|
595
|
-
};
|
|
596
|
-
/**
|
|
597
|
-
* Service name for OTLP resource attributes
|
|
598
|
-
*/
|
|
599
|
-
serviceName?: string;
|
|
600
|
-
/**
|
|
601
|
-
* Service version for OTLP resource attributes
|
|
602
|
-
*/
|
|
603
|
-
serviceVersion?: string;
|
|
749
|
+
headers?: {
|
|
750
|
+
[k: string]: unknown;
|
|
604
751
|
};
|
|
605
752
|
/**
|
|
606
|
-
*
|
|
753
|
+
* The path to write the traces to. Only for file exporter.
|
|
607
754
|
*/
|
|
608
|
-
|
|
609
|
-
/**
|
|
610
|
-
* Enable or disable OpenTelemetry metrics forwarding
|
|
611
|
-
*/
|
|
612
|
-
enabled?: boolean | string;
|
|
613
|
-
/**
|
|
614
|
-
* OTLP metrics endpoint URL (e.g., http://collector:4318/v1/metrics)
|
|
615
|
-
*/
|
|
616
|
-
endpoint: string;
|
|
617
|
-
/**
|
|
618
|
-
* Interval in milliseconds between metric forwards
|
|
619
|
-
*/
|
|
620
|
-
interval?: number | string;
|
|
621
|
-
/**
|
|
622
|
-
* Additional HTTP headers for authentication
|
|
623
|
-
*/
|
|
624
|
-
headers?: {
|
|
625
|
-
[k: string]: string;
|
|
626
|
-
};
|
|
627
|
-
};
|
|
755
|
+
path?: string;
|
|
628
756
|
/**
|
|
629
|
-
*
|
|
757
|
+
* The OTLP transport protocol to use. Only for the otlp exporter. Defaults to http.
|
|
630
758
|
*/
|
|
631
|
-
|
|
632
|
-
/**
|
|
633
|
-
* The label name to use in metrics
|
|
634
|
-
*/
|
|
635
|
-
name: string;
|
|
636
|
-
/**
|
|
637
|
-
* The HTTP request header to extract the value from
|
|
638
|
-
*/
|
|
639
|
-
header: string;
|
|
640
|
-
/**
|
|
641
|
-
* Default value when header is missing (defaults to "unknown")
|
|
642
|
-
*/
|
|
643
|
-
default?: string;
|
|
644
|
-
}[];
|
|
645
|
-
};
|
|
646
|
-
telemetry?: {
|
|
647
|
-
enabled?: boolean | string;
|
|
648
|
-
/**
|
|
649
|
-
* The name of the application. Defaults to the folder name if not specified.
|
|
650
|
-
*/
|
|
651
|
-
applicationName: string;
|
|
652
|
-
/**
|
|
653
|
-
* The version of the application (optional)
|
|
654
|
-
*/
|
|
655
|
-
version?: string;
|
|
656
|
-
/**
|
|
657
|
-
* An array of paths to skip when creating spans. Useful for health checks and other endpoints that do not need to be traced.
|
|
658
|
-
*/
|
|
659
|
-
skip?: {
|
|
660
|
-
/**
|
|
661
|
-
* The path to skip. Can be a string or a regex.
|
|
662
|
-
*/
|
|
663
|
-
path?: string;
|
|
664
|
-
/**
|
|
665
|
-
* HTTP method to skip
|
|
666
|
-
*/
|
|
667
|
-
method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
668
|
-
[k: string]: unknown;
|
|
669
|
-
}[];
|
|
670
|
-
exporter?:
|
|
671
|
-
| {
|
|
672
|
-
type?: "console" | "otlp" | "zipkin" | "memory" | "file";
|
|
673
|
-
/**
|
|
674
|
-
* Options for the exporter. These are passed directly to the exporter.
|
|
675
|
-
*/
|
|
676
|
-
options?: {
|
|
677
|
-
/**
|
|
678
|
-
* The URL to send the traces to. Not used for console or memory exporters.
|
|
679
|
-
*/
|
|
680
|
-
url?: string;
|
|
681
|
-
/**
|
|
682
|
-
* Headers to send to the exporter. Not used for console or memory exporters.
|
|
683
|
-
*/
|
|
684
|
-
headers?: {
|
|
685
|
-
[k: string]: unknown;
|
|
686
|
-
};
|
|
687
|
-
/**
|
|
688
|
-
* The path to write the traces to. Only for file exporter.
|
|
689
|
-
*/
|
|
690
|
-
path?: string;
|
|
691
|
-
/**
|
|
692
|
-
* The OTLP transport protocol to use. Only for the otlp exporter. Defaults to http.
|
|
693
|
-
*/
|
|
694
|
-
protocol?: "http" | "grpc";
|
|
695
|
-
/**
|
|
696
|
-
* Alias for protocol. Only for the otlp exporter. Defaults to http.
|
|
697
|
-
*/
|
|
698
|
-
transport?: "http" | "grpc";
|
|
699
|
-
[k: string]: unknown;
|
|
700
|
-
};
|
|
701
|
-
additionalProperties?: never;
|
|
702
|
-
[k: string]: unknown;
|
|
703
|
-
}[]
|
|
704
|
-
| {
|
|
705
|
-
type?: "console" | "otlp" | "zipkin" | "memory" | "file";
|
|
706
|
-
/**
|
|
707
|
-
* Options for the exporter. These are passed directly to the exporter.
|
|
708
|
-
*/
|
|
709
|
-
options?: {
|
|
710
|
-
/**
|
|
711
|
-
* The URL to send the traces to. Not used for console or memory exporters.
|
|
712
|
-
*/
|
|
713
|
-
url?: string;
|
|
714
|
-
/**
|
|
715
|
-
* Headers to send to the exporter. Not used for console or memory exporters.
|
|
716
|
-
*/
|
|
717
|
-
headers?: {
|
|
718
|
-
[k: string]: unknown;
|
|
719
|
-
};
|
|
720
|
-
/**
|
|
721
|
-
* The path to write the traces to. Only for file exporter.
|
|
722
|
-
*/
|
|
723
|
-
path?: string;
|
|
724
|
-
/**
|
|
725
|
-
* The OTLP transport protocol to use. Only for the otlp exporter. Defaults to http.
|
|
726
|
-
*/
|
|
727
|
-
protocol?: "http" | "grpc";
|
|
728
|
-
/**
|
|
729
|
-
* Alias for protocol. Only for the otlp exporter. Defaults to http.
|
|
730
|
-
*/
|
|
731
|
-
transport?: "http" | "grpc";
|
|
732
|
-
[k: string]: unknown;
|
|
733
|
-
};
|
|
734
|
-
additionalProperties?: never;
|
|
735
|
-
[k: string]: unknown;
|
|
736
|
-
};
|
|
737
|
-
/**
|
|
738
|
-
* Enable the OpenTelemetry diagnostic logger. Diagnostic messages are forwarded to the Platformatic global logger using the current logger level.
|
|
739
|
-
*/
|
|
740
|
-
diagLogger?: boolean | string;
|
|
741
|
-
};
|
|
742
|
-
verticalScaler?: {
|
|
743
|
-
enabled?: boolean;
|
|
744
|
-
maxTotalWorkers?: number;
|
|
745
|
-
maxTotalMemory?: number;
|
|
746
|
-
minWorkers?: number;
|
|
747
|
-
maxWorkers?: number;
|
|
748
|
-
cooldownSec?: number;
|
|
749
|
-
gracePeriod?: number;
|
|
750
|
-
scaleUpELU?: number;
|
|
751
|
-
scaleDownELU?: number;
|
|
752
|
-
/**
|
|
753
|
-
* @deprecated
|
|
754
|
-
*/
|
|
755
|
-
timeWindowSec?: number;
|
|
756
|
-
/**
|
|
757
|
-
* @deprecated
|
|
758
|
-
*/
|
|
759
|
-
scaleDownTimeWindowSec?: number;
|
|
760
|
-
/**
|
|
761
|
-
* @deprecated
|
|
762
|
-
*/
|
|
763
|
-
scaleIntervalSec?: number;
|
|
764
|
-
};
|
|
765
|
-
inspectorOptions?: {
|
|
766
|
-
host?: string;
|
|
767
|
-
port?: number;
|
|
768
|
-
breakFirstLine?: boolean;
|
|
769
|
-
watchDisabled?: boolean;
|
|
770
|
-
[k: string]: unknown;
|
|
771
|
-
};
|
|
772
|
-
applicationTimeout?: number | string;
|
|
773
|
-
startupConcurrency?: number | string;
|
|
774
|
-
messagingTimeout?: number | string;
|
|
775
|
-
env?: {
|
|
776
|
-
[k: string]: string;
|
|
777
|
-
};
|
|
778
|
-
envfile?: string;
|
|
779
|
-
/**
|
|
780
|
-
* When set to true, the configuration loading fails if a {PLT_*} placeholder references an environment variable which is not set. When set to "warn", a warning listing the missing variables is logged but the placeholders are still replaced with an empty string. Defaults to false.
|
|
781
|
-
*/
|
|
782
|
-
strictEnv?: boolean | string;
|
|
783
|
-
sourceMaps?: boolean;
|
|
784
|
-
nodeModulesSourceMaps?: string[];
|
|
785
|
-
scheduler?: {
|
|
786
|
-
enabled?: boolean | string;
|
|
787
|
-
name: string;
|
|
788
|
-
cron: string;
|
|
789
|
-
callbackUrl: string;
|
|
790
|
-
method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
791
|
-
headers?: {
|
|
792
|
-
[k: string]: string;
|
|
793
|
-
};
|
|
794
|
-
body?:
|
|
795
|
-
| string
|
|
796
|
-
| {
|
|
797
|
-
[k: string]: unknown;
|
|
798
|
-
};
|
|
799
|
-
maxRetries?: number;
|
|
800
|
-
[k: string]: unknown;
|
|
801
|
-
}[];
|
|
802
|
-
policies?: {
|
|
803
|
-
deny: {
|
|
804
|
-
/**
|
|
805
|
-
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
806
|
-
* via the `patternProperty` "^.*$".
|
|
807
|
-
*/
|
|
808
|
-
[k: string]: string | [string, ...string[]];
|
|
809
|
-
};
|
|
810
|
-
};
|
|
811
|
-
compileCache?:
|
|
812
|
-
| boolean
|
|
813
|
-
| {
|
|
814
|
-
/**
|
|
815
|
-
* Enable Node.js module compile cache for faster startup
|
|
816
|
-
*/
|
|
817
|
-
enabled?: boolean;
|
|
759
|
+
protocol?: "http" | "grpc";
|
|
818
760
|
/**
|
|
819
|
-
*
|
|
761
|
+
* Alias for protocol. Only for the otlp exporter. Defaults to http.
|
|
820
762
|
*/
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
application?: {
|
|
824
|
-
reuseTcpPorts?: boolean;
|
|
825
|
-
workers?:
|
|
826
|
-
| number
|
|
827
|
-
| string
|
|
828
|
-
| {
|
|
829
|
-
static?: number;
|
|
830
|
-
minimum?: number;
|
|
831
|
-
maximum?: number;
|
|
832
|
-
scaleUpELU?: number;
|
|
833
|
-
scaleDownELU?: number;
|
|
834
|
-
[k: string]: unknown;
|
|
835
|
-
};
|
|
836
|
-
health?: {
|
|
837
|
-
enabled?: boolean | string;
|
|
838
|
-
interval?: number | string;
|
|
839
|
-
gracePeriod?: number | string;
|
|
840
|
-
maxUnhealthyChecks?: number | string;
|
|
841
|
-
maxELU?: number | string;
|
|
842
|
-
maxEventLoopDelay?: number | string;
|
|
843
|
-
maxEventLoopDelayP99?: number | string;
|
|
844
|
-
maxHeapUsed?: number | string;
|
|
845
|
-
maxHeapTotal?: number | string;
|
|
846
|
-
maxYoungGeneration?: number | string;
|
|
847
|
-
codeRangeSize?: number | string;
|
|
848
|
-
bufferPoolSize?: number | string;
|
|
849
|
-
defaultHighWaterMark?: number | string;
|
|
850
|
-
};
|
|
851
|
-
/**
|
|
852
|
-
* Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.
|
|
853
|
-
*/
|
|
854
|
-
restartOnError?: boolean | number;
|
|
855
|
-
arguments?: string[];
|
|
856
|
-
env?: {
|
|
857
|
-
[k: string]: string;
|
|
858
|
-
};
|
|
859
|
-
envfile?: string;
|
|
860
|
-
sourceMaps?: boolean;
|
|
861
|
-
nodeModulesSourceMaps?: string[];
|
|
862
|
-
packageManager?: "npm" | "pnpm" | "yarn";
|
|
863
|
-
preload?: string | string[];
|
|
864
|
-
nodeOptions?: string;
|
|
865
|
-
execArgv?: string[];
|
|
866
|
-
permissions?: {
|
|
867
|
-
fs?: {
|
|
868
|
-
read?: string[];
|
|
869
|
-
write?: string[];
|
|
763
|
+
transport?: "http" | "grpc";
|
|
764
|
+
[k: string]: unknown;
|
|
870
765
|
};
|
|
871
|
-
|
|
872
|
-
telemetry?: {
|
|
873
|
-
/**
|
|
874
|
-
* An array of instrumentations loaded if telemetry is enabled
|
|
875
|
-
*/
|
|
876
|
-
instrumentations?: (
|
|
877
|
-
| string
|
|
878
|
-
| {
|
|
879
|
-
package: string;
|
|
880
|
-
exportName?: string;
|
|
881
|
-
options?: {
|
|
882
|
-
[k: string]: unknown;
|
|
883
|
-
};
|
|
884
|
-
[k: string]: unknown;
|
|
885
|
-
}
|
|
886
|
-
)[];
|
|
766
|
+
additionalProperties?: never;
|
|
887
767
|
[k: string]: unknown;
|
|
888
768
|
};
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
769
|
+
/**
|
|
770
|
+
* Enable the OpenTelemetry diagnostic logger. Diagnostic messages are forwarded to the Platformatic global logger using the current logger level.
|
|
771
|
+
*/
|
|
772
|
+
diagLogger?: boolean | string;
|
|
773
|
+
}
|
|
774
|
+
export interface CompileCacheOptions {
|
|
775
|
+
/**
|
|
776
|
+
* Enable Node.js module compile cache for faster startup
|
|
777
|
+
*/
|
|
778
|
+
enabled?: boolean;
|
|
779
|
+
/**
|
|
780
|
+
* Directory to store compile cache. Defaults to .plt/compile-cache in app root
|
|
781
|
+
*/
|
|
782
|
+
directory?: string;
|
|
783
|
+
/**
|
|
784
|
+
* Wait for the first worker to start before starting the remaining workers
|
|
785
|
+
*/
|
|
786
|
+
awaitFirstWorker?: boolean;
|
|
787
|
+
}
|
|
788
|
+
export interface ApplicationWorkersOptions {
|
|
789
|
+
static?: number;
|
|
790
|
+
dynamic?: boolean;
|
|
791
|
+
minimum?: number;
|
|
792
|
+
maximum?: number;
|
|
793
|
+
eluThreshold?: number;
|
|
794
|
+
heapThresholdMb?: number;
|
|
795
|
+
}
|
|
796
|
+
export interface ApplicationHealthOptions {
|
|
797
|
+
enabled?: boolean | string;
|
|
798
|
+
interval?: number | string;
|
|
799
|
+
gracePeriod?: number | string;
|
|
800
|
+
maxUnhealthyChecks?: number | string;
|
|
801
|
+
maxELU?: number | string;
|
|
802
|
+
maxEventLoopDelay?: number | string;
|
|
803
|
+
maxEventLoopDelayP99?: number | string;
|
|
804
|
+
maxHeapUsed?: number | string;
|
|
805
|
+
maxHeapTotal?: number | string;
|
|
806
|
+
maxYoungGeneration?: number | string;
|
|
807
|
+
codeRangeSize?: number | string;
|
|
808
|
+
bufferPoolSize?: number | string;
|
|
809
|
+
defaultHighWaterMark?: number | string;
|
|
810
|
+
}
|
|
811
|
+
export interface PermissionsOptions {
|
|
812
|
+
fs?: {
|
|
813
|
+
read?: string[];
|
|
814
|
+
write?: string[];
|
|
912
815
|
};
|
|
913
816
|
}
|
|
817
|
+
export interface ApplicationTelemetryOverrides {
|
|
818
|
+
/**
|
|
819
|
+
* An array of instrumentations loaded if tracing is enabled
|
|
820
|
+
*/
|
|
821
|
+
instrumentations?: (
|
|
822
|
+
| string
|
|
823
|
+
| {
|
|
824
|
+
package: string;
|
|
825
|
+
exportName?: string;
|
|
826
|
+
options?: {
|
|
827
|
+
[k: string]: unknown;
|
|
828
|
+
};
|
|
829
|
+
[k: string]: unknown;
|
|
830
|
+
}
|
|
831
|
+
)[];
|
|
832
|
+
[k: string]: unknown;
|
|
833
|
+
}
|
|
834
|
+
export interface CompileCacheOptions1 {
|
|
835
|
+
/**
|
|
836
|
+
* Enable Node.js module compile cache for faster startup
|
|
837
|
+
*/
|
|
838
|
+
enabled?: boolean;
|
|
839
|
+
/**
|
|
840
|
+
* Directory to store compile cache. Defaults to .plt/compile-cache in app root
|
|
841
|
+
*/
|
|
842
|
+
directory?: string;
|
|
843
|
+
/**
|
|
844
|
+
* Wait for the first worker to start before starting the remaining workers
|
|
845
|
+
*/
|
|
846
|
+
awaitFirstWorker?: boolean;
|
|
847
|
+
}
|