scout_apm 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35153897d05053c188035cea90a9c9821abcd4cf
-  data.tar.gz: 94fe5aee4fa214256fe31ffe643973274f2d66fb
+  metadata.gz: fe3261e9eced978064607b53499cc6293be5a058
+  data.tar.gz: 6d676264b1b042a9cbe355e09353a861b7bcc8b8
 SHA512:
-  metadata.gz: efef5649e203008c653a8fba69e1c28de35f510d831ff3e47a4483fda8e92116cd8aa5e1e64d3ab7ffe63cef9f03113987f953cc78f65a05af076be04fa1fb7b
-  data.tar.gz: 37966ab847e9c50ce354c9f8a2fe3c4ecfda397e091fc2d89f02b7816b2b14bfdd8e4bf56528a1f6572e9bb92b26ab6438b7a4bb83709969c887a8f904a810a0
+  metadata.gz: 2fd76e1a585a61ad5cf2e1ded0a6e83dd958697ef79ca6cd95cc4643a7d07844ef0da37096d1a8303ee8e6c1fc56b33ad5436e20548d289f8a7aeb144e916d74
+  data.tar.gz: 9fda0efefb37ef6707950e03d4fdd745299e3f3921cebd8e3f56680b9f635bfc7839719329fce8b32ac34d51447561b27d805749303337fb65b15448edf410e2

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 2.4.1
+
+* Fix logging on STDOUT only platforms (Heroku)
+
 # 2.4.0
 
 * Rework agent startup sequence

data/lib/scout_apm/agent_context.rb

@@ -220,7 +220,7 @@ module ScoutApm
         {
           :log_level     => config.value('log_level'),
           :log_file_path => config.value('log_file_path'),
-          :stdout        => config.value('log_stdout'),
+          :stdout        => config.value('log_stdout') || environment.platform_integration.log_to_stdout?,
           :stderr        => config.value('log_stderr'),
           :logger_class  => config.value('log_class'),
         }

data/lib/scout_apm/logger.rb

@@ -40,7 +40,11 @@ module ScoutApm
     def fatal(*args, &block); @logger.fatal(*args, &block); end
 
     def log_level=(level)
-      @logger.level = level
+      @logger.level = log_level_from_opts(level)
+    end
+
+    def log_level
+      @logger.level
     end
 
     def log_file_path
@@ -48,11 +52,11 @@ module ScoutApm
     end
 
     def stdout?
-      @opts[:stdout] || @opts[:log_file_path] == "STDOUT"
+      @opts[:stdout] || (@opts[:log_file_path] || "").upcase == "STDOUT"
     end
 
     def stderr?
-      @opts[:stderr] || @opts[:log_file_path] == "STDERR"
+      @opts[:stderr] || (@opts[:log_file_path] || "").upcase == "STDERR"
     end
 
     private
@@ -86,13 +90,16 @@ module ScoutApm
       end
     end
 
-    def log_level_from_opts
-      case @opts[:log_level]
+    def log_level_from_opts(explicit=nil)
+      candidate = explicit || (@opts[:log_level] || "").downcase
+
+      case candidate
       when "debug" then ::Logger::DEBUG
       when "info" then ::Logger::INFO
       when "warn" then ::Logger::WARN
       when "error" then ::Logger::ERROR
       when "fatal" then ::Logger::FATAL
+      when ::Logger::DEBUG, ::Logger::INFO, ::Logger::WARN, ::Logger::ERROR, ::Logger::FATAL then candidate
       else ::Logger::INFO
       end
     end
@@ -116,11 +123,12 @@ module ScoutApm
     # Check if this path is ok for a log file.
     # Does it exist?
     # Is it writable?
-    # XXX: Implement
     def validate_path(candidate)
-      !candidate.nil?
-    end
+      return false if candidate.nil?
 
+      directory = File.dirname(candidate)
+      File.writable?(directory)
+    end
 
     class DefaultFormatter < ::Logger::Formatter
       def call(severity, time, progname, msg)

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.4.0"
+  VERSION = "2.4.1"
 end
 

data/test/unit/logger_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+require 'scout_apm/logger'
+
+class LoggerTest < Minitest::Test
+  def setup
+    @env_root = Pathname.new(File.dirname(__FILE__)) + "../../"
+  end
+
+  def test_detect_stdout
+    logger = ScoutApm::Logger.new("", { :log_file_path => "STDOUT"})
+    assert logger.stdout?
+    assert_equal STDOUT, logger.log_destination
+
+    # and lowercase
+    logger = ScoutApm::Logger.new("", { :log_file_path => "stdout"})
+    assert logger.stdout?
+    assert_equal STDOUT, logger.log_destination
+  end
+
+  def test_force_stdout
+    logger = ScoutApm::Logger.new("", { :stdout => true })
+    assert logger.stdout?
+    assert_equal STDOUT, logger.log_destination
+  end
+
+  def test_pick_log_file_with_no_options
+    logger = ScoutApm::Logger.new(@env_root, { })
+    assert_equal (@env_root + "log" + "scout_apm.log").to_s, logger.log_destination
+  end
+
+  def test_pick_log_file_with_different_dir
+    logger = ScoutApm::Logger.new(@env_root, { :log_file_path => "/tmp" })
+    assert_equal "/tmp/scout_apm.log", logger.log_destination
+  end
+
+  def test_pick_log_file_invalid_dir
+    logger = ScoutApm::Logger.new(@env_root, { :log_file_path => "/not_a_real_dir" })
+    assert_equal STDOUT, logger.log_destination
+  end
+
+  def test_pick_log_dir_not_writable
+    Dir.mktmpdir { |dir|
+      # An unwritable dir
+      FileUtils.chmod(0000, dir)
+      logger = ScoutApm::Logger.new(@env_root, { :log_file_path => dir })
+      assert_equal STDOUT, logger.log_destination
+
+      # so it can be deleted
+      FileUtils.chmod(0700, dir)
+    }
+  end
+
+  def test_set_log_level
+    logger = ScoutApm::Logger.new(@env_root, { :log_level => "debug" })
+    assert_equal ::Logger::DEBUG, logger.log_level
+  end
+
+  def test_set_log_level_after
+    logger = ScoutApm::Logger.new(@env_root, { :log_level => "debug" })
+    logger.log_level = "info"
+    assert_equal ::Logger::INFO, logger.log_level
+
+    logger.log_level = ::Logger::ERROR
+    assert_equal ::Logger::ERROR, logger.log_level
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-13 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -329,6 +329,7 @@ files:
 - test/unit/layer_converters/metric_converter_test.rb
 - test/unit/layer_converters/stubs.rb
 - test/unit/limited_layer_test.rb
+- test/unit/logger_test.rb
 - test/unit/metric_set_test.rb
 - test/unit/remote/test_message.rb
 - test/unit/remote/test_router.rb
@@ -392,6 +393,7 @@ test_files:
 - test/unit/layer_converters/metric_converter_test.rb
 - test/unit/layer_converters/stubs.rb
 - test/unit/limited_layer_test.rb
+- test/unit/logger_test.rb
 - test/unit/metric_set_test.rb
 - test/unit/remote/test_message.rb
 - test/unit/remote/test_router.rb