# This file is distributed under New Relic's license terms. # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details. # frozen_string_literal: true DependencyDetection.defer do named :excon # We instrument Excon 0.19.0 and above using the middleware mechanism # # EXCON_MIN_VERSION is the minimum version we attempt to instrument at all. # # Why don't we use Excon.defaults[:instrumentor]? # While this might seem a perfect fit, it unfortunately isn't suitable in # current form. Someone might reasonably set the default instrumentor to # something else after we install our instrumentation. Ideally, excon would # itself conform to the #subscribe interface of ActiveSupport::Notifications, # so we could safely subscribe and not be clobbered by future subscribers, # but alas, it does not yet. # TODO: MAJOR VERSION - update min version to 0.56.0 EXCON_MIN_VERSION = Gem::Version.new("0.19.0") depends_on do defined?(::Excon) && defined?(::Excon::VERSION) end executes do excon_version = Gem::Version.new(::Excon::VERSION) if excon_version >= EXCON_MIN_VERSION install_excon_instrumentation(excon_version) else ::NewRelic::Agent.logger.warn("Excon instrumentation requires at least version #{EXCON_MIN_VERSION}") end end executes do next unless Gem::Version.new(::Excon::VERSION) < Gem::Version.new('0.56.0') deprecation_msg = 'Instrumentation for Excon versions below 0.56.0 is deprecated.' \ 'They will stop being monitored in version 9.0.0. ' \ 'Please upgrade your Excon version to continue receiving full support. ' ::NewRelic::Agent.logger.log_once( :warn, :deprecated_excon_version, deprecation_msg ) ::NewRelic::Agent.record_metric("Supportability/Deprecated/Excon", 1) end def install_excon_instrumentation(excon_version) require 'new_relic/agent/distributed_tracing/cross_app_tracing' require 'new_relic/agent/http_clients/excon_wrappers' install_middleware_excon_instrumentation end def install_middleware_excon_instrumentation ::NewRelic::Agent.logger.info('Installing middleware-based Excon instrumentation') require 'new_relic/agent/instrumentation/excon/middleware' defaults = Excon.defaults if defaults[:middlewares] defaults[:middlewares] << ::Excon::Middleware::NewRelicCrossAppTracing else ::NewRelic::Agent.logger.warn("Did not find :middlewares key in Excon.defaults, skipping Excon instrumentation") end end end