@eventstore/opentelemetry

中文文档
0.1.0发布于 2024/09/02Apache-2.0TypeScriptCommonJS近 30 天下载 2545

[![license][license-badge]][license-badge-url] [![Github action CI workflow][ci-badge]][ci-badge-url]

原始使用文档
文档目录7 节
  1. Installation
  2. Supported Versions
  3. Usage
  4. Useful links
  5. Support
  6. Communities
  7. Contributing

@eventstore/opentelemetry

license Github action CI workflow

This module provides automatic tracing instrumentation for EventStore-Client-NodeJS.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @eventstore/opentelemetry

Supported Versions

  • [6.x]

It's likely that the instrumentation would support earlier versions of EventStoreDB, but this has not been tested.

Usage

OpenTelemetry EventStoreDB Instrumentation allows the user to automatically collect trace data from append and subscription operations and export them to the backend of choice.

To load the instrumentation, specify it in the instrumentations list to registerInstrumentations. There is currently no configuration option.

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { EventStoreDBInstrumentation } = require('@eventstore/opentelemetry');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new EventStoreDBInstrumentation(),
  ],
});

Support

Information on support can be found on our website: Event Store Support

Communities

Contributing

Refer to our contribution guidelines.

版本与发布记录

@eventstore/opentelemetry 共发布 2 个版本,首次发布于 2024/05/23;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.0latest2024/09/022 年前
0.1.0-alpha.02024/05/232 年前

关于 @eventstore/opentelemetry 的常见问题

@eventstore/opentelemetry 是什么?

[![license][license-badge]][license-badge-url] [![Github action CI workflow][ci-badge]][ci-badge-url]

如何安装 @eventstore/opentelemetry?

在项目目录运行 npm install @eventstore/opentelemetry,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@eventstore/db-client(^6)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@eventstore/opentelemetry 支持 TypeScript 吗?

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

@eventstore/opentelemetry 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@eventstore/opentelemetry 需要什么版本的 Node.js?

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

@eventstore/opentelemetry 可以商用吗?

@eventstore/opentelemetry 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@eventstore/opentelemetry 的下载量有多少?

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

@eventstore/opentelemetry 还在维护吗?

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