posthog-ruby 3.24.0 → 3.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471bfa76731003cb33a963c903119506339f2e5cc51eb5b326a8af5df7deaabd
-  data.tar.gz: c41215d0fcc1edc5894b513788ca1e5777e98061f6017e80ae845c46c009d906
+  metadata.gz: e122582ed410310c48c95e3bffbac3b3255a055ec0e527769421162b672b4b85
+  data.tar.gz: 4491c33e03c11dbc78c4f6e71f378ef28f4a17558e12ce48df1008d63a417fa3
 SHA512:
-  metadata.gz: f183202aacd689a033e142a57d79355b115306fc39538220c7b002828883d15c8c61cccd29f3a40c7fde95df2ddefd55cebc4f0eab8fdf5cb9a800887b2536bd
-  data.tar.gz: 02123c015cb06e724ab63576948dbf928c7ce1f919772c0e5b70d69d62e2b7ce27ccbbb8a16b24de583c608d8566f5c7da806a2756cf6a182a40d7ced73d466e
+  metadata.gz: 70c0f2c24d1528b88ccb6d79302b285b2ba01759d4cd87c5009e3d7a46ac518b79a3a365a68a92176d6b69c7ea6b129c35c6c9c0d92a71c0815d41e96a8d121c
+  data.tar.gz: 45c8a888745f5e873084ea828e65e2982b73391ce9ac901473f9390f600e912600754dd67553734ace2e1aa330ad1935c98ebeee3d80f989b5f4c27e45614f94

data/lib/posthog/client.rb

@@ -44,9 +44,16 @@ module PostHog
       $is_server
       $lib
       $lib_version
+      $release_id
     ].flat_map { |key| [key, key.to_sym] }.freeze
     private_constant :MINIMAL_FLAG_CALLED_EVENT_PROPERTIES
 
+    # Holds the id that `posthog-cli release resolve` prints. Error tracking
+    # links an exception to its release by this id, because a Ruby app has no
+    # build step that could inject it.
+    RELEASE_ID_ENV_VAR = 'POSTHOG_RELEASE_ID'
+    private_constant :RELEASE_ID_ENV_VAR
+
     # Thread-safe tracking of client instances per API key for singleton warnings
     @instances_by_api_key = {}
     @instances_mutex = Mutex.new
@@ -217,6 +224,7 @@ module PostHog
 
       @before_send = opts[:before_send]
       @is_server = opts.fetch(:is_server, true) != false
+      @release_id = normalize_string_option(ENV.fetch(RELEASE_ID_ENV_VAR, nil), blank_as_nil: true)
       @deprecation_emitted_for = Concurrent::Set.new
     end
 
@@ -1137,6 +1145,8 @@ module PostHog
     def enqueue(action)
       return false if @disabled || shutdown?
 
+      # Every event type passes through here, and before_send still sees the id.
+      action = add_release_id(action)
       action = process_before_send(action)
       return false if action.nil? || action.empty?
 
@@ -1168,6 +1178,17 @@ module PostHog
       end
     end
 
+    # A `$release_id` the caller or the request context already set wins.
+    def add_release_id(action)
+      return action if @release_id.nil?
+
+      properties = action[:properties]
+      return action unless properties.is_a?(Hash)
+      return action if properties.key?('$release_id') || properties.key?(:$release_id)
+
+      action.merge(properties: properties.merge('$release_id' => @release_id))
+    end
+
     def normalize_string_option(value, blank_as_nil: false)
       return value unless value.is_a?(String)
 

data/lib/posthog/mcp/client.rb

@@ -17,10 +17,13 @@ module PostHog
       # @param opts [Hash] {PostHog::Client} options plus:
       # @option opts [String] :missing_capability_tool_name name of the virtual tool (default `get_more_tools`)
       # @option opts [Boolean] :mcp_exception_autocapture emit a sibling `$exception` for failed calls (default true)
+      # @option opts [Boolean, ModelOptions] :capture_model capture the calling model (default true)
       def initialize(opts = {})
         opts = opts.transform_keys(&:to_sym)
         @missing_capability_tool_name = opts.delete(:missing_capability_tool_name) || Tools::GET_MORE_TOOLS_NAME
         @mcp_exception_autocapture = opts.delete(:mcp_exception_autocapture) != false
