on_strum-logs 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 631e24b1bfbfe68706b9ff96ccb0a4db7275e73c4ef74ec33b395f4b26cefc7e
-  data.tar.gz: e220ed192fac45ddb61c9faa49cc9981da28bec964eb259f79934141dfcdf2de
+  metadata.gz: 99be5f9f716a2f741e7707f7452d25f2c93de108427156d162a840740c802210
+  data.tar.gz: bcfac9e566a8792d127a4c96d0a8c1e91462572095433bd13b85f102d5462653
 SHA512:
-  metadata.gz: 171bc63a8c00b0090ab194e909deae8df6430f007c7dd4ca8fad11b04a8b78f9d8fb6038bf7c112ad59caa731fc732af9214c9404fba114ccecb0c0290dea060
-  data.tar.gz: 47814455011e5e03e4dc8385db18bc5ce16b42ca26e005c50e173082448b11a29e5c866716a3e5b21f0edc73c6ac2a3739dc766fdef83e2f97907551300eeb7d
+  metadata.gz: 91c6788b1bb58b0a5880219f6f65ce467e0c311d9aa77e94f2c211a72549ccdb82e20b476caf095173c036c88549c17c6ed5c194e235cf7784f30e7c27799d00
+  data.tar.gz: 0bde444c6e7be135857608604de67ae1cfcf30cbb1c9fb2029055f50ac0da4dc2628911cd356f336de9b0f79d0279f7237b6d1f64d2fefd7251aad8abc83b380

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022-2023 onStrum and friends
+Copyright (c) 2022-2024 onStrum and friends
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/on_strum/logs/configuration.rb

@@ -4,17 +4,29 @@ module OnStrum
   module Logs
     class Configuration
       INCOMPLETE_CONFIG = 'service_name, service_version are required parameters'
-      SETTERS = %i[custom_formatter service_name service_version].freeze
+      SETTERS = %i[
+        custom_formatter
+        service_name
+        service_version
+        field_name_level
+        field_name_time
+        field_name_message
+        field_name_context
+        field_name_exception_message
+        field_name_exception_stack_trace
+      ].freeze
+      BUILTIN_FIELDS_DEFAULT_NAMES = %i[level time message context stack_trace].freeze
 
       attr_reader(*OnStrum::Logs::Configuration::SETTERS)
       attr_accessor :detailed_formatter
 
       def initialize(&block)
+        instance_initializer.each { |instace_variable, value| instance_variable_set(:"@#{instace_variable}", value) }
         tap(&block) if block
       end
 
       OnStrum::Logs::Configuration::SETTERS.each do |method|
-        define_method("#{method}=") do |argument|
+        define_method(:"#{method}=") do |argument|
           raise_unless(argument, __method__, valid_argument_type?(method, argument))
           instance_variable_set(:"@#{method}", argument)
         end
@@ -28,12 +40,32 @@ module OnStrum
         custom_formatter || builded_formatter
       end
 
+      # TODO: hardcoded fields will be removed in next release
+      def log_attributes_order
+        @log_attributes_order ||= OnStrum::Logs::Configuration::SETTERS[3..6].map do |field_name_getter|
+          public_send(field_name_getter)
+        end + %i[service_name service_version]
+      end
+
       private
 
+      def instance_initializer
+        message_key = OnStrum::Logs::Configuration::BUILTIN_FIELDS_DEFAULT_NAMES[2]
+        {
+          field_name_level: OnStrum::Logs::Configuration::BUILTIN_FIELDS_DEFAULT_NAMES[0],
+          field_name_time: OnStrum::Logs::Configuration::BUILTIN_FIELDS_DEFAULT_NAMES[1],
+          field_name_message: message_key,
+          field_name_context: OnStrum::Logs::Configuration::BUILTIN_FIELDS_DEFAULT_NAMES[3],
+          field_name_exception_message: message_key,
+          field_name_exception_stack_trace: OnStrum::Logs::Configuration::BUILTIN_FIELDS_DEFAULT_NAMES[4]
+        }
+      end
+
       def valid_argument_type?(method_name, argument)
         argument.is_a?(
           case method_name
           when :service_name, :service_version then ::String
+          when *OnStrum::Logs::Configuration::SETTERS[3..-1] then ::Symbol
           when :custom_formatter then ::Class
           end
         )

data/lib/on_strum/logs/formatter/base.rb

