# @bpinternal/promex 中文文档

规范地址：https://npmcn.com/package/%40bpinternal/promex/

版本：0\.5\.18
npm 元数据更新时间：2026-09-02T19:11:40.798Z
中文译文更新时间：2026-11-08T13:31:57.854Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bpinternal/promex
原文对照：https://npmcn.com/package/%40bpinternal/promex/?lang=original
项目主页：https://github.com/botpress/packages#readme
源码仓库：https://github.com/botpress/packages

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

- 包体积（解压后）：18.5 kB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.0\.0
- 运行依赖：0 个
- peer 依赖：nanoid 3\.3\.8，express 4\.21\.1，prom-client 15\.1\.3，@promster/types 13\.0\.0，@promster/server 13\.0\.0，@promster/express 13\.0\.0，@promster/metrics 13\.0\.0
- 首次发布：2022-10-12T19:28:27.027Z
- 最新版本发布：2025-07-18T16:09:51.085Z
- 近 30 天下载量：2551（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：32（近 12 个月 0 个）

## 中文简介

Prometheus 为节点提供快速初始化包.

## 安装

```sh
npm install @bpinternal/promex
```

也可以使用：`pnpm add @bpinternal/promex`、`yarn add @bpinternal/promex`、`bun add @bpinternal/promex`

## README

# 缩写

> Prometheus 客户端初始化软件包用于快取

## 使用量

Promex是初始化Promster库的一种工具. 安装软件包并参见下面的例子

```ts
import * as promex from '@bpinternal/promex';
import express from 'express';

const backend = express();
const admin = express();

[...]

promex.init(backend); // Adds a recording middleware on the express app
promex.init(admin); // Adds a recording middleware on the express app

[...]

promex.start() // Starts a metrics server on port 9090

```

Promex也可以在快取app上与处理器使用

```ts
import * as promex from '@bpinternal/promex';
import express from 'express';

const app = express()

app.get('/metrics', promex.handler()) // Adds a '/metrics' endpoint that returns the Prometheus metrics

promex.init(app) // Adds a recording middleware on the express app

[...]

app.listen()
```

## 免责声明

此软件包将在 `@bpinternal` 组织。 这个组织的所有软件包都用于 [瓶装](https://github.com/botpress/botpress) 内部的团队 并不适合我们的社区。 由于这些软件包适合我们自己的使用情况,它们可能不稳定的API,在没有警告的情况下接受中断的更改,文件很少,缺乏以社区为重点的支持。 然而,这些软件包仍然被故意公开,其重要原因如下: 我们爱开源. 因此,如果您想要安装或叉出这个软件包,就完全可以自由操作。 我们强烈建议你正确标记你的版本.

博讯工程组.

## 常见问题

### @bpinternal/promex 是什么？

Prometheus 为节点提供快速初始化包\.

### 如何安装 @bpinternal/promex？

在项目目录运行 npm install @bpinternal/promex，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：nanoid（3\.3\.8）、express（4\.21\.1）、prom-client（15\.1\.3）、@promster/types（13\.0\.0）、@promster/server（13\.0\.0）、@promster/express（13\.0\.0）、@promster/metrics（13\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bpinternal/promex 支持 TypeScript 吗？

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

### @bpinternal/promex 支持 ESM 还是 CommonJS？

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

### @bpinternal/promex 需要什么版本的 Node\.js？

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

### @bpinternal/promex 可以商用吗？

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

### @bpinternal/promex 的下载量有多少？

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

### @bpinternal/promex 还在维护吗？

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