@govuk-one-login/frontend-vital-signs

中文文档
0.1.4发布于 2025/11/17ISCTypeScriptESM + CJS构建来源已验证近 30 天下载 4766
中文使用文档
文档目录6 节
  1. GOV.UK 前端生命标志
  2. 关于项目
  3. 开始
  4. 安装
  5. frontendVitalSignsInit(server, options)
  6. 参数

Coverage


GOV.UK 前端生命标志

这个软件包可以让 GOV UK LOGIN 前端节点.js 应用程序添加前端的生命标志监测
探索文件“

报告错误 • 妇女 请求特性

目录
  1. 关于项目
  2. 开始
  3. “前端维塔尔斯Init(服务器,选项)”

关于项目

GDS Frontend Vitals Signs node 套件暴露出关于我们节点应用的自定义度量衡(vital-signs).

这个套件的目的是为了方便我们的FE服务适应需求而扩大规模.

该软件包由DI前端能力团队所拥有,开发本工具的一部分涉及与负责维护构成"一个登录之行"的前端寄存器的吊舱持续发现.

(单位:千美元)返回顶端(中文(简体) )

开始

安装

  1. 安装国家预防机制软件包

    npm install @govuk-one-login/frontend-vital-signs
    
  2. 在您的 Node.js 应用程序的启动文件中导入软件包( 例如: app.js 或 index.js) :

    const { frontendVitalSignsInit } = require("@govuk-one-login/frontend-vital-signs");
    

    如果使用 ES6 导入或类型脚本 :

    import frontendVitalSignsInit from "@govuk-one-login/frontend-vital-signs";
    
  3. 配置使用前端VitalSignsInit函数的服务器。 此函数将关闭前端关键字监视 .

示例


const server = app.listen(port, () => {
 console.log(`Example app listening on port ${port}`);
});

frontendVitalSignsInit(server, {
 interval: 10000, 
 logLevel: "info",
 metrics: ["requestsPerSecond", "avgResponseTime"],
 staticPaths: [/^\/assets\/.*/, "/ga4-assets", "/javascript", "/stylesheets"], 
});

示例日志 :

{
 "level": 30,
 "time": 1722506607855,
 "pid": 22457,
 "hostname": "GDS...",
 "name": "@govuk-one-login/frontend-vital-signs",
 "version": "0.0.3",
 "eventLoopDelay": 10.982777381738174,
 "eventLoopUtilization": {
   "idle": 9972.082872000003,
   "active": 29.954044017529668,
   "utilization": 0.002994794387287299
 },
 "requestsPerSecond": { "dynamic": 0, "static": 0 },
 "avgResponseTime": { "dynamic": null, "static": null },
 "maxConcurrentConnections": 0
}


frontendVitalSignsInit(server, options)

参数

  • server (必须): 您想要监视的 HTTP 或 HTTPS 服务器实例 .

  • options (可选) : 含有下列属性的对象:

    • interval (可选,号码): 以毫秒为单位的伐木测量值间隔 。 默认值为 10000 (10秒钟).

    • logLevel (可选,字符串): 测量日志的日志级别 。 默认值为 “ info” , 即测量值记录的级别 。 可用的日志水平为:

      • 致命:记录可能导致应用程序崩溃的临界错误.
      • 错误: 日志错误消息显示出错 .
      • 警告:记录对潜在问题的警告,这些问题不是错误,但可能需要注意.
      • 信息:关于应用程序操作的日志信息信息.
      • 调试:用于开发的日志调试信息.
      • track:用于调试目的的日志详细信息.
      • 无声: 压制所有日志输出 .
    • metrics (可选,数组): 指定要日志的衡量标准的一系列字符串 。 可能的数值包括:

      • "requestsPerSecond":记录每秒请求的数量.
      • "avgResponseTime":记录平均响应时间.
      • "maxConcurrentConnections":记录同时连接的最大数量.
      • "eventLoopDelay":记录间隔内记录的最大事件循环延迟。 由于节点事件循环被同步操作所超载,这是在后起后起.
      • "eventLoopUtilization":记录事件循环在活动状态和闲置状态所花的时间.
    • staticPaths (可选,数组): 表示您静态文件路径的字符串或正则表达式。 这些路径用于区分静态和动态请求.

      • 提供的字符串被转换为正则表达式,格式为 QQstring value} 意思是路径被当作URL的起始部分. 例如,字符串“ / static” 被视为“ ^/ static ” , 并将匹配任何以 / static 开头的 URL .

(单位:千美元)返回顶端(中文(简体) )

版本与发布记录

@govuk-one-login/frontend-vital-signs 共发布 7 个版本,首次发布于 2024/08/01;过去 12 个月发布了 1 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.4latest2025/11/1711 个月前
0.1.32025/01/311.8 年前
0.1.22025/01/141.8 年前
0.1.12025/01/101.9 年前
0.1.02024/12/171.9 年前
0.0.42024/08/012 年前

关于 @govuk-one-login/frontend-vital-signs 的常见问题

如何安装 @govuk-one-login/frontend-vital-signs?

在项目目录运行 npm install @govuk-one-login/frontend-vital-signs,或使用 pnpm add / yarn add / bun add。

@govuk-one-login/frontend-vital-signs 支持 TypeScript 吗?

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

@govuk-one-login/frontend-vital-signs 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@govuk-one-login/frontend-vital-signs 可以商用吗?

@govuk-one-login/frontend-vital-signs 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@govuk-one-login/frontend-vital-signs 的下载量有多少?

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

@govuk-one-login/frontend-vital-signs 还在维护吗?

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