feat(logging): support for :origin attribute

Author: solnic

sentry-ruby/lib/sentry-ruby.rb

@@ -500,6 +500,7 @@ def capture_check_in(slug, status, **options)
     # @param [Hash] options Extra log event options
     # @option options [Symbol] level The log level (:trace, :debug, :info, :warn, :error, :fatal)
     # @option options [Integer] severity The severity number according to the Sentry Logs Protocol
+    # @option options [String] origin The origin of the log event (e.g., "auto.db.rails", "manual")
     # @option options [Hash] Additional attributes to include with the log
     #
     # @example Direct usage (prefer using Sentry.logger instead)

sentry-ruby/lib/sentry/client.rb

@@ -195,9 +195,10 @@ def event_from_check_in(
     def event_from_log(message, level:, **options)
       return unless configuration.sending_allowed?
 
-      attributes = options.reject { |k, _| k == :level || k == :severity }
+      attributes = options.reject { |k, _| k == :level || k == :severity || k == :origin }
+      origin = options[:origin]
 
-      LogEvent.new(level: level, body: message, attributes: attributes)
+      LogEvent.new(level: level, body: message, attributes: attributes, origin: origin)
     end
 
     # Initializes an Event object with the given Transaction object.

sentry-ruby/lib/sentry/log_event.rb

@@ -29,7 +29,8 @@ class LogEvent
       "sentry.address" => :server_name,
       "sentry.sdk.name" => :sdk_name,
       "sentry.sdk.version" => :sdk_version,
-      "sentry.message.template" => :template
+      "sentry.message.template" => :template,
+      "sentry.origin" => :origin
     }
 
     PARAMETER_PREFIX = "sentry.message.parameter"
@@ -42,14 +43,15 @@ class LogEvent
 
     LEVELS = %i[trace debug info warn error fatal].freeze
 
-    attr_accessor :level, :body, :template, :attributes, :user
+    attr_accessor :level, :body, :template, :attributes, :user, :origin
 
     attr_reader :configuration, *(SERIALIZEABLE_ATTRIBUTES - %i[level body attributes])
 
     SERIALIZERS = %i[
       attributes
       body
       level
+      origin
       parent_span_id
       sdk_name
       sdk_version
@@ -82,6 +84,7 @@ def initialize(configuration: Sentry.configuration, **options)
       @template = @body if is_template?
       @attributes = options[:attributes] || DEFAULT_ATTRIBUTES
       @user = options[:user] || {}
+      @origin = options[:origin]
       @contexts = {}
     end
 

sentry-ruby/spec/sentry/log_event_spec.rb

@@ -20,6 +20,17 @@
       expect(event.body).to eq("User John has logged in!")
     end
 
+    it "accepts origin parameter" do
+      event = described_class.new(
+        configuration: configuration,
+        level: :info,
+        body: "Database query executed",
+        origin: "auto.db.rails"
+      )
+
+      expect(event.origin).to eq("auto.db.rails")
+    end
+
     it "accepts attributes" do
       attributes = {
         "sentry.message.template" => "User %s has logged in!",
@@ -172,5 +183,30 @@
       expect(hash[:attributes]["user.name"]).to eq("john_doe")
       expect(hash[:attributes]["user.email"]).to eq("john@example.com")
     end
+
+    it "includes sentry.origin attribute when origin is set" do
+      event = described_class.new(
+        configuration: configuration,
+        level: :info,
+        body: "Database query executed",
+        origin: "auto.db.rails"
+      )
+
+      hash = event.to_hash
+
+      expect(hash[:attributes]["sentry.origin"]).to eq({ value: "auto.db.rails", type: "string" })
+    end
+
+    it "does not include sentry.origin attribute when origin is nil" do
+      event = described_class.new(
+        configuration: configuration,
+        level: :info,
+        body: "Manual log message"
+      )
+
+      hash = event.to_hash
+
+      expect(hash[:attributes]).not_to have_key("sentry.origin")
+    end
   end
 end

sentry-ruby/spec/sentry_spec.rb

@@ -399,6 +399,39 @@
       expect(log_event[:trace_id]).to_not be(nil)
       expect(log_event[:attributes]).to have_key("sentry.trace.parent_span_id")
     end
+
+    it "includes sentry.origin attribute when origin is provided" do
+      expect do
+        described_class.capture_log("Database query executed", level: :info, origin: "auto.logger.rails.log_subscriber")
+      end.to_not change { sentry_events.count }
+
+      Sentry.get_current_client.flush
+
+      expect(sentry_envelopes.count).to eq(1)
+
+      log_event = sentry_logs.first
+
+      expect(log_event[:level]).to eq("info")
+      expect(log_event[:body]).to eq("Database query executed")
+      expect(log_event[:attributes]).to have_key("sentry.origin")
+      expect(log_event[:attributes]["sentry.origin"]).to eq({ value: "auto.logger.rails.log_subscriber", type: "string" })
+    end
+
+    it "does not include sentry.origin attribute when origin is not provided" do
+      expect do
+        described_class.capture_log("Manual log message", level: :info)
+      end.to_not change { sentry_events.count }
+
+      Sentry.get_current_client.flush
+
+      expect(sentry_envelopes.count).to eq(1)
+
+      log_event = sentry_logs.first
+
+      expect(log_event[:level]).to eq("info")
+      expect(log_event[:body]).to eq("Manual log message")
+      expect(log_event[:attributes]).not_to have_key("sentry.origin")
+    end
   end
 
   describe ".start_transaction" do