opentelemetry-instrumentation-excon 0.21.3 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40bd852e201c584c60a28fbc696cfe40e0f893725faab30ca261470aada8208
-  data.tar.gz: 1af18adaec227b344a108b57257a0b926eb60191a4defceef3ee5646a52556ed
+  metadata.gz: 3e1c05833c8e9363a08e5f834fa6307dc9b12c4d89c384bf0e0c7d3eb930a826
+  data.tar.gz: 85f86623bcfb2b53e1ce2b84fb3659ef1b47b638a8d1d6788ce8365be3b0b35f
 SHA512:
-  metadata.gz: '0931bf63aab79dcd26b43e3e9be495b70a6c742405bf6971dbc5218fd9cc0c9ed31642389158ec00b5e5f53a9f355dcb0548279ab7e9a4481726a80c9b1e676f'
-  data.tar.gz: 3876e51076218eaef6c1cb325c850dc042bb02f9cb3dd563558ecc518c7903fdfc79d173d0d06e2ba07453d00c73a3936cff1b7b215ff9f183e6c9e8e56d4b06
+  metadata.gz: dab9b7e1402204da6c479e14a0ed4c4bb3e46e4d8bb92e831a0f0087476d68a252c79db38e29069dc33233b5d205838154dfc02db94c41dce223d62d013da877
+  data.tar.gz: e8e4729e3dba0857621e8141d7aae54d25ed9b0fd6d9236d5ef03e004ab66ce7cda9720ccadffa512264df6a11db469d2fe69ff4fdaa9c7a9769057ceada92a1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History: opentelemetry-instrumentation-excon
 
+### v0.22.0 / 2023-11-28
+
+* BREAKING CHANGE: Add a connect span to excon
+
+* ADDED: Add a connect span to excon
+
 ### v0.21.3 / 2023-11-23
 
 * CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)

data/lib/opentelemetry/instrumentation/concerns/untraced_hosts.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Concerns
+      # The untraced hosts concerns allows instrumentation to skip traces on hostnames in an exclusion list.
+      # If the current OpenTelemetry context is untraced, all hosts will be treated as untraced.
+      # When included in a class that extends OpenTelemetry::Instrumentation::Base, this module defines an option named :untraced_hosts.
+      module UntracedHosts
+        def self.included(klass)
+          klass.instance_eval do
+            # 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
+          end
+        end
+
+        # Checks whether the given host should be treated as untraced.
+        # If the current OpenTelemetry context is untraced, all hosts will be treated as untraced.
+        # The given host must be a String.
+        def untraced?(host)
+          OpenTelemetry::Common::Utilities.untraced? || untraced_host?(host)
+        end
+
+        private
+
+        def untraced_host?(host)
+          config[:untraced_hosts].any? do |rule|
+            rule.is_a?(Regexp) ? rule.match?(host) : rule == host
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/excon/instrumentation.rb

@@ -4,15 +4,20 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require_relative '../concerns/untraced_hosts'
+
 module OpenTelemetry
   module Instrumentation
     module Excon
       # The Instrumentation class contains logic to detect and install the Excon
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
+        include OpenTelemetry::Instrumentation::Concerns::UntracedHosts
+
         install do |_config|
           require_dependencies
           add_middleware
+          patch
         end
 
         present do
@@ -25,11 +30,15 @@ module OpenTelemetry
 
         def require_dependencies
           require_relative 'middlewares/tracer_middleware'
+          require_relative 'patches/socket'
         end
 
         def add_middleware
-          ::Excon.defaults[:middlewares] =
-            Middlewares::TracerMiddleware.around_default_stack
+          ::Excon.defaults[:middlewares] = Middlewares::TracerMiddleware.around_default_stack
+        end
+
+        def patch
+          ::Excon::Socket.prepend(Patches::Socket)
         end
       end
     end

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

@@ -22,24 +22,30 @@ module OpenTelemetry
           end.freeze
 
           def request_call(datum)
