skylight 0.10.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46377b71401533410551ea729a2fc51c14c8ab19
-  data.tar.gz: 98f06fa6bb8032857b23fce319ad91a397e58d1a
+  metadata.gz: 88325472f4d132fe248d7254a342b230df879416
+  data.tar.gz: 18c75d3a03c14bf7e9b9f6692737fe004b9ad04f
 SHA512:
-  metadata.gz: 5348784baea5422f5f4361ff7ee7bf56424783c485a5549e998acb60611c8504d691558a8813efbf2d10a44cfca46b04ecc0e2e7d4d9fa94ff3af1d9479c2cbd
-  data.tar.gz: 99712c702e5d9bc99baee91408a7fc072f2a4bce9271e9eb0fc94f5648f316e8f736950efa2ad20085c7d43dbb0980274343bbfa17474ddc8dff4d002d064d2d
+  metadata.gz: 8e59cb8d7bf357fae8ec9ceb88d1318455679abb2f6ef60f6a5d112b9dc159085fe52030069a2e5501f5145c74b2807a1b330a1df9facc412324eebdd4521353
+  data.tar.gz: 3ef90cd66399bbeb7ec585c4d3315248020d1ab6b4350c0c50bf7ec0193f76910f1fd0a1e4fe3eb8f68157286d31d50a90c98b849d24b94a81b423c402ccc609

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.10.2 (January 19, 2016)
+
+* [BUGFIX] Fix git repository warning on startup. [Issue #58](https://github.com/skylightio/skylight-ruby/issues/58)
+
+## 0.10.1 (January 4, 2016)
+
+* [FEATURE] Preliminary work for deploy tracking (not yet functional)
+* [BUGFIX] Don't crash if user config (~/.skylight) is empty
+* [BUGFIX] Better handling of unsupported moped versions
+* [IMPROVEMENT] Internal refactor of configuration handling
+* [IMPROVEMENT] Improve automated tests
+* [IMPROVEMENT] Fix tests in Rails 5 (No actual code changes required!)
+
 ## 0.10.0 (December 3, 2015)
 
 * [FEATURE] ActiveModel::Serializers Instrumentation. Always on in latest HEAD, for previous version add 'active_model_serializers' to probes list.

data/lib/skylight/config.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 require 'thread'
 require 'openssl'
 require 'erb'
+require 'skylight/util/deploy'
 require 'skylight/util/hostname'
 require 'skylight/util/logging'
 require 'skylight/util/platform'
@@ -19,14 +20,11 @@ module Skylight
       # == Authentication ==
       'AUTHENTICATION' => :'authentication',
 
-      # == Version ==
-      'VERSION' => :'version',
-
       # == App settings ==
       'ROOT'          => :'root',
-      'APPLICATION'   => :'application',
       'HOSTNAME'      => :'hostname',
       'SESSION_TOKEN' => :'session_token',
+      'DEPLOY_ID'     => :'deploy_id',
 
       # == Logging ==
       'LOG_FILE'       => :'log_file',
@@ -75,38 +73,27 @@ module Skylight
       "SSL_CERT_PATH"                => :'daemon.ssl_cert_path',
       "SSL_CERT_DIR"                 => :'daemon.ssl_cert_dir',
 
+      # == Heroku settings ==
+      #
+      "HEROKU_DYNO_INFO_PATH"        => :'heroku.dyno_info_path',
+
       # == Legacy env vars ==
       #
       'AGENT_LOCKFILE'      => :'agent.lockfile',
-      'AGENT_SOCKFILE_PATH' => :'agent.sockfile_path',
+      'AGENT_SOCKFILE_PATH' => :'agent.sockfile_path'
     }
 
     # Default values for Skylight configuration keys
     DEFAULTS = {
-      :'version'              => VERSION,
       :'auth_url'             => 'https://auth.skylight.io/agent',
       :'sql_mode'             => 'rust',
       :'daemon.lazy_start'    => true,
-
-      # == Legacy ==
-      :'log_file'                => '-'.freeze,
-      :'log_level'               => 'INFO'.freeze,
-      :'alert_log_file'          => '-'.freeze,
-      :'log_sql_parse_errors'    => false,
-      :'hostname'                => Util::Hostname.default_hostname,
-      :'agent.keepalive'         => 60,
-      :'agent.interval'          => 5,
-      :'agent.sample'            => 200,
-      :'agent.max_memory'        => 256, # MB
-      :'report.host'             => 'agent.skylight.io'.freeze,
-      :'report.port'             => 443,
-      :'report.ssl'              => true,
-      :'report.deflate'          => true,
-      :'accounts.host'           => 'www.skylight.io'.freeze,
-      :'accounts.port'           => 443,
-      :'accounts.ssl'            => true,
-      :'accounts.deflate'        => false,
-      :'metrics.report_interval' => 60
+      :'log_file'             => '-'.freeze,
+      :'log_level'            => 'INFO'.freeze,
+      :'alert_log_file'       => '-'.freeze,
+      :'log_sql_parse_errors' => false,
+      :'hostname'             => Util::Hostname.default_hostname,
+      :'heroku.dyno_info_path' => '/etc/heroku/dyno'
     }
 
     if Skylight::Util::Platform::OS != 'darwin'
