@ eliware/ log (帮助) 
以温斯顿为后盾,对节点进行结构化的无害环境管理记录,并进行编辑和防御序列化.
目录
特征
- 创建带有文本或JSON输出的温斯顿日志器,分级过滤,并配置可配置的传输.
- 在请求或其他操作中加入共享的上下文 .
- 在软件包发送记录到传送之前编辑选中的元数据密钥 .
- 对序列化对象和错误应用已配置的输出限制 。 序列器不调用
toJSON()。 。 。 . - 设定时在 JSON 记录中添加时间戳
timestamp: true。 。 。 .
所需资源
在本土无害环境管理项目中使用节点26或以后使用.
设置
用 npm 安装软件包 :
npm install @eliware/log
使用量
导入 createLogger() 从包根创建日志 :
import { createLogger } from "@eliware/log";
const logger = createLogger({ format: "json" });
logger.info("Request received", { requestId: "demo" });
读取 发布注释 用于修改软件包.
发展
运行 npm ci 以安装锁文件依赖性.
测试
运行 npm test 用于汇总验证。 运行 npm run lint, (中文(简体) ), npm run audit, (中文(简体) ), npm run format:check, (中文(简体) ), npm run typecheck,或 npm run pack 用于重点检查。 运行 npm run format 以格式化文件.
解决问题
| 问题 | 原因 | 行动 |
|---|---|---|
createLogger() 报告无效关卡 | 温斯顿没有定义关卡. | 设定 level 达到温斯顿所支持的水平. |
createLogger() 报告无效的格式 | 格式没有 text 或者说 json。 。 。 . | 设定 format 改为 text 或者说 json。 。 。 . |
timestamp must be a boolean | 这个 timestamp 选项不是布尔. | 设定 timestamp 改为 true 或者说 false。 。 。 . |
transports must be an array | 这个 transports 选项不是数组. | 通过一系列温斯顿运输. |
| 缺少日志记录 | 配置的关卡过滤它,或者传输会改变输出. | 检查关卡并检查运输输出. |
警卫
设定 keys 改为含有敏感数据的元数据属性名称。 日志不按属性名称编辑字符串消息 。 在登录信件前删除信件中的秘密 .
检查每个自定义运输的最终输出. 运输可以添加字段或更改记录. 不使用编辑或限定序列来取代日志存储的访问控制.
API 密码
从包根导入日志和编辑函数 。 根还导出编辑选项类型和现有的 RedactionOptions 别名.
读取 API 参考 用于函数行为、选项、声明和方法.
包装
软件包包括 package.json 和列表中的文件 package.json.files数字 : src/, (中文(简体) ), docs/, (中文(简体) ), README.md, (中文(简体) ), AGENTS.md, (中文(简体) ), LICENSE, (中文(简体) ), RELEASE_NOTES.md, (中文(简体) ), examples/, (中文(简体) ), specs/,以及 .env.example。 。 。 .
使用数字 MAJOR.MINOR.PATCH 版本和匹配 v<version> 释放标签.
在发布前通过业务发布会获得批准.
实例
读取 实例/README.md 命令和预期结果.
支助
为了帮助、提问或与提交人和社区交谈,访问:
