本番運用のベストプラクティス
本番運用
ベストプラクティス
監視
デプロイ
この記事の対象
レシートローラー連携アプリを本番で安定運用したいチーム向けの実践指針です。
レシートローラー連携アプリを本番で安定運用したいチーム向けの実践指針です。
環境を3つ分ける
| 環境 | 用途 | RRアプリ |
|---|---|---|
| 本番 | 実顧客・実店舗 | 本番アプリ |
| ステージング | 本番リリース前検証 | ステージング用アプリ |
| 開発 | 日常開発・テスト | 開発用アプリ(個人別もアリ) |
シークレット・データベース・URLすべて分離します。
監視(最低限)
- API呼び出しの成功率:99%以下で警告
- レート制限ヒット率:1%以上で警告
- Webhook受信成功率:99%以下で警告
- トークン更新失敗:即時通知
- 署名検証失敗:継続的に発生したら警告
- 処理キューの滞留:閾値を超えたら警告
デプロイ
- CIで自動テスト:型チェック、ユニット、API契約テスト
- カナリア:新バージョンを一部トラフィックに先行投入
- ロールバック計画:1コマンドで前バージョンに戻せる
- マイグレーション戦略:DBスキーマ変更は2段階(追加→削除)でリリース
- 機能フラグ:新機能はOFFでデプロイ、本番でONに切り替え
レシートローラー側のバージョン追従
- 「お知らせ」を購読しておく
Sunset/Deprecationヘッダーをログに出して通知- 非推奨API使用を月次レビューで棚卸し
- 新APIバージョンが出たら、ステージングで先行検証
障害対応の基本構造
- 検知:監視アラートが鳴る
- 初動:オンコール担当が15分以内に着手
- 影響範囲特定:誰の何が止まっているか
- 暫定対応:ロールバック・機能停止・手動対応
- 連絡:影響を受ける店舗・ユーザーへ通知
- 恒久対応:根本原因を直す
- 振り返り:ポストモーテム(責任追及ではなく改善)
ドキュメントを保つ
- Runbook:よくある障害の対応手順
- アーキテクチャ図:レシートローラーとの接続点
- 連絡先:レシートローラーサポート窓口、内部チームの連絡先
- 環境変数一覧:何の値か・どこから取るか
- 復旧手順:DB復元、デプロイロールバック、シークレット再生成
テストアカウント・テストデータ
- 本番アクセスを伴うE2Eテストには、専用のテスト店舗・テストユーザーを使う
- テスト用クレジットカード番号・テスト用メアドを定数化
- 本番データを使ったテストは原則禁止(個人情報の取り扱いリスク)
関連ガイド
公開日: 2026-04-27
更新日: 2026-04-27
カテゴリ
タグ
API (8)
Webhook (8)
api (6)
oauth (5)
トラブル (5)
OAuth (4)
getting-started (4)
アプリ登録 (4)
app-registration (3)
webhook (3)