opentelemetry-instrumentation-rack 0.23.5 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c034c06a57be3531e53405a03d31b451e5ee96b5d01aa1e431f49114f82b84a9
-  data.tar.gz: 4bdf91f7a3f010d91805fb024d9b4c5393c7c741e11d535daa223a062146518f
+  metadata.gz: d11de07129115be6b9af9347c3893327ea18c58b959fe761c86f1eabc94402eb
+  data.tar.gz: 27cf79e4ab1bdd60c76a90824da839948deab41ee9d9cc8eb5b4d151cb1abc2e
 SHA512:
-  metadata.gz: d1685546ce8ab8568f591de26bc63d9bb2a843a98218e5541061072394e0f78f9efc100dbf49e52ddd61bd9e048f35a9e7028ef501c106408f236627d6f7b886
-  data.tar.gz: 4cccff1a775455e9ce5f2339d15cf23553d300f45b3c7d75ec06c2d42b002aca5b942eb8dcdbaf5c2a4d3899fa981add32e83587679af935b55811b691ef1431
+  metadata.gz: 3c6330ea8a52a55c20e7b62cb6864c784993b7b3a8209ad41812904992d003e8c38d6f9c62096d3cf25c343fea0abf722c5cf978ccc2a826cefbbb4fabd208a5
+  data.tar.gz: 87f30078bd1ee4a8c595048754210ecf82d65f7a2d2eb3738f82138a3631faa3dc8108de9beb0ae8840a1fbf7f546fd112a8c03b435bef078315f79e0d6a82f2

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History: opentelemetry-instrumentation-rack
 
+### v0.24.0 / 2024-01-06
+
+* BREAKING CHANGE: Use Rack Events By Default
+
+* ADDED: Use Rack Events By Default
+* FIXED: Backport Rack proxy event to middleware
+
 ### v0.23.5 / 2023-11-23
 
 * CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)

data/README.md

@@ -42,6 +42,23 @@ OpenTelemetry::SDK.configure do |c|
   c.use_all
 end
 ```
+
+## Rack Middleware vs Rack Events
+
+Since `v0.24.0`, this instrumentation uses `Rake::Events` as opposed to `Middleware` to support Requests that use Buffered Response Bodies.
+
+If your application does not support `Rack::Events`, you may disable it by setting `use_rack_events: false`, e.g.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Rack', use_rack_events: false
+end
+```
+
+This will switch to using `Rack::Middleware` by default in dependent instrumentations.
+
+See [#342](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/342) for more details.
+
 ## Controlling span name cardinality
 
 By default we will set the rack span name to match the format "HTTP #{method}" (ie. HTTP GET). There are different ways to control span names with this instrumentation.

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

@@ -28,8 +28,8 @@ module OpenTelemetry
         option :url_quantization,         default: nil,   validate: :callable
         option :untraced_requests,        default: nil,   validate: :callable
         option :response_propagators,     default: [],    validate: :array
-        # This option is only valid for applicaitons using Rack 2.0 or greater
-        option :use_rack_events,          default: false, validate: :boolean
+        # This option is only valid for applications using Rack 2.0 or greater
+        option :use_rack_events,          default: true, validate: :boolean
 
         # Temporary Helper for Sinatra and ActionPack middleware to use during installation
         #

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

@@ -90,7 +90,7 @@ module OpenTelemetry
             return unless span.recording?
 
             span.record_exception(error)
-            span.status = OpenTelemetry::Trace::Status.error
+            span.status = OpenTelemetry::Trace::Status.error(error.class.name)
           rescue StandardError => e
             OpenTelemetry.handle_error(exception: e)
           end

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

@@ -77,6 +77,8 @@ module OpenTelemetry
               tracer.in_span(request_span_name,
                              attributes: request_span_attributes(env: env),
                              kind: request_span_kind) do |request_span|
+                request_start_time = OpenTelemetry::Instrumentation::Rack::Util::QueueTime.get_request_start(env)
+                request_span.add_event('http.proxy.request.started', timestamp: request_start_time) unless request_start_time.nil?
                 OpenTelemetry::Instrumentation::Rack.with_span(request_span) do
                   @app.call(env).tap do |status, headers, response|
                     set_attributes_after_request(request_span, status, headers, response)

data/lib/opentelemetry/instrumentation/rack/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rack
-      VERSION = '0.23.5'
+      VERSION = '0.24.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rack
 version: !ruby/object:Gem::Version
-  version: 0.23.5
+  version: 0.24.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.59.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.59.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -286,10 +286,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-rack/0.23.5/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-rack/0.24.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.23.5
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-rack/0.24.0
 post_install_message: 
 rdoc_options: []
 require_paths: