rack-monitor-opentsdb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9afbff4ac650e92c2dbd3f916be7787e88b00f8
+  data.tar.gz: 7ede01a4ebbf70501ca057ea0243bdb14d910df8
+SHA512:
+  metadata.gz: 41ebb0204e780f94c16e45d03d47c7fb6c544f9b04af119df80fd17c0cb21e03e92fd63bea8516063c9cfd98607d02a96694bac84e415a95e0777ae8d6bd7f29
+  data.tar.gz: 7cc1a7f1246e936cb4f1a503ba38e50447147847e6f237a0ad35a05b5e5d9302bdf7769e50342a56057f7e5edacb17a36b5f4c59f7ba786e472572521df96b2c

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.1.1
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    rack-monitor-opentsdb (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  rack-monitor-opentsdb!
+  rake (~> 10.3, >= 10.3.2)
+  rspec (~> 3.1, >= 3.1.0)

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2014 FriendScout24 GmbH
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,30 @@
+rack-monitor-opentsdb
+=====================
+
+Rack middleware to monitor requests with OpenTSDB.
+
+Usage:
+------
+
+    require 'sinatra'
+    require 'rack/monitor/opentsdb'
+
+    use Rack::Monitor::OpenTSDB, 'service.rest.hworld',
+                                 :host            => 'opentsdb.example.com',
+                                 :port            => 4242,
+                                 :report_interval => 60,
+                                 :tags            => {
+                                   :host => `hostname`.chomp,
+                                   :env  => ENV['RACK_ENV'] || 'development' }
+
+    get '/' do
+        'Hello World'
+    end
+
+Links:
+------
+
+ - [Homepage](http://friendscout24.github.io/rack-monitor-opentsdb)
+ - [Sources](http://github.com/friendscout24/rack-monitor-opentsdb)
+ - [Issues](http://github.com/friendscout24/rack-monitor-opentsdb/issues)
+ - [![Build Status](https://travis-ci.org/friendscout24/rack-monitor-opentsdb.svg?branch=master)](https://travis-ci.org/friendscout24/rack-monitor-opentsdb)

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+
+task :default => :spec
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  task :spec do
+    abort 'RSpec is not available'
+  end
+end
+
+desc 'run console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'rack/monitor/opentsdb'
+  ARGV.clear
+  IRB.start
+end

data/lib/rack/monitor/opentsdb/reporter.rb

@@ -0,0 +1,118 @@
+module Rack
+  module Monitor
+    class OpenTSDB
+      class Reporter
+
+        MAX_CACHE = 1024
+
+        # stats has the following structure:
+        #
+        #     {
+        #       'GET /monitored/path/1': {
+        #         '<httpstatus>': [<time>, ...],
+        #         ...
+        #       },
+        #       ...
+        #     }
+        #
+        # The stats parameter must be extended with MonitorMixin. Like this it
+        # can be accessed synchronized.
+        def initialize(stats, host, port, key = 'unconfigured.rack.monitor', interval = 60, tags = {})
+          raise ArgumentError, "Interval less than zero" if interval < 0
+          raise ArgumentError, 'stats does not support synchronize' unless stats.respond_to? :synchronize
+
+          @interval = interval
+          @tags     = tags
+          @stats    = stats
+          @host     = host
+          @port     = port
+          @key      = key
+          @tosend   = []
+          start
+        end
+
+        def start
+          return if @run
+          @run = true
+          @th = Thread.new do
+            t = Time.now
+            while run?
+              t += @interval
+              (sleep(t - Time.now) rescue nil) and send_report rescue nil
+            end
+          end
+        end
+
+        def stop
+          @stats.synchronize do
+            @run = false
+          end
+          @th.join
+        end
+
+        private
+
+        def run?
+          @stats.synchronize do
+            @run
+          end
+        end
+
+        def send_report
+          timestamp = Time.now.to_i
+          data = copy_and_clear_stats
+          data.each do |url, url_stats|
+            verb, path = url.split(/ /)
+            url_stats.each do |status, timings|
+              tags = @tags.merge({:status => status, :verb => verb, :path => path}).map { |key, value| "#{key}=#{value}" }.join(' ')
+              @tosend.push("put #{@key}.min #{timestamp} #{timings.min} #{tags}")
+              @tosend.push("put #{@key}.max #{timestamp} #{timings.max} #{tags}")
+              @tosend.push("put #{@key}.num #{timestamp} #{timings.size} #{tags}")
+              @tosend.push("put #{@key}.avg #{timestamp} #{timings.inject(0.0) { |sum, e| sum + e } / timings.size} #{tags}")
+            end
+          end
+
+          # cleanup if cannot send anything, only keep MAX_CACHE entries to send
+          if @tosend.size > MAX_CACHE
+            @tosend.shift(@tosend.length - - MAX_CACHE)
+          end
+
+          send_to_socket
+        end
+
+        def send_to_socket
+          begin
+            @tosend.delete_if do |line|
+              # throws in first go NoMethodError: undefined method `puts' for nil:NilClass
+              # this is rescued and the connection is opened for retry
+              @socket.puts line
+              true
+            end
+          rescue IOError, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::EPIPE
+            # Don't retry immediately (preventing loops), next run will retry
+            @socket = nil
+          rescue
+            begin
+              @socket = TCPSocket.new(@host, @port)
+              retry
+            rescue
+              # will do no retry in this case
+            end
+          end
+        end
+
+        def copy_and_clear_stats
+          copy = {}
+          @stats.synchronize do
+            @stats.each do |url, url_stats|
+              copy[url] = url_stats
+            end
+            @stats.clear
+          end
+          copy
+        end
+
+      end
+    end
+  end
+end

data/lib/rack/monitor/opentsdb/version.rb

@@ -0,0 +1,13 @@
+module Rack
+  module Monitor
+    class OpenTSDB
+      module Version
+        MAJOR = 0
+        MINOR = 0
+        NANO  = 1
+
+        VERSION = "#{MAJOR}.#{MINOR}.#{NANO}"
+      end
+    end
+  end
+end

data/lib/rack/monitor/opentsdb.rb

@@ -0,0 +1,48 @@
+require 'rack/monitor/opentsdb/reporter'
+require 'monitor' # MonitorMixin
+
+module Rack
+  module Monitor
+    class OpenTSDB
+
+      class Stats < Hash
+        include MonitorMixin
+      end
+
+      def initialize(app, key, options={})
+        @app = app
+        @options = {
+          :host            => 'localhost',
+          :port            => 4242,
+          :key             => key,
+          # If somebody has a better idea than defining a regex and gsub
+          # replacement tell me.
+          :track_regex     => /^(\/[^\/]+).*?$/, # Regex to select trackable string
+          :track_replace   => '\1',              # gsub pattern to select trackable string
+          :report_interval => 60,
+          :tags            => {}
+        }.merge(options)
+        @stats = Stats.new
+        @reporter = Reporter.new(@stats, @options[:host], @options[:port], @options[:key], @options[:report_interval], @options[:tags])
+        @reporter.start
+      end
+
+      def call(env, options={})
+        track_path = env['REQUEST_METHOD'] + ' ' + env['PATH_INFO'].gsub(@options[:track_regex], @options[:track_replace])
+
+        beginning_time = Time.now
+        status, headers, body = @app.call(env)
+        execution_time = (Time.now - beginning_time)
+
+        @stats.synchronize do
+          @stats[track_path] ||= {}
+          @stats[track_path][status] ||= []
+          @stats[track_path][status] << execution_time
+        end
+
+        [status, headers, body]
+      end
+
+    end
+  end
+end

data/rack-monitor-opentsdb.gemspec

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), 'lib', 'rack', 'monitor', 'opentsdb', 'version')
+
+Gem::Specification.new do |s|
+  s.name        = 'rack-monitor-opentsdb'
+  s.version     = Rack::Monitor::OpenTSDB::Version::VERSION
+  s.licenses    = ['ALv2']
+  s.summary     = 'Rack Monitoring to OpenTSDB'
+  s.description = 'Send monitoring info to OpenTSDB'
+  s.authors     = ['Rainer Jung']
+  s.email       = 'rainer.jung@gmail.com'
+  s.homepage    = 'http://github.com/friendscout24/rack-monitor-opentsdb'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {spec}/*`.split("\n")
+  s.add_development_dependency 'rake', '~> 10.3', '>= 10.3.2'
+  s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+end

data/spec/monitor_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Rack::Monitor::OpenTSDB do
+
+  before :each do
+    @app = double(:app)
+    @env = {'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/path'}
+    @sut = Rack::Monitor::OpenTSDB.new(@app, 'test.monitor')
+  end
+
+  it 'starts with empty stats' do
+    expect(@sut.instance_variable_get('@stats')).to be_empty
+  end
+
+  describe :call do
+
+    it 'does return apps result' do
+      allow(@app).to receive(:call).and_return(['status', 'headers', 'body'])
+      expect(@sut.call @env).to eq(['status', 'headers', 'body'])
+    end
+
+    describe 'stats' do
+      before do
+        allow(@app).to receive(:call).and_return(['200', 'headers', 'body'])
+        @sut.call @env
+        @stats = @sut.instance_variable_get('@stats')
+      end
+
+      it 'includes path' do
+        expect(@stats).to include 'GET /path'
+      end
+
+      it 'includes status' do
+        expect(@stats['GET /path']).to include '200'
+      end
+
+    end
+
+  end
+
+  describe 'call with regexable path' do
+
+      before do
+        allow(@app).to receive(:call).and_return(['200', 'headers', 'body'])
+        @sut.call({'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/some/longer/path'})
+        @stats = @sut.instance_variable_get('@stats')
+      end
+
+      it 'includes path' do
+        # Default regex does shorten to first path-segment
+        expect(@stats).to include 'GET /some'
+      end
+  end
+
+end

data/spec/reporter_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Rack::Monitor::OpenTSDB::Reporter do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+
+require 'rack/monitor/opentsdb'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rack-monitor-opentsdb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rainer Jung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Send monitoring info to OpenTSDB
+email: rainer.jung@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack/monitor/opentsdb.rb
+- lib/rack/monitor/opentsdb/reporter.rb
+- lib/rack/monitor/opentsdb/version.rb
+- rack-monitor-opentsdb.gemspec
+- spec/monitor_spec.rb
+- spec/reporter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/friendscout24/rack-monitor-opentsdb
+licenses:
+- ALv2
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rack Monitoring to OpenTSDB
+test_files: []