debug は何をしますか？
デバッグパッケージの使用ガイド。デバッグログの追加、ログ名前空間の理解、デバッグ機能の実装時に使用します。デバッグログのリクエストやログ実装に関するトリガーに反応します。
概要
lobehub/debug は、Node.js アプリケーションにおけるデバッグログを管理するためのユーティリティパッケージです。名前空間機能を活用して、必要に応じて特定のモジュールや機能のログを有効/無効にできます。
インストール
npm install lobehub/debug
基本的な使い方
const debug = require('lobehub/debug');
// 名前空間を持つロガーを作成
const log = debug('myapp:server');
const dbLog = debug('myapp:database');
// ログを出力
log('サーバーが起動しました');
dbLog('データベースに接続しました');
名前空間の制御
ログの有効/無効は環境変数 DEBUG で制御します。
- すべてのログを有効にする:
export DEBUG=* - 特定の名前空間のみ有効にする:
export DEBUG=myapp:server - 複数の名前空間を有効にする（カンマ区切り）:
export DEBUG=myapp:server,myapp:database - ワイルドカードでグループ化:
export DEBUG=myapp:* - 特定の名前空間を除外する:
export DEBUG=*,-myapp:database
コードから制御する
const debug = require('lobehub/debug');
// プログラム的に有効にする
debug.enable('myapp:*');
// プログラム的に無効にする
debug.disable();
色とフォーマット
デフォルトでは、異なる名前空間は自動的に異なる色で表示されます。これにより、複数のログストリームを視覚的に区別しやすくなります。
本番環境での使用
本番環境では DEBUG 環境変数を設定しないか、空のままにしてパフォーマンスへの影響を最小限に抑えます。ログは必要に応じてのみ有効にしてください。
詳細
詳細なAPIリファレンスや高度な設定については、公式ドキュメント を参照してください。