sentry-ruby 5.10.0 → 5.26.0

data/lib/sentry-ruby.rb

@@ -11,19 +11,25 @@ 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"
+require "sentry/check_in_event"
 require "sentry/span"
 require "sentry/transaction"
 require "sentry/hub"
 require "sentry/background_worker"
+require "sentry/threaded_periodic_worker"
 require "sentry/session_flusher"
+require "sentry/backpressure_monitor"
+require "sentry/cron/monitor_check_ins"
+require "sentry/metrics"
+require "sentry/vernier/profiler"
 
 [
   "sentry/rake",
-  "sentry/rack",
+  "sentry/rack"
 ].each do |lib|
   begin
     require lib
@@ -36,14 +42,25 @@ module Sentry
 
   CAPTURED_SIGNATURE = :@__sentry_captured
 
-  LOGGER_PROGNAME = "sentry".freeze
+  LOGGER_PROGNAME = "sentry"
 
-  SENTRY_TRACE_HEADER_NAME = "sentry-trace".freeze
+  SENTRY_TRACE_HEADER_NAME = "sentry-trace"
 
-  BAGGAGE_HEADER_NAME = "baggage".freeze
+  BAGGAGE_HEADER_NAME = "baggage"
 
   THREAD_LOCAL = :sentry_hub
 
+  MUTEX = Mutex.new
+
+  GLOBALS = %i[
+    main_hub
+    logger
+    session_flusher
+    backpressure_monitor
+    metrics_aggregator
+    exception_locals_tp
+  ].freeze
+
   class << self
     # @!visibility private
     def exception_locals_tp
@@ -63,25 +80,33 @@ module Sentry
     end
 
     # @!attribute [rw] background_worker
-    #   @return [BackgroundWorker, nil]
+    #   @return [BackgroundWorker]
     attr_accessor :background_worker
 
     # @!attribute [r] session_flusher
     #   @return [SessionFlusher, nil]
     attr_reader :session_flusher
 
+    # @!attribute [r] backpressure_monitor
+    #   @return [BackpressureMonitor, nil]
+    attr_reader :backpressure_monitor
+
+    # @!attribute [r] metrics_aggregator
+    #   @return [Metrics::Aggregator, nil]
+    attr_reader :metrics_aggregator
+
     ##### Patch Registration #####
 
     # @!visibility private
-    def register_patch(patch = nil, target = nil, &block)
+    def register_patch(key, patch = nil, target = nil, &block)
       if patch && block
         raise ArgumentError.new("Please provide either a patch and its target OR a block, but not both")
       end
 
       if block
-        registered_patches << block
+        registered_patches[key] = block
       else
-        registered_patches << proc do
+        registered_patches[key] = proc do
           target.send(:prepend, patch) unless target.ancestors.include?(patch)
         end
       end
@@ -89,14 +114,14 @@ module Sentry
 
     # @!visibility private
     def apply_patches(config)
-      registered_patches.each do |patch|
-        patch.call(config)
+      registered_patches.each do |key, patch|
+        patch.call(config) if config.enabled_patches.include?(key)
       end
     end
 
     # @!visibility private
     def registered_patches
-      @registered_patches ||= []
+      @registered_patches ||= {}
     end
 
     ##### Integrations #####
@@ -114,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
@@ -198,6 +223,13 @@ module Sentry
       get_current_scope.set_context(*args)
     end
 
+    # @!method add_attachment
+    #   @!macro add_attachment
+    def add_attachment(**opts)
+      return unless initialized?
+      get_current_scope.add_attachment(**opts)
+    end
+
     ##### Main APIs #####
 
     # Initializes the SDK with given configuration.
@@ -207,25 +239,20 @@ module Sentry
     def init(&block)
       config = Configuration.new
       yield(config) if block_given?
+
       config.detect_release
       apply_patches(config)
+      config.validate
       client = Client.new(config)
       scope = Scope.new(max_breadcrumbs: config.max_breadcrumbs)
       hub = Hub.new(client, scope)
       Thread.current.thread_variable_set(THREAD_LOCAL, hub)
       @main_hub = hub
       @background_worker = Sentry::BackgroundWorker.new(config)
-
-      @session_flusher = if config.auto_session_tracking
-                           Sentry::SessionFlusher.new(config, client)
-                         else
-                           nil
-                         end
-
-      if config.include_local_variables
-        exception_locals_tp.enable
-      end
-
+      @session_flusher = config.session_tracking? ? Sentry::SessionFlusher.new(config, client) : nil
+      @backpressure_monitor = config.enable_backpressure_handling ? Sentry::BackpressureMonitor.new(config, client) : nil
+      @metrics_aggregator = config.metrics.enabled ? Sentry::Metrics::Aggregator.new(config, client) : nil
+      exception_locals_tp.enable if config.include_local_variables
       at_exit { close }
     end
 
