rivulet-opentelemetry 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0c84121fc0e40a81c56e2292f6b39e38b42333471d0a05bcd0460ef90ee486d
+  data.tar.gz: 756ffd299bb007a24f8531b65b12922559f671f1e392b092e4a8e18e99b2afd0
+SHA512:
+  metadata.gz: 2e47f6a0535d7aaf373dd789ce7ba457b07e035a56bceca7e39633d22a8574f0eef06cbc0d100fa3675bceb5a0455e7bf1e43f4cdae1e230def63c232bcc2f0d
+  data.tar.gz: 20767ee6b59e5be4d974620f021c7432e23c730486f9a578dce2385786d6b0cf213da305beb341796a7d38098ea02c87aee8b8ed075d20bc1af2cc83592add9e

data/bin/rivulet-otel

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/rivulet/otel/cli'
+
+Dry::CLI.new(Rivulet::OTel::CLI::Commands).call

data/lib/rivulet/opentelemetry/version.rb

@@ -0,0 +1,5 @@
+module Rivulet
+  module OTel
+    VERSION = '0.2.0'
+  end
+end

data/lib/rivulet/opentelemetry.rb

@@ -0,0 +1,53 @@
+require 'opentelemetry/sdk'
+require 'opentelemetry/exporter/otlp'
+require 'opentelemetry/instrumentation/rack'
+require 'opentelemetry/sdk/logs'
+require 'opentelemetry/exporter/otlp_logs'
+require 'opentelemetry-metrics-sdk'
+require 'opentelemetry/exporter/otlp_metrics'
+
+require_relative 'opentelemetry/version'
+require_relative 'otel/sink'
+require_relative 'otel/logger'
+require_relative 'otel/metrics'
+
+module Rivulet
+  module OTel
+    class << self
+      def configure(service_name: 'rivulet')
+        return unless ENV['OTEL_EXPORTER_OTLP_ENDPOINT']
+
+        ENV['OTEL_METRICS_EXPORTER'] ||= 'none'
+
+        OpenTelemetry::SDK.configure do |c|
+          c.service_name = service_name
+          c.use 'OpenTelemetry::Instrumentation::Rack'
+        end
+
+        configure_logs(service_name)
+        configure_metrics
+      end
+
+      private
+
+      def configure_logs(service_name)
+        logger_provider = OpenTelemetry::SDK::Logs::LoggerProvider.new
+        logger_provider.add_log_record_processor(
+          OpenTelemetry::SDK::Logs::Export::SimpleLogRecordProcessor.new(
+            OpenTelemetry::Exporter::OTLP::Logs::LogsExporter.new
+          )
+        )
+
+        OpenTelemetry.instance_variable_set(:@logger_provider, logger_provider)
+        logger_provider.logger(name: service_name)
+      end
+
+      def configure_metrics
+        exporter = OpenTelemetry::Exporter::OTLP::Metrics::MetricsExporter.new
+        OpenTelemetry.meter_provider.add_metric_reader(
+          OpenTelemetry::SDK::Metrics::Export::PeriodicMetricReader.new(exporter: exporter)
+        )
+      end
+    end
+  end
+end

data/lib/rivulet/otel/cli/setup.rb

