sentry-ruby 5.23.0 → 5.26.0

data/lib/sentry-ruby.rb

@@ -11,7 +11,7 @@ require "sentry/utils/argument_checking_helper"
 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
@@ -138,7 +139,7 @@ module Sentry
     # @param version [String] version of the integration
     def register_integration(name, version)
       if initialized?
-        logger.warn(LOGGER_PROGNAME) do
+        sdk_logger.warn(LOGGER_PROGNAME) do
           <<~MSG
             Integration '#{name}' is loaded after the SDK is initialized, which can cause unexpected behavior.  Please make sure all integrations are loaded before SDK initialization.
           MSG
@@ -238,6 +239,7 @@ module Sentry
     def init(&block)
       config = Configuration.new
       yield(config) if block_given?
+
       config.detect_release
       apply_patches(config)
       config.validate
@@ -489,6 +491,25 @@ module Sentry
       get_current_hub.capture_check_in(slug, status, **options)
     end
 
+    # Captures a log event and sends it to Sentry via the currently active hub.
+    # This is the underlying method used by the StructuredLogger class.
+    #
+    # @param message [String] the log message
+    # @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 [Hash] Additional attributes to include with the log
+    #
+    # @example Direct usage (prefer using Sentry.logger instead)
+    #   Sentry.capture_log("User logged in", level: :info, user_id: 123)
+    #
+    # @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
+    # @return [LogEvent, nil] The created log event or nil if logging is disabled
+    def capture_log(message, **options)
+      return unless initialized?
+      get_current_hub.capture_log_event(message, **options)
+    end
+
     # Takes or initializes a new Sentry::Transaction and makes a sampling decision for it.
     #
     # @return [Transaction, nil]
@@ -593,6 +614,43 @@ module Sentry
       get_current_hub.continue_trace(env, **options)
     end
 
+    # Returns the structured logger instance that implements Sentry's SDK telemetry logs protocol.
+    #
+    # This logger is only available when logs are enabled in the configuration.
+    #
+    # @example Enable logs in configuration
+    #   Sentry.init do |config|
+    #     config.dsn = "YOUR_DSN"
+    #     config.enable_logs = true
+    #   end
+    #
+    # @example Basic usage
+    #   Sentry.logger.info("User logged in successfully", user_id: 123)
+    #   Sentry.logger.error("Failed to process payment",
+    #     transaction_id: "tx_123",
+    #     error_code: "PAYMENT_FAILED"
+    #   )
+    #
+    # @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
+    #
+    # @return [StructuredLogger, nil] The structured logger instance or nil if logs are disabled
+    def logger
+      @logger ||=
+        if configuration.enable_logs
+          # Initialize the public-facing Structured Logger if logs are enabled
+          # This creates a StructuredLogger instance that implements Sentry's SDK telemetry logs protocol
+          # @see https://develop.sentry.dev/sdk/telemetry/logs/
+          StructuredLogger.new(configuration)
+        else
+          warn <<~STR
+            [sentry] `Sentry.logger` will no longer be used as internal SDK logger when `enable_logs` feature is turned on.
+                    Use Sentry.configuration.sdk_logger for SDK-specific logging needs."
+          STR
+
+          configuration.sdk_logger
+        end
+    end
+
     ##### Helpers #####
 
     # @!visibility private
@@ -604,8 +662,8 @@ module Sentry
     end
 
     # @!visibility private
-    def logger
-      configuration.logger
+    def sdk_logger
+      configuration.sdk_logger
     end
 
     # @!visibility private
@@ -632,3 +690,4 @@ require "sentry/puma"
 require "sentry/graphql"
 require "sentry/faraday"
 require "sentry/excon"
+require "sentry/std_lib_logger"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.23.0
+  version: 5.26.0
 platform: ruby
 authors:
 - Sentry Team
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -48,8 +48,8 @@ email: accounts@sentry.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".gitignore"
 - ".rspec"
@@ -101,6 +101,8 @@ files:
 - lib/sentry/interfaces/stacktrace_builder.rb
 - lib/sentry/interfaces/threads.rb
 - lib/sentry/linecache.rb
+- lib/sentry/log_event.rb
+- lib/sentry/log_event_buffer.rb
 - lib/sentry/logger.rb
 - lib/sentry/metrics.rb
 - lib/sentry/metrics/aggregator.rb
@@ -127,6 +129,8 @@ files:
 - lib/sentry/session.rb
 - lib/sentry/session_flusher.rb
 - lib/sentry/span.rb
+- lib/sentry/std_lib_logger.rb
+- lib/sentry/structured_logger.rb
 - lib/sentry/test_helper.rb
 - lib/sentry/threaded_periodic_worker.rb
 - lib/sentry/transaction.rb
@@ -145,20 +149,21 @@ files:
 - lib/sentry/utils/logging_helper.rb
 - lib/sentry/utils/real_ip.rb
 - lib/sentry/utils/request_id.rb
+- lib/sentry/utils/uuid.rb
 - lib/sentry/vernier/output.rb
 - lib/sentry/vernier/profiler.rb
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.26.0/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.23.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.26.0/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.26.0/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.26.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.23.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.26.0
 rdoc_options: []
 require_paths:
 - lib
@@ -173,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger
 test_files: []