opentelemetry-instrumentation-rack 0.5.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ab783202341e39da5870970951031a6ee1fd822dea984df9e99f16e00654358
-  data.tar.gz: b4280521025fd79d81c0d39f90a73b5ad1a7e03be1a043778c745bd316e969b7
+  metadata.gz: bfabed483a8bb86717b6f1c05e95025753f9f92a73eb075118ddb5844c99f465
+  data.tar.gz: 30b6b82c089d5bde425438d78d11a11c55a35ba60e6cbde09f8eea1ff6d5275e
 SHA512:
-  metadata.gz: 74133b50c5cf99b31a894607a789cdf9983ff5940c3eae4881438d8afffd169301f39b342d56a8ac871194a7380838dd30776d65613585d2f044246dbc0bfb40
-  data.tar.gz: a866d4482c26cac32be68bb32c0aef9cca86519676f3b1375e9c3c0085ed540895da56bf6dae80a4016350226bf3a5d8fa02ac71f87ca69a554db76441000931
+  metadata.gz: c2117ad1a1fb1eb3967aebbd21406bd978558fc7d6f67bcd7af28ae04178df4f3bfa046fead48a7106172c4290da75e341030df82cbb0e0e269c79e266d64b98
+  data.tar.gz: 2a378c7ca600d1bb633d7d421e3b369061fc1ae030e1f4f0f6a733b4aedbc23568f2a9ea6d83fcc6f1574e3dc3498df878b55f8bc2f70cb0e4badb0866e95c4b

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Rack Instrumentation
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/instrumentation/**/*.rb
+./lib/opentelemetry/instrumentation.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Release History: opentelemetry-instrumentation-rack
+
+### v0.10.0 / 2020-12-03
+
+* (No significant changes)
+
+### v0.9.0 / 2020-11-27
+
+* BREAKING CHANGE: 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 
+
+* 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 
+
+### v0.6.0 / 2020-09-10
+
+* (No significant changes)

data/README.md

@@ -0,0 +1,53 @@
+# OpenTelemetry Rack Instrumentation
+
+The Rack instrumentation is a community-maintained instrumentation for the [Rack][rack-home] web server interface.
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-rack
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-rack` in your `Gemfile`.
+
+## Usage
+
+To use the instrumentation, call `use` with the name of the instrumentation:
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Rack'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+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)
+
+## 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].
+
+## License
+
+The `opentelemetry-instrumentation-rack` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[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
+[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.rb

@@ -4,9 +4,15 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
 module OpenTelemetry
   # Instrumentation should be able to handle the case when the library is not installed on a user's system.
-  module Snstrumentations
+  module Instrumentation
   end
 end
 

data/lib/opentelemetry/instrumentation/rack.rb

@@ -10,6 +10,40 @@ module OpenTelemetry
   module Instrumentation
     # Contains the OpenTelemetry instrumentation for the Rack gem
     module Rack
+      extend self
+
+      CURRENT_SPAN_KEY = Context.create_key('current-span')
+
+      private_constant :CURRENT_SPAN_KEY
+
+      # Returns the current span from the current or provided context
+      #
+      # @param [optional Context] context The context to lookup the current
+      #   {Span} from. Defaults to Context.current
+      def current_span(context = nil)
+        context ||= Context.current
+        context.value(CURRENT_SPAN_KEY) || Span::INVALID
+      end
+
+      # Returns a context containing the span, derived from the optional parent
+      # context, or the current context if one was not provided.
+      #
+      # @param [optional Context] context The context to use as the parent for
+      #   the returned context
+      def context_with_span(span, parent_context: Context.current)
+        parent_context.set_value(CURRENT_SPAN_KEY, span)
+      end
+
+      # Activates/deactivates the Span within the current Context, which makes the "current span"
+      # available implicitly.
+      #
+      # On exit, the Span that was active before calling this method will be reactivated.
+      #
+      # @param [Span] span the span to activate
+      # @yield [span, context] yields span and a context containing the span to the block.
+      def with_span(span)
+        Context.with_value(CURRENT_SPAN_KEY, span) { |c, s| yield s, c }
+      end
     end
   end
 end

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

@@ -51,7 +51,7 @@ module OpenTelemetry
             @app = app
           end
 
-          def call(env)
+          def call(env) # rubocop:disable Metrics/AbcSize
             original_env = env.dup
             extracted_context = OpenTelemetry.propagation.http.extract(env)
             frontend_context = create_frontend_span(env, extracted_context)
@@ -63,8 +63,10 @@ module OpenTelemetry
               tracer.in_span(request_span_name,
                              attributes: request_span_attributes(env: env),
                              kind: request_span_kind) do |request_span|
-                @app.call(env).tap do |status, headers, response|
-                  set_attributes_after_request(request_span, status, headers, response)
+                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)
+                  end
                 end
               end
             end
@@ -81,21 +83,17 @@ module OpenTelemetry
             return unless config[:record_frontend_span] && !request_start_time.nil?
 
             span = tracer.start_span('http_server.proxy',
-                                     with_parent_context: extracted_context,
+                                     with_parent: extracted_context,
                                      attributes: {
                                        'start_time' => request_start_time.to_f
                                      },
                                      kind: :server)
 
-            extracted_context.set_value(current_span_key, span)
+            OpenTelemetry::Trace.context_with_span(span, parent_context: extracted_context)
           end
 
           def finish_span(context)
-            context[current_span_key]&.finish if context
-          end
-
-          def current_span_key
-            OpenTelemetry::Trace::Propagation::ContextKeys.current_span_key
+            OpenTelemetry::Trace.current_span(context).finish if context
           end
 
           def tracer
@@ -107,7 +105,8 @@ module OpenTelemetry
               'http.method' => env['REQUEST_METHOD'],
               'http.host' => env['HTTP_HOST'] || 'unknown',
               'http.scheme' => env['rack.url_scheme'],
-              'http.target' => fullpath(env)
+              'http.target' => fullpath(env),
+              'http.user_agent' => env['HTTP_USER_AGENT']
             }.merge(allowed_request_headers(env))
           end
 

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rack
-      VERSION = '0.5.0'
+      VERSION = '0.10.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rack
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.10.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-12-03 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.5.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -199,10 +199,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- CHANGELOG.md
 - LICENSE
+- README.md
 - lib/opentelemetry-instrumentation-rack.rb
 - lib/opentelemetry/instrumentation.rb
-- lib/opentelemetry/instrumentation/instrumentation.rb
 - lib/opentelemetry/instrumentation/rack.rb
 - lib/opentelemetry/instrumentation/rack/instrumentation.rb
 - lib/opentelemetry/instrumentation/rack/middlewares/tracer_middleware.rb
@@ -211,7 +213,11 @@ files:
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-rack/v0.10.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/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.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -227,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rack instrumentation for the OpenTelemetry framework

data/lib/opentelemetry/instrumentation/instrumentation.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  # "Instrumentation" are specified by
-  # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library
-  #
-  # Instrumentation should be able to handle the case when the library is not installed on a user's system.
-  module Instrumentation
-  end
-end
-
-require_relative './instrumentation/rack'