Update to support constant_exception_message and ProfilingError

This gets us closer to allowing these errors to be
sent to telemetry.

Author: bouwkast

lib/datadog/core/telemetry/logging.rb

@@ -49,7 +49,13 @@ def report(exception, level: :error, description: nil)
           # Anonymous exceptions to be logged as <Class:0x00007f8b1c0b3b40>
           message = +"#{exception.class.name || exception.class.inspect}" # standard:disable Style/RedundantInterpolation
 
-          message << ": #{description}" if description
+          exception_message = constant_exception_message(exception)
+
+          if description || exception_message
+            message << ':'
+            message << " #{description}" if description
+            message << " (#{exception_message})" if exception_message
+          end
 
           event = Event::Log.new(
             message: message,
@@ -62,9 +68,9 @@ def report(exception, level: :error, description: nil)
 
         private
 
-        def safe_exception_message(exception)
-          # Only include exception messages from ProfilingError, as those are guaranteed to be created by us
-          # with constant, PII-safe messages
+        def constant_exception_message(exception)
+          # Only include exception messages from ProfilingError, as those are guaranteed to contain
+          # constant strings created by Datadog code (not dynamic/PII content)
           if defined?(Datadog::Profiling::ProfilingError) && exception.is_a?(Datadog::Profiling::ProfilingError)
             exception.message
           end

sig/datadog/profiling.rbs

@@ -1,5 +1,8 @@
 module Datadog
   module Profiling
+    class ProfilingError < StandardError
+    end
+
     def self.supported?: () -> bool
     def self.unsupported_reason: () -> ::String?
     def self.start_if_enabled: () -> bool

spec/datadog/core/telemetry/logging_spec.rb

@@ -82,6 +82,44 @@ def log!(_event)
         end
       end
     end
+
+    context 'with ProfilingError' do
+      before do
+        skip unless defined?(Datadog::Profiling::ProfilingError)
+      end
+
+      it 'includes the exception message in telemetry' do
+        expect(component).to receive(:log!).with(instance_of(Datadog::Core::Telemetry::Event::Log)) do |event|
+          expect(event.payload).to include(
+            logs: [{message: 'Datadog::Profiling::ProfilingError: (This is a safe profiler error)', level: 'ERROR', count: 1,
+                    stack_trace: a_string_including('REDACTED')}]
+          )
+        end
+
+        begin
+          raise Datadog::Profiling::ProfilingError, 'This is a safe profiler error'
+        rescue => e
+          component.report(e, level: :error)
+        end
+      end
+
+      context 'with description' do
+        it 'includes both description and exception message' do
+          expect(component).to receive(:log!).with(instance_of(Datadog::Core::Telemetry::Event::Log)) do |event|
+            expect(event.payload).to include(
+              logs: [{message: 'Datadog::Profiling::ProfilingError: Profiler failed to start (Failed to initialize native extension)', level: 'ERROR', count: 1,
+                      stack_trace: a_string_including('REDACTED')}]
+            )
+          end
+
+          begin
+            raise Datadog::Profiling::ProfilingError, 'Failed to initialize native extension'
+          rescue => e
+            component.report(e, level: :error, description: 'Profiler failed to start')
+          end
+        end
+      end
+    end
   end
 
   describe '.error' do

spec/datadog/profiling/collectors/stack_spec.rb

@@ -330,7 +330,7 @@ def save_rounding_mode # rubocop:disable Lint/UselessMethodDefinition
         it do
           expect {
             sample_and_decode(background_thread, :labels, is_gvl_waiting_state: true)
-          }.to raise_error(RuntimeError, /BUG: .* is_gvl_waiting/)
+          }.to raise_error(Datadog::Profiling::ProfilingError, /BUG: .* is_gvl_waiting/)
         end
       end
 
@@ -366,7 +366,7 @@ def save_rounding_mode # rubocop:disable Lint/UselessMethodDefinition
           let(:metric_values) { {"cpu-samples" => 1} }
 
           it "raises an exception" do
-            expect { gathered_stack }.to raise_error(RuntimeError, /BUG: Unexpected missing state_label/)
+            expect { gathered_stack }.to raise_error(Datadog::Profiling::ProfilingError, /BUG: Unexpected missing state_label/)
           end
         end
 

spec/datadog/profiling/collectors/thread_context_spec.rb

@@ -1582,7 +1582,7 @@ def sample_and_check(expected_state:)
 
     context "when called before on_gc_start/on_gc_finish" do
       it do
-        expect { sample_after_gc(allow_exception: true) }.to raise_error(RuntimeError, /Unexpected call to sample_after_gc/)
+        expect { sample_after_gc(allow_exception: true) }.to raise_error(Datadog::Profiling::ProfilingError, /Unexpected call to sample_after_gc/)
       end
     end
 
@@ -1601,7 +1601,7 @@ def sample_and_check(expected_state:)
           sample_after_gc
 
           expect { sample_after_gc(allow_exception: true) }
-            .to raise_error(RuntimeError, /Unexpected call to sample_after_gc/)
+            .to raise_error(Datadog::Profiling::ProfilingError, /Unexpected call to sample_after_gc/)
         end
       end
 

spec/datadog/profiling/native_extension_spec.rb

@@ -29,9 +29,9 @@
     end
 
     context "when called without releasing the gvl" do
-      it "raises a RuntimeError" do
+      it "raises a ProfilingError" do
         expect { described_class::Testing._native_grab_gvl_and_raise(ZeroDivisionError, "this is a test", nil, false) }
-          .to raise_exception(RuntimeError, /called by thread holding the global VM lock/)
+          .to raise_exception(Datadog::Profiling::ProfilingError, /called by thread holding the global VM lock/)
       end
     end
   end
@@ -58,10 +58,10 @@
     end
 
     context "when called without releasing the gvl" do
-      it "raises a RuntimeError" do
+      it "raises a ProfilingError" do
         expect do
           described_class::Testing._native_grab_gvl_and_raise_syserr(Errno::EINTR::Errno, "this is a test", nil, false)
-        end.to raise_exception(RuntimeError, /called by thread holding the global VM lock/)
+        end.to raise_exception(Datadog::Profiling::ProfilingError, /called by thread holding the global VM lock/)
       end
     end
   end

spec/datadog/profiling/stack_recorder_spec.rb

@@ -679,7 +679,7 @@ def introduce_distinct_stacktraces(i, obj)
             expect do
               Datadog::Profiling::Collectors::Stack::Testing
                 ._native_sample(Thread.current, stack_recorder, metric_values, labels, numeric_labels)
-            end.to raise_error(RuntimeError, /Ended a heap recording/)
+            end.to raise_error(Datadog::Profiling::ProfilingError, /Ended a heap recording/)
           end
 
           it "does not keep the active slot mutex locked" do
@@ -878,7 +878,7 @@ def sample_and_clear
     context "when serialization fails" do
       before { expect(described_class).to receive(:_native_serialize).and_return([:error, "test error message"]) }
 
-      it { expect { serialize! }.to raise_error(RuntimeError, /test error message/) }
+      it { expect { serialize! }.to raise_error(Datadog::Profiling::ProfilingError, /test error message/) }
     end
   end