peak_flow_utils 0.1.16 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c01a814a1aad134f668f7144f6addea59f8b8afdc75a2ae8ff2280dbe3a9867c
-  data.tar.gz: b6746741a1ff204c7b2a31319409d84a4529c14a55f8e9cfbf7b7fcad37eacea
+  metadata.gz: 1d6ad793f87d038dc928420a3c35e046fa1fcfb4f610e4fd6bd1c9f8fa445a9e
+  data.tar.gz: 9abdb774bfa6fd91896dfdbe55b6d6d7e931804035712aa51e1c576ab9d4d6cf
 SHA512:
-  metadata.gz: 5a82e952b87453cfde4fbcb42fd43a0f2bca93f43dc2b3dbdca3109c6d25a21dd587745c602680d89c446cda1c1be251167b46248b98bc1e5354f408ae9f2758
-  data.tar.gz: d2020073122505feaa6cb3923f79a76ff6f8608ac45af16625cae83f79c6232a9f4ac677e834faa015bfd1d9e287946b4cc0662557507dcfab89ea7c3faf665e
+  metadata.gz: ef054a48493eb11175e79cfdac7b9c2ae5258c8d67c3113bb0c61633404df7c6b674dc2fda6809a3c0ded02533f7fe88407bc4b8693a6c982d772f84a1f2de51
+  data.tar.gz: 6b4cd15ee4e07feabc1e0c4b6bb9efc59aff36dad76c8fae97ff9f8d1d486dc570ae5e69997f872105dffc6036e167beb00e0995b5b115561964facc12b63da2

data/README.md

@@ -39,6 +39,13 @@ Add this to `config/peakflow.rb`:
 PeakFlowUtils::NotifierRails.configure
 ```
 
+### Reporting ActiveJob errors in Rails:
+
+If you want the job name and its arguments logged in parameters you can execute this service:
+```ruby
+PeakFlowUtils::ActiveJobParametersLogging.execute!
+```
+
 ### Reporting Sidekiq errors in Rails:
 
 Add this to `config/peakflow.rb`:
@@ -46,6 +53,31 @@ Add this to `config/peakflow.rb`:
 PeakFlowUtils::NotifierSidekiq.configure
 ```
 
+If you want the job name and its arguments logged in parameters you can execute this service:
+```ruby
+PeakFlowUtils::SidekiqParametersLogging.execute!
+```
+
+### Sidekiq and Postgres pings
+
+Add this to `routes.rb`:
+```ruby
+Rails.application.routes.draw do
+  mount PeakFlowUtils::Engine => "/peakflow_utils"
+```
+
+Add these to .env variables:
+```
+PEAKFLOW_PINGS_USERNAME=username
+PEAKFLOW_PINGS_PASSWORD=secret-password
+```
+
+You can now add a HTTP ping on this path:
+`/peakflow_utils/pings/sidekiq`
+
+And this for Postgres:
+`/pings/postgres_connections`
+
 ## Contributing
 Contribution directions go here.
 

data/app/controllers/peak_flow_utils/application_controller.rb

@@ -9,7 +9,7 @@ private
     authenticate_or_request_with_http_basic do |username, password|
       if ENV["PEAKFLOW_PINGS_USERNAME"].blank? || ENV["PEAKFLOW_PINGS_PASSWORD"].blank?
         Rails.logger.error "Peakflow utils: Pings called but PEAKFLOW_PINGS_USERNAME or PEAKFLOW_PINGS_PASSWORD wasn't set"
-        false
+        return false
       end
 
       username == ENV.fetch("PEAKFLOW_PINGS_USERNAME") && password == ENV.fetch("PEAKFLOW_PINGS_PASSWORD")

data/app/controllers/peak_flow_utils/pings/sidekiq_controller.rb

@@ -1,7 +1,6 @@
-require "sidekiq/api"
-
 class PeakFlowUtils::Pings::SidekiqController < PeakFlowUtils::ApplicationController
   def index
