app_profiler 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab22ed223e6cc5f20f3a2541a1ecc17a266591510c199d09ea7b05a91d5b2441
-  data.tar.gz: 73e6a570e6a898170f8caa47c1f389a8d13063e39f46bfdcbef7ecac3cdec677
+  metadata.gz: e78035c478029d4ad4de636efab44240957c2bd05ea761dc9fe28b753b4fa1d3
+  data.tar.gz: c4d6659a31eaa7440c6c8a2550c9cf41fbadb567426cae7c6bd0cd4442e8039a
 SHA512:
-  metadata.gz: 1c269a8514ab205bc7081f23e0b9cd914d7b1dbe252f21963e2ddc2cf7ddcf4c717e759eda03179136578b3c3a840f9253e22b21bc5415699ab2e30e32cc5d26
-  data.tar.gz: e17b9a934254e1871f34b81c9c66c589aa218d24fc5b2cfa6b0fbc34945313b8e1a0b9866f431b27a6d484694b8a6222cd4739602233020541cc3288c9ee63e9
+  metadata.gz: 45610912af0b6952b2c104d27bfc3bf2b37b92f91d2c873bdf9e2bfc43498529decf9568af63b9ee47d84794dd921dbf6312de11aac272be296f99416d5f2b31
+  data.tar.gz: 29ee1a661cc8c81274fbdb7f6123ce90d7dbeaa351ca3b16a8a6bfe933ec3f68385bfe0f2d0afb2ae6c49ba59fa318d733bd23d6cf7724a3d03f1246e36b65ca

data/lib/app_profiler/base_profile.rb

@@ -8,7 +8,7 @@ module AppProfiler
     private_constant :INTERNAL_METADATA_KEYS
     class UnsafeFilename < StandardError; end
 
-    attr_reader :id, :context
+    attr_reader :context
 
     delegate :[], to: :@data
 
@@ -34,9 +34,17 @@ module AppProfiler
     # `data` is assumed to be a Hash for Stackprof,
     # a vernier "result" object for vernier
     def initialize(data, id: nil, context: nil)
-      @id      = id.presence || ProfileId.current
+      ProfileId.current = id if id.present?
+
       @context = context
       @data    = data
+
+      metadata[PROFILE_BACKEND_METADATA_KEY] = self.class.backend_name
+      metadata[PROFILE_ID_METADATA_KEY] = ProfileId.current
+    end
+
+    def id
+      metadata[PROFILE_ID_METADATA_KEY]
     end
 
     def upload

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/profile_id.rb

@@ -1,19 +1,39 @@
 # frozen_string_literal: true
 
-require "active_support/current_attributes"
 require "securerandom"
 
 module AppProfiler
   class ProfileId
-    class Current < ActiveSupport::CurrentAttributes
-      attribute :id
+    class Current
+      PROFILE_ID_KEY = :__app_profiler_profile_id__
+      class << self
+        # This is a thread local variable which gets reset by the middleware at the end of the request.
+        # Need to be mindful of the middleware order. If we try to access ProfileId after the middleware has finished,
+        # lets say in a middleware which runs before Profiling middleware, it will return a different value,
+        # as the middleware has already reset.
+
+        def id
+          Thread.current[PROFILE_ID_KEY] ||= SecureRandom.hex
+        end
+
+        def id=(id)
+          Thread.current[PROFILE_ID_KEY] = id
+        end
+
+        def reset
+          Thread.current[PROFILE_ID_KEY] = nil
+        end
+      end
     end
 
     class << self
       def current
-        Current.id ||= SecureRandom.hex
         Current.id
       end
+
+      def current=(id)
+        Current.id = id
+      end
     end
   end
 end

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/request_parameters.rb

@@ -33,7 +33,7 @@ module AppProfiler
 
       return false if backend != AppProfiler::Backend::StackprofBackend.name && !AppProfiler.vernier_supported?
 
-      if AppProfiler.vernier_supported? && backend == AppProfiler::Backend::VernierBackend.name &&
+      if AppProfiler.vernier_supported? && backend == AppProfiler::VernierProfile::BACKEND_NAME &&
           !AppProfiler::Backend::VernierBackend::AVAILABLE_MODES.include?(mode.to_sym)
         AppProfiler.logger.info("[AppProfiler] unsupported profiling mode=#{mode} for backend #{backend}")
         return false

data/lib/app_profiler/stackprof_profile.rb

@@ -4,6 +4,17 @@ module AppProfiler
   class StackprofProfile < BaseProfile
     FILE_EXTENSION = ".stackprof.json"
 
+    class << self
+      def backend_name
+        Backend::StackprofBackend.name.to_s
+      end
+    end
+
+    def initialize(data, id: nil, context: nil)
+      data[:metadata] ||= {}
+      super(data, id: id, context: context)
+    end
+
     def mode
       @data[:mode]
     end

data/lib/app_profiler/vernier_profile.rb

@@ -3,6 +3,19 @@
 module AppProfiler
   class VernierProfile < BaseProfile
     FILE_EXTENSION = ".vernier.json"
+    BACKEND_NAME = :vernier
+
+    class << self
+      def backend_name
+        # cannot reference Backend::VernierBackend because of different ruby versions we have to support
+        BACKEND_NAME.to_s
+      end
+    end
+
+    def initialize(data, id: nil, context: nil)
+      data[:meta] ||= {}
+      super(data, id: id, context: context)
+    end
 
     def mode
       @data[:meta][:mode]

data/lib/app_profiler/version.rb

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

data/lib/app_profiler.rb

@@ -7,6 +7,9 @@ require "logger"
 require "app_profiler/version"
 
 module AppProfiler
+  PROFILE_ID_METADATA_KEY = :profile_id
+  PROFILE_BACKEND_METADATA_KEY = :profiler
+
   class ConfigurationError < StandardError
   end
 
@@ -73,6 +76,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
@@ -90,6 +95,7 @@ module AppProfiler
       yield
     ensure
       self.backend = original_backend if backend
+      ProfileId::Current.reset
     end
 
     def start(*args, backend: nil, **kwargs)
@@ -158,9 +164,18 @@ 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::Backend::VernierBackend.name
+          backend_name&.to_sym == AppProfiler::VernierProfile::BACKEND_NAME
         AppProfiler::Backend::VernierBackend
       elsif backend_name&.to_sym == AppProfiler::Backend::StackprofBackend.name
         AppProfiler::Backend::StackprofBackend
@@ -174,7 +189,7 @@ module AppProfiler
     end
 
     def vernier_supported?
-      RUBY_VERSION >= "3.2.1" && defined?(AppProfiler::Backend::VernierBackend.name)
+      RUBY_VERSION >= "3.2.1" && defined?(AppProfiler::VernierProfile::BACKEND_NAME)
     end
 
     def profile_header=(profile_header)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -12,7 +12,7 @@ authors:
 - Scott Francis
 bindir: bin
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-02-24 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