ログ画面
モバイルやデスクトップのアプリには、ユーザーが読めるターミナルがありません。LogBuffer は最新のレコードをメモリに保持するため、アプリはログ画面、バグレポート用の「ログを送信」ボタン、デバッグメニューのエラーのバッジを提供できます。これは logBuffer Bean であり、LoggingSystem.instance.buffer でもあります。
使う理由
ユーザーがバグを報告したとき、直前数分のログが最も役に立ちますが、スマートフォンにはそれをコピーするコンソールがありません。バッファーはそれを保持し、ログビューアーのために作られた API を提供します。ライブリスト、フィルター、安定したリストのキー、エクスポートです。
例
class LogScreen extends StatefulWidget {
const LogScreen({super.key});
@override
State<LogScreen> createState() => _LogScreenState();
}
class _LogScreenState extends State<LogScreen> {
final buffer = LoggingSystem.instance.buffer;
var query = const LogQuery(minLevel: SpringLogLevel.info);
@override
Widget build(BuildContext context) => Column(children: [
// 検索ボックスは、ユーザーの入力に合わせてリストを絞り込む。
TextField(
onChanged: (text) => setState(() => query = query.copyWith(text: text)),
),
Expanded(
child: StreamBuilder<List<SpringLogRecord>>(
// 現在のリスト、その後レコードのまとまりごとに新しいリスト。
stream: buffer.watch(query),
builder: (context, snapshot) {
final records = snapshot.data ?? const [];
return ListView.builder(
itemCount: records.length,
itemBuilder: (context, i) => ListTile(
key: ValueKey(records[i].sequence), // リストが変わっても安定している
title: Text(records[i].message),
subtitle: Text('${records[i].loggerName} · ${records[i].fields}'),
),
);
},
),
),
]);
}
# lib/resources/application.yml
logging:
buffer:
enabled: true
capacity: 2000
threshold:
buffer: debug
プロパティ
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
logging.buffer.enabled |
bool |
true |
バッファーがレコードを受け取るかどうか |
logging.buffer.capacity |
int、1 から 1,000,000 |
1000 |
保持するレコードの数。古いものから押し出される |
logging.threshold.buffer |
レベル | trace |
保持する最も低いレベル |
API
| 必要なもの | API |
|---|---|
| フィルター付きのライブリスト | buffer.watch(query): Stream<List<SpringLogRecord>>。現在のリスト、その後変更のまとまりごとに一つ (一回の同期的な処理でログに出された多数のレコードは一つのイベントになる) |
| スナップショット | buffer.records、buffer.query(query) |
| 新しいレコードごと | buffer.onRecord。ロギングの呼び出し中に同期的に届く (エラー時のスナックバー) |
| バッジ | buffer.counts[SpringLogLevel.error]、buffer.dropped (容量によって押し出されたレコード) |
| ロガーのフィルターメニュー | buffer.loggerNames |
| 共有またはコピー | buffer.export(query)、または LogPattern を使う buffer.export(query, pattern) |
| クリア | buffer.clear() |
| サイズ変更 | buffer.capacity = 500 |
LogQuery
LogQuery(minLevel:, levels:, logger:, text:, fields:, since:) はイミュータブルで、copyWith で変更します。
| 条件 | 一致するもの |
|---|---|
minLevel |
このレベル以上のレコード |
levels |
これらのレベルのレコード |
logger |
このロガーと、その下のロガーのレコード |
text |
テキストにこれを含むレコード |
fields |
これらのフィールドの値を持つレコード |
since |
この時刻より後にログに出されたレコード |
copyWith(minLevel: null) (または levels、logger、text、since) はその条件を取り除きます。fields は例外で、copyWith(fields: null) は現在のフィールドを保ちます。取り除くには const {} を渡してください。
レコード
SpringLogRecord はイミュータブルで、time、sequence (安定したリストのキー)、level、loggerName、message、fields、error、stackTrace を持ちます。
Spring (Java) との対応
バッファーに対応するものは Spring にはありません。最も近いのは、ログファイルを配信する Actuator の logfile エンドポイントです。