このプロジェクトについて
modern-errors-winston は、Node.js アプリケーションにおける JavaScript エラーのログ記録方法を改善する、modern-errors ライブラリ用の Winston プラグインです。このプラグインは、BaseError.fullFormat() と BaseError.shortFormat() という 2 つの主要な Winston フォーマットヘルパーを提供します。
fullFormat は、構造化されたログを目的としており、名前、メッセージ、スタック、カスタムプロパティ、ネストされた原因エラー、AggregateError エントリなど、すべてのエラープロパティを含みます。format.json() や format.prettyPrint() などのフォーマットと組み合わせて使用することを想定しており、HTTP トランスポートなどでの使用に特に適しています。出力は JSON セーフであると説明されており、機械可読なログやリモートログの取り込みに適しています。
shortFormat は、人間が読みやすいコンソール出力を目的としています。エラー名、メッセージ、およびオプションでスタックトレースのみをログに記録します。format.simple() や format.cli() などのフォーマットと組み合わせて使用することを想定しており、コンソールトランスポートでの使用に適しています。
このプラグインは、エラークラスごと、サブクラスごと、エラーインスタンスごと、およびフォーマット呼び出しごとに構成できます。構成オプションには、スタックトレースの含否と、Winston ログレベルのオプションのオーバーライドが含まれます。また、Winston の例外処理と併用することで、キャッチされていない例外にも対応します。
Winston のデフォルトエラーフォーマットと比較して、このプラグインはエラー名をログに記録し、原因やアグリゲートエラーを含むネストされたエラーをサポートし、JSON セーフなフル出力を生成し、shortFormat でスタックトレースをオプションで許可し、エラーインスタンスを修正しません。このパッケージは ES モジュールであり、Node.js 18.18.0 以降を必要とし、Winston は別途インストールする必要があります。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.