nunes 0.1.0

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/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rails", "~> 3.2.12"
+gem "sqlite3-ruby", require: "sqlite3"
+gem "minitest"
+gem "rake"
+
+group :watch do
+  gem "rb-fsevent", require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Nunemaker
+
+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,150 @@
+# Nunes
+
+The friendly gem that instruments everything for you, like I would if I could.
+
+## Why "nunes"?
+
+Because I don't work for you, but even that could not stop me from trying to make it as easy as possible for you to instrument ALL THE THINGS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nunes'
+
+Or install it yourself as:
+
+    $ gem install nunes
+
+## Usage
+
+nunes works out of the box with statsd and instrument_agent. All you need to do is subscribe using an instance of statsd or instrumental's agent and you are good to go.
+
+### With Statsd
+
+```ruby
+require 'nunes'
+
+statsd = Statsd.new(...)
+Nunes.subscribe(statsd)
+```
+
+### With Instrumental
+
+```ruby
+require 'nunes'
+I = Instrument::Agent.new(...)
+Nunes.subscribe(I)
+```
+
+## What Can I Do For You?
+
+If you are using nunes with rails, out of the box, I'll subscribe to Actve Support's notifications for:
+
+* `process_action.action_controller`
+* `render_template.action_view`
+* `render_partial.action_view`
+* `deliver.action_mailer`
+* `receive.action_mailer`
+* `sql.active_record`
+* `cache_read.active_support`
+* `cache_generate.active_support`
+* `cache_fetch_hit.active_support`
+* `cache_write.active_support`
+* `cache_delete.active_support`
+* `cache_exist?.active_support`
+
+Whoa! You would do all that for me? Yep, I would. Because I care. Deeply.
+
+Based on those events, you'll get metrics like this in statsd and instrumental:
+
+#### Counters
+
+* `action_controller.status.200`
+* `action_controller.format.html`
+* `action_controller.exception.RuntimeError` - where RuntimeError is the class of any exceptions that occur while processing a controller's action.
+* `active_support.cache_hit`
+* `active_support.cache_miss`
+
+#### Timers
+
+* `action_controller.runtime`
+* `action_controller.view_runtime`
+* `action_controller.db_runtime`
+* `action_controller.posts.index.runtime` - where `posts` is the controller and `index` is the action
+* `action_view.app.views.posts.index.html.erb` - where `app.views.posts.index.html.erb` is the path of the view file
+* `action_view.app.views.posts._post.html.erb` - I can even do partials! woot woot!
+* `action_mailer.deliver.post_mailer` - where `post_mailer` is the name of the mailer
+* `action_mailer.receive.post_mailer` - where `post_mailer` is the name of the mailer
+* `active_record.sql`
+* `active_record.sql.select` - also supported are insert, update, delete, transaction_begin and transaction_commit
+* `active_support.cache_read`
+* `active_support.cache_generate`
+* `active_support.cache_fetch`
+* `active_support.cache_fetch_hit`
+* `active_support.cache_write`
+* `active_support.cache_delete`
+* `active_support.cache_exist`
+
+### But wait, there's more!!!
+
+In addition to doing all that work for you out of the box, I also allow you to wrap your own code with instrumentation. I know, I know, sounds too good to be true.
+
+```ruby
+class User < ActiveRecord::Base
+  extend Nunes::Instrumentable
+
+  # wrap save and instrument the timing of it
+  instrument_method_time :save
+end
+```
+
+This will instrument the timing of the User instance method save. What that means is when you do this:
+
+```ruby
+user = User.new(name: 'NUNES!')
+user.save
+```
+
+An event named `instrument_method_time.nunes` will be generated, which in turn is subscribed to and sent to whatever you used to send instrumentation to (statsd, instrumental, etc.). The metric name will default to class.method. For the example above, the metric name would be `user.save`. No fear, you can customize this.
+
+```ruby
+class User < ActiveRecord::Base
+  extend Nunes::Instrumentable
+
+  # wrap save and instrument the timing of it
+  instrument_method_time :save, 'crazy_town.save'
+end
+```
+
+Passing a string as the second argument sets the name of the metric. You can also customize the name using a Hash as the second argument.
+
+```ruby
+class User < ActiveRecord::Base
+  extend Nunes::Instrumentable
+
+  # wrap save and instrument the timing of it
+  instrument_method_time :save, name: 'crazy_town.save'
+end
+```
+
+In addition to name, you can also pass a payload that will get sent along with the generated event.
+
+```ruby
+class User < ActiveRecord::Base
+  extend Nunes::Instrumentable
+
+  # wrap save and instrument the timing of it
+  instrument_method_time :save, payload: {pay: "loading"}
+end
+```
+
+If you subscribe to the event on your own, say to log some things, you'll get a key named `:pay` with a value of `"loading"` in the event's payload. Pretty neat, eh?
+
+## 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/lib/nunes.rb

