AutoGineer
Generated banner for Integration Ruby
Generated logo for Integration Ruby

Integration Ruby

PostHogOfficialCreated by PostHog

  • Skill
  • Tool integration
  • Data and AI
  • MIT
  • No issues found
Download ZIP

From the author

PostHog integration for any Ruby application using the Ruby SDK
— the description by PostHog

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured workflow for integrating PostHog analytics into Ruby applications. It covers the full lifecycle of implementation, from initial setup and event planning to code modification and error tracking. The skill emphasizes best practices such as using environment variables for configuration, implementing instance-based client initialization, and ensuring proper resource cleanup using Ruby's ensure blocks to prevent event loss.

What it does

  • Guides the setup of the posthog-ruby gem within a Ruby project.
  • Provides a step-by-step workflow for planning and implementing event tracking.
  • Demonstrates how to identify users during authentication flows.
  • Includes patterns for capturing exceptions and tracking critical business events.
  • Ensures robust resource management by requiring client shutdown in ensure blocks.
  • Provides reference examples for CLI and script-based Ruby applications.

When to use it

  • When you need to add product analytics to a Ruby-based application.
  • When implementing server-side event tracking for critical business operations.
  • When you need to track user actions or errors in non-web Ruby scripts or CLIs.
  • When you want to follow standardized patterns for PostHog integration in Ruby.

Advantages

  • Promotes consistent event tracking patterns across the codebase.
  • Reduces the risk of data loss by enforcing proper client shutdown procedures.
  • Prevents hardcoding of sensitive API keys through environment variable usage.
  • Provides clear separation between event tracking and core application logic.

Usage examples

“How do I initialize the PostHog client in my Ruby script?”
The agent will provide the PostHog::Client.new initialization pattern, including the use of environment variables for the API key and host, and the requirement to call client.shutdown.
“What is the correct way to track a user action in Ruby?”
The agent will demonstrate the use of the client.capture method, specifying the required distinct_id, event name, and properties hash.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/posthog/integration-ruby/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip integration-ruby.zip -d .agents/skills

Documentation by PostHog

PostHog integration for Ruby

This skill helps you add PostHog analytics to Ruby applications.

Workflow

Follow these steps in order to complete the integration:

  1. basic-integration-1.0-begin.md - PostHog Setup - Begin ← Start here

  2. basic-integration-1.1-edit.md - PostHog Setup - Edit

  3. basic-integration-1.2-revise.md - PostHog Setup - Revise

  4. basic-integration-1.3-conclude.md - PostHog Setup - Conclusion

Reference files

  • references/EXAMPLE.md - Ruby example project code

  • references/ruby.md - Ruby - docs

  • references/identify-users.md - Identify users - docs

  • references/basic-integration-1.0-begin.md - PostHog setup - begin

  • references/basic-integration-1.1-edit.md - PostHog setup - edit

  • references/basic-integration-1.2-revise.md - PostHog setup - revise

  • references/basic-integration-1.3-conclude.md - PostHog setup - conclusion

The example project shows the target implementation pattern. Consult the documentation for API details.

Key principles

  • Environment variables: Always use environment variables for PostHog keys. Never hardcode them.

  • Minimal changes: Add PostHog code alongside existing integrations. Don't replace or restructure existing code.

  • Match the example: Your implementation should follow the example project's patterns as closely as possible.

Framework guidelines

  • posthog-ruby is the Ruby SDK gem name (add gem 'posthog-ruby' to Gemfile) but require it with require 'posthog' (NOT require 'posthog-ruby')

  • Use PostHog::Client.new(api_key: key, host: host) for instance-based initialization in scripts and CLIs

  • In CLIs and scripts: MUST call client.shutdown before exit or all events are lost

  • Use begin/rescue/ensure with shutdown in the ensure block for proper cleanup

  • capture and identify take a single hash argument: client.capture(distinct_id: 'user_123', event: 'my_event', properties: { key: 'value' })

  • capture_exception takes POSITIONAL args (not keyword): client.capture_exception(exception, distinct_id, additional_properties) — do NOT use distinct_id: keyword syntax

Identifying users

Identify users during login and signup events. Refer to the example code and documentation for the correct identify pattern for this framework. If both frontend and backend code exist, pass the client-side session and distinct ID using X-POSTHOG-DISTINCT-ID and X-POSTHOG-SESSION-ID headers to maintain correlation.

Error tracking

Add PostHog error tracking to relevant files, particularly around critical user flows and API boundaries.

Files

references/basic-integration-1.0-begin.md

title: PostHog Setup - Begin description: Start the event tracking setup process by analyzing the project and creating an event tracking plan

We're making an event tracking plan for this project.

Before proceeding, find any existing posthog.capture() code. Make note of event name formatting.

From the project's file list, select between 10 and 15 files that might have interesting business value for event tracking, especially conversion and churn events. Also look for additional files related to login that could be used for identifying users, along with error handling. Read the files. If a file is already well-covered by PostHog events, replace it with another option. Do not spawn subagents.

Look for opportunities to track client-side events.

IMPORTANT: Server-side events are REQUIRED if the project includes any instrumentable server-side code. If the project has API routes (e.g., app/api/**/route.ts) or Server Actions, you MUST include server-side events for critical business operations like:

  • Payment/checkout completion

  • Webhook handlers

  • Authentication endpoints

Do not skip server-side events - they capture actions that cannot be tracked client-side.

Create a new file with a JSON array at the root of the project: .posthog-events.json. It should include one object for each event we want to add: event name, event description, and the file path we want to place the event in. If events already exist, don't duplicate them; supplement them.

Track actions only, not pageviews. These can be captured automatically. Exceptions can be made for "viewed"-type events that correspond to the top of a conversion funnel.

As you review files, make an internal note of opportunities to identify users and catch errors. We'll need them for the next step.

Status

Before beginning a phase of the setup, you will send a status message with the exact prefix '[STATUS]', as in:

[STATUS] Checking project structure.

Status to report in this phase:

  • Checking project structure

  • Verifying PostHog dependencies

  • Generating events based on project

Upon completion, continue with: basic-integration-1.1-edit.md

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs an API key

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
PostHog
Publisher
PostHog (Official)
Source
PostHog/skills · skills/posthog/integration/skills/ruby · commit a5d30e7
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Also distributed in
PostHog/skills

AutoGineer is not affiliated with or endorsed by PostHog.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download integration-ruby.zip