teneo_microservice 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed9d2b7f1f8e34f56e3fa1a8da1119c51c9918649dfb2e873f0d2ad6d3e8ed02
-  data.tar.gz: a15a32296d3b5326578b437b2e25685198182bf52212914846bb4591dca52c51
+  metadata.gz: 06570bcafbd3acbaa7f1eea2280fa73adbfde4311061040d4fde96f617ead862
+  data.tar.gz: ab48738dcdf280323fbcf73340fed9c873c5a1a8e3f1c4ab09822f49fd415252
 SHA512:
-  metadata.gz: 01316bc5badeaf927e89bad4c6efa88d4dc51111e3b5e9a1f9fa35081632d1b7fba1e061241f3726dda8f51bb72a0502140db0fcea7a8c2d5376c0a2d1938187
-  data.tar.gz: afdda17986e29f4bc65f4b4399dc3db571e1a5d32de68fd332b38c61adb6dc3c033894b2c77542627cd5925b6a9c8e997d1342c55e5753d6f1426a595c175fb1
+  metadata.gz: ff45882cfd370f7f8f5e23abe0be753696ce30a37df2592fe945ab580e32d1d97f4d238f7fa26d66a71e6b96abfc6a2fadb5d7b0997066a015716387f590509c
+  data.tar.gz: adca9acd8b6818d4952cae634365b71a7b70616c6c3ed8ddff743f6214faa6900e5a3da2070c70981e2abf9fd66258f19ecd0795410ee8bb55f9121be9ad1bd6

data/lib/teneo_microservice/server.rb

@@ -3,6 +3,7 @@
 require_relative 'client'
 require_relative 'service_orchestrator'
 require_relative 'util/env'
+require_relative 'util/logging'
 
 ##
 # This class encapsulates both a gRPC endpoint and a list of gRPC clients.
@@ -16,10 +17,16 @@ class Server
   ##
   # A list of clients used for communicating with all registered remote hosts.
   attr_accessor :clients
+  ##
+  # The logger that shows what the Server is doing.
+  attr_accessor :logger
 
   def initialize
     Env.valid_settings?
 
+    @standard_attributes = standard_log_attributes
+    @logger = GRPCLogger.new(standard_metadata: standard_log_attributes)
+
     @socket = "#{ENV["LISTEN_ADDRESS"]}:#{ENV["PORT"]}"
     remote_hosts = ENV['REMOTE_HOSTS'].split('|') unless ENV['REMOTE_HOSTS'].nil?
 
@@ -33,18 +40,31 @@ class Server
     @orchestrator.initialize_listener
   end
 
+  ##
+  # standard_log_attributes returns a hash containing the minimum set of attributes
+  # needed for logs generated by this class.
+  def standard_log_attributes
+    {
+      'grpc.component' => 'server'
+    }
+  end
+
   ##
   # register_service registers a service to the gRPC server.
   #
   # A service provides the actual executable methods used for communication,
   # and registering these to the server makes them available for implementation.
   def register_service(service:)
+    @logger.info(msg: "registering service '#{service.class}'")
+
     @orchestrator.add(service)
   end
 
   ##
   # start_listening_for_data readies the server for accepting traffic.
   def start_listening_for_data
+    @logger.info(msg: "accepting traffic on port ':#{ENV["PORT"]}'")
+
     @orchestrator.start
   end
 end

data/lib/teneo_microservice/service_orchestrator.rb

@@ -1,14 +1,9 @@
 # frozen_string_literal: true
 
-require 'logging'
 require 'grpc'
 
 require_relative 'error_classes/socket_format_error'
 
-module GRPC
-  extend Logging.globally
-end
-
 ##
 # This class represents a gRPC endpoint with which clients can communicate.
 class ServiceOrchestrator
@@ -18,26 +13,6 @@ class ServiceOrchestrator
 
   def initialize(socket:)
     @socket = socket
-
-    Logging.logger.root.appenders = Logging.appenders.stdout
-    Logging.logger.root.level = configured_log_level
-  end
-
-  ##
-  # configured_log_level returns the correct token to be used to set the
-  # gRPC log level based on the configured setting.
-  def configured_log_level
-    error_level_hash = {
-      'DEBUG' => :debug,
-      'INFO' => :info,
-      'WARN' => :warn,
-      'ERROR' => :error,
-      'FATAL' => :fatal
-    }
-
-    return :info unless error_level_hash.key?(ENV['LOG_LEVEL'])
-
-    error_level_hash[ENV['LOG_LEVEL']]
   end
 
   ##
