maestro_metrics 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5ed4252a33b5cf79e7fcc8a1d52392702fc2c49
+  data.tar.gz: c74d4a556e30e7b139961b22540d0f4a2426999e
+SHA512:
+  metadata.gz: bd35d8cb55675d2d91dadbfee1e1768dbeb0c128834f14f9f69237753611afa4880fca5df80545179dbdfdd88390baed065d91eba3197e37665eefc4196b6920
+  data.tar.gz: 85102a9e0f5f91ecedd4b7337ccce9487f8ccbeb79e92b070a40820f7fef96a5f8274c7253535fb4074639504d6ab9ba5e56053b3775e8cd0860e8880ac7b5db

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+pkg/
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.4

data/Gemfile

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

data/README.md

@@ -0,0 +1,4 @@
+maestro-metrics
+===============
+
+Maestro Metrics Library

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/clean'
+
+#require File.expand_path('../lib/maestro_plugin/version', __FILE__)
+
+CLEAN.include('pkg')
+CLOBBER.include('.bundle', '.config', 'coverage', 'InstalledFiles', 'spec/reports', 'rdoc', 'test', 'tmp')
+
+task :default => [:clean, :bundle, :spec, :build]
+
+RSpec::Core::RakeTask.new
+
+desc 'Get dependencies with Bundler'
+task :bundle do
+  sh %{bundle install}
+end

data/lib/maestro_metrics.rb

@@ -0,0 +1,215 @@
+require 'maestro_metrics/version'
+require 'singleton'
+require 'mongo'
+require 'statsd'
+require 'time'
+
+module Maestro
+  module Metrics
+
+    @mocking = false
+    @config = {}
+
+    def Metrics.mock!
+      @mocking = true
+    end
+
+    def Metrics.unmock!
+      @mocking = false
+    end
+
+    def Metrics.mock?
+      @mocking
+    end
+
+    def Metrics.mocking?
+      @mocking
+    end
+
+    def self.configure(config={})
+      @config = config unless config.nil?
+    end
+
+    def Metrics.count(metric, value, sample_rate=1)
+      logger.count(metric, value, sample_rate)
+    end
+
+    def Metrics.timing(metric, value, sample_rate=1)
+      logger.timing(metric, value, sample_rate)
+    end
+
+    def Metrics.increment(metric, sample_rate=1)
+      logger.increment(metric, sample_rate)
+    end
+
+    def Metrics.decrement(metric, sample_rate=1)
+      logger.decrement(metric, sample_rate)
+    end
+
+    def Metrics.time(metric, sample_rate=1, &block)
+      logger.time(metric, sample_rate, &block)
+    end
+
+    def Metrics.log(collection, metrics)
+      logger.log(collection, metrics)
+    end
+
+    def Metrics.aggregate(collection, pipeline=nil)
+      logger.aggregate(collection, pipeline)
+    end
+
+    def Metrics.find(collection, selector={}, opts={})
+      logger.find(collection, selector, opts)
+    end
+
+    def Metrics.to_mongo(value)
+      if value.nil? || value == ''
+        nil
+      else
+        time = nil
+
+        if value.is_a?(::Date)
+          time = value.to_time
+        elsif value.is_a?(::Time)
+          time = value
+        else
+          time = ::Time.parse(value.to_s)
+        end
+
+        time.utc
+      end
+      rescue
+      nil
+    end
+
+    def Metrics.collection_names
+      logger.collection_names
+    end
+
+    protected
+
+    def self.config
+      @config
+    end
+
+    private
+
+    def self.logger
+      self.mocking? ? Mock.instance : Real.instance
+    end
+
+    class Real
+
+      include Mongo
+      include Singleton
+
+      def initialize
+        @mongo_host = Metrics.config[:mongo_host] || 'localhost'
+        @mongo_port = Metrics.config[:mongo_port] || 27017
+        @statsd_host = Metrics.config[:statsd_host] || 'localhost'
+        @statsd_port = Metrics.config[:statsd_port] || 8125
+      end
+
+      def count(metric, value, sample_rate=1)
+        statsd.count(metric, value, sample_rate)
+      end
+
+      def timing(metric, value, sample_rate=1)
+        statsd.timing(metric, value, sample_rate)
+      end
+
+      def increment(metric, sample_rate=1)
+        statsd.increment(metric, sample_rate)
+      end
+
+      def decrement(metric, sample_rate=1)
+        statsd.decrement(metric, sample_rate)
+      end
+
+      def time(metric, sample_rate=1, &block)
+        statsd.time(metric, sample_rate, &block)
+      end
+
+      def log(collection, metrics)
+        mongo_collection(collection).save(metrics)
+      end
+
+      def aggregate(collection, pipeline=nil)
+        mongo_collection(collection).aggregate(pipeline)
+      end
+
+      def find(collection, selector={}, opts={})
+        mongo_collection(collection).find(selector, opts)
+      end
+
+      def collection_names
+        mongo_db.collection_names
+      end
+
+      private
+
+      def mongo_client
+        @mongo_client ||= MongoClient.new(@mongo_host, @mongo_port)
+      end
+
+      def mongo_db
+        @mongo_db ||= mongo_client['maestro']
+      end
+
+      def mongo_collection(name)
+        mongo_db[name]
+      end
+
+      def statsd
+        @statsd ||= Statsd.new(@statsd_host, @statsd_port)
+        @statsd.namespace= 'maestro'
+        @statsd
+      end
+
+    end
+
+  end
+
+  class Mock
+
+    include Singleton
+
+    def count(metric, value, sample_rate=1)
+
+    end
+
+    def timing(metric, value, sample_rate=1)
+
+    end
+
+    def increment(metric, sample_rate=1)
+
+    end
+
+    def decrement(metric, sample_rate=1)
+
+    end
+
+    def time(metric, sample_rate=1, &block)
+
+    end
+
+    def log(collection, metrics)
+      -1
+    end
+
+    def aggregate(collection, pipeline=nil)
+      Array.new
+    end
+
+    def find(collection, selector={}, opts={})
+      Array.new
+    end
+
+    def collection_names
+      Array.new
+    end
+
+  end
+
+end

