@happyvertical/logger

中文文档
0.113.1发布于 2026/11/17MITTypeScriptES Module近 30 天下载 4.2万

HARE SDK 带有信号适配器的结构记录

中文使用文档
文档目录12 节
  1. 安装
  2. 基本用途
  3. 环境变量
  4. 日志级别
  5. 信号适配器
  6. 哨兵适应器
  7. API 概览
  8. 工厂
  9. 类
  10. 类型
  11. 自定义锁定器
  12. 许可证

@ 喜悦的垂直/ 跳动

HARE SDK的结构记录有信号适配器集成和可选的哨兵出错跟踪. 规定 a Logger 与四个重度级的接口,一个带有分级过滤的控制台执行,以及将SMRT框架信号转换成日志条目或哨兵面包屑/例外的适配器.

安装

pnpm add @happyvertical/logger

# Optional: for Sentry integration
pnpm add @sentry/node

取决于 @happyvertical/utils可选同伴依赖 @sentry/node (关于 /sentry (原始内容存档于2018-03-29). subpath.

基本用途

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

// Console logger with default 'info' level
const logger = createLogger(true);

logger.info('Application started');
logger.debug('Verbose detail'); // Not output (below 'info')
logger.warn('High memory usage', { memoryMB: 512 });
logger.error('Connection failed', { host: 'localhost', port: 5432 });

// Configure a specific level
const debugLogger = createLogger({ level: 'debug' });

// No-op logger — all calls discarded, zero overhead
const silent = createLogger(false);

环境变量

设定 HAVE_LOGGER_LEVEL 改为 debug, (中文(简体) ), info, (中文(简体) ), warn,或 error时应用 createLogger(true) 或者说 createLogger({})明确配置优先:

process.env.HAVE_LOGGER_LEVEL = 'debug';
const logger = createLogger(true); // uses 'debug' from env

const explicit = createLogger({ level: 'warn' }); // uses 'warn', ignores env

日志级别

debug < info < warn < error ——已配置阈值以下的信件被丢弃.

const logger = createLogger({ level: 'warn' });
logger.debug('ignored');  // not output
logger.info('ignored');   // not output
logger.warn('output');    // output
logger.error('output');   // output

输出格式 : [LEVEL] message {"key":"value"}

信号适配器

LoggerAdapter 将 SMRT 框架信号转换为结构化的日志条目 :

import { createLogger, LoggerAdapter } from '@happyvertical/logger';

const logger = createLogger({ level: 'info' });
const adapter = new LoggerAdapter(logger);
// Register adapter with a signal bus to log operations automatically

信号类型映射 : start 调试, step 调试, end - 资料, error ——错误.

哨兵适应器

这个 /sentry 子路径信号到哨兵/格利奇Tip. 要求数 @sentry/node 作为同伴的依赖.

import { createSentryAdapter } from '@happyvertical/logger/sentry';

const adapter = createSentryAdapter({ category: 'myapp' });
// Register adapter with a signal bus

// Error signals → Sentry.captureException with scope tags
// Non-error signals → Sentry.addBreadcrumb for debugging trail

API 概览

工厂

函数说明
createLogger(config)回返a Logger —— 说 ConsoleLogger 当启用时, 无操作 false
createSentryAdapter(config?)回返a SentryAdapter (从) /sentry 子路径)

类

类说明
ConsoleLogger带有级别过滤的 Logger 执行, 写到 console.*
LoggerAdapter将信号转换为结构化日志消息的信号适配器
SentryAdapter信号适配器,用于向哨兵传递错误并添加面包屑

类型

类型说明
Logger与 debug, (中文(简体) ), info, (中文(简体) ), warn, (中文(简体) ), error 方法
LogLevel'debug' | 'info' | 'warn' | 'error'
LoggerConfigboolean | { level?: LogLevel }
Signal操作执行中的信号事件
SignalAdapter处理信号的接口
SignalType'start' | 'step' | 'end' | 'error'
SentryAdapterConfig{ category?: string }

自定义锁定器

执行 Logger 自定义后端的接口 :

import type { Logger } from '@happyvertical/logger';

class MyLogger implements Logger {
  debug(message: string, context?: Record<string, unknown>): void { /* ... */ }
  info(message: string, context?: Record<string, unknown>): void { /* ... */ }
  warn(message: string, context?: Record<string, unknown>): void { /* ... */ }
  error(message: string, context?: Record<string, unknown>): void { /* ... */ }
}

许可证

麻省理工学院

版本与发布记录

@happyvertical/logger 共发布 131 个版本,首次发布于 2026/06/23;过去 12 个月发布了 131 个版本。

版本发布日期距今
0.113.1latest2026/11/17今天
0.113.02026/11/152 天前
0.112.32026/11/134 天前
0.112.22026/11/125 天前
0.112.12026/11/125 天前
0.112.02026/11/125 天前

关于 @happyvertical/logger 的常见问题

@happyvertical/logger 是什么?

HARE SDK 带有信号适配器的结构记录

如何安装 @happyvertical/logger?

在项目目录运行 npm install @happyvertical/logger,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 have-logger-context,可以用 npx have-logger-context 直接运行。

@happyvertical/logger 支持 TypeScript 吗?

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

@happyvertical/logger 支持 ESM 还是 CommonJS?

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

@happyvertical/logger 可以商用吗?

@happyvertical/logger 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@happyvertical/logger 的下载量有多少?

根据 npm 官方下载统计,@happyvertical/logger 在 2026/10/17 – 2026/11/15 这 30 天内被下载 41,777 次,日均约 1,393 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@happyvertical/logger 还在维护吗?

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