eventhub-processor2 1.25.0 → 1.26.0

data/lib/eventhub/assets/logo.svg

@@ -0,0 +1,7 @@
+<svg width="200" height="200" viewBox="0 0 300 300" xmlns="http://www.w3.org/2000/svg">
+  <g>
+    <circle cx="150" cy="95" r="62" fill="#ffffff" />
+    <circle cx="215" cy="210" r="48" fill="#ffffff" />
+    <circle cx="95" cy="210" r="36" fill="#ffffff" />
+  </g>
+</svg>

data/lib/eventhub/base.rb

@@ -11,6 +11,8 @@ require "celluloid"
 require_relative "version"
 require_relative "constant"
 require_relative "base_exception"
+require_relative "correlation_id"
+require_relative "execution_id"
 require_relative "logger"
 require_relative "helper"
 require_relative "sleeper"
@@ -24,6 +26,7 @@ require_relative "actor_watchdog"
 require_relative "actor_publisher"
 require_relative "actor_listener_amqp"
 require_relative "actor_listener_http"
+require_relative "docs_renderer"
 require_relative "processor2"
 
 Celluloid.logger = nil

data/lib/eventhub/configuration.rb

@@ -137,6 +137,16 @@ module EventHub
           tls_ca_certificates: [],
           verify_peer: false,
           show_bunny_logs: false,