data/lib/maestro_metrics/version.rb

@@ -0,0 +1,5 @@
+module Maestro
+  module Metrics
+    VERSION = '0.0.7'
+  end
+end

data/maestro_metrics.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/maestro_metrics/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Etienne Pelletier"]
+  gem.email         = ["epelletier@maestrodev.com"]
+  gem.description   = "A gem used to log application metrics"
+  gem.summary       = "Use this gem to record application run time metrics."
+  gem.homepage      = "https://github.com/kellyp/maestro-metrics"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "maestro_metrics"
+  gem.require_paths = ["lib"]
+  gem.version       = Maestro::Metrics::VERSION
+
+  gem.add_dependency('mongo')
+  gem.add_dependency('statsd')
+  gem.add_dependency('statsd-ruby')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('mongo_mapper')
+end

data/spec/maestro_metrics_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+require 'maestro_metrics'
+
+include Maestro
+
+describe Maestro::Metrics do
+
+  before(:all) do
+    Metrics.configure( { :mongo_host => '192.168.56.10', :statsd_host => '192.168.56.10' } )
+  end
+
+  before(:each) do
+    Metrics.unmock!
+  end
+
+  context 'Stats logging' do
+
+    @metric = 'test'
+
+    before(:each) do
+
+      @statsd = double('statsd')
+      Metrics::Real.instance.stub(:statsd => @statsd)
+    end
+
+    it 'should log counts of things' do
+      value = 8
+      @statsd.should_receive(:count).with(@metric, value, 1)
+      Metrics.count(@metric, value)
+
+    end
+
+    it 'should increment a counter' do
+      @statsd.should_receive(:increment).with(@metric, 1)
+      Metrics.increment(@metric)
+    end
+
+    it 'should decrement a counter' do
+      @statsd.should_receive(:decrement).with(@metric, 1)
+      Metrics.decrement(@metric)
+    end
+
+
+    it 'should log timing stats' do
+      @statsd.should_receive(:timing).with(@metric, 1, 1)
+      Metrics.timing(@metric, 1)
+    end
+
+    it 'should time the execution of a block of code' do
+      ran = false
+
+      proc = Proc.new do
+        ran = true
+      end
+
+      @statsd.should_receive(:time).with(@metric, 1, &proc)
+      Metrics.time(@metric,1, &proc)
+      ran.should be_true
+
+    end
+
+    it 'should do nothing when using a mock' do
+      Metrics.mock!
+      value = 8
+      @statsd.should_not_receive(:count)
+      Metrics.count(@metric, value)
+    end
+
+  end
+
+  context 'raw metrics logging' do
+
+    it 'should have a list of collections' do
+
+
+      collection_names = ["system.indexes", "runs", "counters.login.admin_10"]
+      Metrics::Real.instance.stub(:collection_names => collection_names)
+
+      names = Metrics.collection_names
+      names.should_not be_nil
+
+    end
+
+    it 'should log a hash containing raw metrics' do
+
+      @collection = double('collection')
+      Metrics::Real.instance.stub(:mongo_collection => @collection)
+
+      doc = { :name => 'testdoc' }
+      @collection.stub(:save => 1)
+      @collection.should_receive(:save).with(doc)
+
+      Metrics.log("test", doc).should eq 1
+
+    end
+
+    it 'should log a complex document' do
+      Metrics.mock!
+
+      require 'mongo_mapper'
+
+      doc = {
+          :id => 1,
+          :composition_id => 1,
+          :start_time => Time.to_mongo(Time.new),
+          :user=> 'maestro',
+          :trigger_type => 'manual',
+          :run_time => 1234,
+          :wait_time => 0,
+          :success => true,
+          :agent_name => 'some-agent',
+          :agent_host => 'agenthost.example.com',
+          :tasks => [
+            {
+              :task_id => 1,
+              :start_time =>  Time.to_mongo(Time.new),
+              :run_time => 1234,
+              :wait_time => 0,
+              :success => true
+            }
+          ]
+        }
+
+      Metrics.log('runs', doc)
+      results = Metrics.aggregate('runs',
+                                 [ { '$group' => { '_id' => '$composition_id',
+                                                   'numRuns'          => { '$sum' => 1 },
+                                                   'numSuccessfulRuns' => { '$sum' => { '$cond' => [ '$success', 1, 0 ] } },
+                                                   'avgRunTime'       => { '$avg' => '$run_time' },
+                                                   'maxRunTime'       => { '$max' => '$run_time' },
+                                                   'minRunTime'       => { '$min' => '$run_time' }
+                                 }
+                                   } ] )
+
+    end
+
+    it 'should correctly convert date to mongo' do
+      d = Date.new(2001, 2, 3)
+      u = d.to_time.utc
+      m = Maestro::Metrics.to_mongo(d)
+
+      m.should == u
+    end
+
+    it 'should correctly convert time to mongo' do
+      t = Time.parse("2001-02-03 04:05:06 -0800")
+      u = t.utc
+      m = Maestro::Metrics.to_mongo(t)
+
+      m.should == u
+    end
+
+    it 'should correctly convert string datetime to mongo' do
+      s = "2001-02-03 04:05:06"
+      u = Time.parse(s).utc
+      m = Maestro::Metrics.to_mongo(s)
+
+      m.should == u
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'rspec'
+require 'maestro_metrics'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib') unless $LOAD_PATH.include?(File.dirname(__FILE__) + '/../lib')
+
+
+
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: maestro_metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Etienne Pelletier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: statsd
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: A gem used to log application metrics
+email:
+- epelletier@maestrodev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- README.md
+- Rakefile
+- lib/maestro_metrics.rb
+- lib/maestro_metrics/version.rb
+- maestro_metrics.gemspec
+- spec/maestro_metrics_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kellyp/maestro-metrics
+licenses: []
+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.0.3
+signing_key:
+specification_version: 4
+summary: Use this gem to record application run time metrics.
+test_files:
+- spec/maestro_metrics_spec.rb
+- spec/spec_helper.rb