@ 喜悦的垂直/ 跳动
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' |
LoggerConfig | boolean | { 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 { /* ... */ }
}
许可证
麻省理工学院