wip - add Logging

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/logging"
 require "sentry/event"
 require "sentry/error_event"
 require "sentry/transaction_event"
@@ -94,6 +94,10 @@ def exception_locals_tp
     #   @return [Metrics::Aggregator, nil]
     attr_reader :metrics_aggregator
 
+    # @!attribute [r] logger
+    #   @return [Logging::Device]
+    attr_reader :logger
+
     # @!attribute [r] logger
     #   @return [Logger]
     # @!visibility private
@@ -244,6 +248,9 @@ def init(&block)
       config = Configuration.new
       yield(config) if block_given?
 
+      # Public-facing Structured Logger
+      @logger = Logging.setup_logger(config)
+
       # Internal SDK logger
       @sdk_logger = config.sdk_logger
 

sentry-ruby/lib/sentry/logging.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "logger"
+require_relative "logging/device"
+require_relative "logging/handler"
+
+module Sentry
+  module Logging
+    def self.setup_logger(config)
+      if config._experiments[:enable_logs]
+        Device.new(handlers: [config.logger, Handler.new(config)])
+      end
+    end
+  end
+end

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/logging/handler.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Logging
+    class Handler
+      # 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
+end

sentry-ruby/spec/sentry/logging_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Sentry::Logging do
+  let(:default_logger) { Sentry::Logger.new(output) }
+  let(:output) { StringIO.new }
+
+  def expect_log(level, message)
+    yield(message)
+    expect(output.string).to include(level.upcase)
+    expect(output.string).to include(message)
+  end
+
+  context "when log events are not enabled" do
+    before do
+      perform_basic_setup do |config|
+        config.logger = default_logger
+      end
+    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.logger = default_logger
+        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" do
+          expect_log(level, "Hello World") { |msg| Sentry.logger.public_send(level, msg) }
+
+          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")
+        end
+
+        it "logs using default logger and LogEvent logger with extra attributes" do
+          payload = { user_id: 123, action: "create" }
+
+          expect_log(level, "Hello World") { |msg| Sentry.logger.public_send(level, msg, 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