feat: Trilogy: introduce record_exception setting (#1653)

feat: trilogy record_exception config

Co-authored-by: Robert <[email protected]>

Author: kirs

instrumentation/trilogy/lib/opentelemetry/instrumentation/trilogy/instrumentation.rb

@@ -28,6 +28,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
         option :span_name, default: :statement_type, validate: %I[statement_type db_name db_operation_and_name]
         option :obfuscation_limit, default: 2000, validate: :integer
         option :propagator, default: nil, validate: :string
+        option :record_exception, default: true, validate: :boolean
 
         attr_reader :propagator
 

instrumentation/trilogy/lib/opentelemetry/instrumentation/trilogy/patches/client.rb

@@ -19,7 +19,8 @@ def initialize(options = {})
             tracer.in_span(
               'connect',
               attributes: client_attributes.merge!(OpenTelemetry::Instrumentation::Trilogy.attributes),
-              kind: :client
+              kind: :client,
+              record_exception: config[:record_exception]
             ) do
               super
             end
@@ -29,7 +30,8 @@ def ping(...)
             tracer.in_span(
               'ping',
               attributes: client_attributes.merge!(OpenTelemetry::Instrumentation::Trilogy.attributes),
-              kind: :client
+              kind: :client,
+              record_exception: config[:record_exception]
             ) do
               super
             end
@@ -48,7 +50,8 @@ def query(sql)
               attributes: client_attributes(sql).merge!(
                 OpenTelemetry::Instrumentation::Trilogy.attributes
               ),
-              kind: :client
+              kind: :client,
+              record_exception: config[:record_exception]
             ) do |_span, context|
               if propagator && sql.frozen?
                 sql = +sql

instrumentation/trilogy/opentelemetry-instrumentation-trilogy.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = ">= #{File.read(File.expand_path('../../gemspecs/RUBY_REQUIREMENT', __dir__))}"
 
-  spec.add_dependency 'opentelemetry-api', '~> 1.0'
+  spec.add_dependency 'opentelemetry-api', '~> 1.7'
   spec.add_dependency 'opentelemetry-helpers-mysql'
   spec.add_dependency 'opentelemetry-helpers-sql'
   spec.add_dependency 'opentelemetry-helpers-sql-obfuscation'

instrumentation/trilogy/test/opentelemetry/instrumentation/trilogy/instrumentation_test.rb

@@ -277,6 +277,18 @@
         _(span.events.first.attributes['exception.message']).wont_be_nil
         _(span.events.first.attributes['exception.stacktrace']).wont_be_nil
       end
+
+      describe 'when record_exception is false' do
+        let(:config) { { record_exception: false } }
+
+        it 'does not record exception when record_exception is false' do
+          expect do
+            client.query('SELECT INVALID')
+          end.must_raise Trilogy::Error
+
+          _(span.events).must_be_nil
+        end
+      end
     end
 
     describe 'when db_statement is set to include' do