Ruby error tracking installation

Install the gem

Required

Add the PostHog Ruby gem to your Gemfile:

Gemfile

gem "posthog-ruby"

Configure PostHog

Required

Initialize the PostHog client with your API key and host:

Ruby
require 'posthog'

posthog = PostHog::Client.new({
    api_key: "<ph_project_token>",
    host: "https://us.i.posthog.com",
    on_error: Proc.new { |status, msg| print msg }
})

Send events

Recommended

Once installed, you can manually send events to test your integration:

Ruby
posthog.capture({
    distinct_id: 'user_123',
    event: 'button_clicked',
    properties: {
        button_name: 'signup'
    }
})

Manually capture exceptions

Required

Using Ruby on Rails? The posthog-rails gem provides automatic exception capture for controllers and background jobs. Select "Ruby on Rails" from the SDK list for setup instructions.

To capture exceptions in your Ruby application, use the capture_exception method:

Ruby
begin
  # Code that might raise an exception
  raise StandardError, "Something went wrong"
rescue => e
  posthog.capture_exception(
    e,
    distinct_id: 'user_distinct_id',
    properties: {
      custom_property: 'custom_value'
    }
  )
end

The capture_exception method accepts the following parameters:

Param	Type	Description
`exception`	`Exception`	The exception object to capture (required)
`distinct_id`	`String`	The distinct ID of the user (optional)
`properties`	`Hash`	Additional properties to attach to the exception event (optional)

Verify error tracking
Recommended
Confirm events are being sent to PostHog
Before proceeding, let's make sure exception events are being captured and sent to PostHog. You should see events appear in the activity feed.
Check for exceptions in PostHog

Ruby error tracking installation

Install the gem

Configure PostHog

Send events

Manually capture exceptions

Verify error tracking

Community questions

Was this page useful?