文档
所有文档都提供原始 Markdown，便于 LLM 读取。机器可读的索引见 llms.txt。英文原版是权威版本；每篇中文文档的开头都有指向原文的链接。本站托管的参考文档是 JVM 版本；每个运行时都在自己的仓库里带着自己的文档 — 从那里开始。
按运行时
-
TypeScript — 60 秒看一条追踪
@narrativetrace/*—traceObject、@traced装饰器、Vitest fixture；20 个包已在 npm 上线 -
Java — 60 秒看一条追踪
ai.narrativetrace，Maven Central — Gradle 插件、代理、JUnit 5 -
.NET — 60 秒看一条追踪
NarrativeTrace.*，nuget.org —NarrativeTraceProxy.Create、AddNarrativeTracing、xUnit fixture -
Python — 60 秒看一条追踪
narrativetrace，PyPI —trace_object、@narrated装饰器、pytest fixture
入门
- 入门指南 选择一个运行时，60 秒看一条追踪，然后查看安装指南和功能指南
核心概念
集成
TypeScript
- Vitest fixture 逐测试的 narrativeTest fixture——自动生成追踪文件，并提供逐测试的清晰度与失败报告
- Express 中间件 为每个请求打开一个追踪上下文的中间件，并提供容错的提取器
- NestJS AutoProxyModule 自动包装每个 DI provider——实现零代码追踪
- Pino 将调用事件发送到 Pino 日志记录器，并在你自己的日志行上标注追踪身份
- OpenTelemetry 将捕获的调用叙事映射为 OpenTelemetry span，支持实时或批量导出
Java
- Spring Boot @EnableNarrativeTrace、异步支持、Spring Boot 集成
- JUnit 5 逐测试追踪文件、自上次绿色以来的差异、审批模式、清晰度报告
- JUnit 4 面向遗留测试套件的 @Rule 集成
- SLF4J 桥接 MDC 字段，与现有日志共存
- Java Agent 零代码字节码插桩；面向应用服务器和未修改 WAR 的独立 jar
- Micrometer @Async 与 CompletableFuture 的跨线程上下文传播
- Gradle 插件 一段配置搞定；clarityCheck、glossaryScan 与 approveNarratives 任务 —— 0.2.0
.NET
- Microsoft.Extensions.Logging 通过 decorator、exporter 或 DI listener，将追踪事件路由到你已有的 ILogger
- ASP.NET Core 中间件 按请求作用域的追踪上下文，支持可插拔的 exporter 与路径排除
- DI 自动包装 AddNarrativeTracing 按命名空间自动为每个 DI 注册的服务加上装饰——无需修改代码
- xUnit 测试失败时，NarrativeFixture 自动讲述捕获的追踪
- NUnit NarrativeTestBase 连接 setup/teardown 上下文，并通过 TestContext 讲述失败
- OpenTelemetry 将追踪导出为 OpenTelemetry Activity span，支持实时或批量导出
Python
- pytest 插件 逐测试的 narrative_trace fixture，失败追踪报告，以及套件级清晰度评分摘要
- FastAPI / ASGI 中间件 每个 HTTP 请求生成一棵追踪树；传播 W3C traceparent 请求头
- structlog 一个 structlog processor，将追踪关联键注入每条 structlog 事件
- OpenTelemetry 将捕获的追踪导出为 OpenTelemetry span，支持实时或批量导出