mcpField
I
integration-ruby

integration-ruby

github.com/posthogデータ・データベース7690 回インストール今日更新
リポジトリ

integration-ruby について

Ruby アプリに PostHog 分析を導入する開発者向けのスキルです。段階的な手順とサンプルに加え、SDK の初期化、イベント送信、終了前のクライアント停止について案内します。

主な機能

  1. 01段階的な導入手順
  2. 02Ruby のサンプルとドキュメント
  3. 03環境変数によるキー設定
  4. 04SDK 初期化とイベント呼び出しのガイダンス
  5. 05ユーザー識別とエラー追跡のガイダンス

活用シーン

  1. 01Ruby アプリへの PostHog 分析導入
  2. 02スクリプトや CLI から分析イベントを送信
  3. 03ログインや登録時のユーザー識別

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/posthog/skills --skill integration-ruby

インストール後、Claude Code で/integration-rubyを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
basic-integration-1.0-begin.md
basic-integration-1.1-edit.md
basic-integration-1.2-revise.md
basic-integration-1.3-conclude.md
EXAMPLE.md
identify-users.md
ruby.md

詳細

Ruby 向け PostHog インテグレーション

このスキルを使うと、Ruby アプリケーションに 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 - Ruby のサンプルプロジェクトコード
  • references/ruby.md - Ruby - ドキュメント
  • 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 のコードを追加してください。既存のコードを置き換えたり、構成を変更したりしないでください。
  • サンプルに合わせる：できるだけサンプルプロジェクトのパターンに沿って実装してください。

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

  • posthog-ruby は Ruby SDK の gem 名です（Gemfile に gem 'posthog-ruby' を追加します）が、require 'posthog' で読み込んでください（require 'posthog-ruby' ではありません）。
  • スクリプトや CLI でインスタンスベースの初期化を行う場合は、PostHog::Client.new(api_key: key, host: host) を使用してください。
  • CLI やスクリプトでは、終了前に必ず client.shutdown を呼び出してください。呼び出さないと、すべてのイベントが失われます。
  • 適切にクリーンアップするため、ensure ブロック内で shutdown を呼び出す begin/rescue/ensure を使用してください。
  • capture と identify は、1 つのハッシュ引数を受け取ります：client.capture(distinct_id: 'user_123', event: 'my_event', properties: { key: 'value' })
  • capture_exception は位置引数を受け取ります（キーワード引数ではありません）：client.capture_exception(exception, distinct_id, additional_properties) — distinct_id: のキーワード構文は使用しないでください。

ユーザーの識別

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

エラートラッキング

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

コメント

Markdown 対応