+    require "sidekiq/api"
     sidekiq_queue = Sidekiq::Queue.new
 
     render json: {

data/app/services/peak_flow_utils/active_job_parameters_logging.rb

@@ -0,0 +1,13 @@
+class PeakFlowUtils::ActiveJobParametersLogging < PeakFlowUtils::ApplicationService
+  def perform
+    ActiveJob::Base.class_eval do
+      around_perform do |job, block|
+        PeakFlowUtils::Notifier.with_parameters(active_job: {job_name: job.class.name, job_arguments: job.arguments}) do
+          block.call
+        end
+      end
+    end
+
+    succeed!
+  end
+end

data/app/services/peak_flow_utils/sidekiq_parameters_logging.rb

@@ -0,0 +1,16 @@
+class PeakFlowUtils::SidekiqParametersLogging < PeakFlowUtils::ApplicationService
+  def perform
+    require "sidekiq"
+    require "sidekiq/processor"
+
+    Sidekiq::Processor.class_eval do
+      def execute_job(worker, cloned_args)
+        PeakFlowUtils::Notifier.with_parameters(sidekiq: {worker_class_name: worker.class.name, cloned_args: cloned_args}) do
+          worker.perform(*cloned_args)
+        end
+      end
+    end
+
+    succeed!
+  end
+end

data/lib/peak_flow_utils/notifier.rb

@@ -1,6 +1,7 @@
 class PeakFlowUtils::Notifier
   class FailedToReportError < RuntimeError; end
   class NotConfiguredError < RuntimeError; end
+  class NotifyMessageError < RuntimeError; end
 
   attr_reader :auth_token, :mutex, :parameters
 
@@ -16,6 +17,10 @@ class PeakFlowUtils::Notifier
     PeakFlowUtils::Notifier.current&.notify(*args, **opts, &blk)
   end
 
+  def self.notify_message(*args, **opts, &blk)
+    PeakFlowUtils::Notifier.current&.notify_message(*args, **opts, &blk)
+  end
+
   def self.reset_parameters
     ::PeakFlowUtils::Notifier.current&.instance_variable_set(:@parameters, ::PeakFlowUtils::InheritedLocalVar.new({}))
   end
@@ -104,6 +109,12 @@ class PeakFlowUtils::Notifier
     send_notify_request(data: data, uri: uri)
   end
 
+  def notify_message(message, **opts)
+    raise NotifyMessageError, message
+  rescue NotifyMessageError => e
+    notify(error: e, **opts)
+  end
+
   def send_notify_request(data:, uri:)
     https = ::Net::HTTP.new(uri.host, uri.port)
     https.use_ssl = true

data/lib/peak_flow_utils/version.rb

@@ -1,3 +1,3 @@
 module PeakFlowUtils
-  VERSION = "0.1.16".freeze
+  VERSION = "0.1.18".freeze
 end

data/lib/peak_flow_utils.rb

@@ -8,8 +8,6 @@ module PeakFlowUtils
   models_path = "#{__dir__}/peak_flow_utils/models"
   services_path = File.realpath("#{__dir__}/../app/services/peak_flow_utils")
 
-  autoload :ApplicationService, "#{services_path}/application_service"
-  autoload :DeepMerger, "#{services_path}/deep_merger"
   autoload :InheritedLocalVar, "#{path}/inherited_local_var"
   autoload :Notifier, "#{path}/notifier"
   autoload :NotifierErrorParser, "#{path}/notifier_error_parser"
@@ -26,4 +24,9 @@ module PeakFlowUtils
   autoload :ScannedFile, "#{models_path}/scanned_file"
   autoload :TranslationKey, "#{models_path}/translation_key"
   autoload :TranslationValue, "#{models_path}/translation_value"
+
+  autoload :ActiveJobParametersLogging, "#{services_path}/active_job_parameters_logging"
+  autoload :ApplicationService, "#{services_path}/application_service"
+  autoload :SidekiqParametersLogging, "#{services_path}/sidekiq_parameters_logging"
+  autoload :DeepMerger, "#{services_path}/deep_merger"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peak_flow_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.18
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -157,6 +157,7 @@ files:
 - app/handlers/peak_flow_utils/simple_form_handler.rb
 - app/handlers/peak_flow_utils/validations_handler.rb
 - app/handlers/peak_flow_utils/will_paginate_handler.rb
+- app/services/peak_flow_utils/active_job_parameters_logging.rb
 - app/services/peak_flow_utils/application_migration.rb
 - app/services/peak_flow_utils/application_service.rb
 - app/services/peak_flow_utils/attribute_service.rb
@@ -169,6 +170,7 @@ files:
 - app/services/peak_flow_utils/group_service.rb
 - app/services/peak_flow_utils/handlers_finder_service.rb
 - app/services/peak_flow_utils/model_inspector.rb
+- app/services/peak_flow_utils/sidekiq_parameters_logging.rb
 - app/services/peak_flow_utils/translation_service.rb
 - app/services/peak_flow_utils/translations_parser_service.rb
 - config/routes.rb