quiet_logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ae7192146de8bb704c786f4c129dc33b3eece9d1c0b6e0fdb417274c70eb25d
+  data.tar.gz: c7c8971f79e92aede026a7e36ebfea13ff329062c85598e999017c60e5978ef2
+SHA512:
+  metadata.gz: 7f5057c20db5903f1f97c620e892074ab1cfcf3dc4aa53f88b62c514a41c722593f0fd36205350c62e5e86eadac606d632629d1c62a91e297a300138e2cb8593
+  data.tar.gz: a2e71f9d7c810866e316f93c0b0dec3f88e95fddaa78be5b80891e627eab4f0989a7908697fe8f7aee6edaca12b354e7b1dcff61b15ac33cd854ad8dfb85a048

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.0.0
+
+### Added
+- Add QuietLogger class to wrap other loggers but with a higher severity level to quiet their output.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Brian Durand
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+[![Continuous Integration](https://github.com/bdurand/quiet_logger/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/quiet_logger/actions/workflows/continuous_integration.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+
+# QuietLogger
+
+This gem provides a mechanism for wrapping a instance of `Logger` with one that produces a less verbose output.
+
+This can be used in situations where different parts of an application should produce different levels of output to the logs. A classic example is when using a framework that produces a lot of low value log output. You can normally control this by changing the log level, but that can impact other parts of your application sharing the same logger.
+
+For example, in a Rails application ActionCable can log a lot of information to the logs with a severity level of `INFO`. This can produce an excessive amount of output which can bury more important information in the logs. However, increasing the log level would end up turning off info logs for the entire application.
+
+You could override the logger to use one with a higher log level, but this requires you to reinitialize the logger with any customiziation you made to it for your application (i.e. output device, format, etc.). With QuietLogger, you can just re-use the logger that has already been defined:
+
+```ruby
+ActionCable.server.config.logger = QuietLogger.new(Rails.logger, level: :warn)
+```
+
+Now all the log messages will still go to the same logger, but with only `WARN` and higher messages from ActionCable.
+
+## Usage
+
+```ruby
+verbose_logger = Logger.new(STDOUT, level: :debug)
+quiet_logger = QuietLogger.new(verbose_logger, level: :warn)
+
+verbose_logger.debug("hello")       # This is logged
+quiet_logger.debug("hello again")   # This is not logged since the level must be "warn" or higher
+quiet_logger.warn("one more time")  # This is logged since the level is warn
+
+even_quieter_logger = QuietLogger.new(verbose_logger, level: :error)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "quiet_logger"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install quiet_logger
+```
+
+## Contributing
+
+Open a pull request on GitHub.
+
+Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/quiet_logger.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "logger"
+
+# Wrap a Logger in a quieter instance that can have a higher severity level filter.
+#
+# Usage:
+#
+# ```
+# logger = Logger.new(STDOUT)
+# quiet_logger = QuietLogger.new(logger)
+#
+# logger.debug("Stuff")            # This statement is logged
+# quiet_logger.debug("More stuff") # This statement is not logged
+# quiet_logger.warn("Other stuff") # This statement logged
+# ```
+#
+# By default the quiet log level is "warn", but you can change to an even higher level:
+#
+# ```
+# QuietLogger.new(logger, level: :error)
+# ```
+#
+# The log level on the `QuietLogger` can only be made more restrictive than the level on the
+# underlying logger. So, if the underlying logger has a level of "info", you cannot set the
+# `QuietLogger` to "debug".
+class QuietLogger < Logger
+  # Wrap a logger to have a higher log level.
+  def initialize(logger, level: Logger::WARN)
+    @logger = logger
+    self.level = level
+  end
+
+  # @return [Integer] Returns the log level
+  def level
+    [@level, @logger.level].max
+  end
+
+  # @api private
+  def add(severity, message = nil, progname = nil, &block)
+    severity ||= UNKNOWN
+    if severity < level
+      return true
+    end
+    @logger.add(severity, message, progname, &block)
+  end
+  alias_method :log, :add
+
+  # @api private
+  def <<(msg)
+    @logger << msg
+  end
+
+  # @api private
+  def close
+    # no-op
+  end
+
+  # @api private
+  def reopen(logdev = nil)
+    # no-op
+  end
+end

data/quiet_logger.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |spec|
+  spec.name = "quiet_logger"
+  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
+
+  spec.summary = "A logger implementation that can wrap another logger to increase the log level to reduce noise in the logs."
+  spec.homepage = "https://github.com/bdurand/quiet_logger"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  ignore_files = %w[
+    .
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    bin/
+    gemfiles/
+    spec/
+  ]
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+
+  spec.required_ruby_version = ">= 2.5"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: quiet_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- VERSION
+- lib/quiet_logger.rb
+- quiet_logger.gemspec
+homepage: https://github.com/bdurand/quiet_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A logger implementation that can wrap another logger to increase the log
+  level to reduce noise in the logs.
+test_files: []