opentelemetry-instrumentation-rack 0.12.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80a09baaed46a076fed44997cef625ed302dde2d85c89101013cdab648814dbf
-  data.tar.gz: 3e3280f4178e2b18e4058b11d2699a15cd49f87f142f7e3e7bb3276d92490ccb
+  metadata.gz: 7fe65a307ae87d65fca76bc0680ff2c4cfdfa18d801cfa086a5a2fc4604e8d84
+  data.tar.gz: f76e07a68383ae21f66481e5a1cfc87861d880c4223b449295230c022958e3e4
 SHA512:
-  metadata.gz: '08737fba03d92a07aa3e036533a2f743a2ebe0b2d6d64b408be44da226d8925ad1de450df8c141f86afbc78338503ab4126d584b2f05d781f0496eae58e3b326'
-  data.tar.gz: 1a05a5aefc6b5d7e8a4e812a4477880e00523813240e8e75ed33500e23df1c3fbf14d3b45374d4cbabaad28da4f990ae10d9cc4a24694c26c3bf20e1ab335f63
+  metadata.gz: a0346fad3e253c31dd7accb5d5c50f5eb5c4bf1d2094085f8027d4c26e4193d54ed07c3c9ea642a16d614206f0909c5fbb016f4603049f6b8ccd4fc76734b4cb
+  data.tar.gz: 32cc47e8801ead256d770ccf485cc46348c576afd38c5b21342a09615de5796ff647edfb0da3dfa6e1e0356f8605eb563c1dbb7710cc7e78d6136434e1e458e7

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Release History: opentelemetry-instrumentation-rack
 
+### 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 
+
 ### v0.12.0 / 2020-12-24
 
 * (No significant changes)

data/README.md

@@ -32,13 +32,13 @@ 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?
 
 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
 
@@ -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
+[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)
@@ -101,13 +117,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":
@@ -124,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

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rack
-      VERSION = '0.12.0'
+      VERSION = '0.17.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rack
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-24 00:00:00.000000000 Z
+date: 2021-04-23 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.12.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   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.12.0/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.17.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.12.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-rack/v0.17.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