escalating_logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '06191e9214236185a8cb64d31ee7f8a3f6148eb049b768716ea0f51ea7cf71dc'
+  data.tar.gz: 75221d84d36a1aab928014c7b37115e69671ccac4e342f46834444b9e347665c
+SHA512:
+  metadata.gz: 61fca0b72f08cc0c90bcf223ec6711eb6623da0546129fdd2f2db34fb973867577f816eb5c0c496bc56ca867fa02373f5cdb87976c8a790520f25ef34b12044e
+  data.tar.gz: 9e884465748f9727a76699cccf7ce844ccd961cdaf437425589b4683a56a8e5bfd7880f21cd4c9541d378461ddb8dfb1ae4b44dc2e19c2675263e3bd5885700f

data/lib/escalating_logger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EscalatingLogger
+  VERSION = '0.0.1'
+end

data/lib/escalating_logger.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative './escalating_logger/version'
+require 'logger'
+require 'bozos_buckets'
+
+module EscalatingLogger
+  # EscalatingLogger::Logger subclasses the standard Logger class. This
+  # subclass maintains the same API as Logger itself, so it can be used
+  # anywhere you use Logger today
+  class Logger < Logger
+    DECREASE_VERBOSITY = 1
+    INCREASE_VERBOSITY = -1
+
+    attr_accessor :min_verbosity, :max_verbosity, :initial_token_count, :refill_rate,
+                  :max_token_count, :triggering_log_levels, :bucket
+
+    # rubocop:disable Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength
+    def initialize(
+      logdev,
+      shift_age = 0,
+      shift_size = 1_048_576,
+      level:                 DEBUG,
+      progname:              nil,
+      formatter:             nil,
+      datetime_format:       nil,
+      binmode:               false,
+      shift_period_suffix: '%Y%m%d',
+      min_verbosity:         Logger::ERROR,
+      max_verbosity:         Logger::DEBUG,
+      initial_token_count:   100,
+      refill_rate:           1,
+      max_token_count:       100,
+      triggering_log_levels: [Logger::ERROR]
+    )
+
+      @triggering_log_levels = triggering_log_levels
+      @max_verbosity = max_verbosity
+      @min_verbosity = min_verbosity
+      @initial_token_count = initial_token_count
+      @refill_rate = refill_rate
+      @max_token_count = max_token_count
+
+      @bucket = BozosBuckets::Bucket.new(initial_token_count: initial_token_count,
+                                         refill_rate: refill_rate, max_token_count: max_token_count)
+
+      super(
+        logdev,
+        shift_age,
+        shift_size,
+        level: level,
+        progname: progname,
+        formatter: formatter,
+        datetime_format: datetime_format,
+        binmode: binmode,
+        shift_period_suffix: shift_period_suffix
+      )
+    end
+    # rubocop:enable Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength
+
+    # Overrides `add` method to catch all forms of invocations. See
+    # https://github.com/ruby/ruby/blob/b56c8f814e656e6a680acf2e5c96812e84af238d/lib/logger.rb#L459
+    def add(severity, message = nil, progname = nil)
+      # If severity is error/warning/whatever, check if the rate limit has
+      # been exceeded. If so, increase verbosity. If severity check is not
+      # triggered, decrease verbosity if the token bucket is full
+
+      # Check if verbosity should be increased if logger was invoked with
+      # the a triggering severity
+      if @triggering_log_levels.include?(severity)
+        # Increase verbosity if rate limit exceeded/bucket is empty
+        increase_verbosity unless @bucket.use_tokens
+      # Only attempt to decrease verbosity when the lowest severity is called
+      elsif severity == level
+        # Decrease verbosity if the bucket is full
+        decrease_verbosity if @bucket.current_token_count == @bucket.max_token_count
+      end
+
+      # Call the superclass method with the same signature
+      super
+    end
+
+    private
+
+    def increase_verbosity
+      change_verbosity(INCREASE_VERBOSITY)
+    end
+
+    def decrease_verbosity
+      change_verbosity(DECREASE_VERBOSITY)
+    end
+
+    # Negative values increase verbosity, positive values decrease verbosity
+    def change_verbosity(value)
+      current_level = level
+      reset_bucket
+      case value
+      when DECREASE_VERBOSITY
+        next_level = [current_level + 1, @min_verbosity].min
+      when INCREASE_VERBOSITY
+        next_level = [current_level - 1, @max_verbosity].max
+      end
+      self.level = next_level
+    end
+
+    # After changing verbosity, the bucket should be reset. Otherwise
+    # verbosity will change levels very quickly, instead of gradually as
+    # the rate limit is continually exceeded. Note that the bucket is reset
+    # using the attributes on the EscalatingLogger::Logger instance (e.g.
+    # initial_token_count)
+    def reset_bucket
+      @bucket = BozosBuckets::Bucket.new(initial_token_count: @initial_token_count,
+                                         refill_rate: @refill_rate, max_token_count: @max_token_count)
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: escalating_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Glover
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bozos_buckets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.w
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.w
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+        A transparent subclass of Ruby's Logger that automatically increases log verbosity
+        as the number of ERRORs logged exceeds a given rate threshold. The intent is to get
+        more log detail when things are going wrong, and less log noise when everything is
+        going right.
+email:
+- alexdglover@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/escalating_logger.rb
+- lib/escalating_logger/version.rb
+homepage: https://github.com/alexdglover/escalating_logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alexdglover/escalating_logger
+  source_code_uri: https://github.com/alexdglover/escalating_logger
+  changelog_uri: https://github.com/alexdglover/escalating_logger/tree/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Ruby Logger subclass that automatically increases/decreases verbosity
+test_files: []