@@ -0,0 +1,120 @@
+require 'fileutils'
+require 'yaml'
+
+module Rivulet
+  module OTel
+    module CLI
+      module Commands
+        class Setup < Dry::CLI::Command
+          desc "Wire OpenTelemetry into an existing Rivulet app"
+
+          def call(**)
+            validate_app!
+
+            generate_files
+            patch_application_config
+            patch_docker_compose
+
+            puts "\nDone! Next steps:"
+            puts "  docker compose up --build"
+            puts "  Open Grafana at http://localhost:3000 (admin/admin)"
+          end
+
+          private
+
+          def validate_app!
+            unless File.exist?('config.ru') && File.read('config.ru').include?("require 'rivulet'")
+              puts "Error: not a Rivulet application (config.ru not found or missing 'require \"rivulet\"')"
+              exit 1
+            end
+
+            unless File.exist?('config/application.rb')
+              puts "Error: config/application.rb not found"
+              exit 1
+            end
+          end
+
+          def generate_files
+            FileUtils.mkdir_p('config/initializers')
+
+            write 'config/initializers/opentelemetry.rb', opentelemetry_initializer
+          end
+
+          def write(path, content)
+            File.write(path, content)
+            puts "  create  #{path}"
+          end
+
+          def patch_application_config
+            path = 'config/application.rb'
+            content = File.read(path)
+            changed = false
+
+            unless content.include?('config.telemetry.sink = Rivulet::OTel::Sink.new')
+              content = content.sub(/(end\s*\n?\z)/, "  config.telemetry.sink = Rivulet::OTel::Sink.new\n\\1")
+              changed = true
+            end
+
+            unless content.include?('config.logger.engine = Rivulet::OTel::Logger.new')
+              content = content.sub(/(end\s*\n?\z)/, "  config.logger.engine = Rivulet::OTel::Logger.new\n\\1")
+              changed = true
+            end
+
+            if changed
+              File.write(path, content)
+              puts "  patch   #{path}"
+            else
+              puts "  skip    #{path} (already patched)"
+            end
+          end
+
+          def patch_docker_compose
+            path = 'docker-compose.yml'
+            return puts "  skip    #{path} (not found)" unless File.exist?(path)
+
+            compose = YAML.safe_load(File.read(path), permitted_classes: [Symbol])
+            return puts "  skip    #{path} (already patched)" if compose.dig('services', 'lgtm')
+
+            app_env = compose.dig('services', 'app', 'environment')
+            if app_env.is_a?(Hash)
+              app_env['OTEL_EXPORTER_OTLP_ENDPOINT'] = 'http://lgtm:4318'
+            elsif app_env.is_a?(Array)
+              app_env << 'OTEL_EXPORTER_OTLP_ENDPOINT=http://lgtm:4318'
+            else
+              compose['services']['app']['environment'] = { 'OTEL_EXPORTER_OTLP_ENDPOINT' => 'http://lgtm:4318' }
+            end
+
+            app_depends = compose.dig('services', 'app', 'depends_on')
+            if app_depends.is_a?(Hash)
+              app_depends['lgtm'] = { 'condition' => 'service_started' }
+            elsif app_depends.is_a?(Array)
+              app_depends << 'lgtm'
+            else
+              compose['services']['app']['depends_on'] = { 'lgtm' => { 'condition' => 'service_started' } }
+            end
+
+            compose['services']['lgtm'] = lgtm_service
+
+            File.write(path, YAML.dump(compose, line_width: -1))
+            puts "  patch   #{path}"
+          end
+
+          def lgtm_service
+            {
+              'image' => 'grafana/otel-lgtm:latest',
+              'ports' => ['3000:3000', '4318:4318']
+            }
+          end
+
+          def opentelemetry_initializer
+            <<~RUBY
+              require 'rivulet/opentelemetry'
+
+              Rivulet::OTel.configure(service_name: Rivulet.config.app.name)
+            RUBY
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rivulet/otel/cli.rb

@@ -0,0 +1,14 @@
+require 'dry/cli'
+require_relative 'cli/setup'
+
+module Rivulet
+  module OTel
+    module CLI
+      module Commands
+        extend Dry::CLI::Registry
+
+        register 'setup', Commands::Setup
+      end
+    end
+  end
+end

data/lib/rivulet/otel/logger.rb

@@ -0,0 +1,68 @@
+module Rivulet
+  module OTel
+    class Logger
+      SEVERITY_MAP = {
+        debug: { text: 'DEBUG', number: 5 },
+        info:  { text: 'INFO',  number: 9 },
+        warn:  { text: 'WARN',  number: 13 },
+        error: { text: 'ERROR', number: 17 },
+        fatal: { text: 'FATAL', number: 21 },
+      }.freeze
+
+      LEVELS = { debug: 0, info: 1, warn: 2, error: 3, fatal: 4 }.freeze
+
+      def initialize(level: :info)
+        @level = LEVELS.fetch(level, 1)
+      end
+
+      def debug(message = nil, &block)
+        log(:debug, message, &block)
+      end
+
+      def info(message = nil, &block)
+        log(:info, message, &block)
+      end
+
+      def warn(message = nil, &block)
+        log(:warn, message, &block)
+      end
+
+      def error(message = nil, &block)
+        log(:error, message, &block)
+      end
+
+      def fatal(message = nil, &block)
+        log(:fatal, message, &block)
+      end
+
+      private
+
+      def log(severity, message = nil, &block)
+        return if LEVELS.fetch(severity, 1) < @level
+
+        body = (message || (block && block.call)).to_s
+        return if body.empty?
+
+        write_stdout(severity, body)
+        emit_otel(severity, body)
+      end
+
+      def write_stdout(severity, body)
+        ts = Time.now.strftime('%Y-%m-%d %H:%M:%S %z')
+        $stdout.puts("[#{severity.to_s.upcase}] #{ts} #{body}")
+      end
+
+      def emit_otel(severity, body)
+        otel_logger = OpenTelemetry.instance_variable_get(:@logger_provider)&.logger(name: 'rivulet')
+        return unless otel_logger
+
+        sev = SEVERITY_MAP.fetch(severity, SEVERITY_MAP[:info])
+        otel_logger.on_emit(
+          body: body,
+          severity_text: sev[:text],
+          severity_number: sev[:number]
+        )
+      end
+    end
+  end
+end

