loggun 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756771ea707f7cbaafd88da80dc72afd4311702718de31a087711b258f68d47a
-  data.tar.gz: b2a00e34692488e289888c9f3d7aa433fc30f66828a160762cf2fe80aa5ea46b
+  metadata.gz: 2596dacc5a1bea907afccdabec538190ba574a623c19221189798a1a9f320c74
+  data.tar.gz: 2ac4b17d0113f10c3742bf929165c5a6bf95c7273a9e8a2027fe48c170dfef3c
 SHA512:
-  metadata.gz: c797ff8ce8de7a5e2da28b95c9e498c1f78b827e5596f0bf1923fe87a3c5376fa5eef46c9169208225c262dc58bc846f05f4d5eefaa11ef8bd75c7e76f7ea2ee
-  data.tar.gz: 94d4d7bc950a938e82ab17b76fd4e387a169b90f16adeae8199958876847905d28ce698ee47ef4fc17d34102c3e619796cc9e8e03b27dc67b55f36ec34af5f6b
+  metadata.gz: a279ad6a07b077bf7af95aaeba39cae3085808e3e9ab77798a950d192d8e8c9f406b7f49c97f46d80bd7b8b12c5fe77bc38c0fff47c2ee0b055363862d8a45eb
+  data.tar.gz: 410fc2d3b572a729f5e7c0ecde19426384b401dd8f2d87b89b20731c4dbcba20b89231b463e3e49c76220bdfafd7d058e75dfa3af88faec1b6645001485bb330

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,41 @@
+# 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`
+
+## 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,102 @@ 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`;
+  - `:plain` — лог формируется по шаблону `pattern`.
+  
+  По умолчанию `:plain`.
+  
+- `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 +178,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 модификатор 
+
+`config.modifiers.sidekiq`
+
+Модифицирует форматирование логгера Sidekiq.
+
+#### Clockwork модификатор
+
+`config.modifiers.clockwork`
+ 
+Модифицирует форматирование логгера Clockwork.
+
+#### Модификатор исходящих HTTP-запросов
+
+`config.modifiers.outgoing_http`
+
+Добавляет логирование исходящих HTTP-запросов. 
+На данный момент поддерживаются только запросы, выполненные с помощью гема `HTTP`.
+
+#### Модификатор входящих запросов в Rails
+
+ `config.modifiers.incoming_http`
+ 
+Добавляет логирование входящих HTTP-запросов для контроллеров Rails.
 
-##### Sidekiq модификатор 
-`config.modifiers.sidekiq` - модифицирует форматирование логгера Sidekiq.
+Может иметь дополнительные настройки:
 
-##### Clockwork модификатор
-`config.modifiers.clockwork` - модифицирует форматирование логгера Clockwork.
+- `controllers` — массив имён базовых контроллеров, для которых необходимо добавить указанное логирование.
 
-##### Модификатор исходящих HTTP запросово
-`config.modifiers.outgoing_http` - добавляет логирование исходящих http запросов. 
-На данный момент поддерживаются только запросы посредством гема `HTTP`.
+- `success_condition` — лямбда, определяющая, содержит ли успех ответ экшена.
 
-##### Модификатор входящих запросов в Rails
- `config.modifiers.incoming_http` - добавляет логирование входящих http запросов для контроллеров Rails.
-Данный модификатор может иметь дополнительные настройки, которые устанавливаются следующим образом 
-(приведены значения по умолчанию):
+  Например: `-> { JSON.parse(response.body)['result'] == 'ok' }`
+
+- `error_info` — лямбда, позволяющая добавить в лог информацию об ошибке, содержащейся в неуспешном ответе экшена. 
+
+  Например: `-> { JSON.parse(response.body)['error_code'] }`
+
+
+Пример (приведены значения по умолчанию):
 
 ```ruby
 Loggun::Config.configure do |config|
@@ -126,26 +229,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 +257,9 @@ class NewModifier < Loggun::Modifiers::Base
   end
 end
 ```
-Затем необходимо добавить его при конфигурации гема.
+
+Затем необходимо добавить его при конфигурации гема:
+
 
 ```ruby
 Loggun::Config.configure do |config|
@@ -166,10 +270,12 @@ end
 ```
 
 ### Хелперы
-Подключение хелперов в класс позволяет использовать методы логирования `log_info` и `log_error`, 
+
+Подключение хэлперов в класс позволяет использовать методы логирования `log_info` и `log_error`, 
 а также генерировать идентификатор транзации для каждого метода класса.
 
 Например:
+
 ```ruby
 class SomeClass
   include Loggun::Helpers
@@ -183,26 +289,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.rb

@@ -5,7 +5,6 @@ require 'loggun/config'
 require 'loggun/modifiers'
 require 'loggun/modifiers/base'
 require 'loggun/helpers'
