skylight 0.0.6 → 0.0.7

data/lib/skylight.rb

@@ -7,6 +7,12 @@ require 'active_support/notifications'
 module Skylight
   class Error < RuntimeError; end
 
+  TIERS = %w(
+    app
+    view
+    db
+    gc)
+
   # First require all util files
   require 'skylight/util/atomic'
   require 'skylight/util/bytes'
@@ -22,6 +28,7 @@ module Skylight
   require 'skylight/config'
   require 'skylight/instrumenter'
   require 'skylight/middleware'
+  require 'skylight/normalize'
   require 'skylight/json_proto'
   require 'skylight/subscriber'
   require 'skylight/trace'

data/lib/skylight/instrumenter.rb

@@ -25,7 +25,7 @@ module Skylight
 
     def start!
       @worker.start!
-      Subscriber.register!
+      Subscriber.register!(config)
 
       # Ensure properly configured
       return unless config

data/lib/skylight/json_proto.rb

@@ -22,7 +22,7 @@ module Skylight
 #             spans: [
 #               [
 #                 null, // parent-id -- index of the parent span or null if root node
-#                 0292352, // Span start timestamp in 0.1ms granularity
+#                 0292352, // Span start timestamp in 0.1ms granularity, relative to the start of the trace
 #                 20, // Duration of the span in 0.1ms granularity
 #                 "action_controller.process", // Span category
 #                 "Processing WidgetsController#index", // Span title, max 60 chars (optional)
@@ -33,8 +33,10 @@ module Skylight
 #                 0, // The previous span is this span's parent
 #                 1340923,
 #                 0, // No duration
-#                 "log.info", // category
+#                 "log.info", // category "foo" "\"foo\"
+#                 "Title", // Title
 #                 "Doing some stuff..." // Span description
+#                 {}, // Map String->String
 #               ]
 #             ]
 #           }
@@ -68,7 +70,9 @@ module Skylight
              s.started_at,
              s.ended_at - s.started_at,
              s.category,
-             s.description
+             s.title,
+             s.description,
+             s.annotations
             ]
           end
 
@@ -78,6 +82,9 @@ module Skylight
         ehash
       end
 
+      require "pp"
+      @config.logger.debug PP.pp(hash, "")
+
       out << hash.to_json
     end
   end

data/lib/skylight/middleware.rb

@@ -13,7 +13,7 @@ module Skylight
 
     def call(env)
       instrumenter.trace("Rack") do
-        ActiveSupport::Notifications.instrument("rack.request") do
+        ActiveSupport::Notifications.instrument("app.rack.request") do
           @app.call(env)
         end
       end

data/lib/skylight/normalize.rb

@@ -0,0 +1,38 @@
+module Skylight
+  module Normalize
+    @registry = {}
+
+    def self.normalize(trace, name, payload)
+      klass = @registry[name]
+
+      if klass
+        klass.new(trace, name, payload).normalize
+      else
+        Default.new(trace, name, payload).normalize
+      end
+    end
+
+    def self.register(name, klass)
+      @registry[name] = klass
+    end
+  end
+
+  class Normalizer
+    def self.register(name)
+      Normalize.register(name, self)
+    end
+
+    def initialize(trace, name, payload)
+      @trace, @name, @payload = trace, name, payload
+    end
+  end
+end
+
+require "skylight/normalize/default"
+require "skylight/normalize/start_processing"
+require "skylight/normalize/process_action"
+require "skylight/normalize/render_collection"
+require "skylight/normalize/render_template"
+require "skylight/normalize/render_partial"
+require "skylight/normalize/send_file"
+require "skylight/normalize/sql"

data/lib/skylight/normalize/default.rb

