observability-audit について
Observability Audit は、ソフトウェア変更がリリース後に運用・診断できるかを確認するスキルです。API、バックグラウンドジョブ、同期処理、外部アダプターを監査し、追跡可能な証拠と機密データの扱いに注目します。
主な機能
- 01対象別の監査質問
- 02API とジョブの証拠チェックリスト
- 03外部アダプターのログ指針
- 04構造化ログの品質確認
- 05所見と不足証拠のレポート形式
活用シーン
- 01リリース前の可観測性レビュー
- 02ジョブや同期処理の計測漏れの特定
- 03機密データがログに含まれるかの確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ marcioaltoe/ skills --skill observability-auditインストール後、Claude Code で/observability-auditを入力して読み込まれたか確認します。
詳細
可観測性監査
変更をリリースした後も運用できることを確認するには、このスキルを使用してください。
監査の質問
- オペレーターはワークフローが実行されたかどうかを確認できますか?
- 障害を原因別に分類できますか?
- ユーザーからの報告を、リクエスト、ジョブ、テナント、アカウント、または外部システムの ID まで追跡できますか?
- リトライ、一部の失敗、スキップされたレコードは確認できますか?
- シークレットや個人データがログや証跡から除外されていますか?
- コードは外部リクエスト ID やプロバイダーの相関 ID を保持していますか?
各サーフェスで必要な証跡
HTTP API
- リクエスト ID または相関 ID
- ルート名または操作名
- ステータスコードと所要時間
- 安全な場合は、認証済みのアクターまたはテナント ID
- 正規化されたエラーの種類
バックグラウンドジョブと同期処理
- 実行 ID
- ソースシステム
- 処理前後のチェックポイント
- 取得、変更、スキップ、失敗した件数
- リトライ回数
- 失敗の分類
外部アダプター
- 外部システム名
- 操作名
- 安全な外部識別子
- プロバイダーから返されたリクエスト ID
- タイムアウト/リトライの分類
ログ品質チェックリスト
- ログは文字列に埋め込まれた一括データではなく、構造化されています。
- ログレベルは運用上の重大度に合っています。
- 機密フィールドはマスキングされるか、省略されています。
- 関連イベントを結び付けるのに十分なコンテキストがログ行に含まれています。
- 想定内の検証失敗は、プロセスエラーとして記録されていません。
- 例外を処理する境界で、スタックトレースが保持されています。
レビュー結果
監査時には、次の内容を報告してください。
## Observability Findings
- [severity] [file:line] Finding and operational impact.
## Missing Evidence
- Request/job/correlation IDs:
- Counts/status summaries:
- External provider metadata:
- Redaction concerns:
## Recommended Fixes
- Concrete code or logging changes.
よくある誤り
- 起動時と最終的な失敗時にしかログを記録しない。
- 生のリクエスト本文、トークン、ヘッダー、または署名付き URL をログに記録する。
- 件数やチェックポイントの証跡なしに「成功」を記録する。
- プロバイダーのリクエスト ID を隠す。
- 可観測性を実行可能なコードパスではなく、コメントとして扱う。
コメント
Markdown 対応