@@ -0,0 +1,39 @@
+require "nunes/instrumentable"
+
+require "nunes/adapters/memory"
+require "nunes/adapters/default"
+require "nunes/adapters/timing_aliased"
+
+require "nunes/subscriber"
+require "nunes/subscribers/action_controller"
+require "nunes/subscribers/action_view"
+require "nunes/subscribers/action_mailer"
+require "nunes/subscribers/active_support"
+require "nunes/subscribers/active_record"
+require "nunes/subscribers/nunes"
+
+module Nunes
+  # Public: Shortcut method to setup all subscribers for a given client.
+  #
+  # client - The instance that will be adapted and receive all instrumentation.
+  #
+  # Examples:
+  #
+  #   Nunes.subscribe(Statsd.new)
+  #   Nunes.subscribe(Instrumental::Agent.new)
+  #
+  # Returns Array of subscribers that were setup.
+  def self.subscribe(client)
+    subscribers = []
+    adapter = Nunes::Adapter.wrap(client)
+
+    subscribers << Subscribers::ActionController.subscribe(adapter)
+    subscribers << Subscribers::ActionView.subscribe(adapter)
+    subscribers << Subscribers::ActionMailer.subscribe(adapter)
+    subscribers << Subscribers::ActiveSupport.subscribe(adapter)
+    subscribers << Subscribers::ActiveRecord.subscribe(adapter)
+    subscribers << Subscribers::Nunes.subscribe(adapter)
+
+    subscribers
+  end
+end

data/lib/nunes/adapter.rb

@@ -0,0 +1,56 @@
+module Nunes
+  class Adapter
+    # Private: Wraps a given object with the correct adapter/decorator.
+    #
+    # client - The thing to be wrapped.
+    #
+    # Returns Nunes::Adapter instance.
+    def self.wrap(client)
+      if client.nil?
+        raise ArgumentError.new("client cannot be nil")
+      end
+
+      if client.is_a?(self)
+        return client
+      end
+
+      if client.is_a?(Hash)
+        return Adapters::Memory.new(client)
+      end
+
+      has_increment = client.respond_to?(:increment)
+      has_timing = client.respond_to?(:timing)
+      has_gauge = client.respond_to?(:gauge)
+
+      if has_increment && has_timing
+        Adapters::Default.new(client)
+      elsif has_increment && has_gauge && !has_timing
+        Adapters::TimingAliased.new(client)
+      else
+        raise "I have no clue how to wrap what you've given me (#{client.inspect})"
+      end
+    end
+
+    # Private
+    attr_reader :client
+
+    # Internal: Sets the client for the adapter.
+    #
+    # client - The thing being adapted to a simple interface.
+    def initialize(client)
+      @client = client
+    end
+
+    # Internal: Increment a metric by a value. Override in subclass if client
+    # interface does not match.
+    def increment(metric, value = 1)
+      @client.increment metric, value
+    end
+
+    # Internal: Record a metric's duration. Override in subclass if client
+    # interface does not match.
+    def timing(metric, duration)
+      @client.timing metric, duration
+    end
+  end
+end

data/lib/nunes/adapters/default.rb

@@ -0,0 +1,10 @@
+require "nunes/adapter"
+
+module Nunes
+  module Adapters
+    # Internal: Default is the assumed interface, so we don't need to override
+    # anything. This should never need to be used directly by a user of the gem.
+    class Default < ::Nunes::Adapter
+    end
+  end
+end

data/lib/nunes/adapters/memory.rb

@@ -0,0 +1,62 @@
+require "nunes/adapter"
+
+module Nunes
+  module Adapters
+    # Internal: Memory backend for recording instrumentation calls. This should
+    # never need to be used directly by a user of the gem.
+    class Memory < ::Nunes::Adapter
+      def initialize(client = nil)
+        @client = client || {}
+        clear
+      end
+
+      def increment(metric, value = 1)
+        counters << [metric, value]
+      end
+
+      def timing(metric, value)
+        timers << [metric, value]
+      end
+
+      # Internal: Returns Array of any recorded timers with durations.
+      def timers
+        @client.fetch(:timers)
+      end
+
+      # Internal: Returns Array of only recorded timers.
+      def timer_metric_names
+        timers.map { |op| op.first }
+      end
+
+      # Internal: Returns true/false if metric has been recorded as a timer.
+      def timer?(metric)
+        timers.detect { |op| op.first == metric }
+      end
+
+      # Internal: Returns Array of any recorded counters with values.
+      def counters
+        @client.fetch(:counters)
+      end
+
+      # Internal: Returns Array of only recorded counters.
+      def counter_metric_names
+        counters.map { |op| op.first }
+      end
+
+      # Internal: Returns true/false if metric has been recorded as a counter.
+      def counter?(metric)
+        counters.detect { |op| op.first == metric }
+      end
+
+      # Internal: Empties the known counters and metrics.
+      #
+      # Returns nothing.
+      def clear
+        @client ||= {}
+        @client.clear
+        @client[:timers] = []
+        @client[:counters] = []
+      end
+    end
+  end
+end

