klogger-logger 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 721caa676f9ec6ff59d0faa7823f40b63c9ca1fbcde1ac017e19c0f809000574
-  data.tar.gz: '0686ea87fa8f6f86a79b599ed11009061608adcf2884069381fad7f4b6a69d4e'
+  metadata.gz: eb61b7c35a079dfda06d125ae652fd71d78b994f710aafaf687eb177ec822b8d
+  data.tar.gz: b837d26cf1f5d59833a01e6b4c547e5ab05c60f1b23e464c894255010679102b
 SHA512:
-  metadata.gz: 594e56869cb217f308d49e1d5ab5a6669b6c69cb617e64f853a357fd8a30b8d2fc88803157cf54bb7ee9e12641ab2264fab364d7e57f5814c712bbdeb8238805
-  data.tar.gz: 737f6c90d84067dbb1f6697f5f3c6466c83ebc5d1dd3054481b4397bf40737705b4a345d9901fb923768e28374615c0c428f113beb113d3d56785edcedd4de5c
+  metadata.gz: d421b706f0460136f38f1219053ce0b2aa55f9bf1c972113c75eaf3caa8a82f1cec798f1558226f6e9bac9fff13d2cb82a44d387d76d3aa45c5a85aa0cdce3cf
+  data.tar.gz: 5a2eae41db68d08a53fb92e7118ffe1617a34588dffaf037867d0885e099956900cf0c96252b9f9739992639ee628dc220c7d7bf6e7e678dee2f63c39867c652

data/lib/klogger/logger.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'securerandom'
 require 'klogger/formatters/json'
 require 'klogger/formatters/simple'
 require 'klogger/formatters/go'
+require 'concurrent/atomic/thread_local_var'
 
 module Klogger
   class Logger < ::Logger
 
     attr_reader :name
     attr_reader :destinations
-    attr_reader :extra
+    attr_reader :tags
 
     LEVELS = [:debug, :info, :warn, :error, :fatal].freeze
     FORMATTERS = {
@@ -19,51 +21,54 @@ module Klogger
       go: Formatters::Go
     }.freeze
 
-    def initialize(name, destination: $stdout, formatter: :json, highlight: false, extra: {})
+    def initialize(name, destination: $stdout, formatter: :json, highlight: false, include_group_ids: false, tags: {})
       @name = name
-      @extra = extra
+      @tags = tags
       @destinations = []
+      @groups = Concurrent::ThreadLocalVar.new { [] }
+      @silenced = Concurrent::ThreadLocalVar.new { false }
+      @include_group_ids = include_group_ids
 
       super(destination)
       self.formatter = FORMATTERS[formatter].new(highlight: highlight)
     end
 
-    def exception(exception, message = nil, **additional)
+    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(additional))
+              backtrace: exception.backtrace[0, 4].join("\n") }.merge(tags))
     end
 
     LEVELS.each do |level|
-      define_method(level) do |message = nil, progname = nil, **additional, &block|
-        add(Logger.const_get(level.to_s.upcase), message, progname, **additional, &block)
+      define_method(level) do |message = nil, progname = nil, **tags, &block|
+        add(Logger.const_get(level.to_s.upcase), message, progname, **tags, &block)
       end
     end
 
-    def group(**additional)
-      groups << additional
+    def group(**tags)
+      @groups.value += [{ id: SecureRandom.hex(4), tags: tags }]
       yield
     ensure
-      groups.pop
+      @groups.value.pop
     end
 
     def silence!
-      @silence = true
+      @silenced.value = true
       yield if block_given?
     ensure
       unsilence! if block_given?
     end
 
     def unsilence!
-      @silence = false
+      @silenced.value = false
       yield if block_given?
     ensure
       silence! if block_given?
     end
 
     def silenced?
-      @silence == true
+      @silenced.value == true
     end
 
     def add_destination(destination)
@@ -76,33 +81,26 @@ module Klogger
 
     private
 
-    def groups
-      @groups ||= []
-    end
-
-    def add(severity, message = nil, progname = nil, **extra, &block)
+    def add(severity, message = nil, progname = nil, **tags, &block)
       return if silenced?
 
       severity ||= Logger::UNKNOWN
       return if severity < level
 
-      payload = create_payload(severity, message, extra)
-
-      @destinations.each do |destination|
-        destination.call(self, payload.dup)
-      rescue StandardError => e
-        # If something goes wrong in here, we don't want to break the application
-        # so we will rescue that and we'll just use standard warn.
-        Kernel.warn "Error while sending payload to destination (#{e.class}): #{e.message}"
+      if message && block_given?
+        message = "#{message}: #{block.call}"
+      elsif block_given?
+        message = block.call
       end
 
+      payload, group_ids = create_payload(severity, message, tags)
+      call_destinations(payload, group_ids)
       super(severity, payload, progname, &block)
     end
 
-    # rubocop:disable Metrics/AbcSize
-    def create_payload(severity, message, extra)
+    def create_payload(severity, message, tags)
       payload = { time: Time.now.to_s, severity: LEVELS[severity]&.to_s, logger: @name }
-      payload.merge!(@extra)
+      payload.merge!(@tags)
 
       if message.is_a?(Hash)
         payload.merge!(message)
@@ -110,14 +108,35 @@ module Klogger
         payload[:message] = message
       end
 
-      payload.merge!(extra)
+      payload.merge!(tags)
       payload.delete(:message) if payload[:message].nil?
       payload.compact!
 
-      groups.each { |group| payload.merge!(group) }
-      payload
+      group_ids = add_groups_to_payload(payload)
+
+      [payload, group_ids]
+    end
+
+    def call_destinations(payload, group_ids)
+      @destinations.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
+        # so we will rescue that and we'll just use standard warn.
+        Kernel.warn "Error while sending payload to destination (#{e.class}): #{e.message}"
+      end
+    end
+
+    def add_groups_to_payload(payload)
+      group_ids = []
+      @groups.value.each do |group|
+        payload.merge!(group[:tags])
+        group_ids << group[:id]
+      end
+
+      payload[:groups] = group_ids.join(',') if @include_group_ids
+      group_ids
     end
-    # rubocop:enable Metrics/AbcSize
 
   end
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: klogger-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement