implement stdlib logger support #2653

Eazybright · 2025-06-18T23:44:33Z

Description

Describe your changes:
This is a fun way of adding integration for stdlib Logger so that any usage of any logger instance would result in sending logs to Sentry too. issue

Sample Config

require "sentry-ruby"

# Initialize Sentry with experimental logging feature enabled
Sentry.init do |config|
  config.dsn = "YOUR_SENTRY_DSN"
  config.environment = "development"

  # Set this to enable structured logging via Sentry.logger
  config.enable_logs = true

  # set this to send any instance of stdlib logger to sentry
  config.enabled_patches = [:logger]
end

logger = Logger.new(STDOUT)
logger.info('send_stdlib_log') { "send_stdlib_log_enable_logs: Testing 789..." }
logger.warn("ruby logger warn  - - 9")

Sample Result on the UI

sl0thentr0py

left a small comment, will leave a proper review to @solnic

sl0thentr0py · 2025-06-20T10:24:46Z

sentry-ruby/lib/sentry/std_lib_logger.rb

+
+		def add(severity, message = nil, progname = nil, &block)
+
+			return unless Sentry.initialized? && Sentry.get_current_hub


we need a super here and below since the original logger should not be affected

solnic

Thank you for the PR! I've left some initial comments. Please also ensure that rubocop passes against the files you added and changed because there are issues with formatting 🙂

solnic · 2025-06-23T06:29:27Z

sentry-ruby/lib/sentry/configuration.rb

      self.traces_sampler = nil
      self.enable_tracing = nil
      self.enable_logs = false
+      self.send_stdlib_logs = false


This is not needed, there's a config option called enabled_patches that should be used instead. The Logger patch should be registered as :logger and then the users will be able to configure it to be enabled by default.

You can see how :http patch is done for reference.

solnic · 2025-06-23T06:40:02Z

sentry-ruby/lib/sentry/std_lib_logger.rb

+			return unless Sentry.initialized? && Sentry.get_current_hub
+
+			config = Sentry.configuration
+			return unless config.enable_logs && config.send_stdlib_logs


This guard won't be needed when you add patching based on our enabled_patches option like I mentioned in the other comment. When registering your patch via register_patch you'll be able to do something like:

Sentry.register_patch(:logger, Sentry::StdLibLogger, ::Logger) do |config| if config.enable_logs ::Logger.prepend(Sentry::StdLibLogger) else Sentry.sdk_logger.warn(":logger patch enabled but `enable_logs` is turned off - skipping applying patch") end end

solnic · 2025-06-23T06:49:59Z

sentry-ruby/lib/sentry/std_lib_logger.rb

+	      if !message.nil? && message != Sentry::Logger::PROGNAME && method = SEVERITY_MAP[severity]
+					Sentry.logger.send(method, message)
+	      end
+	    end


I think this method should always call super and logs to Sentry as an additional side effect.

@sl0thentr0py wouldn't you agree?

Oh wait nevermind @sl0thentr0py - I just noticed that you pointed it out as well above, sorry for the noise!

…ruby into stdlib-logger-support

Eazybright · 2025-06-23T15:50:32Z

Thank you for the PR! I've left some initial comments. Please also ensure that rubocop passes against the files you added and changed because there are issues with formatting 🙂

all comments have been addressed and PR updated. @solnic @sl0thentr0py

solnic · 2025-06-24T14:26:34Z

Thanks for the PR and for following up on the reviews! 🙇🏻

I've opened a new PR that builds on top of yours because of time constraints, as we need to finish this feature this week and we may need more back and worth in the review process.

See #2657 for more progress!

Gonna close this one because of this, I hope that's OK! All your commits are in my branch of course :)

codecov · 2025-06-24T14:26:50Z

Codecov Report

Attention: Patch coverage is 89.47368% with 2 lines in your changes missing coverage. Please review.

Project coverage is 97.44%. Comparing base (32ca39e) to head (d20494e).

Files with missing lines	Patch %	Lines
sentry-ruby/lib/sentry/std_lib_logger.rb	88.88%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2653      +/-   ##
==========================================
+ Coverage   96.98%   97.44%   +0.45%     
==========================================
  Files         133      134       +1     
  Lines        5147     5167      +20     
