nunes 0.1.0

data/lib/nunes/subscriber.rb

@@ -0,0 +1,69 @@
+require "active_support/notifications"
+
+module Nunes
+  class Subscriber
+    # Private: The bang character that is the first char of some events.
+    BANG = '!'
+
+    # Public: Setup a subscription for the subscriber using the
+    # provided adapter.
+    #
+    # adapter - The adapter instance to send instrumentation to.
+    def self.subscribe(adapter, options = {})
+      subscriber = options.fetch(:subscriber) { ActiveSupport::Notifications }
+      subscriber.subscribe pattern, new(adapter)
+    end
+
+    def self.pattern
+      raise "Not Implemented, override in subclass and provide a regex or string."
+    end
+
+    # Private: The adapter to send instrumentation to.
+    attr_reader :adapter
+
+    # Internal: Initializes a new instance.
+    #
+    # adapter - The adapter instance to send instrumentation to.
+    def initialize(adapter)
+      @adapter = Nunes::Adapter.wrap(adapter)
+    end
+
+    # Private: Dispatcher that converts incoming events to method calls.
+    def call(name, start, ending, transaction_id, payload)
+      # rails doesn't recommend instrumenting methods that start with bang
+      # when in production
+      return if name.starts_with?(BANG)
+
+      method_name = name.split('.').first
+
+      if respond_to?(method_name)
+        send(method_name, start, ending, transaction_id, payload)
+      else
+        $stderr.puts "#{self.class.name} did not respond to #{method_name} therefore it cannot instrument the event named #{name}."
+      end
+    end
+
+    # Internal: Increment a metric for the client.
+    #
+    # metric - The String name of the metric to increment.
+    #
+    # Returns nothing.
+    def increment(metric)
+      if @adapter
+        @adapter.increment metric
+      end
+    end
+
+    # Internal: Track the timing of a metric for the client.
+    #
+    # metric - The String name of the metric.
+    # duration_in_ms - The Integer duration of the event in milliseconds.
+    #
+    # Returns nothing.
+    def timing(metric, duration_in_ms)
+      if @adapter
+        @adapter.timing metric, duration_in_ms
+      end
+    end
+  end
+end

data/lib/nunes/subscribers/action_controller.rb

@@ -0,0 +1,80 @@
+require "nunes/subscriber"
+
+module Nunes
+  module Subscribers
+    class ActionController < ::Nunes::Subscriber
+      # Private
+      Pattern = /\.action_controller\Z/
+
+      # Private: The namespace for events to subscribe to.
+      def self.pattern
+        Pattern
+      end
+
+      def process_action(start, ending, transaction_id, payload)
+        controller = payload[:controller].to_s.gsub('Controller', '').underscore
+        action = payload[:action]
+        status = payload[:status]
+        exception_info = payload[:exception]
+
+        format = payload[:format] || "all"
+        format = "all" if format == "*/*"
+
+        db_runtime = payload[:db_runtime]
+        db_runtime = db_runtime.round if db_runtime
+
+        view_runtime = payload[:view_runtime]
+        view_runtime = view_runtime.round if view_runtime
+
+        runtime = ((ending - start) * 1_000).round
+
+        timing "action_controller.runtime",      runtime      if runtime
+        timing "action_controller.view_runtime", view_runtime if view_runtime
+        timing "action_controller.db_runtime",   db_runtime   if db_runtime
+
+        increment "action_controller.format.#{format}" if format
+        increment "action_controller.status.#{status}" if status
+
+        if controller && action
+          namespace = "action_controller.#{controller}.#{action}"
+
+          timing "#{namespace}.runtime",      runtime      if runtime
+          timing "#{namespace}.view_runtime", view_runtime if view_runtime
+          timing "#{namespace}.db_runtime",   db_runtime   if db_runtime
+        end
+
+        if exception_info
+          exception_class, exception_message = exception_info
+
+          increment "action_controller.exception.#{exception_class}"
+        end
+      end
+
+      ##########################################################################
+      # All of the events below don't really matter. Most of them also go      #
+      # through process_action. The only value that could be pulled from them  #
+      # would be topk related which graphite doesn't do.                       #
+      ##########################################################################
+
+      def start_processing(*)
+        # noop
+      end
+
+      def halted_callback(*)
+        # noop
+      end
+
+      def redirect_to(*)
+        # noop
+      end
+
+      def send_file(*)
+        # noop
+      end
+
+      def send_data(*)
+        # noop
+      end
+    end
+  end
+end

