sentry-ruby 4.1.2 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbe0af63148c410c71208f7bac743d24e224b5265102d645831a9538262961dc
-  data.tar.gz: 9933997d430fc94d400f97b9e2319ab14ccfe1bd2ff42635eda5b13bd4e11621
+  metadata.gz: d5b6dac8f89a557f5c39b840cd9523355c96ba30bd9e713655bd7ebc2a3dcdf0
+  data.tar.gz: d779c5deb961ae968638e74c787284c35f81dcf65d35203fe66b01413c166f46
 SHA512:
-  metadata.gz: a813b4fad61840a850b6dd82451d689272800b5d4e405ab50f80f99cfe69a371f770c1a8151491ccd2f10400822e0e4a98bc8c2ca1265b562139bd7ffc1cdd02
-  data.tar.gz: 1331331801ea39234c96e50e9fc469713efd48ee316e5620ae2c200f97a4a4d88810f942d707fb77dab7b458284ee11cad4b6153632cde4aa6014e2df5a89820
+  metadata.gz: 33516c955431dc91ab472d03917a2037af30682e4b2e7426621de98883ca7c5d92e4dd577163989caeecbf1c6e1a34cf92d2785d3305e660001614be451fb7da
+  data.tar.gz: 30f0e8aab4ff6fa6def5f062497bcb16c3c152580a9185e27bfc0ed4ac2bdd00bef4a0e79df7e92f0d82b5159bdef3d140b197e9e0b64799a67b6a06a0874c0d

data/README.md

