実行時のレベルとアペンダー
loggingSystem Bean (LoggingSystem.instance) は、SpringLog の背後にあるロギングシステムです。アプリケーションの実行中にレベルを変えたり、独自の出力を追加したりするには、これを注入します。
使う理由
動作中のアプリケーションのある部分を調べるには、再起動せずに、その debug の行を今すぐ見たいものです。また、レコードによっては別の場所にも送るべきものがあります。エラーはクラッシュレポーターに、すべてをリモートのログサービスに、などです。Spring Boot はこれを LoggingSystem.setLogLevel と Logback のアペンダーで行います。ここではどちらも普通の Dart です。
例
// 管理者の操作で、チェックアウトの debug の行を有効にする。
@Service()
class LogLevels {
LogLevels(this.logging);
final LoggingSystem logging;
void debugCheckout() => logging.setLogLevel('neon.checkout', SpringLogLevel.debug);
void reset() => logging.setLogLevel('neon.checkout', null); // 再び継承する
}
// エラーは、スタックトレースとともにクラッシュレポーターにも送る。
class CrashReportAppender extends LogAppender {
CrashReportAppender() : super(threshold: SpringLogLevel.error);
@override
void write(SpringLogRecord record) =>
crashlytics.recordError(record.error ?? record.message, record.stackTrace);
}
Future<void> main(List<String> args) async {
LoggingSystem.instance.addAppender(CrashReportAppender());
await runApplicationAsync(args);
}
実行時のレベル
| 呼び出し | 効果 |
|---|---|
setLogLevel('neon', SpringLogLevel.debug) |
neon と、その下の自分のレベルを持たないすべてのロガーのレベル |
setLogLevel('neon', null) |
ロガー自身のレベルを取り除き、再び継承するようにする |
setLogLevel('ROOT', SpringLogLevel.warning) |
ルートのレベル。ROOT は大文字小文字を問わない。ルートには常にレベルが必要 |
rootLevel |
現在のルートのレベル |
これは Spring Boot の LoggingSystem.setLogLevel です。Actuator の loggers エンドポイントはまだありません。リモートで必要な場合は、独自のコントローラーでレベルの変更を公開してください。
独自のアペンダー
アペンダーは、ロギングシステムの出力の一つです。コンソール、ファイル、バッファーはアペンダーです。LogAppender を継承し、より少ないレコードを受け取るべきなら threshold を与え、LoggingSystem.instance.addAppender で追加します。
writeはロギングの呼び出しの中で同期的に実行されるため、ネットワーク呼び出しのような遅い処理はキューに入れてください。- 失敗したアペンダーが他のアペンダーを止めることはありません。
- 追加したアペンダーは、
removeAppenderまで、アプリケーションの再起動 (ホットリロード) をまたいでも残ります。 - 起動中、システムが設定される前にログに出されたレコードは、追加したアペンダーにも再生されます。
Spring では、これは logback-spring.xml で宣言する Logback の Appender です。ここではコードで追加します。
SpringApplication なしで
SpringApplication を使わない場合は、ロギングシステムを自分で構成してインストールします。
LoggingSystem.instance
..configure(environment) // 出力: パターン、しきい値、バッファー、ファイル
..install(); // これ以降、SpringLog のレコードはここに来る
SpringApplication.applyLoggingLevels(environment); // logging.level.*、logging.group.*
configure は ConfigurableEnvironment を受け取り、出力とデフォルトのルートレベル info を設定します。読めない値は、そのプロパティを列挙する ConfigurationPropertiesBindException で失敗します (パターンや文字セットでは FormatException 付き)。再び呼ぶと、開いているファイルを閉じ、現在の値からファイルを開きます。
Spring (Java) との対応
loggingSystem.setLogLevel("neon.checkout", LogLevel.DEBUG);
メソッドは同じです。アペンダーは XML ではなく、コードで追加するクラスです。