honeykiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fe3d4a4b5312e30b13477915e40534824d4c3822db65051b6e344007d513b04
+  data.tar.gz: 32a1df92ef150b084871b05365699f08c4a40efe92854c72175d1cdd31e5b662
+SHA512:
+  metadata.gz: c589ef0b5bb7dbcc8a93200fc9e06b3d6ab85bde7ef0bc0ea98c15741f9117fed3c000d876b2acebb0502c5d8f17bd60a40362521ae139bfe919a08efe0a1d74
+  data.tar.gz: 645a9554dd0313970a8e78e80f5d207da4ac2300a280f6f3442df811e743d535a236c57928935012fcea6e9476cd4b960583066de0a1212b3eeff752cee466d5

data/.circleci/config.yml

@@ -0,0 +1,54 @@
+ruby: &ruby
+  image: carwow/ruby-ci:2.5.3
+
+version: 2
+
+jobs:
+  bundle:
+    working_directory: ~/honeykiq
+    docker:
+      - *ruby
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - bundle-{{ checksum "Gemfile.lock" }}
+            - bundle-
+      - run: |
+          bundle config --local path vendor/bundle &&
+          bundle check || bundle install --jobs=4 --retry=3
+      - save_cache:
+          key: bundle-{{ checksum "Gemfile.lock" }}
+          paths: [~/honeykiq/vendor/bundle]
+      - persist_to_workspace:
+          root: '~'
+          paths: [honeykiq]
+
+  rubocop:
+    working_directory: ~/honeykiq
+    docker:
+      - *ruby
+    steps:
+      - attach_workspace:
+          at: '~'
+      - run: bundle exec rubocop
+
+  tests:
+    working_directory: ~/honeykiq
+    docker:
+      - *ruby
+    steps:
+      - attach_workspace:
+          at: '~'
+      - run: |
+          bundle exec rspec
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - bundle
+      - rubocop:
+          requires: [bundle]
+      - tests:
+          requires: [bundle]

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/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  carwow_rubocop:
+    - default.yml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in honeykiq.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    honeykiq (0.1.0)
+      sidekiq
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    carwow_rubocop (2.1.1)
+      rubocop (~> 0.58)
+      rubocop-rspec (~> 1.28)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http (3.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    jaro_winkler (1.5.1)
+    libhoney (1.11.0)
+      addressable (~> 2.0)
+      http (>= 2.0, < 4.0)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-protection (2.0.4)
+      rack
+    rainbow (3.0.0)
+    rake (12.3.2)
+    redis (4.0.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.61.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.30.1)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    sidekiq (5.2.3)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  carwow_rubocop
+  honeykiq!
+  libhoney
+  rake
+  rspec
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 carwow
+
+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,66 @@
+# Honeykiq
+
+Sidekiq → Honeycomb 🐝
+
+Send Sidekiq related events to Honeycomb.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'honeykiq'
+```
+
+## Usage
+
+At the moment the library only provides a periodic reporter which should be
+scheduled to report every few seconds depending on your use case.
+
+### Periodic Reporter
+
+The periodic reporter will send one event with information about the sidekiq
+instance, plus one event per sidekiq process, plus one event per sidekiq queue.
+Have a look at [periodic_reporter.rb] to see what kind of information we send
+for each type.
+
+[periodic_reporter.rb]: https://github.com/carwow/honeykiq/blob/master/lib/honeykiq/periodic_reporter.rb
+
+A simple setup using [clockwork] would look like this:
+
+[clockwork]: https://github.com/adamwiggins/clockwork
+
+```ruby
+require 'clockwork'
+require 'libhoney'
+require 'honeykiq'
+
+module Clockwork
+  every(30, 'Honeykiq', thread: true) { SidekiqHealth.report }
+end
+
+module SidekiqHealth
+  def self.report
+    reporter.report
+  end
+
+  def self.reporter
+    @reporter ||= Honeykiq.periodic_reporter(honey_client: honey_client)
+  end
+
+  def self.honey_client
+    Libhoney::Client.new(
+      writekey: ENV.fetch('HONEYCOMB_WRITE_KEY'),
+      dataset: ENV.fetch('HONEYCOMB_DATASET')
+    )
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/carwow/honeykiq.
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/honeykiq.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'honeykiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'honeykiq'
+  spec.version       = Honeykiq::VERSION
+  spec.authors       = ['carwow Developers']
+  spec.email         = ['developers@carwow.co.uk']
+  spec.summary       = 'Sidekiq → Honeycomb 🐝'
+  spec.description   = 'Send Sidekiq related events to Honeycomb.'
+  spec.homepage      = 'https://github.com/carwow/honeykiq'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sidekiq'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'carwow_rubocop'
+  spec.add_development_dependency 'libhoney'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/honeykiq/periodic_reporter.rb

@@ -0,0 +1,81 @@
+require 'sidekiq/api'
+
+module Honeykiq
+  class PeriodicReporter
+    def initialize(honey_client:)
+      @honey_client = honey_client
+      @extra = {}
+    end
+
+    def report(&extra)
+      send_instance_event(&extra)
+      Sidekiq::ProcessSet.new.each { |process| send_process_event(process, &extra) }
+      Sidekiq::Queue.all.each { |queue| send_queue_event(queue, &extra) }
+    end
+
+    private
+
+    attr_reader :honey_client
+
+    def send_instance_event(&extra)
+      honey_client.event.add(
+        type: :instance,
+        **instance_stats,
+        **redis_stats,
+        **(extra&.call(:instance) || {})
+      ).send
+    end
+
+    def instance_stats
+      stats = Sidekiq::Stats.new
+
+      {
+        'instance.processes': stats.processes_size,
+        'instance.busy': stats.workers_size,
+        'instance.enqueued': stats.enqueued,
+        'instance.scheduled': stats.scheduled_size,
+        'instance.retries': stats.retry_size,
+        'instance.dead': stats.dead_size
+      }
+    end
+
+    def redis_stats
+      redis_info = fetch_redis_info
+
+      {
+        'redis.connections': redis_info['connected_clients'].to_i,
+        'redis.memory_used': redis_info['used_memory'].to_i
+      }
+    end
+
+    def fetch_redis_info
+      Sidekiq.redis do |redis|
+        redis.pipelined do
+          redis.info :clients
+          redis.info :memory
+        end.reduce(&:merge)
+      end
+    end
+
+    def send_process_event(process, &extra)
+      honey_client.event.add(
+        type: :process,
+        'meta.dyno': process['hostname'],
+        'meta.process_id': process['pid'],
+        'process.concurrency': process['concurrency'],
+        'process.busy': process['busy'],
+        **(extra&.call(:process, process) || {})
+      ).send
+    end
+
+    def send_queue_event(queue, &extra)
+      honey_client.event.add(
+        type: :queue,
+        'queue.name': queue.name,
+        'queue.latency_sec': queue.latency.to_f,
+        'queue.size': queue.size,
+        **(extra&.call(:queue, queue) || {})
+      ).send
+    end
+  end
+end

data/lib/honeykiq/version.rb

@@ -0,0 +1,3 @@
+module Honeykiq
+  VERSION = '0.1.0'.freeze
+end

data/lib/honeykiq.rb

@@ -0,0 +1,8 @@
+module Honeykiq
+  autoload :Version, 'honeykiq/version'
+  autoload :PeriodicReporter, 'honeykiq/periodic_reporter'
+
+  def self.periodic_reporter(honey_client:)
+    @reporter = Honeykiq::PeriodicReporter.new(honey_client: honey_client)
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: honeykiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- carwow Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-12 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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: carwow_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: libhoney
+  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'
+description: Send Sidekiq related events to Honeycomb.
+email:
+- developers@carwow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- honeykiq.gemspec
+- lib/honeykiq.rb
+- lib/honeykiq/periodic_reporter.rb
+- lib/honeykiq/version.rb
+homepage: https://github.com/carwow/honeykiq
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: "Sidekiq → Honeycomb \U0001F41D"
+test_files: []