@@ -234,22 +261,37 @@ module Sentry
     #
     # @return [void]
     def close
-      if @background_worker
-        @background_worker.shutdown
-        @background_worker = nil
-      end
-
       if @session_flusher
+        @session_flusher.flush
         @session_flusher.kill
         @session_flusher = nil
       end
 
-      if configuration&.include_local_variables
-        exception_locals_tp.disable
+      if @backpressure_monitor
+        @backpressure_monitor.kill
+        @backpressure_monitor = nil
+      end
+
+      if @metrics_aggregator
+        @metrics_aggregator.flush(force: true)
+        @metrics_aggregator.kill
+        @metrics_aggregator = nil
       end
 
-      @main_hub = nil
-      Thread.current.thread_variable_set(THREAD_LOCAL, nil)
+      if client = get_current_client
+        client.flush
+
+        if client.configuration.include_local_variables
+          exception_locals_tp.disable
+        end
+      end
+
+      @background_worker.shutdown
+
+      MUTEX.synchronize do
+        @main_hub = nil
+        Thread.current.thread_variable_set(THREAD_LOCAL, nil)
+      end
     end
 
     # Returns true if the SDK is initialized.
@@ -276,6 +318,9 @@ module Sentry
     #
     # @return [Hub]
     def get_main_hub
+      MUTEX.synchronize { @main_hub }
+    rescue ThreadError
+      # In some rare cases this may be called in a trap context so we need to handle it gracefully
       @main_hub
     end
 
@@ -430,6 +475,41 @@ module Sentry
       get_current_hub.capture_event(event)
     end
 
+    # Captures a check-in and sends it to Sentry via the currently active hub.
+    #
+    # @param slug [String] identifier of this monitor
+    # @param status [Symbol] status of this check-in, one of {CheckInEvent::VALID_STATUSES}
+    #
+    # @param [Hash] options extra check-in options
+    # @option options [String] check_in_id for updating the status of an existing monitor
+    # @option options [Integer] duration seconds elapsed since this monitor started
+    # @option options [Cron::MonitorConfig] monitor_config configuration for this monitor
+    #
+    # @return [String, nil] The {CheckInEvent#check_in_id} to use for later updates on the same slug
+    def capture_check_in(slug, status, **options)
+      return unless initialized?
+      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]
@@ -489,6 +569,88 @@ module Sentry
       Scope.add_global_event_processor(&block)
     end
 
+    # Returns the traceparent (sentry-trace) header for distributed tracing.
+    # Can be either from the currently active span or the propagation context.
+    #
+    # @return [String, nil]
+    def get_traceparent
+      return nil unless initialized?
+      get_current_hub.get_traceparent
+    end
+
+    # Returns the baggage header for distributed tracing.
+    # Can be either from the currently active span or the propagation context.
+    #
+    # @return [String, nil]
+    def get_baggage
+      return nil unless initialized?
+      get_current_hub.get_baggage
+    end
+
+    # Returns the a Hash containing sentry-trace and baggage.
+    # Can be either from the currently active span or the propagation context.
+    #
+    # @return [Hash, nil]
+    def get_trace_propagation_headers
+      return nil unless initialized?
+      get_current_hub.get_trace_propagation_headers
+    end
+
+    # Returns the a Hash containing sentry-trace and baggage.
+    # Can be either from the currently active span or the propagation context.
+    #
+    # @return [String]
+    def get_trace_propagation_meta
+      return "" unless initialized?
+      get_current_hub.get_trace_propagation_meta
+    end
+
+    # Continue an incoming trace from a rack env like hash.
+    #
+    # @param env [Hash]
+    # @return [Transaction, nil]
+    def continue_trace(env, **options)
+      return nil unless initialized?
+      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
@@ -500,8 +662,8 @@ module Sentry
     end
 
     # @!visibility private
-    def logger
-      configuration.logger
+    def sdk_logger
+      configuration.sdk_logger
     end
 
     # @!visibility private
@@ -513,6 +675,11 @@ module Sentry
     def utc_now
       Time.now.utc
     end
+
+    # @!visibility private
+    def dependency_installed?(name)
+      Object.const_defined?(name)
+    end
   end
 end
 
@@ -520,3 +687,7 @@ end
 require "sentry/net/http"
 require "sentry/redis"
 require "sentry/puma"
+require "sentry/graphql"
+require "sentry/faraday"
+require "sentry/excon"
+require "sentry/std_lib_logger"

data/sentry-ruby-core.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/version"
 
 Gem::Specification.new do |spec|
@@ -12,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.4'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
-  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.rubocop\.yml)'`.split("\n")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

data/sentry-ruby.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/version"
 
 Gem::Specification.new do |spec|
