skylight 0.3.18 → 0.3.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3075ceb0a4b8ed3fe217362f3600422de59ab1f
-  data.tar.gz: 44909ca961dc7dad62831f66bc69a845a77bd7fb
+  metadata.gz: 067f6d51c1853d7a05e181e42c0291c5b7d642e7
+  data.tar.gz: 3b6390f8c2297c208b803fecc2b0c37c57e63d6d
 SHA512:
-  metadata.gz: 0207565d0fbc49a04a4663b622efc9823883aa96315541cc5f365643a2ee588fe91db3af1b3427a1657b40a5fa6a82e48dd4bf9cb15dd0c09890b3c57141b0ab
-  data.tar.gz: 81b0262fcf344f564dec9ee76ae10a9086d1a330a6d77b959c58355c466e381ab9943339088c53eed2f9001cbdd52984ca14e5f25ab007a18475ecdb5ced8d8d
+  metadata.gz: cbc6aaa40ead5b216b451c3a00cd7c76c591307f40b3e72a7387addeb886c531ee34636539f4f0483966b0ff2733f532f2c3fb785fe256b2a8bfa7cb025db613
+  data.tar.gz: 9290e766596e3d9bf1858070b4a4f413b15f9a381e90dac68587ec4bdb2c8727b6c49c4bf99e45204d3fac74f79d5e9f7141b0cbfdf544a67c3a0689baf1b1e1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.3.19 (July 30, 2014)
+
+* [IMPROVEMENT] HEAD requests are no longer instrumented and will not count towards usage totals.
+* [IMPROVEMENT] Added LICENSE and CLA
+* [IMPROVEMENT] Improve how warnings are logged to reduce overall noise and interfere less with cron jobs
+* [BUGFIX] Fixed a case where failed app creation raised an exception instead of printing error messages
+
 ## 0.3.18 (July 17, 2014)
 
 * [FEATURE] Redis probe (Not enabled by default. See http://docs.skylight.io/agent/#railtie)

data/CLA.md

@@ -0,0 +1,9 @@
+FOR GOOD AND VALUABLE CONSIDERATION, receipt of which is hereby acknowledged
+[name of assignor] ("Assignor"), located at [address of assignor], hereby
+irrevocably transfers and assigns to Tilde, Inc., located at 517 SW 4th Ave,
+Ste 2, Portland, OR 97204, its successors and assigns, in perpetuity, all
+right (whether now known or hereinafter invented), title, and interest,
+throughout the world, including any copyrights and renewals or extensions
+thereto, in the contributions to Skylight made by Assignor.
+
+IN WITNESS THEREOF, Assignor has duly executed this Agreement.

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+Before contributing, please [sign the CLA](https://docs.google.com/spreadsheet/viewform?usp=drive_web&formkey=dHJVY1M5bzNzY0pwN2dRZjMxV0dXSkE6MA#gid=0).

data/LICENSE.md

@@ -0,0 +1,79 @@
+All other components of this product, except where otherwise noted, are
+Copyright (c) 2013-2014 Tilde, Inc.
+All rights reserved.
+
+Certain inventions disclosed in this file may be claimed within patents
+owned or patent applications filed by Tilde, Inc. or third parties.
+
+Subject to the terms of this notice, Tilde grants you a nonexclusive,
+nontransferable license, without the right to sublicense, to (a) install and
+execute one copy of these files on any number of workstations owned or
+controlled by you and (b) distribute verbatim copies of these files to third
+parties. As a condition to the foregoing grant, you must provide this notice
+along with each copy you distribute and you must not remove, alter, or
+obscure this notice. All other use, reproduction, modification,
+distribution, or other exploitation of these files is strictly prohibited,
+except as may be set forth in a separate written license agreement between
+you and Tilde. The terms of any such license agreement will control over
+this notice. The license stated above will be automatically terminated and
+revoked if you exceed its scope or violate any of the terms of this notice.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of Tilde, except as required for reasonable
+and customary use in describing the origin of this file and reproducing the
+content of this notice. You may not mark or brand this file with any trade
+name, trademarks, service marks, or product names other than the original
+brand (if any) provided by Tilde.
+
+Unless otherwise expressly agreed by Tilde in a separate written
+license agreement, these files are provided AS IS, WITHOUT WARRANTY OF
+ANY KIND, including without any implied warranties of MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT.  As a
+condition to your use of these files, you are solely responsible for
+such use. Tilde will have no liability to you for direct,
+indirect, consequential, incidental, special, or punitive damages or
+for lost profits or data.
+
+
+
+Other Licenses
+==============
+
+ActiveSupport
+-------------
+
+Copyright (c) 2005-2014 David Heinemeier Hansson
+
+Released under the MIT License.
+
+Original source at https://github.com/rails/rails/tree/master/activesupport.
+
+
+HighLine
+--------
+
+Copyright (c) 2014 James Edward Gray II, Gregory Brown, et al.
+
+Distributed under the user's choice of the GPL Version 2 or the Ruby software license.
+
+Original source at https://github.com/JEG2/highline.
+
+
+Thor
+----
+
+Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
+
+Released under the MIT License.
+
+Original source at https://github.com/erikhuda/thor.
+
+
+ThreadSafe
+----------
+
+Copyright (c) 2014 Charles Oliver Nutter, thedarkone, et al.
+
+Distributed under Apache License, Version 2.0, January 2004
+
+Original source at https://github.com/ruby-concurrency/thread_safe.

data/lib/skylight.rb

@@ -40,32 +40,36 @@ module Skylight
   end
 
   # @api private
-  def self.check_install_errors
+  def self.check_install_errors(config)
     # Note: An unsupported arch doesn't count as an error.
     install_log = File.expand_path("../../ext/install.log", __FILE__)
 
     if File.exist?(install_log) && File.read(install_log) =~ /ERROR/
-      puts "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension failed to install. " \
-              "Please check #{install_log} and notify support@skylight.io." \
-              "The missing extension will not affect the functioning of your application."
+      config.alert_logger.error \
+          "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension failed to install. " \
+          "Please check #{install_log} and notify support@skylight.io." \
+          "The missing extension will not affect the functioning of your application."
     end
   end
 
   # @api private
-  def self.warn_skylight_native_missing
+  def self.warn_skylight_native_missing(config)
     # TODO: Dumping the error messages this way is pretty hacky
     is_rails = defined?(Rails)
     env_name = is_rails ? Rails.env : "development"
 
     if env_name == "development" || env_name == "test"
-      puts "[SKYLIGHT] [#{Skylight::VERSION}] Running Skylight in #{env_name} mode. " \
-              "No data will be reported until you deploy your app."
+      config.alert_logger.warn \
+          "[SKYLIGHT] [#{Skylight::VERSION}] Running Skylight in #{env_name} mode. " \
+          "No data will be reported until you deploy your app.\n" \
+          "(To disable this message, set `alert_logger_file` in your config.)"
     else
-      puts "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension for your platform wasn't found. " \
-              "The monitoring portion of Skylight is only supported on production servers running 32- or " \
-              "64-bit Linux. The missing extension will not affect the functioning of your application " \
-              "and you can continue local development without data being reported. If you are on a " \
-              "supported platform, please contact support at support@skylight.io."
+      config.alert_logger.error \
+          "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension for your platform wasn't found. " \
+          "The monitoring portion of Skylight is only supported on production servers running 32- or " \
+          "64-bit Linux. The missing extension will not affect the functioning of your application " \
+          "and you can continue local development without data being reported. If you are on a " \
+          "supported platform, please contact support at support@skylight.io."
     end
   end
 
@@ -213,7 +217,3 @@ module Skylight
 
   require 'skylight/probes'
 end
-
-# Warn as soon as possible if there was an error installing Skylight.
-# We do this here since we can't report these issues via Gem install without stopping install entirely.
-Skylight.check_install_errors

data/lib/skylight/api.rb

@@ -12,9 +12,19 @@ module Skylight
       end
 
       def errors
-        return unless res.body.is_a?(Hash)
+        return unless res.respond_to?(:body) && res.body.is_a?(Hash)
         res.body['errors']
       end
+
+      def to_s
+        if errors
+          errors.inspect
+        elsif res
+          "#{res.class.to_s}: #{res.to_s}"
+        else
+          super
+        end
+      end
     end
 
     def initialize(config, service = :accounts)

data/lib/skylight/cli.rb

@@ -44,7 +44,7 @@ repository and deploy from there. You can learn more about the process at:
       OUT
     rescue Api::CreateFailed => e
       say "Could not create the application", :red
-      say e.errors.inspect, :orange if e.errors
+      say e.to_s, :yellow
     rescue Interrupt
     end
 

data/lib/skylight/config.rb

@@ -4,6 +4,20 @@ require 'logger'
 require 'thread'
 require 'socket'
 
+class AlertLoggerIO
+  def initialize(config)
+    @config = config
+  end
+
+  def write(*args)
+    STDERR.write *args
+    @config.logger.<<(*args)
+  end
+
+  def close
+  end
+end
+
 module Skylight
   class Config
     # @api private
@@ -23,6 +37,7 @@ module Skylight
       'ROOT'                    => :'root',
       'LOG_FILE'                => :'log_file',
       'LOG_LEVEL'               => :'log_level',
+      'ALERT_LOG_FILE'          => :'alert_log_file',
       'APPLICATION'             => :'application',
       'AUTHENTICATION'          => :'authentication',
       'HOSTNAME'                => :'hostname',
@@ -60,6 +75,7 @@ module Skylight
     DEFAULTS = {
       :'log_file'                => '-'.freeze,
       :'log_level'               => 'INFO'.freeze,
+      :'alert_log_file'          => '-'.freeze,
       :'hostname'                => default_hostname,
       :'agent.keepalive'         => 60,
       :'agent.interval'          => 5,
@@ -353,6 +369,34 @@ authentication: #{self[:authentication]}
       @logger = logger
     end
 
+    def alert_logger
+      @alert_logger ||=
+        begin
+          MUTEX.synchronize do
+            unless l = @alert_logger
+              out = get(:'alert_log_file')
+
+              if out == '-'
+                out = AlertLoggerIO.new(self)
+              elsif !(IO === out)
+                out = File.expand_path(out, root)
+                FileUtils.mkdir_p(File.dirname(out))
+              end
+
+              l = Logger.new(out)
+              l.level = Logger::DEBUG
+            end
+
+            l
+          end
+        end
+    end
+
+    def alert_logger=(logger)
+      @alert_logger = logger
+    end
+
+
   private
 
     def cast_for_env(v)

data/lib/skylight/instrumenter.rb

@@ -75,8 +75,12 @@ module Skylight
     def start!
       return unless config
 
+      # Warn if there was an error installing Skylight.
+      # We do this here since we can't report these issues via Gem install without stopping install entirely.
+      Skylight.check_install_errors(config)
+
       unless Skylight.native?
-        Skylight.warn_skylight_native_missing
+        Skylight.warn_skylight_native_missing(config)
         return
       end
 
@@ -202,7 +206,6 @@ module Skylight
     end
 
     def limited_description(description)
-      endpoint = nil
       endpoint = @trace_info.current.endpoint
 
       DESC_LOCK.synchronize do

data/lib/skylight/middleware.rb

@@ -51,19 +51,24 @@ module Skylight
     end
 
     def call(env)
-      begin
-        t { "middleware beginning trace" }
-        trace = Skylight.trace "Rack", 'app.rack.request'
-        resp = @app.call(env)
-        resp[2] = BodyProxy.new(resp[2]) { trace.submit } if trace
-        resp
-      rescue Exception
-        t { "middleware exception: #{trace}"}
-        trace.submit if trace
-        raise
-      ensure
-        t { "middleware release: #{trace}"}
-        trace.release if trace
+      if env["REQUEST_METHOD"] == "HEAD"
+        t { "middleware skipping HEAD" }
+        @app.call(env)
+      else
+        begin
+          t { "middleware beginning trace" }
+          trace = Skylight.trace "Rack", 'app.rack.request'
+          resp = @app.call(env)
+          resp[2] = BodyProxy.new(resp[2]) { trace.submit } if trace
+          resp
+        rescue Exception
+          t { "middleware exception: #{trace}"}
+          trace.submit if trace
+          raise
+        ensure
+          t { "middleware release: #{trace}"}
+          trace.release if trace
+        end
       end
     end
   end

data/lib/skylight/probes/excon.rb

@@ -12,8 +12,9 @@ module Skylight
             # TODO: Handle possibility of idx being nil
             ::Excon.defaults[:middlewares].insert(idx, Skylight::Probes::Excon::Middleware)
           else
-            puts "[SKYLIGHT] [#{Skylight::VERSION}] The installed version of Excon doesn't " \
-                    "support Middlewares. The Excon probe will be disabled."
+            # Using $stderr here isn't great, but we don't have a logger accessible
+            $stderr.puts "[SKYLIGHT] [#{Skylight::VERSION}] The installed version of Excon doesn't " \
+                          "support Middlewares. The Excon probe will be disabled."
           end
         end
       end

data/lib/skylight/railtie.rb

@@ -6,7 +6,7 @@ module Skylight
   class Railtie < Rails::Railtie
     config.skylight = ActiveSupport::OrderedOptions.new
 
-    # The environments in which skylight should be inabled
+    # The environments in which skylight should be enabled
     config.skylight.environments = ['production']
 
     # The path to the configuration file
@@ -21,22 +21,34 @@ module Skylight
       # Load probes even when agent is inactive to catch probe related bugs sooner
       load_probes
 
+      config = load_skylight_config(app)
+
       if activate?
-        if config = load_skylight_config(app)
-          if Instrumenter.start!(config)
+        if config
+          if config && Instrumenter.start!(config)
             app.middleware.insert 0, Middleware, config: config
-            puts "[SKYLIGHT] [#{Skylight::VERSION}] Skylight agent enabled"
+            Rails.logger.info "[SKYLIGHT] [#{Skylight::VERSION}] Skylight agent enabled"
           end
+        else
+          Rails.logger.warn "[SKYLIGHT] [#{Skylight::VERSION}] No configuration found; disabling Skylight agent"
         end
       elsif Rails.env.development?
-        puts "[SKYLIGHT] [#{Skylight::VERSION}] Running Skylight in development mode. No data will be reported until you deploy your app."
+        log_warning config, "[SKYLIGHT] [#{Skylight::VERSION}] Running Skylight in development mode. No data will be reported until you deploy your app."
       elsif !Rails.env.test?
-        puts "[SKYLIGHT] [#{Skylight::VERSION}] You are running in the #{Rails.env} environment but haven't added it to config.skylight.environments, so no data will be sent to skylight.io."
+        log_warning config, "[SKYLIGHT] [#{Skylight::VERSION}] You are running in the #{Rails.env} environment but haven't added it to config.skylight.environments, so no data will be sent to skylight.io."
       end
     end
 
   private
 
+    def log_warning(config, msg)
+      if config
+        config.alert_logger.warn(msg)
+      else
+        Rails.logger.warn(msg)
+      end
+    end
+
     def existent_paths(paths)
       paths.respond_to?(:existent) ? paths.existent : paths.select { |f| File.exists?(f) }
     end
@@ -46,7 +58,7 @@ module Skylight
       path = nil unless File.exist?(path)
 
       unless tmp = app.config.paths['tmp'].first
-        puts "[SKYLIGHT] [#{Skylight::VERSION}] tmp directory missing from rails configuration"
+        Rails.logger.error "[SKYLIGHT] [#{Skylight::VERSION}] tmp directory missing from rails configuration"
         return nil
       end
 
@@ -61,7 +73,7 @@ module Skylight
       config
 
     rescue ConfigError => e
-      puts "[SKYLIGHT] [#{Skylight::VERSION}] #{e.message}; disabling Skylight agent"
+      Rails.logger.error "[SKYLIGHT] [#{Skylight::VERSION}] #{e.message}; disabling Skylight agent"
       nil
     end
 

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '0.3.18'
+  VERSION = '0.3.19'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 0.3.18
+  version: 0.3.19
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,6 +34,9 @@ extensions:
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CLA.md
+- CONTRIBUTING.md
+- LICENSE.md
 - README.md
 - bin/skylight
 - ext/extconf.rb