opentelemetry-instrumentation-rack 0.25.0 → 0.27.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rack
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.27.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 2025-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -30,196 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.1
+        version: 0.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.1
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-sdk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-sdk-experimental
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-test-helpers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !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-mocks
-  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: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.66.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.66.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.22.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.24.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.24.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.23.0
 description: Rack instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -235,8 +53,12 @@ files:
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/rack.rb
 - lib/opentelemetry/instrumentation/rack/instrumentation.rb
-- lib/opentelemetry/instrumentation/rack/middlewares/event_handler.rb
-- lib/opentelemetry/instrumentation/rack/middlewares/tracer_middleware.rb
+- lib/opentelemetry/instrumentation/rack/middlewares/dup/event_handler.rb
+- lib/opentelemetry/instrumentation/rack/middlewares/dup/tracer_middleware.rb
+- lib/opentelemetry/instrumentation/rack/middlewares/old/event_handler.rb
+- lib/opentelemetry/instrumentation/rack/middlewares/old/tracer_middleware.rb
+- lib/opentelemetry/instrumentation/rack/middlewares/stable/event_handler.rb
+- lib/opentelemetry/instrumentation/rack/middlewares/stable/tracer_middleware.rb
 - lib/opentelemetry/instrumentation/rack/util.rb
 - lib/opentelemetry/instrumentation/rack/util/queue_time.rb
 - lib/opentelemetry/instrumentation/rack/version.rb
@@ -244,11 +66,11 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-rack/0.25.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-rack/0.27.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/rack
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-rack/0.25.0
-post_install_message: 
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-rack/0.27.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -256,15 +78,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Rack instrumentation for the OpenTelemetry framework
 test_files: []

data/lib/opentelemetry/instrumentation/rack/middlewares/event_handler.rb

