opentelemetry-instrumentation-rack 0.10.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c079f65d4e53d8d3089785f6c6e6cfdb71ddc0236d3b82f2b6f344b762b283f
-  data.tar.gz: c83a43d564760aeaba8e7f0870941a94cc6afcd387ca5e2bd1caec1e3496b77f
+  metadata.gz: ad21d239ad4a5008e97531f80a7e66bc4b994b9723257921a5762b4141423099
+  data.tar.gz: 415138c23cdd98cc069a19ebb0aefa6d5be613517b7bf7ab9392a641cae503bd
 SHA512:
-  metadata.gz: 01fe4134ce9315800e6e448398d1bd4c27c75b32032d64a01d3423201b6939ebdc99f284ccdfddc98aa711d17689dd616be30e81978caa53ca1177ef3c924b4d
-  data.tar.gz: efbd8de523f9ad3406c4fc8871c440181e782f616fb6ca924ef216f55b0ca046ea61639f662377b950931cd204ed25b6a13220210db227d9bfb845e6e9d1331e
+  metadata.gz: 3dee2f0c3eb4f16d4c23e0d15d33d287b73c3a1767fa312583f1165d2f2b704cfd9a279f3309b06604a4cf364036f7dbd0bd0465c8ba0beb27c4db18f8bca918
+  data.tar.gz: 64174578aeb8e18bdffc0cd7a92074708d9cdba56713b96d4a94e058a9e5399a26033bca846945c96d6d509c5dcfbbe3ba5c1f4c941086269a1855b2e4314ccc

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release History: opentelemetry-instrumentation-rack
 
+### 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 
+
+### v0.12.0 / 2020-12-24
+
+* (No significant changes)
+
+### v0.11.0 / 2020-12-11
+
+* FIXED: Copyright comments to not reference year 
+
 ### v0.10.1 / 2020-12-09
 
 * FIXED: Rack current_span 

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -32,7 +32,7 @@ end
 
 ## Examples
 
-Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/rack/example/trace_demonstration.rb)
+Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/rack/example/trace_demonstration.rb)
 
 ## How can I get involved?
 
@@ -47,7 +47,7 @@ The `opentelemetry-instrumentation-rack` gem is distributed under the Apache 2.0
 [rack-home]: https://github.com/rack/rack
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
+[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

data/lib/opentelemetry-instrumentation-rack.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/rack.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -22,6 +22,14 @@ 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
+
         private
 
         def require_dependencies

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -49,11 +49,20 @@ 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:
@@ -76,6 +85,10 @@ module OpenTelemetry
 
           private
 
+          def untraced_request?(env)
+            @untraced_endpoints.include?(env['PATH_INFO'])
+          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)
@@ -101,13 +114,14 @@ module OpenTelemetry
           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' => fullpath(env),
-              'http.user_agent' => env['HTTP_USER_AGENT']
-            }.merge(allowed_request_headers(env))
+              'http.target' => fullpath(env)
+            }
+            attributes['http.user_agent'] = env['HTTP_USER_AGENT'] if env['HTTP_USER_AGENT']
+            attributes.merge(allowed_request_headers(env))
           end
 
           # e.g., "/webshop/articles/4?s=1":

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 module OpenTelemetry
   module Instrumentation
     module Rack
-      VERSION = '0.10.1'
+      VERSION = '0.15.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rack
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.15.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -214,10 +214,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.10.1/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation/rack
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-rack/v0.15.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.10.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-rack/v0.15.0
 post_install_message: 
 rdoc_options: []
 require_paths: