# @bonniernews/exp-metrics 中文文档

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

版本：4\.0\.0
npm 元数据更新时间：2026-10-27T13:06:35.560Z
中文译文更新时间：2026-11-08T11:05:24.316Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bonniernews/exp-metrics
原文对照：https://npmcn.com/package/%40bonniernews/exp-metrics/?lang=original
项目主页：https://github.com/BonnierNews/exp-metrics

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

- 包体积（解压后）：14.3 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：8 个
- 首次发布：2018-10-01T07:32:42.615Z
- 最新版本发布：2026-10-27T13:06:32.059Z
- 近 30 天下载量：2328（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 1 个）

## 中文简介

为您的快速应用 简单的 prootheus 测量标准 .

## 安装

```sh
npm install @bonniernews/exp-metrics
```

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

## README

# exp 计量

[![Run tests](https://github.com/BonnierNews/exp-metrics/actions/workflows/run-tests.yml/badge.svg)](https://github.com/BonnierNews/exp-metrics/actions/workflows/run-tests.yml)

简单包装 [打开几何](https://github.com/open-telemetry/opentelemetry-js) 与 API 相同的参数 [舞会客户](https://www.npmjs.com/package/prom-client), (中文(简体) ), 过渡 `prom-client` 简单,并添加功能 OpenTeleometry 缺少 .

## 指标类型和API

-   计数器
    -   `inc([labels,] [value])`
-   高盖
    -   `set([labels,] value)`
    -   `inc([labels,] [value])`
    -   `dec([labels,] [value])`
-   摘要(以 OpenTelection 术语表示的图像)
    -   `observe([labels,] value)` 或者说 `observe(value[, labels])`

创建一个已存在名称的公尺返回现有的公尺, 所以 `metrics.counter({ name: "x" })` 每一个请求都可以安全呼叫.

一个测量器每个标签集保持一个值,即:. `gauge.set({ queue: "a" }, 1)` 财务报告和审定财务报表 `gauge.set({ queue: "b" }, 2)` 报告为两个系列.

## 安装

```sh
npm install @bonniernews/exp-metrics
```

## 使用量

```javascript
const expMetrics = require("@bonniernews/exp-metrics");

metrics = expMetrics("my-service-name", {
  // optional overrides, see more below
});

const myCounter = metrics.counter({
  name: "my_counter",
  help: "My counter",
})

myCounter.inc(2);
myCounter.inc({ foo: "bar" }, 3);

```

更多见于 [舞会客户](https://github.com/siimon/prom-client?tab=readme-ov-file#custom-metrics) 文档.

包含类型脚本.

### 选项

-   `enabled` (默认) `true`: `false` 保持相同的API, 但输出无任何信息, 也从未调用 Google Cloud, 例如用于测试和当地开发
-   `buckets`:每个摘要的直方图桶,见 [直方图桶](https://npmcn.com/package/%40bonniernews/exp-metrics/#readme-histogram-buckets)

任何其他密钥被设置为 OpenTelemetry 资源属性, 压倒默认值(`gcp.project_id`, (中文(简体) ), `service.name`, (中文(简体) ), `service.namespace`, (中文(简体) ), `service.instance.id`) (中文(简体) ). 见 [OpenTeleometry 文档](https://www.npmjs.com/package/@opentelemetry/resources)。 。 。 .

### 直方图桶

摘要默认导出为指数直方图 。 每个系列的分辨率都很好, 但每个系列都选取自己的桶布局,因此"云监测"(Cloud Monitoring)中跨系列集合的百分位数(例如所有情况下的p95)可能非常粗糙.

明晰的"桶"给每个系列都提供了相同的布局,所以它们精确地聚合,精度的"桶"宽:

```javascript
// one summary
metrics.summary({ name: "my_summary", buckets: [ 10, 50, 100, 250, 500, 1000 ] });

// every summary, including http_response_time_milliseconds
// true = OpenTelemetry defaults [ 0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000 ]
expMetrics("my-service-name", { buckets: true });
expMetrics("my-service-name", { buckets: [ 10, 50, 100, 250, 500, 1000 ] });
```

附有其自己的摘要 `buckets` 带有仪器范围的导出 `exp-metrics-buckets` 改为 `exp-metrics`。 。 。 .

### 关闭

度量衡每60秒出口一次. 在进程退出前将剩余度量标准流出 :

```javascript
process.on("SIGTERM", async () => {
  await metrics.shutdown();
  process.exit(0);
});
```

## 谷歌云号

计量器每60秒通过OTLP输出一次 [谷歌云遥测 API](https://docs.cloud.google.com/stackdriver/docs/reference/telemetry/overview), (中文(简体) ), 以应用程序默认身份验证 。 项目由证书解决(或 `GOOGLE_CLOUD_PROJECT`, (中文(简体) ), 和被制服 `"gcp.project_id"` 在配置中.

所需经费:

-   启用了遥测 API : `gcloud services enable telemetry.googleapis.com`
-   服务账户有: `roles/telemetry.writer` 角色

量子出现在云监测中 `prometheus.googleapis.com/<name>/<counter|gauge|histogram>` 编辑 `prometheus_target` 资源, 譬如说. `prometheus.googleapis.com/http_responses_total/counter`。 。 。 .

## 常见问题

### @bonniernews/exp-metrics 是什么？

为您的快速应用 简单的 prootheus 测量标准 \.

### 如何安装 @bonniernews/exp-metrics？

在项目目录运行 npm install @bonniernews/exp-metrics，或使用 pnpm add / yarn add / bun add。

### @bonniernews/exp-metrics 支持 TypeScript 吗？

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

### @bonniernews/exp-metrics 支持 ESM 还是 CommonJS？

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

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

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

### @bonniernews/exp-metrics 可以商用吗？

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

### @bonniernews/exp-metrics 的下载量有多少？

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

### @bonniernews/exp-metrics 还在维护吗？

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