Merge pull request #344 from 3scale/modernize

update and modernize everything

Author: akostadinov

.circleci/config.yml

@@ -3,16 +3,15 @@ jobs:
   build:
     working_directory: /home/circleci/echo-api
     docker:
-      - image: circleci/ruby:2.7
+      - image: cimg/ruby:3.3
         environment:
-          BUNDLE_JOBS: 3
           BUNDLE_RETRY: 3
           BUNDLE_PATH: vendor/bundle
           OPENTRACING_TRACER: jaeger
           BUNDLE_FROZEN: true # --deployment
-      - image: jaegertracing/all-in-one:1.21
+      - image: quay.io/jaegertracing/jaeger:2.4.0
         environment:
-          COLLECTOR_ZIPKIN_HTTP_PORT: 9411
+          COLLECTOR_OTLP_ENABLED: 1
     steps:
       - checkout
 
@@ -42,10 +41,12 @@ jobs:
             dockerize -wait tcp://0.0.0.0:3000 -timeout 1m # wait for echo-api
 
             curl --fail http://0.0.0.0:3000/test
+            [ x204 = x`curl -s -o /dev/null -w "%{http_code}" http://0.0.0.0:3000/status/204` ]
 
       - run:
           name: Verify OpenTracing
           command: |
-            sleep 1 # that is the flush timeout
-            curl http://localhost:16686/api/services/echo-api/operations | jq '(.data | length) > 0' --exit-status
+            sleep 11 # default flush timeout is 10 https://github.com/open-telemetry/opentelemetry-ruby/tree/main/exporter/otlp-http
+            curl -sS http://localhost:16686/api/services/echo-api/operations | tee operations.out
+            jq '(.data | length) > 0' --exit-status < operations.out
 

.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.tool-versions
 coverage
 InstalledFiles
 lib/bundler/man

.tool-versions.example

@@ -0,0 +1 @@
+ruby 3.3.1

Dockerfile

@@ -1,18 +1,17 @@
 # Common base image
-FROM registry.access.redhat.com/ubi8/ubi-minimal AS base
+FROM registry.access.redhat.com/ubi9/ubi-minimal AS base
 
 EXPOSE 9292
 
 ENV HOME=/home
 WORKDIR "${HOME}/app"
 
-ARG RUBY_VERSION="2.7"
-ARG BUNDLER_VERSION="2.3.6"
+ARG RUBY_VERSION="3.3"
+ARG BUNDLER_VERSION="2.6.6"
 ARG RUNTIME_DEPS="ruby"
 
 RUN echo -e "[ruby]\nname=ruby\nstream=${RUBY_VERSION}\nprofiles=\nstate=enabled\n" > /etc/dnf/modules.d/ruby.module \
-  && microdnf update --nodocs \
-  && microdnf install --nodocs ${RUNTIME_DEPS} \
+  && microdnf install -y --nodocs ${RUNTIME_DEPS} \
   && rm -rf /var/cache/yum /var/cache/dnf \
   && gem install -N bundler -v "= ${BUNDLER_VERSION}" \
   && chown -R 1001:1001 "${HOME}"
@@ -22,7 +21,7 @@ FROM base AS builder-base
 
 ARG BUILD_DEPS="tar make file findutils git patch gcc automake autoconf libtool redhat-rpm-config openssl-devel ruby-devel"
 
-RUN microdnf install --nodocs ${BUILD_DEPS} \
+RUN microdnf install -y --nodocs ${BUILD_DEPS} \
   && rm -rf /var/cache/yum /var/cache/dnf
 
 COPY --chown=1001:1001 ./Gemfile* "${HOME}/app/"
@@ -58,7 +57,7 @@ FROM builder-base AS dev
 USER root
 
 ARG DEV_TOOLS="vim gdb"
-RUN microdnf install --nodocs ${DEV_TOOLS} \
+RUN microdnf install -y --nodocs ${DEV_TOOLS} \
   && rm -rf /var/cache/yum /var/cache/dnf
 
 ARG DEV_UID=1001

Gemfile

@@ -4,15 +4,18 @@ source 'https://rubygems.org'
 
 gem 'nokogiri', '~> 1'
 gem 'puma'
