paid_ruby 0.1.1 → 0.5.0.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e08b12d8087ea612ca1b405c5d6cfa6fab4374f4f89ad81df1a7042b31206c72
-  data.tar.gz: 7dd1f1ef4c71fe4dd19d3c34e6eacd051a95087b74ec5be2f610efe9608e2a55
+  metadata.gz: a2dcc5d043c51e405cbfaf7218d192091d7ee650616596eef5c26ed790b52a78
+  data.tar.gz: 8e0462f0215cbdb94d810ed7c04309a4d1581bcba0efd02d9d49220451625ebc
 SHA512:
-  metadata.gz: 6eed37d4f15ac6939c644a4c7db14fbcaeb3d5e9e67d16b983d3060790f0daeb6054b1e5beb0241470bdaeca393bdc119503dc2ffd893272e9d522c62031059c
-  data.tar.gz: 931419aa3d4767c1df1f7c0ca332db5e629b73f7d38b3f8cdc61463626c726476ac89f327434ecd08bebdc631c8dbcc726484b925a6d4f3a821695b5220a4684
+  metadata.gz: 5f493692e13c4a3db9295e66268aa7e982a26425608f86306eca53fa3ad9e667ac389a93aab6292e16bd15686e6b947cc6df9861e387250172b245f6ad27094b
+  data.tar.gz: 36d9a998cc9813589c53842cb8293141df47625c8b6b3a84c2867ed08720bf9cecd2533d53e87e412ce7a4c85056e9daf7c1f5aa29b6daf08c8c11d9aa303340

data/lib/paid_ruby/tracing/logging.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Paid
+  module Tracing
+    # Provides a central logger for the gem.
+    # The log level can be configured via the PAID_LOG_LEVEL environment variable.
+    # Supported levels are DEBUG, INFO, WARN, ERROR, FATAL.
+    # If the variable is not set, the level defaults to FATAL to suppress output.
+    module Logging
+      def self.logger
+        @logger ||= begin
+          log_level_str = ENV["PAID_LOG_LEVEL"]&.upcase
+          level = if log_level_str && Logger.const_defined?(log_level_str)
+                    Logger.const_get(log_level_str)
+                  else
+                    # Default to a level that shows no logs unless explicitly configured.
+                    Logger::FATAL
+                  end
+
+          logger = Logger.new($stdout)
+          logger.level = level
+          logger.formatter = proc do |severity, _datetime, _progname, msg|
+            "[Paid SDK] #{severity}: #{msg}\n"
+          end
+          logger
+        end
+      end
+    end
+  end
+end

data/lib/paid_ruby/tracing/tracing.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "opentelemetry/sdk"
+require "opentelemetry/exporter/otlp"
+require_relative "logging"
+
+module Paid
+  module Tracing
+    @token = nil
+
+    # Context keys to propagate external_customer_id and token to child spans.
+    # These are just keys, not the values themselves.
+    PAID_EXTERNAL_CUSTOMER_ID_KEY = OpenTelemetry::Context.create_key("paid.external_customer_id")
+    PAID_TOKEN_KEY = OpenTelemetry::Context.create_key("paid.token")
+
+    # @param api_key [String]
+    def self.initialize_tracing(api_key:)
+      endpoint = "https://collector.agentpaid.io:4318/v1/traces"
+      # endpoint = "http://localhost:4318/v1/traces"
+
+      @token = api_key
+
+      exporter = OpenTelemetry::Exporter::OTLP::Exporter.new(
+        endpoint: endpoint,
+        headers: {}
+      )
+      span_processor = OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(exporter)
+
+      OpenTelemetry::SDK.configure do |c|
+        c.add_span_processor(span_processor)
+      end
+
+      # Add an at_exit hook to ensure spans are flushed before the script exits.
+      at_exit do
+        OpenTelemetry.tracer_provider.shutdown
+      end
+
+      Logging.logger.info("Paid tracing initialized successfully")
+    rescue StandardError => e
+      Logging.logger.error("Failed to initialize Paid tracing: #{e.message}")
+      raise
+    end
+
+    def self.token
+      @token
+    end
+
+    # Getter for the OpenAI wrapper to retrieve the external_customer_id from the context.
+    def self.get_external_customer_id_from_context
+      OpenTelemetry::Context.current.value(PAID_EXTERNAL_CUSTOMER_ID_KEY)
+    end
+
+    # Getter for the OpenAI wrapper to retrieve the token from the context.
+    def self.get_token_from_context
+      OpenTelemetry::Context.current.value(PAID_TOKEN_KEY)
+    end
+
+    # @param external_customer_id [String]
+    # @param args [Array]
+    # @param block [Proc]
+    def self.capture(*args, external_customer_id:, &block)
+      token = self.token
+      unless token
+        Logging.logger.warn("No token found - tracing is not initialized and will not be captured")
+        return yield(*args) if block_given?
+      end
+
+      new_context_values = {
+        PAID_EXTERNAL_CUSTOMER_ID_KEY => external_customer_id,
+        PAID_TOKEN_KEY => token
+      }
+
+      # Execute the block within a new context containing our values.
+      OpenTelemetry::Context.with_values(new_context_values) do
+        tracer = OpenTelemetry.tracer_provider.tracer("paid.ruby")
+
+        tracer.in_span("paid.ruby:#{external_customer_id}") do |span|
+          span.set_attribute("external_customer_id", external_customer_id)
+          span.set_attribute("token", token)
+
+          begin
+            result = yield(*args) if block_given?
+            span.status = OpenTelemetry::Trace::Status.ok("Success")
+            result
+          rescue StandardError => e
+            span.status = OpenTelemetry::Trace::Status.error("Error: #{e.message}")
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

