skylight 0.0.7 → 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: addb4eed3d6a9b0f22eb5163115018211c5da90c
+  data.tar.gz: 513eb7a8391b46447744f602127b2e0e4fe84edc
+SHA512:
+  metadata.gz: cd3900fdbb47bc3adf7a81dda75a69277b72484d056a1f86c66b83b36335d0a2e01568830c0bb412bdcd76c82eb7ceec11fc2a5b8f73c1c129d725ab342e27b4
+  data.tar.gz: e94a2b3bf08c8151b1a23e666402a4530eaa3310087de8f6b43f109f57792c7556e17314711babfeff7cfaca3a3f8d1df41f18b36587bf356c5c12d2533f668a

data/bin/skylight

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "skylight/cli"
+
+Skylight::CLI.start(ARGV)

data/lib/skylight.rb

@@ -19,11 +19,13 @@ module Skylight
   require 'skylight/util/clock'
   require 'skylight/util/ewma'
   require 'skylight/util/gzip'
+  require 'skylight/util/http'
   require 'skylight/util/queue'
   require 'skylight/util/uniform_sample'
   require 'skylight/util/uuid'
 
   # Then require the rest
+  require 'skylight/sanity_checker'
   require 'skylight/compat'
   require 'skylight/config'
   require 'skylight/instrumenter'

data/lib/skylight/cli.rb

@@ -0,0 +1,84 @@
+# Use vendored thor / highline
+$:.unshift File.expand_path('../vendor', __FILE__)
+
+require "skylight"
+require "thor"
+require "highline"
+
+module Skylight
+  class CLI < Thor
+    desc "create", "Create a new app"
+    def create
+      if !SanityChecker.new.smoke_test(File.expand_path("config/skylight.yml"))
+        say "Your app is already on Skylight. http://www.skylight.io", :green
+        return
+      end
+
+      token = load_credentials
+      config = http_config
+
+      response = Util::HTTP.new(config).create_app(token, app_name)["app"]
+
+      config.app_id = response["id"]
+      config.authentication_token = response["token"]
+
+      config.yaml_file = File.expand_path("config/skylight.yml")
+
+      config.save
+
+      say "Congratulations. Your application is on Skylight! http://www.skylight.io", :green
+    end
+
+  private
+    def user_settings
+      File.expand_path("~/.skylight")
+    end
+
+    def http_config
+      @http_config ||= Config.new do |c|
+        c.host = "www.skylight.io"
+        c.port = 443
+        c.ssl = true
+        c.deflate = false
+      end
+    end
+
+    def load_credentials
+      if credentials?
+        return YAML.load_file(user_settings)["token"]
+      end
+
+      token = nil
+
+      loop do
+        h = HighLine.new
+        username = h.ask("Username: ")
+        password = h.ask("Password: ") { |q| q.echo = "*" }
+
+        response = Util::HTTP.new(http_config).auth(username, password)
+        if response["authenticated"] == false
+          say "Sorry. That username and password was invalid. Please try again", :red
+          puts
+        else
+          token = response["token"]
+          break
+        end
+      end
+
+      File.open(user_settings, "w") do |file|
+        file.puts YAML.dump("token" => token)
+      end
+
+      token
+    end
+
+    def credentials?
+      !SanityChecker.new.user_credentials(user_settings)
+    end
+
+    def app_name
+      require "./config/application"
+      Rails.application.class.name.split("::").first.underscore
+    end
+  end
+end

data/lib/skylight/config.rb

@@ -1,17 +1,42 @@
 require 'yaml'
+require 'logger'
 
 module Skylight
   class Config
+    class Normalizer < Struct.new(:view_paths)
+    end
+
+    class << self
+      def load_from_yaml(path, env=ENV)
+        new do |config|
+          data = YAML.load_file(path)
 
-    def self.load_from_yaml(path)
-      new do |config|
-        data = YAML.load_file(path)
-        data.each do |key, value|
-          if config.respond_to?("#{key}=")
-            config.send("#{key}=", value)
+          data.each do |key, value|
+            apply_config(config, key, value)
           end
+
+          config.yaml_file = path
+
+          apply_env(config, env)
+        end
+      end
+
+    private
+      def apply_env(config, env)
+        env.each do |key, value|
+          name = normalize_env(key)
+          apply_config(config, name, value) if name
         end
       end
+
+      def normalize_env(key)
+        match = key.match(/^SKYLIGHT_(\w+)$/)
+        match && match[1].downcase
+      end
+
+      def apply_config(config, key, value)
+        config.send("#{key}=", value) if config.respond_to?("#{key}=")
+      end
     end
 
     def initialize(attrs = {})
@@ -27,6 +52,8 @@ module Skylight
       @logger = Logger.new(STDOUT)
       @logger.level = Logger::INFO
 
+      @normalizer = Normalizer.new
+
       attrs.each do |k, v|
         if respond_to?("#{k}=")
           send("#{k}=", v)
@@ -36,7 +63,9 @@ module Skylight
       yield self if block_given?
     end
 
+    attr_accessor :yaml_file
     attr_accessor :authentication_token
+    attr_accessor :app_id
 
     attr_accessor :ssl
     alias_method :ssl?, :ssl
@@ -48,12 +77,16 @@ module Skylight
 
     attr_accessor :port
 
+    attr_accessor :http
+
     attr_accessor :samples_per_interval
 
     attr_accessor :interval
 
     attr_accessor :max_pending_traces
 
+    attr_reader :normalizer
+
     attr_reader :protocol
     def protocol=(val)
       if val.is_a?(String) || val.is_a?(Symbol)
@@ -78,5 +111,19 @@ module Skylight
       end
     end
 
+    attr_writer :gc_profiler
+
+    def gc_profiler
+      @gc_profiler ||= Struct.new(:enable, :disable, :clear, :total_time).new(nil, nil, nil, 0)
+    end
+
+    def save(filename=yaml_file)
+      File.open(filename, "w") do |file|
+        config = {}
+        config["authentication_token"] = authentication_token if authentication_token
+        config["app_id"] = app_id if app_id
+        file.puts YAML.dump(config)
+      end
+    end
   end
 end

data/lib/skylight/instrumenter.rb

@@ -20,6 +20,7 @@ module Skylight
 
     def initialize(config)
       @config = config
+
       @worker = Worker.new(self)
     end
 
@@ -39,6 +40,8 @@ module Skylight
         return
       end
 
+      config.gc_profiler.enable
+
       self
     end
 
@@ -72,7 +75,7 @@ module Skylight
   private
 
     def create_trace(endpoint)
-      Trace.new(endpoint)
+      Trace.new(config, endpoint)
     # Paranoia
     rescue => e
       error e

data/lib/skylight/json_proto.rb

@@ -82,9 +82,6 @@ module Skylight
         ehash
       end
 
-      require "pp"
-      @config.logger.debug PP.pp(hash, "")
-
       out << hash.to_json
     end
   end

data/lib/skylight/middleware.rb

@@ -8,6 +8,7 @@ module Skylight
     def initialize(app, config, instrumenter_class=Instrumenter)
       @app = app
       @config = config
+      @config.gc_profiler = GC::Profiler
       @instrumenter_class = instrumenter_class
     end
 

data/lib/skylight/normalize.rb

@@ -2,13 +2,13 @@ module Skylight
   module Normalize
     @registry = {}
 
-    def self.normalize(trace, name, payload)
+    def self.normalize(trace, name, payload, config={})
       klass = @registry[name]
 
       if klass
-        klass.new(trace, name, payload).normalize
+        klass.new(trace, name, payload, config).normalize
       else
-        Default.new(trace, name, payload).normalize
+        Default.new(trace, name, payload, config).normalize
       end
     end
 
@@ -22,8 +22,33 @@ module Skylight
       Normalize.register(name, self)
     end
 
