newrelic-sidekiq-stats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e7412ea3426783a0101a493cca4277dd78e9769d01f7b0acee7a4e26f3ea0c3
+  data.tar.gz: f53e6aed272aa3cf6e50d99aef38bb24d9f7d074ea81a140d0566e2e9c7e3f60
+SHA512:
+  metadata.gz: 04bcd0661446e05b51d29850f0f52a4bfd24a157f59453ca90e09a637cc1a0e2b6b8f64fae6b17ff2312e6bb54dde8633b03cf5f843717c7a9dcd24859882b5b
+  data.tar.gz: 7238230f969b74a85ff72a2a587946777e75fd83860940a69a1b61eba83e555d45e6601a59009d54e711b39fc2a72e48893ae9a6b037ddc1a3bc859a88c59537

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.4
+before_install: gem install bundler -v 2.1.4

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 benoist.claassen@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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in newrelic-sidekiq-stats.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    newrelic-sidekiq-stats (0.0.1)
+      newrelic_rpm
+      sidekiq
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.3)
+    diff-lcs (1.3)
+    newrelic_rpm (6.11.0.365)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rake (12.3.3)
+    redis (4.2.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    sidekiq (6.0.7)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  newrelic-sidekiq-stats!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,61 @@
+# Newrelic::Sidekiq::Stats
+
+This is a NewRelic Sampler for Sidekiq custom metrics. 
+It will sample the Sidekiq stats and create a custom metric for NewRelic. 
+You can view the information in the NewRelic insights or in NewRelic One.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'newrelic-sidekiq-stats'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install newrelic-sidekiq-stats
+
+## Usage
+
+* Install the gem
+* Create a dashboard on the NewRelic insights or NewRelic One
+
+NQRL example: 
+```
+SELECT rate(average(newrelic.timeslice.value), 1 minute) 
+FROM Metric 
+WHERE appName ='My App Name' 
+WITH METRIC_FORMAT 'Custom/Sidekiq/ScheduledSize' 
+TIMESERIES LIMIT 10 SINCE 1800 seconds ago
+```
+
+Available metrics:
+
+* `Custom/Sidekiq/ProcessedSize`
+* `Custom/Sidekiq/FailedSize`
+* `Custom/Sidekiq/ScheduledSize`
+* `Custom/Sidekiq/RetrySize`
+* `Custom/Sidekiq/DeadSize`
+* `Custom/Sidekiq/EnqueuedSize`
+* `Custom/Sidekiq/ProcessesSize`
+* `Custom/Sidekiq/WorkersSize`
+
+## 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]/newrelic-sidekiq-stats. 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]/newrelic-sidekiq-stats/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Newrelic::Sidekiq::Stats project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/newrelic-sidekiq-stats/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 "newrelic/sidekiq/stats"
+
+# 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/newrelic-sidekiq-stats.rb

@@ -0,0 +1,36 @@
+require 'new_relic/agent/sampler'
+
+module NewRelic
+  module Agent
+    module Samplers
+      class SidekiqSampler < NewRelic::Agent::Sampler
+        METRIC_MAP = {
+          processed:      'ProcessedSize',
+          failed:         'FailedSize',
+          scheduled_size: 'ScheduledSize',
+          retry_size:     'RetrySize',
+          dead_size:      'DeadSize',
+          enqueued:       'EnqueuedSize',
+          processes_size: 'ProcessesSize',
+          workers_size:   'WorkersSize',
+        }.freeze
+
+        named :sidekiq
+
+        def poll
+          return unless Sidekiq.server?
+
+          stats       = Sidekiq::Stats.new
+          max_latency = Sidekiq::Queue.all.map(&:latency).max
+          ::NewRelic::Agent.logger.debug("Recording metric: Custom/Sidekiq/QueueLatency=#{max_latency}")
+          ::NewRelic::Agent.record_metric("Custom/Sidekiq/QueueLatency", max_latency)
+          METRIC_MAP.map do |key, name|
+            value = stats.public_send(key)
+            ::NewRelic::Agent.logger.debug("Recording metric: Custom/Sidekiq/#{name}=#{value}")
+            ::NewRelic::Agent.record_metric("Custom/Sidekiq/#{name}", value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/newrelic_sidekiq_stats/version.rb

@@ -0,0 +1,5 @@
+module NewRelic
+  module SidekiqStats
+    VERSION = '0.0.1'
+  end
+end

data/newrelic-sidekiq-stats.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/newrelic_sidekiq_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "newrelic-sidekiq-stats"
+  spec.version       = NewRelic::SidekiqStats::VERSION
+  spec.authors       = ["Benoist Claassen"]
+  spec.email         = ["benoist.claassen@gmail.com"]
+
+  spec.summary       = %q{Send sidekiq queue stats to new relic}
+  spec.description   = %q{Monitor the queue sizes with new relic}
+  spec.homepage      = "https://github.com/benoist/newrelic-sidekiq-stats"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'newrelic_rpm'
+  spec.add_dependency 'sidekiq'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: newrelic-sidekiq-stats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benoist Claassen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  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: sidekiq
+  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: Monitor the queue sizes with new relic
+email:
+- benoist.claassen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/newrelic-sidekiq-stats.rb
+- lib/newrelic_sidekiq_stats/version.rb
+- newrelic-sidekiq-stats.gemspec
+homepage: https://github.com/benoist/newrelic-sidekiq-stats
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+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: Send sidekiq queue stats to new relic
+test_files: []