skylight 1.0.0.beta4 → 1.0.0.beta5

data/lib/skylight/cli/helpers.rb

@@ -0,0 +1,32 @@
+module Skylight
+  module CLI
+    module Helpers
+
+      private
+
+      # Duplicated below
+      def rails_rb
+        File.expand_path("config/application.rb")
+      end
+
+      def is_rails?
+        File.exist?(rails_rb)
+      end
+
+      def config
+        # Calling .load checks ENV variables
+        @config ||= Config.load
+      end
+
+      # Sets the output padding while executing a block and resets it.
+      #
+      def indent(count = 1, &block)
+        orig_padding = shell.padding
+        shell.padding += count
+        yield
+        shell.padding = orig_padding
+      end
+
+    end
+  end
+end

data/lib/skylight/config.rb

@@ -3,26 +3,30 @@ require 'fileutils'
 require 'thread'
 require 'openssl'
 require 'erb'
+require 'json'
 require 'skylight/util/deploy'
 require 'skylight/util/hostname'
 require 'skylight/util/logging'
 require 'skylight/util/platform'
 require 'skylight/util/ssl'
+require 'skylight/util/proxy'
 
 module Skylight
   class Config
+    include Util::Logging
+
     # @api private
     MUTEX = Mutex.new
 
     # Map environment variable keys with Skylight configuration keys
     ENV_TO_KEY = {
       # == Authentication ==
-      'AUTHENTICATION' => :'authentication',
+      'AUTHENTICATION' => :authentication,
 
       # == App settings ==
-      'ROOT'          => :'root',
-      'HOSTNAME'      => :'hostname',
-      'SESSION_TOKEN' => :'session_token',
+      'ROOT'          => :root,
+      'HOSTNAME'      => :hostname,
+      'SESSION_TOKEN' => :session_token,
 
       # == Deploy settings ==
       'DEPLOY_ID'          => :'deploy.id',
@@ -30,29 +34,30 @@ module Skylight
       'DEPLOY_DESCRIPTION' => :'deploy.description',
 
       # == Logging ==
-      'LOG_FILE'       => :'log_file',
-      'LOG_LEVEL'      => :'log_level',
-      'ALERT_LOG_FILE' => :'alert_log_file',
-      'LOG_SQL_PARSE_ERRORS' => :'log_sql_parse_errors',
+      'LOG_FILE'       => :log_file,
+      'LOG_LEVEL'      => :log_level,
+      'ALERT_LOG_FILE' => :alert_log_file,
+      'LOG_SQL_PARSE_ERRORS' => :log_sql_parse_errors,
 
       # == Proxy ==
-      'PROXY_URL' => :'proxy_url',
+      'PROXY_URL' => :proxy_url,
 
       # == Instrumenter ==
-      "IGNORED_ENDPOINT" => :'ignored_endpoint',
-      "IGNORED_ENDPOINTS" => :'ignored_endpoints',
-      "SQL_MODE" => :'sql_mode',
-      "SEPARATE_FORMATS" => :'separate_formats',
+      "IGNORED_ENDPOINT" => :ignored_endpoint,
+      "IGNORED_ENDPOINTS" => :ignored_endpoints,
+      "ENABLE_SEGMENTS" => :enable_segments,
 
       # == Skylight Remote ==
-      "AUTH_URL"                     => :'auth_url',
-      "AUTH_HTTP_DEFLATE"            => :'auth_http_deflate',
-      "AUTH_HTTP_CONNECT_TIMEOUT"    => :'auth_http_connect_timeout',
-      "AUTH_HTTP_READ_TIMEOUT"       => :'auth_http_read_timeout',
-      "REPORT_URL"                   => :'report_url',
-      "REPORT_HTTP_DEFLATE"          => :'report_http_deflate',
-      "REPORT_HTTP_CONNECT_TIMEOUT"  => :'report_http_connect_timeout',
-      "REPORT_HTTP_READ_TIMEOUT"     => :'report_http_read_timeout',
+      "AUTH_URL"                     => :auth_url,
+      "APP_CREATE_URL"               => :app_create_url,
+      "VALIDATION_URL"               => :validation_url,
+      "AUTH_HTTP_DEFLATE"            => :auth_http_deflate,
+      "AUTH_HTTP_CONNECT_TIMEOUT"    => :auth_http_connect_timeout,
+      "AUTH_HTTP_READ_TIMEOUT"       => :auth_http_read_timeout,
+      "REPORT_URL"                   => :report_url,
+      "REPORT_HTTP_DEFLATE"          => :report_http_deflate,
+      "REPORT_HTTP_CONNECT_TIMEOUT"  => :report_http_connect_timeout,
+      "REPORT_HTTP_READ_TIMEOUT"     => :report_http_read_timeout,
 
       # == Native agent settings ==
       #
@@ -89,15 +94,16 @@ module Skylight
 
     # Default values for Skylight configuration keys
     DEFAULTS = {
-      :'auth_url'             => 'https://auth.skylight.io/agent',
-      :'sql_mode'             => 'rust',
-      :'daemon.lazy_start'    => true,
-      :'log_file'             => '-'.freeze,
-      :'log_level'            => 'INFO'.freeze,
-      :'alert_log_file'       => '-'.freeze,
-      :'log_sql_parse_errors' => false,
-      :'separate_formats'     => false,
-      :'hostname'             => Util::Hostname.default_hostname,
+      :auth_url             => 'https://auth.skylight.io/agent',
+      :app_create_url       => 'https://www.skylight.io/apps',
+      :validation_url       => 'https://auth.skylight.io/agent/config',
+      :'daemon.lazy_start'  => true,
+      :log_file             => '-'.freeze,
+      :log_level            => 'INFO'.freeze,
+      :alert_log_file       => '-'.freeze,
+      :log_sql_parse_errors => false,
+      :enable_segments      => false,
+      :hostname             => Util::Hostname.default_hostname,
       :'heroku.dyno_info_path' => '/etc/heroku/dyno'
     }
 
@@ -116,25 +122,30 @@ module Skylight
     DEFAULTS.freeze
 
     REQUIRED = {
-      :'authentication' => "authentication token",
-      :'hostname'       => "server hostname",
-      :'auth_url'       => "authentication url" }
+      authentication: "authentication token",
+      hostname:       "server hostname",
+      auth_url:       "authentication url",
+      validation_url: "config validation url" }
+
+    SERVER_VALIDATE = [
+      :enable_segments
+    ]
 
     NATIVE_ENV = [
-      :'version',
-      :'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',
+      :version,
+      :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.exec_path',
       :'daemon.lib_path',
@@ -245,7 +256,10 @@ module Skylight
 
       return ret unless env
 
-      ret[:proxy_url] = detect_proxy_url(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
 
       env.each do |k, val|
         # Support deprecated SK_ key prefix
@@ -267,28 +281,19 @@ 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)
+    def api
+      @api ||= Api.new(self)
     end
 
     # @api private
     def validate!
-      return true if skip_validation?
-
       REQUIRED.each do |k, v|
         unless get(k)
           raise ConfigError, "#{v} required"
         end
       end
 
+      # TODO: Move this out of the validate! method: https://github.com/tildeio/direwolf-agent/issues/273
       # FIXME: Why not set the sockdir_path and pidfile_path explicitly?
       # That way we don't have to keep this in sync with the Rust repo.
       sockdir_path = self[:'daemon.sockdir_path'] || File.expand_path('.')
@@ -299,6 +304,50 @@ module Skylight
       true
     end
 
+    def validate_with_server
+      res = api.validate_config
+
+      unless res.token_valid?
+        warn("Invalid authentication token")
+        return false
+      end
+
+      if res.is_error_response?
+        warn("Unable to reach server for config validation")
+      end
+
+      unless res.config_valid?
+        warn("Invalid configuration") unless res.is_error_response?
+        if errors = res.validation_errors
+          errors.each do |k,v|
+            warn("  #{k} #{v}")
+          end
+        end
+
+        corrected_config = res.corrected_config
+        unless corrected_config
+          # Use defaults if no corrected config is available. This will happen if the request failed.
+          corrected_config = Hash[SERVER_VALIDATE.map{|k| [k, DEFAULTS[k]] }]
+        end
+
+        config_to_update = corrected_config.select{|k,v| get(k) != v }
+        unless config_to_update.empty?
+          info("Updating config values:")
+          config_to_update.each do |k,v|
+            info("  setting #{k} to #{v}")
+
+            # This is a weird way to handle priorities
+            # See https://github.com/tildeio/direwolf-agent/issues/275
+            k = "#{environment}.#{k}" if environment
+
+            set(k, v)
+          end
+        end
+      end
+
+      return true
+    end
+
     def check_permissions(pidfile, sockdir_path)
       pidfile_root = File.dirname(pidfile)
 
@@ -401,13 +450,23 @@ module Skylight
       end
     end
 
+    def to_json
+      JSON.generate(
+        config: {
+          priority: @priority,
+          values:   @values
+        }
+      )
+    end
+
     def to_native_env
       ret = []
 
       ret << "SKYLIGHT_AUTHENTICATION" << authentication_with_deploy
 
       NATIVE_ENV.each do |key|
-        if value = send_or_get(key)
+        value = send_or_get(key)
+        unless value.nil?
           env_key = ENV_TO_KEY.key(key) || key.upcase
           ret << "SKYLIGHT_#{env_key}" << cast_for_env(value)
         end
@@ -454,7 +513,7 @@ authentication: #{self[:authentication]}
     def ignored_endpoints
       @ignored_endpoints ||=
         begin
-          ignored_endpoints = get(:'ignored_endpoints')
+          ignored_endpoints = get(:ignored_endpoints)
 
           # If, for some odd reason you have a comma in your endpoint name, use the
           # YML config instead.
@@ -462,7 +521,7 @@ authentication: #{self[:authentication]}
             ignored_endpoints = ignored_endpoints.split(/\s*,\s*/)
           end
 
-          val = Array(get(:'ignored_endpoint'))
+          val = Array(get(:ignored_endpoint))
           val.concat(Array(ignored_endpoints))
           val
         end
@@ -501,7 +560,7 @@ authentication: #{self[:authentication]}
         begin
           MUTEX.synchronize do
             unless l = @alert_logger
-              out = get(:'alert_log_file')
+              out = get(:alert_log_file)
 
               if out == '-'
                 out = Util::AlertLogger.new(load_logger)
@@ -523,12 +582,16 @@ authentication: #{self[:authentication]}
       @alert_logger = logger
     end
 
+    def on_heroku?
+      File.exist?(get(:'heroku.dyno_info_path'))
+    end
+
     def deploy
       @deploy ||= Util::Deploy.build(self)
     end
 
-    def separate_formats?
-      !!get(:separate_formats)
+    def enable_segments?
+      !!get(:enable_segments)
     end
 
   private
@@ -540,7 +603,7 @@ authentication: #{self[:authentication]}
 
     def load_logger
       unless l = @logger
-        out = get(:'log_file')
+        out = get(:log_file)
         out = STDOUT if out == '-'
 
         unless IO === out
@@ -550,7 +613,7 @@ authentication: #{self[:authentication]}
 
         l = Logger.new(out)
         l.level =
-          case get(:'log_level')
+          case get(:log_level)
           when /^debug$/i then Logger::DEBUG
           when /^info$/i  then Logger::INFO
           when /^warn$/i  then Logger::WARN

data/lib/skylight/core.rb

@@ -7,7 +7,9 @@ module Skylight
   # Load the native agent
   require 'skylight/native'
 
-  if defined?(Rails)
+  # 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)
     require 'skylight/railtie'
   end
 

data/lib/skylight/instrumenter.rb

@@ -107,10 +107,9 @@ module Skylight
       end
 
       t { "starting instrumenter" }
-      @config.validate!
 
-      unless validate_authentication
-        warn "invalid authentication token"
+      unless config.validate_with_server
+        log_error "invalid config"
         return
       end
 
@@ -120,13 +119,13 @@ module Skylight
         return
       end
 
-      @config.gc.enable
+      config.gc.enable
       @subscriber.register!
 
       self
 
     rescue Exception => e
-      log_error "failed to start instrumenter; msg=%s; config=%s", e.message, @config.inspect
+      log_error "failed to start instrumenter; msg=%s; config=%s", e.message, config.inspect
       t { e.backtrace.join("\n") }
       nil
     end
@@ -252,33 +251,7 @@ module Skylight
     end
 
     def ignore?(trace)
-      @config.ignored_endpoints.include?(trace.endpoint)
-    end
-
-    # Validates that the provided authentication token is valid. This is done
-    # by issuing a request for a session token and checking the response
-    def validate_authentication
-      # If a session token is specified, don't bother attempting to validate
-      if config[:session_token]
-        debug "using pre-generated session token"
-        true
-      else
-        api = Api.new(config)
-        api.authentication = config[:authentication]
-
-        case res = api.validate_authentication
-        when :ok
-          true
-        when :invalid
-          false
-        when :unknown
-          warn "unable to validate authentication token"
-          true
-        else
-          error "[BUG] unexpected validate_token result; res=%s", res
-          true
-        end
-      end
+      config.ignored_endpoints.include?(trace.endpoint)
     end
 
   end

data/lib/skylight/normalizers/action_controller/process_action.rb

@@ -16,11 +16,19 @@ module Skylight
         end
 
         def normalize_after(trace, span, name, payload)
-          return unless config.separate_formats?
+          return unless config.enable_segments?
 
-          format = [payload[:format], payload[:variant]].compact.flatten.join('+')
-          unless format.empty?
-            trace.endpoint += "<sk-format>#{format}</sk-format>"
+          # Show 'error' if there's an unhandled exception or if the status is 4xx or 5xx
+          if payload[:exception] || payload[:status].to_s =~ /^[45]/
+            segment = "error"
+          # We won't have a rendered_format if it's a `head` outside of a `respond_to` block.
+          elsif payload[:rendered_format]
+            # We only show the variant if we actually have a format
+            segment = [payload[:rendered_format], payload[:variant]].compact.flatten.join('+')
+          end
+
+          if segment
+            trace.endpoint += "<sk-segment>#{segment}</sk-segment>"
           end
         end