メインコンテンツまでスキップ
バージョン: design-archive

運用設計

本システムは、安定稼働、効率的な運用、および迅速な問題解決を可能にするための運用設計を行う。

1. 監視 (Monitoring)​

システムの健全性、パフォーマンス、およびリソース使用状況を継続的に監視する。

  • 監視対象:
    • インフラストラクチャ: CPU使用率、メモリ使用量、ディスクI/O、ネットワークトラフィック(サーバー、データベース、メッセージブローカー)。
    • アプリケーション: HTTPリクエスト数、エラー率、応答時間、LLM API呼び出し回数、Celeryタスクのキューイング状況、タスク実行時間、WebSocket接続数。
    • ビジネスメトリクス: ユーザー登録数、グラフアップロード数、分析実行回数など。
  • 監視ツール: Prometheus + Grafana、またはクラウドプロバイダーのマネージド監視サービス(例: Google Cloud Monitoring)。
  • アラート: 定義された閾値を超過した場合、または異常な挙動が検知された場合に、担当者に自動的に通知(例: Slack, PagerDuty)する。

2. ログ管理 (Logging)​

システム内で発生するイベント、エラー、警告などを適切にログに記録し、一元的に管理する。

  • ログレベル: DEBUG, INFO, WARNING, ERROR, CRITICALなどのログレベルを適切に使い分ける。
  • ログフォーマット: 構造化ログ(JSON形式)を採用し、検索・分析を容易にする。
  • ログ収集: 各コンポーネントから出力されるログを集中ログ管理システム(例: Google Cloud Logging, ELK Stack)に集約する。
  • ログ保持期間: 法的要件および運用要件に基づき、ログの保持期間を定める。
  • 機密情報のマスキング: ログに個人情報や機密情報(パスワード、APIキーなど)が含まれないよう、マスキングまたは記録しない対策を講じる。

3. バックアップとリカバリ (Backup & Recovery)​

データの損失を防ぎ、障害発生時にシステムを迅速に復旧させるためのバックアップおよびリカバリ戦略を策定する。

  • バックアップ対象:
    • PostgreSQL: データベースのフルバックアップおよび増分バックアップ。
    • Neo4j: グラフデータのバックアップ。
    • Redis: RDBスナップショットまたはAOF(Append Only File)による永続化設定。
  • バックアップ頻度: データの重要性および更新頻度に基づき、適切なバックアップ頻度を定める。
  • バックアップ保存場所: 異なるリージョンやストレージサービスにバックアップを保存し、災害対策を行う。
  • リカバリ手順: 障害発生時のリカバリ手順を明確に文書化し、定期的にテストを実施する。

4. デプロイメント (Deployment)​

システムのデプロイメントは、ユーザーの要望に基づき、Dockerコンテナとしてパッケージ化し、APIキー設定のみでデプロイ可能な状態を目指す。

  • デプロイメントツール: Docker Compose、またはシンプルなコンテナオーケストレーションツール(例: Portainer)を想定。
  • 環境変数: APIキーやデータベース接続情報などの設定は、環境変数を通じて行う。
  • ロールバック: デプロイメントに問題が発生した場合に、迅速に以前の安定バージョンに戻せるメカニズムを確保する。

5. 障害対応 (Incident Management)​

障害発生時の対応プロセスを定義し、影響を最小限に抑え、迅速な復旧を目指す。

  • 障害検知: 監視システムからのアラートにより障害を検知する。
  • 初動対応: 障害発生時の連絡体制、担当者の特定、影響範囲の特定。
  • 原因究明: ログ、監視データ、デバッグツールを用いて原因を特定する。
  • 復旧作業: 定義されたリカバリ手順に基づき、システムを復旧させる。
  • 事後分析: 障害の原因、対応、再発防止策を分析し、ドキュメント化する。