data/lib/nunes/adapters/timing_aliased.rb

@@ -0,0 +1,17 @@
+require "nunes/adapter"
+
+module Nunes
+  module Adapters
+    # Internal: Adapter that aliases timing to gauge. One of the supported
+    # places to send instrumentation data is instrumentalapp.com. Their agent
+    # uses gauge under the hood for timing information. This adapter is used to
+    # adapter their gauge interface to the timing one used internally in the
+    # gem. This should never need to be used directly by a user of the gem.
+    class TimingAliased < ::Nunes::Adapter
+      # Internal: Adapter timing to gauge.
+      def timing(metric, duration)
+        @client.gauge metric, duration
+      end
+    end
+  end
+end

data/lib/nunes/instrumentable.rb

@@ -0,0 +1,102 @@
+require "active_support/notifications"
+
+module Nunes
+  # Extend and instrument. Simple class that makes it easy to instrument method
+  # timing using ActiveSupport::Notifications.
+  #
+  # The event name is the name of the method being instrumented and the event
+  # namespace is the name of the class the method is in.
+  #
+  # Examples
+  #
+  #   # To instrument an instance method, extend the module and instrument it.
+  #   class User
+  #     # Only need to do this once.
+  #     extend Nunes::Instrumentable
+  #
+  #     def something
+  #       # ...
+  #     end
+  #
+  #     instrument_method_time :something
+  #
+  #     # you can customize the event and namespace by providing the name option
+  #     instrument_method_time :something, {
+  #       name: "something.else.User",
+  #     }
+  #
+  #     # you can also add additional payload items
+  #     instrument_method_time :something, {
+  #       payload: {some: 'thing'},
+  #     }
+  #   end
+  #
+  #   # To instrument a class method, you need to extend the module on the
+  #   # singleton class and use the same to call the method.
+  #   class User
+  #     # Only need to do this once.
+  #     singleton_class.extend Nunes::Instrumentable
+  #
+  #     def self.something_class_level
+  #       # ...
+  #     end
+  #
+  #     singleton_class.instrument_method_time :someting_class_level
+  #   end
+  #
+  module Instrumentable
+    # Private
+    MethodTimeEventName = "instrument_method_time.nunes".freeze
+
+    # Public: Instrument a method's timing by name.
+    #
+    # method_name - The String or Symbol name of the method.
+    # options_or_string - The Hash of options or the String metic name.
+    #           :payload - Any items you would like to include with the
+    #                      instrumentation payload.
+    #           :name - The String name of the event and namespace.
+    def instrument_method_time(method_name, options_or_string = nil)
+      options = options_or_string || {}
+      options = {name: options} if options.is_a?(String)
+
+      action = :time
+      payload = options.fetch(:payload) { {} }
+      instrumenter = options.fetch(:instrumenter) { ActiveSupport::Notifications }
+
+      payload[:metric] = options.fetch(:name) {
+        "#{self.name}/#{method_name}"
+      }.to_s.underscore.gsub('/', '.')
+
+      nunes_wrap_method(method_name, action) do |old_method_name, new_method_name|
+        define_method(new_method_name) do |*args, &block|
+          instrumenter.instrument(MethodTimeEventName, payload) {
+            result = send(old_method_name, *args, &block)
+
+            payload[:arguments] = args
+            payload[:result] = result
+
+            result
+          }
+        end
+      end
+    end
+
+    # Private: And so horrendously ugly...
+    def nunes_wrap_method(method_name, action, &block)
+      method_without_instrumentation = :"#{method_name}_without_#{action}"
+      method_with_instrumentation = :"#{method_name}_with_#{action}"
+
+      if method_defined?(method_without_instrumentation)
+        raise ArgumentError, "already instrumented #{method_name} for #{self.name}"
+      end
+
+      if !method_defined?(method_name) && !private_method_defined?(method_name)
+        raise ArgumentError, "could not find method #{method_name} for #{self.name}"
+      end
+
+      alias_method method_without_instrumentation, method_name
+      yield method_without_instrumentation, method_with_instrumentation
+      alias_method method_name, method_with_instrumentation
+    end
+  end
+end