@@ -7,18 +9,25 @@ Gem::Specification.new do |spec|
   spec.description = spec.summary = "A gem that provides a client interface for the Sentry error logger"
   spec.email = "accounts@sentry.io"
   spec.license = 'MIT'
-  spec.homepage = "https://github.com/getsentry/sentry-ruby"
 
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.4'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
-  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.rubocop\.yml)'`.split("\n")
+
+  github_root_uri = 'https://github.com/getsentry/sentry-ruby'
+  spec.homepage = "#{github_root_uri}/tree/#{spec.version}/#{spec.name}"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{github_root_uri}/blob/#{spec.version}/CHANGELOG.md",
+    "bug_tracker_uri" => "#{github_root_uri}/issues",
+    "documentation_uri" => "http://www.rubydoc.info/gems/#{spec.name}/#{spec.version}"
+  }
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "concurrent-ruby", '~> 1.0', '>= 1.0.2'
+  spec.add_dependency "concurrent-ruby", "~> 1.0", ">= 1.0.2"
+  spec.add_dependency "bigdecimal"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.10.0
+  version: 5.26.0
 platform: ruby
 authors:
 - Sentry Team
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,13 +29,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem that provides a client interface for the Sentry error logger
 email: accounts@sentry.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".gitignore"
 - ".rspec"
@@ -50,69 +63,107 @@ files:
 - bin/console
 - bin/setup
 - lib/sentry-ruby.rb
+- lib/sentry/attachment.rb
 - lib/sentry/background_worker.rb
+- lib/sentry/backpressure_monitor.rb
 - lib/sentry/backtrace.rb
 - lib/sentry/baggage.rb
 - lib/sentry/breadcrumb.rb
 - lib/sentry/breadcrumb/sentry_logger.rb
 - lib/sentry/breadcrumb_buffer.rb
+- lib/sentry/check_in_event.rb
 - lib/sentry/client.rb
 - lib/sentry/configuration.rb
 - lib/sentry/core_ext/object/deep_dup.rb
 - lib/sentry/core_ext/object/duplicable.rb
+- lib/sentry/cron/configuration.rb
+- lib/sentry/cron/monitor_check_ins.rb
+- lib/sentry/cron/monitor_config.rb
+- lib/sentry/cron/monitor_schedule.rb
 - lib/sentry/dsn.rb
 - lib/sentry/envelope.rb
+- lib/sentry/envelope/item.rb
 - lib/sentry/error_event.rb
 - lib/sentry/event.rb
 - lib/sentry/exceptions.rb
+- lib/sentry/excon.rb
+- lib/sentry/excon/middleware.rb
+- lib/sentry/faraday.rb
+- lib/sentry/graphql.rb
 - lib/sentry/hub.rb
 - lib/sentry/integrable.rb
 - lib/sentry/interface.rb
 - lib/sentry/interfaces/exception.rb
+- lib/sentry/interfaces/mechanism.rb
 - lib/sentry/interfaces/request.rb
 - lib/sentry/interfaces/single_exception.rb
 - lib/sentry/interfaces/stacktrace.rb
 - 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
+- lib/sentry/metrics/configuration.rb
+- lib/sentry/metrics/counter_metric.rb
+- lib/sentry/metrics/distribution_metric.rb
+- lib/sentry/metrics/gauge_metric.rb
+- lib/sentry/metrics/local_aggregator.rb
+- lib/sentry/metrics/metric.rb
+- lib/sentry/metrics/set_metric.rb
+- lib/sentry/metrics/timing.rb
 - lib/sentry/net/http.rb
 - lib/sentry/profiler.rb
+- lib/sentry/profiler/helpers.rb
+- lib/sentry/propagation_context.rb
 - lib/sentry/puma.rb
 - lib/sentry/rack.rb
 - lib/sentry/rack/capture_exceptions.rb
 - lib/sentry/rake.rb
 - lib/sentry/redis.rb
 - lib/sentry/release_detector.rb
+- lib/sentry/rspec.rb
 - lib/sentry/scope.rb
 - 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
 - lib/sentry/transaction_event.rb
 - lib/sentry/transport.rb
 - lib/sentry/transport/configuration.rb
 - lib/sentry/transport/dummy_transport.rb
 - lib/sentry/transport/http_transport.rb
+- lib/sentry/transport/spotlight_transport.rb
 - lib/sentry/utils/argument_checking_helper.rb
 - lib/sentry/utils/custom_inspection.rb
 - lib/sentry/utils/encoding_helper.rb
+- lib/sentry/utils/env_helper.rb
 - lib/sentry/utils/exception_cause_chain.rb
+- lib/sentry/utils/http_tracing.rb
 - 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
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.26.0/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md
-post_install_message: 
+  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.26.0
 rdoc_options: []
 require_paths:
 - lib
@@ -127,8 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger
 test_files: []