@ancplua/qyl-semantic-conventions

中文文档
15.0.5发布于 2026/10/22Apache-2.0TypeScriptES Module零依赖近 30 天下载 2755

qyl semantic convention constants generated from the shared OpenTelemetry registry

原始使用文档

@ancplua/qyl-semantic-conventions

ES modules and TypeScript literal declarations generated from the same resolved Weaver registry as qyl's C# packages. No runtime dependencies. Individual named exports are tree-shakable.

import { ATTR_SERVICE_NAME, SCHEMA_URL } from '@ancplua/qyl-semantic-conventions';
import {
  ATTR_MCP_METHOD_NAME,
  METRIC_MCP_SERVER_OPERATION_DURATION,
  METRIC_MCP_SERVER_OPERATION_DURATION_UNIT,
} from '@ancplua/qyl-semantic-conventions/incubating';

The root export contains stable and deprecated migration conventions. ./incubating contains the complete vocabulary, including stable exports and qyl-owned development conventions. Upstream unstable conventions can change in minor releases. Deprecated keys remain migration symbols; importing them does not normalize telemetry.

Exports follow OpenTelemetry JavaScript names: ATTR_*, enum *_VALUE_*, METRIC_* and EVENT_*. Metrics also export METRIC_*_UNIT and METRIC_*_DEFINITION (name, instrument, unit and stability). SCHEMA_URL identifies the qyl schema; REGISTRY_SNAPSHOT_SHA256 identifies the shared resolved input, excluding source-location metadata such as temporary checkout paths. The C# RegistrySnapshot.Sha256 constant carries the same fingerprint. Literal .d.ts declarations and TypeScript sources are included alongside JavaScript.

Import findAttribute and findMetric from @ancplua/qyl-semantic-conventions/catalog for value kinds, template expansion, units, stability and deprecation metadata. Lookups return frozen records from the same normalized Weaver facts as C# RegistryCatalog. An unknown custom name returns undefined and remains valid OpenTelemetry. Requirements belong to the selected signal definition; registry membership does not establish scope ownership. The separate export keeps the complete catalog out of constant-only imports.

Import getCapturedFieldPersistence from @ancplua/qyl-semantic-conventions/policy to classify captured HTTP header and RPC metadata names using the same registry policy as C# RegistryPolicy.TryGetCapturedFieldPersistence. It returns true for valid names, false for bare roots or invalid names in those families, and undefined for unrelated keys. Matching is case-insensitive for ASCII. Callers still own capture selection and value-shape checks.

Generation runs through scripts/generate.sh at the repository root, using pinned official language-independent OpenTelemetry registries and qyl/vendor definitions. These bindings can release independently of OpenTelemetry SDK versions. SDKs/exporters and official OTLP wire definitions remain separate dependencies. The registry schema URL alone does not transform attributes.

版本与发布记录

@ancplua/qyl-semantic-conventions 共发布 22 个版本,首次发布于 2026/10/12;过去 12 个月发布了 22 个版本。

版本发布日期距今
15.0.5latest2026/10/2216 天前
15.0.42026/10/2216 天前
15.0.32026/10/2018 天前
15.0.22026/10/1919 天前
15.0.12026/10/1919 天前
15.0.02026/10/1919 天前

关于 @ancplua/qyl-semantic-conventions 的常见问题

@ancplua/qyl-semantic-conventions 是什么?

qyl semantic convention constants generated from the shared OpenTelemetry registry

如何安装 @ancplua/qyl-semantic-conventions?

在项目目录运行 npm install @ancplua/qyl-semantic-conventions,或使用 pnpm add / yarn add / bun add。

@ancplua/qyl-semantic-conventions 支持 TypeScript 吗?

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

@ancplua/qyl-semantic-conventions 支持 ESM 还是 CommonJS?

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

@ancplua/qyl-semantic-conventions 可以商用吗?

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

@ancplua/qyl-semantic-conventions 的下载量有多少?

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

@ancplua/qyl-semantic-conventions 还在维护吗?

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