OpenThread ログは、多数のコンパイル時構成定数によって制御されます。特に明記されていない限り、これらの定数は次のファイルで定義されています。
openthread/src/core/config/logging.h
出力メソッド
OpenThread は、OPENTHREAD_CONFIG_LOG_OUTPUT のコンパイル時構成定数として定義された、さまざまな出力ロギング方法をサポートしています。ロギング メソッドのオプションは、次のファイルに記載されています。
openthread/src/core/config/logging.h
デフォルトのログ出力構成は OPENTHREAD_CONFIG_LOG_OUTPUT_PLATFORM_DEFINED です。
出力メソッドは、コアの構成定数ではなくプラットフォーム レベルの構成定数を更新する必要がある場合の例です。たとえば、シミュレーションのサンプルアプリで出力メソッドを変更するには、openthread/src/core/config/logging.h ではなく openthread/examples/platforms/simulation/openthread-core-simulation-config.h を編集します。
ログレベル
ログは、OPENTHREAD_CONFIG_LOG_LEVEL のコンパイル時構成定数として定義されたさまざまなレベルの情報を出力する場合があります。レベル オプションは次のファイルに記載されています。
openthread/include/openthread/platform/logging.h
ログレベルの一覧は、プラットフォーム ロギング マクロ API リファレンスにも記載されています。
デフォルトのログレベルは OT_LOG_LEVEL_CRIT で、最も重要なログのみが出力されます。必要に応じてレベルを変更して、より多くのログを表示します。すべての OpenThread ログを表示するには、OT_LOG_LEVEL_DEBG を使用します。
ログのリージョン
ログ リージョンは、ロギング用に有効にする OpenThread コードの領域を決定します。リージョン列挙型は、次のファイルで定義されています。
openthread/include/openthread/platform/logging.h
ログ リージョンのリストは、プラットフォーム ロギング列挙型 API リファレンスでも確認できます。
ログ領域は、ログ関数のパラメータとしてよく使用されます。デフォルトでは、すべてのリージョンが有効になっています。
デフォルトのロギング関数
OpenThread 内のロギングのデフォルト関数は otPlatLog で、OPENTHREAD_CONFIG_PLAT_LOG_FUNCTION のコンパイル時構成定数として定義されます。
この関数の詳細については、プラットフォーム ロギング API リファレンスをご覧ください。
OpenThread のサンプルアプリでこの関数を直接使用するには、OT_REFERENCE_DEVICE cmake オプションを使用します。たとえば、CC2538 の例の CLI アプリ内で使用するには:
./script/build -DOT_REFERENCE_DEVICE=ON
または、openthread/etc/cmake/options.cmake ファイルを更新して、ビルド時にデフォルトで有効にします。
ログを有効にする方法
ログを有効にする前に、OpenThread をビルドするように環境が構成されていることを確認してください。詳しくは、OpenThread をビルドするをご覧ください。
すべてのログを有効にする
すべてのログレベルとリージョンをすばやく有効にするには、OT_FULL_LOGS cmake オプションを使用します。
./script/build -DOT_FULL_LOGS=ON
このスイッチは、ログレベルを OT_LOG_LEVEL_DEBG に設定し、すべての地域フラグをオンにします。
特定のレベルのログを有効にする
特定のレベルのログを有効にするには、openthread/src/core/config/logging.h を編集して OPENTHREAD_CONFIG_LOG_LEVEL を目的のレベルに更新し、OpenThread をビルドします。たとえば、OT_LOG_LEVEL_INFO までのログを有効にするには:
#define OPENTHREAD_CONFIG_LOG_LEVEL OT_LOG_LEVEL_INFO
./script/build
syslog でログを表示する
ログはデフォルトで syslog に送信されます。Linux の場合は /var/log/syslog.
- すべてのログを有効にしてシミュレーションの例をビルドします。
cd openthread./script/cmake-build simulation -DOT_FULL_LOGS=ON - シミュレートされたノードを起動します。
./build/simulation/examples/apps/cli/ot-cli-ftd 1 - 新しいターミナル ウィンドウで、OT ログのリアルタイム出力を設定します。
tail -F /var/log/syslog | grep "ot-cli-ftd" - シミュレートされたノードで、Thread を起動します。
dataset init newDonedatasetActive Timestamp: 1 Channel: 13 Channel Mask: 07fff800 Ext PAN ID: d63e8e3e495ebbc3 Mesh Local Prefix: fd3d:b50b:f96d:722d/64 Network Key: dfd34f0f05cad978ec4e32b0413038ff Network Name: OpenThread-8f28 PAN ID: 0x8f28 PSKc: c23a76e98f1a6483639b1ac1271e2e27 Security Policy: 0, onrcb Donedataset commit activeDoneifconfig upDonethread startDone
tail コマンドを実行しているターミナル ウィンドウに戻ります。シミュレートされたノードのログがリアルタイムで表示されます。出力のログタグ（[INFO]、[DEBG]、[NOTE]）に注目してください。これらはすべてログレベルに対応しています。たとえば、ログレベルを OT_LOG_LEVEL_INFO に変更すると、DEBG ログが出力から消えます。
ot-cli-ftd[30055]: [1] [DEBG]-MAC-----: SrcAddrMatch - Cleared all entries
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: Read NetworkInfo {rloc:0x9c00, extaddr:1a4aaf5e97c852de, role:Leader, mode:0x0f, keyseq:0x0, ...
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: ... pid:0x8581bc9, mlecntr:0x3eb, maccntr:0x3e8, mliid:05e4b515e33746c8}
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Notifier: StateChanged (0x7f133b) [Ip6+ Ip6- LLAddr MLAddr Rloc+ KeySeqCntr NetData Ip6Mult+ Channel PanId NetName ExtPanId MstrKey PSKc SecPolicy]
ot-cli-ftd[30055]: [1] [INFO]-CLI-----: execute command: dataset panid
ot-cli-ftd[30055]: [1] [INFO]-CLI-----: execute command: dataset commit active
ot-cli-ftd[30055]: [1] [INFO]-MESH-CP-: Active dataset set
ot-cli-ftd[30055]: [1] [DEBG]-MAC-----: Idle mode: Radio sleeping
ot-cli-ftd[30055]: [1] [DEBG]-MAC-----: RadioPanId: 0x8f28
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Notifier: StateChanged (0x007f0100) [KeySeqCntr Channel PanId NetName ExtPanId MstrKey PSKc SecPolicy]
ot-cli-ftd[30055]: [1] [INFO]-CLI-----: execute command: ifconfig up
ot-cli-ftd[30055]: [1] [DEBG]-MAC-----: Idle mode: Radio receiving on channel 11
ot-cli-ftd[30055]: [1] [INFO]-CLI-----: execute command: thread start
ot-cli-ftd[30055]: [1] [NOTE]-MLE-----: Role Disabled -> Detached
ot-cli-ftd[30055]: [1] [INFO]-MLE-----: Attempt to become router
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: Read NetworkInfo {rloc:0x9c00, extaddr:1a4aaf5e97c852de, role:Leader, mode:0x0f, keyseq:0x0, ...
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: ... pid:0x8581bc9, mlecntr:0x3eb, maccntr:0x3e8, mliid:05e4b515e33746c8}
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: Saved NetworkInfo {rloc:0x9c00, extaddr:1a4aaf5e97c852de, role:Leader, mode:0x0f, keyseq:0x0, ...
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: ... pid:0x8581bc9, mlecntr:0x7d4, maccntr:0x7d0, mliid:05e4b515e33746c8}
ot-cli-ftd[30055]: [1] [DEBG]-MLE-----: Store Network Information
ot-cli-ftd[30055]: [1] [INFO]-MLE-----: Send Link Request (ff02:0:0:0:0:0:0:2)
CLI アプリでログを表示する
ログは OpenThread CLI のサンプルアプリで直接確認できます。
- サンプル プラットフォームの構成ファイルを編集し、ログ出力をアプリに変更します。シミュレーションの例では、これは
openthread/examples/platforms/simulation/openthread-core-simulation-config.hです。#define OPENTHREAD_CONFIG_LOG_OUTPUT OPENTHREAD_CONFIG_LOG_OUTPUT_APP - 目的のログレベルでシミュレーションの例をビルドします。すべてのログを有効にするには:
./script/cmake-build simulation -DOT_FULL_LOGS=ON - シミュレートされたノードを起動します。
./build/simulation/examples/apps/cli/ot-cli-ftd 1 - コマンドが処理されると、OpenThread CLI と同じウィンドウにログ出力が表示されます。
カスタム ロギングを追加してすべてのログを有効にしている場合、CLI 行バッファまたは UART 送信バッファが、追加のカスタムログを処理するのに十分な大きさでない可能性があります。ログが表示されるべきときに表示されない場合は、/openthread/src/cli/cli_config.h の OPENTHREAD_CONFIG_CLI_MAX_LINE_LENGTH として定義されている CLI 行バッファのサイズを増やすか、/src/nrf52840/openthread-core-nrf52840-config.h などのプラットフォームの構成ファイルで OPENTHREAD_CONFIG_CLI_UART_TX_BUFFER_SIZE として定義されている UART 送信バッファのサイズを増やしてみてください。
実行時にログレベルを変更する
動的ログレベル制御が有効になっている場合、ログレベルは実行時に変更されることがあります。
-DOT_LOG_LEVEL_DYNAMIC=ONオプションを使用してアプリをビルドします。たとえば、./script/build nrf52840 UART_trans -DOT_JOINER=ON -DOT_FULL_LOGS=ON -DOT_LOG_LEVEL_DYNAMIC=ON- OpenThread アプリケーション内で Logging API を使用します。