sbmt-outbox 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d936531e4d8411170774717a4a325846ee05ad292027285a8a6dd1a337c7bb9f
-  data.tar.gz: 46a7e007d5f3be785b7616e0eb683354cbdb6654663f744914e3309441aa1a52
+  metadata.gz: aed7afb062770ab592517d363d16fa57428a29b9e67ec83eb65c5ceacbfba714
+  data.tar.gz: eafe1f3ea486c9913a82508a7e20a423e6eb6789651d7cb0642e706fa233a609
 SHA512:
-  metadata.gz: 5ff4f4b9b1d3e5e9260b227b4781a66233908c36023cae98d4ab8344baa612b9f0195a02d930054fa3ecf51f256518c7d05a36083887eccc67cb39cb25592c67
-  data.tar.gz: 52d88f0391854c934059f21daff079f242e736536efd4ac0bfad2edb7b595f4027c0b3bdf44dd469a6058e26d5a7e4f9c1d811793af0f8a2ebfaf370d0da1f25
+  metadata.gz: e58e6a80a6bd1a2ec1f9f41816d2b70532ae2e58b29f8588d5c326d22617fdbeb8e321fa70d2d02773ac6d0ff07403047351eb7ea89ff1597b9708ff66b69909
+  data.tar.gz: fe734a0361f7a749b23f63074faa5c3c1d3b9c92fad1e997ca4603a64a2efb30550f7a62c22a96f2830c0ef8fb1be0650fb6cd7a3a62100a63245d3631834580

data/README.md

@@ -3,12 +3,12 @@
 
 # Sbmt-Outbox
 
+<img src="https://raw.githubusercontent.com/SberMarket-Tech/sbmt-outbox/master/.github/outbox-logo.png" alt="sbmt-outbox logo" height="220" align="right" />
+
 Microservices often publish messages after a transaction has been committed. Writing to the database and publishing a message are two separate transactions, so they must be atomic. A failed publication of a message could lead to a critical failure of the business process.
 
 The Outbox pattern provides a reliable solution for message publishing. The idea behind this approach is to have an "outgoing message table" in the service's database. Before the main transaction completes, a new message row is added to this table. As a result, two actions take place as part of a single transaction. An asynchronous process retrieves new rows from the database table and, if they exist, publishes the messages to the broker.
 
-Read more about the Outbox pattern at https://microservices.io/patterns/data/transactional-outbox.html
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -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

data/app/controllers/sbmt/outbox/api/inbox_classes_controller.rb

@@ -6,7 +6,7 @@ module Sbmt
       class InboxClassesController < BaseController
         def index
           render_list(Sbmt::Outbox.inbox_item_classes.map do |item|
-            Sbmt::Outbox::Api::InboxClass.find_or_initialize(item.box_name)
+            Sbmt::Outbox::Api::InboxClass.find_or_initialize(item.box_id)
           end)
         end
 

data/app/controllers/sbmt/outbox/api/outbox_classes_controller.rb

@@ -6,7 +6,7 @@ module Sbmt
       class OutboxClassesController < BaseController
         def index
           render_list(Sbmt::Outbox.outbox_item_classes.map do |item|
-            Api::OutboxClass.find_or_initialize(item.box_name)
+            Api::OutboxClass.find_or_initialize(item.box_id)
           end)
         end
 

data/app/models/sbmt/outbox/base_item.rb

@@ -16,8 +16,12 @@ module Sbmt
           @box_name ||= name.underscore
         end
 
+        def box_id
+          @box_id ||= name.underscore.tr("/", "-").dasherize
+        end
+
         def config
-          @config ||= lookup_config.new(box_name)
+          @config ||= lookup_config.new(box_id: box_id, box_name: box_name)
         end
 
         def calc_bucket_partitions(count)

data/app/models/sbmt/outbox/base_item_config.rb

@@ -8,7 +8,8 @@ module Sbmt
 
       delegate :yaml_config, :memory_store, to: "Sbmt::Outbox"
 
-      def initialize(box_name)
+      def initialize(box_id:, box_name:)
+        self.box_id = box_id
         self.box_name = box_name
 
         validate!
@@ -109,7 +110,7 @@ module Sbmt
 
       private
 
-      attr_accessor :box_name
+      attr_accessor :box_id, :box_name
 
       def options
         @options ||= lookup_config || {}
@@ -129,8 +130,8 @@ module Sbmt
       end
 
       def polling_enabled_for?(api_model)
-        record = memory_store.fetch("sbmt/outbox/outbox_item_config/#{box_name}", expires_in: 10) do
-          api_model.find(box_name)
+        record = memory_store.fetch("sbmt/outbox/outbox_item_config/#{box_id}", expires_in: 10) do
+          api_model.find(box_id)
         end
 
         if record.nil?

data/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

data/lib/sbmt/outbox/cli.rb

@@ -69,8 +69,8 @@ module Sbmt
         $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

data/lib/sbmt/outbox/engine.rb

@@ -22,7 +22,7 @@ module Sbmt
         c.ui = ActiveSupport::OrderedOptions.new.tap do |c|
           c.serve_local = false
           c.local_endpoint = "http://localhost:5173"
-          c.cdn_url = "https://cdn.jsdelivr.net/npm/sbmt-outbox-ui@0.0.7/dist/assets/index.js"
+          c.cdn_url = "https://cdn.jsdelivr.net/npm/sbmt-outbox-ui@0.0.8/dist/assets/index.js"
         end
         c.process_items = ActiveSupport::OrderedOptions.new.tap do |c|
           c.general_timeout = 120

data/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

data/lib/sbmt/outbox/probes/probe.rb

@@ -7,6 +7,10 @@ module Sbmt
         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 @@ module Sbmt
 
             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

data/lib/sbmt/outbox/version.rb

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

data/lib/sbmt/outbox.rb

@@ -38,6 +38,7 @@ require_relative "outbox/engine"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sbmt-outbox
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Sbermarket Ruby-Platform Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -586,6 +586,7 @@ files:
 - lib/sbmt/outbox/middleware/sentry/tracing_batch_process_middleware.rb
 - lib/sbmt/outbox/middleware/sentry/tracing_item_process_middleware.rb
 - lib/sbmt/outbox/middleware/sentry/transaction.rb
+- lib/sbmt/outbox/probes/metrics.rb
 - lib/sbmt/outbox/probes/probe.rb
 - lib/sbmt/outbox/redis_client_factory.rb
 - lib/sbmt/outbox/tasks/delete_failed_items.rake