Merge pull request #26 from on-strum/develop

OnStrum::Logs v1.0.0

Author: bestwebua

.circleci/gemspecs/latest

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.1'
   spec.add_development_dependency 'reek', '~> 6.3'
   spec.add_development_dependency 'rspec', '~> 3.13'
-  spec.add_development_dependency 'rubocop', '~> 1.61'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.20', '>= 1.20.2'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.27', '>= 2.27.1'
+  spec.add_development_dependency 'rubocop', '~> 1.62', '>= 1.62.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.21'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.28'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'
 end

.codeclimate.yml

@@ -9,7 +9,7 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: rubocop-1-61
+    channel: rubocop-1-62
     config:
       file: .circleci/linter_configs/.rubocop.yml
 

CHANGELOG.md

@@ -2,21 +2,53 @@
 
 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] - 2024-03-31
+
+### Added
+
+- Added ability to define static fields in the logger document root
+
+```ruby
+OnStrum::Logs.configure do |config|
+  # Optional parameter. Ability to define static fields in the logger document root.
+  # It is equal to empty hash by default.
+  config.root_fields = {
+    service_name: 'My Great Application',
+    service_version: '1.42.0'
+  }
+```
+
+### Changed
+
+- Changed `OnStrum::Logs.configure`, tests
+- Changed `OnStrum::Logs::Configuration`, tests
+- Changed `OnStrum::Logs::Logger::Default`, tests
+- Changed `OnStrum::Logs::RspecHelper::Configuration`, tests
+- Changed `OnStrum::Logs::RspecHelper::ContextGenerator`, tests
+- Changed RSpec helpers
+- Changed gem development dependencies
+- Changed gem documentation
+
+### Removed
+
+- Removed `service_name`, `service_version` required configuration options
+- Removed `OnStrum::Logs::RspecHelper::Configuration#complete?`
+
 ## [0.3.0] - 2024-03-10
 
 ### Added
 
 - Added ability to configure builtin attribute key names
 
-### Updated
+### Changed
 
-- Updated `OnStrum::Logs::Configuration`, tests
-- Updated `OnStrum::Logs::Logger::Default`, tests
-- Updated `OnStrum::Logs::Formatter::Base`, tests
-- Updated `OnStrum::Logs::Formatter::Json`, tests
-- Updated `OnStrum::Logs::RspecHelper::Configuration`, tests
-- Updated `OnStrum::Logs::RspecHelper::ContextGenerator`, tests
-- Updated gem documentation
+- Changed `OnStrum::Logs::Configuration`, tests
+- Changed `OnStrum::Logs::Logger::Default`, tests
+- Changed `OnStrum::Logs::Formatter::Base`, tests
+- Changed `OnStrum::Logs::Formatter::Json`, tests
+- Changed `OnStrum::Logs::RspecHelper::Configuration`, tests
+- Changed `OnStrum::Logs::RspecHelper::ContextGenerator`, tests
+- Changed gem documentation
 
 ## [0.2.0] - 2024-03-05
 
@@ -25,23 +57,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Added Ruby 3.3 support
 - Added `commitspell` linter
 
-### Updated
+### Changed
 
-- Updated gem development dependencies
-- Updated gem documentation, license
+- Changed gem development dependencies
+- Changed gem documentation, license
 
 ## [0.1.1] - 2023-10-18
 
 ### Fixed
 
 - Fixed gem class loading
 
-### Updated
+### Changed
 
-- Updated gem documentation
+- Changed gem documentation
 
 ## [0.1.0] - 2023-10-15
 
 ### Added
 
-- First release of `on_strum-logs`.
+- Added first release of `on_strum-logs`.

README.md

@@ -1,4 +1,4 @@
-# `on_strum-logs` - Simple structured logger
+# ![OnStrum::Logs - Simple configurable structured logger with JSON formatter out of the box](https://repository-images.githubusercontent.com/703974267/64869920-5005-490e-9e5d-90b49ba59f25)
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/2f4acd0ca4da58ca3b1e/maintainability)](https://codeclimate.com/github/on-strum/ruby-on-strum-logs/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/2f4acd0ca4da58ca3b1e/test_coverage)](https://codeclimate.com/github/on-strum/ruby-on-strum-logs/test_coverage)
@@ -73,11 +73,12 @@ To start working with this gem, you must configure it first as in the example be
 require 'on_strum/logs'
 
 OnStrum::Logs.configure do |config|
-  # Required parameter. Current service name.
-  config.service_name = 'My Great Application'
-
-  # Required parameter. Current service version.
-  config.service_version = '1.42.0'
+  # Optional parameter. Ability to define static fields in the logger document root.
+  # It is equal to empty hash by default.
+  config.root_fields = {
+    service_name: 'My Great Application',
+    service_version: '1.42.0'
+  }
 
   # Optional parameter. The colorized structured log in STDOUT. It could be useful
   # for debug mode.
@@ -211,8 +212,10 @@ For view detailed colorized logs you can use configuration option `detailed_form
 require 'on_strum/logs'
 
 OnStrum::Logs.configure do |config|
-  config.service_name = 'My Great Application'
-  config.service_version = '1.42.0'
+  config.root_fields = {
+    service_name: 'My Great Application',
+    service_version: '1.42.0'
+  }
   config.detailed_formatter = true
 end
 

lib/on_strum/logs.rb

@@ -9,10 +9,7 @@ def configuration(&block)
         @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
 

lib/on_strum/logs/configuration.rb

@@ -3,11 +3,9 @@
 module OnStrum
   module Logs
     class Configuration
-      INCOMPLETE_CONFIG = 'service_name, service_version are required parameters'
       SETTERS = %i[
         custom_formatter
-        service_name
-        service_version
+        root_fields
         field_name_level
         field_name_time
         field_name_message
@@ -32,26 +30,22 @@ def initialize(&block)
         end
       end
 
-      def complete?
-        !!(service_name && service_version)
-      end
-
       def formatter
         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|
+        @log_attributes_order ||= OnStrum::Logs::Configuration::SETTERS[2..5].map do |field_name_getter|
           public_send(field_name_getter)
-        end + %i[service_name service_version]
+        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,
@@ -64,9 +58,9 @@ def instance_initializer
       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 *OnStrum::Logs::Configuration::SETTERS[2..-1] then ::Symbol
           when :custom_formatter then ::Class
+          when :root_fields then ::Hash
           end
         )
       end

lib/on_strum/logs/logger/default.rb

@@ -39,8 +39,7 @@ def formatter
           @formatter ||= proc do |_severity, datetime, _progname, log_data|
             configuration.formatter.call(
               configuration.field_name_time => datetime,
-              service_name: configuration.service_name,
-              service_version: configuration.service_version,
+              **configuration.root_fields,
               **log_data
             )
           end

lib/on_strum/logs/version.rb

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