scout_apm_sampler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 075bbdbacb17f3987b92093b6298c71a5f7af5ba0294f848221f2c5efe13033d
+  data.tar.gz: 1825f950472d33c44273f2cdb48dd8df62f9d20a2d599fda6f7ed133fd658d87
+SHA512:
+  metadata.gz: 31c6fc355b493253418116826eb34ed693861a775bac20c3f4049fb9ace99a329efa3772a461909704082ed5dce6f87d46290d35cc429b7715c937a47abd50b0
+  data.tar.gz: be4c27c79bfe3026b58f868f3f33898c346df5a8c4d91c1319959f1d488d3291f552a9fd9fefd0fc740682e9495ad0879950712b8c41eb0ffb02e5a5a3a919e6

data/README.md

@@ -0,0 +1,37 @@
+# scout_apm_sampler
+
+Instrument only a percentage of your Rails app's web requests and background jobs in Scout APM so you can subscribe to an affordable plan in Scout APM
+
+## Why
+
+Application Performance Management (APM) tools are often expensive. This forces many startups to forego using an APM tool. This gem helps you instrument only a percentage of your Rails app's web requests and background jobs in Scout APM so you can subscribe to a plan that's affordable for you now and later upgrade as your revenue grows.
+
+
+## Installation
+
+Add `scout_apm_sampler` to your Rails app's Gemfile
+
+```
+gem "scout_apm_sampler"
+```
+
+and bundle install
+
+```
+bundle install
+```
+
+Now, in an initializer, configure `scout_apm_sampler` to only send a percentage of web requests and background jobs to Scout APM
+
+```ruby
+# config/initializers/scout_apm_sampler.rb
+
+ScoutApmSampler.configure do |config|
+  config.web_request_sampling_rate = 0.1
+  config.background_job_sampling_rate = 0.05
+end
+```
+
+## Todos
+
+- Support other background job systems in addition to Sidekiq

data/Rakefile

@@ -0,0 +1,8 @@
+require_relative "lib/scout_apm_sampler/version"
+
+task :publish do
+  `gem build scout_apm_sampler.gemspec`
+  current_version = ScoutApmSampler::VERSION
+  gem_push_command = "gem push scout_apm_sampler-#{current_version}.gem"
+  system(gem_push_command)
+end

data/lib/scout_apm_sampler/background_job_sampler.rb

@@ -0,0 +1,18 @@
+module ScoutApmSampler
+  class BackgroundJobSampler
+    def call(worker, msg, queue)
+      disable_scout_instrumentation unless instrument_job?
+      yield
+    end
+
+    private
+
+    def instrument_job?
+      rand < ScoutApmSampler.config.background_job_sampling_rate
+    end
+
+    def disable_scout_instrumentation
+      ScoutApm::Transaction.ignore!
+    end
+  end
+end

data/lib/scout_apm_sampler/config.rb

@@ -0,0 +1,6 @@
+module ScoutApmSampler
+  class Config
+    attr_accessor :web_request_sampling_rate
+    attr_accessor :background_job_sampling_rate
+  end
+end

data/lib/scout_apm_sampler/version.rb

@@ -0,0 +1,3 @@
+module ScoutApmSampler
+  VERSION = "0.1.0"
+end

data/lib/scout_apm_sampler/web_request_sampler.rb

@@ -0,0 +1,23 @@
+module ScoutApmSampler
+  module WebRequestSampler
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :instrument_a_percentage_of_web_requests_in_scout
+    end
+
+    def scout_instrument_a_percentage_of_requests
+      disable_scout_instrumentation unless instrument_request?
+    end
+
+    private
+
+    def instrument_request?
+      rand < ScoutApmSampler.config.web_request_sampling_rate
+    end
+
+    def disable_scout_instrumentation
+      ScoutApm::Transaction.ignore!
+    end
+  end
+end

data/lib/scout_apm_sampler.rb

@@ -0,0 +1,26 @@
+require "scout_apm_sampler/version"
+require "scout_apm_sampler/config"
+require "scout_apm_sampler/instrument_a_percentage_of_background_jobs_in_scout_apm"
+require "scout_apm_sampler/instrument_a_percentage_of_web_requests_in_scout_apm"
+
+module ScoutApmSampler
+  class << self
+    def configure
+      yield config
+
+      ApplicationController.class_eval do
+        include ScoutApmSampler::WebRequestSampler
+      end
+
+      Sidekiq.configure_server do |config|
+        config.server_middleware do |chain|
+          chain.add ScoutApmSampler::BackgroundJobSampler
+        end
+      end
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: scout_apm_sampler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nisanth Chunduru
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: scout_apm
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send a percentage of web requests and background jobs to Scout APM so
+  you can subscribe to a affordable plan that's commensurate with your company's revenue
+email:
+- nisanth074@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/scout_apm_sampler.rb
+- lib/scout_apm_sampler/background_job_sampler.rb
+- lib/scout_apm_sampler/config.rb
+- lib/scout_apm_sampler/version.rb
+- lib/scout_apm_sampler/web_request_sampler.rb
+homepage: https://github.com/nisanthchunduru/scout_apm_sampler
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Send a percentage of web requests and background jobs to Scout APM
+test_files: []