loggun 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2596dacc5a1bea907afccdabec538190ba574a623c19221189798a1a9f320c74
-  data.tar.gz: 2ac4b17d0113f10c3742bf929165c5a6bf95c7273a9e8a2027fe48c170dfef3c
+  metadata.gz: 51f8b307222f4c0cd6a68a2e1190c505dfb85c98916e8bef75f8353308d6066e
+  data.tar.gz: a967d678e0ca4e52f7dc2f4387d2d04fe7097f10eb0cbfaccfe9c41d6c2de809
 SHA512:
-  metadata.gz: a279ad6a07b077bf7af95aaeba39cae3085808e3e9ab77798a950d192d8e8c9f406b7f49c97f46d80bd7b8b12c5fe77bc38c0fff47c2ee0b055363862d8a45eb
-  data.tar.gz: 410fc2d3b572a729f5e7c0ecde19426384b401dd8f2d87b89b20731c4dbcba20b89231b463e3e49c76220bdfafd7d058e75dfa3af88faec1b6645001485bb330
+  metadata.gz: 29b945bd8b60102ba564177193321458adc9226d6c5eb541be5e8ba06a591d9cef305d2a3c45180c011580b31acb78c6687b87941951268e35525bc5af110311
+  data.tar.gz: 18894d7473ac6a2700b96e61a1d3f2d5c4ff152546f464d1663b2aa891a6fb559856a99a1fe0b2205cdb83457818091f391ac2e137e9e6027cc72eb6b59b0bc5

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.1 - 2020-09-22
+* fix
+  * `message` string only in `log_format == :json` 
+
 ## 0.5.0 - 2020-09-22
 * features
   * `config.log_format` - for control full log rows format

data/README.md

@@ -108,11 +108,25 @@ end
 
   Доступные значения:
    
-  - `:json` — лог формируется как JSON-строка игнорируя шаблон `pattern`;
+  - `:json` — лог формируется как JSON-строка игнорируя шаблон `pattern` и настройку `message_format`;
   - `:plain` — лог формируется по шаблону `pattern`.
   
   По умолчанию `:plain`.
   
+  При `log_format == :json` в `message` будет попадать только сообщение, которое было передано строкой. Сообщение, 
+  переданное хешем попадет в поле `metadata`. Пример:
+  ```ruby
+    Loggun.info("my.best.action", "message string", test: true)
+    # {
+    #    "metadata":{"test":true},
+    #    "message":"message string",
+    #    "type":"my.best.action",
+    #    "timestamp":"2020-09-22T14:57:22.233+03:00",
+    #    "severity":"INFO",
+    #    ...
+    #    }
+  ```
+      
 - `exclude_keys` — список ключей, которые будут исключены из лога.
 
    Используется, если `log_format` имеет значение `:json` и список `only_keys` пуст.

data/lib/loggun/formatter.rb

@@ -8,30 +8,21 @@ module Loggun
     def call(severity, time, _program_name, message, loggun_type: nil)
       data = Hash.new(DEFAULT_VALUE)
       time = time.utc if config.force_utc
-      message = prepare_message(message)
+
+      process_message(data, message)
+
+      data[:type] = loggun_type || Loggun.type || DEFAULT_VALUE.dup
 
       data[:timestamp] = time.iso8601(config.timestamp_precision)
       data[:time] = data[:timestamp] if config.log_format == :plain
-      data[:pid] = Process.pid
-      data[:message] = message
+
       data[:severity] = severity&.to_s || 'INFO'
+      data[:pid] = Process.pid
       data[:tags_text] = tags_text
-      data[:type] = loggun_type || Loggun.type || DEFAULT_VALUE.dup
       data[:transaction_id] = Loggun.transaction_id
       data[:parent_transaction] = parent_transaction if parent_transaction
 
-      if data[:transaction_id] && data[:type] != DEFAULT_VALUE &&
-         data[:transaction_id].to_i != Process.pid
-        data[:type] = "#{data[:type]}##{data[:transaction_id]}"
-      end
-
-      if config.log_format == :json
-        data.except!(*config.exclude_keys) if config.only_keys.empty?
-        data.slice!(*config.only_keys) if config.only_keys.any?
-        JSON.generate(data) + "\n"
-      else
-        format(config.pattern + "\n", data)
-      end
+      prepare_to_output(data)
     end
 
     def tagged(*tags)
@@ -71,18 +62,38 @@ module Loggun
 
     private
 
-    def prepare_message(message)
+    def process_message(data, message)
       if message.is_a?(Hash)
         if config.parent_transaction_to_message && parent_transaction
           message[:parent_transaction] = parent_transaction
         end
-        message = format_message(message) if config.log_format == :plain
+
+        if config.log_format == :plain
+          message = format_message(message)
+        else
+          simple_message = message.delete(:message)
+          data[:metadata] = message if message != {}
+          message = simple_message
+        end
       end
 
-      if config.log_format == :plain
-        message.to_s.tr("\r\n", ' ').strip
+      message = message.to_s.tr("\r\n", ' ').strip if config.log_format == :plain
+
+      data[:message] = message
+    end
+
+    def prepare_to_output(data)
+      if data[:transaction_id] && data[:type] != DEFAULT_VALUE &&
+        data[:transaction_id].to_i != Process.pid
+        data[:type] = "#{data[:type]}##{data[:transaction_id]}"
+      end
+
+      if config.log_format == :json
+        data.except!(*config.exclude_keys) if config.only_keys.empty?
+        data.slice!(*config.only_keys) if config.only_keys.any?
+        JSON.generate(data) + "\n"
       else
-        message
+        format(config.pattern + "\n", data)
       end
     end
 

data/lib/loggun/version.rb

@@ -1,3 +1,3 @@
 module Loggun
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.5.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggun
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Aleksandr Noskov