memolog 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd5031cdc39d67fc6409bbe9d71028129040f13abd8f30445e5b0c4f090a005
-  data.tar.gz: 8d5e0699f794abd16aa2a2e11562085d538581c567af030bf7d3bd0e3e9bd304
+  metadata.gz: a0f3276d2ccd3726c5e46dee8275cee70124955d9b8764e371097324a4643713
+  data.tar.gz: c6ca8429d029135ba450f232d80a1406d4256a03193705ead871d39e7800698a
 SHA512:
-  metadata.gz: a894bc14c69acadbacd0dded2ea7ce4d04f2e607e19ecec70c570160976a0c79b8a9513b1024e305066bf4490e84ac8cc2927cf7a096e9df80cde82fe5f2fabe
-  data.tar.gz: 0415da3006d84de2b1804d3b2ac7e26d8f793617861a22c0a6eb71291c2d1071ff021b4859b9ee53d23b609bf66aaa4e7cef5e338d6fb9e6fb708fa874f5f197
+  metadata.gz: 706306f7722c755d2df86f76141a102d9da097b8bab2b64830fc1381652c64da5ba45bba31ed696773f641f4864bd2d1c06a91e191bfe1e4ea0192d3e56c0eac
+  data.tar.gz: 2136479ffe04455d9a56ba52fce097a182deb65c924a7a9f1a18e653eb49419a2063c895f72242c1ee581596bc95688f8f0759de175e3c7819e3e91346041ffe

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
+## 0.2.0
 
-## [0.1.0] - 2021-09-27
+- Uprade gem due [CVE-2021-41098](https://github.com/advisories/GHSA-2rr5-8q37-2w7h)
+- Add initializers config option, available initializers are [rails, sentry, sidekiq].
+- Move debug option to config.
+
+## 0.1.0
 
 - Test version for publish and test workflow.

data/Gemfile

@@ -4,3 +4,11 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in memolog.gemspec
 gemspec
+
+gem "pry"
+gem "rails"
+gem "rake"
+gem "rspec"
+gem "rubocop-config-umbrellio"
+gem "sentry-ruby"
+gem "sidekiq"

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    memolog (0.1.0)
-      logger
-      securerandom
+    memolog (0.2.0)
+      logger (~> 1.4.3)
+      securerandom (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -110,9 +110,9 @@ GEM
     minitest (5.14.4)
     multipart-post (2.1.1)
     nio4r (2.5.8)
-    nokogiri (1.12.4-x86_64-darwin)
+    nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.12.4-x86_64-linux)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     parallel (1.21.0)
     parser (3.0.2.0)
@@ -177,7 +177,7 @@ GEM
       rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
     rubocop-config-umbrellio (1.17.0.53)
       rubocop (= 1.17.0)

data/README.md

@@ -20,10 +20,40 @@ Or install it yourself as:
 
     $ gem install memolog
 
+## Configuration
+
+Use this example during application initialization process (this example implement default values):
+
+```ruby
+Memolog.configure do |config|
+  config.debug = false
+  config.formatter = ::Memolog::Formatter.new
+  config.initializers = %i[rails sentry sidekiq]
+  config.log_size_limit = 50_000
+  config.sentry_key = :memolog
+  config.uuid_callable = -> { SecureRandom.uuid }
+end
+
+Memolog.init!
+```
+
+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.
+- `uuid_callable` - Memolog add unique value to logs, here you can redefine uuid generation.
+
 ## 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.
+
 Memolog has init code for Rails (Middleware), Sentry (Extension) and Sidekiq (Middleware).
-It implement all hacks on the load process.
+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

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

data/lib/memolog/init.rb

@@ -1,17 +1,31 @@
 # frozen_string_literal: true
 
-if defined?(Rails::Railtie)
-  require "memolog/railtie"
-end
+class Memolog::Init
+  def call
+    init_rails!
+    init_sentry!
+    init_sidekiq!
+  end
 
-if defined?(Sentry::Scope)
-  Sentry::Scope.prepend(Memolog::SentryScopeExtension)
-end
+  private
+
+  def init_rails!
+    return unless defined?(Rails) && Memolog.config.initializers.include?(:rails)
+    require "memolog/railtie"
+  end
+
+  def init_sentry!
+    return unless defined?(Sentry::Scope) && Memolog.config.initializers.include?(:sentry)
+    Sentry::Scope.prepend(Memolog::SentryScopeExtension)
+  end
+
+  def init_sidekiq!
+    return unless defined?(Sidekiq) && Memolog.config.initializers.include?(:sidekiq)
 
-if defined?(Sidekiq)
-  Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.prepend(Memolog::SentrySidekiqMiddleware)
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.prepend(Memolog::SentrySidekiqMiddleware)
+      end
     end
   end
 end

data/lib/memolog/version.rb

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

data/lib/memolog.rb

@@ -2,52 +2,55 @@
 
 require "logger"
 require "securerandom"
+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"
 
 module Memolog
   extend self
 
-  autoload :VERSION, "memolog/version"
-  autoload :Config, "memolog/config"
-  autoload :Extension, "memolog/extension"
-  autoload :Formatter, "memolog/formatter"
-  autoload :Middleware, "memolog/middleware"
-  autoload :SentryScopeExtension, "memolog/sentry_scope_extension"
-  autoload :SentrySidekiqMiddleware, "memolog/sentry_sidekiq_middleware"
+  attr_accessor :config, :logdevs
 
-  attr_accessor :debug, :logdevs
-
-  self.debug = false
-  self.logdevs = []
+  @config = Memolog::Config.new
+  @logdevs = []
 
   def configure
-    @config ||= Memolog::Config.new
-    yield(@config) if block_given?
-    @config
+    yield(config) if block_given?
+  end
+
+  def init!
+    Memolog::Init.new.call
   end
-  alias config configure
 
   def extend_logger(other_logger)
     other_logger.extend(Memolog::Extension)
     other_logger.formatter = config.formatter
   end
 
-  def logger
-    Thread.current[:memolog_logger] ||= Logger.new(nil, formatter: config.formatter)
-  end
-
   def uuid
     Thread.current[:memolog_uuid]
   end
 
+  def logger
+    Thread.current[:memolog_logger] ||= Logger.new(nil, formatter: config.formatter)
+  end
+
   def run
-    Thread.current[:memolog_uuid] = Memolog.config.uuid_callable.call
+    Thread.current[:memolog_uuid] = config.uuid_callable.call
 
     logdevs.push(StringIO.new)
     logger.instance_variable_set(:@logdev, logdevs.last)
 
     yield
   ensure
-    logdevs.pop unless debug
+    logdevs.pop unless config.debug
   end
 
   def dump
@@ -59,5 +62,3 @@ module Memolog
     logdevs.last.string.slice(beginning, config.log_size_limit)
   end
 end
-
-require "memolog/init"

metadata

@@ -1,141 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: memolog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stepan Kirushkin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.3
 - !ruby/object:Gem::Dependency
   name: securerandom
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-config-umbrellio
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sentry-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 description: |2
       Memolog is an in-memory logger, which extend any other logger.
       Designed to work with Sentry.
@@ -173,7 +75,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/skirushkin/memolog
   source_code_uri: https://github.com/skirushkin/memolog
-  changelog_uri: https://github.com/skirushkin/memolog
+  changelog_uri: https://github.com/skirushkin/memolog/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: