sentry-smart-sampler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c153ce539a78bfd853358b91da59c219dd8aa09cc5da4b07aefd7fea0574f3b9
+  data.tar.gz: 3fb8b058f618e8738bf7aff076b02b1a90417c9081e6a087c63f0ef25a759730
+SHA512:
+  metadata.gz: c085db3f77003cfaf788f7288c2040d730ae7d429c5f53a7c218c2561b024f38a6ec951c99357fa4ac2b09d0ebd2e8891ba017fc17fa7c1263a1288185e7dfc3
+  data.tar.gz: 7b3aa4862c7f7c9db9f0631239ff25ae3dfe39109af3ad4b97220f3441bf7876955fac7363b9cdafeb17f2525cd191ea98958f3e24b27a6195ee6f8cdba0598c

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:2.7.2
+    steps:
+      - checkout
+      - run:
+          name: Run the default task
+          command: |
+            gem install bundler -v 2.2.11
+            bundle install
+            bundle exec rake

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+on: [pull_request]
+jobs:
+  rubocop:
+    strategy:
+      fail-fast: true
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle exec rubocop
+  rspec:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.0', '3.1' ]
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

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/.rubocop.yml

@@ -0,0 +1,115 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - "db/**/*"
+    - "bin/**/*"
+    - "tmp/**/*"
+    - "log/**/*"
+    - "vendor/**/*"
+    - "spec/rails_helper.rb"
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ArrayAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/SpaceBeforeBrackets:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Metrics/ParameterLists:
+  MaxOptionalParameters: 4
+
+RSpec/ExpectChange:
+  EnforcedStyle: block
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 20
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/CommandLiteral:
+  EnforcedStyle: percent_x
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/sentry-smart-sampler.rb'
+
+RSpec/ExampleLength:
+  Max: 7
+

data/.rubocop_todo.yml

