首页 > web前端 > js教程 > 正文

LogTape .eleased:有什么新内容?

Linda Hamilton
发布: 2024-09-24 16:31:43
原创
350 人浏览过

LogTape .eleased: What

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 开始,您现在可以
覆盖

父记录器的接收器。例如,如果您为子记录器启用parentSinks:“覆盖”选项,如下所示:
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"] 记录器的接收器。

当然,默认值是parentSinks:“继承”,所以如果你不指定该选项,它将像以前一样运行。

如果您对添加此功能的背景感到好奇,请参阅 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 输出和格式化之前表示日志。

虽然 LogRecord.message 属性已经存在,但该属性包含消息模板中的占位符替换为实际属性值后的结果。这在大多数情况下已经足够了,但是当日志输出目的地(接收器)是另一个日志系统时,您可能希望分别输出原始消息模板和属性值,从而允许接收日志系统用属性替换消息模板中的占位符直接值。
logger.info("Hello, {name}!", { name: "Alice" });
登录后复制
登录后复制

LogTape 0.6.0 中添加的 LogRecord.rawMessage 正是用于此目的的属性,其中包含消息模板的原始状态以及未替换的占位符。例如,如果您像这样登录:

LogRecord.message 将包含值 ["Hello, ", "Alice", "!"],LogRecord.rawMessage 将包含值 "Hello, {name}!"。

如果您想了解此功能添加的背景,请参阅 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.

Get it from JSR and npm

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中文网其他相关文章!

来源:dev.to
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
作者最新文章
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板