@faremeter/ 日志
带有可插件后端的可配置日志抽象.
安装
pnpm install @faremeter/logs
特征
- 覆盖所有软件包的统一日志接口
- 可插接后端( 控制台, 日志)
- 等级日志命名
- 运行时间后端互换
API 参考
职能
日志
| 函数 | 类型 |
|---|---|
shouldLog | (level: "trace" or "debug" or "info" or "warning" or "error" or "fatal", configuredLevel: "trace" or "debug" or "info" or "warning" or "error" or "fatal") => boolean |
控制台备份.debug
| 函数 | 类型 |
|---|---|
ConsoleBackend.debug | (message: string, context?: Context or undefined) => void |
配置辅助
初始化全球伐木系统.
在应用程序启动时调用此选项以配置日志级别和后端 . 如果没有指定后端,则在可用时使用logtape,否则会掉入 返回控制台输出.
| 函数 | 类型 |
|---|---|
configureApp | (args?: ConfigureAppArgs) => Promise<void> |
参数:
args: - 关卡和后端的配置选项.
实例:
await configureApp({ level: "debug" });
获取潜行器
为特定子系统创建日志.
如果后端在之后更改, 返回的日志机会自动调整 创建( 例如, 当 QQlink 配置 App ) .
| 函数 | 类型 |
|---|---|
getLogger | (subsystem: readonly string[]) => Promise<Logger> |
参数:
subsystem: - 日志的分级分类路径 .
回返情况:
一个日志实例被扩展到子系统 .
实例:
const logger = await getLogger(["faremeter", "client"]);
logger.info("Client initialized", { version: "1.0.0" });
常数
日志级别
| 常数 | 类型 |
|---|---|
LogLevels | readonly ["trace", "debug", "info", "warning", "error", "fatal"] |
接口
锁定器
| 财产 | 类型 | 说明 |
|---|
日志 后端
后端实施伐木系统.
后端处理日志输出目的地(主机、文件、外部服务) 并在运行时通过 QQlink 配置App} 互换 .
| 财产 | 类型 | 说明 |
|---|
配置 AppArgs 选项
初始化日志系统的配置选项 .
| 财产 | 类型 | 说明 |
|---|---|---|
level | "trace" or "debug" or "info" or "warning" or "error" or "fatal" or undefined | 要发射的最小日志级别 。 默认为 "info"。 。 。 . |
backend | LoggingBackend<BaseConfigArgs> or undefined | 后端执行要使用. 未提供自动检测. |
类型
日志级别
| 类型 | 类型 |
|---|---|
LogLevel | (typeof LogLevels)[number] |
A. 背景情况
| 类型 | 类型 |
|---|---|
Context | Record<string, unknown> |
日志
| 类型 | 类型 |
|---|---|
LogArgs | [message: string, context?: Context] |
碱基ConfigArgs
| 类型 | 类型 |
|---|---|
BaseConfigArgs | { level: LogLevel } |
相关软件包
- @ faremeter/ 中间软件 - 服务器中间软件
- @faremeter/促进器 - 主持人服务器
许可证
LGPL-3.0 仅限