app_profiler 0.2.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88fa4e71be7c319cba26e669752c8a7a46c9b7c56881894944a8ae4b8def6c6f
-  data.tar.gz: 9daa41d818e4fbd0a113186c20e7a18814a3c039bc7dc91d52d26efd7a3ab5c6
+  metadata.gz: b5ca2ed69abcd8cba935914ee16e8427fa8070fb3b0eecb488b06a027a64667a
+  data.tar.gz: fbcd17ddeeabfbbb8fe52c69d8744b0a8c73a9cd54ed6cd248f40e1c1a8f2662
 SHA512:
-  metadata.gz: 8471c04250be1ae8b393a804ee83553ccc5c374008f343ab0213464b130658ee69fa77626a0f557e7423350e60d0ac6c803228a656e48be739def63400d34fe3
-  data.tar.gz: 216c13be42bb571a535c894f543889fa114f97ff49aa84fb59d7ab2a39e8b7f2815c5e75399a3d98b7cbcf645376e37bb4899d8e5c63761f3fac6f1ca2483848
+  metadata.gz: f41e6a149770dbffc1f85f3b280ef91cfc3c2ab966f6d9c8ce943c6c46e3ae2a2784b2864d2a8163593c83d0c116af1919598cc0576831423c5ed825a90b0770
+  data.tar.gz: d12e52408d4d5aedc048661bc96d35f55f038c1eeaedc01c6ed4b31612298d8203c33e5449d935a677a4ec3b75e0cc4c3cc938ae186a3a29c49d245da8093128

data/lib/app_profiler/backend/base_backend.rb

@@ -3,8 +3,27 @@
 module AppProfiler
   module Backend
     class BaseBackend
-      def run(params = {}, &block)
-        raise NotImplementedError
+      def run(params = {})
+        started = start(params)
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        yield
+
+        return unless started
+
+        duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
+
+        stop
+        results_data = results
+
+        if results_data
+          results_data.metadata[:duration] = duration
+        end
+
+        results_data
+      ensure
+        # Only stop the profiler if profiling was started in this context.
+        stop if started
       end
 
       def start(params = {})

data/lib/app_profiler/backend/stackprof_backend.rb

@@ -22,20 +22,6 @@ module AppProfiler
         end
       end
 
-      def run(params = {})
-        started = start(params)
-
-        yield
-
-        return unless started
-
-        stop
-        results
-      ensure
-        # Only stop the profiler if profiling was started in this context.
-        stop if started
-      end
-
       def start(params = {})
         # Do not start the profiler if StackProf was started somewhere else.
         return false if running?

data/lib/app_profiler/backend/vernier_backend.rb

@@ -21,20 +21,6 @@ module AppProfiler
         end
       end
 
-      def run(params = {})
-        started = start(params)
-
-        yield
-
-        return unless started
-
-        stop
-        results
-      ensure
-        # Only stop the profiler if profiling was started in this context.
-        stop if started
-      end
-
       def start(params = {})
         # Do not start the profiler if we already have a collector started somewhere else.
         return false if running?

data/lib/app_profiler/base_profile.rb

@@ -47,6 +47,10 @@ module AppProfiler
       metadata[PROFILE_ID_METADATA_KEY]
     end
 
+    def duration
+      metadata[:duration]
+    end
+
     def upload
       AppProfiler.storage.upload(self).tap do |upload|
         if upload && defined?(upload.url)

data/lib/app_profiler/middleware.rb

@@ -7,6 +7,11 @@ require "app_profiler/middleware/view_action"
 
 module AppProfiler
   class Middleware
+    OTEL_PROFILE_ID = "profile.id"
+    OTEL_PROFILE_BACKEND = "profile.profiler"
+    OTEL_PROFILE_MODE = "profile.mode"
+    OTEL_PROFILE_CONTEXT = "profile.context"
+
     class_attribute :action,   default: UploadAction
     class_attribute :disabled, default: false
 
@@ -29,8 +34,11 @@ module AppProfiler
       return yield unless app_profiler_params
 
       params_hash = app_profiler_params.to_h
+
       return yield unless before_profile(env, params_hash)
 
+      add_otel_instrumentation(env, params_hash) if AppProfiler.otel_instrumentation_enabled
+
       profile = AppProfiler.run(**params_hash) do
         response = yield
       end
@@ -47,6 +55,27 @@ module AppProfiler
       response
     end
 
+    def add_otel_instrumentation(env, params)
+      rack_span = OpenTelemetry::Instrumentation::Rack.current_span
+      return unless rack_span.recording?
+
+      metadata = params[:metadata]
+      profile_id = if metadata[:id].present?
+        metadata[:id]
+      else
+        AppProfiler::ProfileId.current
+      end
+
+      attributes = {
+        OTEL_PROFILE_ID => profile_id,
+        OTEL_PROFILE_BACKEND => params[:backend].to_s,
+        OTEL_PROFILE_MODE => params[:mode].to_s,
+        OTEL_PROFILE_CONTEXT => AppProfiler.context,
+      }
+
+      rack_span.add_attributes(attributes)
+    end
+
     def profile_params(params)
       return params if params.valid?
       return unless AppProfiler.profile_sampler_enabled

data/lib/app_profiler/railtie.rb

@@ -51,6 +51,8 @@ module AppProfiler
       AppProfiler.profile_sampler_enabled = app.config.app_profiler.profile_sampler_enabled || false
       AppProfiler.profile_sampler_config = app.config.app_profiler.profile_sampler_config ||
         AppProfiler::Sampler::Config.new
+
+      AppProfiler.otel_instrumentation_enabled = app.config.app_profiler.otel_instrumentation_enabled || false
     end
 
     initializer "app_profiler.add_middleware" do |app|

data/lib/app_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppProfiler
-  VERSION = "0.2.9"
+  VERSION = "0.4.0"
 end

data/lib/app_profiler.rb

@@ -3,6 +3,7 @@
 require "active_support"
 require "active_support/core_ext/class"
 require "active_support/core_ext/module"
+require "active_support/core_ext/time/zones"
 require "logger"
 require "app_profiler/version"
 
@@ -76,6 +77,8 @@ module AppProfiler
   mattr_reader :profile_file_name
 
   class << self
+    attr_reader :otel_instrumentation_enabled
+
     def deprecator # :nodoc:
       @deprecator ||= ActiveSupport::Deprecation.new("in future releases", "app_profiler")
     end
@@ -162,6 +165,15 @@ module AppProfiler
       false
     end
 
+    def otel_instrumentation_enabled=(value)
+      if value
+        gem("opentelemetry-instrumentation-rack")
+        require("opentelemetry/instrumentation/rack")
+      end
+
+      @otel_instrumentation_enabled = value
+    end
+
     def backend_for(backend_name)
       if vernier_supported? &&
           backend_name&.to_sym == AppProfiler::VernierProfile::BACKEND_NAME

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -12,7 +12,7 @@ authors:
 - Scott Francis
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,6 +112,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Collect performance profiles for your Rails application.
 test_files: []