ntq_tools 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '019d7dc36a586c41c90f0344dc403b659636885801160c02ce727bce64a67c02'
-  data.tar.gz: c428933a52c6da37c406d6b7d67506c653144c8db7b0256c7a0ac5979f784a5f
+  metadata.gz: 94c540289f3f6ae2a2c2956b0ee7ee132c57eb7091f36e54350f88cbb86762d2
+  data.tar.gz: ba67366fe693e767e9a7219b7d9600e03a533d2f1094fa02d3f6b94e532c6393
 SHA512:
-  metadata.gz: 16a33bdd9c21bb5c83f4f3b82bc983f8072ce75bf31a144c1056fc364e6a10e03392055e1d4c44c85e6690c5993c6f00e7bd52e7fb028577c1d99fefe22388ef
-  data.tar.gz: d52ae223a99923e7c85c47d240d81b65f222c2be988aa044b7c0336c12345206382b1ae961a22fa3b9dd4a8010105fe66cf632232816150bdf2a63bf36716c31
+  metadata.gz: 223b5fda86121d12cdd0c109aaedfb53551dd4d1c5ea584ee13d5b968f62184e50271c43cd5f4acb47aa1872c545e5d640253db1062b1dfe338b412b8d6f4d1f
+  data.tar.gz: 54addce36763c562fd8a8281edebacb3f5262b0b06bfc4eaaa68321e29e4dd79391f915277a9b42deb72c0a703de0bcbcf29ac5a363119577ffaa465457999a8

data/README.md

@@ -4,6 +4,14 @@ Short description and motivation.
 ## Usage
 How to use my plugin.
 
+## Monitoring
+Pour activer le monitoring, veillez à ajouter ces variables d'environnement
+
+```
+MONITORING_PASSWORD
+MONITORING_USERNAME
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/app/controllers/ntq_tools/monitors_controller.rb

@@ -0,0 +1,27 @@
+require 'ntq_tools/monitor'
+module NtqTools
+  class MonitorsController < ActionController::Base
+
+    before_action :check_basic_auth
+
+    def check
+      @status, @services_status = NtqTools::Monitor.check
+
+      respond_to do |format|
+        format.json do
+          render json: { status: @status, services_status: @services_status }, status: @status == 'OK' ? :ok : :service_unavailable
+        end
+        format.html do
+        end
+      end
+    end
+
+  private
+
+    def check_basic_auth
+      authenticate_or_request_with_http_basic do |username, password|
+        username == ENV['MONITORING_USERNAME'] && password == ENV['MONITORING_PASSWORD']
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,6 +1,10 @@
 NtqTools::Engine.routes.draw do
-  resource :translation, only: [:update, :show]
-  get '/translation/refresh' => "translations#refresh"
+  get '/check' => "monitors#check"
+
+  if Rails.env.development?
+    resource :translation, only: [:update, :show]
+    get '/translation/refresh' => "translations#refresh"
+  end
 
   if NtqTools.impersonation_enabled && NtqTools.impersonation_user_models.any? && defined?(Devise) && Rails.env.development?
     get '/impersonation/users' => "impersonation#index"

data/lib/ntq_tools/monitor.rb

@@ -0,0 +1,37 @@
+require 'ntq_tools/monitors/redis'
+require 'ntq_tools/monitors/database'
+require 'ntq_tools/monitors/sidekiq'
+
+module NtqTools
+  class Monitor
+
+    # Check if installed services are running, it return a tuple with the status and the services status
+    #
+    # eg: [:ok, [{name: 'redis', status: 'OK'}, {name: 'database', status: 'OK'}]]
+    # eg: [:error, [{name: 'redis', status: 'OK'}, {name: 'database', status: 'ERROR'}]]
+    #
+    # @return [Symbol, Array<Hash>]
+    def self.check
+      services_status = []
+      list.each do |monitor|
+        next unless monitor.is_installed?
+
+        services_status << {
+          name: monitor.name,
+          status: monitor.check ? 'OK' : 'ERROR'
+        }
+      end
+      status = services_status.all? { |service| service[:status] == 'OK' } ? :ok : :error
+      [status, services_status]
+    end
+    
+    def self.list
+      [
+        ::NtqTools::Monitors::Redis,
+        ::NtqTools::Monitors::Database,
+        ::NtqTools::Monitors::Sidekiq
+      ]
+    end
+  
+  end
+end

data/lib/ntq_tools/monitors/base.rb

@@ -0,0 +1,20 @@
+module NtqTools
+  module Monitors
+    class Base
+      class << self
+  
+        def name
+          "You must define the name method in your monitor class"
+        end
+  
+        def is_installed?
+          "You must define the is_installed? method in your monitor class"
+        end
+  
+        def check
+          "You must define the check method in your monitor class"
+        end
+      end
+    end
+  end
+end

data/lib/ntq_tools/monitors/database.rb

@@ -0,0 +1,21 @@
+require 'ntq_tools/monitors/base'
+module NtqTools
+  module Monitors
+    class Database < Base
+  
+      class << self
+        def name
+          "database"
+        end
+    
+        def is_installed?
+          defined?(::ActiveRecord).present?
+        end
+    
+        def check
+          ::ActiveRecord::Base.connection_pool.with_connection { |con| con.active? } rescue false
+        end
+      end
+    end
+  end
+end

data/lib/ntq_tools/monitors/redis.rb

@@ -0,0 +1,23 @@
+require 'ntq_tools/monitors/base'
+module NtqTools
+  module Monitors
+    class Redis < Base
+  
+      class << self
+        def name
+          'redis'
+        end
+    
+        def is_installed?
+          ::Gem.loaded_specs.has_key?("redis")
+        end
+    
+        def check
+          ::Sidekiq.redis { |con| con.ping }.present?
+        rescue ::Redis::CannotConnectError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/ntq_tools/monitors/sidekiq.rb

@@ -0,0 +1,22 @@
+require 'ntq_tools/monitors/base'
+module NtqTools
+  module Monitors
+    class Sidekiq < Base
+  
+      class << self
+        def name
+          "sidekiq"
+        end
+    
+        def is_installed?
+          ::Gem.loaded_specs.has_key?("sidekiq")
+        end
+    
+        def check
+          ::Sidekiq::ProcessSet.new.any? { |process| process['busy'] }
+        end
+      end
+  
+    end
+  end
+end

data/lib/ntq_tools/version.rb

@@ -1,3 +1,3 @@
 module NtqTools
-  VERSION = "0.6.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ntq_tools
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Kevin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: missing_translation
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,7 @@ files:
 - app/assets/stylesheets/ntq_tools/application.css
 - app/controllers/ntq_tools/application_controller.rb
 - app/controllers/ntq_tools/impersonation_controller.rb
+- app/controllers/ntq_tools/monitors_controller.rb
 - app/controllers/ntq_tools/translations_controller.rb
 - app/helpers/ntq_tools/application_helper.rb
 - app/jobs/ntq_tools/application_job.rb
@@ -70,6 +71,11 @@ files:
 - lib/generators/templates/ntq_tools.rb
 - lib/ntq_tools.rb
 - lib/ntq_tools/engine.rb
+- lib/ntq_tools/monitor.rb
+- lib/ntq_tools/monitors/base.rb
+- lib/ntq_tools/monitors/database.rb
+- lib/ntq_tools/monitors/redis.rb
+- lib/ntq_tools/monitors/sidekiq.rb
 - lib/ntq_tools/translations/hash_utils.rb
 - lib/ntq_tools/translations/translation_tool.rb
 - lib/ntq_tools/translations/yaml_tool.rb