A ruby method tracer for StatsD
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.coveralls.yml
.gitignore
.rspec
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
tags
traced.gemspec

README.md

Traced

Build Status Coverage Status

TraceD is a ruby library which enables you to easily trace your methods via 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.

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:

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:

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:

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:

statsd_trace :some_method, count: true

This way, both execution time and count will be reported

Notice

  1. Use the statsd_trace declaration only after the method definition in the class or else it won't work.

  2. If you're not using statsd-ruby please make sure your client adheres the following intrface:

class << self
  def increment(stat_name)
    # Report increment for stat_name
  end

  def time(stat_name, &block)
    # yield and report timing for block
  end
end

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