klogger-logger 1.3.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec65c2728e6aee2870704aeb67e2224f3ffe8b94173f0dafa5e54354f9ec4737
-  data.tar.gz: 51244c5f4ab5fc54d5a9dda4aa14a1051fed37fd718b205c3bd14cf62b7d52ee
+  metadata.gz: 545977913e2a22754ceaa46726ed6c1ccaa28c4af5ff3bda20ddf76fbf0783ad
+  data.tar.gz: db4cd99e286083d70e768f659cb1446ab4d289a6ed6bbb36ae4f51000771e9ff
 SHA512:
-  metadata.gz: dab76a4af78b3684b078caf4348712637b952bd4abdc61cf73ba5bc1722feb6754b3dee5eaa4d1a49f5bf22cb86c5a30a5570861822735a64c4c379c56bfe27b
-  data.tar.gz: 0b4fe70463502a574a6e461aec57559bf26e1141ae24d1b129fb2320058fb1acba31c42979564db4e1058c42f4785034fdb586ea05a5e8b5c944c53a4c48ca20
+  metadata.gz: 30e4cb6330c169eea17379c012bca5e0b829fe06a4f2bd4597e5d7cde189c981aa514ce4e891ee7e32dcafc3391d8856db440cf759b8b8769abf51ec890f7d40
+  data.tar.gz: 39ceffeb22baa21c39f3ef2461a3e469535340e77bbb6795d59fc74078db17b813576c2f9a1df42f476e87cd16d6af295e88ecf3e83d6d047cb60accc9a4bc5f

data/README.md

@@ -78,7 +78,7 @@ logger.info { "Hello world!" }
 logger.info('Result of 1 + 1') { 1 + 1 } # Logs with a message of "Result: 2"
 ```
 
-### Loggging exceptions
+### Logging exceptions
 
 Exceptions happen and when they do, you want to know about them. Klogger provides a helper method to log exceptions. These will automatically be logged with the `error` severity.
 
@@ -135,7 +135,7 @@ Klogger.group(ip: '1.2.3.4') do
 end
 
 # If you can't use a block you can manually open and close a group but you'll need to be sure to close it
-# when you're finished.
+# when you're finished.
 group_id = Klogger.global_groups.add(ip: '1.2.3.4')
 # ... do anything that you want - everything will be tagged as appropriate
 Klogger.global_groups.pop
@@ -149,6 +149,16 @@ logger.tagged(name: 'steve') do
 end
 ```
 
+### Tagged Loggers
+
+If you wish to apply tags to a series of log entries but you don't wish to use blocks, you can create a "sub" logger which will always include those tags for all messages sent to it.
+
+```ruby
+logger = Klogger.new(:logger)
+tagged_logger = logger.create_tagged_logger(tag: 'my-tag')
+tagged_logger.info "Hello world!" # => will be tagged with tag=my-tag
+```
+
 ### Silencing
 
 Sometimes you don't want to log for a little while. You can use the `silence` method to temporarily disable logging.
@@ -187,4 +197,9 @@ end
 # Create a logger and add the destination
 logger = Klogger.new(name)
 logger.add_destination(GraylogDestination.new('graylog.example.com', 12201))
+
+# If you only want to send certain data to another block, you can do so
+logger.with_destination(other_destination) do
+  # ...
+end
 ```

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.5.0

data/lib/klogger/logger.rb

@@ -25,13 +25,18 @@ module Klogger
       go: Formatters::Go
     }.freeze
 
-    def initialize(name = nil, destination: $stdout, formatter: :go, highlight: false, include_group_ids: false,
+    def initialize(name = nil,
+                   destination: $stdout,
+                   formatter: :go,
+                   highlight: false,
+                   include_group_ids: false,
                    tags: {})
       @name = name
       @tags = tags
       @destinations = []
       @group_set = GroupSet.new
       @silenced = Concurrent::ThreadLocalVar.new { false }
+      @block_destinations = Concurrent::ThreadLocalVar.new { [] }
       @include_group_ids = include_group_ids
       super(destination)
       self.formatter = FORMATTERS[formatter].new(highlight: highlight)
@@ -39,12 +44,10 @@ module Klogger
 
     def exception(exception, message = nil, **tags)
       error(
-        **{
-          message: message,
-          exception: exception.class.name,
-          exception_message: exception.message,
-          backtrace: exception.backtrace[0, 4].join("\n")
-        }.merge(tags)
+        message: message,
+        exception: exception.class.name,
+        exception_message: exception.message,
+        backtrace: exception.backtrace[0, 4].join("\n"), **tags
       )
     end
 
@@ -96,6 +99,17 @@ module Klogger
       @destinations.delete(destination)
     end
 
+    def with_destination(destination)
+      @block_destinations.value << destination
+      yield
+    ensure
+      @block_destinations.value.delete(destination)
+    end
+
+    def create_tagged_logger(**tags)
+      TaggedLogger.new(self, **tags)
+    end
+
     private
 
     def add(severity, message = nil, progname = nil, **tags, &block)
@@ -136,7 +150,7 @@ module Klogger
     end
 
     def call_destinations(payload, group_ids)
-      @destinations.each do |destination|
+      (@destinations + @block_destinations.value).each do |destination|
         destination.call(self, payload.dup, group_ids)
       rescue StandardError => e
         # If something goes wrong in here, we don't want to break the application

data/lib/klogger/tagged_logger.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'klogger/logger'
+
+module Klogger
+  class TaggedLogger
+
+    def initialize(parent, **tags)
+      @parent = parent
+      @tags = tags
+    end
+
+    Klogger::Logger::LEVELS.each do |level|
+      define_method(level) do |message = nil, progname = nil, **tags, &block|
+        @parent.public_send(level, message, progname, **@tags.merge(tags), &block)
+      end
+    end
+
+    def exception(exception, message = nil, **tags)
+      @parent.exception(exception, message, **@tags.merge(tags))
+    end
+
+    def group(**tags, &block)
+      @parent.group(**@tags.merge(tags), &block)
+    end
+
+    def add_group(**tags)
+      @parent.add_group(**@tags.merge(tags))
+    end
+
+    def pop_group
+      @parent.pop_group
+    end
+
+    def tagged(**tags, &block)
+      @parent.tagged(**@tags.merge(tags), &block)
+    end
+
+    def silence!(&block)
+      @parent.silence!(&block)
+    end
+
+    def unsilence!(&block)
+      @parent.unsilence!(&block)
+    end
+
+    def silenced?
+      @parent.silenced?
+    end
+
+    def create_tagged_logger(**tags)
+      @parent.create_tagged_logger(**@tags.merge(tags))
+    end
+
+  end
+end

data/lib/klogger.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'klogger/logger'
+require 'klogger/tagged_logger'
 
 module Klogger
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klogger-logger
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-25 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -84,6 +84,7 @@ files:
 - lib/klogger/group_set.rb
 - lib/klogger/json_highlighter.rb
 - lib/klogger/logger.rb
+- lib/klogger/tagged_logger.rb
 - lib/klogger/version.rb
 homepage: https://github.com/krystal/klogger
 licenses:
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: A simple Ruby logger