data/lib/nunes/subscribers/action_mailer.rb

@@ -0,0 +1,33 @@
+require "nunes/subscriber"
+
+module Nunes
+  module Subscribers
+    class ActionMailer < ::Nunes::Subscriber
+      # Private
+      Pattern = /\.action_mailer\Z/
+
+      # Private: The namespace for events to subscribe to.
+      def self.pattern
+        Pattern
+      end
+
+      def deliver(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        mailer = payload[:mailer]
+
+        if mailer
+          timing "action_mailer.deliver.#{mailer.to_s.underscore}", runtime
+        end
+      end
+
+      def receive(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        mailer = payload[:mailer]
+
+        if mailer
+          timing "action_mailer.receive.#{mailer.to_s.underscore}", runtime
+        end
+      end
+    end
+  end
+end

data/lib/nunes/subscribers/action_view.rb

@@ -0,0 +1,44 @@
+require "nunes/subscriber"
+
+module Nunes
+  module Subscribers
+    class ActionView < ::Nunes::Subscriber
+      # Private
+      Pattern = /\.action_view\Z/
+
+      # Private: The namespace for events to subscribe to.
+      def self.pattern
+        Pattern
+      end
+
+      def render_template(start, ending, transaction_id, payload)
+        instrument_identifier payload[:identifier], start, ending
+      end
+
+      def render_partial(start, ending, transaction_id, payload)
+        instrument_identifier payload[:identifier], start, ending
+      end
+
+      private
+
+      # Private: Sends timing information about identifier event.
+      def instrument_identifier(identifier, start, ending)
+        if identifier.present?
+          runtime = ((ending - start) * 1_000).round
+          timing identifier_to_metric(identifier), runtime
+        end
+      end
+
+      # Private: Converts an identifier to a metric name. Strips out the rails
+      # root from the full path.
+      #
+      # identifier - The String full path to the template or partial.
+      def identifier_to_metric(identifier)
+        rails_root = ::Rails.root.to_s + '/'
+        view_path = identifier.gsub(rails_root, '')
+        metric = view_path.gsub('/', '.')
+        "action_view.#{metric}"
+      end
+    end
+  end
+end

data/lib/nunes/subscribers/active_record.rb

@@ -0,0 +1,33 @@
+require "nunes/subscriber"
+
+module Nunes
+  module Subscribers
+    class ActiveRecord < ::Nunes::Subscriber
+      # Private
+      Pattern = /\.active_record\Z/
+
+      # Private: The namespace for events to subscribe to.
+      def self.pattern
+        Pattern
+      end
+
+      def sql(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        name = payload[:name]
+        sql = payload[:sql].to_s.strip
+        operation = sql.split(' ', 2).first.to_s.downcase
+
+        timing "active_record.sql", runtime
+
+        case operation
+        when "begin"
+          timing "active_record.sql.transaction_begin", runtime
+        when "commit"
+          timing "active_record.sql.transaction_commit", runtime
+        else
+          timing "active_record.sql.#{operation}", runtime
+        end
+      end
+    end
+  end
+end

data/lib/nunes/subscribers/active_support.rb

@@ -0,0 +1,58 @@
+require "nunes/subscriber"
+
+module Nunes
+  module Subscribers
+    class ActiveSupport < ::Nunes::Subscriber
+      # Private
+      Pattern = /\.active_support\Z/
+
+      # Private: The namespace for events to subscribe to.
+      def self.pattern
+        Pattern
+      end
+
+      def cache_read(start, ending, transaction_id, payload)
+        super_operation = payload[:super_operation]
+        runtime = ((ending - start) * 1_000).round
+
+        case super_operation
+        when Symbol
+          timing "active_support.cache_#{super_operation}", runtime
+        else
+          timing "active_support.cache_read", runtime
+        end
+
+        hit = payload[:hit]
+        unless hit.nil?
+          hit_type = hit ? :hit : :miss
+          increment "active_support.cache_#{hit_type}"
+        end
+      end
+
+      def cache_generate(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        timing "active_support.cache_generate", runtime
+      end
+
+      def cache_fetch_hit(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        timing "active_support.cache_fetch_hit", runtime
+      end
+
+      def cache_write(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        timing "active_support.cache_write", runtime
+      end
+
+      def cache_delete(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        timing "active_support.cache_delete", runtime
+      end
+
+      def cache_exist?(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        timing "active_support.cache_exist", runtime
+      end
+    end
+  end
+end

data/lib/nunes/subscribers/nunes.rb

@@ -0,0 +1,24 @@
+require "nunes/subscriber"
+
+module Nunes
+  module Subscribers
+    class Nunes < ::Nunes::Subscriber
+      # Private
+      Pattern = /\.nunes\Z/
+
+      # Private: The namespace for events to subscribe to.
+      def self.pattern
+        Pattern
+      end
+
+      def instrument_method_time(start, ending, transaction_id, payload)
+        runtime = ((ending - start) * 1_000).round
+        metric = payload[:metric]
+
+        if metric
+          timing "#{metric}", runtime
+        end
+      end
+    end
+  end
+end

data/lib/nunes/version.rb

@@ -0,0 +1,3 @@
+module Nunes
+  VERSION = "0.1.0"
+end

data/nunes.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nunes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nunes"
+  spec.version       = Nunes::VERSION
+  spec.authors       = ["John Nunemaker"]
+  spec.email         = ["nunemaker@gmail.com"]
+  spec.description   = %q{The friendly gem that instruments everything for you, like I would if I could.}
+  spec.summary       = %q{The friendly gem that instruments everything for you, like I would if I could.}
+  spec.homepage      = "https://github.com/jnunemaker/nunes"
+  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"
+end

data/script/bootstrap

@@ -0,0 +1,21 @@
+#!/bin/sh
+#/ Usage: bootstrap [bundle options]
+#/
+#/ Bundle install the dependencies.
+#/
+#/ Examples:
+#/
+#/   bootstrap
+#/   bootstrap --local
+#/
+
+set -e
+cd $(dirname "$0")/..
+
+[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
+    grep '^#/' <"$0"| cut -c4-
+    exit 0
+}
+
+rm -rf .bundle/{binstubs,config}
+bundle install --binstubs .bundle/binstubs --path .bundle --quiet "$@"

data/script/test

@@ -0,0 +1,25 @@
+#!/bin/sh
+#/ Usage: test [individual test file]
+#/
+#/ Bootstrap and run all tests or an individual test.
+#/
+#/ Examples:
+#/
+#/   # run all tests
+#/   test
+#/
+#/   # run individual test
+#/   test test/controller_instrumentation_test.rb
+#/
+
+set -e
+cd $(dirname "$0")/..
+
+[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
+    grep '^#/' <"$0"| cut -c4-
+    exit 0
+}
+
+script/bootstrap && ruby -I lib -I test -r rubygems \
+  -e 'require "bundler/setup"' \
+  -e '(ARGV.empty? ? Dir["test/**/*_test.rb"] : ARGV).each { |f| load f }' -- "$@"

data/script/watch

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+#/ Usage: watch
+#/
+#/ Run the tests whenever any relevant files change.
+#/
+
+require "pathname"
+require "rubygems"
+require "bundler"
+Bundler.setup :watch
+
+# Put us where we belong, in the root dir of the project.
+Dir.chdir Pathname.new(__FILE__).realpath + "../.."
+
+# Run the tests to start.
+system "clear; script/test"
+
+require "rb-fsevent"
+
+IgnoreRegex = /\/log|db/
+
+fs = FSEvent.new
+fs.watch ["lib", "test"], latency: 1 do |args|
+  unless args.first =~ IgnoreRegex
+    system "clear"
+    puts "#{args.first} changed..."
+    system "script/test"
+  end
+end
+fs.run