LogTape,一个用于 JavaScript 和 TypeScript 的零依赖结构化日志库,已发布 v0.6.0。发生了什么变化?
LogTape 的功能之一是通过分层类别继承接收器。例如,如果您设置两个记录器,如下所示:
import { configure, getConsoleSink, getFileSink } from "@logtape/logtape"; await configure({ sinks: { console: getConsoleSink(), file: getFileSink("app.log"), }, loggers: [ { category: ["app"], level: "debug", sinks: ["file"] }, { category: ["app", "module"], level: "debug", sinks: ["console"] }, ], });
写入 ["app"] 记录器的日志只会保存到 app.log 文件,但写入 ["app", "module"] 记录器的日志将同时保存到 app.log 文件
app.log 文件并输出到控制台。这是因为 ["app", "module"] 记录器继承了其父类别 ["app"] 的接收器。
但是,有时您可能不希望出现这种行为。从 LogTape 0.6.0 开始,您现在可以
覆盖
await configure({ sinks: { /* omitted; same as above */ }, loggers: [ { category: ["app"], level: "debug", sinks: ["file"] }, { category: ["app", "module"], level: "debug", sinks: ["console"], parentSinks: "override" }, ], });
写入["app"]记录器的日志只会保存到
app.log文件,写入["app", "module"]记录器的日志只会输出到
app.log文件控制台。这是因为子记录器 ["app", "module"] 覆盖了 ["app"] 记录器的接收器。
如果您对添加此功能的背景感到好奇,请参阅 GitHub Issue #15。
logger.info("Hello, { name }!", { name: "Alice" });
在以前的版本中,如果您这样登录:
logger.info("Hello, {name}!", { name: "Alice" });
与预期相反,一条日志Hello, undefined!将被创建。这是因为占位符 { name } 包含空格字符,因此它查找属性“ name ”而不是“ name ”。换句话说,您必须像这样删除占位符中的空格:
logger.info("Hello, { name }!", { " name ": "Alice" });
或者在实际属性名称中添加相同的空格,如下所示:
logger.info("Hello, { name }!", { name: "Alice" });
但是,从LogTape 0.6.0开始,即使占位符的开头和结尾有空格,它也会寻找不带空格的属性名称。例如,如果您像这样登录:
logger.info("Hello, { name }!", { name: "Alice", " name ": "Bob" });
但是,如果存在完全匹配的属性(包括空格字符),则会优先考虑。例如,如果您像这样登录:
如果您想了解此功能添加的背景,请参阅 GitHub Issue #16。
LogRecord.rawMessage 属性
LogRecord 是一种数据类型,在 LogTape 输出和格式化之前表示日志。
logger.info("Hello, {name}!", { name: "Alice" });
LogTape 0.6.0 中添加的 LogRecord.rawMessage 正是用于此目的的属性,其中包含消息模板的原始状态以及未替换的占位符。例如,如果您像这样登录:
如果您想了解此功能添加的背景,请参阅 GitHub Issue #17。
export type TextFormatter = (record: LogRecord) => string;
文本格式化程序是一个接口,它确定每个日志如何在流接收器、文件接收器等中格式化为文本。实际的类型定义非常简单:
但是,每次直接定义文本格式化程序可能会很麻烦,因此 LogTape 内置了 defaultTextFormatter 和 ansiColorFormatter 供您使用。到目前为止,由于无法进行其他配置,因此您必须按原样接受预定格式。例如,如果您不喜欢像“警告”这样的日志级别输出为像 WRN 这样的三个字母缩写,则必须从头开始实现 TextFormatter。 但是,从 LogTape 0.6.0 开始,您可以通过 getDefaultTextFormatter() 和 getAnsiColorFormatter() 函数根据自己的喜好自定义各种格式设置,而无需从头开始实现 TextFormatter。
For example, if you want to represent log levels like "warning" as a single uppercase letter W, you can configure it like this:
const myFormatter = getDefaultTextFormatter({ level: "L" });
Or if you want to omit the date and timezone from the timestamp and only show the time, you can configure it like this:
const myFormatter = getDefaultTextFormatter({ timestamp: "time" });
For descriptions of more formatting options, please refer to the related documentation.
If you're curious about the background of this feature addition, please refer to GitHub issue #13.
LogTape 0.6.0 is already available on JSR and npm, so get it now!
deno add @logtape/logtape@0.6.0 # Deno npm add @logtape/logtape@0.6.0 # npm pnpm add @logtape/logtape@0.6.0 # pnpm yarn add @logtape/logtape@0.6.0 # Yarn bun add @logtape/logtape@0.6.0 # Bun
Happy logging!
以上是LogTape .eleased:有什么新内容?的详细内容。更多信息请关注PHP中文网其他相关文章!