# @bmatei/apollo-prometheus-exporter 中文文档

规范地址：https://npmcn.com/package/%40bmatei/apollo-prometheus-exporter/

版本：3\.0\.0
npm 元数据更新时间：2023-11-22T20:21:08.409Z
中文译文更新时间：2026-11-08T09:12:19.060Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bmatei/apollo-prometheus-exporter
原文对照：https://npmcn.com/package/%40bmatei/apollo-prometheus-exporter/?lang=original
项目主页：https://github.com/bfmatei/apollo-prometheus-exporter#readme
源码仓库：https://github.com/bfmatei/apollo-prometheus-exporter

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

- 包体积（解压后）：59.1 kB，24 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：prom-client ^12\.0\.0 \|\| ^13\.0\.0 \|\| ^14\.0\.0
- 首次发布：2020-12-08T13:04:41.485Z
- 最新版本发布：2023-11-22T20:21:08.227Z
- 近 30 天下载量：39485（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

阿波罗服务器以普罗米修斯格式导出参数的插件

## 安装

```sh
npm install @bmatei/apollo-prometheus-exporter
```

也可以使用：`pnpm add @bmatei/apollo-prometheus-exporter`、`yarn add @bmatei/apollo-prometheus-exporter`、`bun add @bmatei/apollo-prometheus-exporter`

## README

# 阿波罗·普罗米修斯导出器

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/bfmatei/apollo-prometheus-exporter/Release) ![npm](https://img.shields.io/npm/v/@bmatei/apollo-prometheus-exporter)

阿波罗服务器以普罗米修斯格式导出度量衡的插件 .

用这个 [舞会客户](https://github.com/siimon/prom-client) 在盖子下面,导出度量衡.

自从阿波罗服务器发布新的主要版本后,出口商的新版本(v2.x.y)已经推出. 阿波罗 服务器 v2 仍然在 v1.x.y. 这两个版本将尽可能与特征相匹配.

## 计量

| 名称 | 说明 | 类型 |
| --- | --- | --- |
| `apollo_server_starting` | 阿波罗服务器启动时的最后时刻戳. | 高盖 |
| `apollo_server_closing` | 阿波罗服务器关闭时的最后一个时间戳. | 高盖 |
| `apollo_query_started` | 收到查询的数量. | 计数器 |
| `apollo_query_failed` | 失败的查询量 . | 计数器 |
| `apollo_query_parse_started` | 解析开始的查询量 . | 计数器 |
| `apollo_query_parse_failed` | 解析失败的查询量 . | 计数器 |
| `apollo_query_validation_started` | 已经开始验证的查询量 . | 计数器 |
| `apollo_query_validation_failed` | 验证失败的查询量 . | 计数器 |
| `apollo_query_resolved` | 可解决的查询数量. | 计数器 |
| `apollo_query_execution_started` | 已经开始执行的查询数量 . | 计数器 |
| `apollo_query_execution_failed` | 执行失败的查询量 . | 计数器 |
| `apollo_query_duration` | 查询的总持续时间. | 直方图 |
| `apollo_query_field_resolution_duration` | 解决字段的总长度 . | 直方图 |

关于默认衡量标准,请参考 [舞会客户](https://github.com/siimon/prom-client) 默认参数.

## 使用量

1.  安装 `prom-client` 财务报告和审定财务报表 `@bmatei/apollo-prometheus-exporter`
    
    ```shell
    npm install prom-client @bmatei/apollo-prometheus-exporter
    ```
    
2.  创建插件实例
    
    ```ts
    const app = express();
    
    const prometheusExporterPlugin = createPrometheusExporterPlugin({ app });
    ```
    
3.  将插件添加到阿波罗服务器
    
    ```ts
    const server = new ApolloServer({
      plugins: [prometheusExporterPlugin]
    });
    ```
    

完整的例子,请看一下 `example` 此寄存器中的项目.

## 选项

| 名称 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `app` | 快速实例。 目前,它被用于确定衡量终点。 除非 `metricsEndpoint` 被设定为虚假. | `Express` | `undefined` |
| `defaultLabels` | 包含默认标签的对象将随每个度量发送. | `Object` | `{}` |
| `defaultMetrics` | 启用/禁用默认参数的旗帜 `prom-client`。 。 。 . | `Boolean` | `true` |
| `defaultMetricsOptions` | 默认参数的配置对象 . | `DefaultMetricsCollectorConfiguration` | `{}` |
| `durationHistogramBuckets` | 直方图应当使用的期限列表. | `number[]` | `[0.001, 0.005, 0.015, 0.05, 0.1, 0.2, 0.3, 0.4, 0.5, 1, 5, 10]` |
| `hostnameLabel` | 要启用/ 无法启用的旗帜 `hostname` 标签. | `Boolean` | `true` |
| `hostnameLabelName` | 名称 `hostname` 标签. | `String` | `hostname` |
| `metricsEndpoint` | 启用/ 禁用公尺终点的旗帜 。 如果您禁用此选项, 您可以使用 `registerPrometheusMetricsEndpoint` 方法可以启用度量衡终点. | `Boolean` | `true` |
| `metricsEndpointPath` | HTTP 路径, 其中将发布测量值 . | `String` | `"/metrics"` |
| `register` | 普罗米修斯客户端注册表供阿波罗计量公司使用. 默认情况下,它也被默认的度量衡所使用. | `Registry` | `register` |
| `skipMetrics` | 用于控制是否启用或禁用一个计量的密钥值映射 . | `SkipMetricsMap` | `{}` |

## 谢谢

-   [舞会客户](https://github.com/siimon/prom-client)
-   [外观测量](https://github.com/dotellie/apollo-metrics)

## 常见问题

### @bmatei/apollo-prometheus-exporter 是什么？

阿波罗服务器以普罗米修斯格式导出参数的插件

### 如何安装 @bmatei/apollo-prometheus-exporter？

在项目目录运行 npm install @bmatei/apollo-prometheus-exporter，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：prom-client（^12\.0\.0 \|\| ^13\.0\.0 \|\| ^14\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bmatei/apollo-prometheus-exporter 支持 TypeScript 吗？

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

### @bmatei/apollo-prometheus-exporter 支持 ESM 还是 CommonJS？

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

### @bmatei/apollo-prometheus-exporter 可以商用吗？

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

### @bmatei/apollo-prometheus-exporter 的下载量有多少？

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

### @bmatei/apollo-prometheus-exporter 还在维护吗？

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