skylight 4.3.2 → 5.1.1

data/lib/skylight.rb

@@ -1,36 +1,223 @@
 require "skylight/version"
-require "skylight/core"
 require "skylight/trace"
 require "skylight/instrumenter"
 require "skylight/middleware"
 require "skylight/api"
 require "skylight/helpers"
 require "skylight/config"
+require "skylight/user_config"
 require "skylight/errors"
 require "skylight/native"
+require "skylight/gc"
+require "skylight/vm/gc"
+require "skylight/util"
+require "skylight/deprecation"
+require "skylight/subscriber"
+require "skylight/sidekiq"
+require "skylight/probes"
 
 # For prettier global names
 require "English"
 
+require "active_support/notifications"
+
+# Specifically check for Railtie since we've had at least one case of a
+#   customer having Rails defined without having all of Rails loaded.
+require "skylight/railtie" if defined?(Rails::Railtie)
+
 module Skylight
   # Used from the CLI
   autoload :CLI, "skylight/cli"
 
-  # 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
+  # Is this autoload even useful?
+  autoload :Normalizers, "skylight/normalizers"
 
-  include Core::Instrumentable
+  extend Util::Logging
 
-  def self.instrumenter_class
-    Instrumenter
-  end
+  LOCK = Mutex.new
 
-  def self.config_class
-    Config
-  end
+  # @api private
+  TIERS = %w[rack api app view db noise other].freeze
+
+  # @api private
+  TIER_REGEX = /^(?:#{TIERS.join("|")})(?:\.|$)/u.freeze
+
+  # @api private
+  CATEGORY_REGEX = /^[a-z0-9_-]+(?:\.[a-z0-9_-]+)*$/iu.freeze
+
+  # @api private
+  DEFAULT_CATEGORY = "app.block".freeze
+
+  # @api private
+  DEFAULT_OPTIONS = { category: DEFAULT_CATEGORY }.freeze
+
+  at_exit { stop! }
+
+  class << self
+    extend Util::InstrumenterMethod
+
+    def instrumenter
+      defined?(@instrumenter) && @instrumenter
+    end
+
+    def probe(*args)
+      Probes.probe(*args)
+    end
+
+    def enable_normalizer(*names)
+      Normalizers.enable(*names)
+    end
+
+    # Start instrumenting
+    def start!(config = nil)
+      return instrumenter if instrumenter
+
+      const_get(:LOCK).synchronize do
+        return instrumenter if instrumenter
+
+        config ||= {}
+        config = Config.load(config) unless config.is_a?(Config)
+
+        Probes.install!
+
+        @instrumenter = Instrumenter.new(config).start!
+      end
+    rescue StandardError => e
+      level, message =
+        if e.is_a?(ConfigError)
+          [:warn, format("Unable to start Instrumenter due to a configuration error: %<message>s", message: e.message)]
+        else
+          [
+            :error,
+            format("Unable to start Instrumenter; msg=%<message>s; class=%<klass>s", message: e.message, klass: e.class)
+          ]
+        end
+
+      if config.respond_to?("log_#{level}") && config.respond_to?(:log_trace)
+        config.send("log_#{level}", message)
+        config.log_trace e.backtrace.join("\n")
+      else
+        warn "[#{name.upcase}] #{message}"
+      end
+      false
+    end
+
+    def started?
+      !!instrumenter
+    end
+
+    # Stop instrumenting
+    def stop!
+      t { "stop!" }
 
-  Core::Probes.add_path(File.expand_path("skylight/probes", __dir__))
+      const_get(:LOCK).synchronize do
+        t { "stop! synchronized" }
+        return unless instrumenter
+
+        # This is only really helpful for getting specs to pass.
+        @instrumenter.current_trace = nil
+
+        @instrumenter.shutdown
+        @instrumenter = nil
+      end
+    end
+
+    # Check tracing
+    def tracing?
+      t { "checking tracing?; thread=#{Thread.current.object_id}" }
+      instrumenter&.current_trace
+    end
+
+    # Start a trace
+    def trace(endpoint = nil, cat = nil, title = nil, meta: nil, segment: nil, component: nil)
+      unless instrumenter
+        return yield if block_given?
+
+        return
+      end
+
+      if instrumenter.poisoned?
+        spawn_shutdown_thread!
+        return yield if block_given?
+
+        return
+      end
+
+      cat ||= DEFAULT_CATEGORY
+
+      if block_given?
+        instrumenter.trace(endpoint, cat, title, nil, meta: meta, segment: segment, component: component) do |tr|
+          yield tr
+        end
+      else
+        instrumenter.trace(endpoint, cat, title, nil, meta: meta, segment: segment, component: component)
+      end
+    end
+
+    # @overload instrument(opts)
+    #   @param [Hash] opts the options for instrumentation.
+    #   @option opts [String] :category (`DEFAULT_CATEGORY`) The category
+    #   @option opts [String] :title The title
+    #   @option opts [String] :description The description
+    #   @option opts [Hash] :meta The meta
+    #   @option opts [String] :source_location The source location
+    #   @option opts [String] :source_file The source file. (Will be sanitized.)
+    #   @option opts [String] :source_line The source line.
+    # @overload instrument(title)
+    #   Instrument with the specified title and the default category
+    #   @param [String] title The title
+    def instrument(opts = DEFAULT_OPTIONS, &block)
+      unless instrumenter
+        return yield if block_given?
+
+        return
+      end
+
+      if opts.is_a?(Hash)
+        category = opts[:category] || DEFAULT_CATEGORY
+        title = opts[:title]
+        desc = opts[:description]
+        meta = opts[:meta]
+      else
+        category = DEFAULT_CATEGORY
+        title = opts.to_s
+        desc = nil
+        meta = nil
+        opts = {}
+      end
+
+      # NOTE: unless we have `:internal` (indicating a built-in Skylight instrument block),
+      # or we already have a `source_file` or `source_line` (probably set by `instrument_method`),
+      # we set the caller location to the second item on the stack
+      # (immediate caller of the `instrument` method).
+      unless opts[:source_file] || opts[:source_line] || opts[:internal]
+        opts = opts.merge(sk_instrument_location: caller_locations(1..1).first)
+      end
+
+      meta ||= {}
+
+      instrumenter.extensions.process_instrument_options(opts, meta)
+      instrumenter.instrument(category, title, desc, meta, &block)
+    end
+
+    instrumenter_method :config
+
+    instrumenter_method :mute, block: true
+    instrumenter_method :unmute, block: true
+    instrumenter_method :muted?
+
+    # End a span
+    instrumenter_method :done
+
+    instrumenter_method :broken!
+
+    # Temporarily disable
+    instrumenter_method :disable, block: true
+
+    # Runs the shutdown procedure in the background.
+    # This should do little more than unsubscribe from all ActiveSupport::Notifications
+    def spawn_shutdown_thread!
+      @shutdown_thread || const_get(:LOCK).synchronize { @shutdown_thread ||= Thread.new { @instrumenter&.shutdown } }
+    end
+  end
 end

data/lib/skylight/api.rb

@@ -4,13 +4,19 @@ require "skylight/util/http"
 module Skylight
   # @api private
   class Api
-    include Core::Util::Logging
+    include Util::Logging
 
     attr_reader :config
 
-    class Error < StandardError; end
-    class Unauthorized < Error; end
-    class Conflict < Error; end
+    class Error < StandardError
+    end
+
+    class Unauthorized < Error
+    end
+
+    class Conflict < Error
+    end
+
     class CreateFailed < Error
       attr_reader :res
 
@@ -21,6 +27,7 @@ module Skylight
 
       def errors
         return unless res.respond_to?(:body) && res.body.is_a?(Hash)
+
         res.body["errors"]
       end
 
@@ -36,7 +43,7 @@ module Skylight
     end
 
     class ConfigValidationResults
-      include Core::Util::Logging
+      include Util::Logging
 
       attr_reader :raw_response
 
@@ -67,6 +74,7 @@ module Skylight
       def token_valid?
         # Don't prevent boot if it's an error response, so assume token is valid
         return true if error_response?
+
         # A 2xx response means everything is good!
         return true if raw_response.success?
         return false if status == 401
@@ -87,11 +95,13 @@ module Skylight
 
       def validation_errors
         return {} if config_valid? || !body
+
         body["errors"]
       end
 
       def corrected_config
-        return {} if config_valid? || !body
+        return nil if config_valid? || !body
+
         body["corrected"]
       end
     end
@@ -107,6 +117,7 @@ module Skylight
       res = http_request(:app_create, :post, params)
 
       raise CreateFailed, res unless res.success?
+
       res
     end
 
@@ -132,22 +143,22 @@ module Skylight
 
     private
 
-      # TODO: Improve handling here: https://github.com/tildeio/direwolf-agent/issues/274
-      def http_request(service, method, *args)
-        http = Util::HTTP.new(config, service)
-        uri = URI.parse(config.get("#{service}_url"))
-        http.send(method, uri.path, *args)
-      end
+    # TODO: Improve handling here: https://github.com/tildeio/direwolf-agent/issues/274
+    def http_request(service, method, *args)
+      http = Util::HTTP.new(config, service)
+      uri = URI.parse(config.get("#{service}_url"))
+      http.send(method, uri.path, *args)
+    end
 
-      def error_for_status(code)
-        case code
-        when 401
-          Unauthorized
-        when 409
-          Conflict
-        else
-          Error
-        end
+    def error_for_status(code)
+      case code
+      when 401
+        Unauthorized
+      when 409
+        Conflict
+      else
+        Error
       end
+    end
   end
 end

data/lib/skylight/cli.rb

@@ -28,12 +28,13 @@ module Skylight
             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
+
           return
         end
 
         res = api.create_app(app_name, token)
 
-        config[:application]    = res.get("app.id")
+        config[:application] = res.get("app.id")
         config[:authentication] = res.get("app.token")
         config.write(config_path)
 
@@ -60,7 +61,7 @@ module Skylight
       rescue Api::CreateFailed => e
         say "Could not create the application. Please run `bundle exec skylight doctor` for diagnostics.", :red
         say e.to_s, :yellow
-      rescue Interrupt
+      rescue Interrupt # rubocop:disable Lint/SuppressedException
       end
 
       desc "disable_dev_warning", "Disables warning about running Skylight in development mode for all local apps"
@@ -71,7 +72,9 @@ module Skylight
         say "Development mode warning disabled", :green
       end
 
-      desc "disable_env_warning", "Disables warning about running Skylight in environments not defined in config.skylight.environments"
+      desc "disable_env_warning",
+           "Disables warning about running Skylight in environments not defined in " \
+             "config.skylight.environments"
       def disable_env_warning
         user_config.disable_env_warning = true
         user_config.save
@@ -81,57 +84,56 @@ module Skylight
 
       private
 
-        def app_name
-          @app_name ||=
-            begin
-              name = nil
-
-              if rails?
-                # Get the name in a process so that we don't pollute our environment here
-                # This is especially important since users may have things like WebMock that
-                # will prevent us from communicating with the Skylight API
-                begin
-                  namefile = Tempfile.new("skylight-app-name")
-                  # Windows appears to need double quotes for `rails runner`
-                  `rails runner "File.open('#{namefile.path}', 'w') {|f| f.write(Rails.application.class.name) rescue '' }"`
-                  name = namefile.read.split("::").first.underscore.titleize
-                  name = nil if name.empty?
-                rescue => e
-                  if ENV["DEBUG"]
-                    puts e.class.name
-                    puts e.to_s
-                    puts e.backtrace.join("\n")
-                  end
-                ensure
-                  namefile.close
-                  namefile.unlink
-                end
-
-                unless name
-                  warn "Unable to determine Rails application name. Using directory name."
+      def app_name
+        @app_name ||=
+          begin
+            name = nil
+
+            if rails?
+              # Get the name in a process so that we don't pollute our environment here
+              # This is especially important since users may have things like WebMock that
+              # will prevent us from communicating with the Skylight API
+              begin
+                namefile = Tempfile.new("skylight-app-name")
+
+                # Windows appears to need double quotes for `rails runner`
+                `rails runner "File.open('#{namefile.path}', 'w') {|f| f.write(Rails.application.class.name) rescue '' }"`
+                name = namefile.read.split("::").first.underscore.titleize
+                name = nil if name.empty?
+              rescue StandardError => e
+                if ENV["DEBUG"]
+                  puts e.class.name
+                  puts e.to_s
+                  puts e.backtrace.join("\n")
                 end
+              ensure
+                namefile.close
+                namefile.unlink
               end
 
-              name || File.basename(File.expand_path(".")).titleize
+              warn "Unable to determine Rails application name. Using directory name." unless name
             end
-        end
 
-        # Is this duplicated?
-        def relative_config_path
-          "config/skylight.yml"
-        end
+            name || File.basename(File.expand_path(".")).titleize
+          end
+      end
 
-        def config_path
-          File.expand_path(relative_config_path)
-        end
+      # Is this duplicated?
+      def relative_config_path
+        "config/skylight.yml"
+      end
 
-        def api
-          @api ||= Api.new(config)
-        end
+      def config_path
+        File.expand_path(relative_config_path)
+      end
 
-        def user_config
-          config.user_config
-        end
+      def api
+        @api ||= Api.new(config)
+      end
+
+      def user_config
+        config.user_config
+      end
     end
   end
 end