保存期間 †
ログ記録 †
フルスタックオブザーバビリティのためのログ記録 †
必要なものを記録する †
- 最も重要な判断は、何をログに含めるかを選別すること
- ログには、調査する際にイベントと根本原因の特定に役立つ全ての必要なメタデータを含めるべき
- ログのメタデータの構成要素には、エラーメッセージまたはスタックトレースと、それらに関連する値、メトリクス、イベントなどが含まれる場合がある
- 組織のログの全てのデータには、目的を持たせるべき
- データは、使用率であれ、ユーザーイベントであれ、アプリケーションのエラーと例外であれ、チームにとって価値があるべき
- ログデータ情報の要件：
- 何らかの形ですぐに役立つ
- 根底にある原因を理解し、判断を下すために必要な詳細情報を提供する
共通のシナリオを予想する †
- 共通のシナリオを幾つか念頭にログ記録を取ることにより、ログは組織に直接的な価値をもたらすようになる
- ユーザー同士の行動に関するログは、顧客体験に関する重要な洞察をもたらす
- システムログにより、問題やハードウェア障害を監視できる
- アプリケーションに関する詳細なログは、パフォーマンスとメモリリークなどの潜在的な問題への洞察をもたらす
有意義なメッセージを記録する †
- アプリケーションエラーの場合、メッセージはその命令行で何が起こっているかを伝える必要がある
- トランザクションに関するデータを含むログは、トランザクションが失敗した理由を開発者やエンジニアが確認するのに役立つ
- ログに簡潔な説明を加えると、トラブルシューティングの際に他の開発者やエンジニアの時間と労力を節約できる
ログは常にシンプルで簡潔にする\ †
- 過剰で不必要なデータをメッセージに含めると、ログのストレージサイズとコストが膨れあがり、ログ
の検索が遅くなり、本質的な問題から遠ざかり、デバッグがいっそう面倒なものになってしまうので注意
- ログには、不要なノイズを避けつつ、エラーが発生した理由を含めるべき
- エラーの根本原因に関する情報を提供すべき
- アプリケーションが内部APIに接続できずデータを取得できなかった場合、APIからのエラーメッセージまたは環境のネットワーク状態に関する情報をログに記録すると役立つことがある
- アプリケーションが使用するメモリの量や実行中のアプリケーションの数を含める必要はない
時刻の記録 †
- 納得のいく最も細かいレベルを選択し、ログに出力する必要がある
- 潜在的に明白かつ重要な注意点は、全てのシステムを同時に同期させ、オブザーバビリティプラットフォームがタイムスタンプを使用して、ログイベントを他のテレメトリデータと関連付けられるようにすること
ログフォーマット †
解析可能なログフォーマットを使用する †
- 一貫性のあるログ構造を維持できるログフォーマットを使用して、収集と集計を容易にすべき
- 構造化ログを推奨
ログレベル †
- ログのレベルは、イベントの相対的重要性を説明し（デバッグ、情報、警告、エラー、致命的などの観点で）、ロギングフレームワークから得た情報の密度も説明してくれる
- ログレベルを有効活用すれば、データ量を制限し、集中ログ管理ツールの使用コストを節約し、検索が迅速になる
- チームはログレベル、特にデバッグログレベルを注意して使用すべき
- 特定の動作に伴う冗長なメッセージを取得するのにデバッグは大いに役立つが、不必要なデバ
ッグは膨大な量のログをもたらし、付加価値を提供することなくログの取り込みと検索機能の速度を低下させる
- 規模の大きなチームとプロジェクトは、一貫性のあるグループ化、カテゴリー化、およびログ記録方法に関するログレベルの基準から恩恵を受けることがある
ログに加えるべきでないもの †
機密情報 †
- 機密情報は慎重に取り扱う必要があります。個人識別情報（PII）およびクレジットカード番号などの規制データは、欧州連合の一般データ保護規則（GDPR）3および米国の医療保険ポータビリティおよび説明責任法（HIPAA）などの規制法に従って保護することが不可欠
- オープン・ウェブ・アプリケーション・セキュリティ・プロジェクト（OWASP）のロギングガイドラインには、記録すべきでないものが記載されている
- 例えば、アクセス用トークン、パスワード、機密情報、個人が明かしたくない情報など
- 特定のユーザーの行動またはイベントの追跡に際しては、匿名の識別子を使用する必要がある
構造化ログ †
Pros&Cons †
Pros †
- ログフォーマットごとにパーザを用意しなくてもよくなる
- 各フィールドに名前がついているので、データそれ自体から意味を読み取りやすい (自己記述的である)
- フィールドの追加が容易である
- jq や jr を活用することであらゆる UNIX コマンドと組み合わせることができる
Cons †
その他 †
フォレンジック †
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
