NEVO
すべてのノート
運用

次の疑問に答えるログを書く

約 3 分

よいログは、アプリケーション全体を読み直さなくても、何が起きたかを説明してくれます。

最も役立つログは、最も長いログとは限りません。どの操作が影響を受け、どんな判断が行われ、その後どうなったのか。具体的な疑問に答える記録が役立ちます。

出来事から始める

出来事は平易な言葉で説明し、変わる情報は構造化されたフィールドに入れます。イベント名が安定していれば、リリースごとに変わる文章を解析せずに、発生回数の集計や比較ができます。

外部サービスへの呼び出しが失敗した場合は、接続先、経過時間、試行回数、エラーの種類が役立ちます。リクエスト本文を丸ごと残す必要は少なく、ログに出してはいけない情報が含まれる場合もあります。

文脈を慎重につなぐ

リクエスト ID は関連する出来事を結び付けます。自分たちが管理する処理の間で引き継ぎ、重要な境界で記録します。認証トークンやセッションの秘密情報など、アクセス権を与える値とは分けて扱います。

相関 ID は参照であって、二つの出来事の因果関係を証明するものではありません。バックグラウンド処理、キュー、並列実行では、関係を明確にするために別の操作 ID が必要な場合があります。

重要度を対応に結び付ける

通常の再試行を毎回エラーレベルで記録する必要はありません。想定内の拒否は、警報よりも件数として把握する方が役立つことがあります。最も強い通知は、注意や対応が必要な状況に使います。

同じ失敗をすべての層で繰り返し報告するのも避けます。十分な文脈を持つ層で結果を説明し、下位のログは別の事実を加える場合に使います。

失敗を最初から最後まで読む

ログの変更を完了とする前に、代表的な失敗を起こして記録を読みます。遅い接続先と不正な入力を区別できるか。最終的な結果が分かるか。秘密情報が出ていないかを確認します。

ログの目的は、運用する人の疑問を減らすことです。「何かが失敗した」としか書かれていなければ、次の改善点がそこにあります。


すべてのノート