@equinor/组合-log

用于Fusion Framework应用程序的结构化、分级过滤的伐木设施.

@equinor/fusion-log 给您一个薄薄的,RxJS后置的伐木抽象,并配有现成的控制台执行和帮助从环境变量中解析日志级别. 当您需要一致的、可配置的模块日志输出时使用它 .

密钥导出

快速启动

import { ConsoleLogger, LogLevel } from '@equinor/fusion-log';

const logger = new ConsoleLogger('MyApp');
logger.level = LogLevel.Debug;

logger.debug('bootstrapping modules…');
logger.info('application ready');
logger.warn('deprecated API called');
logger.error('failed to fetch config', err);

日志级别

更高的数值是更动词. 设置 logger.level 升至某一级别使该级别成为可能 及其下方所有级别。 。 。 .

通过环境变量配置

设定 FUSION_LOG_LEVEL 在此之前 您的捆绑者会编译代码, 这样默认的关卡会在构建时内入.

# .env
FUSION_LOG_LEVEL=4        # numeric
# or
FUSION_LOG_LEVEL=debug    # case-insensitive name

[尖叫声] 确保 FUSION_LOG_LEVEL 在编译生产代码之前,设置在软件包管理器的环境变量中.

分辨率规则(在模块载荷时适用一次):

1. 若为 FUSION_LOG_LEVEL 设置和可解析 = 使用已解析的值.
2. 如果解析失败 NODE_ENV === 'development' - 倒车去 Debug。 。 。 .
3. 否则... 回到.. Error。 。 。 .
4. 如果变量未设为 + 默认为 Error。 。 。 .

您也可以在运行时解决一个关卡 resolveLogLevel数字 :

import { resolveLogLevel } from '@equinor/fusion-log';

const level = resolveLogLevel(process.env.MY_LOG_LEVEL ?? 'error');
logger.level = level;

子标签

创建子日志来添加组件级上下文 。 孩子的头衔被前缀为父母的头衔,除非被推翻,日志级别会被继承.

const router = logger.createSubLogger('Router');
router.debug('navigated to /dashboard');
// console output: "MyApp::Router  navigated to /dashboard"

const auth = logger.createSubLogger('Auth', undefined, LogLevel.Error);
auth.info('token refreshed'); // suppressed — level is Error

自定义记录器

扩展 Logger

子类 Logger 将日志条目传送到任何目的地,同时重新使用级别过滤和RxJS可观测管道.

import { Logger, LogLevel, type ILogger } from '@equinor/fusion-log';

class RemoteLogger extends Logger {
  constructor(private readonly endpoint: string) {
    super();
    // subscribe to the filtered stream
    this.log.subscribe(({ lvl, msg }) => {
      fetch(this.endpoint, {
        method: 'POST',
        body: JSON.stringify({ level: lvl, messages: msg }),
      });
    });
  }

  protected _createMessage(_lvl: LogLevel, ...msg: unknown[]): unknown[] {
    return msg;
  }

  createSubLogger(title: string): ILogger {
    const sub = new RemoteLogger(this.endpoint);
    sub.level = this.level;
    return sub;
  }
}

执行 ILogger

如果你不需要RxJS管道 执行 ILogger 直接 :

import { type ILogger, LogLevel, defaultLogLevel } from '@equinor/fusion-log';

class NoopLogger implements ILogger {
  level: LogLevel = defaultLogLevel;
  debug() {}
  info() {}
  warn() {}
  error() {}
  createSubLogger(): ILogger {
    return new NoopLogger();
  }
}