@@ -126,21 +113,50 @@ module Skylight
     REQUIRED = {
       :'authentication' => "authentication token",
       :'hostname'       => "server hostname",
-      :'report.host'    => "skylight remote host",
-      :'report.port'    => "skylight remote port" }
-
-    ALWAYS_INCLUDE_IN_ENV = [
-      :version,
+      :'auth_url'       => "authentication url" }
+
+    NATIVE_ENV = [
+      :'version',
+      :'authentication',
+      :'root',
+      :'hostname',
+      :'deploy_id',
+      :'session_token',
+      :'proxy_url',
+      :'auth_url',
+      :'auth_http_deflate',
+      :'auth_http_connect_timeout',
+      :'auth_http_read_timeout',
+      :'report_url',
+      :'report_http_deflate',
+      :'report_http_connect_timeout',
+      :'report_http_read_timeout',
       :'daemon.lazy_start',
-      :'daemon.lib_path',
       :'daemon.exec_path',
-      :'daemon.ssl_cert_dir',
-      :'daemon.ssl_cert_path' ]
+      :'daemon.lib_path',
+      :'daemon.pidfile_path',
+      :'daemon.sockdir_path',
+      :'daemon.batch_queue_depth',
+      :'daemon.batch_sample_size',
+      :'daemon.batch_flush_interval',
+      :'daemon.tick_interval',
+      :'daemon.sanity_check_interval',
+      :'daemon.inactivity_timeout',
+      :'daemon.max_connect_tries',
+      :'daemon.connect_try_window',
+      :'daemon.max_prespawn_jitter',
+      :'daemon.wait_timeout',
+      :'daemon.client_check_interval',
+      :'daemon.client_queue_depth',
+      :'daemon.client_write_timeout',
+      :'daemon.ssl_cert_path',
+      :'daemon.ssl_cert_dir'
+    ]
 
     # Maps legacy config keys to new config keys
     LEGACY = {
       :'agent.sockfile_path' => :'daemon.sockdir_path',
-      :'agent.pidfile_path'  => :'agent.lockfile',
+      :'agent.lockfile'  => :'daemon.pidfile_path'
     }
 
     VALIDATORS = {
@@ -359,6 +375,10 @@ module Skylight
 
     alias []= set
 
+    def send_or_get(v)
+      respond_to?(v) ? send(v) : get(v)
+    end
+
     def duration_ms(key, default = nil)
       if (v = self[key]) && v.to_s =~ /^\s*(\d+)(s|sec|ms|micros|nanos)?\s*$/
         v = $1.to_i
@@ -377,20 +397,17 @@ module Skylight
       end
     end
 
-    def to_env
+    def to_native_env
       ret = []
 
-      ENV_TO_KEY.each do |k, v|
-        next if LEGACY[v]
-        c = get(v)
-        # Always need to pass daemon lib_path config even when default
-        if c != DEFAULTS[v] || ALWAYS_INCLUDE_IN_ENV.include?(v)
-          ret << "SKYLIGHT_#{k}" << cast_for_env(c) if c
+      NATIVE_ENV.each do |key|
+        if value = send_or_get(key)
+          env_key = ENV_TO_KEY.key(key) || key.upcase
+          ret << "SKYLIGHT_#{env_key}" << cast_for_env(value)
         end
       end
 
-      ret << "SKYLIGHT_VALIDATE_AUTHENTICATION"
-      ret << "false"
+      ret << "SKYLIGHT_VALIDATE_AUTHENTICATION" << "false"
 
       ret
     end
@@ -413,6 +430,10 @@ authentication: #{self[:authentication]}
     #
     #
 
+    def version
+      VERSION
+    end
+
     # @api private
     def gc
       @gc ||= GC.new(self, get('gc.profiler', VM::GC.new))
@@ -483,6 +504,10 @@ authentication: #{self[:authentication]}
       @alert_logger = logger
     end
 
+    def deploy_id
+      @deploy_id = Util::Deploy.detect_id(self)
+    end
+
   private
 
     def check_nfs(path)

data/lib/skylight/instrumenter.rb

@@ -75,7 +75,7 @@ module Skylight
       config = Config.load(config) unless config.is_a?(Config)
       config.validate!
 
-      inst = native_new(config.to_env)
+      inst = native_new(config.to_native_env)
       inst.send(:initialize, config)
       inst
     end

data/lib/skylight/normalizers/active_record/sql.rb

@@ -30,6 +30,7 @@ module Skylight
             extracted_title, sql = extract_binds(payload, binds)
             [ name, extracted_title || title, sql ]
           rescue => e
+            # FIXME: Rust errors get written to STDERR and don't come through here
             if config[:log_sql_parse_errors]
               config.logger.warn "failed to extract binds in SQL; sql=#{payload[:sql].inspect}; exception=#{e.inspect}"
             end

data/lib/skylight/probes/mongo.rb

@@ -1,6 +1,8 @@
 module Skylight
   module Probes
     module Mongo
+      CAT = "db.mongo.command".freeze
+
       class Probe
         def install
           ::Mongo::Monitoring::Global.subscribe(::Mongo::Monitoring::COMMAND, Subscriber.new)
@@ -106,7 +108,7 @@ module Skylight
             # format which would make it hard to merge.
 
             opts = {
-              category:    "db.mongo.command".freeze,
+              category:    CAT,
               title:       title,
               description: payload.empty? ? nil : payload.to_json
             }

data/lib/skylight/probes/moped.rb

@@ -4,6 +4,14 @@ module Skylight
       class Probe
 
         def install
+          unless defined?(::Moped::Instrumentable)
+            # Using $stderr here isn't great, but we don't have a logger accessible
+            $stderr.puts "[SKYLIGHT] [#{Skylight::VERSION}] The installed version of Moped doesn't " \
+                          "support instrumentation. The Moped probe will be disabled."
+
+            return
+          end
+
           ::Moped::Instrumentable.module_eval do
             alias instrument_without_sk instrument
 

data/lib/skylight/user_config.rb

@@ -22,7 +22,9 @@ module Skylight
     end
 
     def reload
-      config = File.exist?(file_path) ? YAML.load_file(file_path) : {}
+      config = File.exist?(file_path) ? YAML.load_file(file_path) : false
+      return unless config
+
       self.disable_dev_warning = !!config['disable_dev_warning']
     end
 

data/lib/skylight/util.rb

@@ -4,6 +4,7 @@ module Skylight
     # Used from the main lib
     require 'skylight/util/allocation_free'
     require 'skylight/util/clock'
+    require 'skylight/util/deploy'
     require 'skylight/util/hostname'
     require 'skylight/util/logging'
     require 'skylight/util/ssl'

data/lib/skylight/util/deploy.rb

@@ -0,0 +1,73 @@
+require 'json'
+
+module Skylight
+  module Util
+
+    module Deploy
+
+      def self.detect_id(config)
+        DEPLOY_TYPES.each do |type|
+          if deploy_id = type.new(config).id
+            return deploy_id
+          end
+        end
+        nil
+      end
+
+      class EmptyDeploy
+
+        attr_reader :config
+
+        def initialize(config)
+          @config = config
+        end
+
+        def id
+          nil
+        end
+
+      end
+
+      class DefaultDeploy < EmptyDeploy
+
+        def id
+          config.get(:deploy_id)
+        end
+
+      end
+
+      class HerokuDeploy < EmptyDeploy
+
+        def id
+          if info = get_info
+            info['release']['commit']
+          end
+        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))
+          end
+
+      end
+
+      class GitDeploy < EmptyDeploy
+
+        def id
+          Dir.chdir(config.root) do
+            rev = `git rev-parse HEAD 2>&1`
+            rev.strip if $?.success?
+          end
+        end
+
+      end
+
+      DEPLOY_TYPES = [DefaultDeploy, HerokuDeploy, GitDeploy]
+
+    end
+
+  end
+end

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '0.10.0'
+  VERSION = '0.10.2'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.2
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,6 +104,7 @@ files:
 - lib/skylight/util.rb
 - lib/skylight/util/allocation_free.rb
 - lib/skylight/util/clock.rb
+- lib/skylight/util/deploy.rb
 - lib/skylight/util/gzip.rb
 - lib/skylight/util/hostname.rb
 - lib/skylight/util/http.rb