关于项目
GDS Frontend Vitals Signs node 套件暴露出关于我们节点应用的自定义度量衡(vital-signs).
这个套件的目的是为了方便我们的FE服务适应需求而扩大规模.
该软件包由DI前端能力团队所拥有,开发本工具的一部分涉及与负责维护构成"一个登录之行"的前端寄存器的吊舱持续发现.
(单位:千美元)返回顶端(中文(简体) )
开始
安装
-
安装国家预防机制软件包
npm install @govuk-one-login/frontend-vital-signs -
在您的 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"; -
配置使用前端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 .
-
(单位:千美元)返回顶端(中文(简体) )