sentry-sidekiq 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3dcbdbb06dfb5f66f6f2c0eaf94d16acd55b5a977908c39ea2623df6185a9304
+  data.tar.gz: edf38d17f4163966a3173c25440acff488c5aaf155926843526458bf7f8ee2cd
+SHA512:
+  metadata.gz: b39e448dd3cb7178a23b6df2ac22c548d465178b6a2303235aa43c868adc69dbcc37b50b0e1cd290d35802d4d9f1c5d4ac9d8fb24786120f93843743c036d476
+  data.tar.gz: '0840c9eb5f8dd8c0a0f90b4a511b3713aba46c6c6aa4e7c5cfa9d44ef5fe463ac0f2f535880e0addc77e63d283f90d55aae143f9ec281ffdad0f7a9623131465'

data/.craft.yml

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

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.1
+
+Release test
+
+## 0.1.0
+
+First version
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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

@@ -0,0 +1,15 @@
+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 "sidekiq"
+gem "activejob"
+
+gem "sentry-ruby", path: "../sentry-ruby"
+
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 st0012
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# sentry-sidekiq
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sentry-sidekiq'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+See `sentry-ruby` for how to configure the Sentry client.
+
+You can also see the example under the `/example` folder.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sentry-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sentry-ruby/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sentry::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sentry-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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/example/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "sidekiq"
+gem "sentry-sidekiq", path: "../"
+gem "sentry-ruby", path: "../../sentry-ruby"
+
+gem "pry"

data/example/README.md

@@ -0,0 +1,8 @@
+# sentry-sidekiq example
+
+## Usage
+
+1. run `bundle install`
+2. change the `dsn` inside `error_worker.rb`
+3. run `bundle exec sidekiq -r ./error_worker.rb`
+4. you should see the event from your Sentry dashboard

data/example/config/sidekiq.yml

@@ -0,0 +1,8 @@
+---
+:verbose: false
+:concurrency: 10
+:timeout: 25
+
+:queues:
+  - default
+

data/example/error_worker.rb

@@ -0,0 +1,18 @@
+require "sidekiq"
+require "sentry/sidekiq"
+
+Sentry.init do |config|
+  config.breadcrumbs_logger = [:sentry_logger]
+  # replace it with your sentry dsn
+  config.dsn = 'https://2fb45f003d054a7ea47feb45898f7649@o447951.ingest.sentry.io/5434472'
+end
+
+class ErrorWorker
+  include Sidekiq::Worker
+
+  def perform
+    1 / 0
+  end
+end
+
+ErrorWorker.perform_async

data/lib/sentry/sidekiq.rb

@@ -0,0 +1,23 @@
+require "sidekiq"
+require "sentry"
+require "sentry/sidekiq/error_handler"
+require "sentry/sidekiq/cleanup_middleware"
+# require "sentry/sidekiq/configuration"
+
+module Sentry
+  module Sidekiq
+    META = { "name" => "sentry.ruby.sidekiq", "version" => Sentry::Sidekiq::VERSION }.freeze
+  end
+
+  def self.sdk_meta
+    Sentry::Sidekiq::META
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.error_handlers << Sentry::Sidekiq::ErrorHandler.new
+  config.server_middleware do |chain|
+    chain.add Sentry::Sidekiq::CleanupMiddleware
+  end
+end
+

data/lib/sentry/sidekiq/cleanup_middleware.rb

@@ -0,0 +1,19 @@
+module Sentry
+  module Sidekiq
+    class CleanupMiddleware
+      def call(_worker, job, queue)
+        Sentry.clone_hub_to_current_thread
+        Sentry.with_scope do |scope|
+          scope.set_extras(sidekiq: job.merge("queue" => queue))
+          scope.set_transaction_name("Sidekiq/#{job["class"]}")
+
+          begin
+            yield
+          rescue => ex
+            Sentry.capture_exception(ex)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentry/sidekiq/context_filter.rb

