Class: NewRelic::Agent::OpenTelemetryBridge

Inherits:
Object
  • Object
show all
Defined in:
lib/new_relic/agent/opentelemetry_bridge.rb

Constant Summary collapse

DEFAULT_EXCLUDED_TRACERS =

Exclude tracers by default to prevent double-reporting. Affects libraries that the Ruby agent already instruments automatically. Can be overridden via the opentelemetry.traces.include configuration. opentelemetry.io/ecosystem/registry/?language=ruby&flag=native

%w[
  elasticsearch-api
  dalli
  OpenTelemetry::Instrumentation::ActionMailer::Instrumentation
  OpenTelemetry::Instrumentation::ActionPack::Instrumentation
  OpenTelemetry::Instrumentation::ActionView::Instrumentation
  OpenTelemetry::Instrumentation::ActiveJob::Instrumentation
  OpenTelemetry::Instrumentation::ActiveRecord::Instrumentation
  OpenTelemetry::Instrumentation::ActiveStorage::Instrumentation
  OpenTelemetry::Instrumentation::ActiveSupport::Instrumentation
  OpenTelemetry::Instrumentation::AwsLambda::Instrumentation
  OpenTelemetry::Instrumentation::AwsSdk::Instrumentation
  OpenTelemetry::Instrumentation::Bunny::Instrumentation
  OpenTelemetry::Instrumentation::ConcurrentRuby::Instrumentation
  OpenTelemetry::Instrumentation::Dalli::Instrumentation
  OpenTelemetry::Instrumentation::Ethon::Instrumentation
  OpenTelemetry::Instrumentation::Excon::Instrumentation
  OpenTelemetry::Instrumentation::Grape::Instrumentation
  OpenTelemetry::Instrumentation::GraphQL::Instrumentation
  OpenTelemetry::Instrumentation::Grpc::Instrumentation
  OpenTelemetry::Instrumentation::HTTP::Instrumentation
  OpenTelemetry::Instrumentation::HttpClient::Instrumentation
  OpenTelemetry::Instrumentation::HTTPX::Instrumentation
  OpenTelemetry::Instrumentation::Logger::Instrumentation
  OpenTelemetry::Instrumentation::Mongo::Instrumentation
  OpenTelemetry::Instrumentation::Net::HTTP::Instrumentation
  OpenTelemetry::Instrumentation::Rack::Instrumentation
  OpenTelemetry::Instrumentation::Rails::Instrumentation
  OpenTelemetry::Instrumentation::Rake::Instrumentation
  OpenTelemetry::Instrumentation::Rdkafka::Instrumentation
  OpenTelemetry::Instrumentation::Redis::Instrumentation
  OpenTelemetry::Instrumentation::Resque::Instrumentation
  OpenTelemetry::Instrumentation::RubyKafka::Instrumentation
  OpenTelemetry::Instrumentation::Sidekiq::Instrumentation
  OpenTelemetry::Instrumentation::Sinatra::Instrumentation
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(events) ⇒ OpenTelemetryBridge

Returns a new instance of OpenTelemetryBridge.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/new_relic/agent/opentelemetry_bridge.rb', line 49

def initialize(events)
  # currently, we only have support for traces
  # this method should change when we add support for metrics and logs.
  if defined?(OpenTelemetry) && Agent.config[:'opentelemetry.enabled'] && Agent.config[:'opentelemetry.traces.enabled']
    OpenTelemetryBridge.install
    events.subscribe(:initial_configuration_complete) do
      NewRelic::Agent.record_metric('Supportability/Tracing/Ruby/OpenTelemetryBridge/enabled', 0.0)
    end
  else
    events.subscribe(:initial_configuration_complete) do
      NewRelic::Agent.record_metric('Supportability/Tracing/Ruby/OpenTelemetryBridge/disabled', 0.0)
    end
  end
end

Class Method Details

.calculate_excluded_tracers ⇒ Object 



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/new_relic/agent/opentelemetry_bridge.rb', line 86

def self.calculate_excluded_tracers
  excluded_names = NewRelic::Agent.config[:'opentelemetry.traces.exclude'].split(',').map(&:strip)
  included_names = NewRelic::Agent.config[:'opentelemetry.traces.include'].split(',').map(&:strip)

  # Priority order (highest to lowest):
  # 1. Configured exclude list - always excluded
  # 2. Configured include list - overrides default exclude
  # 3. Default exclude list - excluded unless overridden by configured include
  excluded_names + (DEFAULT_EXCLUDED_TRACERS - included_names)
end

.install ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/new_relic/agent/opentelemetry_bridge.rb', line 66

def self.install
  require 'opentelemetry' # requires the opentelemetry-api gem
  require_relative 'opentelemetry/trace'
  require_relative 'opentelemetry/transaction_patch'
  require_relative 'opentelemetry/context'
  require_relative 'opentelemetry/trace_patch'
  require_relative 'opentelemetry/abstract_segment_patch'

  NewRelic::Agent.logger.warn('OpenTelemetry SDK gem is installed. This may interfere with New Relic instrumentation.') if defined?(OpenTelemetry::SDK)

  ::OpenTelemetry::Trace.singleton_class.prepend(NewRelic::Agent::OpenTelemetry::TracePatch)
  Transaction.prepend(OpenTelemetry::TransactionPatch)
  Transaction::AbstractSegment.prepend(OpenTelemetry::AbstractSegmentPatch)

  ::OpenTelemetry.tracer_provider = OpenTelemetry::Trace::TracerProvider.new
  ::OpenTelemetry.propagation = OpenTelemetry::Context::Propagation::TracePropagator.new

  install_instrumentation
end

.install_instrumentation ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/new_relic/agent/opentelemetry_bridge.rb', line 97

def self.install_instrumentation
  return unless defined?(::OpenTelemetry::Instrumentation::Registry)

  excluded_set = calculate_excluded_tracers.to_set

  return ::OpenTelemetry::Instrumentation.registry.install_all if excluded_set.empty?

  registry = ::OpenTelemetry::Instrumentation.registry
  registry_lock = registry.instance_variable_get(:@lock)

  registry_lock.synchronize do
    instrumentation = registry.instance_variable_get(:@instrumentation)

    # Filter directly on objects, not strings
    without_excluded = instrumentation.reject do |inst|
      excluded_set.include?(inst.to_s)
    end

    registry.instance_variable_set(:@instrumentation, without_excluded)
  end

  ::OpenTelemetry::Instrumentation.registry.install_all
end