job_enqueue_logger 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d4b7eb9d105f9c73af421299c43d70573c5ac5b519cf5a334d0a78ed2b704f9
-  data.tar.gz: efe3b6d93873f70676e6c7b9cd085328332fda9cba8fcad99007f4151f3e253c
+  metadata.gz: dea7d0e16e19e83d6a41a6ac12dfb637670b6c2767ffd859a65c33eb1fe6fb1b
+  data.tar.gz: 44da64bbfc0bcc1984dff1bb971768d0ebec961e4eefba46b9223c38115f6376
 SHA512:
-  metadata.gz: 523da331a92ea785d6a58ce1fbd3e4bcbc9dbbe1a8f3f2974ee2bb0b581a805e100f7e4d0f225710e7e83bf699916514b84e163ba7bec1e302bfcb143752e858
-  data.tar.gz: 2c2b9128d579945615e85eebdd71531e64027b82ad9e16bbff4d1203a96c875f237a977e3b33aaa7f65ea41b433f4cee8abbaba81201c622383e9336ca47663b
+  metadata.gz: 2b20c92834369550756fe71f0f27c76dca198fe267fad432765740bbcf3a1ed034e89aa126fb2acf6e76978f632813241176af77a7d139762ffd4d7ba9f4c2e5
+  data.tar.gz: e5ef769550740936181d7fa72b78bc6c132542095e0bb66f7c4973bf90298bc6ffed1d168e4aa553f4b60ae8266fc8221dbfa611fc02c1855ffa48a110157592

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## master (unreleased)
 
+## 0.3.0 (2023-11-09)
+
+- Truncate long string arguments in log output
+- Add ability to set logger
+- Prefix this gem log lines with `[JobEnqueueLogger]`
+
 ## 0.2.0 (2023-04-04)
 
 - Support `que`

data/README.md

@@ -11,13 +11,13 @@ This is very much a development and debugging tool; it is not recommended to use
 When the job is enqueued within the guts of the application, the log line is generated:
 
 ```
-Enqueued AvatarThumbnailsJob (jid=578b3d10fc5403f97ee0a8e1) to Sidekiq(default) with arguments: 1092412064
+[JobEnqueueLogger] Enqueued AvatarThumbnailsJob (jid=578b3d10fc5403f97ee0a8e1) to Sidekiq(default) with arguments: 1092412064
 ```
 
 Or with backtraces enabled:
 
 ```
-Enqueued AvatarThumbnailsJob (jid=578b3d10fc5403f97ee0a8e1) to Sidekiq(default) with arguments: 1092412064
+[JobEnqueueLogger] Enqueued AvatarThumbnailsJob (jid=578b3d10fc5403f97ee0a8e1) to Sidekiq(default) with arguments: 1092412064
 ↳ app/models/user.rb:421:in `generate_avatar_thumbnails'
   app/services/user_creator.rb:21:in `call'
   app/controllers/users_controller.rb:49:in `create'
@@ -71,13 +71,15 @@ JobEnqueueLogger.configure do |config|
   # Controls whether to print backtraces. Set to `true` to print backtraces, or
   # a number to limit how many lines to print.
   config.backtrace = false
+
+  # The logger to log to.
+  # Is set to Rails.logger by default, when the gem is used in the Rails app.
+  config.logger = nil
 end
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/lib/job_enqueue_logger/delayed_job_adapter.rb

@@ -34,8 +34,8 @@ module JobEnqueueLogger
       alias server? server
 
       def logger
-        if !server? && defined?(Rails)
-          Rails.logger
+        if !server? && JobEnqueueLogger.logger
+          JobEnqueueLogger.logger
         else
           Delayed::Worker.logger
         end

data/lib/job_enqueue_logger/que_adapter.rb

@@ -56,8 +56,8 @@ module JobEnqueueLogger
       # Que.server? is defined in the newest version of Que - https://github.com/que-rb/que/pull/382
       is_server = defined?(Que::CommandLineInterface)
 
-      if !is_server && defined?(Rails)
-        Rails.logger
+      if !is_server && JobEnqueueLogger.logger
+        JobEnqueueLogger.logger
       elsif Que.logger.respond_to?(:call)
         Que.logger.call
       else

data/lib/job_enqueue_logger/railtie.rb

@@ -6,6 +6,7 @@ module JobEnqueueLogger
   class Railtie < Rails::Railtie
     initializer "job_enqueue_logger.backtrace_cleaner" do
       JobEnqueueLogger.backtrace_cleaner = Rails.backtrace_cleaner
+      JobEnqueueLogger.logger = Rails.logger
     end
   end
 end

data/lib/job_enqueue_logger/resque_adapter.rb

@@ -41,8 +41,8 @@ module JobEnqueueLogger
       alias server? server
 
       def logger
-        if !server? && defined?(Rails)
-          Rails.logger
+        if !server? && JobEnqueueLogger.logger
+          JobEnqueueLogger.logger
         else
           Resque.logger
         end

data/lib/job_enqueue_logger/sidekiq_adapter.rb

@@ -47,8 +47,8 @@ module JobEnqueueLogger
     end
 
     def self.logger
-      if !Sidekiq.server? && defined?(Rails)
-        Rails.logger
+      if !Sidekiq.server? && JobEnqueueLogger.logger
+        JobEnqueueLogger.logger
       else
         Sidekiq.logger
       end

data/lib/job_enqueue_logger/sucker_punch_adapter.rb

@@ -28,11 +28,7 @@ module JobEnqueueLogger
     end
 
     def self.logger
-      if defined?(Rails)
-        Rails.logger
-      else
-        SuckerPunch.logger
-      end
+      JobEnqueueLogger.logger || SuckerPunch.logger
     end
   end
 end

data/lib/job_enqueue_logger/utils.rb

@@ -3,6 +3,7 @@
 module JobEnqueueLogger
   module Utils
     def self.log_job_enqueue(logger, message)
+      message = "[JobEnqueueLogger] #{message}"
       return logger.info(message) unless JobEnqueueLogger.backtrace
 
       backtrace = caller
@@ -19,10 +20,19 @@ module JobEnqueueLogger
 
     def self.args_info(args)
       if Array(args).any?
-        " with arguments: #{Array(args).map(&:inspect).join(', ')}"
+        " with arguments: #{Array(args).map { |arg| format_arg(arg).inspect }.join(', ')}"
       else
         ""
       end
     end
+
+    def self.format_arg(arg)
+      case arg
+      when String
+        arg.size > 100 ? "#{arg[0, 100]}…" : arg
+      else
+        arg
+      end
+    end
   end
 end

data/lib/job_enqueue_logger/version.rb

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

data/lib/job_enqueue_logger.rb

@@ -16,7 +16,7 @@ module JobEnqueueLogger
         end
     end
 
-    attr_accessor :backtrace
+    attr_accessor :backtrace, :logger
 
     def configure
       yield self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: job_enqueue_logger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Log background jobs enqueued by your application (additionally with backtraces).
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Log background jobs enqueued by your application (additionally with backtraces).