@@ -0,0 +1,43 @@
+module Sentry
+  module Sidekiq
+    class ContextFilter
+      ACTIVEJOB_RESERVED_PREFIX_REGEX = /^_aj_/.freeze
+
+      def initialize
+        @has_global_id = defined?(GlobalID)
+      end
+
+      # Once an ActiveJob is queued, ActiveRecord references get serialized into
+      # some internal reserved keys, such as _aj_globalid.
+      #
+      # The problem is, if this job in turn gets queued back into ActiveJob with
+      # these magic reserved keys, ActiveJob will throw up and error. We want to
+      # capture these and mutate the keys so we can sanely report it.
+      def filter_context(context)
+        case context
+        when Array
+          context.map { |arg| filter_context(arg) }
+        when Hash
+          Hash[context.map { |key, value| filter_context_hash(key, value) }]
+        else
+          if has_global_id? && context.is_a?(GlobalID)
+            context.to_s
+          else
+            context
+          end
+        end
+      end
+
+      private
+
+      def filter_context_hash(key, value)
+        key = key.to_s.sub(ACTIVEJOB_RESERVED_PREFIX_REGEX, "") if key.match(ACTIVEJOB_RESERVED_PREFIX_REGEX)
+        [key, filter_context(value)]
+      end
+
+      def has_global_id?
+        @has_global_id
+      end
+    end
+  end
+end

data/lib/sentry/sidekiq/error_handler.rb

@@ -0,0 +1,38 @@
+require 'sentry/sidekiq/context_filter'
+
+module Sentry
+  module Sidekiq
+    class ErrorHandler
+      SIDEKIQ_NAME = "Sidekiq".freeze
+
+      def call(ex, context)
+        context = Sentry::Sidekiq::ContextFilter.new.filter_context(context)
+
+        Sentry.with_scope do |scope|
+          scope.set_transaction_name transaction_from_context(context)
+          Sentry.capture_exception(
+            ex,
+            extra: { sidekiq: context }
+          )
+        end
+      end
+
+      private
+
+      # this will change in the future:
+      # https://github.com/mperham/sidekiq/pull/3161
+      def transaction_from_context(context)
+        classname = (context["wrapped"] || context["class"] ||
+                      (context[:job] && (context[:job]["wrapped"] || context[:job]["class"]))
+                    )
+        if classname
+          "#{SIDEKIQ_NAME}/#{classname}"
+        elsif context[:event]
+          "#{SIDEKIQ_NAME}/#{context[:event]}"
+        else
+          SIDEKIQ_NAME
+        end
+      end
+    end
+  end
+end

data/lib/sentry/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module Sentry
+  module Sidekiq
+    VERSION = "0.1.1"
+  end
+end

data/sentry-sidekiq.gemspec

@@ -0,0 +1,26 @@
+require_relative "lib/sentry/sidekiq/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentry-sidekiq"
+  spec.version       = Sentry::Sidekiq::VERSION
+  spec.authors = ["Sentry Team"]
+  spec.description = spec.summary = "A gem that provides Sidekiq integration for the Sentry error logger"
+  spec.email = "accounts@sentry.io"
+  spec.license = 'Apache-2.0'
+  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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sentry-ruby"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: sentry-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sentry Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  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 Sidekiq integration for the Sentry error logger
+email: accounts@sentry.io
+executables: []
+extensions: []
+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
+- example/Gemfile
+- example/README.md
+- example/config/sidekiq.yml
+- example/error_worker.rb
+- lib/sentry/sidekiq.rb
+- lib/sentry/sidekiq/cleanup_middleware.rb
+- lib/sentry/sidekiq/context_filter.rb
+- lib/sentry/sidekiq/error_handler.rb
+- lib/sentry/sidekiq/version.rb
+- sentry-sidekiq.gemspec
+homepage: https://github.com/getsentry/sentry-ruby
+licenses:
+- Apache-2.0
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A gem that provides Sidekiq integration for the Sentry error logger
+test_files: []