sentry-ruby 4.1.4 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a99aa0cd23f84ac85fe92aeff13f70aabb29f8b4f7e5239b48806f66e9af5376
-  data.tar.gz: bb5c2b32b2086f913fd6e8f55566b9a6bb6331aae414922e65696e4eb87457fe
+  metadata.gz: 4aa9700782e672548a16cd10395610a658bb73d37af363cd657f3f373c7118fe
+  data.tar.gz: 1995b50234b20e9a270fe35d7766dc0b816e6473723fe8d421278a04650257a5
 SHA512:
-  metadata.gz: 70c330fa68f5a42588f7dfa815b7e2276b508de5c3a606c058d37afff5ef3b50ba3c3071cbb51356fd859c97ca19ffdd95a986931e4f54b752ad2b11b352feae
-  data.tar.gz: 0d0dde39080876a24f52256c503778226ae53bf0a668ba55503ae6c76bb4d0731b1cb7c775029fd2ec258c5e4eacbcb679272d7dd9495831ac1f6b77d56124ff
+  metadata.gz: b3856b5f92ba6a00cea9646c7aa18baa9739cd9f6472baef18f8bfae35db0c7047af98f2041e551382e2cff23505a00ba6c0da1cd7354e70b66c0e0d65bdf5e6
+  data.tar.gz: 44941a41ca3b8abd09b36a81fb7ebecc37cb4174092ae3bec5de96b2b0cc6e24830417933b374f8c91d4a32faf0838fc887c245a9080960f8c07e45166c976d0

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:
 
@@ -158,6 +160,7 @@ config.async = lambda { |event, hint| SentryJob.perform_later(event, hint) }
 
 class SentryJob < ActiveJob::Base
   queue_as :default
+  discard_on ActiveJob::DeserializationError # this will prevent infinite loop when there's an issue deserializing SentryJob
 
   def perform(event, hint)
     Sentry.send_event(event, hint)
@@ -165,8 +168,13 @@ class SentryJob < ActiveJob::Base
 end
 ```
 
+If you also use `sentry-rails`, you can directly use the job we defined for you:
+
+```ruby
+config.async = lambda { |event, hint| Sentry::SendEventJob.perform_later(event, hint) }
+```
 
-**After version 4.1.0**, `sentry-ruby` sends events asynchronously by default. The functionality works like this: 
+**After version 4.1.0**, `sentry-ruby` 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.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 4.2.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-02-04 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.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !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/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/argument_checking_helper.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,120 +0,0 @@
-# Changelog
-
-## 4.1.4
-
-- Fix headers serialization for sentry-ruby [#1197](https://github.com/getsentry/sentry-ruby/pull/1197) (by @moofkit)
-- Support capturing "sentry-trace" header from the middleware [#1205](https://github.com/getsentry/sentry-ruby/pull/1205)
-- Document public APIs on the Sentry module [#1208](https://github.com/getsentry/sentry-ruby/pull/1208)
-- Check the argument type of capture_exception and capture_event helpers [#1209](https://github.com/getsentry/sentry-ruby/pull/1209)
-
-## 4.1.3
-
-- rm reference to old constant (from Rails v2.2) [#1184](https://github.com/getsentry/sentry-ruby/pull/1184)
-- Use copied env in events [#1186](https://github.com/getsentry/sentry-ruby/pull/1186)
-  - Fixes [#1183](https://github.com/getsentry/sentry-ruby/issues/1183)
-- Refactor RequestInterface [#1187](https://github.com/getsentry/sentry-ruby/pull/1187)
-- Supply event hint to async callback when possible [#1189](https://github.com/getsentry/sentry-ruby/pull/1189)
-  - Fixes [#1188](https://github.com/getsentry/sentry-ruby/issues/1188)
-- Refactor stacktrace parsing and increase test coverage [#1190](https://github.com/getsentry/sentry-ruby/pull/1190)
-- Sentry.send_event should also take a hint [#1192](https://github.com/getsentry/sentry-ruby/pull/1192)
-
-## 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