loggun 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd41231567df2c15cca3c6ba500fc8228dcf03ac808b2adb452385be59d4217
-  data.tar.gz: 86c26424200b7c443a4160770d7b3f0d22490db5e0ac3c41fffdd2dadd795d9e
+  metadata.gz: 2596dacc5a1bea907afccdabec538190ba574a623c19221189798a1a9f320c74
+  data.tar.gz: 2ac4b17d0113f10c3742bf929165c5a6bf95c7273a9e8a2027fe48c170dfef3c
 SHA512:
-  metadata.gz: '058933cfb04111fe6f0f106e97efde068932b575bfc2be6bdfee0f419db586b07e0a11025eba01b65d12f71a9ef8121dc88e4c53dc39037cd95d5ee6d1ccd90b'
-  data.tar.gz: ebd06ae4867bb4b8cc03fa0ef1815ca73f58af294fab484f3f1207c01d3b4c305cfaa442a6b82771524a909fdb88cb68a8421c760ba8099731957a158c910858
+  metadata.gz: a279ad6a07b077bf7af95aaeba39cae3085808e3e9ab77798a950d192d8e8c9f406b7f49c97f46d80bd7b8b12c5fe77bc38c0fff47c2ee0b055363862d8a45eb
+  data.tar.gz: 410fc2d3b572a729f5e7c0ecde19426384b401dd8f2d87b89b20731c4dbcba20b89231b463e3e49c76220bdfafd7d058e75dfa3af88faec1b6645001485bb330

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.5.0 - 2020-09-22
+* features
+  * `config.log_format` - for control full log rows format
+  * `config.exclude_keys`, `config.include_keys` - for include or exclude keys from `:json` log_format 
+
 ## 0.4.1 - 2020-07-28
 * fixes
   * fill type with class name for empty `log_entity_name`

data/README.md

@@ -92,6 +92,10 @@ end
 - `parent_transaction_to_message` — если `true`, то значение `parent_transaction` будет добавлено в тело логируемого сообщения.
  
   Ключ `parent_transaction` в шаблоне `pattern` можно использовать вне зависимости от значения этой настройки. 
+  
+- `force_utc` — если `true`, то значение `time` будет переведено в UTC.
+  
+  По умолчанию `false`.
 
 - `message_format` — формат переменной `message` в шаблоне `pattern`. 
 
@@ -99,6 +103,23 @@ end
    
   - `:json` — `message` логируется как JSON-строка;
   - `:key_value` — `message` логируется в формате `key1=value1 key2=value2`.
+
+- `log_format` — формат лога. 
+
+  Доступные значения:
+   
+  - `:json` — лог формируется как JSON-строка игнорируя шаблон `pattern`;
+  - `:plain` — лог формируется по шаблону `pattern`.
+  
+  По умолчанию `:plain`.
+  
+- `exclude_keys` — список ключей, которые будут исключены из лога.
+
+   Используется, если `log_format` имеет значение `:json` и список `only_keys` пуст.
+
+- `only_keys` — список ключей, которые будут включены в JSON-строку.
+   
+   Используется, если `log_format` имеет значение `:json`.
  
 - `modifiers` — модификаторы для переопределения формата логирования указанного компонента. См. «[Модификаторы](#модификаторы)».
 

data/lib/loggun/config.rb

@@ -9,6 +9,8 @@ module Loggun
       pattern: '%{time} - %{pid} %{severity} %{type} %{tags_text} %{message}',
       parent_transaction_to_message: true,
       message_format: :json,
+      log_format: :plain,
+      force_utc: false,
       precision: :milliseconds,
       incoming_http: {
         controllers: %w[ApplicationController],
@@ -22,15 +24,20 @@ module Loggun
     }.freeze
     DEFAULT_MODIFIERS = %i[rails active_record sidekiq clockwork outgoing_http].freeze
     MESSAGE_FORMATS = %i[json key_value].freeze
+    LOG_FORMATS = %i[json plain].freeze
 
     attr_accessor(
       :formatter,
       :pattern,
       :parent_transaction_to_message,
       :message_format,
+      :log_format,
+      :force_utc,
       :precision,
       :modifiers,
-      :custom_modifiers
+      :custom_modifiers,
+      :exclude_keys,
+      :only_keys
     )
 
     def initialize
@@ -39,8 +46,12 @@ module Loggun
       @pattern = DEFAULTS[:pattern]
       @parent_transaction_to_message = DEFAULTS[:parent_transaction_to_message]
       @message_format = DEFAULTS[:message_format]
+      @log_format = DEFAULTS[:log_format]
+      @force_utc = DEFAULTS[:force_utc]
       @modifiers = Loggun::OrderedOptions.new
       @custom_modifiers = []
+      @exclude_keys = []
+      @only_keys = []
       set_default_modifiers
     end
 
@@ -65,9 +76,13 @@ module Loggun
       end
 
       def check_config
-        return if MESSAGE_FORMATS.include? instance.message_format
+        unless MESSAGE_FORMATS.include? instance.message_format
+          raise FailureConfiguration, 'Unknown value for message_format'
+        end
 
-        raise FailureConfiguration, 'Unknown value for message_format'
+        unless LOG_FORMATS.include? instance.log_format
+          raise FailureConfiguration, 'Unknown value for log_format'
+        end
       end
 
       def setup_formatter(app, formatter = nil)

data/lib/loggun/formatter.rb

@@ -7,17 +7,13 @@ module Loggun
 
     def call(severity, time, _program_name, message, loggun_type: nil)
       data = Hash.new(DEFAULT_VALUE)
-      data[:time] = time.iso8601(config.timestamp_precision)
-      data[:pid] = Process.pid
-
-      if message.is_a?(Hash)
-        if config.parent_transaction_to_message && parent_transaction
-          message[:parent_transaction] = parent_transaction
-        end
-        message = format_message(message)
-      end
+      time = time.utc if config.force_utc
+      message = prepare_message(message)
 
-      data[:message] = message.to_s.tr("\r\n", ' ').strip
+      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[:tags_text] = tags_text
       data[:type] = loggun_type || Loggun.type || DEFAULT_VALUE.dup
@@ -29,7 +25,13 @@ module Loggun
         data[:type] = "#{data[:type]}##{data[:transaction_id]}"
       end
 
-      format(config.pattern + "\n", data)
+      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
     end
 
     def tagged(*tags)
@@ -69,6 +71,21 @@ module Loggun
 
     private
 
+    def prepare_message(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
+      end
+
+      if config.log_format == :plain
+        message.to_s.tr("\r\n", ' ').strip
+      else
+        message
+      end
+    end
+
     def parent_transaction
       return unless Loggun.parent_type && Loggun.parent_transaction_id
 

data/lib/loggun/helpers.rb

@@ -86,7 +86,10 @@ module Loggun
             attrs[:hidden] = { error: { backtrace: error.backtrace } }
           end
         end
-        attrs[:message] = args unless args.empty?
+        unless args.empty?
+          attrs[:message] = args.first if args.size == 1
+          attrs[:message] ||= args
+        end
 
         with_log_type(type) do
           logger.send(method_name, **attrs, &block)

data/lib/loggun/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggun
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Aleksandr Noskov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler