newrelic-sidekiq-metrics 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff56e51fac9a560c1252483b241aa4a8112a1e290184b08e80cd63cdd4f96d93
+  data.tar.gz: 7e00e186e2714f57619ff71ec79280079c2308a4eace5bc5be68bed1521bf469
+SHA512:
+  metadata.gz: 760a01007bedef4642cc65a91bc38f12e0c76b88e3da003c97e24c49fcd7555d158998a582c28a01340ff772c92b7e5b7a198888e5d156ceecf0785e17a15556
+  data.tar.gz: 2fb59a2474621dfe067ddcfc007d329aec2f9173aa3d2a488aae03f54cae16015d4353a8711f421c21c641ad590747890352a63a06da0f5c1b2b8fd25e52f73a

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+
+# rspec failure tracking
+.rspec_status
+
+# Cached rubocop config files
+.rubocop-http*

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require:
+  - rubocop-performance
+
+inherit_from:
+  - https://raw.githubusercontent.com/RenoFi/rubocop/master/ruby.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Naming/FileName:
+  Exclude:
+    - 'lib/*.rb'

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.5

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.7
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    newrelic-sidekiq-metrics (0.2.0)
+      newrelic_rpm (~> 6.7.0)
+      sidekiq (~> 6.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    newrelic_rpm (6.7.0.359)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
+    rainbow (3.0.0)
+    rake (13.0.0)
+    redis (4.1.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.0)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    sidekiq (6.0.3)
+      connection_pool (>= 2.2.2)
+      rack (>= 2.0.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  newrelic-sidekiq-metrics!
+  pry
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 RenoFi
+
+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,49 @@
+[![Gem Version](https://badge.fury.io/rb/newrelic-sidekiq-metrics.svg)](https://rubygems.org/gems/newrelic-sidekiq-metrics)
+[![Build Status](https://travis-ci.org/RenoFi/newrelic-sidekiq-metrics.svg?branch=master)](https://travis-ci.org/RenoFi/newrelic-sidekiq-metrics)
+
+# newrelic-sidekiq-metrics
+
+Implements recording Sidekiq stats to New Relic metrics.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'newrelic-sidekiq-metrics'
+```
+
+## Usage
+
+Available metrics you can record are:
+
+```
+----------------------------------------------------
+| Sidekiq stat name |    NewRelic metric name      |
+----------------------------------------------------
+| processed         | Custom/Sidekiq/ProcessedSize |
+| failed            | Custom/Sidekiq/FailedSize    |
+| scheduled_size    | Custom/Sidekiq/ScheduledSize |
+| retry_size        | Custom/Sidekiq/RetrySize     |
+| dead_size         | Custom/Sidekiq/DeadSize      |
+| enqueued          | Custom/Sidekiq/EnqueuedSize  |
+| processes_size    | Custom/Sidekiq/ProcessesSize |
+| workers_size      | Custom/Sidekiq/WorkersSize   |
+----------------------------------------------------
+```
+
+By default only `enqueued` and `retry_size` are recorded.
+
+You can enable more with:
+
+```ruby
+NewrelicSidekiqMetrics.use(:enqueued, :retry_size, :dead_size)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RenoFi/newrelic-sidekiq-metrics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'newrelic_sidekiq_metrics'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %w[spec rubocop:auto_correct]

data/lib/newrelic-sidekiq-metrics.rb

@@ -0,0 +1 @@
+require 'newrelic_sidekiq_metrics'

data/lib/newrelic_sidekiq_metrics.rb

@@ -0,0 +1,56 @@
+require 'sidekiq/api'
+require 'newrelic_rpm'
+require 'newrelic_sidekiq_metrics/version'
+require 'newrelic_sidekiq_metrics/recorder'
+require 'newrelic_sidekiq_metrics/middleware'
+
+module NewrelicSidekiqMetrics
+  METRIC_PREFIX = 'Custom/Sidekiq'.freeze
+
+  METRIC_MAP = {
+    processed:      'ProcessedSize',
+    failed:         'FailedSize',
+    scheduled_size: 'ScheduledSize',
+    retry_size:     'RetrySize',
+    dead_size:      'DeadSize',
+    enqueued:       'EnqueuedSize',
+    processes_size: 'ProcessesSize',
+    workers_size:   'WorkersSize',
+  }.freeze
+
+  DEFAULT_ENABLED_METRICS = %i[enqueued retry_size].freeze
+
+  def self.available_metrics
+    METRIC_MAP.keys
+  end
+
+  def self.used_metrics
+    @used_metrics ||= DEFAULT_ENABLED_METRICS
+  end
+
+  def self.use(*values)
+    @used_metrics = values.flatten & available_metrics
+  end
+
+  def self.add_client_middleware
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add NewrelicSidekiqMetrics::Middleware
+      end
+    end
+  end
+
+  def self.add_server_middleware
+    Sidekiq.configure_server do |config|
+      config.client_middleware do |chain|
+        chain.add NewrelicSidekiqMetrics::Middleware
+      end
+      config.server_middleware do |chain|
+        chain.add NewrelicSidekiqMetrics::Middleware
+      end
+    end
+  end
+end
+
+NewrelicSidekiqMetrics.add_client_middleware
+NewrelicSidekiqMetrics.add_server_middleware

data/lib/newrelic_sidekiq_metrics/middleware.rb

@@ -0,0 +1,8 @@
+module NewrelicSidekiqMetrics
+  class Middleware
+    def call(*)
+      Recorder.new.call
+      yield
+    end
+  end
+end

data/lib/newrelic_sidekiq_metrics/recorder.rb

@@ -0,0 +1,24 @@
+module NewrelicSidekiqMetrics
+  class Recorder
+    attr_reader :stats, :metrics
+
+    def initialize
+      @stats = Sidekiq::Stats.new
+      @metrics = NewrelicSidekiqMetrics.used_metrics
+    end
+
+    def call
+      metrics.each { |m| record_metric(m) }
+    end
+
+    private
+
+    def record_metric(name)
+      NewRelic::Agent.record_metric(metric_full_name(name), stats.public_send(name))
+    end
+
+    def metric_full_name(name)
+      File.join(METRIC_PREFIX, METRIC_MAP.fetch(name))
+    end
+  end
+end

data/lib/newrelic_sidekiq_metrics/version.rb

@@ -0,0 +1,3 @@
+module NewrelicSidekiqMetrics
+  VERSION = "0.2.0".freeze
+end

data/newrelic-sidekiq-metrics.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'newrelic_sidekiq_metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'newrelic-sidekiq-metrics'
+  spec.version  = NewrelicSidekiqMetrics::VERSION
+  spec.authors  = ['Krzysztof Knapik', 'RenoFi Engineering Team']
+  spec.email    = ['knapo@knapo.net', 'engineering@renofi.com']
+
+  spec.summary  = 'Implements recording Sidekiq stats to New Relic metrics.'
+  spec.homepage = 'https://github.com/RenoFi/newrelic-sidekiq-metrics'
+  spec.license  = 'MIT'
+
+  spec.metadata['homepage_uri'] = 'https://github.com/RenoFi/newrelic-sidekiq-metrics'
+  spec.metadata['source_code_uri'] = 'https://github.com/RenoFi/newrelic-sidekiq-metrics'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_dependency 'newrelic_rpm', '~> 6.7.0'
+  spec.add_dependency 'sidekiq', '~> 6.0.3'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: newrelic-sidekiq-metrics
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Krzysztof Knapik
+- RenoFi Engineering Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.7.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  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: rubocop-performance
+  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: 
+email:
+- knapo@knapo.net
+- engineering@renofi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/newrelic-sidekiq-metrics.rb
+- lib/newrelic_sidekiq_metrics.rb
+- lib/newrelic_sidekiq_metrics/middleware.rb
+- lib/newrelic_sidekiq_metrics/recorder.rb
+- lib/newrelic_sidekiq_metrics/version.rb
+- newrelic-sidekiq-metrics.gemspec
+homepage: https://github.com/RenoFi/newrelic-sidekiq-metrics
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RenoFi/newrelic-sidekiq-metrics
+  source_code_uri: https://github.com/RenoFi/newrelic-sidekiq-metrics
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Implements recording Sidekiq stats to New Relic metrics.
+test_files: []