@agimon-ai/doompi-telemetry 0.0.1-alpha.28 → 0.0.1-alpha.29
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/README.md +15 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,8 @@ Host-neutral telemetry helpers and Log Sink adapters shared by DoomPi packages.
|
|
|
4
4
|
|
|
5
5
|
Part of the [DoomPi distribution](https://www.npmjs.com/package/@agimon-ai/doompi).
|
|
6
6
|
|
|
7
|
-
This is a library, not a Pi extension. It has no Pi manifest or Pi peer dependency and should not
|
|
7
|
+
This is a library, not a Pi extension. It has no Pi manifest or Pi peer dependency and should not
|
|
8
|
+
be added to a DoomPi layer.
|
|
8
9
|
|
|
9
10
|
> **Alpha:** telemetry attributes and sink contracts may change between releases.
|
|
10
11
|
|
|
@@ -37,17 +38,25 @@ await telemetry.flush();
|
|
|
37
38
|
await telemetry.shutdown();
|
|
38
39
|
```
|
|
39
40
|
|
|
40
|
-
The root and `/telemetry` subpath expose `createDoomTelemetry`, attribute sanitization, header
|
|
41
|
+
The root and `/telemetry` subpath expose `createDoomTelemetry`, attribute sanitization, header
|
|
42
|
+
creation, record subscriptions, and related types.
|
|
41
43
|
|
|
42
44
|
## Data and failure behavior
|
|
43
45
|
|
|
44
|
-
The adapter sanitizes attribute shapes and hashes selected identifiers before export. It is designed
|
|
46
|
+
The adapter sanitizes attribute shapes and hashes selected identifiers before export. It is designed
|
|
47
|
+
for operational metadata, but callers remain responsible for the values they pass. Do not attach
|
|
48
|
+
prompt text, file contents, credentials, or unreviewed user data.
|
|
45
49
|
|
|
46
|
-
Exception export is optional and can include error names, messages, and stack context. Those fields
|
|
50
|
+
Exception export is optional and can include error names, messages, and stack context. Those fields
|
|
51
|
+
may disclose code paths or values even when ordinary attributes are metadata-only.
|
|
47
52
|
|
|
48
|
-
When no endpoint is configured, telemetry export becomes a no-op rather than breaking the host.
|
|
53
|
+
When no endpoint is configured, telemetry export becomes a no-op rather than breaking the host.
|
|
54
|
+
Explicit file fallback must be enabled by the caller; it is not silently selected. Status and
|
|
55
|
+
diagnostic callbacks surface sink initialization, recording, flushing, and shutdown behavior.
|
|
49
56
|
|
|
50
|
-
Common controls used by DoomPi hosts include `AGENT_TELEMETRY_DISABLED`, `OTEL_SDK_DISABLED`, and
|
|
57
|
+
Common controls used by DoomPi hosts include `AGENT_TELEMETRY_DISABLED`, `OTEL_SDK_DISABLED`, and
|
|
58
|
+
`AGENT_OTEL_TRACES`. Hosts must decide whether these variables, endpoint configuration, or explicit
|
|
59
|
+
options have precedence in their integration.
|
|
51
60
|
|
|
52
61
|
## Development
|
|
53
62
|
|
package/package.json
CHANGED