Add new Sentry.logger

[solnic]

This replaces previous internal Sentry.logger with a public-facing logger that supports structured logging and sending log events to Sentry via Sentry.capture_log API.

Sample config

require "sentry-ruby"

# Initialize Sentry with experimental logging feature enabled
Sentry.init do |config|
  config.dsn = "https://..."
  config.environment = "development"
  config.debug = true
  config.max_log_events = 3

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

puts "Testing logging with attributes..."

Sentry.logger.info("User logged in", user_id: 123, action: "login", success: true)

puts "Testing different log levels..."

Sentry.logger.debug("Debug message")
Sentry.logger.info("Info message")
Sentry.logger.warn("Warning message")
Sentry.logger.error("Error message")
Sentry.logger.fatal("Fatal message")

puts "Testing with message templates..."

Sentry.logger.info("Hello %s!", ["World"], extra: "super useful info")

puts "Flushing..."

Sentry.get_current_client.flush

puts "Done!"

Sample results in the UI

Log event with a message template

Positioned parameters

Hash-based parameters

Closes #2604

[solnic]

@sl0thentr0py this is ready for review. Please ignore ruby-head failed builds.

[sl0thentr0py]

some minor comments

[sl0thentr0py]

we should have a clear note in docs that our templates are expected to be like

"This is a template with a %{var}"

and not what ruby people are used to

"This is a template with a #{var}"

[sl0thentr0py]

[sl0thentr0py]

they just changed this to sentry.message.parameter
see getsentry/sentry-python#4387

[AbhiPrasad]

something something hardest problem in computer science

[erickreutz]

Do you guys plan to support log drains? https://devcenter.heroku.com/articles/log-drains

Trying to understand how Sentry.logger is intended to be used? Along side something like Rails.logger or as a replacement?

[AbhiPrasad]

Hey @erickreutz thanks for your interest!

Trying to understand how Sentry.logger is intended to be used? Along side something like Rails.logger or as a replacement?

We have docs for logging in Ruby here: https://docs.sentry.io/platforms/ruby/logs/. If you want more details about logs in Sentry, see our product docs: https://docs.sentry.io/product/explore/logs

We don't have Rails/ActiveSupport support just yet, this is being tracked by this GH issue: #2605. If there's something you'd like to see, please leave a reply!

Do you guys plan to support log drains? https://devcenter.heroku.com/articles/log-drains

Not at the current moment, we are prioritizing getting logging working via our SDKs (so that you can connect your logs and traces together automatically). We're tracking Heroku support in this GH issue: getsentry/sentry#91727. Please leave a comment about your use case, that will help us prioritize this!