-            begin
-              unless datum.key?(:otel_span)
-                http_method = HTTP_METHODS_TO_UPPERCASE[datum[:method]]
-                attributes = span_creation_attributes(datum, http_method)
-                tracer.start_span(
-                  HTTP_METHODS_TO_SPAN_NAMES[http_method],
-                  attributes: attributes,
-                  kind: :client
-                ).tap do |span|
-                  datum[:otel_span] = span
-                  OpenTelemetry::Trace.with_span(span) do
-                    OpenTelemetry.propagation.inject(datum[:headers])
-                  end
-                end
-              end
-            rescue StandardError => e
-              OpenTelemetry.logger.debug(e.message)
-            end
+            return @stack.request_call(datum) if untraced?(datum)
+
+            http_method = HTTP_METHODS_TO_UPPERCASE[datum[:method]]
+
+            attributes = {
+              OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => http_method,
+              OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => datum[:scheme],
+              OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => datum[:path],
+              OpenTelemetry::SemanticConventions::Trace::HTTP_HOST => datum[:host],
+              OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => datum[:hostname],
+              OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => datum[:port]
+            }
+
+            peer_service = Excon::Instrumentation.instance.config[:peer_service]
+            attributes[OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = peer_service if peer_service
+            attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+
+            span = tracer.start_span(HTTP_METHODS_TO_SPAN_NAMES[http_method], attributes: attributes, kind: :client)
+            ctx = OpenTelemetry::Trace.context_with_span(span)
+
+            datum[:otel_span] = span
+            datum[:otel_token] = OpenTelemetry::Context.attach(ctx)
+
+            OpenTelemetry.propagation.inject(datum[:headers])
 
             @stack.request_call(datum)
           end
@@ -71,43 +77,35 @@ module OpenTelemetry
           private
 
           def handle_response(datum)
-            if datum.key?(:otel_span)
-              datum[:otel_span].tap do |span|
-                return span if span.end_timestamp
+            datum.delete(:otel_span)&.tap do |span|
+              return unless span.recording?
 
-                if datum.key?(:response)
-                  response = datum[:response]
-                  span.set_attribute('http.status_code', response[:status])
-                  span.status = OpenTelemetry::Trace::Status.error unless (100..399).cover?(response[:status].to_i)
-                end
-
-                span.status = OpenTelemetry::Trace::Status.error("Request has failed: #{datum[:error]}") if datum.key?(:error)
+              if datum.key?(:response)
+                response = datum[:response]
+                span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE, response[:status])
+                span.status = OpenTelemetry::Trace::Status.error unless (100..399).cover?(response[:status].to_i)
+              end
 
-                span.finish
-                datum.delete(:otel_span)
+              if datum.key?(:error)
+                span.status = OpenTelemetry::Trace::Status.error('Request has failed')
+                span.record_exception(datum[:error])
               end
+
+              span.finish
+
+              OpenTelemetry::Context.detach(datum.delete(:otel_token)) if datum.include?(:otel_token)
             end
           rescue StandardError => e
-            OpenTelemetry.logger.debug(e.message)
-          end
-
-          def span_creation_attributes(datum, http_method)
-            instrumentation_attrs = {
-              'http.host' => datum[:host],
-              'http.method' => http_method,
-              'http.scheme' => datum[:scheme],
-              'http.target' => datum[:path]
-            }
-            config = Excon::Instrumentation.instance.config
-            instrumentation_attrs['peer.service'] = config[:peer_service] if config[:peer_service]
-            instrumentation_attrs.merge!(
-              OpenTelemetry::Common::HTTP::ClientContext.attributes
-            )
+            OpenTelemetry.handle_error(e)
           end
 
           def tracer
             Excon::Instrumentation.instance.tracer
           end
+
+          def untraced?(datum)
+            datum.key?(:otel_span) || Excon::Instrumentation.instance.untraced?(datum[:host])
+          end
         end
       end
     end

data/lib/opentelemetry/instrumentation/excon/patches/socket.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Excon
+      module Patches
+        # Module to prepend to an Excon Socket for instrumentation
+        module Socket
+          private
+
+          def connect
+            return super if untraced?
+
+            if @data[:proxy]
+              conn_address = @data.dig(:proxy, :hostname)
+              conn_port = @data.dig(:proxy, :port)
+            else
+              conn_address = @data[:hostname]
+              conn_port = @port
+            end
+
+            attributes = { OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => conn_address, OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => conn_port }.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+
+            if is_a?(::Excon::SSLSocket) && @data[: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
+
+          def tracer
+            Excon::Instrumentation.instance.tracer
+          end
+
+          def untraced?
+            address = if @data[:proxy]
+                        @data.dig(:proxy, :hostname)
+                      else
+                        @data[:hostname]
+                      end
+
+            Excon::Instrumentation.instance.untraced?(address)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Excon
-      VERSION = '0.21.3'
+      VERSION = '0.22.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-excon
 version: !ruby/object:Gem::Version
-  version: 0.21.3
+  version: 0.22.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -219,18 +219,20 @@ files:
 - README.md
 - lib/opentelemetry-instrumentation-excon.rb
 - lib/opentelemetry/instrumentation.rb
+- lib/opentelemetry/instrumentation/concerns/untraced_hosts.rb
 - lib/opentelemetry/instrumentation/excon.rb
 - lib/opentelemetry/instrumentation/excon/instrumentation.rb
 - lib/opentelemetry/instrumentation/excon/middlewares/tracer_middleware.rb
+- lib/opentelemetry/instrumentation/excon/patches/socket.rb
 - lib/opentelemetry/instrumentation/excon/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-excon/0.21.3/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-excon/0.22.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/excon
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-excon/0.21.3
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-excon/0.22.0
 post_install_message: 
 rdoc_options: []
 require_paths: