integration-django

Django 向け PostHog 統合

このスキルは、Django アプリケーションに PostHog の分析機能を追加するのに役立ちます。

ワークフロー

統合を完了するには、次の手順を順番に実行します。

1. basic-integration-1.0-begin.md - PostHog のセットアップ - 開始 ← ここから始めます
2. basic-integration-1.1-edit.md - PostHog のセットアップ - 編集
3. basic-integration-1.2-revise.md - PostHog のセットアップ - 修正
4. basic-integration-1.3-conclude.md - PostHog のセットアップ - 完了

参照ファイル

• references/EXAMPLE.md - Django のサンプルプロジェクトコード
• references/django.md - Django - ドキュメント
• references/identify-users.md - ユーザーの識別 - ドキュメント
• references/basic-integration-1.0-begin.md - PostHog のセットアップ - 開始
• references/basic-integration-1.1-edit.md - PostHog のセットアップ - 編集
• references/basic-integration-1.2-revise.md - PostHog のセットアップ - 修正
• references/basic-integration-1.3-conclude.md - PostHog のセットアップ - 完了

サンプルプロジェクトは、目標とする実装パターンを示しています。API の詳細については、ドキュメントを参照してください。

重要な原則

• 環境変数：PostHog のキーには必ず環境変数を使用してください。ハードコードしないでください。
• 最小限の変更：既存の統合機能と並行して PostHog のコードを追加してください。既存のコードを置き換えたり、構成し直したりしないでください。
• サンプルに合わせる：実装では、できる限りサンプルプロジェクトのパターンに従ってください。

フレームワークのガイドライン

• PosthogContextMiddleware を MIDDLEWARE に追加してください。トレースヘッダーを自動的に抽出し、例外をキャプチャします。
• 環境変数から api_key と host を取得して、AppConfig.ready() で PostHog を初期化してください。
• new_context()、identify_context(user_id)、続いて capture() を呼び出すコンテキスト API パターンを使用してください。
• ログイン／ログアウトのビューでは、リクエスト中にユーザーの状態が変化するため、新しいコンテキストを作成してください。
• カスタムミドルウェア、distinct_id ヘルパー、条件チェックは作成しないでください。これらは SDK が処理します。
• ソースコードは venv/site-packages ディレクトリにあることを覚えておいてください。
• posthog は Python SDK のパッケージ名です。
• pip install posthog または pip install -r requirements.txt で依存関係をインストールしてください。シェルコマンドで >= のようなバージョン指定子を引用符なしで直接使用しないでください。
• CLI やスクリプトでは、終了前に必ず posthog.shutdown() を呼び出してください。呼び出さないと、すべてのイベントが失われます。
• モジュールレベルの posthog.api_key 設定ではなく、必ず Posthog() クラスコンストラクター（インスタンスベースの API）を使用してください。
• 例外を自動的に追跡するには、必ず Posthog() コンストラクターに enable_exception_autocapture=True を指定してください。
• capture() のイベントプロパティに PII を絶対に含めないでください。メールアドレス、氏名、電話番号、住所、IP アドレス、ユーザーが生成したコンテンツは禁止です。
• PII は identify() の人物プロパティに設定し、capture() のイベントプロパティには設定しないでください。安全なイベントプロパティは、message_length、form_type、真偽値フラグなどのメタデータです。
• 終了時にすべてのイベントがフラッシュされるよう、atexit.register() に posthog_client.shutdown を登録してください。
• Python SDK には identify() メソッドがありません。人物プロパティを設定するには posthog_client.set(distinct_id=user_id, properties={...}) を使用するか、コンテキスト内で identify_context(user_id) を使用してください。

ユーザーの識別

ログインおよびサインアップのイベント中にユーザーを識別してください。このフレームワークで適切な識別パターンを確認するには、サンプルコードとドキュメントを参照してください。フロントエンドとバックエンドの両方のコードがある場合は、相関関係を維持するため、クライアント側のセッション ID と distinct ID を X-POSTHOG-DISTINCT-ID および X-POSTHOG-SESSION-ID ヘッダーで渡してください。

エラー追跡

関連するファイル、特に重要なユーザーフローや API の境界で、PostHog のエラー追跡を追加してください。