skylight 4.2.3 → 5.3.0

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 5.3.0
 platform: ruby
 authors:
 - Tilde, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: skylight-core
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.3
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.3
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: beefcake
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +192,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - engineering@tilde.io
 executables:
@@ -193,20 +221,106 @@ files:
 - lib/skylight/cli/merger.rb
 - lib/skylight/config.rb
 - lib/skylight/data/cacert.pem
+- lib/skylight/deprecation.rb
 - lib/skylight/errors.rb
+- lib/skylight/extensions.rb
+- lib/skylight/extensions/source_location.rb
+- lib/skylight/formatters/http.rb
+- lib/skylight/gc.rb
 - lib/skylight/helpers.rb
 - lib/skylight/instrumenter.rb
 - lib/skylight/middleware.rb
 - lib/skylight/native.rb
 - lib/skylight/native_ext_fetcher.rb
+- lib/skylight/normalizers.rb
+- lib/skylight/normalizers/action_controller/process_action.rb
+- lib/skylight/normalizers/action_controller/send_file.rb
+- lib/skylight/normalizers/action_dispatch/process_middleware.rb
+- lib/skylight/normalizers/action_dispatch/route_set.rb
+- lib/skylight/normalizers/action_view/render_collection.rb
+- lib/skylight/normalizers/action_view/render_layout.rb
+- lib/skylight/normalizers/action_view/render_partial.rb
+- lib/skylight/normalizers/action_view/render_template.rb
+- lib/skylight/normalizers/active_job/perform.rb
+- lib/skylight/normalizers/active_model_serializers/render.rb
+- lib/skylight/normalizers/active_record/instantiation.rb
+- lib/skylight/normalizers/active_record/sql.rb
+- lib/skylight/normalizers/active_storage.rb
+- lib/skylight/normalizers/active_support/cache.rb
+- lib/skylight/normalizers/active_support/cache_clear.rb
+- lib/skylight/normalizers/active_support/cache_decrement.rb
+- lib/skylight/normalizers/active_support/cache_delete.rb
+- lib/skylight/normalizers/active_support/cache_exist.rb
+- lib/skylight/normalizers/active_support/cache_fetch_hit.rb
+- lib/skylight/normalizers/active_support/cache_generate.rb
+- lib/skylight/normalizers/active_support/cache_increment.rb
+- lib/skylight/normalizers/active_support/cache_read.rb
+- lib/skylight/normalizers/active_support/cache_read_multi.rb
+- lib/skylight/normalizers/active_support/cache_write.rb
+- lib/skylight/normalizers/coach/handler_finish.rb
+- lib/skylight/normalizers/coach/middleware_finish.rb
+- lib/skylight/normalizers/couch_potato/query.rb
+- lib/skylight/normalizers/data_mapper/sql.rb
+- lib/skylight/normalizers/default.rb
+- lib/skylight/normalizers/elasticsearch/request.rb
+- lib/skylight/normalizers/faraday/request.rb
+- lib/skylight/normalizers/grape/endpoint.rb
+- lib/skylight/normalizers/grape/endpoint_render.rb
+- lib/skylight/normalizers/grape/endpoint_run.rb
+- lib/skylight/normalizers/grape/endpoint_run_filters.rb
+- lib/skylight/normalizers/grape/format_response.rb
+- lib/skylight/normalizers/graphiti/render.rb
+- lib/skylight/normalizers/graphiti/resolve.rb
+- lib/skylight/normalizers/graphql/base.rb
+- lib/skylight/normalizers/render.rb
+- lib/skylight/normalizers/sequel/sql.rb
+- lib/skylight/normalizers/shrine.rb
+- lib/skylight/normalizers/sql.rb
+- lib/skylight/probes.rb
+- lib/skylight/probes/action_controller.rb
+- lib/skylight/probes/action_dispatch.rb
+- lib/skylight/probes/action_dispatch/request_id.rb
+- lib/skylight/probes/action_dispatch/routing/route_set.rb
+- lib/skylight/probes/action_view.rb
+- lib/skylight/probes/active_job.rb
+- lib/skylight/probes/active_job_enqueue.rb
+- lib/skylight/probes/active_model_serializers.rb
+- lib/skylight/probes/active_record_async.rb
+- lib/skylight/probes/delayed_job.rb
+- lib/skylight/probes/elasticsearch.rb
+- lib/skylight/probes/excon.rb
+- lib/skylight/probes/excon/middleware.rb
+- lib/skylight/probes/faraday.rb
+- lib/skylight/probes/graphql.rb
+- lib/skylight/probes/httpclient.rb
+- lib/skylight/probes/middleware.rb
+- lib/skylight/probes/mongo.rb
+- lib/skylight/probes/mongoid.rb
+- lib/skylight/probes/net_http.rb
+- lib/skylight/probes/rack_builder.rb
+- lib/skylight/probes/redis.rb
+- lib/skylight/probes/sequel.rb
+- lib/skylight/probes/sinatra.rb
 - lib/skylight/probes/sinatra_add_middleware.rb
+- lib/skylight/probes/tilt.rb
 - lib/skylight/railtie.rb
+- lib/skylight/sidekiq.rb
 - lib/skylight/sinatra.rb
+- lib/skylight/subscriber.rb
+- lib/skylight/test.rb
 - lib/skylight/trace.rb
+- lib/skylight/user_config.rb
+- lib/skylight/util.rb
+- lib/skylight/util/allocation_free.rb
+- lib/skylight/util/clock.rb
 - lib/skylight/util/component.rb
 - lib/skylight/util/deploy.rb
+- lib/skylight/util/gzip.rb
 - lib/skylight/util/hostname.rb
 - lib/skylight/util/http.rb
+- lib/skylight/util/instrumenter_method.rb
+- lib/skylight/util/logging.rb
+- lib/skylight/util/lru_cache.rb
 - lib/skylight/util/platform.rb
 - lib/skylight/util/proxy.rb
 - lib/skylight/util/ssl.rb
@@ -250,11 +364,13 @@ files:
 - lib/skylight/vendor/cli/thor/util.rb
 - lib/skylight/vendor/cli/thor/version.rb
 - lib/skylight/version.rb
+- lib/skylight/vm/gc.rb
 homepage: https://www.skylight.io
 licenses:
 - Nonstandard
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -262,15 +378,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Skylight is a smart profiler for Rails, Sinatra, and other Ruby apps.
 test_files: []