@basenative/logger

中文文档
3.0.0发布于 2026/10/31Apache-2.0TypeScriptES Module零依赖构建来源已验证

Structured logging with multiple transports and child logger support

原始使用文档
文档目录9 节
  1. Install
  2. Quick Start
  3. Child Loggers
  4. Request Middleware
  5. API
  6. createLogger(options?)
  7. Transports
  8. Middleware
  9. License

@basenative/logger

Structured JSON logging with Pino-compatible output, transports, and child loggers

Part of the BaseNative ecosystem — a signal-based web runtime over native HTML.

Install

npm install @basenative/logger

Quick Start

import { createLogger } from '@basenative/logger';

const log = createLogger({ name: 'api', level: 'info' });

log.info('Server started', { port: 3000 });
log.warn('Slow query', { duration: 1200, table: 'users' });
log.error('Unhandled error', { err });

Child Loggers

const requestLog = log.child({ requestId: 'abc-123' });
requestLog.info('Incoming request'); // always includes requestId

Request Middleware

import { createLogger, requestLogger } from '@basenative/logger';
import { createPipeline } from '@basenative/middleware';

const log = createLogger({ name: 'http' });

const pipeline = createPipeline().use(requestLogger(log));
// ctx.state.logger is now a child logger with requestId, method, url

API

createLogger(options?)

Creates a logger instance. Options:

  • level — Minimum log level: 'trace', 'debug', 'info', 'warn', 'error', 'fatal'. Default: 'info'.
  • name — Logger name, included in every log entry.
  • transport — Transport instance (default: consoleTransport()).
  • context — Static key/value pairs merged into every log entry.
  • timestamp — Include time field (milliseconds since epoch). Default: true.
  • pretty — Pretty-print with colors in development. Default: NODE_ENV !== 'production'.

Logger methods: trace, debug, info, warn, error, fatal — each accepts (msg, data?).

  • .child(context) — Returns a new logger inheriting all settings with additional static context.
  • .level — Read-only current level string.

Transports

  • consoleTransport() — Writes to console.log. Pretty-prints in development, JSON in production.
  • streamTransport(stream) — Writes JSON lines to any Node.js writable stream (e.g. a file stream).
  • multiTransport(transports[]) — Fans out to multiple transports simultaneously.

Middleware

  • requestLogger(logger, options?) — Middleware that creates a child logger per request with requestId, method, and url. Attaches it to ctx.state.logger. Options: idHeader (default: 'x-request-id').

License

Apache-2.0

版本与发布记录

@basenative/logger 共发布 11 个版本,首次发布于 2026/03/20;过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.0.0latest2026/10/312 天前
2.4.02026/10/268 天前
2.3.22026/10/2212 天前
2.3.12026/10/2212 天前
2.3.02026/10/2212 天前
2.2.02026/10/2113 天前

关于 @basenative/logger 的常见问题

@basenative/logger 是什么?

支持多传输和子日志记录器的结构化日志记录

如何安装 @basenative/logger?

在项目目录运行 npm install @basenative/logger,或使用 pnpm add / yarn add / bun add。

@basenative/logger 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@basenative/logger 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@basenative/logger 可以商用吗?

@basenative/logger 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@basenative/logger 还在维护吗?

最新版本 3.0.0 发布于 2026/10/31(2 天前);至今共发布 11 个版本,其中过去 12 个月发布了 11 个;首次发布于 2026/03/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。