← XeFM English | 日本語 · crftwr/xefm on GitHub · craftware

ログ機能

English | 日本語

概要

XeFM には充実したログ機能があり、アプリケーションの出力、エラーメッセージ、動作に関する情報を専用のログペインに記録します。ログ機能を使うと、XeFM の動作を見守ったり、問題をトラブルシューティングしたり、アプリケーションが何をしているかを把握したりできます。

機能

ログペインの表示

ログペインは XeFM の画面の下部に表示され、次のものを表示します。

アプリケーションのメッセージ：ファイル操作、検索、その他の動作に関する情報
プログラムの出力：外部プログラムやスクリプトからの出力
エラーメッセージ：操作中に発生した警告とエラー
デバッグ情報：詳細な診断情報（有効にした場合）

メッセージの種類

メッセージは種類ごとに色分けされます。

情報（白／通常）：一般的な動作メッセージ
警告（黄）：問題が起こりうることについての警告
エラー（赤）：失敗した操作のエラーメッセージ
デバッグ（淡色）：詳細な診断情報
プログラムの出力（シアン）：外部プログラムからの出力
エラー出力（マゼンタ）：外部プログラムからのエラー出力

画面の配置

┌─────────────────────────────────────────────────────────────┐
│                                                             │
│              Main XeFM Interface                             │
│              (File Browser)                                 │
│                                                             │
├─────────────────────────────────────────────────────────────┤
│ Log Messages:                                               │
│ 14:23:45 [Main] INFO: XeFM started                          │
│ 14:23:46 [FileOp] INFO: Copying file.txt to backup/        │
│ 14:23:47 [FileOp] INFO: Copy completed successfully        │
│ 14:23:48 [STDOUT] Processing complete                      │
└─────────────────────────────────────────────────────────────┘

操作

ログのスクロール

ファイル一覧からフォーカスを移さずにログをスクロールするアクションが 4 つあります。どのキーに割り当てられているかは F1 で確認してください。

scroll_log_up / scroll_log_down：1 行ずつ
scroll_log_page_up / scroll_log_page_down：1 ページずつ。履歴の途中から scroll_log_page_down を使うと、最新のメッセージまで戻っていけます

自動スクロールの動作

新しいメッセージは自動的に下に表示されます
ログは新しいメッセージが見えるように自動的にスクロールします
手動でスクロールすると、自動スクロールは一時的に止まります
最新のメッセージまでスクロールして戻ると、自動スクロールが再び有効になります

よくある使い方

ファイル操作を見守る

ファイル操作をリアルタイムで見守れます。

23:45 [FileOp] INFO: Copying file1.txt to backup/
23:46 [FileOp] INFO: Copy completed successfully
23:46 [FileOp] INFO: Copying file2.txt to backup/
23:47 [FileOp] INFO: Copy completed successfully

エラーをトラブルシューティングする

エラーを見つけて、その内容を理解できます。

14:23:45 [FileOp] INFO: Copying protected.txt to backup/
14:23:46 [FileOp] ERROR: Permission denied

プログラムの出力を見る

外部プログラムからの出力を確認できます。

23:45 [Main] INFO: Running external script
23:46 [STDOUT] Processing file 1 of 10
23:47 [STDOUT] Processing file 2 of 10
23:48 [STDOUT] Processing complete

進み具合を追う

時間のかかる操作を見守れます。

23:45 [Archive] INFO: Extracting archive.zip
23:46 [Archive] INFO: Extracted 100 of 500 files
23:47 [Archive] INFO: Extracted 200 of 500 files
23:48 [Archive] INFO: Extracted 300 of 500 files
23:49 [Archive] INFO: Extraction completed

設定

ログペインのサイズ

ログペインのサイズは設定で変えられます。

既定：画面の高さの 25%
設定ファイルで調整可能
最小：3 行
最大：画面の高さの 50%

メッセージの保持

XeFM が保持するログメッセージの数は設定で変えられます。

既定：1000 件
古いメッセージは自動的に削除されます
設定で変更可能
長時間のセッションでメモリの問題が起きるのを防ぎます

ログレベル

メッセージには次のいずれかのレベルが付きます。

INFO：一般的な動作メッセージ
WARNING：想定どおりに動かなかったが、XeFM は処理を続けたこと
ERROR：失敗
DEBUG：詳細な診断情報

ログには INFO 以上が表示されます。これを変える設定はありません。

ログをクリップボードにコピーする

ログペインの内容は、デスクトップアプリでもターミナルでも同じく、2 つの方法でシステムのクリップボードにコピーできます。バグ報告、チャットのメッセージ、メモに貼り付けるのに便利です。

選択した部分をコピーする

マウスでログの上をドラッグして行を強調表示し（ダブルクリックで単語、トリプルクリックで行を選択します。上端や下端を越えてドラッグすると選択が続きます）、コピーのキー（Ctrl-C。macOS アプリでは、キーマッププリセットによって Command-C にも割り当てられています。キーマッププリセットを参照してください）を押します。ログでテキストが強調表示されているときは、このキーはそのテキストをコピーします。強調表示がないときは、ファイルをファイルクリップボードに入れます。テキストがクリップボードに入ると強調表示は消えます。

このキーは、最後にどのペインをクリックしていたかにかかわらず、ログで強調表示されているものをコピーします。そのため、ログで選択してからファイル一覧に戻っても、コピーできなくなることはありません。何も強調表示されていなければ、何もしません。