@@ -5,10 +5,9 @@ module OnStrum
     module Formatter
       class Base
         DATETIME_FORMAT = '%FT%T.%3N%:z'
-        LOG_ATTRIBUTES_ORDER = %i[level time message context service_name service_version].freeze
 
         def self.arrange_attrs(**log_data)
-          OnStrum::Logs::Formatter::Base::LOG_ATTRIBUTES_ORDER.each_with_object({}) do |attribute, arranged_attrs|
+          OnStrum::Logs.configuration.log_attributes_order.each_with_object({}) do |attribute, arranged_attrs|
             arranged_attrs[attribute] = log_data[attribute]
           end
         end

data/lib/on_strum/logs/formatter/json.rb

@@ -6,10 +6,11 @@ module OnStrum
       class Json < Base
         require 'json'
 
-        def self.call(time:, **log_data)
+        def self.call(**log_data)
+          time_key = OnStrum::Logs.configuration.field_name_time
           json_log = arrange_attrs(
-            time: time.strftime(OnStrum::Logs::Formatter::Base::DATETIME_FORMAT),
-            **log_data
+            **log_data,
+            time_key => log_data[time_key].strftime(OnStrum::Logs::Formatter::Base::DATETIME_FORMAT)
           ).to_json
 
           "#{json_log}\n"

data/lib/on_strum/logs/logger/default.rb

@@ -20,7 +20,10 @@ module OnStrum
 
             # TODO: we need to have ability to process log data before render it to STDOUT/STDERR
             # hash_normalizer(arg); after_callback.call(arg)
-            logger.public_send(method_name, hash_normalizer(arg).merge(level: method_name.to_s.upcase))
+            logger.public_send(
+              method_name,
+              hash_normalizer(arg).merge(configuration.field_name_level => method_name.to_s.upcase)
+            )
           end
         end
 
@@ -35,7 +38,7 @@ module OnStrum
         def formatter
           @formatter ||= proc do |_severity, datetime, _progname, log_data|
             configuration.formatter.call(
-              time: datetime,
+              configuration.field_name_time => datetime,
               service_name: configuration.service_name,
               service_version: configuration.service_version,
               **log_data
@@ -44,20 +47,22 @@ module OnStrum
         end
 
         def hash_normalizer(object)
+          message_key, context_key = configuration.field_name_message, configuration.field_name_context
+
           case object
           when ::Hash
-            raise OnStrum::Logs::Error::Logger unless object.key?(:message)
+            raise OnStrum::Logs::Error::Logger unless object.key?(message_key)
 
-            { message: object.delete(:message), context: (object.empty? ? nil : object) }
+            { message_key => object.delete(message_key), context_key => (object.empty? ? nil : object) }
           when ::Exception
             {
-              message: "Exception: #{object.class}",
-              context: {
-                message: object.message,
-                stack_trace: object.backtrace
+              message_key => "Exception: #{object.class}",
+              context_key => {
+                configuration.field_name_exception_message => object.message,
+                configuration.field_name_exception_stack_trace => object.backtrace
               }
             }
-          else { message: object.to_s, context: nil }
+          else { message_key => object.to_s, context_key => nil }
           end
         end
       end

data/lib/on_strum/logs/version.rb

@@ -2,6 +2,6 @@
 
 module OnStrum
   module Logs
-    VERSION = '0.1.1'
+    VERSION = '0.3.0'
   end
 end

data/on_strum-logs.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors     = ['Vladislav Trotsenko']
   spec.email       = %w[admin@on-strum.org]
 
-  spec.summary     = %(on_strum-logs)
-  spec.description = %(Simple structured logger)
+  spec.summary     = %(Simple structured logger)
+  spec.description = %(Simple structured logger.)
 
   spec.homepage    = 'https://github.com/on-strum/ruby-on-strum-logs'
   spec.license     = 'MIT'
@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'ffaker', '~> 2.21'
   spec.add_development_dependency 'json_matchers', '~> 0.11.1'
-  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
-  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rake', '~> 13.1'
+  spec.add_development_dependency 'rspec', '~> 3.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: on_strum-logs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -58,35 +58,29 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
-description: Simple structured logger
+        version: '3.13'
+description: Simple structured logger.
 email:
 - admin@on-strum.org
 executables: []
@@ -137,5 +131,5 @@ requirements: []
 rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
-summary: on_strum-logs
+summary: Simple structured logger
 test_files: []