# @grest-ts/metrics 中文文档

规范地址：https://npmcn.com/package/%40grest-ts/metrics/

版本：0\.0\.101
npm 元数据更新时间：2026-11-02T15:34:52.235Z
中文译文更新时间：2026-11-17T07:05:39.059Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40grest-ts/metrics
原文对照：https://npmcn.com/package/%40grest-ts/metrics/?lang=original
项目主页：https://grest-ts.com/packages/metrics
源码仓库：https://github.com/grest-ts/grest-ts

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：179 kB，129 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：0 个
- peer 依赖：@grest-ts/common 0\.0\.101，@grest-ts/locator 0\.0\.101
- 首次发布：2026-02-24T10:54:21.867Z
- 最新版本发布：2026-11-02T15:34:52.051Z
- 近 30 天下载量：5315（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：84（近 12 个月 84 个）

## 中文简介

Grest 框架的计量库

## 安装

```sh
npm install @grest-ts/metrics
```

也可以使用：`pnpm add @grest-ts/metrics`、`yarn add @grest-ts/metrics`、`bun add @grest-ts/metrics`

## README

> 部分 [灰尘](https://github.com/grest-ts/grest-ts) 框架. [文档](https://github.com/grest-ts/grest-ts#readme) | [所有软件包](https://github.com/grest-ts/grest-ts#package-reference)

# @ grest-ts/ 度数

Grest Framework的Type安全度量衡收藏库.

## 特征

类型安全度量衡收集库,用于支持计数器,计分仪和直方图.

提供一种结构化方法,用以定义、收集和出口应用度量衡:

-   Prometheus- systems (Counter, Gauge, 直方图)
-   类型安全标签
-   集中计量定义
-   多种导出格式

类型安全度量衡收集库,用于支持计数器,计分仪和直方图.

## 快速使用示例

```typescript
// Define metric keys.
// This additionally acts as documentation of metrics provided by the application.
export const AppMetrics = GGMetrics.define('/app/', () => ({
    actions: new GGCounterKey('actions_total', {
        help: 'Total number of actions',
        labelNames: ['type']
    }),
    // ... add more metrics here. All well documented and type safe.
}));

// Usage in the runtime.
AppMetrics.actions.inc(1, {type: "read"}); // labels are typesafe (values are always strings)

```

## 文档

-   [使用量](https://npmcn.com/package/%40grest-ts/metrics/README-usage.md) - 如何界定和收集指标
-   [测试](https://npmcn.com/package/%40grest-ts/metrics/README-testkit.md) - 如何用测试基特测试计量变化
-   [扩展](https://npmcn.com/package/%40grest-ts/metrics/README-extending.md) - 如何增加海关出口商

## 常见问题

### @grest-ts/metrics 是什么？

Grest 框架的计量库

### 如何安装 @grest-ts/metrics？

在项目目录运行 npm install @grest-ts/metrics，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@grest-ts/common（0\.0\.101）、@grest-ts/locator（0\.0\.101）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @grest-ts/metrics 支持 TypeScript 吗？

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

### @grest-ts/metrics 支持 ESM 还是 CommonJS？

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

### @grest-ts/metrics 需要什么版本的 Node\.js？

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

### @grest-ts/metrics 可以商用吗？

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

### @grest-ts/metrics 的下载量有多少？

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

### @grest-ts/metrics 还在维护吗？

最新版本 0\.0\.101 发布于 2026/11/02（14 天前）；至今共发布 84 个版本，其中过去 12 个月发布了 84 个；首次发布于 2026/02/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

