Remove verbose data from #inspect result (#1602)

* Fix bin/console

* Avoid showing unnecessary data in objects' inspect content

* Simplify StacktraceInterface's inspection result

* Update changelog

CHANGELOG.md

@@ -21,13 +21,15 @@
   This feature should only introduce negligible performance overhead in most Ruby applications. But if you notice obvious performance regression, please file an issue and we'll investigate it.
 
 - Support `ActiveStorage` spans in tracing events [#1588](https://github.com/getsentry/sentry-ruby/pull/1588)
+- Support `Sidekiq` Tags in Sentry [#1596](https://github.com/getsentry/sentry-ruby/pull/1596)
 
 ### Bug Fixes
 
 - Connect `Sidekiq`'s transaction with its parent when possible [#1590](https://github.com/getsentry/sentry-ruby/pull/1590)
   - Fixes [#1586](https://github.com/getsentry/sentry-ruby/issues/1586)
 - Use nil instead of false to disable callable settings [#1594](https://github.com/getsentry/sentry-ruby/pull/1594)
 - Avoid duplicated sampling on Transaction events [#1601](https://github.com/getsentry/sentry-ruby/pull/1601)
+- Remove verbose data from `#inspect` result [#1602](https://github.com/getsentry/sentry-ruby/pull/1602)
 
 ### Refactoring
 

sentry-ruby/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "sentry/ruby"
+require "sentry-ruby"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,9 @@ require "sentry/ruby"
 # require "pry"
 # Pry.start
 
+# Sentry.init do |config|
+#   config.dsn = 'https://2fb45f003d054a7ea47feb45898f7649@o447951.ingest.sentry.io/5434472'
+# end
+
 require "irb"
 IRB.start(__FILE__)

sentry-ruby/lib/sentry/configuration.rb

@@ -1,6 +1,7 @@
 require "concurrent/utility/processor_counter"
 
 require "sentry/utils/exception_cause_chain"
+require 'sentry/utils/custom_inspection'
 require "sentry/dsn"
 require "sentry/release_detector"
 require "sentry/transport/configuration"
@@ -9,6 +10,7 @@
 
 module Sentry
   class Configuration
+    include CustomInspection
     include LoggingHelper
     # Directories to be recognized as part of your app. e.g. if you
     # have an `engines` dir at the root of your project, you may want
@@ -181,6 +183,7 @@ class Configuration
 
     LOG_PREFIX = "** [Sentry] ".freeze
     MODULE_SEPARATOR = "::".freeze
+    SKIP_INSPECTION_ATTRIBUTES = [:@linecache, :@stacktrace_builder]
 
     # Post initialization callbacks are called at the end of initialization process
     # allowing extending the configuration of sentry-ruby by multiple extensions

sentry-ruby/lib/sentry/event.rb

@@ -6,6 +6,7 @@
 require 'sentry/backtrace'
 require 'sentry/utils/real_ip'
 require 'sentry/utils/request_id'
+require 'sentry/utils/custom_inspection'
 
 module Sentry
   class Event
@@ -21,6 +22,10 @@ class Event
 
     MAX_MESSAGE_SIZE_IN_BYTES = 1024 * 8
 
+    SKIP_INSPECTION_ATTRIBUTES = [:@configuration, :@modules, :@backtrace]
+
+    include CustomInspection
+
     attr_writer(*WRITER_ATTRIBUTES)
     attr_reader(*SERIALIZEABLE_ATTRIBUTES)
 

sentry-ruby/lib/sentry/interfaces/single_exception.rb

@@ -1,5 +1,10 @@
+require "sentry/utils/exception_cause_chain"
+
 module Sentry
   class SingleExceptionInterface < Interface
+    include CustomInspection
+
+    SKIP_INSPECTION_ATTRIBUTES = [:@stacktrace]
     PROBLEMATIC_LOCAL_VALUE_REPLACEMENT = "[ignored due to error]".freeze
     OMISSION_MARK = "...".freeze
     MAX_LOCAL_BYTES = 1024

sentry-ruby/lib/sentry/interfaces/stacktrace.rb

@@ -10,6 +10,10 @@ def to_hash
       { frames: @frames.map(&:to_hash) }
     end
 
+    def inspect
+      @frames.map(&:to_s)
+    end
+
     private
 
     # Not actually an interface, but I want to use the same style
@@ -28,6 +32,10 @@ def initialize(project_root, line)
         @filename = compute_filename
       end
 
+      def to_s
+        "#{@filename}:#{@lineno}"
+      end
+
       def compute_filename
         return if abs_path.nil?
 

sentry-ruby/lib/sentry/utils/custom_inspection.rb

@@ -0,0 +1,12 @@
+module Sentry
+  module CustomInspection
+    def inspect
+      attr_strings = (instance_variables - self.class::SKIP_INSPECTION_ATTRIBUTES).each_with_object([]) do |attr, result|
+        value = instance_variable_get(attr)
+        result << "#{attr}=#{value.inspect}" if value
+      end
+
+      "#<#{self.class.name} #{attr_strings.join(", ")}>"
+    end
+  end
+end

sentry-ruby/spec/sentry/event_spec.rb

@@ -33,6 +33,38 @@
     end
   end
 
+  describe "#inspect" do
+    let(:client) do
+      Sentry::Client.new(configuration)
+    end
+
+    subject do
+      e = begin
+            1/0
+          rescue => e
+            e
+          end
+
+      client.event_from_exception(e)
+    end
+
+    it "still contains relevant info" do
+      expect(subject.inspect).to match(/@event_id="#{subject.event_id}"/)
+    end
+
+    it "ignores @configuration" do
+      expect(subject.inspect).not_to match(/@configuration/)
+    end
+
+    it "ignores @modules" do
+      expect(subject.inspect).not_to match(/@modules/)
+    end
+
+    it "ignores @backtrace" do
+      expect(subject.inspect).not_to match(/@backtrace/)
+    end
+  end
+
   context 'rack context specified', rack: true do
     require 'stringio'