@twin.org/node-core 0.9.2-next.12 → 0.9.2-next.14
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/dist/es/builders/engineEnvBuilder.js +16 -0
- package/dist/es/builders/engineEnvBuilder.js.map +1 -1
- package/dist/es/builders/engineServerEnvBuilder.js +18 -1
- package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
- package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
- package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -1
- package/dist/es/models/engineEnvironmentVariableKeys.js +3 -0
- package/dist/es/models/engineEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/models/engineServerEnvironmentVariableKeys.js +2 -1
- package/dist/es/models/engineServerEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/node.js +1 -1
- package/dist/es/node.js.map +1 -1
- package/dist/types/builders/engineEnvBuilder.d.ts +7 -0
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +13 -0
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +4 -0
- package/docs/changelog.md +14 -0
- package/docs/reference/functions/isTracingRequired.md +20 -0
- package/docs/reference/index.md +1 -0
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +30 -0
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +8 -0
- package/package.json +2 -1
|
@@ -508,6 +508,19 @@ export interface IEngineEnvironmentVariables {
|
|
|
508
508
|
* Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
|
|
509
509
|
*/
|
|
510
510
|
telemetryMetricsProducerMaxHistory?: string;
|
|
511
|
+
/**
|
|
512
|
+
* The batch size for the telemetry connector, set to 1 to disable size-based flushing.
|
|
513
|
+
*/
|
|
514
|
+
telemetryBatchSize?: string;
|
|
515
|
+
/**
|
|
516
|
+
* The batch flush interval in seconds for the telemetry connector, how often to flush when using batching, defaults to 5 seconds.
|
|
517
|
+
*/
|
|
518
|
+
telemetryBatchFlushInterval?: string;
|
|
519
|
+
/**
|
|
520
|
+
* The maximum number of metric values to hold in the write-ahead cache for the telemetry connector. Set to 0 for unlimited.
|
|
521
|
+
* @default 1000
|
|
522
|
+
*/
|
|
523
|
+
telemetryMaxCacheSize?: string;
|
|
511
524
|
/**
|
|
512
525
|
* The mutex timeout in milliseconds for the telemetry connector.
|
|
513
526
|
*/
|
|
@@ -66,4 +66,8 @@ export interface IEngineServerEnvironmentVariables {
|
|
|
66
66
|
* Comma-separated list of URL path prefixes excluded from metrics collection.
|
|
67
67
|
*/
|
|
68
68
|
routeMetricsExcludePaths?: string;
|
|
69
|
+
/**
|
|
70
|
+
* Comma-separated list of URL path prefixes excluded from tracing.
|
|
71
|
+
*/
|
|
72
|
+
routeTracingExcludePaths?: string;
|
|
69
73
|
}
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.2-next.14](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.13...node-core-v0.9.2-next.14) (2026-08-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* telemetry batching ([#347](https://github.com/iotaledger/twin-node/issues/347)) ([5d5b0a9](https://github.com/iotaledger/twin-node/commit/5d5b0a91396298fe774ae26193b0595875cd118a))
|
|
9
|
+
|
|
10
|
+
## [0.9.2-next.13](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.12...node-core-v0.9.2-next.13) (2026-08-18)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* add tracing ([#344](https://github.com/iotaledger/twin-node/issues/344)) ([4fa71cd](https://github.com/iotaledger/twin-node/commit/4fa71cd0eafd7d708df15c8f0a85323fecd05561))
|
|
16
|
+
|
|
3
17
|
## [0.9.2-next.12](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.11...node-core-v0.9.2-next.12) (2026-08-17)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Function: isTracingRequired()
|
|
2
|
+
|
|
3
|
+
> **isTracingRequired**(`envVars`): `boolean`
|
|
4
|
+
|
|
5
|
+
Checks if the tracing subsystem is required.
|
|
6
|
+
Returns true when any component that depends on the tracing subsystem is enabled.
|
|
7
|
+
|
|
8
|
+
## Parameters
|
|
9
|
+
|
|
10
|
+
### envVars
|
|
11
|
+
|
|
12
|
+
[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
|
|
13
|
+
|
|
14
|
+
The environment variables.
|
|
15
|
+
|
|
16
|
+
## Returns
|
|
17
|
+
|
|
18
|
+
`boolean`
|
|
19
|
+
|
|
20
|
+
True if tracing is enabled.
|
package/docs/reference/index.md
CHANGED
|
@@ -49,6 +49,7 @@
|
|
|
49
49
|
- [isTaskSchedulerRequired](functions/isTaskSchedulerRequired.md)
|
|
50
50
|
- [isAutomationRequired](functions/isAutomationRequired.md)
|
|
51
51
|
- [isTelemetryRequired](functions/isTelemetryRequired.md)
|
|
52
|
+
- [isTracingRequired](functions/isTracingRequired.md)
|
|
52
53
|
- [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
|
|
53
54
|
- [isAuthEntityStorageRequired](functions/isAuthEntityStorageRequired.md)
|
|
54
55
|
- [extensionsConfiguration](functions/extensionsConfiguration.md)
|
|
@@ -1023,6 +1023,36 @@ Maximum number of values retained per telemetry metric (count-based history cap)
|
|
|
1023
1023
|
|
|
1024
1024
|
***
|
|
1025
1025
|
|
|
1026
|
+
### telemetryBatchSize? {#telemetrybatchsize}
|
|
1027
|
+
|
|
1028
|
+
> `optional` **telemetryBatchSize?**: `string`
|
|
1029
|
+
|
|
1030
|
+
The batch size for the telemetry connector, set to 1 to disable size-based flushing.
|
|
1031
|
+
|
|
1032
|
+
***
|
|
1033
|
+
|
|
1034
|
+
### telemetryBatchFlushInterval? {#telemetrybatchflushinterval}
|
|
1035
|
+
|
|
1036
|
+
> `optional` **telemetryBatchFlushInterval?**: `string`
|
|
1037
|
+
|
|
1038
|
+
The batch flush interval in seconds for the telemetry connector, how often to flush when using batching, defaults to 5 seconds.
|
|
1039
|
+
|
|
1040
|
+
***
|
|
1041
|
+
|
|
1042
|
+
### telemetryMaxCacheSize? {#telemetrymaxcachesize}
|
|
1043
|
+
|
|
1044
|
+
> `optional` **telemetryMaxCacheSize?**: `string`
|
|
1045
|
+
|
|
1046
|
+
The maximum number of metric values to hold in the write-ahead cache for the telemetry connector. Set to 0 for unlimited.
|
|
1047
|
+
|
|
1048
|
+
#### Default
|
|
1049
|
+
|
|
1050
|
+
```ts
|
|
1051
|
+
1000
|
|
1052
|
+
```
|
|
1053
|
+
|
|
1054
|
+
***
|
|
1055
|
+
|
|
1026
1056
|
### telemetryMutexTimeout? {#telemetrymutextimeout}
|
|
1027
1057
|
|
|
1028
1058
|
> `optional` **telemetryMutexTimeout?**: `string`
|
|
@@ -129,3 +129,11 @@ List of properties to obfuscate in the REST logging output, comma separated.
|
|
|
129
129
|
> `optional` **routeMetricsExcludePaths?**: `string`
|
|
130
130
|
|
|
131
131
|
Comma-separated list of URL path prefixes excluded from metrics collection.
|
|
132
|
+
|
|
133
|
+
***
|
|
134
|
+
|
|
135
|
+
### routeTracingExcludePaths? {#routetracingexcludepaths}
|
|
136
|
+
|
|
137
|
+
> `optional` **routeTracingExcludePaths?**: `string`
|
|
138
|
+
|
|
139
|
+
Comma-separated list of URL path prefixes excluded from tracing.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/node-core",
|
|
3
|
-
"version": "0.9.2-next.
|
|
3
|
+
"version": "0.9.2-next.14",
|
|
4
4
|
"description": "TWIN Node Core for serving APIs using the specified configuration",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -42,6 +42,7 @@
|
|
|
42
42
|
"@twin.org/standards-w3c-odrl": "next",
|
|
43
43
|
"@twin.org/telemetry-connector-opentelemetry": "next",
|
|
44
44
|
"@twin.org/tracing-connector-opentelemetry": "next",
|
|
45
|
+
"@twin.org/tracing-models": "next",
|
|
45
46
|
"@twin.org/vault-models": "next",
|
|
46
47
|
"@twin.org/wallet-connector-entity-storage": "next",
|
|
47
48
|
"@twin.org/wallet-models": "next",
|