@christiangalsterer/node-postgres-prometheus-exporter

中文文档
1.4.0发布于 2025/11/27MITTypeScriptCommonJS近 30 天下载 6.5万

节点输出方

中文使用文档
文档目录9 节
  1. 可用计量
  2. pg. 计算机计量
  3. pg. Pool计量器
  4. 示例输出
  5. 依赖性
  6. 类型脚本
  7. Java 脚本
  8. PgClient 输出选项
  9. PgPool 输出选项

GitHub Actions CI Status codecov Coverage Status Known Vulnerabilities npm downloads npm version npm license semver Conventional Commits renovate code style: prettier github stars

节点输出器

月球导出器 显示度量衡 节点后置。 。 。 .

可用计量

出口商提供以下衡量标准.

pg. 计算机计量

计量名称说明标签自兹
pg 客户端 错误 总计数据库连接错误的总数
  • 东道主: 数据库的主机.
  • 数据库: 数据库名称
    1.0.0 (单位:千美元)
    pg 客户端 断开连接 总计断开连接的总数
    • 东道主: 数据库的主机.
    • 数据库: 数据库名称
      1.0.0 (单位:千美元)

      pg. Pool计量器

      计量名称说明标签自兹
      pg pool 连接 创建 总计创建连接的总数
      • 东道主: 数据库的主机.
      • 数据库: 数据库名称
        1.0.0 (单位:千美元)
        池大小连接池的当前大小,包括活动成员和闲置成员
        • 东道主: 数据库的主机.
        • 数据库: 数据库名称
          1.0.0 (单位:千美元)
          pg pool 活动 连接活动连接的总数
          • 东道主: 数据库的主机.
          • 数据库: 数据库名称
            1.0.0 (单位:千美元)
            pg pool errors 总计数据库连接错误的总数
            • 东道主: 数据库的主机.
            • 数据库: 数据库名称
              1.0.0 (单位:千美元)
              pg pool 连接 removed total已删除连接的总数
              • 东道主: 数据库的主机.
              • 数据库: 数据库名称
                1.0.0 (单位:千美元)

                示例输出

                这里举出一个实例,以提供的度量符的正方形格式输出.

                # HELP pg_client_errors_total The total number of connection errors with a database.
                # TYPE pg_client_errors_total counter
                pg_client_errors_total{host="localhost:5432",database="node_postgres_test1"} 1
                
                # HELP pg_client_disconnects_total The total number of disconnected connections.
                # TYPE pg_client_disconnects_total counter
                pg_client_disconnects_total{host="localhost:5432",database="node_postgres_test1"} 1
                
                # HELP pg_pool_connections_created_total The total number of created connections.
                # TYPE pg_pool_connections_created_total counter
                pg_pool_connections_created_total{host="localhost:5432",database="node_postgres_test1"} 19
                
                # HELP pg_pool_size The current size of the connection pool, including active and idle members.
                # TYPE pg_pool_size gauge
                pg_pool_size{host="localhost:5432",database="node_postgres_test1"} 10
                
                # HELP pg_pool_max The maximum size of the connection pool.
                # TYPE pg_pool_max gauge
                pg_pool_max{host="localhost:5432",database="node_postgres_test1"} 10
                
                # HELP pg_pool_active_connections The total number of active connections.
                # TYPE pg_pool_active_connections gauge
                pg_pool_active_connections{host="localhost:5432",database="node_postgres_test1"} 10
                
                # HELP pg_pool_waiting_connections The total number of waiting connections.
                # TYPE pg_pool_waiting_connections gauge
                pg_pool_waiting_connections{host="localhost:5432",database="node_postgres_test1"} 1
                
                # HELP pg_pool_idle_connections The total number of idle connections.
                # TYPE pg_pool_idle_connections gauge
                pg_pool_idle_connections{host="localhost:5432",database="node_postgres_test1"} 0
                
                # HELP pg_pool_errors_total The total number of connection errors with a database.
                # TYPE pg_pool_errors_total counter
                pg_pool_errors_total{host="localhost:5432",database="node_postgres_test1"} 1
                
                # HELP pg_pool_connections_removed_total The total number of removed connections.
                # TYPE pg_pool_connections_removed_total counter
                pg_pool_connections_removed_total{host="localhost:5432",database="node_postgres_test1"} 9
                

                使用量

                依赖性

                在您的工程中添加以下依赖性以下载软件包 无。 。 。 .

                npm i @christiangalsterer/node-postgres-prometheus-exporter
                

                类型脚本

                以下例子说明如何利用出口者监测节点.

                import { Client, Pool } from 'pg'
                import { Registry, collectDefaultMetrics } from 'prom-client'
                import { monitorPgClient, monitorPgPool } from '@christiangalsterer/node-postgres-prometheus-exporter'
                
                ...
                
                // set up a pg.Client
                const client = new Client()
                
                // set up a pg.Pool
                const pool = new Pool()
                
                // set up the prometheus client
                const register = new Registry();
                collectDefaultMetrics({ register })
                
                // monitor the pg.Client
                monitorPgClient(client, register)
                
                // monitor the pg.Pool
                monitorPgPool(pool, register)
                
                ...
                
                // connect to PostgreSQL *after* calling monitorPgClient() / monitorPgPool()
                await client.connect()
                await pool.connect()
                

                Java 脚本

                以下例子说明如何利用出口者监测节点.

                const pg = require('pg')
                const promClient = require( 'prom-client');
                const postgresExporter = require('@christiangalsterer/node-postgres-prometheus-exporter')
                
                // set up a pg.Client
                const client = new pg.Client()
                
                // set up a pg.Pool
                const pool = new pg.Pool()
                
                // set up the prometheus client
                const collectDefaultMetrics = promClient.collectDefaultMetrics;
                const Registry = promClient.Registry;
                const register = new Registry();
                collectDefaultMetrics({ register });
                
                // monitor the pg.Client
                postgresExporter.monitorPgClient(client, register)
                
                // monitor the pg.Pool
                postgresExporter.monitorPgPool(pool, register)
                
                // connect to Postgres *after* calling monitorPgClient() / monitorPgPool()
                await client.connect()
                await pool.connect()
                

                配置

                出口商可以通过类型可选参数指定的属性配置 PgClient 输出选项 财务报告和审定财务报表 PgPool 输出选项 页:1.

                PgClient 输出选项

                属性说明示例自兹
                默认标签默认标签添加到每个参数中 .{'foo':'bar','alice': 3} (中文(简体) )1.0.0 (单位:千美元)

                PgPool 输出选项

                属性说明示例自兹
                默认标签默认标签添加到每个参数中 .{'foo':'bar','alice': 3} (中文(简体) )1.0.0 (单位:千美元)

                格拉法纳板

                Grafana 的示例 这里 显示出口商提供的衡量标准.

                以下是节点后置客户端计量的示例: Grafana:node-postgres Client Metrics

                这里有一个节点点集合度量法的例子: Grafana:node-postgres Pool Metrics

                更改日志

                项目的更改可见于 更改日志。 。 。 .

                兼容性

                下表列出了出口商版本与不同的节点邮递版本和舞会客户端版本的相容性.

                导出版本节点张贴版本舞会客户端版本
                ^ 1. 0^ 8.11.0 (韩语)^15.0

                捐款

                发言是十分受欢迎的。 如欲为该项目捐款,请遵循本报告所述步骤 捐款准则。 。 。 .

                使用导出者的项目

                如果您想要支持此项目, 请在您使用此导出时在您的项目和/ 或公司中添加链接 .

                相关项目

                如果您在寻找一种方法来监视您的节点驱动程序, 请查看 https://github.com/christiangalster/mongodb-driver-prometheus-exporter (中文(简体) )。 。 。 .

                如果你正在寻找一种方法 监视KafkaJs的节点 https://github.com/christiangalster/kafkajs-prometheus-exporter (中文(简体) )。 。 。 .

                版本与发布记录

                @christiangalsterer/node-postgres-prometheus-exporter 共发布 6 个版本,首次发布于 2024/01/18;过去 12 个月发布了 1 个版本。

                版本发布日期距今
                1.4.0latest2025/11/2711 个月前
                1.3.12025/05/191.5 年前
                1.3.02024/07/212 年前
                1.2.02024/04/212 年前
                1.1.02024/04/192 年前
                1.0.02024/01/182 年前

                关于 @christiangalsterer/node-postgres-prometheus-exporter 的常见问题

                @christiangalsterer/node-postgres-prometheus-exporter 是什么?

                节点输出方

                如何安装 @christiangalsterer/node-postgres-prometheus-exporter?

                在项目目录运行 npm install @christiangalsterer/node-postgres-prometheus-exporter,或使用 pnpm add / yarn add / bun add。

                @christiangalsterer/node-postgres-prometheus-exporter 支持 TypeScript 吗?

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

                @christiangalsterer/node-postgres-prometheus-exporter 支持 ESM 还是 CommonJS?

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

                @christiangalsterer/node-postgres-prometheus-exporter 需要什么版本的 Node.js?

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

                @christiangalsterer/node-postgres-prometheus-exporter 可以商用吗?

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

                @christiangalsterer/node-postgres-prometheus-exporter 的下载量有多少?

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

                @christiangalsterer/node-postgres-prometheus-exporter 还在维护吗?

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