sentry-ruby 0.3.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de5539f70eb6f49164765e4e13416bef15f8b697349f2d2e71f63ac57916f325
-  data.tar.gz: 89121fce3fb31be7fe783599ee204ab86354f70a870ce775c79e4a33f6141e13
+  metadata.gz: 3f450d4675e2f6de879b83853aace0c6051ea680b35832da76a156b3a5d49fea
+  data.tar.gz: 392b363545f23cb65bc2b4a55afaab8767ad6a10f7f74b8d210b29218723dd79
 SHA512:
-  metadata.gz: ca35ae1d033f68fcebfe2c3e9e4b91fa2784a56261423a1bc5e5c7550b6304eb63963bf4273b22e924db27e1287f256e712b7e74781d866e71bae288308e13ae
-  data.tar.gz: e5853d409d5bbbb4b60ecee8c1edc3c6de91971b39938c03a19895ce790246cc234e5441d848aaba745ccc90cc4bbd3f1df4eb3108c18ea68736dab41f2ca93f
+  metadata.gz: 98571bdbba234d79a982596afeb34549def742ad0f4a109af7f61c3d97ea49bddd6f7f65d099c59b6e40f97194f828161b62010216966b44dc3723c36a538543
+  data.tar.gz: c1e513dac483417242989841078adb5c674e7668518c95e1d7246f4b276650d5a45f11ae7f02e3250fbbb6cfc78e0bfdac08d8afb45ba8e59ec11dc409626b33

data/README.md

@@ -2,10 +2,16 @@
   <a href="https://sentry.io" target="_blank" align="center">
     <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
   </a>
-  <br>
+  <br />
 </p>
 
-# sentry-ruby, the Ruby Client for Sentry
+_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [<kbd>**Check out our open positions**</kbd>](https://sentry.io/careers/)_
+
+Sentry SDK for Ruby
+===========
+
+
+**The old `sentry-raven` client has entered maintenance mode and was moved to [here](https://github.com/getsentry/sentry-ruby/tree/master/sentry-raven).**
 
 ---
 
@@ -17,14 +23,20 @@
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-ruby&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-ruby&package-manager=bundler&version-scheme=semver)
 
 
-[Documentation](https://docs.sentry.io/clients/ruby/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
+[Documentation](https://docs.sentry.io/platforms/ruby/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
 
 The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
 
 ## Requirements
 
-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.
+We test on Ruby 2.4, 2.5, 2.6, 2.7, and 3.0 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/).
 
 ## Getting Started
 
@@ -39,6 +51,7 @@ and depends on the integrations you want to have, you might also want to install
 ```ruby
 gem "sentry-rails"
 gem "sentry-sidekiq"
+gem "sentry-delayed_job"
 # and mores to come in the future!
 ```
 
@@ -59,7 +72,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:
 
@@ -70,17 +83,46 @@ Sentry.init do |config|
 end
 ```
 
+### Performance Monitoring
+
+You can activate performance monitoring by enabling traces sampling:
+
+```ruby
+Sentry.init do |config|
+  # set a uniform sample rate between 0.0 and 1.0
+  config.traces_sample_rate = 0.2
+
+  # or control sampling dynamically
+  config.traces_sampler = lambda do |sampling_context|
+    # sampling_context[:transaction_context] contains the information about the transaction
+    # sampling_context[:parent_sampled] contains the transaction's parent's sample decision
+    true # return value can be a boolean or a float between 0.0 and 1.0
+  end
+end
+```
+
+To learn more about performance monitoring, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/performance).
+
 ### Usage
 
 `sentry-ruby` has a default integration with `Rack`, so you only need to use the middleware in your application like:
 
-```
-require 'rack'
+```ruby
 require 'sentry-ruby'
 
-use Sentry::Rack::CaptureException
+Sentry.init do |config|
+  config.dsn = 'https://examplePublicKey@o0.ingest.sentry.io/0'
+
+  # To activate performance monitoring, set one of these options.
+  # We recommend adjusting the value in production:
+  config.traces_sample_rate = 0.5
+  # or
+  config.traces_sampler = lambda do |context|
+    true
+  end
+end
 
-run theapp
+use Sentry::Rack::CaptureExceptions
 ```
 
 Otherwise, Sentry you can always use the capture helpers manually
@@ -99,37 +141,63 @@ We also provide integrations with popular frameworks/libraries with the related
 
 - [sentry-rails](https://github.com/getsentry/sentry-ruby/tree/master/sentry-rails)
 - [sentry-sidekiq](https://github.com/getsentry/sentry-ruby/tree/master/sentry-sidekiq)
+- [sentry-delayed_job](https://github.com/getsentry/sentry-ruby/tree/master/sentry-delayed_job)
 
 ### More configuration
 
 You're all set - but there's a few more settings you may want to know about too!
 
-#### async
+#### Blocking v.s. Non-blocking
+
+`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.
+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.
 
-When an error or message occurs, the notification is immediately sent to Sentry. Sentry can be configured to send asynchronously:
+##### About `Sentry::BackgroundWorker`
+
+- The worker is built on top of the [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby) gem's [ThreadPoolExecutor](http://ruby-concurrency.github.io/concurrent-ruby/master/Concurrent/ThreadPoolExecutor.html), which is also used by Rails ActiveJob's async adapter. This should minimize the risk of messing up client applications with our own thread pool implementaion.
+
+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.async = lambda { |event|
-  Thread.new { Sentry.send_event(event) }
-}
+config.background_worker_threads = 5 # the worker will have 5 threads for sending events
 ```
 
-Using a thread to send events will be adequate for truly parallel Ruby platforms such as JRuby, though the benefit on MRI/CRuby will be limited. If the async callback raises an exception, Sentry will attempt to send synchronously.
+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
+```
 
-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.
+If you want to send a particular event immediately, you can use event hints to do it:
 
 ```ruby
-config.async = lambda { |event| SentryJob.perform_later(event) }
+Sentry.capture_message("send me now!", hint: { background: false })
+```
 
-class SentryJob < ActiveJob::Base
-  queue_as :default
+##### `config.async`
 
-  def perform(event)
-    Sentry.send_event(event)
-  end
-end
+You can also use `config.async` to send events with you own worker:
+
+```ruby
+config.async = lambda { |event, hint| SentryJob.perform_later(event, hint) }
 ```
 
+And if you 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) }
+```
+
+
 #### Contexts
 
 In sentry-ruby, every event will inherit their contextual data from the current scope. So you can enrich the event's data by configuring the current scope like:
@@ -148,6 +216,15 @@ end
 Sentry.capture_exception(exception) # the event will carry all those information now
 ```
 
+Or use top-level setters
+
+
+```ruby
+Sentry.set_user(id: 1, email: "test@example.com")
+Sentry.set_tags(tag_1: "foo", tag_2: "bar")
+Sentry.set_extras(order_number: 1234, tickets_count: 4)
+```
+
 Or build up a temporary scope for local information:
 
 ```ruby
@@ -172,7 +249,8 @@ Sentry.capture_exception(exception, tags: {foo: "bar"})
 
 ## More Information
 
-* [Documentation](https://docs.sentry.io/clients/ruby/)
+* [Documentation](https://docs.sentry.io/platforms/ruby/)
 * [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues)
 * [Forum](https://forum.sentry.io/)
 - [Discord](https://discord.gg/ez5KZN7)
+

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-03-12 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.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 description: A gem that provides a client interface for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -32,62 +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/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/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_exception.rb
-- lib/sentry/rack/tracing.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/transport/state.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,31 +0,0 @@
-# Changelog
-
-## 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"
-
-gem "pry"
-gem "rack"
-
-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