opentelemetry-instrumentation-rack 0.23.4 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 980a25e800842fabeb9f244dd99c6adec79247c38804038a429ccae176be334d
-  data.tar.gz: 1db80b2226fbaa9240b4080376192bc74b929fdcde865963b4a272f66a33c399
+  metadata.gz: d11de07129115be6b9af9347c3893327ea18c58b959fe761c86f1eabc94402eb
+  data.tar.gz: 27cf79e4ab1bdd60c76a90824da839948deab41ee9d9cc8eb5b4d151cb1abc2e
 SHA512:
-  metadata.gz: b46b78d3ce13c4f36981f8d8b890f91a3720d5041931e8d30e9d558586a156d41ccda9d292a2fe5fbfb8f6728a32b6b3120bcd498dbd7abca21d03fd9b9d7b14
-  data.tar.gz: 5cfdea9ffcf0c0b019e4806ae4cf8d524e45d1caef0c5d6b8ba1068857206fe2b81a2219843757cae255da2067223b05b9acec59ff8acaa6b10c3aeace1c0d18
+  metadata.gz: 3c6330ea8a52a55c20e7b62cb6864c784993b7b3a8209ad41812904992d003e8c38d6f9c62096d3cf25c343fea0abf722c5cf978ccc2a826cefbbb4fabd208a5
+  data.tar.gz: 87f30078bd1ee4a8c595048754210ecf82d65f7a2d2eb3738f82138a3631faa3dc8108de9beb0ae8840a1fbf7f546fd112a8c03b435bef078315f79e0d6a82f2

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # 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)
+
 ### v0.23.4 / 2023-08-03
 
 * FIXED: Remove inline linter rules

data/README.md

@@ -12,6 +12,19 @@ gem install opentelemetry-instrumentation-rack
 
 Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-rack` in your `Gemfile`.
 
+### Version Compatibility
+
+Older versions of Rack are not supported by the latest version of this instrumentation. If you are using an older version of Rack and need an earlier version of this instrumentation, then consider installing and pinning the compatible gem version, e.g.:
+
+```console
+gem opentelemetry-instrumentation-rack, "<version>"
+```
+
+| Rack Version | Instrumentation Version |
+| ------------ | ----------------------- |
+| `< 2.0`      | `= 0.22.1`              |
+| `>= 2.0`     | `~> 0.23`               |
+
 ## Usage
 
 To use the instrumentation, call `use` with the name of the instrumentation:
@@ -29,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)
@@ -150,7 +152,7 @@ module OpenTelemetry
           end
 
           def set_attributes_after_request(span, status, headers, _response)
-            span.status = OpenTelemetry::Trace::Status.error unless (100..499).include?(status.to_i)
+            span.status = OpenTelemetry::Trace::Status.error unless (100..499).cover?(status.to_i)
             span.set_attribute('http.status_code', status)
 
             # NOTE: if data is available, it would be good to do this:

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rack
-      VERSION = '0.23.4'
+      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.4
+  version: 0.24.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-03 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -198,70 +198,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.55.1
+        version: 1.59.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.55.1
+        version: 1.59.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 1.19.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 1.19.1
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.19'
 - !ruby/object:Gem::Dependency
-  name: yard-doctest
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: '0.9'
 description: Rack instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -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.4/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.4
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-rack/0.24.0
 post_install_message: 
 rdoc_options: []
 require_paths: