RubyGems - stack-service-base - Versions diffs - 0.0.2 → 0.0.4 - Mend

stack-service-base 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

checksums.yaml +4 -4
data/lib/stack-service-base/open_telemetry.rb +181 -0
data/lib/stack-service-base.rb +12 -0
data/lib/version.rb +1 -1
metadata +45 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d365e12102a76d0d4e8e1c453151361881db1d57f4864cba7e3ac0662027b00
-  data.tar.gz: cae46609114c37ee39d63b9b7adb9cac3de539e17263da3e0290798d56da05fe
+  metadata.gz: 340d3036dfae55df21ac629aea2f177b890257e29e8d51d7c7ec975bff57ee0b
+  data.tar.gz: 76ab84fb603376f3a8f29901c5987cd4bf664625dd6a9bd533f20e928716a775
 SHA512:
-  metadata.gz: 2b632ef3a662cfa1105fa3c06b9f14744314f2d1edec155031f4f63c6c52a175682e9f98d5cc5a69958255c27b1c748da4f56e6c8b312036f76b51fe5c9c2f7e
-  data.tar.gz: e5c025affc7e0109e403c7a3e3f31f55b139dd7323b3250ec84dec1fabcec17b7f474a4856a054b34746474f3b825a9a7cefcefac745f4e203ce420d483031b4
+  metadata.gz: d99472369e7dae16f8cfd8526e785a6dee35727e4f7e7b48e81a3509a295c9712883c8060d177f76cb56022d42055868f1ce3ee7cabd27163635a66bb9154bb9
+  data.tar.gz: 3d86d30f6fbcbcb06339d2cdfe03afbf51a58696177d88c4d7fc81e404454093ba0c4e00ef80ac228ebc41140dbf6569f6c405577df0c1ca126ea00cc24360d3

data/lib/stack-service-base/open_telemetry.rb ADDED Viewed

@@ -0,0 +1,181 @@
+ENV['OTEL_LOG_LEVEL'] ||= 'debug'
+ENV['OTEL_TRACES_EXPORTER'] ||= 'console,otlp'
+unless defined? OTEL_ENABLED
+  OTEL_ENABLED = !ENV['OTEL_EXPORTER_OTLP_ENDPOINT'].to_s.empty?
+end
+$stdout.puts "OTEL_ENABLED: #{OTEL_ENABLED}"
+# require 'async'
+# require 'grape'
+if OTEL_ENABLED
+  STACK_NAME = ENV['STACK_NAME'] || 'undefined_stack'
+  SERVICE_NAME = ENV['STACK_SERVICE_NAME'] || 'undefined_service'
+  ENV['OTEL_RESOURCE_ATTRIBUTES'] ||= "deployment.environment=#{STACK_NAME},service.name=#{SERVICE_NAME}"
+  ENV.select{ |k,v| k =~ /OTEL/}.each { |k,v| $stdout.puts "#{k}: #{v}"}
+  require 'opentelemetry/sdk'
+  require 'opentelemetry/exporter/otlp'
+  require 'opentelemetry/instrumentation/all'
+  require 'opentelemetry-api'
+end
+if defined? Async::Task and OTEL_ENABLED
+  module AsyncTaskOTELPatch
+    def initialize(parent = Task.current?, finished: nil, **options, &block)
+      ctx_ = OpenTelemetry::Context.current
+      block_otl = ->(t, *arguments){
+        OpenTelemetry::Context.with_current(ctx_) do
+          block.call t, *arguments
+        end
+      }
+      super parent, finished: , **options, &block_otl
+    end
+  end
+  Async::Task.prepend AsyncTaskOTELPatch
+end
+def flatten_hash(hash, path = [], result = {})
+  hash.each do |k, v|
+    path += [k]
+    result[path.join('.')] = v.to_s if v.is_a?(String) || v.is_a?(Numeric)
+    flatten_hash(v, path, result) if v.is_a?(Hash) || v.is_a?(Array)
+    path.pop
+  end
+  result
+end
+if defined? LOGGER and OTEL_ENABLED
+  OpenTelemetry.logger = LOGGER
+end
+def otel_initialize
+  $stderr.puts "otl_configure: OTEL_ENABLED: #{OTEL_ENABLED}"
+  return unless OTEL_ENABLED
+  OpenTelemetry::SDK.configure do |c|
+    # c.service_name = SERVICE_NAME
+    c.use_all # enables all instrumentation!
+  end
+  at_exit do
+    OpenTelemetry.tracer_provider.force_flush
+    OpenTelemetry.tracer_provider.shutdown
+  end
+  $tracer_ = OpenTelemetry.tracer_provider.tracer(SERVICE_NAME)
+  otl_span "#{SERVICE_NAME} start", {
+    'stack.name': ENV['STACK_NAME'],
+    'stack.service.name': ENV['STACK_SERVICE_NAME'],
+    'org.opencontainers.image.title': ENV['ORG_OPENCONTAINERS_IMAGE_TITLE'],
+    'org.opencontainers.image.url':  ENV['ORG_OPENCONTAINERS_IMAGE_URL'],
+    'org.opencontainers.image.source': ENV['ORG_OPENCONTAINERS_IMAGE_SOURCE'],
+    'org.opencontainers.image.created': ENV['ORG_OPENCONTAINERS_IMAGE_CREATED'],
+    'com.gitlab.ci.commt.timestamp': ENV['COM_GITLAB_CI_COMMIT_TIMESTAMP'],
+    'com.gitlab.ci.tag': ENV['COM_GITLAB_CI_TAG'],
+    RACK_ENV: ENV['RACK_ENV'],
+    NODE_ENV: ENV['NODE_ENV'],
+    SERVER_ENV: ENV['SERVER_ENV'],
+  } do |span|
+    span.add_event("not-working in kibana APM", attributes:{
+      event: 'Success',
+      message: 'Get data from elastic Success'
+    }.transform_keys(&:to_s) )
+    # span.status = OpenTelemetry::Trace::Status.error("error message here!")
+  end
+end
+if defined? Sequel and OTEL_ENABLED
+  class Sequel::Database
+    alias old_test_connection test_connection
+    def test_connection(...)
+      OpenTelemetry::Common::Utilities.untraced do
+        old_test_connection(...)
+      end
+    end
+    alias old_valid_connection? valid_connection?
+    def valid_connection?(...)
+      OpenTelemetry::Common::Utilities.untraced do
+        old_valid_connection?(...)
+      end
+    end
+  end
+end
+def otl_span(name, attributes = {})
+  # span_ = OpenTelemetry::Trace.current_span
+  return yield(nil) unless OTEL_ENABLED
+  return yield(nil) unless $tracer_
+  $tracer_&.in_span(name, attributes: flatten_hash(attributes.transform_keys(&:to_s).transform_values{_1 || 'n/a'}) ) do |span|
+    yield span
+  end
+end
+def otl_current_span
+  return unless OTEL_ENABLED
+  yield OpenTelemetry::Trace.current_span
+end
+def otl_def(name)
+  original_method = self.respond_to?(:instance_method) ? instance_method(name) : method(name)
+  self.respond_to?(:remove_method) ? remove_method(name) : Object.send(:remove_method, name)
+  original_method = original_method.respond_to?(:unbind) ? original_method.unbind : original_method
+  define_method(name) do |*args, **kwargs, &block|
+    klass = self.respond_to?(:class_name) ? self.class_name : (self.respond_to?(:name) ? self.name : 'main')
+    otl_span("method: #{klass}.#{name}", {args: args.to_s, kwargs: kwargs.to_s}) do |span|
+      original_method.bind(self).call(*args, **kwargs, &block)
+    end
+  end
+end
+if defined?  OpenTelemetry::Instrumentation::Rack::Middlewares
+  OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware.config[:url_quantization] = ->(path, env) {
+    "HTTP #{env['REQUEST_METHOD']} #{path}"
+  }
+end
+if OTEL_ENABLED
+  class OpenTelemetry::SDK::Trace::Span
+    alias add_attributes_old add_attributes
+    def add_attributes(attributes)
+      add_attributes_old flatten_hash attributes
+                           .transform_keys(&:to_s)
+                           .transform_values{ _1 || 'n/a' }
+    end
+  end
+end
+if defined? Safrano::Request and OTEL_ENABLED
+  require 'odata/error'
+  class Safrano::Request
+    def process
+      begin
+        @response = Safrano::Response.new
+        before.tap_error { |err| dispatch_error(err) }
+              .tap_valid { |_res| dispatch }
+      rescue Sequel::Error => e
+        OpenTelemetry::Trace.current_span.tap do |span|
+          span.record_exception(e)
+          span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{e.class}")
+        end
+        dispatch_error(Safrano::SequelExceptionError.new(e))
+      end
+      @response.finish
+    end
+  end
+end

data/lib/stack-service-base.rb CHANGED Viewed

@@ -1,6 +1,12 @@
+require 'stack-service-base/open_telemetry'
 module StackServiceBase
   class << self
     def rack_setup app
+      # skip if called within Rspec task
+      # TODO: warn if called not within Rspec task but with a wrong app class
+      return unless app.respond_to? :use
       app.instance_eval do
         if ENV.fetch('PROMETHEUS_METRICS_EXPORT', 'true') == 'true'
           require 'stack-service-base/prometheus'
@@ -9,6 +15,12 @@ module StackServiceBase
           use Prometheus::Middleware::Collector
           use Prometheus::Middleware::Exporter
         end
+        if OTEL_ENABLED
+          otel_initialize
+        end
       end
     end
   end

data/lib/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module StackServiceBase
   class Base
-    VERSION = '0.0.2'
+    VERSION = '0.0.4'
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stack-service-base
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-01 00:00:00.000000000 Z
+date: 2025-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -24,6 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +157,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/stack-service-base.rb
+- lib/stack-service-base/open_telemetry.rb
 - lib/stack-service-base/prometheus.rb
 - lib/stack-service-base/prometheus_parser.rb
 - lib/version.rb