data/lib/paid_ruby/tracing/wrappers/open_ai_wrapper.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "openai"
+require_relative "../tracing"
+
+module Paid
+  module Tracing
+    module Wrappers
+      # A wrapper around the OpenAI::Client that provides automatic tracing for API calls.
+      class PaidOpenAI
+        def initialize(openai_client:)
+          @openai_client = openai_client
+          @tracer = OpenTelemetry.tracer_provider.tracer("paid.ruby")
+        end
+
+        # Wraps the OpenAI#chat method to create a child span.
+        def chat(parameters:)
+          wrap_call(operation: "chat", model: parameters[:model]) do
+            @openai_client.chat(parameters: parameters)
+          end
+        end
+
+        # Wraps the OpenAI#embeddings method to create a child span.
+        def embeddings(parameters:)
+          wrap_call(operation: "embeddings", model: parameters[:model]) do
+            @openai_client.embeddings(parameters: parameters)
+          end
+        end
+
+        # Returns a wrapper for the images API.
+        def images
+          ImagesWrapper.new(openai_client: @openai_client, tracer: @tracer)
+        end
+
+        private
+
+        # A private wrapper for the OpenAI Images API.
+        class ImagesWrapper
+          def initialize(openai_client:, tracer:)
+            @openai_client = openai_client
+            @tracer = tracer
+          end
+
+          def generate(parameters:)
+            current_span = OpenTelemetry::Trace.current_span
+            unless current_span.context.valid?
+              Paid::Tracing::Logging.logger.warn("No active span found, calling OpenAI directly without tracing.")
+              return @openai_client.images.generate(parameters: parameters)
+            end
+
+            external_customer_id = Paid::Tracing.get_external_customer_id_from_context
+            token = Paid::Tracing.get_token_from_context
+            model = parameters[:model] || "dall-e-3"
+            span_name = "trace.images #{model}"
+
+            @tracer.in_span(span_name) do |span|
+              attributes = {
+                "gen_ai.request.model" => model,
+                "gen_ai.system" => "openai",
+                "gen_ai.operation.name" => "image_generation"
+              }
+              attributes["external_customer_id"] = external_customer_id if external_customer_id
+              attributes["token"] = token if token
+              span.add_attributes(attributes)
+
+              begin
+                response = @openai_client.images.generate(parameters: parameters)
+                span.add_attributes({
+                                      "gen_ai.image.count" => parameters[:n] || 1,
+                                      "gen_ai.image.size" => parameters[:size] || "1024x1024",
+                                      "gen_ai.image.quality" => parameters[:quality] || "standard"
+                                    })
+                span.status = OpenTelemetry::Trace::Status.ok("Success")
+                response
+              rescue StandardError => e
+                span.record_exception(e)
+                span.status = OpenTelemetry::Trace::Status.error("Error: #{e.message}")
+                raise e
+              end
+            end
+          end
+        end
+
+        def wrap_call(operation:, model:, &block)
+          current_span = OpenTelemetry::Trace.current_span
+          unless current_span.context.valid?
+            Paid::Tracing::Logging.logger.warn("No active span found, calling OpenAI directly without tracing.")
+            return yield
+          end
+
+          external_customer_id = Paid::Tracing.get_external_customer_id_from_context
+          token = Paid::Tracing.get_token_from_context
+          model_name = model || "unknown"
+          span_name = "trace.#{operation} #{model_name}"
+
+          @tracer.in_span(span_name) do |span|
+            attributes = {
+              "gen_ai.system" => "openai",
+              "gen_ai.operation.name" => operation
+            }
+            attributes["external_customer_id"] = external_customer_id if external_customer_id
+            attributes["token"] = token if token
+            span.add_attributes(attributes)
+
+            begin
+              response = yield
+              add_response_attributes(span, response)
+              span.status = OpenTelemetry::Trace::Status.ok("Success")
+              response
+            rescue StandardError => e
+              span.record_exception(e)
+              span.status = OpenTelemetry::Trace::Status.error("Error: #{e.message}")
+              raise e
+            end
+          end
+        end
+
+        def add_response_attributes(span, response)
+          return unless response.is_a?(Hash) && response.dig("usage")
+
+          attributes = {
+            "gen_ai.usage.input_tokens" => response.dig("usage", "prompt_tokens"),
+            "gen_ai.usage.output_tokens" => response.dig("usage", "completion_tokens"),
+            "gen_ai.response.model" => response.dig("model")
+          }.compact
+
+          span.add_attributes(attributes)
+        end
+      end
+    end
+  end
+end