==========================================
+ Hits         4992     5035      +43     
+ Misses        155      132      -23

Components	Coverage Δ
sentry-ruby	`97.68% <89.47%> (+0.21%)`	⬆️
sentry-rails	`96.70% <ø> (+1.79%)`	⬆️
sentry-sidekiq	`96.57% <ø> (+1.14%)`	⬆️
sentry-resque	`94.44% <ø> (ø)`
sentry-delayed_job	`94.68% <ø> (ø)`
sentry-opentelemetry	`99.31% <ø> (ø)`

Files with missing lines	Coverage Δ
sentry-ruby/lib/sentry-ruby.rb	`99.14% <100.00%> (+<0.01%)`	⬆️
sentry-ruby/lib/sentry/std_lib_logger.rb	`88.88% <88.88%> (ø)`

... and 7 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Eazybright · 2025-06-24T16:29:01Z

Thanks for the PR and for following up on the reviews! 🙇🏻

I've opened a new PR that builds on top of yours because of time constraints, as we need to finish this feature this week and we may need more back and worth in the review process.

See #2657 for more progress!

Gonna close this one because of this, I hope that's OK! All your commits are in my branch of course :)

Totally fine!

solnic · 2025-06-26T07:20:36Z

@Eazybright thanks again for helping with this. I just merged my PR with your work included. We're gonna ship it in the next release 🙂

Eazybright · 2025-07-01T12:51:03Z

@Eazybright thanks again for helping with this. I just merged my PR with your work included. We're gonna ship it in the next release 🙂

Great work @solnic

Thanks for the review, i learnt from it 🙏

sl0thentr0py · 2025-07-01T13:00:21Z

thanks for the contribution @Eazybright! if you want a free Sentry t-shirt, send me an email on neel dot shah at sentry.io and we'll ship it to you :)

Eazybright · 2025-07-07T18:39:15Z

thanks for the contribution @Eazybright! if you want a free Sentry t-shirt, send me an email on neel dot shah at sentry.io and we'll ship it to you :)

Will do, thanks!

implement stblib logger support

4753964

Eazybright changed the title ~~implement stblib logger support~~ implement stdlib logger support Jun 18, 2025

Eazybright and others added 2 commits June 19, 2025 00:48

update changelog

3adb8b5

Merge branch 'master' into stdlib-logger-support

9a9738f

rodolfoBee requested review from sl0thentr0py and solnic June 20, 2025 10:02

sl0thentr0py requested changes Jun 20, 2025

View reviewed changes

solnic requested changes Jun 23, 2025

View reviewed changes

Eazybright added 4 commits June 23, 2025 16:33

use existing patch to register stdlib logger

9beaafa

Merge branch 'stdlib-logger-support' of github.com:Eazybright/sentry-…

c51dd30

…ruby into stdlib-logger-support

remove unused code

6783dfa

fix rubocop lint issues

d20494e

solnic mentioned this pull request Jun 24, 2025

Logger support #2657

Merged

solnic closed this Jun 24, 2025


		def add(severity, message = nil, progname = nil, &block)

		return unless Sentry.initialized? && Sentry.get_current_hub

Uh oh!

implement stdlib logger support #2653

implement stdlib logger support #2653

Uh oh!

Conversation

Eazybright commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Sample Config

Sample Result on the UI

Uh oh!

sl0thentr0py left a comment

Choose a reason for hiding this comment

Uh oh!

sl0thentr0py Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

solnic left a comment

Choose a reason for hiding this comment

Uh oh!

solnic Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

solnic Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

solnic Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

solnic Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

Eazybright commented Jun 23, 2025

Uh oh!

solnic commented Jun 24, 2025

Uh oh!

codecov bot commented Jun 24, 2025

Codecov Report

Uh oh!

Eazybright commented Jun 24, 2025

Uh oh!

solnic commented Jun 26, 2025

Uh oh!

Eazybright commented Jul 1, 2025

Uh oh!

sl0thentr0py commented Jul 1, 2025

Uh oh!

Eazybright commented Jul 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Eazybright commented Jun 18, 2025 •

edited

Loading