stripe 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dccdd56e293fe589e24cbe9dfaa4a4dec846e6693725f695e023c731c29a9a1
-  data.tar.gz: 899abdb8f1449712fbf30bab8b615819e853500d7df10b5830dd29ea652bed63
+  metadata.gz: 33a577d3a54901e265c71453a87d54a54bbb6905f2b698b1f7ee8129661dbdb7
+  data.tar.gz: 5c1d73b562666f0761f01c505e1958a81ccc1d94e582d88087ddf768db3ca814
 SHA512:
-  metadata.gz: ccc38cdd75c55a8af558550fbaa37adef6e3802ce3b2399e0c5d8c883eefcbbbc0ef356d4d905006eb6f26459c8a276225c180938e5f007c7b247cc938e1842f
-  data.tar.gz: b8d4252feb4c72fbd1f4a6a049604d2731b66f8f1400fcae9c9093b018c5d6bce7417bec009b2609f109ff8fca301c6ef5d6e81d37ddff7cc817678dfb3342ed
+  metadata.gz: af632e67609cb9b0486fdee261403c54d9f0b2e3b5b3332ad66eaf974bd240f102a8c7db3dddd4edc2919255a31363d77144722a5ee2f974661380ef3a92bffb
+  data.tar.gz: 3c184ec9d7ef44027e74b8b74a2bb72446fe45b68e5ce0c862a7aff51a5f4cc992b1d8ca6aeb48f6e359a8c0cf2e8eef1a80facde43f8eefddca03ef53a8b8f6

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 8.1.0 - 2023-01-12
+* [#1162](https://github.com/stripe/stripe-ruby/pull/1162) Improve request events instrumentation
+
 ## 8.0.0 - 2022-11-16
 * [#1144](https://github.com/stripe/stripe-ruby/pull/1144) Next major release changes
 

data/VERSION

@@ -1 +1 @@
-8.0.0
+8.1.0

data/lib/stripe/instrumentation.rb

@@ -33,6 +33,10 @@ module Stripe
       attr_reader :num_retries
       attr_reader :path
       attr_reader :request_id
+      attr_reader :response_header
+      attr_reader :response_body
+      attr_reader :request_header
+      attr_reader :request_body
 
       # Arbitrary user-provided data in the form of a Ruby hash that's passed
       # from subscribers on `request_begin` to subscribers on `request_end`.
@@ -40,19 +44,53 @@ module Stripe
       # in `request_end`.
       attr_reader :user_data
 
-      def initialize(duration:, http_status:, method:, num_retries:, path:,
-                     request_id:, user_data: nil)
-        @duration = duration
-        @http_status = http_status
-        @method = method
+      def initialize(request_context:, response_context:,
+                     num_retries:, user_data: nil)
+        @duration = request_context.duration
+        @http_status = response_context.http_status
+        @method = request_context.method
         @num_retries = num_retries
-        @path = path
-        @request_id = request_id
+        @path = request_context.path
+        @request_id = request_context.request_id
         @user_data = user_data
+        @response_header = response_context.header
+        @response_body = response_context.body
+        @request_header = request_context.header
+        @request_body = request_context.body
         freeze
       end
     end
 
+    class RequestContext
+      attr_reader :duration
+      attr_reader :method
+      attr_reader :path
+      attr_reader :request_id
+      attr_reader :body
+      attr_reader :header
+
+      def initialize(duration:, context:, header:)
+        @duration = duration
+        @method = context.method
+        @path = context.path
+        @request_id = context.request_id
+        @body = context.body
+        @header = header
+      end
+    end
+
+    class ResponseContext
+      attr_reader :http_status
+      attr_reader :body
+      attr_reader :header
+
+      def initialize(http_status:, response:)
+        @http_status = http_status
+        @header = response ? response.to_hash : nil
+        @body = response ? response.body : nil
+      end
+    end
+
     # This class was renamed for consistency. This alias is here for backwards
     # compatibility.
     RequestEvent = RequestEndEvent

data/lib/stripe/stripe_client.rb

@@ -494,15 +494,16 @@ module Stripe
           end
         end
 
-      http_resp = execute_request_with_rescues(method, api_base, context) do
-        self.class
-            .default_connection_manager(config)
-            .execute_request(method, url,
-                             body: body,
-                             headers: headers,
-                             query: query,
-                             &response_block)
-      end
+      http_resp =
+        execute_request_with_rescues(method, api_base, headers, context) do
+          self.class
+              .default_connection_manager(config)
+              .execute_request(method, url,
+                               body: body,
+                               headers: headers,
+                               query: query,
+                               &response_block)
+        end
 
       [http_resp, api_key]
     end
@@ -564,7 +565,7 @@ module Stripe
       http_status >= 400
     end
 
-    private def execute_request_with_rescues(method, api_base, context)
+    private def execute_request_with_rescues(method, api_base, headers, context)
       num_retries = 0
 
       begin
@@ -587,7 +588,7 @@ module Stripe
 
         log_response(context, request_start, http_status, resp.body, resp)
         notify_request_end(context, request_duration, http_status,
-                           num_retries, user_data)
+                           num_retries, user_data, resp, headers)
 
         if config.enable_telemetry? && context.request_id
           request_duration_ms = (request_duration * 1000).to_i
@@ -614,7 +615,7 @@ module Stripe
           log_response_error(error_context, request_start, e)
         end
         notify_request_end(context, request_duration, http_status, num_retries,
-                           user_data)
+                           user_data, resp, headers)
 
         if self.class.should_retry?(e,
                                     method: method,
@@ -657,17 +658,24 @@ module Stripe
     end
 
     private def notify_request_end(context, duration, http_status, num_retries,
-                                   user_data)
+                                   user_data, resp, headers)
       return if !Instrumentation.any_subscribers?(:request_end) &&
                 !Instrumentation.any_subscribers?(:request)
 
-      event = Instrumentation::RequestEndEvent.new(
+      request_context = Stripe::Instrumentation::RequestContext.new(
         duration: duration,
+        context: context,
+        header: headers
+      )
+      response_context = Stripe::Instrumentation::ResponseContext.new(
         http_status: http_status,
-        method: context.method,
+        response: resp
+      )
+
+      event = Instrumentation::RequestEndEvent.new(
+        request_context: request_context,
+        response_context: response_context,
         num_retries: num_retries,
-        path: context.path,
-        request_id: context.request_id,
         user_data: user_data || {}
       )
       Stripe::Instrumentation.notify(:request_end, event)

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "8.0.0"
+  VERSION = "8.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Stripe API