scout_apm_savemoney 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db024a1f4a67d8ab49b67abf11a2da233883f062a546b9e1cc12e9b84b237c4f
+  data.tar.gz: 22c25b68e14f4e00c0e2b7e13d8deaeab7797adaddfeb93dd8d59c209ed19054
+SHA512:
+  metadata.gz: 9588763b3688ab0fb6960249b03b0368a99d47c9d153180dfcefcb50c85e5cacde23bc7bfb89817142b2e7c2df22a65d0d8ec3d208fbb86f6a9b7df263bd94f3
+  data.tar.gz: bae1dcfe5d1f266cf9e92c70a46d9c8cc06da2498a24ae505e8c708c8ff927def59d2a675542764a77323c55afd4bf43c10219e5a222bcc2e1d6cdcb773fb123

data/README.md

@@ -0,0 +1,36 @@
+# scout_apm_savemoney
+
+Instrument only a percentage of your Rails app's web requests and background jobs in Scout APM so you can subscribe to a lower plan in Scout APM and save money
+
+## Installation
+
+Add `scout_apm_savemoney` to your Rails app's Gemfile
+
+```
+gem "scout_apm_savemoney"
+```
+
+and bundle install
+
+```
+bundle install
+```
+
+Now, in an initializer, configure `scout_apm_savemoney` to only send a percentage of web requests and background jobs to Scout APM
+
+```ruby
+# config/initializers/scout_apm_savemoney.rb
+
+ScoutApmSaveMoney.configure do |config|
+  config.web_requests_instrumentation_percentage = 10
+  config.background_jobs_instrumentation_percentage = 10
+end
+```
+
+## 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.
+
+## Todos
+
+- Support other background job systems in addition to Sidekiq

data/Rakefile

@@ -0,0 +1,7 @@
+# @example
+#   GEM_HOST_API_KEY="our_rubygems_api_key" bundle exec rake publish_to_rubygems
+task :publish_to_rubygems do
+  `gem build scout_apm_savemoney.gemspec`
+  require_relative "lib/scout_apm_savemoney/version"
+  `gem push scout_apm_savemoney-#{ScoutApmSaveMoney::VERSION}.gem`
+end

data/lib/scout_apm_savemoney.rb

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

data/lib/scout_apm_savemoney/config.rb

@@ -0,0 +1,6 @@
+module ScoutApmSaveMoney
+  class Config
+    attr_accessor :web_requests_instrumentation_percentage
+    attr_accessor :background_jobs_instrumentation_percentage
+  end
+end

data/lib/scout_apm_savemoney/instrument_a_percentage_of_background_jobs_in_scout_apm.rb

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

data/lib/scout_apm_savemoney/instrument_a_percentage_of_web_requests_in_scout_apm.rb

@@ -0,0 +1,23 @@
+module ScoutApmSaveMoney
+  module InstrumentAPercentageOfWebRequestsInScoutApm
+    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 < (ScoutApmSaveMoney.config.web_requests_instrumentation_percentage / 100.0)
+    end
+  
+    def disable_scout_instrumentation
+      ScoutApm::Transaction.ignore!
+    end
+  end
+end

data/lib/scout_apm_savemoney/version.rb

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

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: scout_apm_savemoney
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nisanth Chunduru
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-23 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 lower plan and save money
+email:
+- nisanth074@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/scout_apm_savemoney.rb
+- lib/scout_apm_savemoney/config.rb
+- lib/scout_apm_savemoney/instrument_a_percentage_of_background_jobs_in_scout_apm.rb
+- lib/scout_apm_savemoney/instrument_a_percentage_of_web_requests_in_scout_apm.rb
+- lib/scout_apm_savemoney/version.rb
+homepage: https://github.com/nisanth074/scout_apm_savemoney
+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.4
+signing_key:
+specification_version: 4
+summary: Send a percentage of web requests and background jobs to Scout APM
+test_files: []