newrelic_sidekiq_plugin 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmY3YmE0MTViZjkwYTZlYjk0Yzg3Y2JkN2FjZWQ3YTcxNGNiZGEzZg==
+  data.tar.gz: !binary |-
+    YWRhYTVkM2IyMGViNzliZjMzMWIyNmJmY2Y0ODRjNDYwZDRjMmNiOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDEzZGQ2NmNiYWI5NDUzZjI0OTg4Mjc4ZWNiNGQ3YTQ2YTExMzE4ODc0Njg5
+    MGY2OTIxZTZkZjFiOTA2MWNiOGM1YjE3OWJjMzNkNzA5ODA1ZGYxZDExZWFi
+    YTM3YTczOTRhNmU4NjdjN2M5ODE3MzMzMzI4YmY0NzRkNzE3MjA=
+  data.tar.gz: !binary |-
+    MzFiOWUyYzQwNzQyZTNmYTRjYzU0MzkwNzhkZTgyNzY1NTAwMTk5Y2Y1N2Rm
+    YTA4NWYyN2UwODg2MGNkNjMwMDdmOWIzYjdjYjlhMzc3NWFhNzdlM2EwNjQ2
+    MzZmOTFhNzhmZmI0YTE2ZDUyOGI5YTE4MjgwMTEwOWQxODBlNzk=

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,18 @@
+## NewRelic Sidekiq plugin
+
+This plugin reports back metrics to the NewRelic plugin dashboard.
+
+## Requirements
+
+Ruby 1.9.3  
+Sidekiq 2.13.0  
+
+## Installation
+
+    gem install newrelic_sidekiq_plugin
+    
+## Getting Started
+
+1. Copy `config/newrelic_plugin.yml.example` to `config/newrelic_plugin.yml`
+2. Edit `config/newrelic_plugin.yml` and replace "YOUR_LICENSE_KEY_HERE" with your New Relic license key
+3. run `./bin/newrelic_example_agent`

data/bin/newrelic_sidekiq_agent

@@ -0,0 +1,22 @@
+#! /usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+require "#{File.expand_path('../../',__FILE__)}/lib/newrelic_sidekiq_agent"
+
+module SidekiqAgent
+
+  #
+  # Register this agent with the component.
+  # The ExampleAgent is the name of the module that defines this
+  # driver (the module must contain at least three classes - a
+  # PollCycle, a Metric and an Agent class, as defined above).
+  #
+  NewRelic::Plugin::Setup.install_agent :sidekiq, SidekiqAgent
+
+  #
+  # Launch the agent; this never returns.
+  #
+  NewRelic::Plugin::Run.setup_and_run
+
+end

data/config/newrelic_plugin.yml.example

@@ -0,0 +1,21 @@
+# Please make sure to update the license_key information with the license key for your New Relic
+# account.
+#
+#
+newrelic:
+  #
+  # Update with your New Relic account license key:
+  #
+  license_key: 'YOUR_LICENSE_KEY_HERE'
+  #
+  # Set to '1' for verbose output, remove for normal output.
+  # All output goes to stdout/stderr.
+  #
+  # verbose: 1
+#
+# Agent Configuration:
+#
+agents:
+  # this is where configuration for agents belongs
+  sidekiq:
+    # No configuration options

data/lib/newrelic_sidekiq_agent.rb

@@ -0,0 +1,57 @@
+#
+# This is a NewRelic Plugin Agent for monitoring Sidekiq
+#
+require "newrelic_plugin"
+require "sidekiq"
+
+module SidekiqAgent
+  class Agent < NewRelic::Plugin::Agent::Base
+
+    agent_guid "com.getdropstream.sidekiq"
+    agent_version "0.0.2"
+    agent_config_options :queue
+    agent_human_labels("Sidekiq Agent") { ident }
+    
+    attr_reader :ident
+    
+    def setup_metrics
+      @total_failed = NewRelic::Processor::EpochCounter.new
+      @processed    = NewRelic::Processor::EpochCounter.new
+    end
+        
+    def poll_cycle
+      stats = Sidekiq::Stats.new
+      
+      # 
+      # The # of worker executing a job 
+      #
+      report_metric "Workers/Working", "Workers", Sidekiq::Workers.new.size
+      
+      #
+      # The # of queued jobs
+      #
+      report_metric "Jobs/Pending", "Jobs", stats.enqueued
+      
+      #
+      # Total # of jobs failed
+      #
+      report_metric "Jobs/Failed", "Jobs", stats.failed
+      
+      #
+      # Total # of jobs processed
+      #
+      report_metric 'Jobs/Processed', "Jobs", stats.processed
+      
+      #
+      # The rate at which jobs are processed per second
+      #
+      report_metric "Jobs/Rate/Processed", "Jobs/Second", @processed.process(stats.processed)
+      
+      #
+      # The rate at which jobs failed per second
+      #
+      report_metric "Jobs/Rate/Failed", "Jobs/Second", @total_failed.process(stats.failed)
+    end
+
+  end
+end

data/newrelic_sidekiq_plugin.gemspec

@@ -0,0 +1,71 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'newrelic_sidekiq_plugin'
+  s.version           = '0.0.2'
+  s.date              = '2013-08-03'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "New Relic Sidekiq monitoring plugin"
+  s.description = <<-EOF
+This is the New Relic plugin for monitoring Sidekiq developed by Falconer Development, LLC
+  EOF
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Karl Falconer"]
+  s.email    = 'karl@falconerdevelopment.com'
+  s.homepage = 'https://github.com/dropstream/newrelic_sidekiq_plugin'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## This sections is only necessary if you have C extensions.
+  #s.require_paths << 'ext'
+  #s.extensions = %w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ["newrelic_sidekiq_agent"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.  
+  s.add_dependency('newrelic_plugin', "1.0.3")
+  s.add_dependency('sidekiq', ">= 2.13.0")
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    README.md
+    bin/newrelic_sidekiq_agent
+    config/newrelic_plugin.yml.example
+    lib/newrelic_sidekiq_agent.rb
+    newrelic_sidekiq_plugin.gemspec
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_sidekiq_plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Karl Falconer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: ! 'This is the New Relic plugin for monitoring Sidekiq developed by Falconer
+  Development, LLC
+
+'
+email: karl@falconerdevelopment.com
+executables:
+- newrelic_sidekiq_agent
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- README.md
+- bin/newrelic_sidekiq_agent
+- config/newrelic_plugin.yml.example
+- lib/newrelic_sidekiq_agent.rb
+- newrelic_sidekiq_plugin.gemspec
+homepage: https://github.com/dropstream/newrelic_sidekiq_plugin
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 2
+summary: New Relic Sidekiq monitoring plugin
+test_files: []