loggun 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64690d6ecfdadf2c32a49d2a688de83dfd2ea90a22e8c87e24544fd6c025100a
-  data.tar.gz: 428175cd75ee0bef72c3c74450df4c69069a37997794a253a86147883e7d14db
+  metadata.gz: 3a78f3c782857269e283aa2f00ef6f5a2002e57c1e0d2fe5d43284a54d5aa106
+  data.tar.gz: fb9d8dad64af86d1f43c510dc34c1fd3acb9a515441315973ab0a5b72d493099
 SHA512:
-  metadata.gz: e680f49877dcb8418b3653c38ec42187ba17050ba58ac061d383ca9e3cf836d6739f7ae111ec9a7352b8d9ea721a1b4e09ad4d91bb022c6d61b2ff6bacdd4d5f
-  data.tar.gz: 0e5e5cedcdd59e80c71979a4ae90f87a59b76565b4e02754a2b3c35d1bd264ce8e619330b4944e6035e524ff26e56ba65be0c30b3f71114b7f29d2f84be629cb
+  metadata.gz: e0d93bbbe8ed26b5c5decc4d88c16876d4db185d5ae415b07fb47a23848149183e56fb0be6128f8c321410d205d19778228888f9cdb7ce57414ba29c380f22db
+  data.tar.gz: '08d78b02426b5b3da9a31b90bf3715c9728de0eaeb40ed9d5b55ccfeab76c3e241146fcdaa9f052b11ee233a40fdb07e68be5f33ff4a104467cbd08b959fe07a'

data/README.md

@@ -49,6 +49,7 @@ Loggun::Config.configure do |config|
   config.precision = :milliseconds
   config.pattern = '%{time} - %{pid} %{severity} %{type} %{tags_text} %{message}'
   config.parent_transaction_to_message = false
+  config.message_format = :json
 
   config.modifiers.rails = true
   config.modifiers.sidekiq = false
@@ -64,6 +65,9 @@ end
 Доступные ключи: `time`, `pid`, `severity`, `type`, `tags_text`, `message`, `parent_transaction`
 - `parent_transaction_to_message` - признак необходимости добавлять значение `parent_transaction` в тело логируемого сообщения. 
 Вне зависимости от данной настройки можно использовать ключ `parent_transaction` в шаблоне `pattern`. 
+- `message_format` - формат переменной message в шаблоне pattern. Доступны два формата: 
+  - `:json` - `message` логгируется как json строка
+  - `:key_value` - `message` логгируется в формате `key1=value1 key2=value2` 
 - `modifiers` - модификаторы для переопределения формата логирования указанного компонента. См. далее.
 
 #### Модификаторы

data/lib/loggun/config.rb

@@ -8,6 +8,7 @@ module Loggun
     DEFAULTS = {
       pattern: '%{time} - %{pid} %{severity} %{type} %{tags_text} %{message}',
       parent_transaction_to_message: true,
+      message_format: :json,
       precision: :milliseconds,
       incoming_http: {
         controllers: %w[ApplicationController],
@@ -20,11 +21,13 @@ module Loggun
       }
     }.freeze
     DEFAULT_MODIFIERS = %i[rails active_record sidekiq clockwork outgoing_http].freeze
+    MESSAGE_FORMATS = %i[json key_value].freeze
 
     attr_accessor(
       :formatter,
       :pattern,
       :parent_transaction_to_message,
+      :message_format,
       :precision,
       :modifiers,
       :custom_modifiers
@@ -35,6 +38,7 @@ module Loggun
       @precision = DEFAULTS[:precision]
       @pattern = DEFAULTS[:pattern]
       @parent_transaction_to_message = DEFAULTS[:parent_transaction_to_message]
+      @message_format = DEFAULTS[:message_format]
       @modifiers = Loggun::OrderedOptions.new
       @custom_modifiers = []
       set_default_modifiers
@@ -44,6 +48,7 @@ module Loggun
       def configure(&block)
         block.call(instance)
         use_modifiers
+        check_config
         instance
       end
 
@@ -59,6 +64,12 @@ module Loggun
         instance.custom_modifiers.each(&:use)
       end
 
+      def check_config
+        return if MESSAGE_FORMATS.include? instance.message_format
+
+        raise FailureConfiguration, 'Unknown value for message_format'
+      end
+
       def setup_formatter(app, formatter = nil)
         Loggun.logger = app.logger
         Loggun.logger.formatter = formatter || instance.formatter
@@ -91,5 +102,7 @@ module Loggun
         3 # milliseconds
       end
     end
+
+    class FailureConfiguration < StandardError; end
   end
 end

data/lib/loggun/formatter.rb

@@ -14,7 +14,7 @@ module Loggun
         if config.parent_transaction_to_message && parent_transaction
           message[:parent_transaction] = parent_transaction
         end
-        message = JSON.generate(message)
+        message = format_message(message)
       end
 
       data[:message] = message.to_s.tr("\r\n", ' ').strip
@@ -78,5 +78,16 @@ module Loggun
     def config
       Loggun::Config.instance
     end
+
+    def format_message(message)
+      if config.message_format == :json
+        JSON.generate(message)
+      elsif config.message_format == :key_value
+        message.map { |key, value| "#{key}=#{value}" }.join(' ')
+      else
+        warn('Unknown value for message_format')
+        JSON.generate(message)
+      end
+    end
   end
 end

data/lib/loggun/version.rb

@@ -1,3 +1,3 @@
 module Loggun
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggun
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Aleksandr Noskov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler