Merge branch 'feat/DEX-2163/autoload-yabeda-server' into 'master'

[DEX-2163] feat: autostart yabeda server

Closes DEX-2163

See merge request nstmrt/rubygems/outbox!90

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased] - yyyy-mm-dd
 
+## [6.4.0] - 2024-05-02
+
+### Added
+- added autostart of the yabeda server via the `enabled` option
+- added disabling autorun of probes via the `enabled` option
+
 ## [6.3.1] - 2024-05-01
 
 ### Added

README.md

@@ -224,7 +224,11 @@ The `outbox.yml` configuration file is the main configuration for the gem, where
 default: &default
   owner: foo-team # optional, used in Yabeda metrics
   bucket_size: 16 # optional, default 16, see into about the buckets at the #Concurrency section
+  metrics:
+    enabled: true # default false, yabeda server autostart with port: 9090 and path: /metrics
+    port: 9090 # optional, default, used in Yabeda metrics
   probes:
+    enabled: false # optional, default true
     port: 5555 # default, used for Kubernetes probes
 
   outbox_items: # outbox items section

lib/generators/outbox/install/templates/outbox.yml

@@ -1,6 +1,8 @@
 default: &default
   owner: owner-team
   bucket_size: 16
+  metrics:
+    enabled: true
 
   probes:
       port: SET-UP-YOUR-HEALTHCHECK-PORT-HERE

lib/sbmt/outbox.rb

@@ -38,6 +38,7 @@
 require_relative "outbox/middleware/builder"
 require_relative "outbox/middleware/runner"
 require_relative "outbox/probes/probe"
+require_relative "outbox/probes/metrics"
 require_relative "outbox/redis_client_factory"
 
 module Sbmt

lib/sbmt/outbox/cli.rb

@@ -69,8 +69,8 @@ def start
         $stdout.puts AsciiArt.logo
         $stdout.puts "Outbox/Inbox worker has been started"
         $stdout.puts "Version: #{VERSION}"
-        $stdout.puts "Starting probes..."
         Sbmt::Outbox::Probes::Probe.run_probes
+        Sbmt::Outbox::Probes::Metrics.run_metrics
 
         worker.start
       end

lib/sbmt/outbox/probes/metrics.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sbmt
+  module Outbox
+    module Probes
+      class Metrics
+        DEFAULT_YABEDA_PORT = 9090
+        DEFAULT_YABEDA_PATH = "/metrics"
+        class << self
+          def run_metrics
+            return unless autostart_yabeda_server?
+
+            if defined?(Yabeda)
+              $stdout.puts "Starting metrics http-server..."
+
+              start_webrick(
+                Yabeda::Prometheus::Mmap::Exporter::NOT_FOUND_HANDLER,
+                middlewares: {::Yabeda::Prometheus::Exporter => {path: DEFAULT_YABEDA_PATH}},
+                port: yabeda_port
+              )
+            end
+          end
+
+          private
+
+          def yabeda_port
+            Sbmt::Outbox.yaml_config.dig(:metrics, :port) || DEFAULT_YABEDA_PORT
+          end
+
+          def start_webrick(app, middlewares:, port:)
+            Thread.new do
+              ::Rack::Handler::WEBrick.run(
+                ::Rack::Builder.new do
+                  middlewares.each do |middleware, options|
+                    use middleware, **options
+                  end
+                  run app
+                end,
+                Host: "0.0.0.0",
+                Port: port
+              )
+            end
+          end
+
+          def autostart_yabeda_server?
+            Sbmt::Outbox.yaml_config.dig(:metrics, :enabled) || false
+          end
+        end
+      end
+    end
+  end
+end

lib/sbmt/outbox/probes/probe.rb

@@ -7,6 +7,10 @@ class Probe
         DEFAULT_PROBE_PORT = 5555
         class << self
           def run_probes
+            return unless autostart_probe?
+
+            $stdout.puts "Starting probes..."
+
             ::HttpHealthCheck.run_server_async(
               port: probe_port,
               rack_app: HttpHealthCheck::RackApp.configure do |c|
@@ -31,6 +35,12 @@ def probe_port
 
             Sbmt::Outbox.yaml_config.fetch(:probes).fetch(:port)
           end
+
+          def autostart_probe?
+            value = Sbmt::Outbox.yaml_config.dig(:probes, :enabled)
+            value = true if value.nil?
+            value
+          end
         end
       end
     end

lib/sbmt/outbox/version.rb

@@ -2,6 +2,6 @@
 
 module Sbmt
   module Outbox
-    VERSION = "6.3.1"
+    VERSION = "6.4.0"
   end
 end