@@ -0,0 +1,3 @@
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/sentry_smart_sampler/sampler.rb'

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-16
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sentry-smart-sampler.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "redis"
+gem "rspec", "~> 3.0"
+gem "rubocop", require: false
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "timecop"

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    sentry-smart-sampler (0.1.0)
+      activesupport (>= 5)
+      sentry-ruby (~> 5)
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.7.1)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    sentry-ruby (5.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+    timecop (0.9.5)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-darwin-18
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  redis
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  sentry-smart-sampler!
+  timecop
+
+BUNDLED WITH
+   2.2.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Karol Galanciak
+
+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,83 @@
+# SentrySmartSampler
+
+Smart sampler for `sentry-ruby` with rate limiting/throttling and sampling specific errors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sentry-smart-sampler'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sentry-smart-sampler
+
+## Usage
+
+Inside Sentry initializer:
+
+``` rb
+Rails.application.config.to_prepare do
+  SentrySmartSampler.configure do |config|
+    config.cache_storage = Rails.cache # ideally a Rails cache backed by Redis. But could be anything responding to the same interface
+    config.logger = Rails.logger
+    config.default_sample_rate = 0.5 # defaults to 1
+    config.declare_sampling_rate_per_error do
+      declare Faraday::ClientError, sample_rate: 0.1
+      declare ActiveRecord::RecordInvalid, sample_rate: 0.2
+      declare /message pattern as regexp/, sample_rate: 0.3
+      declare "message pattern as string", sample_rate: 0.4
+    end
+    
+    config.default_throttling_errors_number_threshold = 100 # do not set it if you don't want errors to be throttled
+    config.default_throttling_time_unit = :minute  # do not set it if you don't want errors to be throttled, other options: [:second, :minute, :hour, :day]
+    # this config means that at most 100 errors of the same type can be sent withing a minute
+    
+    config.declare_throttling_per_error do
+      declare ActiveRecord::StatementInvalid, time_unit: :hour, threshold: 50
+      declare /message pattern as regexp/, time_unit: :hour, threshold: 100
+      declare "message pattern as string", time_unit: :hour, threshold: 200
+    end
+    
+    config.after_throttling_threshold_reached = lambda do |event, hint|
+      # do something when the threshold is reached, e.g. send a Slack notification. This callback will be fired at most once, when the threshold is reached. Not required
+      # when not provided, the error will be logged using logger
+    end
+    
+    # not-required and not recommended to set unless you really know what you are doing
+    # the default definition of of reaching threshold is when the number of errors reaches the provided threshold for a given error within a given time unit
+    # if you really want to customize it (because you want e.g. to have another notification delivered from `after_throttling_threshold_reached` when you reach 10x of the threshold
+    # you need create an object that responds to `reached?` method taking 3 arguments: rate_limit, throttling_registration, error
+    # check `SentrySmartSampler::ThrottlingThresholdReachedDefinition` for more details
+    config.throttling_threshold_reached_definition = SomeCustomClassImplementingThrottlingThresholdReachedDefinition.new 
+  end
+end
+
+Sentry.init do |config| 
+  config.dsn = ENV["SENTRY_DSN"]
+  
+  config.before_send = lambda do |event, hint|
+    SentrySmartSampler.call(event, hint) # returns event or nil if the event should be dropped
+  end
+end
+```
+
+## 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 the created tag, 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-smart-sampler.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sentry/smart/sampler"
+
+# 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/lib/sentry/smart/sampler/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Smart
+    module Sampler
+      module Version
+      end
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/sentry/smart/sampler.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "sampler/version"
+
+# Your code goes here...
+module Sentry
+  module Smart
+    module Sampler
+      class Error < StandardError
+        # Your code goes here...
+      end
+    end
+  end
+end

data/lib/sentry-smart-sampler.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "sentry_smart_sampler"

data/lib/sentry_smart_sampler/configuration.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class SentrySmartSampler
+  class Configuration
+    attr_accessor :cache_storage, :logger, :default_throttling_errors_number_threshold
+    attr_reader :default_throttling_time_unit
+    attr_writer :default_sample_rate, :after_throttling_threshold_reached, :throttling_threshold_reached_definition
+
+    TIME_UNITS = %i[second minute hour day].freeze
+    private_constant :TIME_UNITS
+
+    def default_sample_rate
+      @default_sample_rate || 1
+    end
+
+    def after_throttling_threshold_reached
+      @after_throttling_threshold_reached || default_after_throttling_threshold_reached_callback
+    end
+
+    def default_throttling_time_unit=(time_unit)
+      time_unit = time_unit.to_sym
+      validate_time_unit(time_unit)
+      @default_throttling_time_unit = time_unit
+    end
+
+    def declare_sampling_rate_per_error(&block)
+      sampling_rate_per_error_registry.instance_exec(&block)
+    end
+
+    def sampling_rate_per_error_registry
+      @sampling_rate_per_error_registry ||= SampleRatePerErrorRegistry.new(default_sample_rate)
+    end
+
+    def declare_throttling_per_error(&block)
+      throttling_per_error_registry.instance_exec(&block)
+    end
+
+    def throttling_per_error_registry
+      @throttling_per_error_registry ||= ThrottlingPerErrorRegistry.new(default_throttling_errors_number_threshold,
+        default_throttling_time_unit)
+    end
+
+    def throttling_threshold_reached_definition
+      @throttling_threshold_reached_definition || ThrottlingThresholdReachedDefinition.new
+    end
+
+    private
+
+    def validate_time_unit(time_unit)
+      TIME_UNITS.include?(time_unit) or raise_invalid_time_unit_error(time_unit)
+    end
+
+    def raise_invalid_time_unit_error(time_unit)
+      raise(ArgumentError.new("Invalid time unit: :#{time_unit}, allowed_values: #{TIME_UNITS}"))
+    end
+
+    def default_after_throttling_threshold_reached_callback
+      lambda do |_event, hint|
+        error = hint[:exception]
+        logger.info "[SentrySmartSampler] Throttling threshold reached for #{error.class}: #{error.message}"
+      end
+    end
+  end
+end

data/lib/sentry_smart_sampler/rate_limit.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class SentrySmartSampler
+  class RateLimit
+    KEY_PREFIX = "sentry_smart_sampler"
+    private_constant :KEY_PREFIX
+
+    attr_reader :key, :threshold, :interval, :increment, :cache
+    private     :key, :threshold, :interval, :increment, :cache
+
+    def initialize(key:, threshold:, interval:, increment: 1, cache: SentrySmartSampler.configuration.cache_storage)
+      @key = key
+      @threshold = threshold
+      @interval = interval
+      @increment = increment
+      @cache = cache
+    end
+
+    def throttled?
+      count >= threshold
+    end
+
+    def count
+      cache.read(storage_key, raw: true).to_i
+    end
+
+    def remaining
+      threshold - count
+    end
+
+    def clear!
+      cache.delete(storage_key)
+    end
+
+    def increase
+      cache.increment(storage_key, increment) || increment
+    end
+
+    def storage_key
+      "#{KEY_PREFIX}/#{normalized_key}"
+    end
+
+    # let's say that the interval is 1.hour
+    # the current time is 15:05
+    # window is going to keep the same value until another interval time starts
+    # a new window is going to be start at 16:00
+    def window
+      Time.current.to_i / interval
+    end
+
+    private
+
+    def normalized_key
+      Digest::MD5.hexdigest([key, window].flatten.join("/"))
+    end
+  end
+end

data/lib/sentry_smart_sampler/sample_rate_per_error_registry.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class SentrySmartSampler
+  class SampleRatePerErrorRegistry
+    attr_reader :default_sample_rate, :registry
+    private     :default_sample_rate, :registry
+
+    def initialize(default_sample_rate)
+      @default_sample_rate = default_sample_rate
+      @registry = []
+    end
+
+    def declare(samplable, sample_rate:)
+      registry << Registration.new(samplable: samplable, sample_rate: sample_rate)
+    end
+
+    def sample_rate_registration_for(error)
+      registry.find(-> { default_registration }) { |registration| registration.matches?(error) }
+    end
+
+    private
+
+    def default_registration
+      Registration.new(samplable: nil, sample_rate: default_sample_rate)
+    end
+
+    class Registration
+      attr_reader :samplable, :sample_rate
+
+      def initialize(samplable:, sample_rate:)
+        @samplable = samplable
+        @sample_rate = sample_rate
+      end
+
+      def matches?(matchable_error)
+        if samplable.is_a?(Regexp) || samplable.respond_to?(:to_str)
+          matchable_error.message.scan(samplable).any?
+        else
+          matchable_error.is_a?(samplable)
+        end
+      end
+    end
+  end
+end

data/lib/sentry_smart_sampler/sampler.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class SentrySmartSampler
+  class Sampler
+    attr_reader :registry, :random_generator, :cache_storage, :after_throttling_threshold_reached,
+      :throttling_threshold_reached_definition
+    private     :registry, :random_generator, :cache_storage, :after_throttling_threshold_reached,
+      :throttling_threshold_reached_definition
+
+    def initialize(registry, random_generator: Random, configuration: SentrySmartSampler.configuration)
+      @registry = registry
+      @random_generator = random_generator
+      @cache_storage = configuration.cache_storage
+      @after_throttling_threshold_reached = configuration.after_throttling_threshold_reached
+      @throttling_threshold_reached_definition = configuration.throttling_threshold_reached_definition
+    end
+
+    def call(event, hint)
+      error = hint[:exception]
+      throttling_registration = registry.throttling_registration_for(error)
+
+      if apply_throttling?(throttling_registration)
+        rate_limit = initialize_rate_limit(throttling_registration, error)
+        already_throttled = rate_limit.throttled?
+        rate_limit.increase
+        after_throttling_threshold_reached.call(event, hint) if throttling_threshold_reached_definition.reached?(
+          rate_limit, throttling_registration, error
+        )
+        return if already_throttled
+      end
+
+      sample(event, error)
+    end
+
+    private
+
+    def apply_throttling?(throttling_registration)
+      throttling_registration.threshold && throttling_registration.time_unit && cache_storage
+    end
+
+    def initialize_rate_limit(throttling_registration, error)
+      SentrySmartSampler::RateLimit.new(key: throttling_registration.throttable || error.class,
+        threshold: throttling_registration.threshold,
+        interval: 1.public_send(throttling_registration.time_unit),
+        cache: cache_storage)
+    end
+
+    def threshold_reached?(rate_limit, throttling_registration, error); end
+
+    def sample(event, error)
+      event if random_generator.rand <= registry.sample_rate_registration_for(error).sample_rate
+    end
+  end
+end

data/lib/sentry_smart_sampler/throttling_per_error_registry.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class SentrySmartSampler
+  class ThrottlingPerErrorRegistry
+    attr_reader :default_throttling_errors_number_threshold, :default_throttling_time_unit, :registry
+    private     :default_throttling_errors_number_threshold, :default_throttling_time_unit, :registry
+
+    def initialize(default_throttling_errors_number_threshold, default_throttling_time_unit)
+      @default_throttling_errors_number_threshold = default_throttling_errors_number_threshold
+      @default_throttling_time_unit = default_throttling_time_unit
+      @registry = []
+    end
+
+    def declare(throttable, time_unit:, threshold:)
+      registry << Registration.new(throttable: throttable, time_unit: time_unit, threshold: threshold)
+    end
+
+    def throttling_registration_for(error)
+      registry.find(-> { default_registration }) { |registration| registration.matches?(error) }
+    end
+
+    private
+
+    def default_registration
+      Registration.new(throttable: nil, time_unit: default_throttling_time_unit,
+        threshold: default_throttling_errors_number_threshold)
+    end
+
+    class Registration
+      attr_reader :throttable, :threshold, :time_unit
+
+      def initialize(throttable:, threshold:, time_unit:)
+        @throttable = throttable
+        @threshold = threshold
+        @time_unit = time_unit
+      end
+
+      def matches?(matchable_error)
+        if throttable.is_a?(Regexp) || throttable.respond_to?(:to_str)
+          matchable_error.message.scan(throttable).any?
+        else
+          matchable_error.is_a?(throttable)
+        end
+      end
+    end
+  end
+end

data/lib/sentry_smart_sampler/throttling_threshold_reached_definition.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class SentrySmartSampler
+  class ThrottlingThresholdReachedDefinition
+    def reached?(rate_limit, throttling_registration, _error)
+      rate_limit.throttled? && rate_limit.count == throttling_registration.threshold
+    end
+  end
+end

data/lib/sentry_smart_sampler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/sentry-smart-sampler.rb")
+loader.setup
+
+class SentrySmartSampler
+  def self.configuration
+    @configuration ||= SentrySmartSampler::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.sample_rate_registration_for(error)
+    configuration.sampling_rate_per_error_registry.sample_rate_registration_for(error)
+  end
+
+  def self.throttling_registration_for(error)
+    configuration.throttling_per_error_registry.throttling_registration_for(error)
+  end
+
+  def self.call(event, hint)
+    SentrySmartSampler::Sampler.new(self).call(event, hint)
+  end
+
+  def self.reset!
+    @configuration = nil
+  end
+end

data/sentry-smart-sampler.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/sentry/smart/sampler/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentry-smart-sampler"
+  spec.version       = Sentry::Smart::Sampler::VERSION
+  spec.authors       = ["Karol Galanciak"]
+  spec.email         = ["karol.galanciak@gmail.com"]
+
+  spec.summary       = "Smart sampler for sentry-ruby with rate limiting/throttling and sampling specific errors"
+  spec.description   = "Smart sampler for sentry-ruby with rate limiting/throttling and sampling specific errors"
+  spec.homepage      = "https://github.com/BookingSync/sentry-smart-sampler"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/BookingSync/sentry-smart-sampler"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  spec.add_dependency "activesupport", ">= 5"
+  spec.add_dependency "sentry-ruby", "~> 5"
+  spec.add_dependency "zeitwerk"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sentry-smart-sampler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Galanciak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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: Smart sampler for sentry-ruby with rate limiting/throttling and sampling
+  specific errors
+email:
+- karol.galanciak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sentry-smart-sampler.rb
+- lib/sentry/smart/sampler.rb
+- lib/sentry/smart/sampler/version.rb
+- lib/sentry_smart_sampler.rb
+- lib/sentry_smart_sampler/configuration.rb
+- lib/sentry_smart_sampler/rate_limit.rb
+- lib/sentry_smart_sampler/sample_rate_per_error_registry.rb
+- lib/sentry_smart_sampler/sampler.rb
+- lib/sentry_smart_sampler/throttling_per_error_registry.rb
+- lib/sentry_smart_sampler/throttling_threshold_reached_definition.rb
+- sentry-smart-sampler.gemspec
+homepage: https://github.com/BookingSync/sentry-smart-sampler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BookingSync/sentry-smart-sampler
+  source_code_uri: https://github.com/BookingSync/sentry-smart-sampler
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Smart sampler for sentry-ruby with rate limiting/throttling and sampling
+  specific errors
+test_files: []