Error Tracking Ruby On Rails
PostHogOfficialCreated by PostHog
- Skill
- Tool integration
- Data and AI
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides the necessary configuration patterns and best practices for integrating PostHog error tracking into Ruby on Rails applications. It covers the setup of the posthog-rails gem, initialization procedures, and strategies for capturing both unhandled exceptions and background job failures. The guide emphasizes maintaining existing error handling structures while leveraging PostHog's automated instrumentation and manual capture capabilities to improve observability.
What it does
- Configures the posthog-rails gem for automatic exception capture in Rails controllers.
- Enables instrumentation for ActiveJob to track background job failures.
- Provides patterns for manual error capture at specific boundaries using captureException.
- Supports user association by mapping Rails models to PostHog distinct IDs.
- Outlines best practices for environment variable management and client lifecycle handling.
- Explains how to integrate frontend tracking alongside backend Ruby instrumentation.
When to use it
- When you need to monitor and track runtime exceptions in a Ruby on Rails application.
- When you want to gain visibility into background job failures within ActiveJob.
- When you need to associate backend errors with specific user identities.
- When you are setting up a new Rails project and want to implement robust error observability.
Advantages
- Seamless integration with existing Rails error handling patterns.
- Automated capture of unhandled exceptions and background job metadata.
- Centralized error reporting alongside other product analytics data.
- Clear guidelines on avoiding common pitfalls like manual client instantiation.
Usage examples
- “How do I set up PostHog error tracking in my Rails initializer?”
- The skill instructs you to use the posthog-rails gem, run the install generator, and configure auto_capture_exceptions and auto_instrument_active_job within config/initializers/posthog.rb.
- “How can I manually capture an error in a rescue block?”
- Use the PostHog.capture_exception(exception, distinct_id, additional_properties) method, ensuring you use positional arguments rather than keyword arguments.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/posthog/error-tracking-ruby-on-rails/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip error-tracking-ruby-on-rails.zip -d .agents/skills
Documentation by PostHog
PostHog error tracking for Ruby on Rails
This skill helps you add PostHog error tracking to Ruby on Rails applications.
Reference files
references/ruby-on-rails.md- Ruby on rails error tracking installation - docsreferences/fingerprints.md- Fingerprints - docsreferences/alerts.md- Send error tracking alerts - docsreferences/monitoring.md- Monitor and search issues - docsreferences/assigning-issues.md- Assign issues to teammates - docsreferences/upload-source-maps.md- Upload source maps - docs
Consult the documentation for API details and framework-specific patterns.
Key principles
Environment variables: Always use environment variables for PostHog keys and host URLs. Never hardcode them.
Minimal changes: Add error tracking alongside existing error handling. Don't replace or restructure existing error handling code.
Autocapture first: Enable exception autocapture in the SDK initialization before adding manual captures.
Source maps: Upload source maps so stack traces resolve to original source code, not minified bundles.
Manual capture for boundaries: Use
captureException()at error boundaries and catch blocks for errors that don't propagate to the global handler.
Framework guidelines
Use posthog-rails gem alongside posthog-ruby for automatic exception capture and ActiveJob instrumentation
Run
rails generate posthog:installto create the initializer, or manually create config/initializers/posthog.rbConfigure auto_capture_exceptions: true to automatically track unhandled exceptions in controllers
Configure report_rescued_exceptions: true to also capture exceptions that Rails rescues (e.g. with rescue_from)
Configure auto_instrument_active_job: true to track background job failures with job class, queue, and arguments
Use PostHog.capture() and PostHog.identify() class-level methods (NOT instance methods) — the posthog-rails gem manages the client lifecycle via PostHog.init
Do NOT manually create PostHog::Client instances in Rails — use PostHog.init in the initializer and PostHog.capture/identify everywhere else
capture_exception takes POSITIONAL args: PostHog.capture_exception(exception, distinct_id, additional_properties) — do NOT use keyword args
Define posthog_distinct_id on the User model for automatic user association in error reports — posthog-rails auto-detects by trying: posthog_distinct_id, distinct_id, id, pk, uuid (in order)
For ActiveJob user association, use the class-level DSL
posthog_distinct_id ->(user) { user.email }or pass user_id: in a hash argumentStore API key in Rails credentials or environment variables, never hardcode
For frontend tracking alongside posthog-rails, add the posthog-js snippet to the layout template — posthog-js handles pageviews, session replay, and client-side errors while posthog-ruby handles backend events, server errors, feature flags, and background jobs
posthog-ruby is the Ruby SDK gem name (add
gem 'posthog-ruby'to Gemfile) but require it withrequire 'posthog'(NOTrequire '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
Files
- ATTRIBUTION.mdAdded by AutoGineer984 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md3.8 KiB
- references/alerts.md4.1 KiB
- references/assigning-issues.md5.5 KiB
- references/fingerprints.md3.4 KiB
- references/monitoring.md8.6 KiB
- references/ruby-on-rails.md3.5 KiB
- references/upload-source-maps.md2.7 KiB
references/monitoring.md
Monitor and search issues - Docs
This guide covers how to find the most relevant, urgent, and impactful issues in your error tracking using the issues page.
Monitoring issues
When you're monitoring issues in your project, there are generally two common workflows:
You're exploring issues to identify impactful and problematic areas. You should use sorting features.
You're looking for issues assigned to you to resolve them. You should filter by the
Assigned toproperty.
Sorting issues
Issues can be sorted by the following properties:
| Property | Description |
|---|---|
| Last seen | The issue that has the most recent exception |
| First seen | The issue that has the oldest exception |
| Occurrences | The number of exceptions in the issue |
| Users | The number of unique users affected by the issue |
| Sessions | The number of unique sessions affected by the issue |
Sorting by last seen and occurrences are great ways to get a general sense of issues in your project. Sorting by users and sessions is great to find the most impactful issues if you're using other filters to narrow down your results.
Monitoring issues assigned to you
You can filter issues by the Assigned to property to find issues assigned to you. This is especially useful if you configure automatic issue assignment and configure alerts to notify you when new issues are created.
Finding specific issues
You can use the search bar at the top of the issue page to filter issues based on the properties of the exceptions in that issue.
Search results are matched based on properties of exception events grouped into the issues. For example, if you search for "TypeError", we show you all issues where any exception grouped into the issue has a type of "TypeError".
Unrelated results
You may see seemingly unrelated issues in your search results because your search term matches an exception in the issue group. For example, you may see an issues named RefreshError when searching "schema", because a get_schema method appears on the exception stack traces.
Filtering modes
The search bar provides two modes of filtering:
1. Exact property filtering
This operates like property filters elsewhere in PostHog, enabling you to add terms like where 'http_referer' is set or where 'library' equals 'web'. You add a property filter by clicking the property name shown here:
Image: Adding a property to the property filterImage: Adding a property to the property filter
Added property filters look like this:
Image: Search bar with property filterImage: Search bar with property filter
The results of both of these filter types (property filters and freeform search) are combined with AND logic, such that only exceptions that match all filters are included in the search results.
2. Freeform text search
This does text matching for a subset of the error tracking specific properties of the exception event. It splits the text you give it into tokens. The search matches an exception if each of the tokens in your search term appear in one of the following:
The exception type
The exception message
The function names in the exception stack trace (if known)
The file paths in the exception stack trace (if known)
For example, imagine you have an exception that looks like this:
PostHog AI
TypeError: Cannot read property 'name' of undefined
at Object.<anonymous> (/path/to/myfile.js:123:45)
at Module._compile (module.js:653:30)
at Object.Module._extensions..js (module.js:664:10)
at Module.load (module.js:566:32)
at tryModuleLoad (module.js:506:12)
at Function.Module._load (module.js:498:3)
at Function.Module.runMain (module.js:694:10)
at startup (bootstrap_node.js:204:16)
at bootstrap_node.js:625:3If you search for the term TypeError myfile.js, the exception matches this search, as it contains TypeError (as the exception type) and myfile.js (as a file path in the stack trace).
If you search for TypeError myfile.js abc, the exception would not match, as the token abc does not appear anywhere in freeform search properties.
If you want to search for longer exact strings, e.g. a particular exception message, you can group tokens into a single term using quotes, e.g. "Cannot read property 'name' of undefined" myfile.js would match, and "Cannot read property of myfile.js" would not.
Note, perhaps unintuitively, Cannot read property of myfile.js would match, because the tokens are ungrouped, and all of them appear somewhere in the exception search properties.
Searching chained exceptions
Exception events can have more than one exception in them, due to language features like exception chaining. For freeform search, we put the types, messages, functions and file paths of all exceptions into one list, and match if the token appears in any of them.
For example, if you had a chained exception with the messages MyCustomError: Failed to load user and Cannot read property 'age' of undefined, searching for cannot read property would match the exception, because it matches one of the exception messages (property appears in the "root" one).
Issue details
When you click on an issue, you'll see the details page of the issue.
This page shows you the following:
The stack trace, properties, and sessions related to the currently selected exception.
Name, description, status, assignee, and external tracking links for the issue.
A filterable list of all exceptions in the issue. Selecting an exception will show you the stack trace, properties, and sessions related to that exception at the top of the page.
Image: An issue, with an unfiltered exception listImage: An issue, with an unfiltered exception list
Filtering exception occurrences within an issue
Once you've found and opened the issue you want to investigate, you can use the same search interface to filter the exception list for a particular instance of the issue. This is particularly useful in cases where some exceptions in the issue have information others don't and you want to use that information for debugging.
For example, you can add a property filter on http_referer that shows all exceptions where the http_referer is set:
Image: An issue, with a filtered exception listImage: An issue, with a filtered exception list
Alerts
If you have a set of filters that you use often, you can create alerts for them. This way you can be notified when new issues match your filters. Learn more about alerts.
Improving search performance
We try to return results to you within a second, but sometimes if you're querying over large amounts of data, it may take longer. The following can improve the search performance:
Limit the time range you're searching over: 7 days is usually enough to get a sense for the trends of an issue over time.
Use freeform search rather than property filters: Our freeform searches are generally faster than property filters, as the total amount of data processed is smaller.
If you find your queries timing out or taking more than 30 seconds, please let us know in-app! We're always looking for benchmarks to improve against.
Suppressing issues
If you find issues that are not useful to you, you can suppress them by changing the status to Suppressed. We recommend that you also implement client-side suppression to not capture these exceptions in the first place, for cost and performance reasons.
Community questions
Ask a question
Was this page useful?
HelpfulCould be better
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/error-tracking/skills/ruby-on-rails · 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 error-tracking-ruby-on-rails.zip