すべてのプロパティ
spring_boot_starter_logging が読むすべてのプロパティを、spring_boot_dart が適用するレベルのキーとともに、プレフィックスごとにまとめています。スターターはそれらを LoggingProperties、AnsiProperties、ApplicationGroupProperties でバインドし、それらがエディター用のメタデータも生成します。
使う理由
ロギングはすべてプロパティで設定します。logback.xml はありません。このページはすべてのキーを列挙しているため、名前、デフォルト、単位を一か所で確認できます。
例
ファイルにログを書き、コンソールは短く保つサーバー:
# lib/resources/application.yml
spring:
application:
name: shop
group: neon
output:
ansi:
enabled: detect
logging:
level:
root: info
neon.checkout: debug
group:
payments: [neon.card, neon.cash]
pattern:
console: "%d{HH:mm:ss.SSS} %clr(%5p) [%logger{20}] %m%X%n"
dateformat: "yyyy-MM-dd HH:mm:ss.SSS"
threshold:
console: info
file: debug
file:
name: logs/shop.log
rolling-policy:
max-file-size: 10MB
max-history: 7
total-size-cap: 100MB
buffer:
capacity: 2000
# lib/resources/application.properties: 同じ内容
spring.application.name=shop
spring.application.group=neon
spring.output.ansi.enabled=detect
logging.level.root=info
logging.level.neon.checkout=debug
logging.group.payments=neon.card,neon.cash
logging.pattern.console=%d{HH:mm:ss.SSS} %clr(%5p) [%logger{20}] %m%X%n
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS
logging.threshold.console=info
logging.threshold.file=debug
logging.file.name=logs/shop.log
logging.file.rolling-policy.max-file-size=10MB
logging.file.rolling-policy.max-history=7
logging.file.rolling-policy.total-size-cap=100MB
logging.buffer.capacity=2000
値の書き方
- レベル:
trace、debug、info、warn (または warning)、error (または fatal)、off。大文字小文字を問いません。false (YAML の引用符なしの off) は off です。
- 真偽値:
true / false、on / off、yes / no、1 / 0 も可。それ以外は起動を止めます。logging.enabled では、スターターを無効にするのは false だけです。@ConditionalOnProperty と同じく、off、no、0 では有効のままです。
- データサイズ:
10MB、512KB。単なる数値はバイトです。
- パターンは書かれたとおりにバインドされます。その
${...} はパターンが解決します。
- スターターが読めない値 (パターン、レベル、数値、サイズ、文字セット) は、不正なログを出すのではなく、起動を止めます。
スターター
| キー |
型 |
デフォルト |
意味 |
logging.enabled |
bool |
true |
false: スターターは何も設定しない (出力も、バッファーも、Bean もない)。SpringLog は素の出力のまま |
レベル (spring_boot_dart が適用)
| キー |
型 |
デフォルト |
意味 |
logging.level.root (または logging.level) |
レベル |
info |
自分のレベルも祖先のレベルも持たないすべてのロガーのレベル |
logging.level.<logger> |
レベル |
継承 |
ロガーとその下のロガーのレベル。変数としては LOGGING_LEVEL_NEON_CHECKOUT=debug |
logging.group.<group> |
List<String> |
web と sql が定義済み |
ロガー名。logging.level.<group> がそれらをすべて設定する |
ログレベル を参照してください。
logging.pattern.*: 行の形式
| キー |
型 |
デフォルト |
意味 |
logging.pattern.console |
パターン |
Spring Boot のコンソールのパターン |
コンソールの行。空の値はコンソールを無効にする → パターン |
logging.pattern.file |
パターン |
Spring Boot のファイルのパターン |
ファイルの行。空の値はファイルなしを意味する → パターン |
logging.pattern.dateformat |
日付のパターン |
yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
デフォルトのパターンの %d (時刻は UTC)。${LOG_DATEFORMAT_PATTERN} |
logging.pattern.level |
パターン |
%5p |
デフォルトのパターンのレベルの列。${LOG_LEVEL_PATTERN} |
logging.pattern.correlation |
パターン |
空 |
デフォルトのパターンで [thread] の後に置かれる。${LOG_CORRELATION_PATTERN} |
logging.exception-conversion-word |
パターン |
%wEx |
デフォルトのパターンがエラーを出力する方法。${LOG_EXCEPTION_CONVERSION_WORD} |
logging.include-application-name |
bool |
true |
デフォルトのパターンに [spring.application.name] を入れる |
logging.include-application-group |
bool |
true |
デフォルトのパターンに [spring.application.group] を入れる |
spring.application.group |
String |
なし |
アプリケーションのグループ。デフォルトのパターンに表示される |
コンソール
| キー |
型 |
デフォルト |
意味 |
logging.console.enabled |
bool |
true |
コンソールの出力 → コンソール |
logging.console.target |
stdout / stderr / system-out / system-err |
未設定: 標準出力、またはアプリケーションが設定したもの (debugPrint) |
Dart VM でコンソールが書く先 |
logging.threshold.console |
レベル |
trace |
コンソールが表示する最も低いレベル |
logging.charset.console |
文字セット |
なし |
チェックされるだけ: コンソールはバイトではなくテキストを書く |
spring.output.ansi.enabled |
always / detect / never |
always。コンソールがコードをテキストとして表示する場所 (iOS の Flutter) では never |
色: %clr、または色のないパターンには Spring Boot の色 → コンソール |
バッファー
| キー |
型 |
デフォルト |
意味 |
logging.buffer.enabled |
bool |
true |
logBuffer がレコードを受け取るかどうか → ログ画面 |
logging.buffer.capacity |
int、1 から 1,000,000 |
1000 |
保持するレコードの数 |
logging.threshold.buffer |
レベル |
trace |
保持する最も低いレベル |
logging.file.*: ログファイル
| キー |
型 |
デフォルト |
意味 |
logging.file.name |
パス |
なし |
ログファイル。LoggingSystem.fileDirectory、なければ作業ディレクトリからの相対 → ログファイル |
logging.file.path |
ディレクトリ |
なし |
名前が設定されていないときの <dir>/spring.log |
logging.threshold.file |
レベル |
trace |
ファイルが保持する最も低いレベル |
logging.charset.file |
文字セット |
UTF-8 |
UTF-8、ISO-8859-1、US-ASCII。エンコードできない文字は ? になる |
logging.file.rolling-policy.max-file-size |
DataSize |
10MB |
ファイルが .1、.2、... にロールオーバーするサイズ |
logging.file.rolling-policy.max-history |
int |
7 |
保持するロールオーバー済みファイルの数。0: すべて |
logging.file.rolling-policy.total-size-cap |
DataSize |
0B: 上限なし |
ロールオーバー済みファイルの合計サイズの上限 |
logging.file.rolling-policy.clean-history-on-start |
bool |
false |
アプリケーションの起動時にロールオーバー済みファイルを削除する |
名前が変わったキー、無視されるキー、対応していないキー
| キー |
起こること |
logging.logback.rollingpolicy.* |
起動を止め、logging.file.rolling-policy.* を示す |
logging.file.max-size、logging.file.max-history、logging.file.total-size-cap、logging.file.clean-history-on-start |
現在のキーを示す警告とともに無視される |
logging.file.rolling-policy.file-name-pattern |
警告とともに無視される |
logging.config、logging.structured.*、logging.logback.* のその他のキー |
読まれない |
関連項目