data/lib/paid_ruby.rb

@@ -9,6 +9,8 @@ require_relative "paid_ruby/contacts/client"
 require_relative "paid_ruby/orders/client"
 require_relative "paid_ruby/usage/client"
 require_relative "extensions/batch"
+require_relative "paid_ruby/tracing/tracing"
+require_relative "paid_ruby/tracing/wrappers/open_ai_wrapper"
 
 module Paid
   class Client
@@ -44,6 +46,19 @@ module Paid
       @orders = Paid::OrdersClient.new(request_client: @request_client)
       @usage = Paid::BatchUsageClient.new(request_client: @request_client)
     end
+
+    def initialize_tracing
+      token = @request_client.token
+      api_key = token.gsub(/^Bearer /, "")
+      Paid::Tracing.initialize_tracing(api_key: api_key)
+    end
+
+    # @param external_customer_id [String]
+    # @param args [Array]
+    # @param block [Proc]
+    def capture(*args, external_customer_id:, &block)
+      Paid::Tracing.capture(*args, external_customer_id: external_customer_id, &block)
+    end
   end
 
   class AsyncClient
@@ -79,5 +94,18 @@ module Paid
       @orders = Paid::AsyncOrdersClient.new(request_client: @async_request_client)
       @usage = Paid::AsyncBatchUsageClient.new(request_client: @async_request_client)
     end
+
+    def initialize_tracing
+      token = @async_request_client.token
+      api_key = token.gsub(/^Bearer /, "")
+      Paid::Tracing.initialize_tracing(api_key: api_key)
+    end
+
+    # @param external_customer_id [String]
+    # @param args [Array]
+    # @param block [Proc]
+    def capture(*args, external_customer_id:, &block)
+      Paid::Tracing.capture(*args, external_customer_id: external_customer_id, &block)
+    end
   end
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: paid_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.5.0.pre.alpha1
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-12 00:00:00.000000000 Z
+date: 2025-06-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-http-faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -71,25 +91,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: async-http-faraday
+  name: opentelemetry-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-    - - "<"
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
-    - - "<"
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
 description: ''
 email: ''
 executables: []
@@ -105,6 +189,9 @@ files:
 - lib/paid_ruby/customers/client.rb
 - lib/paid_ruby/orders/client.rb
 - lib/paid_ruby/orders/lines/client.rb
+- lib/paid_ruby/tracing/logging.rb
+- lib/paid_ruby/tracing/tracing.rb
+- lib/paid_ruby/tracing/wrappers/open_ai_wrapper.rb
 - lib/paid_ruby/types/address.rb
 - lib/paid_ruby/types/agent.rb
 - lib/paid_ruby/types/agent_attribute.rb
@@ -149,14 +236,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: ''