@@ -0,0 +1,17 @@
+module Skylight
+  module Normalize
+    class Default < Normalizer
+      REGEX = /^(?:#{TIERS.join('|')})(?:\.|$)/
+
+      def normalize
+        if @name =~ REGEX
+          annot = @payload.dup
+          [ @name, annot.delete(:title), annot.delete(:description), annot ]
+        else
+          :skip
+        end
+      end
+
+    end
+  end
+end

data/lib/skylight/normalize/process_action.rb

@@ -0,0 +1,17 @@
+module Skylight
+  module Normalize
+    class ProcessAction < Normalizer
+      register "process_action.action_controller"
+
+      def normalize
+        @trace.endpoint = controller_action
+        [ "app.controller.request", controller_action, controller_action, @payload ]
+      end
+
+    private
+      def controller_action
+        "#{@payload[:controller]}##{@payload[:action]}"
+      end
+    end
+  end
+end

data/lib/skylight/normalize/render_collection.rb

@@ -0,0 +1,15 @@
+module Skylight
+  module Normalize
+    class RenderCollection < Normalizer
+      register "render_collection.action_view"
+
+      def normalize
+        path = @payload[:identifier]
+        annotations = { count: @payload[:count] }
+
+        [ "view.render.collection", path, path, annotations ]
+      end
+    end
+  end
+end
+

data/lib/skylight/normalize/render_partial.rb

@@ -0,0 +1,17 @@
+module Skylight
+  module Normalize
+    class RenderPartial < Normalizer
+      register "render_partial.action_view"
+
+      def normalize
+        path = @payload[:identifier]
+        annotations = { partial: true }
+
+        [ "view.render.template", path, path, annotations ]
+      end
+    end
+  end
+end
+
+
+

data/lib/skylight/normalize/render_template.rb

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalize
+    class RenderTemplate < Normalizer
+      register "render_template.action_view"
+
+      def normalize
+        path = @payload[:identifier]
+        annotations = { partial: false }
+
+        [ "view.render.template", path, path, annotations ]
+      end
+    end
+  end
+end
+
+

data/lib/skylight/normalize/send_file.rb

@@ -0,0 +1,44 @@
+require "action_dispatch/http/mime_type"
+require "action_dispatch/http/mime_types"
+require "rack/utils"
+
+module Skylight
+  module Normalize
+    class SendFile < Normalizer
+      register "send_file.action_controller"
+
+      def normalize
+        path = @payload[:path]
+
+        annotations = {
+          path: path,
+          filename: @payload[:filename],
+          type: normalize_type,
+          disposition: normalize_disposition,
+          status: normalize_status
+        }
+
+        # These will eventually be different
+        title = desc = "send file: #{path}"
+
+        [ "app.controller.send_file", title, desc, annotations ]
+      end
+
+    private
+      def normalize_type
+        type = @payload[:type] || "application/octet-stream"
+        type = Mime[type].to_s if type.is_a?(Symbol)
+        type
+      end
+
+      def normalize_status
+        status = @payload[:status] || 200
+        Rack::Utils.status_code(status)
+      end
+
+      def normalize_disposition
+        @payload[:disposition] || "attachment"
+      end
+    end
+  end
+end

data/lib/skylight/normalize/sql.rb

@@ -0,0 +1,28 @@
+module Skylight
+  module Normalize
+    class SQL < Normalizer
+      register "sql.active_record"
+
+      def normalize
+        if @payload[:name] == "SCHEMA"
+          return :skip
+        elsif @payload[:name] == "CACHE"
+          name = "db.sql.cache"
+          title = "Cached Load"
+        else
+          name = "db.sql.query"
+          title = @payload[:name]
+        end
+
+        binds = @payload[:binds]
+
+        annotations = {
+          sql: @payload[:sql],
+          binds: binds ? binds.map(&:last) : []
+        }
+
+        [ name, title, nil, annotations ]
+      end
+    end
+  end
+end

data/lib/skylight/normalize/start_processing.rb

@@ -0,0 +1,12 @@
+module Skylight
+  module Normalize
+    class StartProcessing < Normalizer
+      register "start_processing.action_controller"
+
+      def normalize
+        return :skip
+      end
+    end
+  end
+end
+

data/lib/skylight/subscriber.rb

@@ -1,30 +1,49 @@
 module Skylight
   # TODO: Handle filtering out notifications that we don't care about
   class Subscriber
-    PROCESS_ACTION = "process_action.action_controller"
+    def self.register!(config=Config.new)
+      ActiveSupport::Notifications.subscribe nil, new(config)
+    end
 
-    def self.register!
-      ActiveSupport::Notifications.subscribe nil, new
+    def initialize(config)
+      @config = config
     end
 
     def start(name, id, payload)
       return unless trace = Trace.current
 
-      if name == PROCESS_ACTION
-        trace.endpoint = controller_action(payload)
+      name, title, desc, payload = Normalize.normalize(trace, name, payload)
+
+      if name != :skip
+        logger.debug("[SKYLIGHT] START: #{name} (#{title}, \"#{desc}\")")
+        logger.debug("[SKYLIGHT] > #{payload.inspect}")
+      else
+        logger.debug("[SKYLIGHT] START: skipped")
       end
 
-      trace.start(name, nil, payload)
+      trace.start(name, title, desc, payload)
     end
 
     def finish(name, id, payload)
       return unless trace = Trace.current
+
+      logger.debug("[SKYLIGHT] END")
       trace.stop
     end
 
     def measure(name, id, payload)
       return unless trace = Trace.current
-      trace.record(name, nil, payload)
+
+      name, title, desc, payload = Normalize.normalize(trace, name, payload)
+
+      if name != :skip
+        logger.debug("[SKYLIGHT] MEASURE: #{name} (#{title}, \"#{desc}\")")
+        logger.debug("[SKYLIGHT] > #{payload.inspect}")
+      else
+        logger.debug("[SKYLIGHT] MEASURE: skipped")
+      end
+
+      trace.record(name, title, desc, payload)
     end
 
   private
@@ -33,5 +52,8 @@ module Skylight
       "#{payload[:controller]}##{payload[:action]}"
     end
 
+    def logger
+      @config.logger
+    end
   end
 end

data/lib/skylight/trace.rb

@@ -1,4 +1,8 @@
 module Skylight
+  # The first span will always have a timestamp of 0, which other
+  # spans will report times relative to.
+  #
+  # build_span will lazily start the timestamp at 0
   class Trace
     KEY = :__skylight_current_trace
 
@@ -10,10 +14,11 @@ module Skylight
     class Span < Struct.new(
       :parent,
       :started_at,
-      :ended_at,
       :category,
+      :title,
       :description,
-      :annotations)
+      :annotations,
+      :ended_at)
 
       def key
         @key ||= [category, description]
