inference_activity 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 930b5b9c1533a9da594668af59131f20b9d670b621e6e1da59e9bbb1cab08617
+  data.tar.gz: 47f37d2e37c9bdf70d1cb5b906b0e6f143bca9be4fed5f8dc6169fc43e64c6e7
+SHA512:
+  metadata.gz: 27ea85c2efcc589f767b4c23bb14038f52c1809b96e0488ebef08e5ad780c6d9a47fbcf394ba6f20f8ab28d1cc0f9a1dc411dcb34ba237dd0c9a28f22b3c6df0
+  data.tar.gz: 9763eca818ca551b36b9d94706d36ef7864d4c16ecaea00f85b1a503a758fc33ee28359a5dcd14e03fb7178f242dc92760d11c2f2cc7737e87ccbd5de69418c9

data/README.md

@@ -0,0 +1,133 @@
+# Inference Activity for Ruby
+
+A Ruby gem that provides Net::HTTP extensions for tracking inference activities on Heroku AI. This gem is the Ruby equivalent of `inference-activity-axios`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inference_activity'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install inference_activity
+```
+
+## Usage
+
+The gem automatically extends Net::HTTP to track inference activities. Simply require it in your code:
+
+```ruby
+require 'inference_activity'
+require 'net/http'
+require 'json'
+require 'uri'
+
+# Set up your environment variables
+ENV['INFERENCE_ACTIVITY_URL'] = 'your-activity-logging-endpoint'
+ENV['INFERENCE_ACTIVITY_KEY'] = 'your-api-key'
+
+# Make requests as usual with Net::HTTP
+uri = URI('https://api.heroku.ai/v1/chat/completions')
+request = Net::HTTP::Post.new(uri)
+request['Authorization'] = "Bearer #{ENV['API_KEY']}"
+request['Content-Type'] = 'application/json'
+request.body = {
+  messages: [
+    { role: 'user', content: 'Hello!' }
+  ],
+  model: 'gpt-3.5-turbo'
+}.to_json
+
+response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+  http.request(request)
+end
+```
+
+The gem will automatically:
+- Track the request/response
+- Measure response time
+- Redact sensitive information
+- Send activity logs to your specified endpoint
+
+## Features
+
+- Automatically tracks inference activities for Heroku AI endpoints
+- Redacts sensitive information from requests and responses
+- Tracks response times and logs activity data
+- Handles the following endpoints:
+  - `/v1/chat/completions`
+  - `/v1/embeddings`
+  - `/v1/images/generations`
+
+## Environment Variables
+
+- `INFERENCE_ACTIVITY_URL`: The endpoint where activity logs will be sent
+- `INFERENCE_ACTIVITY_KEY`: The API key for authentication when sending activity logs
+
+## Activity Data Format
+
+The gem sends the following data structure to your activity logging endpoint:
+
+```ruby
+{
+  timestamp: 1234567890123,  # Unix timestamp in milliseconds
+  response_time: 500,        # Response time in milliseconds
+  status_code: 200,          # HTTP status code
+  status_message: "OK",      # HTTP status message
+  request: {
+    method: "POST",
+    url: "https://api.heroku.ai/v1/chat/completions",
+    params: {},
+    body: {
+      messages: "[REDACTED]",
+      model: "gpt-3.5-turbo"
+    }
+  },
+  response: {
+    headers: {
+      "content-type" => "application/json",
+      # ...
+    },
+    data: {
+      choices: [{
+        message: {
+          content: "[REDACTED]",
+          role: "assistant"
+        }
+      }],
+      # ...
+    }
+  }
+}
+```
+
+## Differences from inference-activity-axios
+
+This gem provides the same functionality as `inference-activity-axios` but is adapted for Ruby's Net::HTTP:
+
+1. Uses Ruby's Net::HTTP extension system instead of Axios interceptors
+2. Automatically applies to all Net::HTTP requests in the application
+3. Uses Ruby's Time class for timestamps
+4. Maintains consistent millisecond-precision timestamps for compatibility
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/add-co/inference-activity-ruby.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/inference_activity/version.rb

@@ -0,0 +1,3 @@
+module InferenceActivity
+  VERSION = "1.0.0"
+end

data/lib/inference_activity.rb

@@ -0,0 +1,150 @@
+require 'net/http'
+require 'json'
+require 'uri'
+require 'time'
+
+module InferenceActivity
+  class << self
+    def wrap_request(request, &block)
+      start_time = Time.now
+
+      # Execute the original request
+      response = yield
+
+      # Track activity if environment variables are set
+      track_activity(request, response, start_time) if tracking_enabled?
+
+      response
+    end
+
+    private
+
+    def tracking_enabled?
+      !ENV['INFERENCE_ACTIVITY_URL'].nil? && !ENV['INFERENCE_ACTIVITY_KEY'].nil?
+    end
+
+    def track_activity(request, response, start_time)
+      duration = ((Time.now - start_time) * 1000).to_i # Convert to milliseconds
+
+      activity_data = {
+        timestamp: (Time.now.to_f * 1000).to_i, # Unix timestamp in milliseconds
+        response_time: duration,
+        status_code: response.code.to_i,
+        status_message: response.message,
+        request: redact_request(request),
+        response: redact_response(response)
+      }
+
+      send_activity_data(activity_data)
+    rescue => e
+      warn "Failed to send inference activity: #{e.message}"
+    end
+
+    def redact_request(request)
+      uri = URI(request.uri)
+      body = parse_request_body(request)
+
+      if body.is_a?(Hash)
+        if uri.path.end_with?('/v1/chat/completions') && body['messages']
+          body = body.merge('messages' => '[REDACTED]')
+        end
+
+        if uri.path.end_with?('/v1/embeddings') && body['input']
+          body = body.merge('input' => '[REDACTED]')
+        end
+
+        if uri.path.end_with?('/v1/images/generations')
+          body = body.merge('prompt' => '[REDACTED]') if body['prompt']
+          body = body.merge('negative_prompt' => '[REDACTED]') if body['negative_prompt']
+        end
+      end
+
+      {
+        method: request.method,
+        url: request.uri.to_s,
+        params: URI.decode_www_form(uri.query || '').to_h,
+        body: body
+      }
+    end
+
+    def redact_response(response)
+      data = parse_response_body(response)
+      uri = URI(response.uri)
+
+      if data.is_a?(Hash)
+        if uri.path.end_with?('/v1/chat/completions') && data['choices']
+          data['choices'] = data['choices'].map do |choice|
+            if choice['message']
+              choice.merge('message' => choice['message'].merge('content' => '[REDACTED]'))
+            else
+              choice
+            end
+          end
+        end
+
+        if uri.path.end_with?('/v1/embeddings') && data['data']
+          data['data'] = data['data'].map do |item|
+            item.merge('embedding' => '[REDACTED]')
+          end
+        end
+
+        if uri.path.end_with?('/v1/images/generations') && data['data']
+          data['data'] = data['data'].map do |item|
+            redacted = item.dup
+            redacted['b64_json'] = '[REDACTED]' if item.key?('b64_json')
+            redacted['revised_prompt'] = '[REDACTED]' if item.key?('revised_prompt')
+            redacted
+          end
+        end
+      end
+
+      {
+        headers: response.each_header.to_h,
+        data: data
+      }
+    end
+
+    def parse_request_body(request)
+      return {} unless request.body
+
+      JSON.parse(request.body)
+    rescue JSON::ParserError
+      request.body
+    end
+
+    def parse_response_body(response)
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      response.body
+    end
+
+    def send_activity_data(activity_data)
+      uri = URI(ENV['INFERENCE_ACTIVITY_URL'])
+      request = Net::HTTP::Post.new(uri)
+      request['Authorization'] = "Bearer #{ENV['INFERENCE_ACTIVITY_KEY']}"
+      request['Content-Type'] = 'application/json'
+      request.body = activity_data.to_json
+
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+    end
+  end
+
+  module RequestExtensions
+    def self.included(base)
+      base.class_eval do
+        alias_method :original_exec, :exec
+
+        def exec(sock, ver, path)
+          InferenceActivity.wrap_request(self) do
+            original_exec(sock, ver, path)
+          end
+        end
+      end
+    end
+  end
+end
+
+# Extend Net::HTTP::Request with our tracking functionality
+Net::HTTPRequest.include(InferenceActivity::RequestExtensions)

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: inference_activity
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Add Co
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides request/response tracking and activity logging for Heroku AI
+  endpoints with sensitive data redaction
+email:
+- dev@add.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/inference_activity.rb
+- lib/inference_activity/version.rb
+homepage: https://github.com/add-co/inference-activity-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.15
+signing_key:
+specification_version: 4
+summary: Net::HTTP extensions for tracking inference activities on Heroku AI
+test_files: []