skylight 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d299c38749f9eb46bf2ed780d3b554760d8728b
-  data.tar.gz: 74e57f72bc4bc58ab4a8977382d930e032414ca4
+  metadata.gz: 1699f6ba8c234cdf6b89fd396784d237522fc664
+  data.tar.gz: ed71e8ba5f1fba9a80100c1f3a9aa92f8e730254
 SHA512:
-  metadata.gz: b4d63a7ac26843af364e798327841652ee2a9fc21b0724845190f0a7e963886ab534fc16a813ab673dab32f37cc59835c7f459255881594542c6827d7eeac190
-  data.tar.gz: 70b05635d94f0b60ede936c2b645c978497fcb85fb8acc061290124b595bff1849367b9977bc618513cd26e985700723355dc38b569468a4ad8afd532ded0456
+  metadata.gz: ba7ff221b40a563cf0367f4622f173e28277bceabac3f73b640b414b608cd104cc9fb78fcf14d199a254371dc537a185b1145ec7411aa049ffcc18d9381891a0
+  data.tar.gz: a7a7d90630a59b8657c93519e67b442478cdb83730bbc3e9f07415239a6373b79d29dc0837883613fc602abff370731acdfd0ae7f14a03e035f7bea570a58531

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.1.0 (March 9, 2017)
+
+* [FEATURE] Support musl-based OSes (including Alpine Linux)
+* [FEATURE] Add Elasticsearch Probe
+* [FEATURE] Add HTTPClient probe (#76)j
+* [IMPROVEMENT] Update tested Ruby versions, drop 1.9.2
+* [BUGFIX] Fix HTTP_PROXY handling of empty strings (#90)
+* [BUGFIX] Don't crash on empty content_type strings
+* [BUGFIX] Use more robust method to detect home dir (#75)
+* [BUGFIX] Add option to suppress environment warning (#62)
+
 ## 1.0.1 (November 15, 2016)
 
 * [BUGFIX] Gracefully handle non-writable log files

data/ext/libskylight.yml

@@ -1,6 +1,7 @@
 ---
-version: "1.0.1-fcb0e55"
+version: "1.1.0-de45c74"
 checksums:
-  x86-linux:     "8a4b585dc72735947bc3bd7ae24c11e92dbe8d57af4afb7345df561fad563804"
-  x86_64-linux:  "7c192d9c98715f32be74c20596738e48af295629a401dffe5aff21da796231ed"
-  x86_64-darwin: "8bd31a89a7bdb32c0903608c5e73818af9dfb0f8b3f3004ec2fa8f587ee5f819"
+  x86-linux:         "fbfb6a647701403a11e2e81045dd84b3c55ec7fedf60910bfa372c9bf7ef8b5f"
+  x86_64-linux:      "6958c20cc35bea207f12e65530460dda64ed6a31556a76de8911ae9c604cff93"
+  x86_64-linux-musl: "65171091e9262755431e52e1b1c3c7e4881c71bbf8ded322aa599f137baecf10"
+  x86_64-darwin:     "238ae95c68a8d4601d2e4e2c2583090750cd70e647c0342f73699ab772b35335"

data/lib/skylight/cli.rb

@@ -69,6 +69,14 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
         say "Development mode warning disabled", :green
       end
 
+      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
+
+        say "Environment warning disabled", :green
+      end
+
     private
 
       def app_name

data/lib/skylight/config.rb

@@ -552,7 +552,7 @@ authentication: #{self[:authentication]}
         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}"
+        token += "|#{deploy_str}"
       end
 
       token

data/lib/skylight/normalizers.rb

@@ -145,6 +145,7 @@ module Skylight
         active_model_serializers/render
         active_record/sql
         active_support/cache
+        elasticsearch/request
         grape/endpoint
         moped/query).each do |file|
       require "skylight/normalizers/#{file}"

data/lib/skylight/normalizers/elasticsearch/request.rb

@@ -0,0 +1,20 @@
+module Skylight
+  module Normalizers
+    module Elasticsearch
+      class Request < Normalizer
+        register "request.elasticsearch"
+
+        CAT = "db.elasticsearch.request".freeze
+
+        def normalize(trace, name, payload)
+          path = payload[:path].split('/')
+          title = [payload[:method], path[0]].compact.join(' ')
+          desc = {}
+          desc[:type] = path[1] if path[1]
+          desc[:id] = '?' if path[2]
+          [ CAT, title, desc.presence.try(:to_json) ]
+        end
+      end
+    end
+  end
+end

data/lib/skylight/probes/action_controller.rb

@@ -8,11 +8,15 @@ module Skylight
             alias append_info_to_payload_without_sk append_info_to_payload
             def append_info_to_payload(payload)
               append_info_to_payload_without_sk(payload)
-              if respond_to?(:rendered_format)
-                rendered_mime = rendered_format
-              elsif respond_to?(:lookup_context)
-                format = lookup_context.formats.first
-                rendered_mime = Mime[format.to_sym] if format
+              rendered_mime = begin
+                if respond_to?(:rendered_format)
+                  rendered_format
+                elsif content_type.is_a?(Mime::Type)
+                  content_type
+                elsif content_type.respond_to?(:to_s)
+                  type_str = content_type.to_s.split(';').first
+                  Mime::Type.lookup(type_str) unless type_str.blank?
+                end
               end
               payload[:rendered_format] = rendered_mime.try(:ref)
               payload[:variant] = request.respond_to?(:variant) ? request.variant : nil

data/lib/skylight/probes/elasticsearch.rb

@@ -0,0 +1,34 @@
+module Skylight
+  module Probes
+    module Elasticsearch
+      class Probe
+        def install
+          ::Elasticsearch::Transport::Transport::Base.class_eval do
+            alias perform_request_without_sk perform_request
+            def perform_request(method, path, *args, &block)
+              ActiveSupport::Notifications.instrument "request.elasticsearch",
+                                                      name:   'Request',
+                                                      method: method,
+                                                      path:   path do
+
+                # Prevent HTTP-related probes from firing
+                disable_skylight_probe(:NetHTTP) do
+                  disable_skylight_probe(:HTTPClient) do
+                    perform_request_without_sk(method, path, *args, &block)
+                  end
+                end
+              end
+            end
+
+            def disable_skylight_probe(class_name, &block)
+              klass = Skylight::Probes.const_get(class_name).const_get(:Probe) rescue nil
+              klass ? klass.disable(&block) : block.call
+            end
+          end
+        end
+      end
+    end
+
+    register("Elasticsearch", "elasticsearch", Elasticsearch::Probe.new)
+  end
+end

data/lib/skylight/probes/httpclient.rb

@@ -0,0 +1,46 @@
+require 'skylight/formatters/http'
+
+module Skylight
+  module Probes
+    module HTTPClient
+      class Probe
+        DISABLED_KEY = :__skylight_httpclient_disabled
+
+        def self.disable
+          Thread.current[DISABLED_KEY] = true
+          yield
+        ensure
+          Thread.current[DISABLED_KEY] = false
+        end
+
+        def self.disabled?
+          !!Thread.current[DISABLED_KEY]
+        end
+
+        def install
+          ::HTTPClient.class_eval do
+            # HTTPClient has request methods on the class object itself,
+            # but the internally instantiate a client and perform the method
+            # on that, so this instance method override will cover both
+            # `HTTPClient.get(...)` and `HTTPClient.new.get(...)`
+
+            alias do_request_without_sk do_request
+            def do_request(method, uri, query, body, header, &block)
+              if Skylight::Probes::HTTPClient::Probe.disabled?
+                return do_request_without_sk(method, uri, query, body, header, &block)
+              end
+
+              opts = Formatters::HTTP.build_opts(method, uri.scheme, uri.host, uri.port, uri.path, uri.query)
+
+              Skylight.instrument(opts) do
+                do_request_without_sk(method, uri, query, body, header, &block)
+              end
+            end
+          end
+        end
+      end # class Probe
+    end # module Probes::HTTPClient
+
+    register("HTTPClient", "httpclient", HTTPClient::Probe.new)
+  end
+end

data/lib/skylight/probes/net_http.rb

@@ -4,12 +4,25 @@ module Skylight
   module Probes
     module NetHTTP
       class Probe
+        DISABLED_KEY = :__skylight_net_http_disabled
+
+        def self.disable
+          Thread.current[DISABLED_KEY] = true
+          yield
+        ensure
+          Thread.current[DISABLED_KEY] = false
+        end
+
+        def self.disabled?
+          !!Thread.current[DISABLED_KEY]
+        end
+
         def install
           Net::HTTP.class_eval do
             alias request_without_sk request
 
             def request(req, body = nil, &block)
-              unless started?
+              if !started? || Skylight::Probes::NetHTTP::Probe.disabled?
                 return request_without_sk(req, body, &block)
               end
 

data/lib/skylight/railtie.rb

@@ -42,7 +42,9 @@ module Skylight
                                 "(To disable this message for all local apps, run `skylight disable_dev_warning`.)"
         end
       elsif !Rails.env.test?
-        log_warning config, "[SKYLIGHT] [#{Skylight::VERSION}] You are running in the #{Rails.env} environment but haven't added it to config.skylight.environments, so no data will be sent to skylight.io."
+        unless UserConfig.instance.disable_env_warning?
+          log_warning config, "[SKYLIGHT] [#{Skylight::VERSION}] You are running in the #{Rails.env} environment but haven't added it to config.skylight.environments, so no data will be sent to skylight.io."
+        end
       end
     end
 

data/lib/skylight/user_config.rb

@@ -3,7 +3,7 @@ require 'yaml'
 module Skylight
   class UserConfig
 
-    attr_accessor :disable_dev_warning
+    attr_accessor :disable_dev_warning, :disable_env_warning
 
     def self.instance
       @instance ||= new
@@ -14,18 +14,35 @@ module Skylight
     end
 
     def file_path
-      File.expand_path(ENV["SKYLIGHT_USER_CONFIG_PATH"] || "~/.skylight")
+      return @file_path if @file_path
+
+      config_path = ENV.fetch("SKYLIGHT_USER_CONFIG_PATH") do
+        require "etc"
+        home_dir = ENV['HOME'] || Etc.getpwuid.dir || (ENV["USER"] && File.expand_path("~#{ENV['USER']}"))
+        if home_dir
+          File.join(home_dir, ".skylight")
+        else
+          raise KeyError, "SKYLIGHT_USER_CONFIG_PATH must be defined since the home directory cannot be inferred"
+        end
+      end
+
+      @file_path = File.expand_path(config_path)
     end
 
     def disable_dev_warning?
       disable_dev_warning
     end
 
+    def disable_env_warning?
+      disable_env_warning
+    end
+
     def reload
       config = File.exist?(file_path) ? YAML.load_file(file_path) : false
       return unless config
 
       self.disable_dev_warning = !!config['disable_dev_warning']
+      self.disable_env_warning = !!config['disable_env_warning']
     end
 
     def save
@@ -37,9 +54,10 @@ module Skylight
 
     def to_hash
       {
-        'disable_dev_warning' => disable_dev_warning
+        'disable_dev_warning' => disable_dev_warning,
+        'disable_env_warning' => disable_env_warning
       }
     end
 
   end
-end
+end

data/lib/skylight/util/platform.rb

@@ -7,7 +7,15 @@ module Skylight
       # Normalize the platform OS
       OS = case os = RbConfig::CONFIG['host_os'].downcase
       when /linux/
-        "linux"
+        # The official ruby-alpine Docker containers pre-build Ruby. As a result,
+        #   Ruby doesn't know that it's on a musl-based platform. `ldd` is the
+        #   only reliable way to detect musl that we've found.
+        # See https://github.com/skylightio/skylight-ruby/issues/92
+        if ENV['SKYLIGHT_MUSL'] || `ldd --version 2>&1` =~ /musl/
+          "linux-musl"
+        else
+          "linux"
+        end
       when /darwin/
         "darwin"
       when /freebsd/

data/lib/skylight/util/proxy.rb

@@ -2,7 +2,8 @@ module Skylight
   module Util
     module Proxy
       def self.detect_url(env)
-        if u = env['HTTP_PROXY'] || env['http_proxy']
+        u = env['HTTP_PROXY'] || env['http_proxy']
+        if u && !u.empty?
           u = "http://#{u}" unless u =~ %r[://]
           u
         end

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -79,6 +79,7 @@ files:
 - lib/skylight/normalizers/active_support/cache_read_multi.rb
 - lib/skylight/normalizers/active_support/cache_write.rb
 - lib/skylight/normalizers/default.rb
+- lib/skylight/normalizers/elasticsearch/request.rb
 - lib/skylight/normalizers/grape/endpoint.rb
 - lib/skylight/normalizers/grape/endpoint_render.rb
 - lib/skylight/normalizers/grape/endpoint_run.rb
@@ -88,9 +89,11 @@ files:
 - lib/skylight/probes/action_controller.rb
 - lib/skylight/probes/action_view.rb
 - lib/skylight/probes/active_model_serializers.rb
+- lib/skylight/probes/elasticsearch.rb
 - lib/skylight/probes/excon.rb
 - lib/skylight/probes/excon/middleware.rb
 - lib/skylight/probes/grape.rb
+- lib/skylight/probes/httpclient.rb
 - lib/skylight/probes/mongo.rb
 - lib/skylight/probes/mongoid.rb
 - lib/skylight/probes/moped.rb
@@ -185,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Skylight is a smart profiler for Rails apps