skylight 0.10.6 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 773ffa2d7890941c87af2e1ba08c0a0f4009d1c0
-  data.tar.gz: 6f9799920986f0b5f90153cf7bf32036490828a7
+  metadata.gz: 65cea5cc60bb1c3e0a8025ca0486b586434cd54b
+  data.tar.gz: 7c98c5e24d2922cd684462ae86d5c125e1432a80
 SHA512:
-  metadata.gz: 120e99f711d7b608daa826f6514d96b0b4d3c184d9fa94b89c3b607f94646604e813d6d1233f3c43660fd400968a0b5610b2cf510a6baca102e52ddb55575ad6
-  data.tar.gz: ea0f555fed4c920cc4df9eb898b3710102e7a9541ea629bc3b4c3443dcf06a8afd1f20d5fdeab3a534e059d76fa4a902f39760a9889509b31a861cbbf5fd739a
+  metadata.gz: 6767a9393d6fe515fea63ee0b4c0b92b424606325b3842fbd5949dd1e22b4cee787e8bcacd7ea67e8009872912c6202d63a6a700b8ad74d39b1b3a81d4307eae
+  data.tar.gz: 1a1240244582028e5e1bbb40e7a551e053f8158586c4fce0032b4b0a44a42b58fdbf98981d0bf2b744a2a20f97d7788b3af6d3f1e98ed0793f0f757a603ba191

data/CHANGELOG.md

@@ -1,34 +1,11 @@
-## 0.10.6 (August 10, 2016)
+## 1.0.0.beta2 (January 14, 2016)
 
-* [BUGFIX] Turn off -Werror and -pedantic for builds. [Issue #64](https://github.com/skylightio/skylight-ruby/issues/64)
+* [BUGFIX] Fix version format so Rust agent can load config.
 
-## 0.10.5 (June 22, 2016)
+## 1.0.0.beta1 (January 14, 2016) [YANKED]
 
-* [BUGFIX] Fix issue with Grape multi-method naming
-* [BUGFIX] Add http to proxy_url for native fetching
-* [BUGFIX] Fix setting `proxy_url` in config YML
-* [IMPROVEMENT] Log errors during authentication validation
-
-## 0.10.4 (June 3, 2016)
-
-* [BUGFIX] Sinatra instrumenation now works for latest master
-* [BUGFIX] Sequel support for 4.35.0
-* [BUGFIX] Handle latest ActiveModel::Serializers version
-* [BUGFIX] More precise check for existence of Rails
-* [BREAKING] Drop official support for Sinatra 1.2 (it likely never worked correctly)
-* [IMPROVEMENT] On Heroku, logs are now written to STDOUT
-* [IMPROVEMENT] Allow Skylight to raise on logged errors, useful for testing and debugging
-* [IMPROVEMENT] Finish Rack::Responses in Middleware
-* [IMRPOVEMENT] Better message when config/skylight.yml already exists
-* [IMPROVEMENT] Update Rust Agent with SQL improvements, including handling for arrays and WITH
-
-## 0.10.3 (February 2, 2016)
-
-* [BUGFIX] Don't validate configuration on disabled environments.
-
-## 0.10.2 (January 19, 2016)
-
-* [BUGFIX] Fix git repository warning on startup. [Issue #58](https://github.com/skylightio/skylight-ruby/issues/58)
+* [FEATURE] Deploy tracking support. Contact support@skylight.io to have this enabled for your account.
+* [BUGFIX] Correct documentation link in `skylight setup`.
 
 ## 0.10.1 (January 4, 2016)
 
@@ -46,7 +23,7 @@
 
 ## 0.9.4 (November 23, 2015)
 
-* [FEATURE] Added instrumentation for official Mongo Ruby Driver (utilized by Mongoid 5+). Add 'mongo' to probes list to enable.
+* [FEATURE] Added instrumentation for official Mongo Ruby Driver (utilized by Mongoid 5+). Add 'mongo' to probes list to enable. 
 * [BUGFIX] SQL lexer now handles indentifiers beginning with underscores.
 * [BUGFIX] Excon instrumentation now works correctly.
 * [BUGFIX] Graceful handling of native agent failures on old OS X versions.

data/LICENSE.md

@@ -1,5 +1,5 @@
 All other components of this product, except where otherwise noted, are
-Copyright (c) 2013-2016 Tilde, Inc.
+Copyright (c) 2013-2014 Tilde, Inc.
 All rights reserved.
 
 Certain inventions disclosed in this file may be claimed within patents

data/ext/extconf.rb

@@ -24,8 +24,6 @@ SKYLIGHT_SOURCE_URL = ENV['SKYLIGHT_SOURCE_URL']
 SKYLIGHT_VERSION = ENV['SKYLIGHT_VERSION']
 SKYLIGHT_CHECKSUM = ENV['SKYLIGHT_CHECKSUM']
 
-SKYLIGHT_EXT_STRICT = ENV.key?("SKYLIGHT_EXT_STRICT") && ENV['SKYLIGHT_EXT_STRICT'] =~ /^true$/i
-
 # Setup logger
 LOG = Logger.new(MultiIO.new(STDOUT, File.open(SKYLIGHT_INSTALL_LOG, 'a')))
 
@@ -187,16 +185,9 @@ unless have_func('rb_thread_call_without_gvl', 'ruby/thread.h')
   have_func('rb_thread_blocking_region') or abort "Ruby is unexpectedly missing rb_thread_blocking_region. This should not happen."
 end
 
-# Previous comment stated:
-#   -Werror is needed for the fast thread local storage
-#
-# Despite this comment, everything appears to build fine without the flag on. Since this
-#   flag can cause issues for some customers we're turning it off by default. However,
-#   in development and CI, we still have the option of turning it back on to help catch
-#   potential issues.
-if SKYLIGHT_EXT_STRICT
-  $CFLAGS << " -Werror"
-end
+# Some extra checks
+# -Werror is needed for the fast thread local storage
+$CFLAGS << " -Werror"
 
 checking_for 'fast thread local storage' do
   if try_compile("__thread int foo;")
@@ -205,13 +196,17 @@ checking_for 'fast thread local storage' do
   end
 end
 
-# Flag -std=c99 required for older build systems
-$CFLAGS << " -std=c99 -Wall -fno-strict-aliasing"
+#     spec = nil
+#     checking_for('thread_specific', '%s') do
+#       spec = %w[__declspec(thread) __thread].find {|th|
+#         try_compile("#{th} int foo;", "", :werror => true)
+#       }
+#       spec or 'no'
+#     end
+#     $defs << "-DRB_THREAD_SPECIFIC=#{spec}" if spec
 
-# Allow stricter checks to be turned on for development or debugging
-if SKYLIGHT_EXT_STRICT
-  $CFLAGS << " -pedantic"
-end
+# Flag -std=c99 required for older build systems
+$CFLAGS << " -std=c99 -pedantic -Wall -fno-strict-aliasing"
 
 # TODO: Compute the relative path to the location
 create_makefile 'skylight_native', File.expand_path('..', __FILE__) # or fail "could not create makefile"

data/ext/libskylight.yml

@@ -1,6 +1,6 @@
 ---
-version: "1.0.0-4a74d28"
+version: "0.7.0-b2a5f4b"
 checksums:
-  x86-linux:     "66e1b9fd8c9223febf8e7febb56a2ad71714ab61193d153e2bf0f462409cb4f7"
-  x86_64-linux:  "40d7e0822610244d916df5488a83af5bdc7b2aa8b2410abc672a42cfab629f3f"
-  x86_64-darwin: "1484612b150317f1debdcaeab9bea806749d8be9ac132b8cd1b92781d1972b46"
+  x86-linux:     "4ea1f0382dbbba12454d5121a4b400278b2b515b79b676e7d4a2655cdc088bfe"
+  x86_64-linux:  "42a958e6fe7f5d9b459e10ffc62c336c44f00e46c253b7f466a72f2902e8e130"
+  x86_64-darwin: "7958533c605d98f43fbe54cdd7f7a6e39d6c8fee30acd29494465213afd123ef"

data/lib/skylight/api.rb

@@ -3,8 +3,6 @@ require 'uri'
 module Skylight
   # @api private
   class Api
-    include Util::Logging
-
     attr_reader :config, :http
 
     class CreateFailed < StandardError
@@ -55,11 +53,9 @@ module Skylight
       when 400...500
         :invalid
       else
-        warn res.exception.message if res.exception
         :unknown
       end
-    rescue => e
-      warn e.message
+    rescue
       :unknown
     end
 

data/lib/skylight/cli.rb

@@ -13,12 +13,7 @@ module Skylight
     desc "setup TOKEN", "Sets up a new app using the provided token"
     def setup(token=nil)
       if File.exist?(config_path)
-        say <<-OUT, :green
-A config/skylight.yml already exists for your application.
-
-Visit your app at https://www.skylight.io/app or remove config/skylight.yml
-to set it up as a new app in Skylight.
-        OUT
+        say "Your app is already on Skylight. http://www.skylight.io", :green
         return
       end
 

data/lib/skylight/config.rb

@@ -1,4 +1,3 @@
-require 'uri'
 require 'yaml'
 require 'fileutils'
 require 'thread'
@@ -9,7 +8,6 @@ require 'skylight/util/hostname'
 require 'skylight/util/logging'
 require 'skylight/util/platform'
 require 'skylight/util/ssl'
-require 'skylight/util/proxy'
 
 module Skylight
   class Config
@@ -25,7 +23,11 @@ module Skylight
       'ROOT'          => :'root',
       'HOSTNAME'      => :'hostname',
       'SESSION_TOKEN' => :'session_token',
-      'DEPLOY_ID'     => :'deploy_id',
+
+      # == Deploy settings ==
+      'DEPLOY_ID'          => :'deploy.id',
+      'DEPLOY_GIT_SHA'     => :'deploy.git_sha',
+      'DEPLOY_DESCRIPTION' => :'deploy.description',
 
       # == Logging ==
       'LOG_FILE'       => :'log_file',
@@ -118,7 +120,6 @@ module Skylight
 
     NATIVE_ENV = [
       :'version',
-      :'authentication',
       :'root',
       :'hostname',
       :'deploy_id',
@@ -242,10 +243,7 @@ module Skylight
 
       return ret unless env
 
-      # Only set if it exists, we don't want to set to a nil value
-      if proxy_url = Util::Proxy.detect_url(env)
-        ret[:proxy_url] = proxy_url
-      end
+      ret[:proxy_url] = detect_proxy_url(env)
 
       env.each do |k, val|
         # Support deprecated SK_ key prefix
@@ -267,6 +265,13 @@ module Skylight
       ret
     end
 
+    def self.detect_proxy_url(env)
+      if u = env['HTTP_PROXY'] || env['http_proxy']
+        u = "http://#{u}" unless u =~ %r[://]
+        u
+      end
+    end
+
     # @api private
     def skip_validation?
       !!get(:skip_validation)
@@ -397,6 +402,8 @@ module Skylight
     def to_native_env
       ret = []
 
+      ret << "SKYLIGHT_AUTHENTICATION" << authentication_with_deploy
+
       NATIVE_ENV.each do |key|
         if value = send_or_get(key)
           env_key = ENV_TO_KEY.key(key) || key.upcase
@@ -463,6 +470,19 @@ authentication: #{self[:authentication]}
       self[:root] || Dir.pwd
     end
 
+    def authentication_with_deploy
+      token = get(:authentication)
+
+      if token && deploy
+        deploy_str = deploy.to_query_string
+        # A pipe should be a safe delimiter since it's not in the standard token
+        # and is encoded by URI
+        token += "|#{deploy.to_query_string}"
+      end
+
+      token
+    end
+
     def logger
       @logger ||=
         MUTEX.synchronize do
@@ -501,12 +521,8 @@ authentication: #{self[:authentication]}
       @alert_logger = logger
     end
 
-    def on_heroku?
-      File.exist?(get(:'heroku.dyno_info_path'))
-    end
-
-    def deploy_id
-      @deploy_id = Util::Deploy.detect_id(self)
+    def deploy
+      @deploy ||= Util::Deploy.build(self)
     end
 
   private

data/lib/skylight/core.rb

@@ -7,9 +7,7 @@ module Skylight
   # Load the native agent
   require 'skylight/native'
 
-  # Specifically check for Railtie since we've had at least one case of a
-  #   customer having Rails defined without having all of Rails loaded.
-  if defined?(Rails::Railtie)
+  if defined?(Rails)
     require 'skylight/railtie'
   end
 

data/lib/skylight/middleware.rb

@@ -59,13 +59,6 @@ module Skylight
           t { "middleware beginning trace" }
           trace = Skylight.trace "Rack", 'app.rack.request'
           resp = @app.call(env)
-
-          # Responses should be finished but in some situations they aren't
-          #   e.g. https://github.com/ruby-grape/grape/issues/1041
-          if resp.respond_to?(:finish)
-            resp = resp.finish
-          end
-
           resp[2] = BodyProxy.new(resp[2]) { trace.submit } if trace
           resp
         rescue Exception

data/lib/skylight/normalizers/active_model_serializers/render.rb

@@ -12,9 +12,7 @@ module Skylight
           title = serializer_class.name.sub(/^ActiveModel::(Serializer::)?/, '')
 
           if adapter_instance = payload[:adapter]
-            adapter_name = adapter_instance.class.name
-                              .sub(/^ActiveModel::Serializer::Adapter::/, '')
-                              .sub(/^ActiveModelSerializers::Adapter::/, '')
+            adapter_name = adapter_instance.class.name.sub(/^ActiveModel::Serializer::Adapter::/, '')
             desc = "Adapter: #{adapter_name}"
           end
 

data/lib/skylight/normalizers/grape/endpoint.rb

@@ -12,7 +12,7 @@ module Skylight
 
           def get_method(endpoint)
             method = endpoint.options[:method].first
-            method = "#{method}..." if endpoint.options[:method].length > 1
+            method << "..." if endpoint.options[:method].length > 1
             method
           end
 

data/lib/skylight/probes/sequel.rb

@@ -5,14 +5,11 @@ module Skylight
       class Probe
         def install
           require 'sequel/database/logging'
+          ::Sequel::Database.class_eval do
+            alias log_yield_without_sk log_yield
 
-          method_name = ::Sequel::Database.method_defined?(:log_connection_yield) ? 'log_connection_yield' : 'log_yield'
-
-          ::Sequel::Database.class_eval <<-end_eval
-            alias #{method_name}_without_sk #{method_name}
-
-            def #{method_name}(sql, *args, &block)
-              #{method_name}_without_sk(sql, *args) do
+            def log_yield(sql, args=nil, &block)
+              log_yield_without_sk(sql, *args) do
                 ::ActiveSupport::Notifications.instrument(
                   "sql.sequel",
                   sql: sql,
@@ -23,7 +20,7 @@ module Skylight
                 end
               end
             end
-          end_eval
+          end
         end
       end
     end

data/lib/skylight/probes/sinatra.rb

@@ -8,9 +8,7 @@ module Skylight
             alias compile_without_sk! compile!
 
             def compile!(verb, path, *args, &block)
-              compile_without_sk!(verb, path, *args, &block).tap do |_, _, keys_or_wrapper, wrapper|
-                wrapper ||= keys_or_wrapper
-
+              compile_without_sk!(verb, path, *args, &block).tap do |_, _, _, wrapper|
                 # Deal with the situation where the path is a regex, and the default behavior
                 # of Ruby stringification produces an unreadable mess
                 if path.is_a?(Regexp)

data/lib/skylight/railtie.rb

@@ -25,17 +25,11 @@ module Skylight
 
       if activate?
         if config
-          begin
-            config.validate!
-
-            if Instrumenter.start!(config)
-              app.middleware.insert 0, Middleware, config: config
-              Rails.logger.info "[SKYLIGHT] [#{Skylight::VERSION}] Skylight agent enabled"
-            else
-              Rails.logger.info "[SKYLIGHT] [#{Skylight::VERSION}] Unable to start"
-            end
-          rescue ConfigError => e
-            Rails.logger.error "[SKYLIGHT] [#{Skylight::VERSION}] #{e.message}; disabling Skylight agent"
+          if Instrumenter.start!(config)
+            app.middleware.insert 0, Middleware, config: config
+            Rails.logger.info "[SKYLIGHT] [#{Skylight::VERSION}] Skylight agent enabled"
+          else
+            Rails.logger.info "[SKYLIGHT] [#{Skylight::VERSION}] Unable to start"
           end
         end
       elsif Rails.env.development?
@@ -78,7 +72,12 @@ module Skylight
 
       config[:'daemon.sockdir_path'] ||= tmp
       config[:'normalizers.render.view_paths'] = existent_paths(app.config.paths["app/views"]) + [Rails.root.to_s]
+      config.validate!
       config
+
+    rescue ConfigError => e
+      Rails.logger.error "[SKYLIGHT] [#{Skylight::VERSION}] #{e.message}; disabling Skylight agent"
+      nil
     end
 
     def configure_logging(config, app)
@@ -88,7 +87,7 @@ module Skylight
         # Configure the log file destination
         if log_file = app.config.skylight.log_file
           config['log_file'] = log_file
-        elsif !config.key?('log_file') && !config.on_heroku?
+        elsif !config.key?('log_file')
           config['log_file'] = File.join(Rails.root, 'log/skylight.log')
         end
 

data/lib/skylight/user_config.rb

@@ -14,7 +14,7 @@ module Skylight
     end
 
     def file_path
-      File.expand_path(ENV["SKYLIGHT_USER_CONFIG_PATH"] || "~/.skylight")
+      File.expand_path("~/.skylight")
     end
 
     def disable_dev_warning?

data/lib/skylight/util/deploy.rb

@@ -1,15 +1,15 @@
 require 'json'
+require 'uri'
 
 module Skylight
   module Util
 
     module Deploy
 
-      def self.detect_id(config)
+      def self.build(config)
         DEPLOY_TYPES.each do |type|
-          if deploy_id = type.new(config).id
-            return deploy_id
-          end
+          deploy = type.new(config)
+          return deploy if deploy.id
         end
         nil
       end
@@ -17,52 +17,102 @@ module Skylight
       class EmptyDeploy
 
         attr_reader :config
+        attr_reader :timestamp
 
         def initialize(config)
           @config = config
+          @timestamp = Time.now.to_i
         end
 
         def id
+          git_sha
+        end
+
+        def git_sha
           nil
         end
 
+        def description
+          nil
+        end
+
+        def to_query_string
+          URI.encode_www_form(
+            timestamp:   timestamp,
+            deploy_id:   id.to_s[0..100], # Keep this sane
+            git_sha:     git_sha[0..40], # A valid SHA will never exceed 40
+            description: description[0..255]) # Avoid massive descriptions
+        end
+
       end
 
       class DefaultDeploy < EmptyDeploy
 
         def id
-          config.get(:deploy_id)
+          config.get(:'deploy.id') || git_sha
+        end
+
+        def git_sha
+          config.get(:'deploy.git_sha')
+        end
+
+        def description
+          config.get(:'deploy.description')
         end
 
       end
 
       class HerokuDeploy < EmptyDeploy
 
+        def initialize(*)
+          super
+          @info = get_info
+        end
+
         def id
-          if info = get_info
-            info['release']['commit']
-          end
+          @info ? @info['id'] : nil
+        end
+
+        def git_sha
+          @info ? @info['commit'] : nil
+        end
+
+        def description
+          @info ? @info['description'] : nil
         end
 
         private
 
           def get_info
             info_path = config[:'heroku.dyno_info_path']
-            return nil unless File.exist?(info_path)
-            JSON.parse(File.read(info_path))
+
+            if File.exist?(info_path)
+              if info = JSON.parse(File.read(info_path))
+                info['release']
+              end
+            end
           end
 
       end
 
       class GitDeploy < EmptyDeploy
 
-        def id
-          Dir.chdir(config.root) do
-            rev = `git rev-parse HEAD 2>&1`
-            rev.strip if $?.success?
-          end
+        attr_reader :git_sha, :description
+
+        def initialize(*)
+          super
+          @git_sha, @description = get_info
         end
 
+        private
+
+          def get_info
+            Dir.chdir(config.root) do
+              info = `git log -1 --pretty="%H %s" 2>&1`
+              info.split(" ", 2).map(&:strip) if $?.success?
+            end
+          end
+
       end
 
       DEPLOY_TYPES = [DefaultDeploy, HerokuDeploy, GitDeploy]

data/lib/skylight/util/logging.rb

@@ -57,7 +57,6 @@ module Skylight
       end
 
       def error(msg, *args)
-        raise msg if ENV['SKYLIGHT_RAISE_ON_ERROR']
         log :error, msg, *args
       end
 

data/lib/skylight/util/native_ext_fetcher.rb

@@ -4,7 +4,6 @@ require 'net/http'
 require 'fileutils'
 require 'digest/sha2'
 require 'skylight/util/ssl'
-require 'skylight/util/proxy'
 
 # Used from extconf.rb
 module Skylight
@@ -93,9 +92,9 @@ module Skylight
               when :success
                 log "successfully downloaded native ext; out=#{out}"
                 return extra
-              when :redirect
+              else
                 log "fetching native ext; uri=#{uri}; redirected=#{res}"
-                uri = extra
+                uri = res
 
                 next
               end
@@ -119,7 +118,7 @@ module Skylight
       end
 
       def http_get(host, port, use_ssl, path, out)
-        if http_proxy = Proxy.detect_url(ENV)
+        if http_proxy = ENV['HTTP_PROXY'] || ENV['http_proxy']
           log "connecting with proxy: #{http_proxy}"
           uri = URI.parse(http_proxy)
           p_host, p_port = uri.host, uri.port

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '0.10.6'
+  VERSION = '1.0.0-beta2'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 0.10.6
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,7 +113,6 @@ files:
 - lib/skylight/util/multi_io.rb
 - lib/skylight/util/native_ext_fetcher.rb
 - lib/skylight/util/platform.rb
-- lib/skylight/util/proxy.rb
 - lib/skylight/util/ssl.rb
 - lib/skylight/vendor/active_support/notifications.rb
 - lib/skylight/vendor/active_support/notifications/fanout.rb
@@ -181,13 +180,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Skylight is a smart profiler for Rails apps
 test_files: []
+has_rdoc: 

data/lib/skylight/util/proxy.rb

@@ -1,12 +0,0 @@
-module Skylight
-  module Util
-    module Proxy
-      def self.detect_url(env)
-        if u = env['HTTP_PROXY'] || env['http_proxy']
-          u = "http://#{u}" unless u =~ %r[://]
-          u
-        end
-      end
-    end
-  end
-end