memolog 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e99e3c68b6d46dff6769d0526a9b9638d6ddf479665929a8e03dddb5eeddf618
-  data.tar.gz: f7221b929323ff44066403d01a3f02eefb6dd8302c882a2a78df43776acdc03b
+  metadata.gz: 4c73ff6eb1b46572a24b11def4c3b3a8a19c68562cec12d3c71331c0429f449a
+  data.tar.gz: 92a591f3707ad982c923c86392c9b3204ab8348a27a006320f91ea27ca9122aa
 SHA512:
-  metadata.gz: 35f308119cb2c44d09974ce1f9fda973e648212aefb36d6256678d0b281de6784be265bc87781b55f3aa05d5a3d6ddfdd60beb86e77420f629fab02e72e87be7
-  data.tar.gz: 3a82f19378b63f47ffcd9ad512ee44a2daa4769ffdaed6b01cd90e867e3cea31c200d264820f91af8307f0e43bb3a2c03944aa0d107bd2beeb6e6464a46cb8c7
+  metadata.gz: 542f4e56cd23a025151c4b4d0f5ba4c9ffb2b002fb9e87c35170bea903c4d82f722501f5b4a6954af06638ea74795609491b5709511476a49d82ad4011d3918c
+  data.tar.gz: 681b07990f0f8e74ebed98ea43d54bbabb228ea636c140bc56aa8f9f06c75b0340bff019a2367a44c9d971b26b01b6a9957a4dcb7d78540dd1b166d5d68bbec1

data/Gemfile

@@ -10,6 +10,4 @@ gem "rails"
 gem "rake"
 gem "rspec"
 gem "rubocop-config-umbrellio"
-gem "sentry-ruby"
-gem "sentry-sidekiq"
 gem "sidekiq"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    memolog (0.3.0)
+    memolog (0.3.4)
       logger (~> 1.4.3)
       securerandom (~> 0.1.0)
 
@@ -75,25 +75,6 @@ GEM
     crass (1.0.6)
     diff-lcs (1.4.4)
     erubi (1.10.0)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
     globalid (0.5.2)
       activesupport (>= 5.0)
     i18n (1.8.10)
@@ -108,7 +89,6 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.1)
     minitest (5.14.4)
-    multipart-post (2.1.1)
     nio4r (2.5.8)
     nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
