agent-inspect 1.3.0 → 1.4.0
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 +19 -4
- package/README.md +39 -37
- package/docs/ADAPTERS.md +111 -31
- package/docs/API.md +15 -5
- package/docs/CLI.md +62 -1
- package/docs/EXPORTS.md +73 -15
- package/docs/GETTING-STARTED.md +29 -1
- package/docs/KNOWN-ISSUES.md +6 -0
- package/docs/LIMITATIONS.md +8 -2
- package/docs/SCHEMA.md +5 -4
- package/package.json +1 -1
- package/packages/cli/dist/index.cjs +748 -0
- package/packages/cli/dist/index.cjs.map +1 -1
- package/packages/cli/dist/index.mjs +748 -0
- package/packages/cli/dist/index.mjs.map +1 -1
- package/packages/core/dist/index.cjs +575 -0
- package/packages/core/dist/index.cjs.map +1 -1
- package/packages/core/dist/index.d.cts +126 -1
- package/packages/core/dist/index.d.ts +126 -1
- package/packages/core/dist/index.mjs +569 -1
- package/packages/core/dist/index.mjs.map +1 -1
package/docs/SCHEMA.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Schema (AgentInspect 1.
|
|
1
|
+
# Schema (AgentInspect 1.x)
|
|
2
2
|
|
|
3
3
|
This document describes the **persisted manual trace JSONL schema** and the **log-derived normalized model** used by AgentInspect.
|
|
4
4
|
|
|
@@ -25,7 +25,7 @@ Manual trace events use:
|
|
|
25
25
|
|
|
26
26
|
- **`schemaVersion: "0.1"`**
|
|
27
27
|
|
|
28
|
-
Existing `0.1` traces remain readable
|
|
28
|
+
Existing `0.1` traces remain readable across AgentInspect 1.x.
|
|
29
29
|
|
|
30
30
|
### 2.3 TraceEvent union
|
|
31
31
|
|
|
@@ -133,6 +133,7 @@ Unknown status must **not** be treated as success.
|
|
|
133
133
|
- Steps may include `metadata` on `step_started`.
|
|
134
134
|
- Manual traces intentionally avoid full prompt/output capture by default.
|
|
135
135
|
- **Redaction (default on):** before disk, `inspectRun` / `step` redact sensitive keys using the shared `Redactor` defaults (`authorization`, `cookie`, `token`, `apiKey`, `password`, `secret`, `email`). Opt out with `redact: false`.
|
|
136
|
+
- **Redaction profiles (v1.3.0+):** optional `redactionProfile` (`local`, `share`, `strict`) adds preset extra keys and tighter metadata bounds for trace writing. Key-based only — not compliance-grade DLP. `export --redaction-profile` applies profiles to export copies without mutating source JSONL.
|
|
136
137
|
- **Size bounds:** long string values are truncated (`maxMetadataValueLength`, default 2000; preview-like keys use `maxPreviewLength`, default 500). Serialized events are capped at `maxEventBytes` (default 65536 UTF-8 bytes). If still too large, `metadata` may be replaced with `{ truncated: true, reason: "maxEventBytes", originalApproxBytes: number }`. Required event fields are never removed.
|
|
137
138
|
|
|
138
139
|
## 7. Additive fields and unknown fields
|
|
@@ -150,7 +151,7 @@ Manual trace reading:
|
|
|
150
151
|
|
|
151
152
|
## 9. Backward compatibility
|
|
152
153
|
|
|
153
|
-
- v0.1 JSONL traces remain readable
|
|
154
|
+
- v0.1 JSONL traces remain readable across AgentInspect 1.x.
|
|
154
155
|
- No automatic migrations or rewriting of old files.
|
|
155
156
|
|
|
156
157
|
## 10. Breaking change policy
|
|
@@ -235,7 +236,7 @@ Canonical samples: `fixtures/traces-v0.2/*.jsonl` (validated by `pnpm fixtures:c
|
|
|
235
236
|
| `tokenUsage` | no | `{ input?, output?, total? }` when known |
|
|
236
237
|
| `trace` | no | Optional `{ traceId?, spanId?, parentSpanId? }` for future OTel alignment |
|
|
237
238
|
|
|
238
|
-
Programmatic helpers: see [API.md](./API.md) §
|
|
239
|
+
Programmatic helpers: see [API.md](./API.md) §11 (experimental persisted-event foundation).
|
|
239
240
|
|
|
240
241
|
## 15. Migration notes
|
|
241
242
|
|