data/lib/rivulet/otel/metrics.rb

@@ -0,0 +1,53 @@
+module Rivulet
+  module OTel
+    class Metrics
+      def initialize
+        meter = OpenTelemetry.meter_provider.meter('rivulet')
+
+        @request_count = meter.create_counter(
+          'rivulet.request.count',
+          unit: '1',
+          description: 'Total number of requests'
+        )
+
+        @request_duration = meter.create_histogram(
+          'rivulet.request.duration_ms',
+          unit: 'ms',
+          description: 'Request duration in milliseconds'
+        )
+
+        @db_queries = meter.create_counter(
+          'rivulet.db.queries',
+          unit: '1',
+          description: 'Total number of database queries'
+        )
+
+        @db_duration = meter.create_histogram(
+          'rivulet.db.duration_ms',
+          unit: 'ms',
+          description: 'Database query duration in milliseconds'
+        )
+
+        @step_duration = meter.create_histogram(
+          'rivulet.step.duration_ms',
+          unit: 'ms',
+          description: 'Operation/step duration in milliseconds'
+        )
+      end
+
+      def record_request(total_ms)
+        @request_count.add(1)
+        @request_duration.record(total_ms)
+      end
+
+      def record_db(elapsed_ms)
+        @db_queries.add(1)
+        @db_duration.record(elapsed_ms)
+      end
+
+      def record_step(name, duration_ms)
+        @step_duration.record(duration_ms, attributes: { 'step.name' => name })
+      end
+    end
+  end
+end

data/lib/rivulet/otel/sink.rb

@@ -0,0 +1,66 @@
+require 'opentelemetry'
+
+module Rivulet
+  module OTel
+    class Sink
+      SPAN_STACK_KEY = :rivulet_otel_span_stack
+
+      def initialize(tracer: nil)
+        @tracer = tracer || OpenTelemetry.tracer_provider.tracer('rivulet')
+        @metrics = begin
+          Rivulet::OTel::Metrics.new
+        rescue
+          nil
+        end
+      end
+
+      def on_start(node, parent)
+        span = @tracer.start_span(node.name, kind: :internal)
+        span.set_attribute('rivulet.node.name', node.name)
+
+        ctx = OpenTelemetry::Trace.context_with_span(span)
+        token = OpenTelemetry::Context.attach(ctx)
+
+        stack = Fiber[SPAN_STACK_KEY] ||= []
+        stack.push(span: span, token: token)
+      end
+
+      def on_stop(node)
+        entry = (Fiber[SPAN_STACK_KEY] ||= []).pop
+        return unless entry
+
+        span = entry[:span]
+        token = entry[:token]
+
+        span.set_attribute('rivulet.duration_ms', node.duration_ms)
+        span.set_attribute('rivulet.self_ms', node.self_ms)
+
+        @metrics&.record_step(node.name, node.duration_ms)
+
+        span.finish
+        OpenTelemetry::Context.detach(token)
+      end
+
+      def on_db(elapsed_ms)
+        span = current_span
+        return unless span
+
+        span.add_event('db.query', attributes: { 'db.elapsed_ms' => elapsed_ms })
+        @metrics&.record_db(elapsed_ms)
+      end
+
+      def on_root(node, total_ms)
+        @metrics&.record_request(total_ms)
+      end
+
+      private
+
+      def current_span
+        stack = Fiber[SPAN_STACK_KEY]
+        return OpenTelemetry::Trace::Span.new unless stack&.any?
+
+        stack.last[:span]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: rivulet-opentelemetry
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Vladimir Dombrovskiy <vold@fastmail.com>
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rivulet-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.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-rack
+  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-logs-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-logs
+  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-metrics-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-metrics
+  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: dry-cli
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+executables:
+- rivulet-otel
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/rivulet-otel
+- lib/rivulet/opentelemetry.rb
+- lib/rivulet/opentelemetry/version.rb
+- lib/rivulet/otel/cli.rb
+- lib/rivulet/otel/cli/setup.rb
+- lib/rivulet/otel/logger.rb
+- lib/rivulet/otel/metrics.rb
+- lib/rivulet/otel/sink.rb
+licenses:
+- Apache-2.0
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: OpenTelemetry integration for Rivulet framework
+test_files: []