Feat support opentelemetry metrics (#38)

Signed-off-by: EdmondFrank <[email protected]>

.env.example

@@ -118,3 +118,8 @@ export NOTIFICATION_WECHAT_REPORT_SUBSCRIPTION_UPDATE_TEMPLATE_ID=OPENTM41261210
 export BOT_NAME=compass-bot
 export BOT_EMAIL=[email protected]
 
+# OpenTelemetry
+export OTEL_EXPORTER=otlp
+export OTEL_SERVICE_NAME=CompassSAAS
+export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
+export OTEL_RESOURCE_ATTRIBUTES=application=compass-web-service

Gemfile

@@ -122,6 +122,11 @@ gem 'rails-i18n'
 
 gem 'addressable'
 
+# OpenTelemetry
+gem 'opentelemetry-sdk'
+gem 'opentelemetry-exporter-otlp'
+gem 'opentelemetry-instrumentation-all'
+
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
   gem 'annotate'

Gemfile.lock

@@ -188,6 +188,10 @@ GEM
     gli (2.21.0)
     globalid (1.1.0)
       activesupport (>= 5.0)
+    google-protobuf (3.23.2-arm64-darwin)
+    google-protobuf (3.23.2-x86_64-linux)
+    googleapis-common-protos-types (1.6.0)
+      google-protobuf (~> 3.14)
     graphiql-rails (1.8.0)
       railties
       sprockets-rails
@@ -329,6 +333,196 @@ GEM
     opensearch-transport (2.0.1)
       faraday (>= 1.0, < 3)
       multi_json
+    opentelemetry-api (1.1.0)
+    opentelemetry-common (0.19.7)
+      opentelemetry-api (~> 1.0)
+    opentelemetry-exporter-otlp (0.25.0)
+      google-protobuf (~> 3.19)
+      googleapis-common-protos-types (~> 1.3)
+      opentelemetry-api (~> 1.1)
+      opentelemetry-common (~> 0.19.6)
+      opentelemetry-sdk (~> 1.2)
+      opentelemetry-semantic_conventions
+    opentelemetry-instrumentation-action_pack (0.7.0)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+      opentelemetry-instrumentation-rack (~> 0.21)
+    opentelemetry-instrumentation-action_view (0.6.0)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-active_support (~> 0.1)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-active_job (0.5.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-active_model_serializers (0.20.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-active_record (0.6.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+      ruby2_keywords
+    opentelemetry-instrumentation-active_support (0.4.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-all (0.39.1)
+      opentelemetry-instrumentation-active_model_serializers (~> 0.20.1)
+      opentelemetry-instrumentation-aws_sdk (~> 0.4.1)
+      opentelemetry-instrumentation-bunny (~> 0.20.1)
+      opentelemetry-instrumentation-concurrent_ruby (~> 0.21.1)
+      opentelemetry-instrumentation-dalli (~> 0.24.1)
+      opentelemetry-instrumentation-delayed_job (~> 0.20.1)
+      opentelemetry-instrumentation-ethon (~> 0.21.1)
+      opentelemetry-instrumentation-excon (~> 0.21.1)
+      opentelemetry-instrumentation-faraday (~> 0.23.1)
+      opentelemetry-instrumentation-grape (~> 0.1.3)
+      opentelemetry-instrumentation-graphql (~> 0.26.2)
+      opentelemetry-instrumentation-http (~> 0.23.1)
+      opentelemetry-instrumentation-http_client (~> 0.22.1)
+      opentelemetry-instrumentation-koala (~> 0.20.1)
+      opentelemetry-instrumentation-lmdb (~> 0.22.1)
+      opentelemetry-instrumentation-mongo (~> 0.22.1)
+      opentelemetry-instrumentation-mysql2 (~> 0.24.2)
+      opentelemetry-instrumentation-net_http (~> 0.22.1)
+      opentelemetry-instrumentation-pg (~> 0.25.2)
+      opentelemetry-instrumentation-que (~> 0.6.1)
+      opentelemetry-instrumentation-racecar (~> 0.2.1)
+      opentelemetry-instrumentation-rack (~> 0.23.1)
+      opentelemetry-instrumentation-rails (~> 0.27.1)
+      opentelemetry-instrumentation-rake (~> 0.2.1)
+      opentelemetry-instrumentation-rdkafka (~> 0.3.1)
+      opentelemetry-instrumentation-redis (~> 0.25.1)
+      opentelemetry-instrumentation-resque (~> 0.4.1)
+      opentelemetry-instrumentation-restclient (~> 0.22.1)
+      opentelemetry-instrumentation-ruby_kafka (~> 0.20.1)
+      opentelemetry-instrumentation-sidekiq (~> 0.24.1)
+      opentelemetry-instrumentation-sinatra (~> 0.23.1)
+      opentelemetry-instrumentation-trilogy (~> 0.56.1)
+    opentelemetry-instrumentation-aws_sdk (0.4.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-base (0.22.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-registry (~> 0.1)
+    opentelemetry-instrumentation-bunny (0.20.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-concurrent_ruby (0.21.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-dalli (0.24.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-delayed_job (0.20.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-ethon (0.21.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-excon (0.21.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-faraday (0.23.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-grape (0.1.3)
+      opentelemetry-api (~> 1.1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+      opentelemetry-instrumentation-rack (~> 0.21)
+    opentelemetry-instrumentation-graphql (0.26.2)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-http (0.23.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-http_client (0.22.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-koala (0.20.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-lmdb (0.22.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-mongo (0.22.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-mysql2 (0.24.2)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-net_http (0.22.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-pg (0.25.2)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-que (0.6.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-racecar (0.2.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-rack (0.23.2)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-rails (0.27.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-action_pack (~> 0.7.0)
+      opentelemetry-instrumentation-action_view (~> 0.6.0)
+      opentelemetry-instrumentation-active_job (~> 0.5.1)
+      opentelemetry-instrumentation-active_record (~> 0.6.1)
+      opentelemetry-instrumentation-active_support (~> 0.4.1)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-rake (0.2.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-rdkafka (0.3.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-redis (0.25.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-resque (0.4.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-restclient (0.22.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-ruby_kafka (0.20.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-sidekiq (0.24.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-sinatra (0.23.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+      opentelemetry-instrumentation-rack (~> 0.21)
+    opentelemetry-instrumentation-trilogy (0.56.1)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+      opentelemetry-semantic_conventions (>= 1.8.0)
+    opentelemetry-registry (0.2.0)
+      opentelemetry-api (~> 1.1)
+    opentelemetry-sdk (1.2.1)
+      opentelemetry-api (~> 1.1)
+      opentelemetry-common (~> 0.19.3)
+      opentelemetry-registry (~> 0.2)
+      opentelemetry-semantic_conventions
+    opentelemetry-semantic_conventions (1.10.0)
+      opentelemetry-api (~> 1.0)
     orm_adapter (0.5.0)
     overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
@@ -635,6 +829,9 @@ DEPENDENCIES
   omniauth-wechat-oauth2
   omniauth_openid_connect
   opensearch-ruby
+  opentelemetry-exporter-otlp
+  opentelemetry-instrumentation-all
+  opentelemetry-sdk
   overcommit
   pagy
   pry

config/environment.rb

@@ -1,5 +1,10 @@
 # Load the Rails application.
+require 'opentelemetry/sdk'
 require_relative "application"
 
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+
 # Initialize the Rails application.
 Rails.application.initialize!

config/environments/development.rb

@@ -72,6 +72,7 @@
   config.log_tags = [ :request_id ]
 
   # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.logger = ::Logger.new("log/development.log", 5, 50.megabytes)
   config.log_formatter = ::Logger::Formatter.new
 
   # Mailer configs

config/environments/production.rb

@@ -76,6 +76,7 @@
   config.active_support.report_deprecations = false
 
   # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.logger = ::Logger.new("log/production.log", 5, 20.megabytes)
   config.log_formatter = ::Logger::Formatter.new
 
   # Use a different logger for distributed setups.