appsignal 3.0.16 → 3.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c328cc2792e823cfde99017052cb090d704c9e919aa9dd826343518616df0e48
-  data.tar.gz: 3a0f796a71985048fac24343f92a79d041069470280fb78f7a51121f934397b2
+  metadata.gz: f4140fb4353aa8d684bd56f7ecd80aa62b959863afbbabc933ec9a6f4b6a1af2
+  data.tar.gz: '095d567f4576b945245623cdfc3adb5e4d0f13c57be7a346e8839c9cd4dfd917'
 SHA512:
-  metadata.gz: 80db72cdb0f313e0f1adf92e70e9ea44974d537bf8ad396b238135541b2fbb0ab84527722825fde4915a5d640ba73f94fff52e2eaea367decabe8276733f5c99
-  data.tar.gz: 74d11d47c32a02ffdc5da5f42aaed1c113188bb780123304492516c4aecf0b1f14fb65b8c2a3dc711dc0dd43892598b960c3a4f1b61ccbe55cc1b979ac0e8ce1
+  metadata.gz: a1081c4a7cf6dfe102749c58fdf2c83b0db061f99e27632fa106eac349b17a5beda9c221d72e43408b91e0fcacbe1a375d4ea1f6d18c201ff7b55c4424d7acc9
+  data.tar.gz: e8be655962ae38665b68f43ef7255c9638ad36d5be796011e14cde14ef766522489ec3312a16387511b67c990f0e0076f06fd87f3b8f869e83a57a6678677e37

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.0.17
+
+### Fixed
+
+- [f9d57752](https://github.com/appsignal/appsignal-ruby/commit/f9d5775217400c59a70d98e9aa96e3dcd06cb1f9) patch - Use the `log_level` option for the Ruby gem logger. Previously it only configured the extension and agent loggers. Also fixes the `debug` and `transaction_debug_mode` option if no `log_level` is configured by the app.
+
 ## 3.0.16
 
 ### Added

data/lib/appsignal/config.rb

@@ -30,7 +30,6 @@ module Appsignal
       :instrument_redis               => true,
       :instrument_sequel              => true,
       :log                            => "file",
-      :log_level                      => "info",
       :request_headers                => %w[
         HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
         HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_CONNECTION
@@ -44,6 +43,20 @@ module Appsignal
       :transaction_debug_mode         => false
     }.freeze
 
+    # @api private
+    DEFAULT_LOG_LEVEL = Logger::INFO
+    # Map from the `log_level` config option to Ruby's Logger level value.
+    #
+    # The trace level doesn't exist in the Ruby logger so it's mapped to debug.
+    # @api private
+    LOG_LEVEL_MAP = {
+      "error" => Logger::ERROR,
+      "warn" => Logger::WARN,
+      "info" => Logger::INFO,
+      "debug" => Logger::DEBUG,
+      "trace" => Logger::DEBUG
+    }.freeze
+
     ENV_TO_KEY_MAPPING = {
       "APPSIGNAL_ACTIVE"                         => :active,
       "APPSIGNAL_APP_NAME"                       => :name,
@@ -242,6 +255,18 @@ module Appsignal
       config_hash[key] = value
     end
 
+    def log_level
+      if config_hash[:debug] || config_hash[:transaction_debug_mode]
+        level = Logger::DEBUG
+      end
+      option = config_hash[:log_level]
+      if option
+        log_level_option = LOG_LEVEL_MAP[option]
+        level = log_level_option if log_level_option
+      end
+      level.nil? ? Appsignal::Config::DEFAULT_LOG_LEVEL : level
+    end
+
     def log_file_path
       path = config_hash[:log_path] || root_path && File.join(root_path, "log")
       if path && File.writable?(path)

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.0.16".freeze
+  VERSION = "3.0.17".freeze
 end

data/lib/appsignal.rb

@@ -116,12 +116,7 @@ module Appsignal
       )
 
       if config.valid?
-        logger.level =
-          if config[:debug]
-            Logger::DEBUG
-          else
-            Logger::INFO
-          end
+        logger.level = config.log_level
         if config.active?
           logger.info "Starting AppSignal #{Appsignal::VERSION} "\
             "(#{$PROGRAM_NAME}, Ruby #{RUBY_VERSION}, #{RUBY_PLATFORM})"
@@ -230,12 +225,11 @@ module Appsignal
       end
 
       logger.level =
-        if config && config[:debug]
-          Logger::DEBUG
+        if config
+          config.log_level
         else
-          Logger::INFO
+          Appsignal::Config::DEFAULT_LOG_LEVEL
         end
-
       logger << @in_memory_log.string if @in_memory_log
     end
 

data/spec/lib/appsignal/config_spec.rb

@@ -171,7 +171,6 @@ describe Appsignal::Config do
         :instrument_redis               => true,
         :instrument_sequel              => true,
         :log                            => "file",
-        :log_level                      => "info",
         :name                           => "TestApp",
         :push_api_key                   => "abc",
         :request_headers                => [],
@@ -787,4 +786,83 @@ describe Appsignal::Config do
       end
     end
   end
+
+  describe "#log_level" do
+    let(:options) { {} }
+    let(:config) { described_class.new("", nil, options) }
+    subject { config.log_level }
+
+    context "without any config" do
+      it "returns info by default" do
+        is_expected.to eq(Logger::INFO)
+      end
+    end
+
+    context "with debug set to true" do
+      let(:options) { { :debug => true } }
+      it { is_expected.to eq(Logger::DEBUG) }
+    end
+
+    context "with transaction_debug_mode set to true" do
+      let(:options) { { :transaction_debug_mode => true } }
+      it { is_expected.to eq(Logger::DEBUG) }
+    end
+
+    context "with log_level set to error" do
+      let(:options) { { :log_level => "error" } }
+      it { is_expected.to eq(Logger::ERROR) }
+    end
+
+    context "with log_level set to warn" do
+      let(:options) { { :log_level => "warn" } }
+      it { is_expected.to eq(Logger::WARN) }
+    end
+
+    context "with log_level set to info" do
+      let(:options) { { :log_level => "info" } }
+      it { is_expected.to eq(Logger::INFO) }
+    end
+
+    context "with log_level set to debug" do
+      let(:options) { { :log_level => "debug" } }
+      it { is_expected.to eq(Logger::DEBUG) }
+    end
+
+    context "with log_level set to trace" do
+      let(:options) { { :log_level => "trace" } }
+      it { is_expected.to eq(Logger::DEBUG) }
+    end
+
+    context "with debug and log_level set" do
+      let(:options) { { :log_level => "error", :debug => true } }
+
+      it "the log_level option is leading" do
+        is_expected.to eq(Logger::ERROR)
+      end
+    end
+
+    context "with transaction_debug_mode and log_level set" do
+      let(:options) { { :log_level => "error", :transaction_debug_mode => true } }
+
+      it "the log_level option is leading" do
+        is_expected.to eq(Logger::ERROR)
+      end
+    end
+
+    context "with log level set to an unknown value" do
+      let(:options) { { :log_level => "fatal" } }
+
+      it "prints a warning and doesn't use the log_level" do
+        is_expected.to eql(Logger::INFO)
+      end
+
+      context "with debug option set to true" do
+        let(:options) { { :log_level => "fatal", :debug => true } }
+
+        it "prints a warning and sets it to debug" do
+          is_expected.to eql(Logger::DEBUG)
+        end
+      end
+    end
+  end
 end

data/spec/lib/appsignal_spec.rb

@@ -1236,7 +1236,7 @@ describe Appsignal do
           before do
             capture_stdout(out_stream) do
               initialize_config
-              Appsignal.config[:debug] = true
+              Appsignal.config[:log_level] = "debug"
               Appsignal.start_logger
             end
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.16
+  version: 3.0.17
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack