[logging] few more tweaks for disabling logging

- tests need to read the right file
- -1 is an accepted value
- updates to the comment (=documentation) in the config file

AO-10683

Author: prettycoder

lib/appoptics_apm/config.rb

@@ -71,12 +71,12 @@ def self.load_config_file
     # Oboe will override vars passed in if it finds an environment variable
     # :debug_level and :verbose need special consideration, because they are used in Ruby
     def self.check_env_vars
-      unless (0..6).include?(AppOpticsAPM::Config[:debug_level])
-        AppOpticsAPM::Config[:debug_level] = nil
+      unless (-1..6).include?(AppOpticsAPM::Config[:debug_level])
+        AppOpticsAPM::Config[:debug_level] = 3
       end
 
-      # let's use the same debug level for ruby as well,
-      debug_level = ENV['APPOPTICS_DEBUG_LEVEL'].to_i || AppOpticsAPM::Config[:debug_level] || 3
+      # let's find and use the  equivalent debug level for ruby
+      debug_level = ENV['APPOPTICS_DEBUG_LEVEL'] ? ENV['APPOPTICS_DEBUG_LEVEL'].to_i : AppOpticsAPM::Config[:debug_level]
       if debug_level < 0
         # there should be no logging if APPOPTICS_DEBUG_LEVEL == -1
         # In Ruby level 5 is UNKNOWN and it can log, but level 6 is quiet

lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb

@@ -27,17 +27,17 @@
 
   #
   # Set APPOPTICS_DEBUG_LEVEL
-  # This Setting will be overridden if APPOPTICS_DEBUG_LEVEL is set as an environment variable
+  # This setting will be overridden if APPOPTICS_DEBUG_LEVEL is set as an environment variable.
   #
   # It sets the log level and takes the following values:
-  ## 0 fatal, 1 error, 2 warning, 3 info (the default), 4 debug low, 5 debug medium, 6 debug high.
-  #
+  # -1 disabled, 0 fatal, 1 error, 2 warning, 3 info (the default), 4 debug low, 5 debug medium, 6 debug high.
+  # Values < -1 or > 6 will set the log level to the default (info).
   #
   AppOpticsAPM::Config[:debug_level] = 3
   #
   # :debug_level will be used in the c-extension of the gem and also mapped to the
-  # Ruby logger as FATAL, ERROR, WARN, INFO, or DEBUG
-  # The Ruby logger can afterwards be changed to a different level as follows:
+  # Ruby logger as DISABLED, FATAL, ERROR, WARN, INFO, or DEBUG
+  # The Ruby logger can afterwards be changed to a different level, e.g:
   # AppOpticsAPM.logger.level = Logger::INFO
 
   #

test/support/config_test.rb

@@ -56,7 +56,7 @@ class ConfigTest
         f.puts "AppOpticsAPM::Config[:debug_level] = 6"
         f.puts "AppOpticsAPM::Config[:verbose] = true"
       end
-
+      ENV['APPOPTICS_APM_CONFIG_RUBY'] = @@default_config_path
       AppOpticsAPM::Config.load_config_file
 
       ENV['APPOPTICS_SERVICE_KEY'].must_be_nil
@@ -86,7 +86,7 @@ class ConfigTest
          f.puts "AppOpticsAPM::Config[:debug_level] = 6"
          f.puts "AppOpticsAPM::Config[:verbose] = false"
        end
-
+       ENV['APPOPTICS_APM_CONFIG_RUBY'] = @@default_config_path
        AppOpticsAPM::Config.load_config_file
 
        ENV['APPOPTICS_SERVICE_KEY'].must_equal '22222222-2222-2222-2222-222222222222:the_service_name'
@@ -101,19 +101,31 @@ class ConfigTest
       File.open(@@default_config_path, 'w') do |f|
         f.puts "AppOpticsAPM::Config[:debug_level] = 7"
       end
-
+      ENV['APPOPTICS_APM_CONFIG_RUBY'] = @@default_config_path
       AppOpticsAPM::Config.load_config_file
 
       ENV['APPOPTICS_DEBUG_LEVEL'].must_be_nil
-      AppOpticsAPM::Config[:debug_level].must_be_nil
+      AppOpticsAPM::Config[:debug_level].must_equal 3
       AppOpticsAPM.logger.level.must_equal Logger::INFO
     end
 
+    it "should accept -1 (disable logging)" do
+      File.open(@@default_config_path, 'w') do |f|
+        f.puts "AppOpticsAPM::Config[:debug_level] = -1"
+      end
+      ENV['APPOPTICS_APM_CONFIG_RUBY'] = @@default_config_path
+      AppOpticsAPM::Config.load_config_file
+
+      ENV['APPOPTICS_DEBUG_LEVEL'].must_be_nil
+      AppOpticsAPM::Config[:debug_level].must_equal -1
+      AppOpticsAPM.logger.level.must_equal 6
+    end
+
     it "should accept 'true'/'TRUE'/'True'/... as true for VERBOSE" do
       File.open(@@default_config_path, 'w') do |f|
         f.puts "AppOpticsAPM::Config[:verbose] = false"
       end
-
+      ENV['APPOPTICS_APM_CONFIG_RUBY'] = @@default_config_path
       ENV['APPOPTICS_GEM_VERBOSE'] = 'FALSE'
       AppOpticsAPM::Config.load_config_file
       AppOpticsAPM::Config[:verbose].wont_equal true