@@ -24,26 +29,30 @@ module Skylight
     attr_writer :endpoint
 
     def initialize(endpoint = "Unknown", ident = nil)
-      @ident    = ident
-      @endpoint = endpoint
-      @spans    = []
+      @ident      = ident
+      @endpoint   = endpoint
+      @spans      = []
+      @timestamp  = nil
+      @finish     = nil
+      @stack      = []
 
       # Tracks the ID of the current parent
       @parent = nil
     end
 
     def from
-      return unless span = @spans.first
-      span.started_at
+      return unless @finish
+      @timestamp
     end
 
     def to
-      return unless span = @spans.last
-      span.ended_at
+      @finish
     end
 
-    def record(cat, desc = nil, annot = nil)
-      span = build_span(cat, desc, annot)
+    def record(cat, title, desc, annot)
+      return self if cat == :skip
+
+      span = build_span(cat, title, desc, annot)
       span.ended_at = span.started_at
 
       @spans << span
@@ -51,8 +60,11 @@ module Skylight
       self
     end
 
-    def start(cat, desc = nil, annot = nil)
-      span = build_span(cat, desc, annot)
+    def start(cat, title, desc, annot)
+      @stack.push cat
+      return self if cat == :skip
+
+      span = build_span(cat, title, desc, annot)
 
       @parent = @spans.length
 
@@ -62,6 +74,9 @@ module Skylight
     end
 
     def stop
+      last = @stack.pop
+      return self if last == :skip
+
       # Find last unclosed span
       span = @spans.last
       while span && span.ended_at
@@ -71,7 +86,7 @@ module Skylight
       raise "trace unbalanced" unless span
 
       # Set ended_at
-      span.ended_at = now
+      span.ended_at = now - @timestamp
 
       # Update the parent
       @parent = @spans[@parent].parent
@@ -84,6 +99,7 @@ module Skylight
       raise "trace unbalanced" if @parent
 
       @ident ||= gen_ident
+      @finish = now
 
       # No more changes should be made
       freeze
