opentelemetry-instrumentation-net_http 0.20.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2442c90d8584836e3e177d4293ee4ea25bf80b9881fdd0b7dba85732c129377
-  data.tar.gz: 6cb51c3a57942893ec3bf56470ea862973b598efe0a55b27082622f62aebdb65
+  metadata.gz: 75cccfbbc7a3dadc9e99dad68d96e1f7b0822d60873a0c86b758b1cfa7b9d5a2
+  data.tar.gz: 5f9ff39ff195cf75fbb708c2d9af936e6b63f24502126877127e1d5864ec720b
 SHA512:
-  metadata.gz: 3b42df81a1dec1ffe01bbba2f6e367059764a7e42bca24ba5112fb0fc958213ec1f209a4aa7ee1424136acb0d406fc76d185aa18adeaed38de4094b874118e3a
-  data.tar.gz: c0434f35899222326bd6c663452ff27a6484a5ea842a6e7b34960851597ba11f6407ae5d8ea0131e5e6011996a5a305e26e8c151ebb911160cdb7c5678515e4d
+  metadata.gz: c9ed09d3a4b3ee2009ae7def869a326a0bff2d554b65eac60cea304ee8cc7c55add5209dbf8f0352a2d818e17b1cb3813ea069901c25d4665e4368a855f2bc41
+  data.tar.gz: fd47b018541b28af16ae1fa466f5c15413eecf9f6839e0571654bdca27d46310194ed5454e0e8c3efefffbb8eae2216c8f55278a23ec315dc0612dd6762b4b5b

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-instrumentation-net_http
 
+### v0.21.1 / 2023-01-14
+
+* FIXED: Add untraced check to the Net::HTTP connect instrumentation 
+* DOCS: Fix gem homepage 
+* DOCS: More gem documentation fixes 
+
+### v0.21.0 / 2022-10-04
+
+* ADDED: Add Net::HTTP :untraced_hosts option
+* FIXED: Rename HTTP CONNECT for low level connection spans 
+
 ### v0.20.0 / 2022-06-09
 
 * Upgrading Base dependency version

data/README.md

@@ -1,6 +1,6 @@
 # OpenTelemetry Net::HTTP Instrumentation
 
-The OpenTelemetry Net::HTTP Ruby gem is a community maintained instrumentation for [Net::HTTP][net-http-home]. 
+The OpenTelemetry Net::HTTP Ruby gem is a community maintained instrumentation for [Net::HTTP][net-http-home].
 
 ## How do I get started?
 
@@ -32,7 +32,7 @@ end
 
 ## Example
 
-An example of usage can be seen in [`example/net_http.rb`](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/net_http/example/net_http.rb).
+An example of usage can be seen in [`example/net_http.rb`](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/net_http/example/net_http.rb).
 
 ## How can I get involved?
 
@@ -47,7 +47,7 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [net-http-home]: https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/instrumentation/net/http/instrumentation.rb

@@ -20,6 +20,14 @@ module OpenTelemetry
             defined?(::Net::HTTP)
           end
 
+          ## Supported configuration keys for the install config hash:
+          #
+          # untraced_hosts: if a request's address matches any of the `String`
+          #   or `Regexp` in this array, the instrumentation will not record a
+          #   `kind = :client` representing the request and will not propagate
+          #   context in the request.
+          option :untraced_hosts, default: [], validate: :array
+
           private
 
           def require_dependencies

data/lib/opentelemetry/instrumentation/net/http/patches/instrumentation.rb

@@ -18,6 +18,8 @@ module OpenTelemetry
               # Do not trace recursive call for starting the connection
               return super(req, body, &block) unless started?
 
+              return super(req, body, &block) if untraced?
+
               attributes = {
                 OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => req.method,
                 OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => USE_SSL_TO_SCHEME[use_ssl?],
@@ -41,7 +43,10 @@ module OpenTelemetry
 
             private
 
+            # rubocop:disable Metrics/MethodLength
             def connect
+              return super if untraced?
+
               if proxy?
                 conn_address = proxy_address
                 conn_port    = proxy_port
@@ -55,10 +60,19 @@ module OpenTelemetry
                 OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => conn_port
               }.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
 
-              tracer.in_span('HTTP CONNECT', attributes: attributes) do
+              if use_ssl? && proxy?
+                span_name = 'HTTP CONNECT'
+                span_kind = :client
+              else
+                span_name = 'connect'
+                span_kind = :internal
+              end
+
+              tracer.in_span(span_name, attributes: attributes, kind: span_kind) do
                 super
               end
             end
+            # rubocop:enable Metrics/MethodLength
 
             def annotate_span_with_response!(span, response)
               return unless response&.code
@@ -72,6 +86,14 @@ module OpenTelemetry
             def tracer
               Net::HTTP::Instrumentation.instance.tracer
             end
+
+            def untraced?
+              return true if Net::HTTP::Instrumentation.instance.config[:untraced_hosts]&.any? do |host|
+                host.is_a?(Regexp) ? host.match?(@address) : host == @address
+              end
+
+              false
+            end
           end
         end
       end

data/lib/opentelemetry/instrumentation/net/http/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Instrumentation
     module Net
       module HTTP
-        VERSION = '0.20.0'
+        VERSION = '0.21.1'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-net_http
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.41.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -209,14 +209,14 @@ files:
 - lib/opentelemetry/instrumentation/net/http/instrumentation.rb
 - lib/opentelemetry/instrumentation/net/http/patches/instrumentation.rb
 - lib/opentelemetry/instrumentation/net/http/version.rb
-homepage: https://github.com/open-telemetry/opentelemetry-ruby
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-net_http/v0.20.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/net_http
-  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-net_http/v0.20.0
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-net_http/0.21.1/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/net_http
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-net_http/0.21.1
 post_install_message: 
 rdoc_options: []
 require_paths: