sneakers-influxdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ec0d503d7f4dfef766bfec6ec3f4d0fedf10ff3
+  data.tar.gz: 6220b43cfcb167867d287985aafd7653eefc3cb2
+SHA512:
+  metadata.gz: 8afd3a5ef900647998549fccca1128ee07eeb299bf7edc29212f684d8b89cbd5ec412848b5dc9e3dd37a816205ed229712beb6027150da20a886a643d51cd96b
+  data.tar.gz: 904bf08e18bf7c6081381cced5859ad5429d94f9b6b5a68768a5ba77e8f3517848e209ba40aad8265cf68753a6f444753edb3347d6e15be3ed1811829776002d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p648

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sneakers-metrics-influxdb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Guilherme Moreira
+
+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,56 @@
+# Sneakers::InfluxDB
+
+This gem collect metrics from Sneakers workers and insert them in InfluxDB. Those metrics can be useful so you know how many works you are doing, how many started and ended, as well the time each work takes to execute.
+
+This gem depends on `influxdb` gem 0.3.x. This branch supports Ruby 2.1 and less, so it shouldn't break current compatibility while using Sneakers and Bunny gems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sneakers-influxdb'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install sneakers-influxdb
+```
+
+## Usage
+
+Where you configure the Sneakers gem, pass the object Sneakers::InfluxDBMetrics to the metrics option.
+
+Example:
+
+```ruby
+require 'sneakers-influxdb'
+
+influxdb_metrics = Sneakers::InfluxDBMetrics.new('sneakers', host: 'localhost',
+                                                                      port: 8086,
+                                                                      username: 'admin',
+                                                                      password: 'admin')
+
+Sneakers.configure(workers:           8,
+                   threads:           1,
+                   timeout_job_after: 2,
+                   log: Rails.logger,
+                   metrics: influxdb_metrics)
+```
+
+The InfluxDBMetrics initializer receives the same params as the InfluxDB::Client class. You can also pass an instance of InfluxDB::Client if you already uses the client in other parts of your project.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gmmoreira/sneakers-influxdb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sneakers/metrics/influxdb"
+
+# 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/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '2'
+
+services:
+  gem:
+    depends_on:
+      - rabbitmq
+      - influxdb
+  rabbitmq:
+    image: rabbitmq:3.6-alpine
+  influxdb:
+    image: influxdb:1.3-alpine

data/lib/sneakers/influxdb_metrics/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sneakers
+  class InfluxDBMetrics
+    VERSION = "0.1.0"
+  end
+end

data/lib/sneakers/influxdb_metrics.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'influxdb'
+require 'benchmark'
+
+module Sneakers
+  class InfluxDBMetrics
+    INCREMENT_SERIES = 'sneakers_increment'
+    TIMING_SERIES = 'sneakers_timing'
+
+    attr_reader :client
+
+    def initialize(db_or_client, opts = {})
+      if db_or_client.is_a? ::InfluxDB::Client
+        @client = db_or_client
+      else
+        @client = ::InfluxDB::Client.new(db_or_client, opts)
+      end
+    end
+
+    def increment(metric)
+      raise RuntimeError, 'Metric must be a String type' unless metric.is_a?(String)
+
+      client.write_point(
+        INCREMENT_SERIES,
+        values: { value: 1 },
+        tags: increment_tags(metric)
+      )
+    end
+
+    def timing(metric, &block)
+      raise RuntimeError, 'Metric must be a String type' unless metric.is_a?(String)
+      raise RuntimeError, 'Timing must receive a block parameter' unless block_given?
+
+      elapsed = Benchmark.realtime(&block)
+
+      client.write_point(
+        TIMING_SERIES,
+        values: { value: elapsed },
+        tags: timing_tags(metric)
+      )
+    end
+
+    private
+
+    private_constant :INCREMENT_SERIES
+    private_constant :TIMING_SERIES
+
+    def increment_tags(metric)
+      if /\A                   #match start of string
+            work\.               #match work
+            (?<worker>[^\.]+?)\. #match worker name
+            (?<status>[^\.]+?)   #match worker status
+            \z                   #match end of string
+            /x =~ metric
+        {
+          worker: worker,
+          status: status
+        }
+      elsif /\A                  #match start of string
+               work\.              #match work
+              (?<worker>[^\.]+?)\. #match worker name
+              handled\.            #match message handled
+              (?<type>[^\.]+?)     #match message handled type
+              \z                   #match end of string
+              /x =~ metric
+        {
+          worker: worker,
+          status: 'handled',
+          type: type
+        }
+      else
+        raise RuntimeError, "Increment metric cannot be matched. Metric: #{metric}"
+      end
+    end
+
+    def timing_tags(metric)
+      if /\A                  #match start of string
+           work\.               #match work
+           (?<worker>[^\.]+?)\. #match worker name
+           time                 #match time type
+           /x =~ metric
+        {
+          worker: worker,
+          status: 'timing'
+        }
+      else
+        raise RuntimeError, "Timing metric cannot be matched. Metric: #{metric}"
+      end
+    end
+  end
+end

data/lib/sneakers-influxdb.rb

@@ -0,0 +1,2 @@
+require 'sneakers/influxdb_metrics'
+require 'sneakers/influxdb_metrics/version'

data/sneakers-influxdb.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sneakers-influxdb"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sneakers-influxdb"
+  spec.version       = Sneakers::InfluxDBMetrics::VERSION
+  spec.authors       = ["Guilherme Moreira"]
+  spec.email         = ["guilhermerx7@gmail.com"]
+
+  spec.summary       = %q{InfluxDB metrics for Sneakers workers}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/gmmoreira/sneakers-influxdb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  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         = `git ls-files -z`.split("\x0").reject do |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 "influxdb", "~> 0.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sneakers-influxdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guilherme Moreira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: ''
+email:
+- guilhermerx7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/sneakers-influxdb.rb
+- lib/sneakers/influxdb_metrics.rb
+- lib/sneakers/influxdb_metrics/version.rb
+- sneakers-influxdb.gemspec
+homepage: https://github.com/gmmoreira/sneakers-influxdb
+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.6.13
+signing_key: 
+specification_version: 4
+summary: InfluxDB metrics for Sneakers workers
+test_files: []