Add StructuredLogger and re-purpose Sentry.logger

Author: solnic

sentry-ruby/lib/sentry-ruby.rb

@@ -11,7 +11,7 @@
 require "sentry/utils/encoding_helper"
 require "sentry/utils/logging_helper"
 require "sentry/configuration"
-require "sentry/logger"
+require "sentry/structured_logger"
 require "sentry/event"
 require "sentry/error_event"
 require "sentry/transaction_event"
@@ -54,6 +54,7 @@ module Sentry
 
   GLOBALS = %i[
     main_hub
+    logger
     session_flusher
     backpressure_monitor
     metrics_aggregator
@@ -95,9 +96,8 @@ def exception_locals_tp
     attr_reader :metrics_aggregator
 
     # @!attribute [r] logger
-    #   @return [Logger]
-    # @!visibility private
-    attr_reader :sdk_logger
+    #   @return [Logging::Device]
+    attr_reader :logger
 
     ##### Patch Registration #####
 
@@ -244,8 +244,8 @@ def init(&block)
       config = Configuration.new
       yield(config) if block_given?
 
-      # Internal SDK logger
-      @sdk_logger = config.sdk_logger
+      # Public-facing Structured Logger
+      @logger = StructuredLogger.new(config) if config._experiments[:enable_logs]
 
       config.detect_release
       apply_patches(config)
@@ -624,6 +624,11 @@ def sys_command(command)
       result.strip
     end
 
+    # @!visibility private
+    def sdk_logger
+      configuration.sdk_logger
+    end
+
     # @!visibility private
     def sdk_meta
       META

sentry-ruby/lib/sentry/configuration.rb

@@ -12,6 +12,7 @@
 require "sentry/metrics/configuration"
 require "sentry/linecache"
 require "sentry/interfaces/stacktrace_builder"
+require "sentry/logger"
 require "sentry/log_event_buffer"
 
 module Sentry

sentry-ruby/lib/sentry/logging/device.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Logging
+    class Device
+      attr_reader :handlers
+
+      def initialize(options)
+        @handlers = options.fetch(:handlers)
+      end
+
+      def trace(message, payload = {})
+        log(:trace, message, payload)
+      end
+
+      def debug(message, payload = {})
+        log(:debug, message, payload)
+      end
+
+      def info(message, payload = {})
+        log(:info, message, payload)
+      end
+
+      def warn(message, payload = {})
+        log(:warn, message, payload)
+      end
+
+      def error(message, payload = {})
+        log(:error, message, payload)
+      end
+
+      def fatal(message, payload = {})
+        log(:fatal, message, payload)
+      end
+
+      def log(level, message, payload)
+        handlers.each do |handler|
+          case handler
+          when Sentry::Logger
+            handler.public_send(level, message)
+          else
+            handler.public_send(level, message, payload)
+          end
+        end
+      end
+    end
+  end
+end

sentry-ruby/lib/sentry/structured_logger.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Sentry
+  class StructuredLogger
+    # https://develop.sentry.dev/sdk/telemetry/logs/#log-severity-number
+    LEVELS = {
+      "trace" => 1,
+      "debug" => 5,
+      "info" => 9,
+      "warn" => 13,
+      "error" => 17,
+      "fatal" => 21
+    }.freeze
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def trace(message, payload = {})
+      log(:trace, message, payload)
+    end
+
+    def debug(message, payload = {})
+      log(:debug, message, payload)
+    end
+
+    def info(message, payload = {})
+      log(:info, message, payload)
+    end
+
+    def warn(message, payload = {})
+      log(:warn, message, payload)
+    end
+
+    def error(message, payload = {})
+      log(:error, message, payload)
+    end
+
+    def fatal(message, payload = {})
+      log(:fatal, message, payload)
+    end
+
+    def log(level, message, payload)
+      Sentry.capture_log(message, level: level, severity: LEVELS[level], **payload)
+    end
+  end
+end

sentry-ruby/spec/sentry/structured_logger_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Sentry::StructuredLogger do
+  context "when log events are not enabled" do
+    before do
+      perform_basic_setup
+    end
+
+    it "logger is not set up" do
+      expect(Sentry.logger).to be_nil
+    end
+  end
+
+  context "when log events are enabled" do
+    before do
+      perform_basic_setup do |config|
+        config.max_log_events = 1
+        config._experiments = { enable_logs: true }
+      end
+    end
+
+    let(:logs) do
+      Sentry.get_current_client.log_event_buffer.pending_events
+    end
+
+    # TODO: At the moment the Sentry::Logger enforces info - is that intentional?
+    ["info", "warn", "error", "fatal"].each do |level|
+      describe "##{level}" do
+        it "logs using default logger and LogEvent logger with extra attributes" do
+          payload = { user_id: 123, action: "create" }
+
+          Sentry.logger.public_send(level, "Hello World", payload)
+
+          expect(logs).to_not be_empty
+
+          log_event = logs.last
+
+          expect(log_event.type).to eql("log")
+          expect(log_event.level).to eql(level.to_sym)
+          expect(log_event.body).to eql("Hello World")
+          expect(log_event.attributes).to include(payload)
+        end
+      end
+    end
+  end
+end