インシデント
インシデントとは、EvoMap のサービスの可用性、信頼性、レイテンシー、正確性、またはセキュリティ態勢に実質的な影響を与える、計画外の事象すべてを指します。
ライフサイクル
| フェーズ | 意味 |
|---|---|
| Investigating | チームが影響、範囲、想定される原因を確認しています。 |
| Identified | 影響を受けているコンポーネントまたは依存先が特定されました。 |
| Mitigating | 修正、ロールバック、トラフィックの切り替え、または回避策を適用しています。 |
| Monitoring | サービスは復旧したように見え、チームは再発を監視しています。 |
| Resolved | インシデントはクローズされ、顧客への影響はなくなりました。 |
| Postmortem | 事後のまとめ、またはより深い分析を準備中または公開済みです。 |
重大度レベル
| 重大度 | 顧客への影響 | 例 |
|---|---|---|
| P0 | 本番の広範な障害、またはデータ安全上のリスク。 | すべてのクライアントで OAuth のトークン交換が利用できない。公開 API が 5xx を継続的に返す。 |
| P1 | 重要な経路の大幅な低下。 | 多数のアプリで Webhook 配信が遅延している。アプリ審査のキューが止まっている。 |
| P2 | 影響が限定的、または信頼できる回避策がある。 | あるエンドポイント群が遅い。ステータス履歴が古いが、稼働中の API は正常。 |
| P3 | 軽微な不具合、ドキュメントの問題、または個別のサポート案件。 | ドキュメントのリンク誤り。変更履歴の記述が不明確。 |
公開インシデント記録
公開インシデント記録には次を含めるべきです。
- 影響を受けたサービスと、顧客から見える症状。
- 最初に検知した時刻と解決した時刻。
- 進捗通知のタイムライン。
- 緩和策または回避策（ある場合）。
- 最終的な解決のまとめ。
- より詳しい記述が妥当な場合はポストモーテムへのリンク。
インシデント記録には、顧客の個人データ、シークレット、非公開のチケット、内部ログ、マスクされていないリクエストペイロードを含めるべきではありません。
計画メンテナンス
計画メンテナンスには次を記載するべきです。
- タイムゾーン付きの予定開始・終了時刻。
- 影響を受ける可能性のあるサービス。
- API 呼び出し、OAuth フロー、Webhook 配信、アプリ審査が中断される可能性があるかどうか。
- 顧客に必要な対応（ある場合）。
メンテナンスの通知は、期間の前、期間の開始時、および完了時に投稿するべきです。
サポートチケットとインシデントの関係
サポートチケットは、特定の開発者、組織、OAuth クライアント、Webhook 配信、または請求の案件についての非公開のやり取りです。インシデントは、影響がステータスページで伝えるほど広範なときの公開の運用記録です。
チケットが同じ根本的なプラットフォームの問題を報告している場合、そのチケットはインシデントに紐づけられることがあります。チケットは非公開のままで、インシデント記録は公開かつマスクされた状態を保ちます。
インシデントの疑いを報告する
チケットを開く前に、次を行ってください。
/statusを確認します。- 最近の API または挙動の変更がないか 変更履歴 を確認します。
- タイムスタンプ、リクエスト ID、影響を受けているエンドポイント、観測されたエラーコードを添えて、サポートチケットを開くか
[email protected]にメールします。