opentelemetry-instrumentation-rack 0.13.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dfb36f720e7c29d75aa43e7704bcdcbc48f7d372c26ac8375369cab8488fdf1
-  data.tar.gz: 866c30087a8a130be2e77ffdbc93c788afa6f1710d9e1c777721b8ecf2ffc0e9
+  metadata.gz: 045d523393ba587000900fa6fe04d53639bbc893745795ae71b95a8e295fa33f
+  data.tar.gz: c56bdb588db187f92fc59038b6a7f612d9e38fe17a2d9544f3c04e9cc2a78551
 SHA512:
-  metadata.gz: 9aa4b46b9fad82880a7bf4dba1d537cab64d9bd4743fb6bf6d6c71aed9c6a4d960bf3cd036e170d6bc0ea826b73a0342dcf4204931f406e03d45406b10dc0294
-  data.tar.gz: a03e4a30b5e2c82047cbbd8b490e06dbe92e792b7f8d8c0481c4ed45397768e7e924520ec660205cb28a4064748e40e4e61ddd584d48de21bcf2e276a170ba97
+  metadata.gz: 235196039e3f220a14563489952c810d2acface20997498213a8bb57573307c9a4cf1cbce1cb38da22e3073f56ec53838f9c1bf2eae053428779f6e2274345e3
+  data.tar.gz: 66431cf36f90e5ed006d2a12cd396be2d30249562372cbc5bfdf5b97748f61afba051e765f99505474d7d074abcf117df84b9d7ec5cd9aa6fad143fbdd1ac46a

data/CHANGELOG.md

@@ -1,8 +1,37 @@
 # Release History: opentelemetry-instrumentation-rack
 
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+* FIXED: Removed http.status_text attribute #750
+
+### v0.17.0 / 2021-04-22
+
+* (No significant changes)
+
+### v0.16.0 / 2021-03-17
+
+* BREAKING CHANGE: Pass env to url quantization rack config to allow more flexibility
+
+* ADDED: Pass env to url quantization rack config to allow more flexibility
+* ADDED: Add rack instrumentation config option to accept callable to filter requests to trace
+* FIXED: Example scripts now reference local common lib
+* DOCS: Replace Gitter with GitHub Discussions
+
+### v0.15.0 / 2021-02-18
+
+* ADDED: Add instrumentation config validation
+
+### v0.14.0 / 2021-02-03
+
+* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators
+
+* ADDED: Replace getter and setter callables and remove rack specific propagators
+* ADDED: Add untraced endpoints config to rack middleware
+
 ### v0.13.0 / 2021-01-29
 
-* FIXED: Only include user agent when present 
+* FIXED: Only include user agent when present
 
 ### v0.12.0 / 2020-12-24
 
@@ -10,11 +39,11 @@
 
 ### v0.11.0 / 2020-12-11
 
-* FIXED: Copyright comments to not reference year 
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.1 / 2020-12-09
 
-* FIXED: Rack current_span 
+* FIXED: Rack current_span
 
 ### v0.10.0 / 2020-12-03
 
@@ -22,24 +51,24 @@
 
 ### v0.9.0 / 2020-11-27
 
-* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+* BREAKING CHANGE: Add timeout for force_flush and shutdown
 
-* ADDED: Instrument rails 
-* ADDED: Add timeout for force_flush and shutdown 
+* ADDED: Instrument rails
+* ADDED: Add timeout for force_flush and shutdown
 
 ### v0.8.0 / 2020-10-27
 
-* BREAKING CHANGE: Move context/span methods to Trace module 
-* BREAKING CHANGE: Remove 'canonical' from status codes 
+* BREAKING CHANGE: Move context/span methods to Trace module
+* BREAKING CHANGE: Remove 'canonical' from status codes
 
-* FIXED: Move context/span methods to Trace module 
-* FIXED: Remove 'canonical' from status codes 
+* FIXED: Move context/span methods to Trace module
+* FIXED: Remove 'canonical' from status codes
 
 ### v0.7.0 / 2020-10-07
 
