on_strum-logs 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 707d72443b6cdcfb8fcdfda542d7f04ed7cc4d6e50db124463956e5f5a5fa949
-  data.tar.gz: eaa1485b5dc0e96759cf14f676004d94dd3ffec176368277655e4d6c5d858837
+  metadata.gz: 2ecbe6a25ee37ba18625810f3c21d555a0b5ae11a35883167438e4368576311e
+  data.tar.gz: d6604a0734775516a73bcc5a5ffbe63f9741cf86f40f69e5e2a6d3a3b47aba3b
 SHA512:
-  metadata.gz: 07c7c79f133d3a073722e12d1a71a5a211a87d6602e5d0d63d2aa29a573f3a9f0d63c7052a70cbc17aeea295456b431b056b8a2c12a67b52eabd0b2360731065
-  data.tar.gz: 31b8c66623c02f97afe291e6ec8ee5bf484e2e2bb217c016624d2a83cf4479df43e74d13ad3d20db1d38e420a9770d25b593901093ffe0b409b6a44b8e458827
+  metadata.gz: '01390b62cd01dd39b8f49d0cf3d60a5e557cc37b6ef3543274f49173d25e1bb4666a04d3c89bd018f1d65a727e7c394fe8326642b763843c9b9adcc753c59114'
+  data.tar.gz: 645e4a74b4130d79400a49d7b75d73fcebccbff71a7d80b7a45545e364a411836554c747949f5b6ecb52b34ce2c7380b08872694ad1b8e3fbf99e4aeb3323322

data/lib/on_strum/logs/configuration.rb

@@ -3,13 +3,23 @@
 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
+        root_fields
+        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
 
@@ -20,21 +30,37 @@ module OnStrum
         end
       end
 
-      def complete?
-        !!(service_name && service_version)
-      end
-
       def formatter
         custom_formatter || builded_formatter
       end
 
+      def log_attributes_order
+        @log_attributes_order ||= OnStrum::Logs::Configuration::SETTERS[2..5].map do |field_name_getter|
+          public_send(field_name_getter)
+        end + root_fields.keys
+      end
+
       private
 
+      def instance_initializer
+        message_key = OnStrum::Logs::Configuration::BUILTIN_FIELDS_DEFAULT_NAMES[2]
+        {
+          root_fields: {},
+          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[2..-1] then ::Symbol
           when :custom_formatter then ::Class
+          when :root_fields then ::Hash
           end
         )
       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,29 +38,30 @@ module OnStrum
         def formatter
           @formatter ||= proc do |_severity, datetime, _progname, log_data|
             configuration.formatter.call(
-              time: datetime,
-              service_name: configuration.service_name,
-              service_version: configuration.service_version,
+              configuration.field_name_time => datetime,
+              **configuration.root_fields,
               **log_data
             )
           end
         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.2.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/on_strum/logs.rb

@@ -9,10 +9,7 @@ module OnStrum
         @configuration ||= begin
           return unless block
 
-          configuration = OnStrum::Logs::Configuration.new(&block)
-          raise OnStrum::Logs::Error::Configuration, OnStrum::Logs::Configuration::INCOMPLETE_CONFIG unless configuration.complete?
-
-          configuration
+          OnStrum::Logs::Configuration.new(&block)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: on_strum-logs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-05 00:00:00.000000000 Z
+date: 2024-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print