traced 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGIwMWU3MmI3OGY5MGZhOGJiZDVhNDY0ODU2ZjdkYTU5YjgwZmIyNg==
+  data.tar.gz: !binary |-
+    MWNhZGIwYmJhNDM2NmI2MzRmNWFlNDdmYzBiMGJhMjhlZWQwOWFmMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjQ2MmUzYTNkN2JlYjI5NzVhMzUzMmNiY2FjMDAzZDY4NjFjMDU3ZGRiY2Q2
+    OGJiMWUxZDEyNTc2OTZhOGQ4YjUyYzhhZGY1ODUzYjQ4MTU2NDIzZjVhYWM0
+    YmJiYjE5NzdhMTUxZjFiMjQxYTlmMzlkY2Y2ODJiZDM2YmY5OGI=
+  data.tar.gz: !binary |-
+    N2ZlN2Q3OTUzMWU4ZmQzZGViYzNjMDI4MmVkYjRkZTZkZDNmNzY3YmJlOTg1
+    YjQ4MmM5MjVhMDdkODY5Y2FmNDRlMmY5ZDhmYmZlOGNhYzllMDIxOTJmZjYw
+    MjhmZDczMGNiNTBiN2M5MzU3ZjhiMDFhZTRiYjc4NGEzN2Y1YTk=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Erez Rabih
+
+MIT License
+
+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,108 @@
+# Traced
+
+TraceD is a ruby library which enables you to easily trace your methods via [StatsD](https://github.com/etsy/statsd/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'traced'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install traced
+
+## Usage
+
+### Configuration
+
+Before using TraceD in your code you will have to provide it with a StatsD
+Client. You can use many existing clients like [statsd-ruby](https://github.com/reinh/statsd).
+
+```ruby
+TraceD::Client.set(Statsd.new 'localhost', 9125)
+```
+I'll be using statsd-ruby as my client example in the usage scenarios.
+
+### Usage Scenraios
+
+Let's assume we have a Dummy class and we want to trace some_method:
+
+```ruby
+require 'traced'
+require 'statsd'
+TraceD::Client.set(Statsd.new 'localhost', 9125)
+
+class Dummy
+
+  include TraceD
+
+  def some_method(arg)
+  end
+
+  statsd_trace :some_method
+end
+```
+
+Simliarly, if we want to trace a class method, this is how things would look
+like:
+
+```ruby
+require 'traced'
+require 'statsd'
+TraceD::Client.set(Statsd.new 'localhost', 9125)
+
+class Dummy
+  class << self
+    include TraceD
+
+    def some_method(arg)
+    end
+
+    statsd_trace :some_method
+  end
+end
+```
+
+## Tracing Options
+
+### Stat Name
+
+By default, TraceD assigns the following stat name:
+
+```
+method_tracer.<Class Name>.<Method Name>
+```
+For example, in the first usage scenraio, the reported stat would be
+```
+method_tracer.Dummy.some_method
+```
+
+You can pass your own custom stat name in the following way:
+
+```ruby
+statsd_trace :some_method, stat_name: "custom.stat.name"
+```
+
+### Execution Count
+
+By default, TraceD will only report the execution time of the method.
+You can ask it to report the number of times a method has been called in the
+following way:
+
+```ruby
+statsd_trace :some_method, count: true
+```
+This way, both execution time and count will be reported
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/traced.rb

@@ -0,0 +1,50 @@
+require "traced/version"
+require 'traced/client'
+
+module TraceD
+
+  def self.included clazz
+    clazz.extend ClassMethods
+  end
+
+  module InstanceMethods
+
+    def traced_method_name(method)
+      "_statsd_traced_#{method}"
+    end
+
+    def default_time_stat_name(method)
+      my_name = self.class.name == "Class" ? self.name : self.class.name
+      "method_tracer.#{my_name}.#{method}"
+    end
+
+    def default_count_stat_name(stat_name)
+      "#{stat_name}.count"
+    end
+  end
+
+  module ClassMethods
+    def statsd_trace(method, opts = {})
+
+      old_method_name = traced_method_name(method)
+      alias_method old_method_name, method
+
+      define_method method do |*args|
+
+        opts[:stat_name] ||= default_time_stat_name(method)
+        opts[:count_stat_name] = default_count_stat_name(opts[:stat_name])
+
+        ::TraceD::Client.increment(opts[:count_stat_name]) if opts[:count]
+        ::TraceD::Client.time(opts[:stat_name]) do
+          self.send(old_method_name, *args)
+        end
+      end
+
+    end
+
+    include ::TraceD::InstanceMethods
+  end
+
+  include InstanceMethods
+
+end

data/lib/traced/client.rb

@@ -0,0 +1,19 @@
+module TraceD
+  class Client
+    class << self
+      def set(client)
+        @client = client
+      end
+
+      def increment(stat)
+        @client.increment(stat)
+      end
+      
+      def time(stat)
+        @client.time(stat) do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/traced/version.rb

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

data/spec/lib/traced_spec.rb

@@ -0,0 +1,221 @@
+require 'spec_helper'
+require 'traced'
+
+describe TraceD do
+
+  before :all do
+    TraceD::Client.set(FakeStatsdClient.new)
+  end
+
+  module DummyMethods
+    def zero
+      return 0
+    end
+
+    def sum(arg1, arg2, arg3)
+      return arg1 + arg2 + arg3
+    end
+  end
+
+  class Dummy1
+    include TraceD
+    include DummyMethods
+  end
+
+  class Dummy2
+    include TraceD
+    include DummyMethods
+  end
+
+  class Dummy3
+    include TraceD
+    include DummyMethods
+  end
+
+  class Dummy4
+    class << self
+      include TraceD
+      def zero
+        return 0
+      end
+
+      def sum(arg1, arg2, arg3)
+        return arg1 + arg2 + arg3
+      end
+      statsd_trace :zero, count: true
+      statsd_trace :sum, stat_name: "class_sum"
+    end
+  end
+
+  describe "before tracing" do
+
+    describe :zero do
+      it "should return zero" do
+        Dummy1.new.zero.should eq 0
+      end
+    end
+
+    describe :sum do
+      it "should return the sum" do
+        Dummy1.new.sum(1,2,3).should eq 6
+      end
+    end
+
+  end
+
+  describe "traced" do
+
+    before :all do
+      Dummy1.class_eval do
+        statsd_trace :zero
+        statsd_trace :sum
+      end
+    end
+
+    describe :zero do
+      it "should return zero" do
+        Dummy1.new.zero.should eq 0
+      end
+    end
+
+    describe :sum do
+      it "should return the sum 1" do
+        Dummy1.new.sum(1,2,3).should eq 6
+      end
+    end
+
+    describe "statsd reporting" do
+      context "default stats name" do
+        it "should generate default name for stats" do
+          TraceD::Client.should_receive(:time).with("method_tracer.Dummy1.zero").once
+          TraceD::Client.should_receive(:time).with("method_tracer.Dummy1.sum").once
+          Dummy1.new.zero
+          Dummy1.new.sum(1,2,3)
+        end
+      end
+    end
+  end
+
+  describe "trace with stat name" do
+
+    before :all do
+      Dummy2.class_eval do
+        statsd_trace :zero, stat_name: :zero_stat
+        statsd_trace :sum, stat_name: :sum_stat
+      end
+    end
+
+    describe :zero do
+      it "should return zero" do
+        Dummy2.new.zero.should eq 0
+      end
+    end
+
+    describe :sum do
+      it "should return the sum 1" do
+        Dummy2.new.sum(1,2,3).should eq 6
+      end
+    end
+
+    describe "statsd reporting" do
+      context "stats name" do
+        it "should report with given stat name" do
+          TraceD::Client.should_receive(:time).with(:zero_stat).once
+          TraceD::Client.should_receive(:time).with(:sum_stat).once
+          Dummy2.new.zero
+          Dummy2.new.sum(1,2,3)
+        end
+      end
+    end
+  end
+
+  describe "trace with count" do
+
+    before :all do
+      Dummy3.class_eval do
+        statsd_trace :zero, count: true
+        statsd_trace :sum
+      end
+    end
+
+    describe :zero do
+      it "should return zero" do
+        Dummy3.new.zero.should eq 0
+      end
+    end
+
+    describe :sum do
+      it "should return the sum 1" do
+        Dummy3.new.sum(1,2,3).should eq 6
+      end
+    end
+
+    describe "statsd reporting" do
+      context "stats name" do
+        it "should report with given stat name" do
+          TraceD::Client.should_receive(:time).with("method_tracer.Dummy3.zero").once
+          TraceD::Client.should_receive(:time).with("method_tracer.Dummy3.sum").once
+          Dummy3.new.zero
+          Dummy3.new.sum(1,2,3)
+        end
+      end
+
+      context "count" do
+        it "should count traced method with count" do
+          TraceD::Client.should_receive(:increment).with("method_tracer.Dummy3.zero.count").once
+          Dummy3.new.zero
+        end
+
+        it "should not count traced method without count" do
+          TraceD::Client.should_not_receive(:increment)
+          Dummy3.new.sum(1,2,3)
+        end
+      end
+    end
+  end
+
+  describe "tracing class methods" do
+
+    describe :zero do
+      it "should return zero" do
+        Dummy4.zero.should eq 0
+      end
+    end
+
+    describe :sum do
+      it "should return the sum 1" do
+        Dummy4.sum(1,2,3).should eq 6
+      end
+    end
+
+    describe "statsd reporting" do
+      context "default stats name" do
+
+        context "zero" do
+          it "should report time" do
+            TraceD::Client.should_receive(:time).with("method_tracer.Dummy4.zero").once
+            Dummy4.zero
+          end
+
+          it "should report count" do
+            TraceD::Client.should_receive(:increment).with("method_tracer.Dummy4.zero.count").once
+            Dummy4.zero
+          end
+        end
+
+        context "sum" do
+          it "should report time" do
+            TraceD::Client.should_receive(:time).with("class_sum").once
+            Dummy4.sum(1,2,3)
+          end
+
+          it "should not report count" do
+            TraceD::Client.should_not_receive(:increment)
+            Dummy4.sum(1,2,3)
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+# 
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/fake_statsd_client.rb

@@ -0,0 +1,9 @@
+class FakeStatsdClient
+
+  def increment(stat)
+  end
+
+  def time(stat)
+    yield
+  end
+end

data/tags

@@ -0,0 +1,30 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.8	//
+ClassMethods	/Users/erez/workspace/traced/lib/traced.rb	/^  module ClassMethods$/;"	m	class:TraceD
+Client	/Users/erez/workspace/traced/lib/traced/client.rb	/^  class Client$/;"	c	class:TraceD
+Dummy1	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^  class Dummy1$/;"	c
+Dummy2	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^  class Dummy2$/;"	c
+Dummy3	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^  class Dummy3$/;"	c
+Dummy4	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^  class Dummy4$/;"	c
+DummyMethods	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^  module DummyMethods$/;"	m
+InstanceMethods	/Users/erez/workspace/traced/lib/traced.rb	/^  module InstanceMethods$/;"	m	class:TraceD
+TraceD	/Users/erez/workspace/traced/lib/traced.rb	/^module TraceD$/;"	m
+TraceD	/Users/erez/workspace/traced/lib/traced/client.rb	/^module TraceD$/;"	m
+Traced	/Users/erez/workspace/traced/lib/traced/version.rb	/^module Traced$/;"	m
+client	/Users/erez/workspace/traced/lib/traced/client.rb	/^      def client$/;"	f	class:TraceD.Client
+config	/Users/erez/workspace/traced/lib/traced/client.rb	/^      def config$/;"	f	class:TraceD.Client
+default_count_stat_name	/Users/erez/workspace/traced/lib/traced.rb	/^    def default_count_stat_name(stat_name)$/;"	f	class:TraceD.InstanceMethods
+default_time_stat_name	/Users/erez/workspace/traced/lib/traced.rb	/^    def default_time_stat_name(method)$/;"	f	class:TraceD.InstanceMethods
+included	/Users/erez/workspace/traced/lib/traced.rb	/^  def self.included clazz$/;"	F	class:TraceD
+method_missing	/Users/erez/workspace/traced/lib/traced/client.rb	/^      def method_missing(sym, *args, &block)$/;"	f	class:TraceD.Client
+statsd_enabled?	/Users/erez/workspace/traced/lib/traced/client.rb	/^      def statsd_enabled?$/;"	f	class:TraceD.Client
+statsd_trace	/Users/erez/workspace/traced/lib/traced.rb	/^    def statsd_trace(method, opts = {})$/;"	f	class:TraceD.ClassMethods
+sum	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^      def sum(arg1, arg2, arg3)$/;"	f	class:Dummy4
+sum	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^    def sum(arg1, arg2, arg3)$/;"	f	class:DummyMethods
+traced_method_name	/Users/erez/workspace/traced/lib/traced.rb	/^    def traced_method_name(method)$/;"	f	class:TraceD.InstanceMethods
+zero	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^      def zero$/;"	f	class:Dummy4
+zero	/Users/erez/workspace/traced/spec/lib/traced_spec.rb	/^    def zero$/;"	f	class:DummyMethods

data/traced.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'traced/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "traced"
+  spec.version       = Traced::VERSION
+  spec.authors       = ["Erez Rabih"]
+  spec.email         = ["erez.rabih@gmail.com"]
+  spec.description   = %q{Method tracer for Statsd written in Ruby}
+  spec.summary       = %q{TraceD is a small module which enables seamless method tracing for both execution time and execution count}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: traced
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Erez Rabih
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: Method tracer for Statsd written in Ruby
+email:
+- erez.rabih@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/traced.rb
+- lib/traced/client.rb
+- lib/traced/version.rb
+- spec/lib/traced_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_statsd_client.rb
+- tags
+- traced.gemspec
+homepage: ''
+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.0.5
+signing_key: 
+specification_version: 4
+summary: TraceD is a small module which enables seamless method tracing for both execution
+  time and execution count
+test_files:
+- spec/lib/traced_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_statsd_client.rb
+has_rdoc: