loggun 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64690d6ecfdadf2c32a49d2a688de83dfd2ea90a22e8c87e24544fd6c025100a
-  data.tar.gz: 428175cd75ee0bef72c3c74450df4c69069a37997794a253a86147883e7d14db
+  metadata.gz: 8bdbf0283432b32fe9fe682ca29e432480e1bae6cc4ff31879b50a26120b10c9
+  data.tar.gz: bce5fe0878cba0d1e758289baa9b2227bfc81a1946443c2b7bfc8ee4580a3267
 SHA512:
-  metadata.gz: e680f49877dcb8418b3653c38ec42187ba17050ba58ac061d383ca9e3cf836d6739f7ae111ec9a7352b8d9ea721a1b4e09ad4d91bb022c6d61b2ff6bacdd4d5f
-  data.tar.gz: 0e5e5cedcdd59e80c71979a4ae90f87a59b76565b4e02754a2b3c35d1bd264ce8e619330b4944e6035e524ff26e56ba65be0c30b3f71114b7f29d2f84be629cb
+  metadata.gz: e8f76f5a5d5244f20d6b3cf5ed1f2c41ef87f93f50ac107626bc6f45cc2a3b44629d6b3d45af61bbd79e424f99ce99f1070937bb97c6e35906c8ea6d2609efd8
+  data.tar.gz: 923f02afe9583bbb919671fbeb6fb54e8553efd1a01a6102d2eed865158a21c30c1effdd9e46f836488541b622ac8ae7e5c6ca9bfaa89e43752de40f0827aef3

data/.travis.yml

@@ -3,8 +3,6 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.8
-  - 2.4.6
   - 2.5.5
   - 2.6.5
 before_install: gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+## 0.6.0 - 2020-09-22
+* features
+  * Sidekiq client middlware for logging enqueued jobs
+
+## 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
+  * `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`
+
+## 0.4.0 - 2020-06-02
+* fixes
+  * fix key_value join character to space
+  * fix dummy dependency alerts
+* features
+  * add new const MESSAGE_FORMATS and test for checking the value of message_format
+  * add check message_format
+  * boolean flag replace with a whitelist and create method for generating a message
+  * added ability to log messages format k=v
+
+## 0.3.1 - 2020-04-21
+* fixes
+  * fix error "modify frozen String" for class name in helpers
+
+## 0.3.0 - 2020-04-17
+* fixes
+  * make public #generate_log_transaction_id in helper
+  * removed incoming http modifier
+
+## 0.2.0 - 2020-04-13
+* fixes
+  * fix Readme with active_record modifier
+  * fix except option for helper #log_options
+  * refactor helpers #log_type
+  * fix helper define log_methods caller
+  * improve stability of helpers
+* features
+  * remove legacy agent from default log pattern
+  * new active record modifier
+  * improve sidekiq modifier for difference versions

data/README.md

@@ -1,34 +1,52 @@
 # Loggun
 
-[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_compact.svg)](https://funbox.ru)
-
 [![Gem Version](https://badge.fury.io/rb/loggun.svg)](https://badge.fury.io/rb/loggun)
 [![Build Status](https://travis-ci.org/funbox/loggun.svg?branch=master)](https://travis-ci.org/funbox/loggun)
 
-## Описание
-Loggun - это гем, позволяющий привести все логи приложения к единому формату
+Приводит логи приложения к единому формату.
+
+## Содержание
+
+- [Установка](#установка)
+- [Использование](#использование)
+- [Конфигурация](#конфигурация)
+  - [Настройки](#настройки)
+  - [Модификаторы](#модификаторы)
+    - [Rails модификатор](#rails-модификатор)
+    - [Active Record модификатор](#active-record-модификатор)
+    - [Sidekiq модификатор](#sidekiq-модификатор)
+    - [Clockwork модификатор](#clockwork-модификатор)
+    - [Модификатор исходящих HTTP-запросов](#модификатор-исходящих-http-запросов)
+    - [Модификатор входящих запросов в Rails](#модификатор-входящих-запросов-в-rails)
+    - [Пользовательские модификаторы](#пользовательские-модификаторы)
+  - [Хелперы](#хелперы)
 
 ## Установка
 
-Чтобы установить гем, добавьте в ваш Gemfile:
+Чтобы установить гем, добавьте его в Gemfile:
 
 ```ruby
 gem 'loggun'
 ```
 
-И выполните команду :
+И выполните команду:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 ## Использование
-Вы можете использовать Loggun как обертку для вашего Logger. Для этого необходимо передать
-ему инстанс вашего логгера и настроить его formatter:
+
+Loggun можно использовать как обертку для вашего `logger`. Для этого необходимо передать
+ему инстанс логгера и настроить его `formatter`:
+
 ```ruby
 Loggun.logger = Rails.logger
 Loggun.logger.formatter = Loggun::Formatter.new
 ```
 
-Теперь вы можете использовать Loggun для логгирования в стандартизированном формате:
+Теперь можно использовать Loggun для логирования в стандартизированном формате:
+
 ```ruby
 Loggun.info('http_request.api.request', user_id: current_user.id)
 #=> 2020-04-11T22:35:04.225+03:00 - 170715 INFO http_request.api.request - {"user_id": 5465}
@@ -37,18 +55,16 @@ Loggun.info('http_request.api.response', user_id: current_user.id, success: true
 #=> 2020-04-11T22:35:04.225+03:00 - 170715 INFO http_request.api.response - {"user_id": 5465, "success": true} 
 ``` 
 
-Подробнее об конфигурации и использовании Loggun ниже.
+## Конфигурация
 
-### Конфигурация
-Для успешной конфигурации гема необходимо подгружать файл при инициализации вашего приложения.
-
-`config/initializers/loggun.rb`
+Конфигурацию гема необходимо производить при инициализации приложения. Например, так:
 
 ```ruby
 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
@@ -57,35 +73,116 @@ Loggun::Config.configure do |config|
   config.modifiers.outgoing_http = false
 end
 ```
-Все настройки являются опциональными.
-#### Настройки
-- `precision` - точность отметок времени. По умолчанию - `milliseconds`. Может принимать одно из следующих значений: `sec`, `seconds`, `ms`, `millis`, `milliseconds`, `us`, `micros`, `microseconds`, `ns`, `nanos`, `nanoseconds`
-- `pattern` - текстовый шаблон для формата вывода данных в лог. 
-Доступные ключи: `time`, `pid`, `severity`, `type`, `tags_text`, `message`, `parent_transaction`
-- `parent_transaction_to_message` - признак необходимости добавлять значение `parent_transaction` в тело логируемого сообщения. 
-Вне зависимости от данной настройки можно использовать ключ `parent_transaction` в шаблоне `pattern`. 
-- `modifiers` - модификаторы для переопределения формата логирования указанного компонента. См. далее.
-
-#### Модификаторы
+
+### Настройки
+
+Все настройки опциональны.
+
+- `precision` — точность отметок времени.
+
+  Может принимать одно из следующих значений:
+  `sec`, `seconds`, `ms`, `millis`, `milliseconds`, `us`, `micros`, `microseconds`, `ns`, `nanos`, `nanoseconds`.
+  
+  По умолчанию `milliseconds`.
+
+- `pattern` — текстовый шаблон для формата вывода данных в лог.   
+
+  Доступные ключи внутри шаблона: `time`, `pid`, `severity`, `type`, `tags_text`, `message`, `parent_transaction`.
+
+- `parent_transaction_to_message` — если `true`, то значение `parent_transaction` будет добавлено в тело логируемого сообщения.
+ 
+  Ключ `parent_transaction` в шаблоне `pattern` можно использовать вне зависимости от значения этой настройки. 
+  
+- `force_utc` — если `true`, то значение `time` будет переведено в UTC.
+  
+  По умолчанию `false`.
+
+- `message_format` — формат переменной `message` в шаблоне `pattern`. 
+
+  Доступные значения:
+   
+  - `:json` — `message` логируется как JSON-строка;
+  - `:key_value` — `message` логируется в формате `key1=value1 key2=value2`.
+
+- `log_format` — формат лога. 
+
+  Доступные значения:
+   
+  - `: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` пуст.
+
+- `only_keys` — список ключей, которые будут включены в JSON-строку.
+   
+   Используется, если `log_format` имеет значение `:json`.
+ 
+- `modifiers` — модификаторы для переопределения формата логирования указанного компонента. См. «[Модификаторы](#модификаторы)».
+
+### Модификаторы
+
 Каждый модифкатор может быть активирован двумя равнозначными способами:
+
 ```ruby
 config.modifiers.rails = true
 ```
+
 или
+
 ```ruby
 config.modifiers.rails.enable = true
 ```
 
-##### Rails модификатор 
-`config.modifier.rails` - модифицирует форматирование логгера Rails.
+(В качестве примера активируется Rails модификатор, но может быть любой другой.)
+
+#### Rails модификатор 
+
+`config.modifier.rails`
+
+Модифицирует форматирование логгера Rails.
+
+#### Active Record модификатор
+
+`config.modifier.active_record`
+
+Добавляет (именно добавляет, а не модифицирует) нового подписчика на SQL-события.
+
+SQL начинает дополнительно логироваться в Loggun формате, `severity` — `info`. Например:
 
-##### Active Record модификатор
-`config.modifier.active_record` - добавляет (именно добавляет, а не модифицирует) нового подписчика на SQL события.
-SQL начинает дополнительно логгироваться в Loggun формате, severity - info. Например:
 ```text
 2020-04-12T20:08:52.913+03:00 - 487257 INFO storage.sql.query - {"sql":"SELECT 1","name":null,"duration":0.837}
 ```
-Пример настроек:
+
+Дополнительные настройки:
+
+- `log_subscriber_class_name` — имя класса, реализующего логирование SQL-события.
+
+  Необходим метод `#sql`. По умолчанию: `::Loggun::Modifiers::ActiveRecord::LoggunLogSubscriber`.
+
+- `payload_keys` — необходимые ключи в полезной нарзуке. Используется в классе по умолчанию. 
+   
+  Доступные ключи: `%i[sql name duration source]`.
+
+Пример:
+
 ```ruby
 Loggun::Config.configure do |config|
   #...
@@ -95,26 +192,46 @@ Loggun::Config.configure do |config|
   #...
 end
 ```
-- `log_subscriber_class_name` - имя класса, реализующего логирование sql события.
-Необходим метод `#sql`. По-умолчанию `::Loggun::Modifiers::ActiveRecord::LoggunLogSubscriber`
 
-- `payload_keys` - необходимые ключи в полезной нарзуке. Используется в дефолтном классе. Доступные
-ключи: ```%i[sql name duration source]```.
+#### Sidekiq модификатор 
 
-##### Sidekiq модификатор 
-`config.modifiers.sidekiq` - модифицирует форматирование логгера Sidekiq.
+`config.modifiers.sidekiq`
 
-##### Clockwork модификатор
-`config.modifiers.clockwork` - модифицирует форматирование логгера Clockwork.
+Модифицирует форматирование логгера Sidekiq.
 
-##### Модификатор исходящих HTTP запросово
-`config.modifiers.outgoing_http` - добавляет логирование исходящих http запросов. 
-На данный момент поддерживаются только запросы посредством гема `HTTP`.
+#### Clockwork модификатор
 
-##### Модификатор входящих запросов в Rails
- `config.modifiers.incoming_http` - добавляет логирование входящих http запросов для контроллеров Rails.
-Данный модификатор может иметь дополнительные настройки, которые устанавливаются следующим образом 
-(приведены значения по умолчанию):
+`config.modifiers.clockwork`
+ 
+Модифицирует форматирование логгера Clockwork.
+
+#### Модификатор исходящих HTTP-запросов
+
+`config.modifiers.outgoing_http`
+
+Добавляет логирование исходящих HTTP-запросов. 
+На данный момент поддерживаются только запросы, выполненные с помощью гема `HTTP`.
+
+#### Модификатор входящих запросов в Rails
+
+ `config.modifiers.incoming_http`
+ 
+Добавляет логирование входящих HTTP-запросов для контроллеров Rails.
+
+Может иметь дополнительные настройки:
+
+- `controllers` — массив имён базовых контроллеров, для которых необходимо добавить указанное логирование.
+
+- `success_condition` — лямбда, определяющая, содержит ли успех ответ экшена.
+
+  Например: `-> { JSON.parse(response.body)['result'] == 'ok' }`
+
+- `error_info` — лямбда, позволяющая добавить в лог информацию об ошибке, содержащейся в неуспешном ответе экшена. 
+
+  Например: `-> { JSON.parse(response.body)['error_code'] }`
+
+
+Пример (приведены значения по умолчанию):
 
 ```ruby
 Loggun::Config.configure do |config|
@@ -126,26 +243,25 @@ Loggun::Config.configure do |config|
   #...
 end
 ```
-- `controllers` - массив имён базовых контроллеров, для которых необходимо добавить указанное логирование.
 
-- `success_condition` - лямбда, определяющая, содержит ли успех ответ экшена. Например `-> { JSON.parse(response.body)['result'] == 'ok' }`
+**Для Rails 6 и выше данный модификатор может работать некорректно.** 
 
-- `error_info` - лямбда, позволяющая добавить в лог информацию об ошибке, содержащейся в неуспешном ответе экшена. 
-Например `-> { JSON.parse(response.body)['error_code'] }`
+В этом случае можно добавить в требуемый базовый контроллер строку:
 
-**Для Rails 6 и выше данный модификатор может работать некорректно.** 
-В этом случае можно указать в требуемом базовом контроллере строку:
 ```ruby
 include Loggun::HttpHelpers
 ```
+
 Это делает настройки `enable` и `controllers` модификатора безсполезными, 
-однако позволяет гарантированно логировать входящие http запросы.
+однако позволяет гарантированно логировать входящие HTTP-запросы.
 
 Настройки `success_condition` и `error_info` продолжают использоваться и могут быть установлены требуемым образом.
 
-##### Персональные модификаторы
+#### Пользовательские модификаторы
+
 Помимо указанных модификаторов существует возможность добавить собственный. 
-Необходимо уснаследовать его от `Loggun::Modifiers::Base` и указать в методе `apply` все необходимые действия.
+Необходимо уснаследовать его от `Loggun::Modifiers::Base` и указать в методе `apply` все необходимые действия:
+
 ```ruby
 require 'sinatra/custom_logger'
 
@@ -155,7 +271,9 @@ class NewModifier < Loggun::Modifiers::Base
   end
 end
 ```
-Затем необходимо добавить его при конфигурации гема.
+
+Затем необходимо добавить его при конфигурации гема:
+
 
 ```ruby
 Loggun::Config.configure do |config|
@@ -166,10 +284,12 @@ end
 ```
 
 ### Хелперы
-Подключение хелперов в класс позволяет использовать методы логирования `log_info` и `log_error`, 
+
+Подключение хэлперов в класс позволяет использовать методы логирования `log_info` и `log_error`, 
 а также генерировать идентификатор транзации для каждого метода класса.
 
 Например:
+
 ```ruby
 class SomeClass
   include Loggun::Helpers
@@ -183,26 +303,26 @@ class SomeClass
   end
 end
 ```
-При вызове `#download_data` мы получим следующий вывод в лог:
+
+При вызове `#download_data` будет следующий вывод в лог:
+
 ```
 2020-03-04T16:58:38.207+05:00 - 28476 INFO http_request.some_class.download_data#ffg5431_1583323118203 - {"message":["Information"]}
 2020-03-04T16:58:38.208+05:00 - 28476 INFO http_response.some_class.download_data#ffg5431_1583323118203 - {"success": true}
 ```
 
-**Важно**, что с хелпером log_options необходимо использовать только методы вида `log_<severity>`. 
+**Важно**, что с хэлпером `log_options` необходимо использовать только методы вида `log_<severity>`. 
 Методы модуля `Loggun` не будут работать.
 
-Список всех опций хелпера log_options:
-
-- `entity_name` - имя сущности метода, string
-- `entity_action` - действие сущности метода, string
-- `as_transaction` - добавлять уникальный ID транзакции для метода, boolean
-- `transaction_generator` - собственный генератор ID транзакции, lambda
-- `log_all_methods` - признак необходимости применения хелпера ко всем методам, boolean
-- `only` - список методов, для которых необходимо применить хелпер (работает только если `log_all_methods` - false), Array{Symbol}
-- `except` - список методов, которые надо исключить для хелпера, Array{Symbol}
-- `log_transaction_except` - список методов, логирование которых не нужно обогащать ID транзакции, Array{Symbol}
+Список всех опций хэлпера `log_options`:
 
-## License
+- `entity_name` — имя сущности метода, `string`;
+- `entity_action` — действие сущности метода, `string`;
+- `as_transaction` — добавлять ли уникальный ID транзакции для метода, `boolean`;
+- `transaction_generator` — собственный генератор ID транзакции, `lambda`;
+- `log_all_methods` — применять ли хэлпер ко всем методам, `boolean`;
+- `only` — список методов, для которых необходимо применить хэлпер (работает только когда `log_all_methods = false`), `Array{Symbol}`;
+- `except` — список методов, которые надо исключить для хэлпера, `Array{Symbol}`;
+- `log_transaction_except` — список методов, логирование которых не нужно обогащать ID транзакции, `Array{Symbol}`.
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)

data/lib/loggun/config.rb

@@ -8,6 +8,9 @@ module Loggun
     DEFAULTS = {
       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],
@@ -20,14 +23,21 @@ 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
@@ -35,8 +45,13 @@ module Loggun
       @precision = DEFAULTS[:precision]
       @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
 
@@ -44,6 +59,7 @@ module Loggun
       def configure(&block)
         block.call(instance)
         use_modifiers
+        check_config
         instance
       end
 
@@ -59,6 +75,16 @@ module Loggun
         instance.custom_modifiers.each(&:use)
       end
 
+      def check_config
+        unless MESSAGE_FORMATS.include? instance.message_format
+          raise FailureConfiguration, 'Unknown value for message_format'
+        end
+
+        unless LOG_FORMATS.include? instance.log_format
+          raise FailureConfiguration, 'Unknown value for log_format'
+        end
+      end
+
       def setup_formatter(app, formatter = nil)
         Loggun.logger = app.logger
         Loggun.logger.formatter = formatter || instance.formatter
@@ -91,5 +117,7 @@ module Loggun
         3 # milliseconds
       end
     end
+
+    class FailureConfiguration < StandardError; end
   end
 end

data/lib/loggun/formatter.rb

@@ -7,29 +7,22 @@ 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
+      time = time.utc if config.force_utc
 
-      if message.is_a?(Hash)
-        if config.parent_transaction_to_message && parent_transaction
-          message[:parent_transaction] = parent_transaction
-        end
-        message = JSON.generate(message)
-      end
+      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[:message] = message.to_s.tr("\r\n", ' ').strip
       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
-
-      format(config.pattern + "\n", data)
+      prepare_to_output(data)
     end
 
     def tagged(*tags)
@@ -69,6 +62,41 @@ module Loggun
 
     private
 
+    def process_message(data, message)
+      if message.is_a?(Hash)
+        if config.parent_transaction_to_message && parent_transaction
+          message[:parent_transaction] = parent_transaction
+        end
+
+        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
+
+      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
+        format(config.pattern + "\n", data)
+      end
+    end
+
     def parent_transaction
       return unless Loggun.parent_type && Loggun.parent_transaction_id
 
@@ -78,5 +106,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/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)
@@ -139,7 +142,9 @@ module Loggun
       type_as_arr = type.split('.')
 
       if type_as_arr.size == 1
-        log_entity_name = klass.respond_to?(:log_entity_name) ? klass.log_entity_name : underscore(klass.name.dup)
+        log_entity_name = klass.log_entity_name if klass.respond_to?(:log_entity_name)
+
+        log_entity_name ||= underscore(klass.name.dup)
         type_as_arr << log_entity_name
       end
 

data/lib/loggun/modifiers/sidekiq.rb

@@ -8,6 +8,10 @@ module Loggun
       def apply
         return unless defined?(::Sidekiq) && ::Sidekiq::VERSION >= MIN_SIDEKIQ_V
 
+        ::Sidekiq.client_middleware do |chain|
+          chain.add ClientMiddleware
+        end
+
         ::Sidekiq.configure_server do |config|
           Loggun::Config.setup_formatter(config, LoggunFormatter.new)
         end
@@ -20,6 +24,15 @@ module Loggun
           require 'loggun/modifiers/sidekiq/sidekiq4'
         end
       end
+
+      class ClientMiddleware
+        def call(worker_class, _msg, queue, _redis_pool)
+          yield.tap do |options|
+            msg = "Job #{worker_class} JID-#{options['jid']} enqueued to `#{queue}`"
+            Loggun.info('app.sidekiq.enqueued', msg, worker_class: worker_class, jid: options['jid'], queue: queue)
+          end
+        end
+      end
     end
   end
 end

data/lib/loggun/version.rb

@@ -1,3 +1,3 @@
 module Loggun
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.6.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.6.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-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -182,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Loggun