@@ -28,6 +28,8 @@ The official Ruby-language client and integration layer for the [Sentry](https:/
 
 We test on Ruby 2.4, 2.5, 2.6 and 2.7 at the latest patchlevel/teeny version. We also support JRuby 9.0.
 
+If you use self-hosted Sentry, please also make sure its version is above `20.6.0`.
+
 ## Migrate From sentry-raven
 
 If you're using `sentry-raven`, we recommend you to migrate to this new SDK. You can find the benefits of migrating and how to do it in our [migration guide](https://docs.sentry.io/platforms/ruby/migration/).
@@ -65,7 +67,7 @@ end
 
 ### Sentry doesn't report some kinds of data by default
 
-**Sentry ignores some exceptions by default** - most of these are related to 404s parameter parsing errors. [For a complete list, see the `IGNORE_DEFAULT` constant](https://github.com/getsentry/sentry-ruby/blob/master/sentry-ruby/lib/sentry/configuration.rb#L118) and the integration gems' `IGNORE_DEFAULT`, like [`sentry-rails`'s](https://github.com/getsentry/sentry-ruby/blob/update-readme/sentry-rails/lib/sentry/rails/configuration.rb#L12)
+**Sentry ignores some exceptions by default** - most of these are related to 404s parameter parsing errors. [For a complete list, see the `IGNORE_DEFAULT` constant](https://github.com/getsentry/sentry-ruby/blob/master/sentry-ruby/lib/sentry/configuration.rb#L118) and the integration gems' `IGNORE_DEFAULT`, like [`sentry-rails`'s](https://github.com/getsentry/sentry-ruby/blob/master/sentry-rails/lib/sentry/rails/configuration.rb#L12)
 
 Sentry doesn't send personally identifiable information (pii) by default, such as request body, user ip or cookies. If you want those information to be sent, you can use the `send_default_pii` config option:
 
@@ -94,7 +96,7 @@ Sentry.init do |config|
 end
 ```
 
-To lean more about performance monitoring, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/performance).
+To learn more about performance monitoring, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/performance).
 
 ### Usage
 
@@ -144,8 +146,8 @@ You're all set - but there's a few more settings you may want to know about too!
 **Before version 4.1.0**, `sentry-ruby` sends every event immediately. But it can be configured to send asynchronously:
 
 ```ruby
-config.async = lambda { |event|
-  Thread.new { Sentry.send_event(event) }
+config.async = lambda { |event, hint|
+  Thread.new { Sentry.send_event(event, hint) }
 }
 ```
 
@@ -154,13 +156,13 @@ Using a thread to send events will be adequate for truly parallel Ruby platforms
 Note that the naive example implementation has a major drawback - it can create an infinite number of threads. We recommend creating a background job, using your background job processor, that will send Sentry notifications in the background.
 
 ```ruby
-config.async = lambda { |event| SentryJob.perform_later(event) }
+config.async = lambda { |event, hint| SentryJob.perform_later(event, hint) }
 
 class SentryJob < ActiveJob::Base
   queue_as :default
 
-  def perform(event)
-    Sentry.send_event(event)
+  def perform(event, hint)
+    Sentry.send_event(event, hint)
   end
 end
 ```

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.1.5
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.5
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -52,65 +66,15 @@ extra_rdoc_files:
 - README.md
 - LICENSE.txt
 files:
-- ".craft.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- lib/sentry-ruby.rb
-- lib/sentry/background_worker.rb
-- lib/sentry/backtrace.rb
-- lib/sentry/benchmarks/benchmark_transport.rb
-- lib/sentry/breadcrumb.rb
-- lib/sentry/breadcrumb/sentry_logger.rb
-- lib/sentry/breadcrumb_buffer.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/dsn.rb
-- lib/sentry/event.rb
-- lib/sentry/hub.rb
-- lib/sentry/integrable.rb
-- lib/sentry/interface.rb
-- lib/sentry/interfaces/exception.rb
-- lib/sentry/interfaces/request.rb
-- lib/sentry/interfaces/single_exception.rb
-- lib/sentry/interfaces/stacktrace.rb
-- lib/sentry/linecache.rb
-- lib/sentry/logger.rb
-- lib/sentry/rack.rb
-- lib/sentry/rack/capture_exceptions.rb
-- lib/sentry/rack/deprecations.rb
-- lib/sentry/rack/interface.rb
-- lib/sentry/rake.rb
-- lib/sentry/scope.rb
-- lib/sentry/span.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/utils/exception_cause_chain.rb
-- lib/sentry/utils/real_ip.rb
-- lib/sentry/utils/request_id.rb
-- lib/sentry/version.rb
-- sentry-ruby.gemspec
-homepage: https://github.com/getsentry/raven-ruby
+homepage: https://github.com/getsentry/sentry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  homepage_uri: https://github.com/getsentry/raven-ruby
-  source_code_uri: https://github.com/getsentry/raven-ruby
-  changelog_uri: https://github.com/getsentry/raven-ruby/blob/master/CHANGELOG.md
+  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/sentry-ruby/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.craft.yml

@@ -1,19 +0,0 @@
-minVersion: '0.13.2'
-github:
-    owner: getsentry
-    repo: sentry-ruby
-changelogPolicy: simple
-preReleaseCommand: ruby ../.scripts/bump-version.rb
-releaseBranchPrefix: release-sentry-ruby
-statusProvider:
-  name: github
-artifactProvider:
-  name: github
-targets:
-    - name: gem
-    - name: github
-      tagPrefix: sentry-ruby-v
-    - name: registry
-      type: sdk
-      config:
-          canonical: 'gem:sentry-ruby'

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 2.1.1

data/CHANGELOG.md

@@ -1,102 +0,0 @@
-# Changelog
-
-## 4.1.2
-
-- before_send callback shouldn't be applied to transaction events [#1167](https://github.com/getsentry/sentry-ruby/pull/1167)
-- Transaction improvements [#1170](https://github.com/getsentry/sentry-ruby/pull/1170)
-- Support Ruby 3 [#1172](https://github.com/getsentry/sentry-ruby/pull/1172)
-- Add Integrable module [#1177](https://github.com/getsentry/sentry-ruby/pull/1177)
-
-## 4.1.1
-
-- Fix NoMethodError when sending is not allowed [#1161](https://github.com/getsentry/sentry-ruby/pull/1161)
-- Add notification for users who still use deprecated middlewares [#1160](https://github.com/getsentry/sentry-ruby/pull/1160)
-- Improve top-level api safety [#1162](https://github.com/getsentry/sentry-ruby/pull/1162)
-
-## 4.1.0
-
-- Separate rack integration [#1138](https://github.com/getsentry/sentry-ruby/pull/1138)
-  - Fixes [#1136](https://github.com/getsentry/sentry-ruby/pull/1136)
-- Fix event sampling [#1144](https://github.com/getsentry/sentry-ruby/pull/1144)
-- Merge & rename 2 Rack middlewares [#1147](https://github.com/getsentry/sentry-ruby/pull/1147)
-  - Fixes [#1153](https://github.com/getsentry/sentry-ruby/pull/1153)
-  - Removed `Sentry::Rack::Tracing` middleware and renamed `Sentry::Rack::CaptureException` to `Sentry::Rack::CaptureExceptions`.
-- Deep-copy spans [#1148](https://github.com/getsentry/sentry-ruby/pull/1148)
-- Move span recorder related code from Span to Transaction [#1149](https://github.com/getsentry/sentry-ruby/pull/1149)
-- Check SDK initialization before running integrations [#1151](https://github.com/getsentry/sentry-ruby/pull/1151)
-  - Fixes [#1145](https://github.com/getsentry/sentry-ruby/pull/1145)
-- Refactor transport [#1154](https://github.com/getsentry/sentry-ruby/pull/1154)
-- Implement non-blocking event sending [#1155](https://github.com/getsentry/sentry-ruby/pull/1155)
-  - Added `background_worker_threads` configuration option.
-
-### Noticeable Changes
-
-#### Middleware Changes
-
-`Sentry::Rack::Tracing` is now removed. And `Sentry::Rack::CaptureException` has been renamed to `Sentry::Rack::CaptureExceptions`.
-
-#### Events Are Sent Asynchronously
-
-`sentry-ruby` now sends events asynchronously by default. The functionality works like this: 
-
-1. When the SDK is initialized, a `Sentry::BackgroundWorker` will be initialized too.
-2. When an event is passed to `Client#capture_event`, instead of sending it directly with `Client#send_event`, we'll let the worker do it.
-3. The worker will have a number of threads. And the one of the idle threads will pick the job and call `Client#send_event`.
-    - If all the threads are busy, new jobs will be put into a queue, which has a limit of 30.
-    - If the queue size is exceeded, new events will be dropped.
-
-However, if you still prefer to use your own async approach, that's totally fine. If you have `config.async` set, the worker won't initialize a thread pool and won't be used either.
-
-This functionality also introduces a new `background_worker_threads` config option. It allows you to decide how many threads should the worker hold. By default, the value will be the number of the processors your machine has. For example, if your machine has 4 processors, the value would be 4.
-
-Of course, you can always override the value to fit your use cases, like
-
-```ruby
-config.background_worker_threads = 5 # the worker will have 5 threads for sending events
-```
-
-You can also disable this new non-blocking behaviour by giving a `0` value:
-
-```ruby
-config.background_worker_threads = 0 # all events will be sent synchronously
-```
-
-## 4.0.1
-
-- Add rake integration: [1137](https://github.com/getsentry/sentry-ruby/pull/1137)
-- Make Event's interfaces accessible: [1135](https://github.com/getsentry/sentry-ruby/pull/1135)
-- ActiveSupportLogger should only record events that has a started time: [1132](https://github.com/getsentry/sentry-ruby/pull/1132)
-
-## 4.0.0
-
-- Only documents update for the official release and no API/feature changes.
-
-## 0.3.0
-
-- Major API changes: [1123](https://github.com/getsentry/sentry-ruby/pull/1123)
-- Support event hint: [1122](https://github.com/getsentry/sentry-ruby/pull/1122)
-- Add request-id tag to events: [1120](https://github.com/getsentry/sentry-ruby/pull/1120) (by @tvec)
-
-## 0.2.0
-
-- Multiple fixes and refactorings
-- Tracing support
-
-## 0.1.3
-
-Fix require reference
-
-## 0.1.2
-
-- Fix: Fix async callback [1098](https://github.com/getsentry/sentry-ruby/pull/1098)
-- Refactor: Some code cleanup [1100](https://github.com/getsentry/sentry-ruby/pull/1100)
-- Refactor: Remove Event options [1101](https://github.com/getsentry/sentry-ruby/pull/1101)
-
-## 0.1.1
-
-- Feature: Allow passing custom scope to Hub#capture* helpers [1086](https://github.com/getsentry/sentry-ruby/pull/1086)
-
-## 0.1.0
-
-First version
-

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at stan001212@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,16 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in sentry-ruby.gemspec
-gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "codecov", "0.2.12"
-
-gem "pry"
-gem "rack" unless ENV["WITHOUT_RACK"] == "1"
-
-gem "benchmark-ips"
-gem "benchmark_driver"
-gem "benchmark-ipsa"
-gem "benchmark-memory"

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec).tap do |task|
-  task.rspec_opts = "--order rand"
-end
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "sentry/ruby"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/sentry-ruby.rb

@@ -1,152 +0,0 @@
-require "forwardable"
-require "time"
-
-require "sentry/version"
-require "sentry/core_ext/object/deep_dup"
-require "sentry/configuration"
-require "sentry/logger"
-require "sentry/event"
-require "sentry/transaction_event"
-require "sentry/span"
-require "sentry/transaction"
-require "sentry/hub"
-require "sentry/background_worker"
-
-def safely_require(lib)
-  begin
-    require lib
-  rescue LoadError
-  end
-end
-
-safely_require "sentry/rake"
-safely_require "sentry/rack"
-
-module Sentry
-  class Error < StandardError
-  end
-
-  META = { "name" => "sentry.ruby", "version" => Sentry::VERSION }.freeze
-
-  LOGGER_PROGNAME = "sentry".freeze
-
-  THREAD_LOCAL = :sentry_hub
-
-  def self.sdk_meta
-    META
-  end
-
-  def self.utc_now
-    Time.now.utc
-  end
-
-  class << self
-    def integrations
-      @integrations ||= {}
-    end
-
-    def register_integration(name, version)
-      meta = { name: "sentry.ruby.#{name}", version: version }.freeze
-      integrations[name.to_s] = meta
-    end
-  end
-
-  class << self
-    extend Forwardable
-
-    def_delegators :get_current_scope, :set_tags, :set_extras, :set_user
-
-    attr_accessor :background_worker
-
-    def init(&block)
-      config = Configuration.new
-      yield(config)
-      client = Client.new(config)
-      scope = Scope.new
-      hub = Hub.new(client, scope)
-      Thread.current[THREAD_LOCAL] = hub
-      @main_hub = hub
-      @background_worker = Sentry::BackgroundWorker.new(config)
-    end
-
-    def initialized?
-      !!@main_hub
-    end
-
-    def get_main_hub
-      @main_hub
-    end
-
-    def logger
-      configuration.logger
-    end
-
-    def add_breadcrumb(breadcrumb, &block)
-      get_current_scope.breadcrumbs.record(breadcrumb, &block)
-    end
-
-    def configuration
-      get_current_client.configuration
-    end
-
-    def get_current_client
-      get_current_hub&.current_client
-    end
-
-    def get_current_hub
-      # we need to assign a hub to the current thread if it doesn't have one yet
-      #
-      # ideally, we should do this proactively whenever a new thread is created
-      # but it's impossible for the SDK to keep track every new thread
-      # so we need to use this rather passive way to make sure the app doesn't crash
-      Thread.current[THREAD_LOCAL] || clone_hub_to_current_thread
-    end
-
-    def clone_hub_to_current_thread
-      Thread.current[THREAD_LOCAL] = get_main_hub.clone
-    end
-
-    def get_current_scope
-      get_current_hub&.current_scope
-    end
-
-    def with_scope(&block)
-      get_current_hub&.with_scope(&block)
-    end
-
-    def configure_scope(&block)
-      get_current_hub&.configure_scope(&block)
-    end
-
-    def send_event(event)
-      get_current_client.send_event(event)
-    end
-
-    def capture_event(event)
-      get_current_hub&.capture_event(event)
-    end
-
-    def capture_exception(exception, **options, &block)
-      get_current_hub&.capture_exception(exception, **options, &block)
-    end
-
-    def capture_message(message, **options, &block)
-      get_current_hub&.capture_message(message, **options, &block)
-    end
-
-    def start_transaction(**options)
-      get_current_hub&.start_transaction(**options)
-    end
-
-    def last_event_id
-      get_current_hub&.last_event_id
-    end
-
-    def sys_command(command)
-      result = `#{command} 2>&1` rescue nil
-      return if result.nil? || result.empty? || ($CHILD_STATUS && $CHILD_STATUS.exitstatus != 0)
-
-      result.strip
-    end
-  end
-end