-* FIXED: Remove superfluous file from Rack gem 
-* DOCS: Added README for Rack Instrumentation 
-* DOCS: Standardize toplevel docs structure and readme 
+* FIXED: Remove superfluous file from Rack gem
+* DOCS: Added README for Rack Instrumentation
+* DOCS: Standardize toplevel docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 

data/README.md

@@ -38,7 +38,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here](
 
 The `opentelemetry-instrumentation-rack` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -50,4 +50,4 @@ The `opentelemetry-instrumentation-rack` gem is distributed under the Apache 2.0
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/instrumentation/rack.rb

@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation

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

@@ -22,6 +22,15 @@ module OpenTelemetry
           defined?(::Rack)
         end
 
+        option :allowed_request_headers,  default: [],    validate: :array
+        option :allowed_response_headers, default: [],    validate: :array
+        option :application,              default: nil,   validate: :callable
+        option :record_frontend_span,     default: false, validate: :boolean
+        option :retain_middleware_names,  default: false, validate: :boolean
+        option :untraced_endpoints,       default: [],    validate: :array
+        option :url_quantization,         default: nil,   validate: :callable
+        option :untraced_requests,        default: nil,   validate: :callable
+
         private
 
         def require_dependencies

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

@@ -49,16 +49,25 @@ module OpenTelemetry
 
           def initialize(app)
             @app = app
+            @untraced_endpoints = config[:untraced_endpoints]
           end
 
-          def call(env) # rubocop:disable Metrics/AbcSize
+          def call(env) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+            if untraced_request?(env)
+              OpenTelemetry::Common::Utilities.untraced do
+                return @app.call(env)
+              end
+            end
             original_env = env.dup
-            extracted_context = OpenTelemetry.propagation.http.extract(env)
+            extracted_context = OpenTelemetry.propagation.extract(
+              env,
+              getter: OpenTelemetry::Context::Propagation.rack_env_getter
+            )
             frontend_context = create_frontend_span(env, extracted_context)
 
             # restore extracted context in this process:
             OpenTelemetry::Context.with_current(frontend_context || extracted_context) do
-              request_span_name = create_request_span_name(env['REQUEST_URI'] || original_env['PATH_INFO'])
+              request_span_name = create_request_span_name(env['REQUEST_URI'] || original_env['PATH_INFO'], env)
               request_span_kind = frontend_context.nil? ? :server : :internal
               tracer.in_span(request_span_name,
                              attributes: request_span_attributes(env: env),
@@ -76,6 +85,13 @@ module OpenTelemetry
 
           private
 
+          def untraced_request?(env)
+            return true if @untraced_endpoints.include?(env['PATH_INFO'])
+            return true if config[:untraced_requests]&.call(env)
+
+            false
+          end
+
           # return Context with the frontend span as the current span
           def create_frontend_span(env, extracted_context)
             request_start_time = OpenTelemetry::Instrumentation::Rack::Util::QueueTime.get_request_start(env)
@@ -125,12 +141,12 @@ module OpenTelemetry
           # 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_uri_or_path_info)
+          def create_request_span_name(request_uri_or_path_info, env)
             # NOTE: dd-trace-rb has implemented 'quantization' (which lowers url cardinality)
             #       see Datadog::Quantization::HTTP.url
 
             if (implementation = config[:url_quantization])
-              implementation.call(request_uri_or_path_info)
+              implementation.call(request_uri_or_path_info, env)
             else
               request_uri_or_path_info
             end
@@ -143,7 +159,6 @@ module OpenTelemetry
             # NOTE: if data is available, it would be good to do this:
             # set_attribute('http.route', ...
             # e.g., "/users/:userID?
-            span.set_attribute('http.status_text', ::Rack::Utils::HTTP_STATUS_CODES[status])
 
             allowed_response_headers(headers).each { |k, v| span.set_attribute(k, v) }
           end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rack
-      VERSION = '0.13.0'
+      VERSION = '0.18.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rack
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.18.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -214,10 +228,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-rack/v0.13.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-rack/v0.18.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/rack
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-rack/v0.13.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-rack/v0.18.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -233,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Rack instrumentation for the OpenTelemetry framework