Edit ▸ Copy Log Selection はメニューから同じことを行います。何かを選択するまではグレー表示になっています。

ログ全体をコピーする

Edit ▸ Copy All Logs は、ペインがまだ保持しているすべての行をコピーします。起動時からの行も、スクロールして見えなくなった行も、バッファーの上限（2000 行）まですべてです。コピーした行数はログ自体に表示されます。ログを貼り付けてほしいと頼まれたときは、これを使ってください。

このアクションには既定のキーがありません。キーを割り当てるには、~/.xefm/config.py で copy_log_all をバインドします。

KEY_BINDINGS['copy_log_all'] = ['Ctrl-G']

ファイルにはまったく触れないキーがほしい場合は、copy_log_selection（ログ専用のアクションで、既定ではキーが割り当てられていません）を同じようにバインドします。

コピーされる形式

行はペインに表示されているとおりにコピーされます。ロガーのメッセージにはタイムスタンプ（HH:MM:SS）、ロガー名、レベルが付き、アプリ自身のステータス行は描画されているとおりのプレーンテキストとしてコピーされます。

23:45 [Main  ] INFO: Application started
23:46 [FileOp] INFO: Loaded directory: /home/user/documents
Copied 3 names to clipboard
23:47 [Main  ] WARNING: Configuration file not found, using defaults

選択した部分は画面上の配置どおりにコピーされるので、折り返された長い行は折り返し位置で分かれた状態になります。Copy All Logs は折り返さずに行全体をコピーします。

ヒントとコツ

最近のエラーを探す

ログを最新のメッセージの位置にしておきます（既定ではそうなっています）
scroll_log_up で 1 行ずつ上にスクロールします
赤いエラーメッセージを探します

操作の履歴を振り返る

scroll_log_page_up で履歴を 1 ページずつさかのぼります
scroll_log_page_down でまた先に進みます
メッセージを時系列で確認します

長い操作を見守る

操作中はログペインを表示したままにします
進み具合のメッセージに注目します
エラーや警告がないか確認します
完了メッセージを確かめます

問題をデバッグする

詳しい情報を得るために DEBUG ログレベルを有効にします
問題を再現させます
手がかりを探してログメッセージを確認します
エラーメッセージと警告を探します

トラブルシューティング

ログペインが表示されない

問題： ログペインが表示されません。

解決策： 設定を確認してください。

設定で LOG_PANE_ENABLED = True になっていることを確かめます
画面の高さが十分か確認します
ターミナルのウィンドウサイズを変えてみます

メッセージのスクロールが速すぎる

問題： 新しいメッセージがすぐに流れ去ってしまいます。

解決策：

scroll_log_up で上にスクロールして確認します
scroll_log_page_up でページ単位でさかのぼります
ログレベルを WARNING に下げることを検討します

メッセージが多すぎる

問題： ログペインがメッセージであふれてしまいます。

解決策：

設定の MAX_LOG_MESSAGES を増やします（既定値：1000）
より高いログレベル（WARNING または ERROR）を設定します
XeFM を再起動して古いメッセージを消去します

利点

ユーザーにとって

すぐにわかる反応：XeFM が何をしているかをリアルタイムで確認できます
エラーが見える：エラーをすばやく見つけて理解できます
操作の履歴：最近の操作とその結果を振り返れます
進み具合の把握：時間のかかる操作を見守れます

トラブルシューティングにとって

エラーの診断：詳しいエラーメッセージが問題の特定に役立ちます
操作の追跡：どの操作が行われたかを正確に確認できます
デバッグ情報：必要なときに詳しい診断データが得られます

開発者にとって

デバッグが簡単：デバッグ出力が 1 か所にまとまっています
エラーの追跡：エラーを漏れなくログに記録します
進み具合の通知：進み具合のメッセージを簡単に追加できます
柔軟な出力：さまざまな種類のメッセージに対応しています

高度な機能

メッセージのタイムスタンプ

すべてのメッセージにタイムスタンプが付きます。

14:23:45 [FileOp] INFO: Operation started
14:23:46 [FileOp] INFO: Operation completed

形式：HH:MM:SS（24 時間表記）

発生元の表示

メッセージには発生元が表示されます。

[Main]：メインアプリケーション
[FileOp]：ファイル操作
[DirDiff]：ディレクトリ差分ビューアー
[Archive]：アーカイブ操作
[STDOUT]：プログラムの出力
[STDERR]：エラー出力

複数行のメッセージ

複数行の出力はそのまま保たれます。

23:45 [STDOUT] Processing file: example.txt
23:45 [STDOUT] Size: 1024 bytes
23:45 [STDOUT] Modified: 2024-01-15

色分け

メッセージは見分けやすいように色分けされます。

通常のメッセージ：白／既定の色
警告：黄
エラー：赤
デバッグ：淡色／グレー
プログラムの出力：シアン
エラー出力：マゼンタ

まとめ

XeFM のログ機能を使うと、アプリケーションの動作を隅々まで把握でき、動作の見守り、問題のトラブルシューティング、アプリケーションが何をしているかの理解に役立ちます。色分けされ、スクロールできるログペインのおかげで、操作を追跡し、問題をすばやく見つけるのが簡単になります。

開発者向けのドキュメントは doc/dev/LOGGING_SYSTEM.md を参照してください。