observability-instrumentation

原則:

• 低カーディナリティのメトリクスラベル。
• 関連付けIDを含む構造化ログ。シークレットをログに記録しないこと。
• 「エッジ」をトレース: インバウンドリクエスト、アウトバウンド呼び出し、主要なドメイン操作。

チェックリスト:

• トレーシング
  • 外部呼び出し(HTTP、DB、メッセージバス、サードパーティSDK)の周辺にスパンを作成
  • 有用なスパン属性を追加(ルート、ステータスコード、依存関係名)
  • 非同期境界およびサービス間でコンテキストを伝播
• メトリクス
  • スループットとエラーのカウンターを追加
  • 必要に応じてレイテンシーのヒストグラムを追加
  • ユーザーID、リクエストID、またはその他の高カーディナリティラベルは回避
• ロギング
  • 構造化ログ(メッセージテンプレート)
  • 関連付けID/トレースID を含める(または OTel から導出)
  • 個人情報/シークレットのマスキング
• ヘルスチェックと準備状態
  • ヘルスエンドポイントまたはプローブが実際の依存関係を反映していることを確認(リポジトリ規約に従う)
• 検証
  • ローカルエクスポートパス(console/OTLP)を検証し、サンプルトレースが表示されることを確認
  • 最小限のドキュメントを追加: ローカルで実行する方法 + ダッシュ

...