-    def initialize(trace, name, payload)
-      @trace, @name, @payload = trace, name, payload
+    def initialize(trace, name, payload, config={})
+      @trace, @name, @payload, @config = trace, name, payload, config
+    end
+  end
+
+  class RenderNormalizer < Normalizer
+  private
+    def normalize_render(category, payload)
+      path = @payload[:identifier]
+
+      title = relative_path(path)
+      path = nil if path == title
+      [ category, title, path, payload ]
+    end
+
+    def relative_path(path)
+      root_path = @config.view_paths.find do |p|
+        path.start_with?(p)
+      end
+
+      if root_path
+        relative = path[root_path.size..-1]
+        relative = relative[1..-1] if relative.start_with?("/")
+        relative
+      else
+        path
+      end
     end
   end
 end

data/lib/skylight/normalize/process_action.rb

@@ -5,7 +5,7 @@ module Skylight
 
       def normalize
         @trace.endpoint = controller_action
-        [ "app.controller.request", controller_action, controller_action, @payload ]
+        [ "app.controller.request", controller_action, nil, @payload ]
       end
 
     private

data/lib/skylight/normalize/render_collection.rb

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

data/lib/skylight/normalize/render_partial.rb

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

data/lib/skylight/normalize/render_template.rb

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

data/lib/skylight/normalize/sql.rb

@@ -4,11 +4,9 @@ module Skylight
       register "sql.active_record"
 
       def normalize
-        if @payload[:name] == "SCHEMA"
+        case @payload[:name]
+        when "SCHEMA", "CACHE"
           return :skip
-        elsif @payload[:name] == "CACHE"
-          name = "db.sql.cache"
-          title = "Cached Load"
         else
           name = "db.sql.query"
           title = @payload[:name]

data/lib/skylight/railtie.rb

@@ -13,9 +13,25 @@ module Skylight
 
     attr_accessor :instrumenter
 
+    initializer "skylight.sanity_check" do |app|
+      checker = SanityChecker.new
+      @problems = checker.smoke_test(config_path(app)) || checker.sanity_check(load_config(app))
+      next unless @problems
+
+      @problems.each do |group, problem_list|
+        problem_list.each do |problem|
+          puts "[SKYLIGHT] PROBLEM: #{group} #{problem}"
+        end
+      end
+    end
+
     initializer "skylight.configure" do |app|
-      Rails.logger.debug "[SKYLIGHT] Installing middleware"
-      app.middleware.insert 0, Middleware, load_config
+      if @problems
+        puts "[SKYLIGHT] Skipping Skylight boot"
+      else
+        Rails.logger.debug "[SKYLIGHT] Installing middleware"
+        app.middleware.insert 0, Middleware, load_config(app)
+      end
     end
 
   private
@@ -24,42 +40,23 @@ module Skylight
       Array(config.skylight.environments).map { |e| e && e.to_s }.compact
     end
 
-    def load_instrumenter
-      if environments.include?(Rails.env.to_s)
-        if c = load_config
-          Rails.logger.debug "[SKYLIGHT] Starting instrumenter"
-          Instrumenter.start!(c)
-        end
-      end
-    # Paranoia
-    rescue
-      nil
+    def config_path(app)
+      path = config.skylight.config_path
+      File.expand_path(path, app.root)
     end
 
-    def load_config
-      unless path = config.skylight.config_path
-        Rails.logger.warn "[SKYLIGHT] Path to config YAML file unset"
-        return
-      end
-
-      path = File.expand_path(path, Rails.root)
-
-      unless File.exist?(path)
-        Rails.logger.warn "[SKYLIGHT] Config does not exist at `#{path}`"
-        return
-      end
-
-      ret = Config.load_from_yaml(path)
+    def load_config(app)
+      @skylight_config ||= begin
+        config = Config.load_from_yaml(config_path(app), ENV).tap do |c|
+          c.logger = Rails.logger
+        end
 
-      unless ret.authentication_token
-        Rails.logger.warn "[SKYLIGHT] Config does not include an authentication token"
-        return
+        config.normalizer.view_paths = app.config.paths["app/views"].existent
+        config.http = Util::HTTP.new(config)
+        config
       end
-
-      ret.logger = Rails.logger
-
-      ret
     rescue => e
+      raise
       Rails.logger.error "[SKYLIGHT] #{e.message} (#{e.class}) - #{e.backtrace.first}"
     end