@@ -49,7 +24,6 @@ class ServiceOrchestrator
 
     @listener = GRPC::RpcServer.new
     @listener.add_http2_port(@socket, :this_port_is_insecure)
-    GRPC.logger.info("... running insecurely on #{@socket}")
   end
 
   ##

data/lib/teneo_microservice/util/logging.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'time'
+
+##
+# This module provides functionality for creating a correctly configured logger.
+class GRPCLogger
+  def initialize(standard_metadata: {})
+    @logger = Logger.new($stdout)
+    @logger.sev_threshold = threshold_level
+
+    @logger.formatter = proc do |sev, datetime, _, msg|
+      "#{datetime.to_datetime.rfc3339} #{abbreviate_severity(severity: sev)} #{msg}\n"
+    end
+
+    @standard_metadata = standard_metadata
+  end
+
+  ##
+  # construct_message constructs the message to be logged so it matches Go's zerolog's
+  # format (https://github.com/rs/zerolog).
+  #
+  # The message consists of the message provided by the caller appended by both
+  # the provided attributes and time attributes.
+  def construct_message(message:, attributes: {})
+    msg_parts = []
+
+    msg_parts.push(message)
+
+    now = Time.now
+    ms = (now.to_f * 1000).to_i - (now.to_i * 1000)
+    attributes['grpc.start_time'] = now.to_datetime.rfc3339
+    attributes['grpc.time_ms'] = ms
+
+    attributes.each do |key, value|
+      msg_parts.push("#{key}=#{value}")
+    end
+
+    msg_parts.join(' ')
+  end
+
+  ##
+  # abbreviate_severity abbreviates the log's severity so it matches Go's zerolog's
+  # log severities (https://github.com/rs/zerolog).
+  def abbreviate_severity(severity:)
+    abbreviations = {
+      'DEBUG' => 'DBG',
+      'INFO' => 'INF',
+      'WARN' => 'WRN',
+      'ERROR' => 'ERR',
+      'FATAL' => 'FTL'
+    }
+
+    abbreviations[severity]
+  end
+
+  ##
+  # threshold_level returns the correct logging threshold level
+  # based on the configured setting.
+  def threshold_level
+    error_level_hash = {
+      'DEBUG' => Logger::DEBUG,
+      'INFO' => Logger::INFO,
+      'WARN' => Logger::WARN,
+      'ERROR' => Logger::ERROR,
+      'FATAL' => Logger::FATAL
+    }
+
+    return Logger::INFO unless error_level_hash.key?(ENV['LOG_LEVEL'])
+
+    error_level_hash[ENV['LOG_LEVEL']]
+  end
+
+  ##
+  # debug logs a message with the DEBUG severity.
+  def debug(msg:, meta: {})
+    meta = meta.merge(@standard_metadata)
+
+    @logger.debug do
+      construct_message(
+        message: msg,
+        attributes: meta
+      )
+    end
+  end
+
+  ##
+  # info logs a message with the INFO severity.
+  def info(msg:, meta: {})
+    meta = meta.merge(@standard_metadata)
+
+    @logger.info do
+      construct_message(
+        message: msg,
+        attributes: meta
+      )
+    end
+  end
+
+  ##
+  # warn logs a message with the WARN severity.
+  def warn(msg:, meta: {})
+    meta = meta.merge(@standard_metadata)
+
+    @logger.warn do
+      construct_message(
+        message: msg,
+        attributes: meta
+      )
+    end
+  end
+
+  ##
+  # error logs a message with the ERROR severity.
+  def error(msg:, meta: {})
+    meta = meta.merge(@standard_metadata)
+
+    @logger.error do
+      construct_message(
+        message: msg,
+        attributes: meta
+      )
+    end
+  end
+
+  ##
+  # fatal logs a message with the FATAL severity.
+  def fatal(msg:, meta: {})
+    meta = meta.merge(@standard_metadata)
+
+    @logger.fatal do
+      construct_message(
+        message: msg,
+        attributes: meta
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teneo_microservice
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ruben Vanoverschelde
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -82,6 +82,7 @@ files:
 - lib/teneo_microservice/service_orchestrator.rb
 - lib/teneo_microservice/util/convert.rb
 - lib/teneo_microservice/util/env.rb
+- lib/teneo_microservice/util/logging.rb
 homepage: https://github.com/libis/teneo-microservice-ruby
 licenses:
 - MIT