@codelitdev/observability

中文文档
0.8.2发布于 2026/11/09MITTypeScriptES Module构建来源已验证近 30 天下载 3042

Provider-neutral logging and optional telemetry for CodeLit products

原始使用文档

@codelitdev/observability

Explicit createObservability factory for structured stdout logging and optional exception/event capture. The package does not read environment variables or construct SDK clients at import. Products pass configuration and own event catalogs. Tenant identity is an opaque subjectId.

Pass posthog: { apiKey } for best-effort HTTP capture or provide a typed client in tests. logs.otlp adds an OTLP/HTTP log fan-out while structured stdout remains enabled; both remote pipelines are failure-isolated and timeout-bounded during shutdown.

Both pipelines queue what they send and post it in batches (PostHog /batch/, one OTLP request per batch): every second or once 50 items are waiting, with a 10-second request timeout and two retries on network errors, 429 and 5xx. The queue holds at most 1,000 items, dropping the oldest. Call shutdown() before a process exits, or queued items are lost.

contextPolicy.propertyAllowlist decides which properties are sent. String values are masked for emails, secrets and anything that looks like a token (24 or more letters, digits, - or _). List keys that hold opaque record ids, such as team_id, in contextPolicy.identifierKeys so their UUIDs are not masked too. Never list a key that can hold a session or access token.

Next.js (and other browser) apps use createBrowserObservability from @codelitdev/observability/browser. Pass apiKey from request-time env (POSTHOG_API_KEY), not NEXT_PUBLIC_*, so OSS images can enable telemetry at container start. Missing apiKey is a no-op and does not load posthog-js. After init, call identify({ id }) with a stable auth user id and reset() on logout. Session recording uses PostHog JS defaults; enable Session replay on the project to record.

版本与发布记录

@codelitdev/observability 共发布 12 个版本,首次发布于 2026/09/05;过去 12 个月发布了 12 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.8.2latest2026/11/09今天
0.8.12026/11/018 天前
0.8.02026/11/018 天前
0.7.02026/11/018 天前
0.6.02026/11/018 天前
0.5.02026/10/3010 天前

其他发布通道:alpha → 0.1.0-alpha.0。

关于 @codelitdev/observability 的常见问题

@codelitdev/observability 是什么?

Provider-neutral logging and optional telemetry for CodeLit products

如何安装 @codelitdev/observability?

在项目目录运行 npm install @codelitdev/observability,或使用 pnpm add / yarn add / bun add。

@codelitdev/observability 支持 TypeScript 吗?

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

@codelitdev/observability 支持 ESM 还是 CommonJS?

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

@codelitdev/observability 可以商用吗?

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

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

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

@codelitdev/observability 还在维护吗?

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