posthog-rails 3.5.3 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7a93ce29b1528ad68c2b03e82400e3b986c6bf78fab3f3dfed6e54079d271a
-  data.tar.gz: 1c818a7ce001ab48a469a294a0f0dad6643e4e1a14975423b3a57cfe0fa9b240
+  metadata.gz: 32c8090638dc6456a2cfe2abdfe0dec901ee549b44f3d52f8c1728019a931d57
+  data.tar.gz: 2371da2d51b6977fd8a2544270fae72c8c6e5e9465783ca9fd32bf118b85ae8c
 SHA512:
-  metadata.gz: 30bbf87a63ef62bce4c0146ba49209d53bdbf3774cb45da43fcbc0ca3c20ed416f182fc811c4446300a370a39a37afb68066384c162a66c99149b4cb3112c9a7
-  data.tar.gz: 3ec3f4b8daa595bc1c22a8d043d6815d6ec9a7d0c6daa64f789aea16cc1403397a5ffd4eddd36dbdef10fa84f9e827e27997652e2eae08f2d941e1460823e399
+  metadata.gz: 2cf658e5f2ebce148a07e221b3458925b22affb61196f1771691e0988e161a2024c29dcc021cf30c30e62f13ab71e01b5f8c2a10faeb02996f5ace063360dae2
+  data.tar.gz: '0338af574847d6c9f52e1c3f43b7f7b7401ee9966a1d0816d3b1a5967b3a4689d584e1801cfa50101e0106f4692239eb0ac2a9be5e7f7533099bca7266730705'

data/lib/generators/posthog/install_generator.rb

@@ -7,10 +7,10 @@ module Posthog
     class InstallGenerator < ::Rails::Generators::Base
       desc 'Creates a PostHog initializer file at config/initializers/posthog.rb'
 
-      source_root File.expand_path('../../..', __dir__)
+      source_root File.expand_path('templates', __dir__)
 
       def copy_initializer
-        copy_file 'examples/posthog.rb', 'config/initializers/posthog.rb'
+        copy_file 'posthog.rb', 'config/initializers/posthog.rb'
       end
 
       def show_readme

