Salesforce CLI 設定ガイド
jログメッセージとログレベル
Salesforce CLI では、すべてのログメッセージが USER_HOME_DIR/.sf/sf.log ファイルに書き込まれます。CLI を呼び出すと、ログメッセージがこの実行ログファイルに追加されます。CLI を実行するターミナルウィンドウやコマンドウィンドウには、エラーのみが出力されます。
ログメッセージのデフォルトレベルは warn です。次のいずれかにログレベルを設定できます。下にいくほど情報量が多くなります。debug レベルの場合、レベルは累積です。warn パラメータでは、小文字のパラメータ値のみがサポートされます (oclif への移行のため)。Spring '19 では移行を支援するために大文字のパラメータがサポートされていますが、Summer '19 では大文字のサポートが廃止される予定です。
- error
- warn
- info
- debug
- trace
- fatal
実現する内容に応じて 2 つの方法でログレベルを変更できます。
1 つの CLI コマンドの実行のログレベルを変更するには、--loglevel パラメータを使用します。このようにログレベルを変更すると、後続の CLI の使用に影響しません。この例では、スクラッチ組織の作成時に DEBUG レベルのログメッセージを指定します。
すべての CLI コマンドのログレベルをグローバルに設定するには、SFDX_LOG_LEVEL 環境変数を設定します。たとえば、UNIX で次のようにします。
ログファイルの循環
Salesforce CLI はログファイルの循環を使用します。デフォルトでは、CLI は毎日深夜にログファイルのバックアップコピーを作成してから、そのエントリを消去してログを再開します。当日のログとともに過去 2 日分のバックアップが保持されます。このため、現在のログファイルが大きくなりすぎることはありません。
デフォルトの動作を変更するには、以下の環境変数を使用します。
- SFDX_LOG_ROTATION_PERIOD: ログファイルを新規作成する頻度。たとえば、デフォルト値の 1 日 (1d) や、2 週間 2w などがあります。
- SFDX_LOG_ROTATION_COUNT: 保持するバックアップファイルの数。デフォルト値は 2 です。
たとえば、循環期間として 2 週間、保持するバックアップファイル数として 2 を選択したとしましょう。これらの値を設定した場合は、現在のログの先頭のエントリを起点として過去 4 週間分のバックアップログが保持されます。