-gem 'rack', '~> 2'
+gem 'rack', '~> 3'
 gem 'rack-cors', require: 'rack/cors'
-gem 'sinatra'
+gem 'rackup', '~> 2.2'
+gem 'sinatra', '~> 4'
 
 gem 'json'
 
 # Opentracing
-gem 'jaeger-client', '~> 1', require: nil
-gem 'rack-tracer', '~> 0.9', require: nil
+gem 'opentelemetry-instrumentation-rack', '~> 0.22', require: false
+gem 'opentelemetry-instrumentation-sinatra', '~> 0.22', require: false
+gem 'opentelemetry-exporter-otlp', require: false
+gem 'opentelemetry-exporter-zipkin', require: false
 
 group :development do
   gem 'shotgun'

Gemfile.lock

@@ -1,56 +1,110 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    jaeger-client (1.3.0)
-      opentracing (~> 0.3)
-      thrift
-    json (2.6.3)
-    mini_portile2 (2.8.0)
-    mustermann (1.1.1)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    csv (3.3.3)
+    google-protobuf (4.30.1)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.30.1-x86_64-linux)
+      bigdecimal
+      rake (>= 13)
+    googleapis-common-protos-types (1.19.0)
+      google-protobuf (>= 3.18, < 5.a)
+    json (2.10.2)
+    logger (1.6.6)
+    mini_portile2 (2.8.8)
+    mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
-    nio4r (2.5.8)
-    nokogiri (1.13.6)
-      mini_portile2 (~> 2.8.0)
+    nio4r (2.7.4)
+    nokogiri (1.18.6)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.13.6-x86_64-linux)
+    nokogiri (1.18.6-x86_64-linux-gnu)
       racc (~> 1.4)
-    opentracing (0.5.0)
-    puma (5.6.4)
+    opentelemetry-api (1.5.0)
+    opentelemetry-common (0.22.0)
+      opentelemetry-api (~> 1.0)
+    opentelemetry-exporter-otlp (0.30.0)
+      google-protobuf (>= 3.18)
+      googleapis-common-protos-types (~> 1.3)
+      opentelemetry-api (~> 1.1)
+      opentelemetry-common (~> 0.20)
+      opentelemetry-sdk (~> 1.2)
+      opentelemetry-semantic_conventions
+    opentelemetry-exporter-zipkin (0.24.0)
+      csv (~> 3.1)
+      opentelemetry-api (~> 1.1)
+      opentelemetry-common (~> 0.20)
+      opentelemetry-sdk (~> 1.2)
+      opentelemetry-semantic_conventions
+    opentelemetry-instrumentation-base (0.23.0)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.21)
+      opentelemetry-registry (~> 0.1)
+    opentelemetry-instrumentation-rack (0.26.0)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.23.0)
+    opentelemetry-instrumentation-sinatra (0.25.0)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.23.0)
+      opentelemetry-instrumentation-rack (~> 0.21)
+    opentelemetry-registry (0.4.0)
+      opentelemetry-api (~> 1.1)
+    opentelemetry-sdk (1.8.0)
+      opentelemetry-api (~> 1.1)
+      opentelemetry-common (~> 0.20)
+      opentelemetry-registry (~> 0.2)
+      opentelemetry-semantic_conventions
+    opentelemetry-semantic_conventions (1.11.0)
+      opentelemetry-api (~> 1.0)
+    puma (6.6.0)
       nio4r (~> 2.0)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-cors (1.1.1)
+    racc (1.8.1)
+    rack (3.1.12)
+    rack-cors (2.0.2)
       rack (>= 2.0.0)
