sidekiq-opentsdb 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmIyNzYzZjljYTJhMjdlODUzZGJjYThiMzNiMjU1MTFhZjdmZWVjZQ==
+  data.tar.gz: !binary |-
+    M2E3YTIwOTJkN2IxMTI5YjMyMWE3NzM2NmQ0MjFhOTY1NzMwZjUyZQ==
+SHA512:
+  metadata.gz: !binary |-
+    N2RkYjg3NGFjZTI2NjYzNmM1ZjZmMGU2NTcwYjFkMWU2MjJiNTMyNDcyMmY5
+    MDc4MGMyMmVmZmM2MGFmYTdmODJkZGJhNGMyMDhkMThjOWM0NWQwNzY2NzUy
+    YWZkYjE1ZGJlMGI3MjM0MGNmZmVjMjAwODJlYjUzMDAxMzgzZTk=
+  data.tar.gz: !binary |-
+    YzdjMTc5YTgwZWJmNzYxOTlmNjI1ZjMzZmQwY2RiNDMzZjBmOTI2ZGY1MTM4
+    MDg0MjliYmRmYTY3MGQ2N2FhZGU1NDA2Mzk0ZjIxYzk3ZDk3YzBmNmRiNTQw
+    YTI4ZGI3MjQxZmM0NWEyYmQ1NzkzOTU1MmZjMmNiMGVhMjg1MTg=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+- 2.3.0
+- 2.2
+- 2.1
+sudo: false
+cache: bundler
+script: bundle exec rspec
+notifications:
+  email: false
+deploy:
+  provider: rubygems
+  api_key:
+    secure: GRvMGszfopDomvWOWaSVsEpE3ZI8QHykuM8U7RTFQ1/wAwGe5P33sGGw3eciSGYHRB+UgQyxFdJUPz5kp+rYojSD7XvvRwMfNkY3o4LlJpkb5Yi8vf7Htg6tgLflWLXVwM1ekkGXbDFDEZnjsBcgsS/ZPIkXBivbRcTGnd9WESxVK9tvly/htkMmGefYTWISOoSC4NLBuZVD4esFY+G19HdX48Gg8VneIqA0NdMoRgVTltD53fWFtRxzdF+Z1unynvNrQ3ZaI1BgW3It6V+S+Uuwz4tpXQ20fheYoLxA8XG3ER6ay3NxriSgTufFWTeEZWMqoKIBk3HoXTaYEb9Oici0R/IWNQdXMeoz0nPZDlPLWUdPz+MwFJAG0hmIQV9JCalP9rXoe1sOdcGn9o+tfl+E9jXiED8DtWl0++xn79ZpsdIvehzuOSwZWuPBDxMTmQNJX2yGKRgaXGsDqu8Q4d2osvF9wPt+1yKs5eyRWos6alGF+LlLOQ4Gy63nQaS4bBxXQoH1m40Fvgh7N6GNmhi/AckP88Vqfw2gqxSHtrSCPzfhnbXsc0dyqO8SoAKe103q/EyE58W91EmHdhgUNoD9tpZJRxrzFhvo3Oo/C2Q63GtOCRzbig9bzrNrks5ZAIXne45RQ8EOLxnB2jXt/hwAjGLSia9ydGtw3FdXSfk=
+  gem: sidekiq-opentsdb
+  on:
+    branch: master
+    tags: true
+    repo: ninech/sidekiq-opentsdb
+    rvm: 2.3.0

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+
+# 0.0.4
+
+
+
+
+
+# 0.0.3
+
+
+
+
+
+# 0.0.2
+
+
+
+
+
+# 0.0.1
+
+
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 nine.ch
+
+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,59 @@
+# Sidekiq::Opentsdb
+
+[![Build Status](https://travis-ci.org/ninech/sidekiq-opentsdb.svg?branch=master)](https://travis-ci.org/ninech/sidekiq-opentsdb)
+
+Sidekiq middleware that sends useful Sidekiq statistics to OpenTSDB.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-opentsdb'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+You need to add the middleware to your call stack. To do so, put the folllowing code in an initializer (ideally `sidekiq.rb`):
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    middleware_options = {
+      opentsdb_hostname: 'localhost',
+      opentsdb_port: '4242',
+      metric_prefix: 'nine',
+      only: %w(retry_size dead_size)
+    }
+
+    chain.add Sidekiq::Opentsdb::ServerMiddleware, middleware_options
+  end
+end
+```
+
+### Available Options
+
+```ruby
+opentsdb_hostname: 'localhost'   # (required) Hostname of your opentsdb server.
+opentsdb_port: '4242'            # (required) Port of your opentsdb server.
+
+metric_prefix: 'nine'            # (optional) Prefix of the metric keys (default: '').
+only:   %w(retry_size dead_size) # (optional) Only send the given metrics to OpenTSDB.
+except: %w(retry_size dead_size) # (optional) Send all but the given metrics to OpenTSDB.
+
+# Tags
+app: 'MyApp'                     # (optional) Your app name (Rails app name if available)
+environment: 'staging'           # (optional) Your app environment (default: ENV['RACK_ENV'])
+```
+
+## About
+
+This Gem is maintained and funded by nine.ch.
+
+![nine.ch](https://blog.nine.ch/assets/logo.png)
+
+We run your Linux server infrastructure – without interruptions, around the clock.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sidekiq/opentsdb'
+
+# 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.
+
+require 'pry'
+Pry.start

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/sidekiq/opentsdb.rb

@@ -0,0 +1,12 @@
+require 'sidekiq/api'
+require 'opentsdb'
+require 'socket'
+
+module Sidekiq
+  module Opentsdb
+  end
+end
+
+require 'sidekiq/opentsdb/tags'
+require 'sidekiq/opentsdb/server_middleware'
+require 'sidekiq/opentsdb/version'

data/lib/sidekiq/opentsdb/server_middleware.rb

@@ -0,0 +1,58 @@
+module Sidekiq
+  module Opentsdb
+    class ServerMiddleware
+      SIDEKIQ_METRICS = %w(processed failed scheduled_size retry_size dead_size
+                           processes_size default_queue_latency workers_size enqueued).freeze
+
+      def initialize(options = {})
+        @options = options
+
+        if !options.key?(:opentsdb_hostname) || !options.key?(:opentsdb_port)
+          fail '[sidekiq-opentsdb] OpenTSDB configuration not found...'
+        end
+      end
+
+      def call(*)
+        yield
+
+        sidekiq_stats_metrics_with_values.each do |metric, value|
+          opentsdb_client.put metric: "#{metric_prefix}sidekiq.#{metric}", value: value,
+                              timestamp: Time.now.to_i, tags: tags
+        end
+      rescue ::OpenTSDB::Errors::UnableToConnectError
+      end
+
+      private
+
+      def sidekiq_stats_metrics_with_values
+        sidekiq_stats_instance = Sidekiq::Stats.new
+        selected_metrics.inject({}) do |hash, sidekiq_metric|
+          hash.merge("stats.#{sidekiq_metric}" => sidekiq_stats_instance.send(sidekiq_metric))
+        end
+      end
+
+      def selected_metrics
+        if @options.key?(:only)
+          SIDEKIQ_METRICS.select { |key| @options[:only].include?(key) }
+        elsif @options.key?(:except)
+          SIDEKIQ_METRICS.select { |key| !@options[:except].include?(key) }
+        else
+          SIDEKIQ_METRICS
+        end
+      end
+
+      def tags
+        Tags.new(@options).to_hash
+      end
+
+      def metric_prefix
+        @options.key?(:metric_prefix) ? "#{@options[:metric_prefix]}." : ''
+      end
+
+      def opentsdb_client
+        @opentsdb_client ||= ::OpenTSDB::Client.new hostname: @options[:opentsdb_hostname],
+                                                    port:     @options[:opentsdb_port]
+      end
+    end
+  end
+end

data/lib/sidekiq/opentsdb/tags.rb

@@ -0,0 +1,31 @@
+module Sidekiq
+  module Opentsdb
+    class Tags
+      def initialize(options = {})
+        @options = options
+      end
+
+      def to_hash
+        {
+          host: Socket.gethostname,
+          environment: environment,
+          app: app,
+        }.delete_if { |k, v| v.nil? }
+      end
+
+      private
+
+      def environment
+        @options[:environment] || ENV['RACK_ENV']
+      end
+
+      def app
+        @options[:app] || rails_app_name
+      end
+
+      def rails_app_name
+        ::Rails.application.class.parent_name if defined?(::Rails)
+      end
+    end
+  end
+end

data/lib/sidekiq/opentsdb/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Opentsdb
+    VERSION = File.read(File.expand_path('../../../../VERSION', __FILE__).strip).chomp
+  end
+end

data/sidekiq-opentsdb.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-opentsdb'
+  spec.version       = File.read(File.expand_path('../VERSION', __FILE__)).strip
+  spec.authors       = ['David Dieulivol', 'Philippe Haessig']
+  spec.email         = ['dadie@nine.ch', 'phil@nine.ch']
+
+  spec.summary       = 'Sidekiq middleware to log useful sidekiq stats to OpenTSDB.'
+  spec.description   = 'Sidekiq middleware to log useful sidekiq stats to OpenTSDB.'
+  spec.homepage      = 'http://github.com/ninech/sidekiq-opentsdb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'sidekiq', '>= 2.6'
+  spec.add_runtime_dependency 'opentsdb', '~> 1.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake', '~> 11.1'
+  spec.add_development_dependency 'pry', '~> 0'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-opentsdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Dieulivol
+- Philippe Haessig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: opentsdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !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'
+description: Sidekiq middleware to log useful sidekiq stats to OpenTSDB.
+email:
+- dadie@nine.ch
+- phil@nine.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- lib/sidekiq/opentsdb.rb
+- lib/sidekiq/opentsdb/server_middleware.rb
+- lib/sidekiq/opentsdb/tags.rb
+- lib/sidekiq/opentsdb/version.rb
+- sidekiq-opentsdb.gemspec
+homepage: http://github.com/ninech/sidekiq-opentsdb
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Sidekiq middleware to log useful sidekiq stats to OpenTSDB.
+test_files: []