@@ -101,8 +117,11 @@ module Skylight
       Util::UUID.gen Digest::MD5.digest(@endpoint)[0, 2]
     end
 
-    def build_span(cat, desc, annot)
-      Span.new(@parent, now, nil, cat, desc || "", annot)
+    def build_span(cat, title, desc, annot)
+      n = now
+      @timestamp ||= n
+
+      Span.new(@parent, n - @timestamp, cat, title, desc, annot)
     end
 
   end

data/lib/skylight/version.rb

@@ -1,3 +1,3 @@
 module Skylight
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/skylight/worker.rb

@@ -15,31 +15,20 @@ module Skylight
       attr_reader :from, :counts, :sample
 
       def initialize(config, from, interval)
-        @config = config
-        @interval = interval
-        @from = from
-        @to = from + interval
-        @flush_at = @to + FLUSH_DELAY
-        @sample = Util::UniformSample.new(config.samples_per_interval)
-        @counts = Hash.new { |h,k| h[k] = 0 }
+        @from     = from
+        @flush_at = from + interval + FLUSH_DELAY
+        @sample   = Util::UniformSample.new(config.samples_per_interval)
+        @counts   = Hash.new(0)
       end
 
       def should_flush?(now)
         now >= @flush_at
       end
 
-      def next_batch
-        Batch.new(@config, @to, @interval)
-      end
-
       def empty?
         @sample.empty?
       end
 
-      def wants?(trace)
-        return trace.to >= @from && trace.to < @to
-      end
-
       def push(trace)
         # Count it
         @counts[trace.endpoint] += 1
@@ -92,41 +81,28 @@ module Skylight
 
     # A worker iteration
     def iter(msg, now=Util.clock.now)
-      unless @current_batch
-        interval = Util.clock.convert(@interval)
-        from = (now / interval) * interval
-
-        # If we're still accepting traces from the previous batch
-        # Create the previous interval instead
-        if now < from + FLUSH_DELAY
-          from -= interval
-        end
+      interval = Util.clock.convert(@interval)
 
-        @current_batch = Batch.new(config, from, interval)
-        @next_batch    = @current_batch.next_batch
-      end
+      @current_batch ||= Batch.new(config, start(now, interval), interval)
 
       if msg == :SHUTDOWN
         flush(@current_batch) if @current_batch
-        flush(@next_batch)    if @next_batch
+        @current_batch = nil
         return false
       end
 
-      while @current_batch && @current_batch.should_flush?(now)
+      if @current_batch.should_flush?(now)
         flush(@current_batch)
-        @current_batch = @next_batch
-        @next_batch = @current_batch.next_batch
+        @current_batch = Batch.new(config, start(now, interval), interval)
       end
 
+      return true if msg.nil?
+
       if Trace === msg
         debug "Received trace"
-        if @current_batch.wants?(msg)
-          @current_batch.push(msg)
-        elsif @next_batch.wants?(msg)
-          @next_batch.push(msg)
-        else
-          # Seems bad bro
-        end
+        @current_batch.push(msg)
+      else
+        debug "Received something other than a trace: #{msg.inspect}"
       end
 
       true
@@ -138,6 +114,10 @@ module Skylight
       @instrumenter.config
     end
 
+    def start(now, interval)
+      (now / interval) * interval
+    end
+
     def logger
       config.logger
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Currently in pre-alpha.
 email:
 - engineering@tilde.io
@@ -44,6 +60,15 @@ files:
 - lib/skylight/instrumenter.rb
 - lib/skylight/json_proto.rb
 - lib/skylight/middleware.rb
+- lib/skylight/normalize.rb
+- lib/skylight/normalize/default.rb
+- lib/skylight/normalize/process_action.rb
+- lib/skylight/normalize/render_collection.rb
+- lib/skylight/normalize/render_partial.rb
+- lib/skylight/normalize/render_template.rb
+- lib/skylight/normalize/send_file.rb
+- lib/skylight/normalize/sql.rb
+- lib/skylight/normalize/start_processing.rb
 - lib/skylight/railtie.rb
 - lib/skylight/subscriber.rb
 - lib/skylight/trace.rb
@@ -78,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Skylight is a ruby application monitoring tool.