adhearsion-stats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d587ad87763835b7a5f856f76682467a653924f7
+  data.tar.gz: 1d4afde478e4c00eb75b01b36bf263d0fc57dacc
+SHA512:
+  metadata.gz: db4891c188316c18910dd11ed2b0afc93394a2fcfc1d4b42833d30e3ba55f996a96ad567e361e77909082dcf6075455f8a91ec5a293fd906602842ef1d108e46
+  data.tar.gz: b71ad1fe5885410f537439a03a7c1786124d471b6d0ae026c25890086e3530aa69f6831859a87d8de3f622a1bc26d61fbaea2a77918f4d9de13c364b312e2c74

data/.gitignore

@@ -0,0 +1,22 @@
+# Gem related stuff
+*.gem
+/pkg
+/.bundle
+/Gemfile.lock
+/vendor
+
+# RBX stuff
+/.rbx/
+
+# Editor temp/backup files
+*~
+.*.sw?
+
+# General
+/nbproject
+.DS_Store
+/.rvmrc
+/.yardoc
+/doc
+/tmp
+/coverage

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx-2.1.1
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: rbx-2.1.1
+    - rvm: ruby-head

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', cli: '--format documentation', all_on_start: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2013 Adhearsion Foundation Inc.
+
+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,121 @@
+# Adhearsion Stats [![Build Status](https://secure.travis-ci.org/JustinAiken/adhearsion-stats.png?branch=master)](http://travis-ci.org/JustinAiken/adhearsion-stats)[![Code Climate](https://codeclimate.com/github/JustinAiken/adhearsion-stats.png)](https://codeclimate.com/github/JustinAiken/adhearsion-stats)[![Coverage Status](https://coveralls.io/repos/JustinAiken/adhearsion-stats/badge.png)](https://coveralls.io/r/JustinAiken/adhearsion-stats)
+
+This is an Adhearsion plugin for sending metrics to a [statsd server](https://github.com/etsy/statsd/).
+
+It uses the [statsd gem](https://github.com/reinh/statsd).
+
+## Usage Example
+
+```ruby
+class WellTrackedCallController < Adhearsion::CallController
+
+  before_call :start_stats
+  after_call  :end_stats
+
+  def run
+    answer
+    ...
+    hangup
+  end
+
+private
+
+  def start_stats
+    @call_started = Time.now.to_f
+    AdhearsionStats.increment "calls.started"
+    AdhearsionStats.gauge "calls.in_progress", "+1"
+  end
+
+  def end_stats
+    AdhearsionStats.gauge "calls.in_progress", "-1"
+
+    #Track call duration in ms
+    call_duration = Time.now.to_f - @call_started
+    AdhearsionStats.timing "calls.length", (call_duration * 1000).to_i
+  end
+end
+```
+
+## Optional Logging
+
+If you set the `log_metrics` option to true, it will generate a log file called `adhearsion-stats.log` next to the `adhearsion.log` showing every call send to statsd:
+
+```
+...
+2014-01-14 01:08:53 PM: increment(foo)
+2014-01-14 01:08:53 PM: timing(bar,100)
+...
+```
+
+## Stat Types
+
+#### Counters (`#increment` and `#decrement`)
+
+Either increments or decrements a simple counter.  Mostly used for checking rate of things happening.
+By default will go up or down one, but you can also pass a value to increment a set amount:
+
+```ruby
+AdhearsionStats.increment "foo", 10
+```
+
+#### Timers (`#timing` and `#time`)
+
+Besides timing, can also be used for percents:
+
+```ruby
+6.times do
+  AdhearsionStats.timing "foo", 100
+end
+
+4.times do
+  AdhearsionStats.timing "foo", 0
+end
+
+# Sixty percent of the time, it works every time!
+
+```
+
+A block method is also available if you want to time an action:
+
+```ruby
+
+AdhearsionStats.time "time_spent_in_menu" do
+  menu menu_message do
+    ...
+  end
+end
+
+```
+
+#### Gauges (`#gauge`)
+
+Used to track running counts of something - these aren't reset each flush period.
+
+```ruby
+AdhearsionStats.gauge "foo", +4 #This now goes up 4 and stays up 4 until the next time the gauge is sent something
+```
+
+### Links
+
+* [Adhearsion](http://adhearsion.com)
+* [Source](https://github.com/JustinAiken/adhearsion-stats)
+* [Bug Tracker](https://github.com/JustinAiken/adhearsion-stats/issues)
+
+### Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+### Credits
+
+Original author: [JustinAiken](https://github.com/JustinAiken)
+
+Developed for [Mojo Lingo](http://mojolingo.com).
+
+### Copyright
+
+Copyright (c) 2013 Adhearsion Foundation Inc. MIT license (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec

data/adhearsion-stats.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "adhearsion-stats/version"
+
+Gem::Specification.new do |s|
+  s.name        = "adhearsion-stats"
+  s.version     = AdhearsionStats::VERSION
+  s.authors     = ["JustinAiken"]
+  s.email       = ["jaiken@mojolingo.com"]
+  s.homepage    = "https://github.com/polysics/adhearsion-stats"
+  s.summary     = %q{Adhearsion plugin for stats}
+  s.description = %q{Adhearsion plugin for stats. Reports via statsd.}
+  s.license     = 'MIT'
+
+  s.rubyforge_project = "adhearsion-stats"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency %q<adhearsion>, ["~> 2.1"]
+  s.add_runtime_dependency %q<statsd-ruby>
+
+  s.add_development_dependency %q<coveralls>, ['>= 0']
+  s.add_development_dependency %q<bundler>, ["~> 1.0"]
+  s.add_development_dependency %q<rspec>, ["~> 2.5"]
+  s.add_development_dependency %q<rake>, [">= 0"]
+  s.add_development_dependency %q<guard-rspec>
+ end

data/lib/adhearsion-stats.rb

@@ -0,0 +1,5 @@
+module AdhearsionStats; end
+
+require "adhearsion-stats/version"
+require "adhearsion-stats/metrics_logger"
+require "adhearsion-stats/plugin"

data/lib/adhearsion-stats/metrics_logger.rb

@@ -0,0 +1,17 @@
+require 'logger'
+
+module AdhearsionStats
+
+  class MetricsLogger < Logger
+    def format_message(severity, timestamp, progname, msg)
+      nice = timestamp.strftime("%Y-%m-%d %I:%M:%S %p")
+      "#{nice}: #{msg}\n"
+    end
+  end
+
+  def self.setup_logger
+    logfile         = File.open(File.dirname(__FILE__) + "#{Adhearsion.root}/log/adhearsion-stats.log", 'a')
+    logfile.sync    = true
+    @metrics_logger = MetricsLogger.new(logfile)
+  end
+end

data/lib/adhearsion-stats/plugin.rb

@@ -0,0 +1,35 @@
+require 'statsd'
+
+module AdhearsionStats
+
+  class << self
+    attr_accessor :statsd, :loaded, :metrics_logger
+  end
+
+  class Plugin < Adhearsion::Plugin
+
+    config :statsd do
+      host "127.0.0.1",  desc: "The host that statsd is found at"
+      port 8125,         desc: "The port that statsd is found at"
+      log_metrics false, desc: "Whether or not to log stats sent to statsd"
+    end
+
+    init :statsd do
+      AdhearsionStats.setup_logger if Adhearsion.config.statsd.log_metrics
+
+      AdhearsionStats.statsd = Statsd.new Adhearsion.config.statsd.host, Adhearsion.config.statsd.port
+      AdhearsionStats.loaded = true
+
+      logger.info "Adhearsion-Stats has been loaded"
+    end
+  end
+
+  class << self
+    def method_missing(meth, *args, &blk)
+      if Adhearsion.config[:statsd].log_metrics
+        metrics_logger.send :info, "#{meth}(#{args.join(",")})"
+      end
+      AdhearsionStats.statsd.send meth, *args
+    end
+  end
+end

data/lib/adhearsion-stats/version.rb

@@ -0,0 +1,3 @@
+module AdhearsionStats
+  VERSION = "0.0.1"
+end

data/spec/adhearsion-stats/plugin_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe AdhearsionStats do
+
+  describe "plugin configuration" do
+    it "sets the default values" do
+      Adhearsion.config[:statsd].host.should == '127.0.0.1'
+      Adhearsion.config[:statsd].port.should == 8125
+      Adhearsion.config[:statsd].log_metrics.should be_false
+    end
+  end
+
+  describe "initialization" do
+    let(:logfile)       { double "File", 'sync=' => true }
+    let!(:dummy_logger) { AdhearsionStats::MetricsLogger.new(STDOUT) }
+
+    before do
+      File.stub(:open).and_return logfile
+      AdhearsionStats::MetricsLogger.stub(:new).with(logfile).and_return dummy_logger
+      Adhearsion.config[:statsd].log_metrics = true
+      Adhearsion::Plugin.initializers.each { |plugin_initializer| plugin_initializer.run }
+    end
+
+    it "sets init variables" do
+      subject.statsd.should be_an_instance_of Statsd
+      subject.statsd.host.should == "127.0.0.1"
+      subject.statsd.port.should == 8125
+
+      subject.metrics_logger.should be_an_instance_of AdhearsionStats::MetricsLogger
+      subject.loaded.should be_true
+    end
+
+    describe "the plugin" do
+      let(:statsd)     { FakeStatsd.new }
+      let(:stats_sent) { statsd.socket.buffer.flatten }
+
+      before { subject.statsd = statsd }
+
+      it "has methods that calls statsd" do
+        subject.increment "foo"
+        subject.timing "bar", 100
+        subject.gauge "biz", "+1"
+
+        stats_sent.should include "foo:1|c"
+        stats_sent.should include "bar:100|ms"
+        stats_sent.should include "biz:+1|g"
+      end
+
+      describe "logging" do
+        it "adds logging to all reporting methods" do
+          subject.metrics_logger.should_receive(:info).with 'increment(foo)'
+          subject.increment "foo"
+
+          subject.metrics_logger.should_receive(:info).with 'timing(bar,100)'
+          subject.timing "bar", 100
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'adhearsion'
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'adhearsion-stats'
+require 'support/statsd_test_helper'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end
+

data/spec/support/statsd_test_helper.rb

@@ -0,0 +1,17 @@
+class FakeUDPSocket
+  def buffer
+    @buffer ||= []
+  end
+
+  def send(message, *rest)
+    buffer.push [message]
+  end
+
+  def to_s; buffer; end
+end
+
+class FakeStatsd < Statsd
+  def socket
+    @socket ||= FakeUDPSocket.new
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: adhearsion-stats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- JustinAiken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: adhearsion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  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: coveralls
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  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: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !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: guard-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: Adhearsion plugin for stats. Reports via statsd.
+email:
+- jaiken@mojolingo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adhearsion-stats.gemspec
+- lib/adhearsion-stats.rb
+- lib/adhearsion-stats/metrics_logger.rb
+- lib/adhearsion-stats/plugin.rb
+- lib/adhearsion-stats/version.rb
+- spec/adhearsion-stats/plugin_spec.rb
+- spec/spec_helper.rb
+- spec/support/statsd_test_helper.rb
+homepage: https://github.com/polysics/adhearsion-stats
+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: adhearsion-stats
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Adhearsion plugin for stats
+test_files: []