@aaac/observability

中文文档
0.3.0发布于 2026/10/20MITTypeScriptES Module近 30 天下载 6442

@aaac — 事件控制器/ 规范器/ 关联器/ SqliteSink 的流程中可观察性

中文使用文档
文档目录7 节
  1. 安装
  2. 它会做什么
  3. 图书馆使用情况
  4. CLI: 爱丽丝 aaac-observ
  5. E2E 测试助手(可观察堆栈)
  6. 文档
  7. 许可证

@aaac/可观察性

aaac-native,在流程中的可观察性记录AaaC工具链. 记录代理 / 处理/ 促销活动进入本地的 SQLite 商店并发送 它们是通用的OTEL后端。 见 docs/observability-spec/ 完全设计.

安装

npm install @aaac/observability

需要节点(使用内置) node:sqlite) (中文(简体) ).

它会做什么

  • 进程内记录数字 : @aaac/runtime 通过 observer.emit(); 外部进程( git / cursor hooks, CI) 注册事件 通过 registerExternalEvent()。 。 。 .
  • 管道: 事件控制器 – 常态器 – 关联器(平面寿命周期配对, 持续时间, trackId) → richer (TypeScript相關完成) → SqliteSink
    • 奥特尔艾密特.
  • 佳能节 有跨轴链接的内部模型; OTEL 是导出 代表(Span / SpanLink).
  • 一般电信业务汇总数字 : OtelEmitter 批次: Canonical Events to an OTLP相容后端(无法打开——本地SQLite总是记录).
  • 查询( 读取路径)数字 : QueryAdapter 在SQLite商店上方——横跨/追踪/ 链接 traversal, 独立于写入路径.

图书馆使用情况

import { createPipeline, EventCollector } from "@aaac/observability";

CLI: 爱丽丝 aaac-observ

外部事件注册和查询的细小切入点( 界面) (通过cli-contracts定义).

aaac-observ record --event-type process.edit --lifecycle instant --attr edit.path=src/x.ts
aaac-observ query trace --trace-id <id>

E2E 测试助手(可观察堆栈)

这个 __tests__/e2e/stack/ 目录包含用于 aaac可观察性堆放(ClickHouse / Tempo / Grafana). 后续问题 (单位:千美元)#163+)可以导入共享助手 :

import {
  seedAndBackfill,
  queryClickHouse,
  assertViewRow,
  applyAnalysisViews,
  waitForSeedData,
} from '@aaac/observability/__tests__/e2e/stack/helpers.js';
import { SEED_SESSION_ID } from
  '@aaac/observability/__tests__/e2e/stack/__fixtures__/observability-stack-seed.js';
import { loadStackConfig } from '@aaac/observability/__tests__/e2e/load-stack-config.js';

// Example usage in a follow-up E2E test:
const config = loadStackConfig();
const seed = await seedAndBackfill(config, { flushTimeoutMs: 30_000 });
await waitForSeedData(config, SEED_SESSION_ID);
const rows = await queryClickHouse<{ session_id: string }>(
  config,
  'SELECT session_id FROM aaac_agent_sessions LIMIT 1',
);
assertViewRow(rows, 'session_id', SEED_SESSION_ID);
await seed.cleanup();

见 docs/observability-setup.md 用于完整的 E2E 运行指令.

文档

  • 事件格式和目录 : docs/observability-spec/event-catalog.md
  • 结构 : docs/observability-spec/architecture.md
  • 三轴型号: docs/observability-spec/shift-left-guidline-v2.md
  • E2E 设置和运行 : docs/observability-setup.md

许可证

麻省理工学院

版本与发布记录

@aaac/observability 共发布 29 个版本,首次发布于 2026/06/08;过去 12 个月发布了 29 个版本。

版本发布日期距今
0.3.0latest2026/10/2018 天前
0.2.102026/10/2018 天前
0.2.92026/10/1127 天前
0.2.82026/10/1127 天前
0.2.72026/10/0929 天前
0.2.62026/10/061 个月前

关于 @aaac/observability 的常见问题

@aaac/observability 是什么?

@aaac — 事件控制器/ 规范器/ 关联器/ SqliteSink 的流程中可观察性

如何安装 @aaac/observability?

在项目目录运行 npm install @aaac/observability,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 aaac-observ、aaac-observ-global-record,可以用 npx aaac-observ 直接运行。

@aaac/observability 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@aaac/observability 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@aaac/observability 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.5.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@aaac/observability 可以商用吗?

@aaac/observability 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@aaac/observability 的下载量有多少?

根据 npm 官方下载统计,@aaac/observability 在 2026/10/05 – 2026/11/03 这 30 天内被下载 6,442 次,日均约 215 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@aaac/observability 还在维护吗?

最新版本 0.3.0 发布于 2026/10/20(18 天前);至今共发布 29 个版本,其中过去 12 个月发布了 29 个;首次发布于 2026/06/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。