django-query-profiling

Django クエリのプロファイリング

このスキルを使うと、曖昧な Django の遅さに関する報告を、具体的なクエリセット、SQL 文、再現可能なシナリオに落とし込めます。

ワークフロー

1. ユーザーに見える遅い処理から始めます。

   • URL、API アクション、バックグラウンドタスク、管理コマンド、またはレポートを記録します。
   • リクエストパラメーター、ユーザーまたはテナントの構成、ページネーションの状態、データ量を把握します。

2. 本番環境またはステージング環境の証拠を収集します。

   • 利用できる場合は、APM のトランザクショントレースを優先します。
   • Python の処理とは独立して遅い SQL には、データベースのスロークエリログを使います。
   • ローカル開発環境のサーバー描画ページには、Django Debug Toolbar を使います。
   • API やジョブでは、疑わしい処理ブロックの周辺に対象を絞ったクエリログを追加します。

3. SQL を Django のコードに対応づけます。

   • モデルのテーブル名とカラム名を検索します。
   • ビューの get_queryset()、シリアライザーフィールド、テンプレートのループ、マネージャー、モデルプロパティ、シグナルハンドラーを調べます。
   • 最初のクエリセットが評価された後に、関連オブジェクトへアクセスしていないか確認します。

4. ローカル環境または安全なシェルで再現します。

   • 可能であれば、本番環境に近い行数を使います。
   • 測定時には、無関係な計測機能やデバッグ専用のミドルウェアを無効にします。
   • 遅い処理を実行する、繰り返し使えるスクリプト、テスト、またはシェルスニペットを用意します。

5. 修正方法を振り分けます。

   • クエリ数の問題：django-orm-query-optimization を使います。
   • 1 つの遅い SQL 文：django-query-plan-reading を使います。
   • 大規模なループや書き込み：django-queryset-batch-processing を使います。

具体的なプロファイリング用スニペットと注意点については、tooling-and-reproduction.md を参照してください。

有効な証拠

• 対象の処理におけるクエリ数の修正前と修正後の値。
• 遅い SQL、または正規化された SQL フィンガープリント。
• SQL の発生箇所を説明するスタックまたはコードへの参照。
• 同じ環境で、代表的なデータ構成を使って測定した時間。

検証

推測だけでプロファイリングを終えないでください。名前を特定したクエリセット、コードパス、そして別のエージェントが再実行できるコマンドまたはリクエストを示して完了してください。