在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:egg-apigw-tracer开源软件地址:https://gitee.com/inlym/egg-apigw-tracer开源软件介绍:egg-apigw-tracer适配 API 网关的 HTTP 请求示踪器,用于 Egg.js 框架。 目录介绍在对外提供 Web 服务时,可能在线上环境出现偶发性的错误,为了方便排查问题,给所有的请求都提供一个唯一请求ID是一个不错的实践,开发者可以根据这个请求ID去相关日志中找寻对应的错误内容。 这个「唯一请求ID」(Unique Request ID)有的时候也叫「示踪ID」(trace ID),一个通俗的做法是使用 UUID 生成一个字符串,并在响应中附带该字符串。另外一些 Web 服务,会使用云厂商的 API 网关作为接入层,然后将请求转发到开发者自己的服务器上。此时我们往往希望使用 API 网关自带的请求ID作为示踪ID,本插件就是为了解决这个问题诞生的。 本插件完美适配 Egg.js 框架,只需要按照框架要求启用插件,可以零配置使用。 安装按照通用的方式使用 npm 下载安装到你的项目下即可,无需全局安装。 安装命令: npm i egg-apigw-tracer 使用在使用前,请确保你已经阅读 Egg.js 框架关于插件的文档。 下面说明如何配置以及使用插件。 启用插件在 exports.tracer = { // enable 属性表示是否启用插件,true 为启用,false 为禁用 enable: true, // 指定插件使用的包,为 'egg-apigw-tracer' package: 'egg-apigw-tracer',}; 配置方式本插件无需任何配置即可使用。但考虑到以下使用场景:
在 exports.tracer = { mode: 'apigw', idHeaders: 'x-ca-request-id',} 各配置项的含义是:
使用说明主要有 2 处使用场景,一是你可以直接通过 示例我们模拟以下这个使用场景,来演示如何配置和使用本插件:
在 exports.tracer = { enable: true, package: 'egg-apigw-tracer',}; 在 exports.tracer = { mode: 'uuid',} 在 exports.tracer = { mode: 'apigw',} 相关
作者我是 inlym ,一个产品经理和全栈开发者。 如果你有任何问题或者建议,欢迎联系我,以下是我的联系方式: 参与非常欢迎你能够参与这个项目的开发和维护。 你可以通过以下几种方式参与到项目中:
许可证本插件使用 MIT 许可证。 |
2022-08-15
2022-08-17
2022-09-23
2023-10-27
2022-08-18
请发表评论