@@ -201,18 +181,7 @@ GEM
     rubocop-sequel (0.2.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
     securerandom (0.1.1)
-    sentry-ruby (4.7.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      faraday (>= 1.0)
-      sentry-ruby-core (= 4.7.3)
-    sentry-ruby-core (4.7.3)
-      concurrent-ruby
-      faraday
-    sentry-sidekiq (4.7.3)
-      sentry-ruby-core (~> 4.7.0)
-      sidekiq (>= 3.0)
     sidekiq (6.2.2)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
@@ -244,8 +213,6 @@ DEPENDENCIES
   rake
   rspec
   rubocop-config-umbrellio
-  sentry-ruby
-  sentry-sidekiq
   sidekiq
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,7 @@
 # Memolog
 
 Memolog is an in-memory logger, which extend any other logger.
-Designed to work with [Sentry](https://github.com/getsentry/sentry-ruby).
-It adds `memolog` extra section to Sentry errors.
+Designed to work with [Sentry](https://github.com/getsentry/sentry-ruby) but it's not necessary.
 
 ## Installation
 
@@ -28,31 +27,36 @@ Use this example during application initialization process (this example impleme
 Memolog.configure do |config|
   config.debug = false
   config.formatter = ::Memolog::Formatter.new
-  config.initializers = %i[rails sentry sidekiq]
+  config.middlewares = %i[rails sidekiq]
   config.log_size_limit = 50_000
-  config.sentry_key = :memolog
   config.uuid_callable = -> { SecureRandom.uuid }
 end
 
-Memolog.init!
+Memolog.init_middlewares!
 ```
 
 Available options are:
 - `debug` - set it to true if you need to leave Memolog.dump result outside `Memolog.run {}` block.
 - `formatter` - setup your own formatter.
-- `initializers` - define here what you want to initialize in `#init!` call.
-- `log_size_limit` - max log length in Sentry event.
-- `sentry_key` - key name in Sentry extra object.
+- `middlewares` - define here what you want to initialize in `#init_middlewares!` call.
+- `log_size_limit` - max log length in `#dump`.
 - `uuid_callable` - Memolog add unique value to logs, here you can redefine uuid generation.
 
+If you want to apply Sentry monkey patch that call `Memolog.dump` before `Sentry.capture_exception`
+and `Sentry.capture_message` you can implement it via this code:
+
+```ruby
+Sentry.prepend(Memolog::SentryExtension)
+```
+
 ## Usage
 
 Please call `Memolog.extend_logger(Rails.logger)` or any other logger you want to collect.
-After that when error occured you can check your Sentry report and see `memolog` section with all
-logs collected before error. Also there will be unique identifier to find logs behaviour on your
-server or log collection system.
+After that when error occured you can call `Memolog.dump` in your code and get log from
+`Rails.logger` so you can collect it to another place (Sentry or etc). Also there will be unique
+identifier to find logs behaviour on your server or log collection system.
 
-Memolog has init code for Rails (Middleware), Sentry (Extension) and Sidekiq (Middleware).
+Memolog has init code for Rails (Middleware) and Sidekiq (Middleware).
 It implement all hacks on the `Memolog.init!` call.
 Also you can add `Memolog.run {}` around logs you want to collect and release it with `Memolog.dump`
 inside this block.

data/lib/memolog/config.rb

@@ -3,17 +3,15 @@
 Memolog::Config = Struct.new(
   :debug,
   :formatter,
-  :initializers,
+  :middlewares,
   :log_size_limit,
-  :sentry_key,
   :uuid_callable,
 ) do
   def initialize
     self.debug = false
     self.formatter = ::Memolog::Formatter.new
-    self.initializers = %i[rails sentry sidekiq]
+    self.middlewares = %i[rails sidekiq]
     self.log_size_limit = 50_000
-    self.sentry_key = :memolog
     self.uuid_callable = -> { SecureRandom.uuid }
   end
 end

data/lib/memolog/init.rb

@@ -1,35 +1,29 @@
 # frozen_string_literal: true
 
-class Memolog::Init
-  def call
-    init_rails!
-    init_sentry!
-    init_sidekiq!
-  end
+module Memolog::Init
+  extend self
 
-  private
+  def init_middlewares!
+    init_rails_middleware!
+    init_sidekiq_middleware!
+  end
 
-  def init_rails!
-    return unless Memolog.config.initializers.include?(:rails)
+  def init_rails_middleware!
+    return unless Memolog.config.middlewares.include?(:rails)
     return unless Object.const_defined?("Rails")
     return if Object.const_defined?("Sidekiq") && Sidekiq.server?
 
-    Rails.application.middleware.insert_before(0, Memolog::Middleware)
-  end
-
-  def init_sentry!
-    return unless Memolog.config.initializers.include?(:sentry)
-    return unless Object.const_defined?("Sentry::Scope")
-
-    Sentry::Scope.prepend(Memolog::SentryScopeExtension)
+    Rails.application.middleware.insert_before(0, Memolog::RailsMiddleware)
   end
 
-  def init_sidekiq!
-    return unless Memolog.config.initializers.include?(:sidekiq)
-    return unless Object.const_defined?("Sentry::Sidekiq::SentryContextServerMiddleware")
+  def init_sidekiq_middleware!
+    return unless Memolog.config.middlewares.include?(:sidekiq)
+    return unless Object.const_defined?("Sidekiq")
 
-    Sentry::Sidekiq::SentryContextServerMiddleware.prepend(
-      Memolog::SentrySidekiqMiddlewareExtension,
-    )
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.prepend(Memolog::SidekiqMiddleware)
+      end
+    end
   end
 end

data/lib/memolog/{extension.rb → logger_extension.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Memolog::Extension
+module Memolog::LoggerExtension
   def add(*args, &block)
     Memolog.logger.log(*args, &block)
     super

data/lib/memolog/{middleware.rb → rails_middleware.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Memolog::Middleware
+class Memolog::RailsMiddleware
   def initialize(app)
     @app = app
   end

data/lib/memolog/sentry_extension.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Memolog::SentryExtension
+  def self.prepended(base)
+    base.singleton_class.send(:prepend, ClassMethods)
+  end
+
+  module ClassMethods
+    def capture_exception(exception, **options, &block)
+      set_extras_memolog!
+      super
+    end
+
+    def capture_message(message, **options, &block)
+      set_extras_memolog!
+      super
+    end
+
+    def set_extras_memolog!
+      return unless get_current_scope
+      set_extras(memolog: Memolog.dump)
+    end
+  end
+end

data/lib/memolog/sidekiq_middleware.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Memolog::SidekiqMiddleware
+  def call(*)
+    Memolog.run { yield } # rubocop:disable Style/ExplicitBlockArgument
+  end
+end

data/lib/memolog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Memolog
-  VERSION = "0.3.0"
+  VERSION = "0.3.4"
 end

data/lib/memolog.rb

@@ -6,31 +6,30 @@ require "stringio"
 
 require "memolog/version"
 require "memolog/config"
-require "memolog/extension"
 require "memolog/formatter"
 require "memolog/init"
-require "memolog/middleware"
-require "memolog/sentry_scope_extension"
-require "memolog/sentry_sidekiq_middleware_extension"
+require "memolog/logger_extension"
+require "memolog/rails_middleware"
+require "memolog/sentry_extension"
+require "memolog/sidekiq_middleware"
 
 module Memolog
   extend self
 
-  attr_accessor :config, :logdevs
+  attr_accessor :config
 
   @config = Memolog::Config.new
-  @logdevs = []
 
   def configure
     yield(config) if block_given?
   end
 
-  def init!
-    Memolog::Init.new.call
+  def init_middlewares!
+    Memolog::Init.init_middlewares!
   end
 
   def extend_logger(other_logger)
-    other_logger.extend(Memolog::Extension)
+    other_logger.extend(Memolog::LoggerExtension)
     other_logger.formatter = config.formatter
   end
 
@@ -42,6 +41,10 @@ module Memolog
     Thread.current[:memolog_logger] ||= Logger.new(nil, formatter: config.formatter)
   end
 
+  def logdevs
+    Thread.current[:memolog_logdevs] ||= []
+  end
+
   def run
     Thread.current[:memolog_uuid] = config.uuid_callable.call
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memolog
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Stepan Kirushkin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-21 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -61,12 +61,12 @@ files:
 - bin/setup
 - lib/memolog.rb
 - lib/memolog/config.rb
-- lib/memolog/extension.rb
 - lib/memolog/formatter.rb
 - lib/memolog/init.rb
-- lib/memolog/middleware.rb
-- lib/memolog/sentry_scope_extension.rb
-- lib/memolog/sentry_sidekiq_middleware_extension.rb
+- lib/memolog/logger_extension.rb
+- lib/memolog/rails_middleware.rb
+- lib/memolog/sentry_extension.rb
+- lib/memolog/sidekiq_middleware.rb
 - lib/memolog/version.rb
 homepage: https://github.com/skirushkin/memolog
 licenses:

data/lib/memolog/sentry_scope_extension.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Memolog::SentryScopeExtension
-  def apply_to_event(scope, hint = nil)
-    memolog_dump = Memolog.dump
-    set_extras(Memolog.config.sentry_key => memolog_dump) if memolog_dump
-
-    super
-  end
-end

data/lib/memolog/sentry_sidekiq_middleware_extension.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Memolog::SentrySidekiqMiddlewareExtension
-  def call(worker, job, queue)
-    Memolog.run { super }
-  end
-end