Trilogy: introduce record_exception setting

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

@@ -16,7 +16,7 @@ module Client
           def initialize(options = {})
             @connection_options = options # This is normally done by Trilogy#initialize
 
-            tracer.in_span(
+            in_span(
               'connect',
               attributes: client_attributes.merge!(OpenTelemetry::Instrumentation::Trilogy.attributes),
               kind: :client
@@ -26,7 +26,7 @@ def initialize(options = {})
           end
 
           def ping(...)
-            tracer.in_span(
+            in_span(
               'ping',
               attributes: client_attributes.merge!(OpenTelemetry::Instrumentation::Trilogy.attributes),
               kind: :client
@@ -36,7 +36,7 @@ def ping(...)
           end
 
           def query(sql)
-            tracer.in_span(
+            in_span(
               OpenTelemetry::Helpers::MySQL.database_span_name(
                 sql,
                 OpenTelemetry::Instrumentation::Trilogy.attributes[
@@ -64,6 +64,19 @@ def query(sql)
 
           private
 
+          def in_span(name, attributes: nil, kind: nil)
+            span = tracer.start_span(name, attributes: attributes, kind: kind)
+            OpenTelemetry::Trace.with_span(span) { |s, c| yield s, c }
+          rescue Exception => e # rubocop:disable Lint/RescueException
+            if config[:record_exception]
+              span&.record_exception(e)
+            end
+            span&.status = OpenTelemetry::Trace::Status.error("Exception of type: #{e.class}")
+            raise e
+          ensure
+            span&.finish
+          end
+
           def client_attributes(sql = nil)
             attributes = {
               ::OpenTelemetry::SemanticConventions::Trace::DB_SYSTEM => 'mysql',

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