ログレベル
SpringApplication は、spring_boot_starter_logging の有無にかかわらず、起動のたびに logging.level.* と logging.group.* のプロパティを SpringLog ファサードに適用します。Spring Boot の LoggingApplicationListener に当たります。スターターは出力 (コンソールのパターン、ファイル、バッファー) を追加します。レベルは spring_boot_dart の担当です。
使う理由
ログレベルはコードより頻繁に変わります。デバッグ中はあるパッケージの詳細を増やし、本番ではノイズを減らします。プロパティとして設定すれば、他の設定と同じく、コマンドラインのオプション、環境変数、プロファイルのファイルで変更できます。
例
# lib/resources/application.yml
logging:
level:
root: info
neon.checkout: debug # neon.checkout.* のすべてのロガーにも
payments: trace # グループ。下を参照
group:
payments: [neon.card, neon.cash]
# lib/resources/application.properties: 同じ内容
logging.level.root=info
logging.level.neon.checkout=debug
logging.group.payments=neon.card,neon.cash
logging.level.payments=trace
LOGGING_LEVEL_NEON_CHECKOUT=debug dart run bin/main.dart
dart run bin/main.dart --logging.level.root=warn
// @Log(topic: 'neon.checkout') は、クラスにその名前のロガーを与える。
@Service()
@Log(topic: 'neon.checkout')
class Checkout {
void pay() => log.debug(() => 'paying'); // neon.checkout が debug なら表示される
}
ルール
| キー | 意味 |
|---|---|
logging.level.root (または単なる logging.level) |
自分のレベルを持たないすべてのロガーのレベル。root は大文字小文字を問わず照合される |
logging.level.<logger> |
ロガーと、その下のすべてのロガー (neon.checkout.cart) のレベル |
logging.group.<group> |
ロガー名のリスト。logging.level.<group> がそのそれぞれを設定する |
- レベルは
trace、debug、info、warn(またはwarning)、error(またはfatal)、offです。引用符なしのoffから YAML が作るfalseはoffを意味します。 - レベルでない値は起動を止めます:
logging.level.neon: failed to convert to LogLevel (was "loud"; use trace, debug, info, warn, error, fatal or off)。 - 空の値はレベルを継承したままにします。
- レベルは、設定ファイルが読まれた後、バナーと Bean の前に設定されます。起動のそれより前に書かれたログ行は保留され、それらのレベルで出力されます。
spring_boot_starter_loggingがない場合、SpringLogは INFO 以上のレコードをコンソールに書きます (Spring のデフォルトのレベル)。スターターはパターン、ファイル、バッファーを追加します。
定義済みのグループ
Spring Boot の web と sql のグループと同様です。
| グループ | ロガー |
|---|---|
web |
spring.web、spring.websocket |
sql |
spring.jdbc.core.JdbcTemplate、spring.jdbc.core.StatementCreatorUtils |
# Web スターターのすべてのリクエストと、すべての SQL 文。
logging.level.web=debug
logging.level.sql=debug
アプリケーションの logging.group.web は、定義済みのリストを置き換えます。
--debug と --trace
| スイッチ | 効果 |
|---|---|
--debug (または debug=true、DEBUG=true) |
spring_core_dart、spring_boot_dart、spring.web.server を debug にし、条件評価レポート をログに出す |
--trace (または trace=true) |
同じロガーを trace にする。--debug より優先される |
false 以外のどの値でも有効になるため、--debug だけで動きます。logging.level.* のレベルはこれらより優先されます。
コードで
SpringApplication.applyLoggingLevels(environment) は、SpringApplication を使わずに準備した Environment に対して同じことを行います。以前の呼び出しが設定したレベルはクリアされます。
Spring (Java) との対応
キー、グループ、スイッチは同じです。ロガー名は Java のパッケージではなく Dart のライブラリ名、または SpringLog に与えた名前です。そのため logging.level.org.springframework=debug には効果がありません。--debug か上記の名前を使ってください。