+          http: {
+            bind_address: "localhost",
+            port: 8080,
+            base_path: "/svc/#{@name}",
+            docs: {
+              readme_path: nil,
+              changelog_path: nil
+            }
+          },
+          # deprecated: use http instead (kept for backward compatibility)
           heartbeat: {
             bind_address: "localhost",
             port: 8080,

data/lib/eventhub/correlation_id.rb

@@ -0,0 +1,35 @@
+# EventHub module
+module EventHub
+  # Manages correlation_id for distributed tracing
+  # Storage mechanism can be swapped if needed (e.g., Thread.current -> Fiber storage)
+  module CorrelationId
+    class << self
+      def current
+        Thread.current[:eventhub_correlation_id]
+      end
+
+      def current=(value)
+        Thread.current[:eventhub_correlation_id] = value
+      end
+
+      def clear
+        Thread.current[:eventhub_correlation_id] = nil
+      end
+
+      # Execute block with correlation_id set, ensures cleanup
+      def with(correlation_id)
+        if correlation_id.nil? || correlation_id.to_s.empty?
+          yield
+        else
+          old_value = current
+          begin
+            self.current = correlation_id
+            yield
+          ensure
+            self.current = old_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eventhub/docs_renderer.rb

@@ -0,0 +1,184 @@
+require "erb"
+require "kramdown"
+
+module EventHub
+  class DocsRenderer
+    ASSETS_PATH = File.expand_path("assets", __dir__)
+    TEMPLATES_PATH = File.expand_path("templates", __dir__)
+
+    DEFAULT_README_LOCATIONS = ["README.md", "doc/README.md"].freeze
+    DEFAULT_CHANGELOG_LOCATIONS = ["CHANGELOG.md", "doc/CHANGELOG.md"].freeze
+    DEFAULT_COMPANY_NAME = "Novartis"
+
+    DEFAULT_HTTP_RESOURCES = [:heartbeat, :version, :docs, :changelog, :configuration].freeze
+
+    def initialize(processor:, base_path:)
+      @processor = processor
+      @base_path = base_path
+    end
+
+    def render_readme
+      content = readme_html
+      render_layout(title: "README", content: content, content_class: "")
+    end
+
+    def render_changelog
+      content = changelog_html
+      render_layout(title: "CHANGELOG", content: content, content_class: "changelog")
+    end
+
+    def render_config
+      content = config_html
+      render_layout(title: "Configuration", content: content, content_class: "config")
+    end
+
+    def asset(name)
+      path = File.join(ASSETS_PATH, name)
+      return nil unless File.exist?(path)
+      File.read(path)
+    end
+
+    private
+
+    def readme_html
+      return @processor.readme_as_html if @processor.class.method_defined?(:readme_as_html)
+
+      markdown = load_markdown(:readme)
+      markdown_to_html(markdown)
+    end
+
+    def changelog_html
+      return @processor.changelog_as_html if @processor.class.method_defined?(:changelog_as_html)
+
+      markdown = load_markdown(:changelog)
+      markdown_to_html(markdown)
+    end
+
+    def load_markdown(type)
+      config_path = case type
+      when :readme
+        EventHub::Configuration.server.dig(:http, :docs, :readme_path)
+      when :changelog
+        EventHub::Configuration.server.dig(:http, :docs, :changelog_path)
+      end
+
+      if config_path && File.exist?(config_path)
+        return File.read(config_path)
+      end
+
+      locations = case type
+      when :readme
+        DEFAULT_README_LOCATIONS
+      when :changelog
+        DEFAULT_CHANGELOG_LOCATIONS
+      end
+
+      locations.each do |location|
+        path = File.join(Dir.pwd, location)
+        return File.read(path) if File.exist?(path)
+      end
+
+      "No #{(type == :readme) ? "README" : "CHANGELOG"} available."
+    end
+
+    def config_html
+      return @processor.configuration_as_html if @processor&.class&.method_defined?(:configuration_as_html)
+
+      config = EventHub::Configuration.config_data
+      return "<p>No configuration available.</p>" if config.nil? || config.empty?
+
+      intro = "<h1>Configuration</h1>" \
+        "<p>Active configuration for the <strong>#{ERB::Util.html_escape(EventHub::Configuration.environment)}</strong> environment. " \
+        "Sensitive values such as passwords, tokens, and keys are automatically redacted.</p>"
+
+      intro + config_to_html_table(config)
+    end
+
+    def config_to_html_table(hash, depth = 0)
+      rows = hash.map do |key, value|
+        if value.is_a?(Hash)
+          "<tr class=\"is-section\"><td colspan=\"2\"><strong>#{ERB::Util.html_escape(key)}</strong></td></tr>\n" \
+          "#{config_to_html_table(value, depth + 1)}"
+        elsif value.is_a?(Array)
+          format_array_rows(key, value, depth)
+        else
+          display_value = sensitive_key?(key) ? "<span class=\"redacted\">[REDACTED]</span>" : ERB::Util.html_escape(value.to_s)
+          "<tr><td class=\"config-key\">#{ERB::Util.html_escape(key)}</td><td>#{display_value}</td></tr>"
+        end
+      end.join("\n")
+
+      if depth == 0
+        "<table class=\"table is-bordered is-striped is-fullwidth config-table\">\n<thead><tr><th>Key</th><th>Value</th></tr></thead>\n<tbody>\n#{rows}\n</tbody>\n</table>"
+      else
+        rows
+      end
+    end
+
+    def format_array_rows(key, array, depth)
+      if array.any? { |item| item.is_a?(Hash) }
+        array.each_with_index.map do |item, index|
+          if item.is_a?(Hash)
+            "<tr class=\"is-section\"><td colspan=\"2\"><strong>#{ERB::Util.html_escape(key)}[#{index}]</strong></td></tr>\n" \
+            "#{config_to_html_table(item, depth + 1)}"
+          else
+            display_value = sensitive_key?(key) ? "<span class=\"redacted\">[REDACTED]</span>" : ERB::Util.html_escape(item.to_s)
+            "<tr><td class=\"config-key\">#{ERB::Util.html_escape(key)}[#{index}]</td><td>#{display_value}</td></tr>"
+          end
+        end.join("\n")
+      else
+        display_value = sensitive_key?(key) ? "<span class=\"redacted\">[REDACTED]</span>" : ERB::Util.html_escape(array.join(", "))
+        "<tr><td class=\"config-key\">#{ERB::Util.html_escape(key)}</td><td>#{display_value}</td></tr>"
+      end
+    end
+
+    DEFAULT_SENSITIVE_KEYS = %w[password secret token api_key credential].freeze
+
+    def sensitive_key?(key)
+      keys = if @processor&.class&.method_defined?(:sensitive_keys)
+        @processor.sensitive_keys
+      else
+        DEFAULT_SENSITIVE_KEYS
+      end
+      keys.any? { |pattern| key.to_s.downcase == pattern.downcase }
+    end
+
+    def markdown_to_html(markdown)
+      Kramdown::Document.new(markdown).to_html
+    end
+
+    def render_layout(title:, content:, content_class: "")
+      template_path = File.join(TEMPLATES_PATH, "layout.erb")
+      template = File.read(template_path)
+
+      processor_name = EventHub::Configuration.name
+      version = processor_version
+      environment = EventHub::Configuration.environment
+      company_name = processor_company_name
+      base_path = @base_path
+      year = Time.now.year
+      http_resources = processor_http_resources
+      bulma_css = asset("bulma.min.css")
+      app_css = asset("app.css")
+
+      ERB.new(template).result(binding)
+    end
+
+    def processor_version
+      return "?.?.?" unless @processor
+      return "?.?.?" unless @processor.class.method_defined?(:version)
+      @processor.version
+    end
+
+    def processor_company_name
+      return DEFAULT_COMPANY_NAME unless @processor
+      return DEFAULT_COMPANY_NAME unless @processor.class.method_defined?(:company_name)
+      @processor.company_name
+    end
+
+    def processor_http_resources
+      return DEFAULT_HTTP_RESOURCES unless @processor
+      return DEFAULT_HTTP_RESOURCES unless @processor.class.method_defined?(:http_resources)
+      @processor.http_resources
+    end
+  end
+end

data/lib/eventhub/execution_id.rb

@@ -0,0 +1,20 @@
+# EventHub module
+module EventHub
+  # ExecutionId module for storing the current message's execution_id
+  # in thread-local storage for distributed tracing.
+  module ExecutionId
+    class << self
+      def current
+        Thread.current[:eventhub_execution_id]
+      end
+
+      def current=(value)
+        Thread.current[:eventhub_execution_id] = value
+      end
+
+      def clear
+        Thread.current[:eventhub_execution_id] = nil
+      end
+    end
+  end
+end

data/lib/eventhub/logger.rb

@@ -1,21 +1,54 @@
 # EventHub module
 module EventHub
+  # Logger proxy that automatically includes correlation_id in structured log output
+  class LoggerProxy
+    def initialize(logger)
+      @logger = logger
+    end
+
+    %i[debug info warn error fatal unknown].each do |level|
+      define_method(level) do |message = nil, &block|
+        message = block.call if block
+        correlation_id = CorrelationId.current
+        execution_id = ExecutionId.current
+        if correlation_id || execution_id
+          log_hash = {message: message}
+          log_hash[:correlation_id] = correlation_id if correlation_id
+          log_hash[:execution_id] = execution_id if execution_id
+          @logger.send(level, log_hash)
+        else
+          @logger.send(level, message)
+        end
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      @logger.send(method, *args, &block)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @logger.respond_to?(method, include_private)
+    end
+  end
+
   def self.logger
     unless defined?(@logger)
-      @logger = ::EventHub::Components::MultiLogger.new
+      base_logger = ::EventHub::Components::MultiLogger.new
 
       if Configuration.console_log_only
-        @logger.add_device(
+        base_logger.add_device(
           EventHub::Components::Logger.logstash_cloud(Configuration.name,
             Configuration.environment)
         )
       else
-        @logger.add_device(Logger.new($stdout))
-        @logger.add_device(
+        base_logger.add_device(Logger.new($stdout))
+        base_logger.add_device(
           EventHub::Components::Logger.logstash(Configuration.name,
             Configuration.environment)
         )
       end
+
+      @logger = LoggerProxy.new(base_logger)
     end
     @logger
   end

data/lib/eventhub/message.rb

@@ -71,7 +71,7 @@ module EventHub
       @header.set("origin.site_id", "undefined", false)
 
       @header.set("process.name", "undefined", false)
-      @header.set("process.execution_id", SecureRandom.uuid, false)
+      @header.set("process.execution_id", CorrelationId.current || SecureRandom.uuid, false)
       @header.set("process.step_position", 0, false)
 
       @header.set("status.retried_count", 0, false)

data/lib/eventhub/processor2.rb

@@ -32,6 +32,7 @@ module EventHub
 
     def start
       EventHub.logger.info("#{Configuration.name} (#{version}): has been started")
+      log_general_settings
 
       before_start
       main_event_loop
@@ -76,6 +77,15 @@ module EventHub
 
     private
 
+    def log_general_settings
+      console = Configuration.console_log_only ? "yes" : "no"
+      settings = [
+        Configuration.environment,
+        "console=#{console}"
+      ].join(", ")
+      EventHub.logger.info("Settings [#{settings}]")
+    end
+
     def setup_signal_handler
       # have a re-entrant signal handler by just using a simple array
       # https://www.sitepoint.com/the-self-pipe-trick-explained/
@@ -88,7 +98,7 @@ module EventHub
       @config = Celluloid::Supervision::Configuration.define([
         {type: ActorHeartbeat, as: :actor_heartbeat, args: [self]},
         {type: ActorListenerAmqp, as: :actor_listener_amqp, args: [self]},
-        {type: ActorListenerHttp, as: :actor_listener_http, args: []}
+        {type: ActorListenerHttp, as: :actor_listener_http, args: [{processor: self}]}
       ])
 
       sleeper = @sleeper

data/lib/eventhub/templates/layout.erb

@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title><%= title %> - <%= processor_name %></title>
+    <style>
+<%= bulma_css %>
+<%= app_css %>
+    </style>
+  </head>
+  <body>
+    <nav class="navbar is-fixed-top" role="navigation" aria-label="main navigation">
+      <div class="container">
+        <div class="navbar-brand">
+          <a class="navbar-item" href="<%= base_path %>/docs">
+            <img src="<%= base_path %>/assets/logo.svg" alt="Logo" class="logo">
+            <span class="processor-name"><%= processor_name %></span>
+          </a>
+        </div>
+        <div class="navbar-menu">
+          <div class="navbar-end">
+<% if http_resources.include?(:configuration) %>
+            <a class="navbar-item" href="<%= base_path %>/docs/configuration">
+              Configuration
+            </a>
+<% end %>
+<% if http_resources.include?(:changelog) %>
+            <a class="navbar-item" href="<%= base_path %>/docs/changelog">
+              Changelog
+            </a>
+<% end %>
+          </div>
+        </div>
+      </div>
+    </nav>
+
+    <section class="section">
+      <div class="container">
+        <div class="content <%= content_class %>">
+<%= content %>
+        </div>
+      </div>
+    </section>
+
+    <footer class="footer">
+      <div class="container">
+        <div class="level">
+          <div class="level-left">
+            <div class="level-item">
+              <span><strong><%= processor_name %></strong> <%= version %><br><%= environment %></span>
+            </div>
+          </div>
+          <div class="level-right">
+            <div class="level-item">
+              <span><%= company_name %> &copy; <%= year %></span>
+            </div>
+          </div>
+        </div>
+      </div>
+    </footer>
+  </body>
+</html>

data/lib/eventhub/version.rb

@@ -1,3 +1,3 @@
 module EventHub
-  VERSION = "1.25.0".freeze
+  VERSION = "1.26.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eventhub-processor2
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Steiner, Thomas
@@ -93,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -157,8 +171,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
-- ".github/workflows/cd.yml"
-- ".github/workflows/ci.yml"
+- ".github/workflows/01_test.yml"
+- ".github/workflows/02_test_build_and_release.yml"
 - ".gitignore"
 - ".rspec"
 - ".tool-versions"
@@ -176,6 +190,7 @@ files:
 - docker/rabbitmq.config
 - docker/reset
 - eventhub-processor2.gemspec
+- example/CHANGELOG.md
 - example/README.md
 - example/config/receiver.json
 - example/config/router.json
@@ -189,11 +204,17 @@ files:
 - lib/eventhub/actor_listener_http.rb
 - lib/eventhub/actor_publisher.rb
 - lib/eventhub/actor_watchdog.rb
+- lib/eventhub/assets/app.css
+- lib/eventhub/assets/bulma.min.css
+- lib/eventhub/assets/logo.svg
 - lib/eventhub/base.rb
 - lib/eventhub/base_exception.rb
 - lib/eventhub/configuration.rb
 - lib/eventhub/constant.rb
 - lib/eventhub/consumer.rb
+- lib/eventhub/correlation_id.rb
+- lib/eventhub/docs_renderer.rb
+- lib/eventhub/execution_id.rb
 - lib/eventhub/hash_extensions.rb
 - lib/eventhub/helper.rb
 - lib/eventhub/logger.rb
@@ -201,6 +222,7 @@ files:
 - lib/eventhub/processor2.rb
 - lib/eventhub/sleeper.rb
 - lib/eventhub/statistics.rb
+- lib/eventhub/templates/layout.erb
 - lib/eventhub/version.rb
 homepage: https://github.com/thomis/eventhub-processor2
 licenses:
@@ -220,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Next generation gem to build ruby based eventhub processor
 test_files: []

data/.github/workflows/cd.yml

@@ -1,31 +0,0 @@
-name: cd
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-jobs:
-
-  build:
-    runs-on: ubuntu-latest
-    permissions:
-      id-token: write  # Required for OIDC
-      contents: write  # Required for pushing tags
-
-    steps:
-    - name: Checkout current code
-      uses: actions/checkout@v6
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '4.0'
-        bundler-cache: true
-        cache-version: 1
-
-    - name: Build gem
-      run: gem build *.gemspec
-
-    - name: Push to Rubygems
-      uses: rubygems/release-gem@v1