+        capture_model = opts.key?(:capture_model) ? opts.delete(:capture_model) : true
+        @capture_model_option = Options.new(capture_model: capture_model).capture_model
         super
         @mcp_sink = Sink.new(self)
         @mcp_options = Options.new(
@@ -113,16 +116,20 @@ module PostHog
         emit(event)
       end
 
-      # Inject the `context` argument (and, with `capture_model`, `llm_model`) into
+      # Inject the `context` and `llm_model` arguments into
       # every tool descriptor (Hash with `inputSchema`) so agents state their intent,
       # and optionally append the `get_more_tools` virtual tool. Returns a new Array
       # of new Hashes. A tool whose schema is composed (oneOf/allOf/anyOf) or a
-      # `$ref` is passed through untouched.
+      # `$ref` is passed through untouched. Pass `capture_model: false` here or
+      # to {#initialize} to disable model capture for this client, including
+      # extraction from later tool calls.
       #
       # @param tools [Array<Hash>] `tools/list` entries
       # @return [Array<Hash>]
-      def prepare_tool_list(tools, context: true, report_missing: false, capture_model: false)
+      def prepare_tool_list(tools, context: true, report_missing: false, capture_model: @capture_model_option)
         options = Options.new(context: context, capture_model: capture_model)
+        @capture_model_option = false unless options.capture_model_enabled?
+        options = Options.new(context: context, capture_model: false) if @capture_model_option == false
         prepared = tools.map do |tool|
           next tool unless tool.is_a?(Hash) && (options.context_enabled? || options.capture_model_enabled?)
 
@@ -165,7 +172,7 @@ module PostHog
       # @return [PreparedToolCall]
       def prepare_tool_call(name, args = nil, input_schema: nil)
         intent = tool_declares?(input_schema, 'context') ? nil : Intent.normalize(argument(args, 'context'))
-        model = if tool_declares?(input_schema, ModelCapture::PARAM_NAME)
+        model = if @capture_model_option == false || tool_declares?(input_schema, ModelCapture::PARAM_NAME)
                   nil
                 else
                   ModelCapture.normalize(argument(args, ModelCapture::PARAM_NAME))
@@ -199,6 +206,8 @@ module PostHog
       end
 
       def apply_model(event, llm_model, source)
+        return if @capture_model_option == false
+
         model = ModelCapture.normalize(llm_model)
         return unless model
 
@@ -236,9 +245,11 @@ module PostHog
       def strip_injected(args, input_schema)
         return args unless args.is_a?(Hash)
 
-        keys = ['context', ModelCapture::PARAM_NAME].reject { |param| tool_declares?(input_schema, param) }
-                                                    .flat_map { |param| [param.to_sym, param] }
-                                                    .select { |key| args.key?(key) }
+        params = ['context']
+        params << ModelCapture::PARAM_NAME unless @capture_model_option == false
+        keys = params.reject { |param| tool_declares?(input_schema, param) }
+                     .flat_map { |param| [param.to_sym, param] }
+                     .select { |key| args.key?(key) }
         keys.empty? ? args : args.except(*keys)
       end
     end

data/lib/posthog/mcp/instrumentation.rb

@@ -506,9 +506,8 @@ module PostHog
           'Warning: an MCP request arrived over streamable HTTP with no session id, so PostHog generated a ' \
           'per-process $session_id that will fragment across requests and pods. In stateless mode the ' \
           'client must replay the Mcp-Session-Id header PostHog::MCP mints at initialize; for a custom Rack ' \
-          'stack add PostHog::MCP::RackMiddleware. Enabling conversation ids ' \
-          '(PostHog::MCP.instrument(server, enable_conversation_id: true)) also anchors the session without ' \
-          'any middleware. See https://posthog.com/docs/mcp-analytics/installation#ruby.'
+          'stack add PostHog::MCP::RackMiddleware. Conversation ids, which are enabled by default, also anchor ' \
+          'the session without any middleware. See https://posthog.com/docs/mcp-analytics/installation#ruby.'
         )
       end
 

data/lib/posthog/mcp/options.rb

@@ -52,13 +52,13 @@ module PostHog
       attr_reader :report_missing
       # @return [String] Name of the virtual tool. Default `get_more_tools`.
       attr_reader :missing_capability_tool_name
-      # @return [Boolean] Inject `conversation_id` and anchor `$session_id` on it. Default false.
+      # @return [Boolean] Inject `conversation_id` and anchor `$session_id` on it. Default true.
       attr_reader :enable_conversation_id
       # @return [Boolean] Emit a sibling `$exception` event for failed calls. Default true.
       attr_reader :enable_exception_autocapture
       # @return [Boolean, ContextOptions] Inject the required `context` argument. Default true.
       attr_reader :context
-      # @return [Boolean, ModelOptions] Capture `$mcp_llm_model`. Default false.
+      # @return [Boolean, ModelOptions] Capture `$mcp_llm_model`. Default true.
       attr_reader :capture_model
       # @return [#call, UserIdentity, Hash, nil] `(request, extra) -> UserIdentity | Hash | nil`, or a static identity.
       attr_reader :identify
@@ -70,8 +70,8 @@ module PostHog
       attr_reader :event_properties
 
       def initialize(logger: nil, report_missing: false, missing_capability_tool_name: nil,
-                     enable_conversation_id: false, enable_exception_autocapture: true, context: true,
-                     capture_model: false, identify: nil, intent_fallback: nil, before_send: nil,
+                     enable_conversation_id: true, enable_exception_autocapture: true, context: true,
+                     capture_model: true, identify: nil, intent_fallback: nil, before_send: nil,
                      event_properties: nil)
         @logger = logger
         @report_missing = report_missing == true

data/lib/posthog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PostHog
-  VERSION = '3.24.0'
+  VERSION = '3.26.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 3.24.0
+  version: 3.26.0
 platform: ruby
 authors:
 - ''
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: PostHog library
 test_files: []