@@ -1,268 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-require_relative '../util'
-require 'opentelemetry/trace/status'
-
-module OpenTelemetry
-  module Instrumentation
-    module Rack
-      module Middlewares
-        # OTel Rack Event Handler
-        #
-        # This seeds the root context for this service with the server span as the `current_span`
-        # allowing for callers later in the stack to reference it using {OpenTelemetry::Trace.current_span}
-        #
-        # It also registers the server span in a context dedicated to this instrumentation that users may look up
-        # using {OpenTelemetry::Instrumentation::Rack.current_span}, which makes it possible for users to mutate the span,
-        # e.g. add events or update the span name like in the {ActionPack} instrumentation.
-        #
-        # @example Rack App Using BodyProxy
-        #   GLOBAL_LOGGER = Logger.new($stderr)
-        #   APP_TRACER = OpenTelemetry.tracer_provider.tracer('my-app', '1.0.0')
-        #
-        #   Rack::Builder.new do
-        #     use Rack::Events, [OpenTelemetry::Instrumentation::Rack::Middlewares::EventHandler.new]
-        #     run lambda { |_arg|
-        #       APP_TRACER.in_span('hello-world') do |_span|
-        #         body = Rack::BodyProxy.new(['hello world!']) do
-        #           rack_span = OpenTelemetry::Instrumentation::Rack.current_span
-        #           GLOBAL_LOGGER.info("otel.trace_id=#{rack_span.context.hex_trace_id} otel.span_id=#{rack_span.context.hex_span_id}")
-        #         end
-        #         [200, { 'Content-Type' => 'text/plain' }, body]
-        #       end
-        #     }
-        #   end
-        #
-        # @see Rack::Events
-        # @see OpenTelemetry::Instrumentation::Rack.current_span
-        class EventHandler
-          include ::Rack::Events::Abstract
-
-          OTEL_TOKEN_AND_SPAN = 'otel.rack.token_and_span'
-
-          # Creates a server span for this current request using the incoming parent context
-          # and registers them as the {current_span}
-          #
-          # @param [Rack::Request] The current HTTP request
-          # @param [Rack::Response] This is nil in practice
-          # @return [void]
-          def on_start(request, _)
-            parent_context = if untraced_request?(request.env)
-                               extract_remote_context(request, OpenTelemetry::Common::Utilities.untraced)
-                             else
-                               extract_remote_context(request)
-                             end
-
-            span = create_span(parent_context, request)
-            span_ctx = OpenTelemetry::Trace.context_with_span(span, parent_context: parent_context)
-            rack_ctx = OpenTelemetry::Instrumentation::Rack.context_with_span(span, parent_context: span_ctx)
-            request.env[OTEL_TOKEN_AND_SPAN] = [OpenTelemetry::Context.attach(rack_ctx), span]
-          rescue StandardError => e
-            OpenTelemetry.handle_error(exception: e)
-          end
-
-          # Optionally adds debugging response headers injected from {response_propagators}
-          #
-          # @param [Rack::Request] The current HTTP request
-          # @param [Rack::Response] This current HTTP response
-          # @return [void]
-          def on_commit(request, response)
-            span = OpenTelemetry::Instrumentation::Rack.current_span
-            return unless span.recording?
-
-            response_propagators&.each do |propagator|
-              propagator.inject(response.headers)
-            rescue StandardError => e
-              OpenTelemetry.handle_error(message: 'Unable to inject response propagation headers', exception: e)
-            end
-          rescue StandardError => e
-            OpenTelemetry.handle_error(exception: e)
-          end
-
-          # Records Unexpected Exceptions on the Rack span and set the Span Status to Error
-          #
-          # @note does nothing if the span is a non-recording span
-          # @param [Rack::Request] The current HTTP request
-          # @param [Rack::Response] The current HTTP response
-          # @param [Exception] An unxpected error raised by the application
-          def on_error(request, _, error)
-            span = OpenTelemetry::Instrumentation::Rack.current_span
-            return unless span.recording?
-
-            span.record_exception(error)
-            span.status = OpenTelemetry::Trace::Status.error(error.class.name)
-          rescue StandardError => e
-            OpenTelemetry.handle_error(exception: e)
-          end
-
-          # Finishes the span making it eligible to be exported and cleans up existing contexts
-          #
-          # @note does nothing if the span is a non-recording span
-          # @param [Rack::Request] The current HTTP request
-          # @param [Rack::Response] The current HTTP response
-          def on_finish(request, response)
-            span = OpenTelemetry::Instrumentation::Rack.current_span
-            return unless span.recording?
-
-            add_response_attributes(span, response) if response
-          rescue StandardError => e
-            OpenTelemetry.handle_error(exception: e)
-          ensure
-            detach_context(request)
-          end
-
-          private
-
-          EMPTY_HASH = {}.freeze
-          def extract_request_headers(env)
-            return EMPTY_HASH if allowed_request_headers.empty?
-
-            allowed_request_headers.each_with_object({}) do |(key, value), result|
-              result[value] = env[key] if env.key?(key)
-            end
-          end
-
-          def extract_response_attributes(response)
-            attributes = { 'http.status_code' => response.status.to_i }
-            attributes.merge!(extract_response_headers(response.headers))
-            attributes
-          end
-
-          def extract_response_headers(headers)
-            return EMPTY_HASH if allowed_response_headers.empty?
-
-            allowed_response_headers.each_with_object({}) do |(key, value), result|
-              if headers.key?(key)
-                result[value] = headers[key]
-              else
-                # do case-insensitive match:
-                headers.each do |k, v|
-                  if k.upcase == key
-                    result[value] = v
-                    break
-                  end
-                end
-              end
-            end
-          end
-
-          def untraced_request?(env)
-            return true if untraced_endpoints.include?(env['PATH_INFO'])
-            return true if untraced_requests&.call(env)
-
-            false
-          end
-
-          # https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-http.md#name
-          #
-          # recommendation: span.name(s) should be low-cardinality (e.g.,
-          # strip off query param value, keep param name)
-          #
-          # see http://github.com/open-telemetry/opentelemetry-specification/pull/416/files
-          def create_request_span_name(request)
-            # NOTE: dd-trace-rb has implemented 'quantization' (which lowers url cardinality)
-            #       see Datadog::Quantization::HTTP.url
-
-            if (implementation = url_quantization)
-              request_uri_or_path_info = request.env['REQUEST_URI'] || request.path_info
-              implementation.call(request_uri_or_path_info, request.env)
-            else
-              "HTTP #{request.request_method}"
-            end
-          end
-
-          def extract_remote_context(request, context = Context.current)
-            OpenTelemetry.propagation.extract(
-              request.env,
-              context: context,
-              getter: OpenTelemetry::Common::Propagation.rack_env_getter
-            )
-          end
-
-          def request_span_attributes(env)
-            attributes = {
-              'http.method' => env['REQUEST_METHOD'],
-              'http.host' => env['HTTP_HOST'] || 'unknown',
-              'http.scheme' => env['rack.url_scheme'],
-              'http.target' => env['QUERY_STRING'].empty? ? env['PATH_INFO'] : "#{env['PATH_INFO']}?#{env['QUERY_STRING']}"
-            }
-
-            attributes['http.user_agent'] = env['HTTP_USER_AGENT'] if env['HTTP_USER_AGENT']
-            attributes.merge!(extract_request_headers(env))
-            attributes
-          end
-
-          def detach_context(request)
-            return nil unless request.env[OTEL_TOKEN_AND_SPAN]
-
-            token, span = request.env[OTEL_TOKEN_AND_SPAN]
-            span.finish
-            OpenTelemetry::Context.detach(token)
-          rescue StandardError => e
-            OpenTelemetry.handle_error(exception: e)
-          end
-
-          def add_response_attributes(span, response)
-            span.status = OpenTelemetry::Trace::Status.error if response.server_error?
-            attributes = extract_response_attributes(response)
-            span.add_attributes(attributes)
-          rescue StandardError => e
-            OpenTelemetry.handle_error(exception: e)
-          end
-
-          def record_frontend_span?
-            config[:record_frontend_span] == true
-          end
-
-          def untraced_endpoints
-            config[:untraced_endpoints]
-          end
-
-          def untraced_requests
-            config[:untraced_requests]
-          end
-
-          def url_quantization
-            config[:url_quantization]
-          end
-
-          def response_propagators
-            config[:response_propagators]
-          end
-
-          def allowed_request_headers
-            config[:allowed_rack_request_headers]
-          end
-
-          def allowed_response_headers
-            config[:allowed_rack_response_headers]
-          end
-
-          def tracer
-            OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.tracer
-          end
-
-          def config
-            OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.config
-          end
-
-          def create_span(parent_context, request)
-            span = tracer.start_span(
-              create_request_span_name(request),
-              with_parent: parent_context,
-              kind: :server,
-              attributes: request_span_attributes(request.env)
-            )
-            request_start_time = OpenTelemetry::Instrumentation::Rack::Util::QueueTime.get_request_start(request.env)
-            span.add_event('http.proxy.request.started', timestamp: request_start_time) unless request_start_time.nil?
-            span
-          end
-        end
-      end
-    end
-  end
-end