data/lib/generators/posthog/templates/posthog.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# PostHog Rails Initializer
+# Place this file in config/initializers/posthog.rb
+
+# ============================================================================
+# RAILS-SPECIFIC CONFIGURATION
+# ============================================================================
+# Configure Rails-specific options via PostHog::Rails.configure
+# These settings control how PostHog integrates with Rails features.
+
+PostHog::Rails.configure do |config|
+  # Automatically capture exceptions (default: false)
+  # Set to true to enable automatic exception tracking
+  # config.auto_capture_exceptions = true
+
+  # Report exceptions that Rails rescues (e.g., with rescue_from) (default: false)
+  # Set to true to capture rescued exceptions
+  # config.report_rescued_exceptions = true
+
+  # Automatically instrument ActiveJob background jobs (default: false)
+  # Set to true to enable automatic ActiveJob exception tracking
+  # config.auto_instrument_active_job = true
+
+  # Capture user context with exceptions (default: true)
+  # config.capture_user_context = true
+
+  # Controller method name to get current user (default: :current_user)
+  # Change this if your app uses a different method name (e.g., :authenticated_user)
+  # When configured, exceptions will include user context (distinct_id, email, name),
+  # making it easier to identify affected users and debug user-specific issues.
+  # config.current_user_method = :current_user
+
+  # Additional exception classes to exclude from reporting
+  # These are added to the default excluded exceptions
+  # config.excluded_exceptions = [
+  #   # 'MyCustom404Error',
+  #   # 'MyCustomValidationError'
+  # ]
+end
+
+# You can also configure Rails options directly:
+# PostHog::Rails.config.auto_capture_exceptions = true
+
+# ============================================================================
+# CORE POSTHOG CONFIGURATION
+# ============================================================================
+# Initialize the PostHog client with core SDK options.
+# IMPORTANT: Use PostHog.init once — creating multiple clients can cause dropped events.
+# PostHog.init provides a singleton-like pattern; use PostHog.capture, PostHog.identify, etc.
+
+PostHog.init do |config|
+  # ============================================================================
+  # REQUIRED CONFIGURATION
+  # ============================================================================
+
+  # Your PostHog project API key (required)
+  # Get this from: PostHog Project Settings > API Keys
+  # https://app.posthog.com/settings/project-details#variables
+  config.api_key = ENV.fetch('POSTHOG_API_KEY', nil)
+
+  # ============================================================================
+  # OPTIONAL CONFIGURATION
+  # ============================================================================
+
+  # For PostHog Cloud, use: https://us.i.posthog.com or https://eu.i.posthog.com
+  config.host = ENV.fetch('POSTHOG_HOST', 'https://us.i.posthog.com')
+
+  # Personal API key (optional, but required for local feature flag evaluation)
+  # Get this from: PostHog Settings > Personal API Keys
+  # https://app.posthog.com/settings/user-api-keys
+  config.personal_api_key = ENV.fetch('POSTHOG_PERSONAL_API_KEY', nil)
+
+  # Maximum number of events to queue before dropping (default: 10000)
+  config.max_queue_size = 10_000
+
+  # Feature flags polling interval in seconds (default: 30)
+  config.feature_flags_polling_interval = 30
+
+  # Feature flag request timeout in seconds (default: 3)
+  config.feature_flag_request_timeout_seconds = 3
+
+  # Error callback - called when PostHog encounters an error
+  # config.on_error = proc { |status, message|
+  #   Rails.logger.error("[PostHog] Error #{status}: #{message}")
+  # }
+
+  # Before send callback - modify or filter events before sending
+  # Return nil to prevent the event from being sent
+  # config.before_send = proc { |event|
+  #   # Filter out test users
+  #   return nil if event[:properties]&.dig('$user_email')&.end_with?('@test.com')
+  #
+  #   # Add custom properties to all events
+  #   event[:properties] ||= {}
+  #   event[:properties]['environment'] = Rails.env
+  #
+  #   event
+  # }
+
+  # ============================================================================
+  # ENVIRONMENT-SPECIFIC CONFIGURATION
+  # ============================================================================
+
+  # Disable in test environment
+  config.test_mode = true if Rails.env.test?
+
+  # Optional: Disable in development
+  # config.test_mode = true if Rails.env.test? || Rails.env.development?
+end
+
+# ============================================================================
+# DEFAULT EXCLUDED EXCEPTIONS
+# ============================================================================
+# The following exceptions are excluded by default:
+#
+# - AbstractController::ActionNotFound
+# - ActionController::BadRequest
+# - ActionController::InvalidAuthenticityToken
+# - ActionController::InvalidCrossOriginRequest
+# - ActionController::MethodNotAllowed
+# - ActionController::NotImplemented
+# - ActionController::ParameterMissing
+# - ActionController::RoutingError
+# - ActionController::UnknownFormat
+# - ActionController::UnknownHttpMethod
+# - ActionDispatch::Http::Parameters::ParseError
+# - ActiveRecord::RecordNotFound
+# - ActiveRecord::RecordNotUnique
+#
+# These can be re-enabled by removing them from the exclusion list if needed.

data/lib/posthog/rails/railtie.rb

@@ -160,6 +160,10 @@ module PostHog
         @base_options[:test_mode] = value
       end
 
+      def sync_mode=(value)
+        @base_options[:sync_mode] = value
+      end
+
       def on_error=(value)
         @base_options[:on_error] = value
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posthog-rails
 version: !ruby/object:Gem::Version
-  version: 3.5.3
+  version: 3.6.0
 platform: ruby
 authors:
 - PostHog
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 description: Automatic exception tracking and instrumentation for Ruby on Rails applications
   using PostHog
 email: hey@posthog.com
@@ -45,6 +45,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/generators/posthog/install_generator.rb
+- lib/generators/posthog/templates/posthog.rb
 - lib/posthog-rails.rb
 - lib/posthog/rails.rb
 - lib/posthog/rails/active_job.rb
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: PostHog integration for Rails
 test_files: []