-    rack-protection (2.2.0)
-      rack
-    rack-tracer (0.9.0)
-      opentracing (~> 0.4)
+    rack-protection (4.1.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rackup (2.2.1)
+      rack (>= 3)
+    rake (13.2.1)
     ruby2_keywords (0.0.5)
     shotgun (0.9.2)
       rack (>= 1.0)
-    sinatra (2.2.0)
-      mustermann (~> 1.0)
-      rack (~> 2.2)
-      rack-protection (= 2.2.0)
+    sinatra (4.1.1)
+      logger (>= 1.6.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.1.1)
+      rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
-    thrift (0.16.0)
-    tilt (2.0.10)
+    tilt (2.6.0)
 
 PLATFORMS
   powerpc64le-linux
   ruby
   x86_64-linux
 
 DEPENDENCIES
-  jaeger-client (~> 1)
   json
   nokogiri (~> 1)
+  opentelemetry-exporter-otlp
+  opentelemetry-exporter-zipkin
+  opentelemetry-instrumentation-rack (~> 0.22)
+  opentelemetry-instrumentation-sinatra (~> 0.22)
   puma
-  rack (~> 2)
+  rack (~> 3)
   rack-cors
-  rack-tracer (~> 0.9)
+  rackup (~> 2.2)
   shotgun
-  sinatra
+  sinatra (~> 4)
 
 BUNDLED WITH
-   2.3.6
+   2.6.6

contrib/openshift/echo-api-template.yml

@@ -1,4 +1,4 @@
-apiVersion: v1
+apiVersion: template.openshift.io/v1
 kind: Template
 metadata:
   creationTimestamp: null
@@ -10,7 +10,7 @@ metadata:
 
 objects:
 
-- apiVersion: v1
+- apiVersion: apps.openshift.io/v1
   kind: DeploymentConfig
   metadata:
     name: echo-api
@@ -67,7 +67,7 @@ objects:
     selector:
       deploymentconfig: echo-api
 
-- apiVersion: v1
+- apiVersion: route.openshift.io/v1
   kind: Route
   metadata:
     name: echo-api

echo_api.rb

@@ -3,16 +3,13 @@
 # shotgun app.rb -p 9294
 
 module EchoAPI
-  VERSION = '1.0.5'.freeze
+  VERSION = '1.1.0'.freeze
 end
 
-require 'sinatra'
-require 'json'
-require 'nokogiri'
-require 'digest/sha1'
-require 'securerandom'
-require 'base64'
-require 'rack/cors'
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
 
 enable :logging
 set :protection, except: [:json_csrf]
@@ -23,20 +20,28 @@ module EchoAPI
   enable :static
 end
 
-case ENV['OPENTRACING_TRACER']
-when 'jaeger'
-  require 'jaeger/client'
-  require 'rack/tracer'
 
-  jaeger_agent_host = ENV['JAEGER_AGENT_HOST'] || '127.0.0.1'
-  jaeger_agent_port = ENV['JAEGER_AGENT_PORT'] || 6831
-  jaeger_service_name = ENV['JAEGER_SERVICE_NAME'] || 'echo-api'
-  jaeger_client = Jaeger::Client.build(host: jaeger_agent_host,
-                                       port: jaeger_agent_port,
-                                       service_name: jaeger_service_name,
-                                       flush_interval: 1)
+telemetry_exporter = ENV['OTEL_TRACES_EXPORTER'] || ENV['OPENTRACING_TRACER']
+if telemetry_exporter
+  telemetry_exporter = 'otlp' if telemetry_exporter == 'jaeger'
+
+  ENV['OTEL_TRACES_EXPORTER'] = telemetry_exporter
+  require 'opentelemetry/sdk'
+  unless telemetry_exporter == 'console'
+    host = ENV['JAEGER_AGENT_HOST'] || '127.0.0.1'
+    port = ENV['JAEGER_AGENT_PORT']
+    port ||= telemetry_exporter == 'zipkin' ? 6831 : 4318
+    ENV['OTEL_EXPORTER_OTLP_ENDPOINT'] ||= "http://#{host}:#{port}"
+    require "opentelemetry/exporter/#{telemetry_exporter}"
+  end
+
+  require 'opentelemetry/instrumentation/sinatra'
+
+  OpenTelemetry::SDK.configure do |c|
+    c.service_name = ENV['OTEL_SERVICE_NAME'] || ENV['JAEGER_SERVICE_NAME'] || 'echo-api'
 
-  use ::Rack::Tracer, tracer: jaeger_client
+    c.use 'OpenTelemetry::Instrumentation::Sinatra'
+  end
 end
 
 # Enabling CORS