Add posthog-rails gem for automatic Rails exception tracking #81
Conversation
popcorn
force-pushed
the
popcorn/add-rails-activejob-automatic-error-tracking
branch
from
2967d45 to
1dfe144
Compare
| def extract_distinct_id_from_job | ||
| # Try to find a user ID in job arguments | ||
| arguments.each do |arg| | ||
| if arg.respond_to?(:id) | ||
| return arg.id | ||
| elsif arg.is_a?(Hash) && arg['user_id'] | ||
| return arg['user_id'] | ||
| elsif arg.is_a?(Hash) && arg[:user_id] | ||
| return arg[:user_id] | ||
| end | ||
| end | ||
|
|
||
| nil # No user context found | ||
| end |
There was a problem hiding this comment.
I am not super-happy with this. Will probably change it to use a proc-based / dynamic configuration.
So you'll be able to define distinct ID in the job itself like this:
class MyJob < ApplicationJob
posthog_distinct_id ->(user, arg1, arg2) { user.id }
def perform(user, arg1, arg2)
# ...
end
end
popcorn
force-pushed
the
popcorn/add-rails-activejob-automatic-error-tracking
branch
from
1dfe144 to
b4d5947
Compare
This commit introduces the posthog-rails gem which provides automatic exception tracking for Rails applications, including: - Automatic capture of unhandled exceptions via Rails middleware - Automatic capture of rescued exceptions (configurable) - Automatic instrumentation of ActiveJob failures - Integration with Rails 7.0+ error reporter - Configurable exception exclusion list - User context capture from controllers Core library improvements: - Added comprehensive logging throughout exception capture flow - Added ExceptionCapture module for standardized exception parsing - Fixed field handling in Transport to strip internal-only fields (type, library, library_version, messageId) that are not part of PostHog's RawEvent struct - Fixed UUID field handling to avoid sending null values - Added capture_exception method to Client for explicit exception tracking The posthog-rails gem includes: - Railtie for automatic initialization and middleware insertion - Multiple middleware layers for capturing different exception types - ErrorSubscriber for Rails 7.0+ error reporter integration - ActiveJob extensions for job failure tracking - Comprehensive configuration options
popcorn
force-pushed
the
popcorn/add-rails-activejob-automatic-error-tracking
branch
from
b4d5947 to
e2e4e6d
Compare
|
Hey @rafaeelaudibert, I saw you closing another PR for automating Rails error tracking because it was too big and included many integrations at once. This one hooks into Rails middleware and ActiveJob, and also lets you integrate with error reporter if you're on Rails >7.0. Can you take a look? |
|
cc @dmarticus @daibhin @mariusandra I cannot add any reviewers for this PR, so I'm tagging you. Please let me know if you're ok with this approach to implementing Rails SDK. |
|
@daibhin, it seems @hpouillot triggered a few CI actions that are failing. I'll sort it out tomorrow or during the weekend. In the meantime, let me know if you agree with the general approach. |
rafaeelaudibert
left a comment
rafaeelaudibert
left a comment
There was a problem hiding this comment.
This looks very very good! Sorry for taking this long to review, but here it is!
I've left a handful of comments on things I'd like to see changed/improved. This is already 95% of the way there!
| # Your PostHog project API key (required) | ||
| # Get this from: PostHog Project Settings > API Keys |
There was a problem hiding this comment.
Url here would be nice!
https://app.posthog.com/settings/project-details#variables
| # ============================================================================ | ||
|
|
||
| # For PostHog Cloud, use: https://us.i.posthog.com or https://eu.i.posthog.com | ||
| config.host = ENV.fetch('POSTHOG_HOST', 'https://app.posthog.com') |
There was a problem hiding this comment.
We always use us.i.posthog.com as a default
| config.host = ENV.fetch('POSTHOG_HOST', 'https://app.posthog.com') | |
| config.host = ENV.fetch('POSTHOG_HOST', 'https://us.i.posthog.com') |
| config.host = ENV.fetch('POSTHOG_HOST', 'https://app.posthog.com') | ||
|
|
||
| # Personal API key (optional, but required for local feature flag evaluation) | ||
| # Get this from: PostHog Settings > Personal API Keys |
There was a problem hiding this comment.
Url here would be nice
https://app.posthog.com/settings/user-api-keys
| config.on_error = proc { |status, message| | ||
| Rails.logger.error("[PostHog] Error #{status}: #{message}") | ||
| } |
There was a problem hiding this comment.
Should probably be commented out by default
|
|
||
| # Controller method name to get current user (default: :current_user) | ||
| # Change this if your app uses a different method name | ||
| config.current_user_method = :current_user |
There was a problem hiding this comment.
Expanding on the docs on why enabling this is a good idea would be nice!
| require 'posthog' | ||
|
|
||
| # Load Rails integration | ||
| require 'posthog/rails' if defined?(Rails) |
There was a problem hiding this comment.
Should probably abort loading if Rails is not defined, right? People shouldn't use this without Rails
There was a problem hiding this comment.
This is very LLM-y. Do we need this here?
| # Exceptions are automatically captured with job context | ||
| end | ||
| end | ||
| ``` |
There was a problem hiding this comment.
Add a comment here explaining we don't support other job runners yet, and they're coming in the future. Also add a note saying we accept contributions - like yours!
| # Code that might raise an error | ||
| end | ||
|
|
||
| Rails.error.record(exception, context: { user_id: current_user.id }) |
There was a problem hiding this comment.
Make it clear we'll detect the user id from both user_id and distinct_id inside the context.
There was a problem hiding this comment.
We'd benefit from a section here explaining how we detect distinct_id in the different runtimes (Autorescue, Rails rescueing, Rails error reporter, Active Job)
|
Hey @popcorn pinging you just in case you're still interested in getting this merged :) |
|
I'd certainly be interested in getting it merged for my own selfish reasons 😅 |
3 participants
What is this?
This PR introduces the
posthog-railsgem which provides automatic exception tracking for Rails applications, inspired by Sentry's gem.Features:
Please read
posthog-ruby/posthog-rails/IMPLEMENTATION.mdto learn more.How to test this?
Put both gems in your Rails app's
Gemfile, and then reference them via path on your local machine:PS