-require 'loggun/http_helpers'
 require 'logger'
 
 module Loggun

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],
@@ -19,15 +22,22 @@ module Loggun
         payload_keys: %i[sql name duration source]
       }
     }.freeze
-    DEFAULT_MODIFIERS = %i[rails active_record sidekiq clockwork incoming_http outgoing_http].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,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
+      time = time.utc if config.force_utc
+      message = prepare_message(message)
 
-      if message.is_a?(Hash)
-        if config.parent_transaction_to_message && parent_transaction
-          message[:parent_transaction] = parent_transaction
-        end
-        message = JSON.generate(message)
-      end
-
-      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
 
@@ -78,5 +95,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)
@@ -138,8 +141,12 @@ module Loggun
       type ||= DEFAULT_TYPE.dup
       type_as_arr = type.split('.')
 
-      log_entity_name = klass.respond_to?(:log_entity_name) ? klass.log_entity_name : underscore(klass.name)
-      type_as_arr << log_entity_name if type_as_arr.size == 1
+      if type_as_arr.size == 1
+        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
 
       return type unless klass.respond_to?(:log_entity_action)
 
@@ -150,6 +157,14 @@ module Loggun
       type_as_arr.join('.')
     end
 
+    def generate_log_transaction_id
+      if self.class.log_transaction_generator
+        return self.class.log_transaction_generator.call(self)
+      end
+
+      "#{SecureRandom.uuid[0..7]}_#{DateTime.now.strftime('%Q')}"
+    end
+
     private
 
     def normalize(type)
@@ -168,14 +183,6 @@ module Loggun
       word
     end
 
-    def generate_log_transaction_id
-      if self.class.log_transaction_generator
-        return self.class.log_transaction_generator.call
-      end
-
-      "#{SecureRandom.uuid[0..7]}_#{DateTime.now.strftime('%Q')}"
-    end
-
     def logger
       Loggun.logger
     end

data/lib/loggun/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: loggun
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Aleksandr Noskov
 - Sergey Nesterov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-13 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
@@ -144,7 +145,6 @@ files:
 - lib/loggun/config.rb
 - lib/loggun/formatter.rb
 - lib/loggun/helpers.rb
-- lib/loggun/http_helpers.rb
 - lib/loggun/modifiers.rb
 - lib/loggun/modifiers/active_record.rb
 - lib/loggun/modifiers/active_record/loggun_log_subscriber.rb
@@ -152,7 +152,6 @@ files:
 - lib/loggun/modifiers/clockwork.rb
 - lib/loggun/modifiers/clockwork/manager.rb
 - lib/loggun/modifiers/clockwork/methods.rb
-- lib/loggun/modifiers/incoming_http.rb
 - lib/loggun/modifiers/outgoing_http.rb
 - lib/loggun/modifiers/outgoing_http/block_logger.rb
 - lib/loggun/modifiers/rails.rb
@@ -169,7 +168,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/funbox/loggun
   source_code_uri: https://github.com/funbox/loggun
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -185,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Loggun
 test_files: []

data/lib/loggun/http_helpers.rb

@@ -1,48 +0,0 @@
-module Loggun
-  module HttpHelpers
-    def self.included(klass)
-      klass.class_eval do
-        around_action :log_http_actions
-      end
-    end
-
-    private
-
-    def log_http_actions
-      log_action :start
-      yield
-      log_action :response
-    rescue StandardError => e
-      log_action :response, fail: e
-      raise e
-    end
-
-    def log_action(action = :start, fail: nil)
-      api = request.path[/\w+/]
-      api_version = request.path[/v./]
-      type = "http_request.#{api}.#{action}"
-      data = { path: clean_pathname }
-      data[:api_version] = api_version if api_version
-
-      return Loggun.info type, data if action == :start
-
-      success = fail.nil? && instance_exec(&modifier_config.success_condition)
-      data[:success] = success
-      unless success
-        error = instance_exec(&modifier_config.error_info)
-        data[:error] = error if error
-      end
-      Loggun.info type, data
-    end
-
-    def clean_pathname
-      filtered_params = params.to_unsafe_h
-      filtered_params.delete('action')
-      request.path.gsub(/(#{filtered_params.values.join('|')})/, '').gsub(/\/api\/v./, '')
-    end
-
-    def modifier_config
-      Loggun::Config.instance.modifiers.incoming_http
-    end
-  end
-end

data/lib/loggun/modifiers/incoming_http.rb

@@ -1,16 +0,0 @@
-module Loggun
-  module Modifiers
-    class IncomingHttp < Loggun::Modifiers::Base
-      def apply
-        return unless defined?(ActionPack)
-
-        controllers = Loggun::Config.instance.modifiers.incoming_http.controllers
-        controllers.each do |controller|
-          controller.constantize.class_eval do
-            include Loggun::HttpHelpers
-          end
-        end
-      end
-    end
-  end
-end