minato-trace 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dad2393fa9ef79aa9bd7819bc96cb454d0d5def4183dd3feabbf616cbb5527d8
-  data.tar.gz: 1625ebc64178e9ab8af1603af99878d9c237a7819e1cc43ff813d2a6af635f27
+  metadata.gz: abaab6f1d94d35a7bb32bd461e843bb82cbb7e9920992b92cee8c3c1349e1f5c
+  data.tar.gz: '012468667f02897aa987032acb3ef00cd8306a7dce33ab5be8fba48302ed6fea'
 SHA512:
-  metadata.gz: ec570765bf6793ca52a6abec7fe08013c2b94fdaa94b6a42b64e5cf4d4b2ea80b60f2ed3ee771703fa1ba27540a077ada6845d1cd5e20e97f5b5287d390d51b2
-  data.tar.gz: ac27594c416905799c1008b54b40b910cbb1f1feecc7546219549ca197f8e2729181e08f4851322c9c19c2513a01dcdae344aa0fdbeedb40e4e0aac19f553ac4
+  metadata.gz: 85a8112afede40d0f3272d19938966d515f6d14d505e01afdccdbca0cd5aa7cbfaab94e6116963c587f4db9e8346e75986a31c2961201c13455c87fa2f75902a
+  data.tar.gz: 20b9d7c2b5332bca6aee82e81d85381191d5c455efba0586a24b382966f052b75b698dbfb2389c288e9f67b307754ab065296bdfcc729b7dfd7d422885d28a21

data/lib/minato/trace/configuration.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "opentelemetry/sdk"
+require "opentelemetry/exporter/otlp"
+
+module Minato
+  module Trace
+    class Configuration
+      # Indicates whether the trace functionality is enabled.
+      # This can be controlled via the `MINATO_TRACE_DISABLED` environment variable.
+      # If set to "true", tracing will be disabled.
+      # Default is true, meaning tracing is enabled unless explicitly disabled.
+      # Example: `ENV["MINATO_TRACE_DISABLED"] = "true"` will disable tracing
+      attr_accessor :enabled
+
+      # The name of the service to be used in Google Cloud Trace.
+      # This is used to identify the service in the Google Cloud Console.
+      # It should be a unique name that represents your application.
+      # Example: "my-rails-app"
+      attr_accessor :service_name
+
+      # This is the endpoint where traces will be sent.
+      # Default is google's Cloud Trace endpoint.
+      # You can modify this endpoint if you are using a different trace service.
+      # Example: "https://cloudtrace.googleapis.com/v1/projects/my-gcp-project-id/traces"
+      attr_accessor :otlp_endpoint
+
+      # A list of routes that should be excluded from tracing.
+      # These routes will not be traced, which is useful for health check endpoints
+      # or other endpoints that do not require tracing.
+      # Default is ["/health/alive", "/health/ready"].
+      # You can modify this list to include any other routes you want to exclude.
+      attr_reader :excluded_routes
+
+      # The runtime environment in which the application is running.
+      # It can be used to differentiate between environments for logging or tracing purposes.
+      # Default is the value of the `RUNTIME_ENV` environment variable or Rails environment.
+      # If `RUNTIME_ENV` is not set, it will default to `Rails.env
+      # Example: "production"
+      attr_reader :runtime_environment
+
+      # The ID of the project on Google Cloud
+      # It's used to generate official links betewwn the Cloud Trace and the Cloud Logging
+      # Example: "meu-gcp-project-id"
+      attr_accessor :project_id
+
+      def initialize
+        @enabled = ENV["MINATO_TRACE_DISABLED"] != "true"
+        @service_name = nil
+        @otlp_endpoint = ENV["OTEL_EXPORTER_OTLP_ENDPOINT"] || nil
+        @excluded_routes = ["/health/alive", "/health/ready"]
+        @runtime_environment = ENV["RUNTIME_ENV"] || ENV["RAILS_ENV"] || nil
+        @project_id = ENV["GOOGLE_CLOUD_PROJECT"] || ENV["GCP_PROJECT"] || nil
+      end
+
+      def excluded_routes=(routes)
+        @excluded_routes = Array(routes).map(&:to_s).uniq
+      end
+
+      def enabled?
+        @enabled
+      end
+
+      def disable!
+        @enabled = false
+      end
+
+      def enable!
+        @enabled = true
+      end
+
+      def otlp_exporter
+        OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+          OpenTelemetry::Exporter::OTLP::Exporter.new(
+            endpoint: otlp_endpoint
+          ),
+          max_queue_size: 1000,
+          schedule_delay: 1000,
+          max_export_batch_size: 100
+        )
+      end
+
+      def console_exporter
+        OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
+          OpenTelemetry::SDK::Trace::Export::ConsoleSpanExporter.new
+        )
+      end
+
+      def exporter
+        otlp_endpoint.nil? ? console_exporter : otlp_exporter
+      end
+
+      def ot_resources
+        resources = {
+          OpenTelemetry::SemanticConventions::Resource::SERVICE_NAME => service_name,
+          OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT => runtime_environment
+        }
+        OpenTelemetry::SDK::Resources::Resource.create(resources)
+      end
+    end
+  end
+end

data/lib/minato/trace/instrumentation/minato_logger/middleware.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Minato
+  module Trace
+    module Instrumentation
+      class MinatoLogger < OpenTelemetry::Instrumentation::Base
+        class Middleware
+          def call(log)
+            span = OpenTelemetry::Trace.current_span
+
+            return log unless span.context.valid?
+
+            data = trace_data(span)
+            log.merge(data)
+          end
+
+          private
+
+          def trace_data(span)
+            data = {
+              "trace_id" => span.context.hex_trace_id,
+              "span_id" => span.context.hex_span_id
+            }
+            trace_data = otel_data(data, span)
+
+            data.merge(trace_data)
+          end
+
+          def otel_data(data, span)
+            project_id = Minato::Trace.config.project_id
+            return {} if project_id.blank?
+
+            {
+              "logging.googleapis.com/trace" => "projects/#{project_id}/traces/#{data["trace_id"]}",
+              "logging.googleapis.com/spanId" => data["span_id"],
+              "logging.googleapis.com/trace_sampled" => span.context.trace_flags.sampled?
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minato/trace/instrumentation/minato_logger.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "opentelemetry/instrumentation/base"
+require_relative "minato_logger/middleware"
+
+module Minato
+  module Trace
+    module Instrumentation
+      class MinatoLogger < OpenTelemetry::Instrumentation::Base
+        instrumentation_name "Minato::Trace::Instrumentation::MinatoLogger"
+        instrumentation_version Minato::Trace::VERSION
+
+        present do
+          defined?(::MinatoLogger::Formatters::FluentBit)
+        end
+
+        install do |_config|
+          require_relative "minato_logger/middleware"
+
+          Rails.application.config.after_initialize do
+            if Rails.application.config.respond_to?(:minato_logger)
+              Rails.application.config.minato_logger.middleware.use(
+                Minato::Trace::Instrumentation::MinatoLogger::Middleware
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minato/trace/railtie.rb

@@ -1,11 +1,61 @@
 # frozen_string_literal: true
 
+require "opentelemetry/sdk"
+require "opentelemetry/exporter/otlp"
+require "opentelemetry/resource/detector"
+
+require "opentelemetry/instrumentation/rack"
+require "opentelemetry/instrumentation/action_pack"
+require "opentelemetry/instrumentation/active_record"
+require "opentelemetry/instrumentation/active_job"
+require "opentelemetry/instrumentation/net/http"
+require "opentelemetry/instrumentation/faraday"
+require "opentelemetry/instrumentation/http"
+require "opentelemetry/instrumentation/active_model_serializers"
+require "opentelemetry/instrumentation/concurrent_ruby"
+require "opentelemetry/instrumentation/redis"
+
+require "minato/trace/instrumentation/minato_logger"
+require "rails"
+
 module Minato
   module Trace
     class Railtie < ::Rails::Railtie
-      initializer "minato_trace_setup",
-                  before: "load_environment_config" do |app|
-        Minato::Trace.init(app)
+      config.minato_trace = ActiveSupport::OrderedOptions.new
+
+      initializer "minato_trace.configure", after: :load_config_initializers do |_app|
+        next unless Minato::Trace.config.enabled?
+
+        unless Minato::Trace.config.service_name
+          raise Minato::Trace::Error, "Minato Trace service_name configuration is missing."
+        end
+
+        OpenTelemetry::SDK.configure do |c|
+          c.service_name = Minato::Trace.config.service_name
+          app_resource = Minato::Trace.config.ot_resources
+          gcp_resource = OpenTelemetry::Resource::Detector::GoogleCloudPlatform.detect
+          c.resource = gcp_resource.merge(app_resource)
+
+          c.use "OpenTelemetry::Instrumentation::Rack", {
+            enabled: true,
+            untraced_endpoints: Minato::Trace.config.excluded_routes
+          }
+          c.use "OpenTelemetry::Instrumentation::ActionPack"
+
+          c.use "OpenTelemetry::Instrumentation::ActiveRecord"
+          c.use "OpenTelemetry::Instrumentation::ActiveJob"
+          c.use "OpenTelemetry::Instrumentation::Redis"
+
+          c.use "OpenTelemetry::Instrumentation::Net::HTTP"
+          c.use "OpenTelemetry::Instrumentation::Faraday"
+          c.use "OpenTelemetry::Instrumentation::HTTP"
+
+          c.use "OpenTelemetry::Instrumentation::ActiveModelSerializers"
+          c.use "OpenTelemetry::Instrumentation::ConcurrentRuby"
+          c.use "Minato::Trace::Instrumentation::MinatoLogger", { enabled: true }
+
+          c.add_span_processor(Minato::Trace.config.exporter)
+        end
       end
     end
   end

data/lib/minato/trace/version.rb

@@ -2,6 +2,6 @@
 
 module Minato
   module Trace
-    VERSION = "0.2.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/minato/trace.rb

@@ -1,45 +1,35 @@
 # frozen_string_literal: true
 
 require "minato/trace/version"
-require "minato/trace/middleware"
-
-if defined? Rails::Railtie
-  require "google/cloud/trace/rails"
-  require "minato/trace/railtie"
+require "minato/trace/configuration"
+require "opentelemetry-sdk"
+begin
+  require "rails/railtie"
+rescue LoadError => e
+  Rails.logger.debug e
 end
+require "minato/trace/railtie" if defined?(Rails::Railtie)
 
 module Minato
   module Trace
-    BLACKLIST_PATHS = ["/health/alive", "/health/ready"].freeze
-
-    def self.init(app)
-      if Minato::Trace.enabled?
-        Minato::Trace.configure_loggging
-        Minato::Trace.configure_trace
-      end
-
-      app
-    end
+    class Error < StandardError; end
 
     def self.enabled?
       ENV["MINATO_TRACE_DISABLED"] != "true"
     end
 
-    def self.configure_trace
-      Google::Cloud.configure do |config|
-        config.use_trace = true
-        config.trace.sampler = Google::Cloud::Trace::TimeSampler.new(path_blacklist: BLACKLIST_PATHS.dup)
-      end
+    def self.configure
+      @config ||= Configuration.new
+      yield(@config) if block_given?
+      @config
     end
 
-    def self.configure_loggging
-      Google::Cloud.configure do |config|
-        config.use_logging = false
-      end
+    def self.config
+      @config || configure
     end
 
-    def self.skip_trace?(trace)
-      BLACKLIST_PATHS.any? { |path| trace.name.start_with?(path) }
+    def self.tracer
+      @tracer ||= OpenTelemetry.tracer_provider.tracer("minato_trace", Minato::Trace::VERSION)
     end
   end
 end

data/lib/tasks/minato/trace_tasks.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :minato_trace do
 #   # Task goes here

metadata

@@ -1,44 +1,213 @@
 --- !ruby/object:Gem::Specification
 name: minato-trace
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ferreri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 2026-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: google-cloud-trace
+  name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.2
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.2
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 7.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
-description: Default setup of trace gem in Minato Rails Apps.
+        version: 7.0.8
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-resource-detector-google_cloud_platform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-action_pack
+  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-active_job
+  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-active_model_serializers
+  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-active_record
+  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-concurrent_ruby
+  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-faraday
+  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-http
+  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-net_http
+  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-instrumentation-redis
+  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'
+description: Add OpenTelemetry instrumentation to your Minato Rails applications,                       enabling
+  tracing with Google Cloud Trace integration or any other trace service.
 email:
 - contato@ferreri.co
 executables: []
@@ -49,9 +218,9 @@ files:
 - README.md
 - Rakefile
 - lib/minato/trace.rb
-- lib/minato/trace/middleware.rb
-- lib/minato/trace/middleware/distributed_trace_context.rb
-- lib/minato/trace/middleware/integrate_with_cloud_logging.rb
+- lib/minato/trace/configuration.rb
+- lib/minato/trace/instrumentation/minato_logger.rb
+- lib/minato/trace/instrumentation/minato_logger/middleware.rb
 - lib/minato/trace/railtie.rb
 - lib/minato/trace/version.rb
 - lib/tasks/minato/trace_tasks.rake
@@ -71,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -81,5 +250,5 @@ requirements: []
 rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
-summary: trace configuration for Minato Rails Apps.
+summary: Configure OpenTelementry instrumentation for Minato Rails applications
 test_files: []

data/lib/minato/trace/middleware/distributed_trace_context.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Minato
-  module Trace
-    module Middleware
-      class DistributedTraceContext
-        TRACE_HEADER_KEY = "X-Cloud-Trace-Context"
-
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          add_trace_context_header(env)
-
-          @app.call(env)
-        end
-
-        private
-
-        def add_trace_context_header(env)
-          return unless ::Rails.env.production? && Minato::Trace.enabled?
-
-          return if current_cloud_trace.nil?
-
-          env.request_headers.merge!({ "#{TRACE_HEADER_KEY}": "#{current_cloud_trace.trace.trace_id};o=1" })
-        end
-
-        def current_cloud_trace
-          @current_cloud_trace ||= current_trace_from_google_cloud
-        end
-
-        def current_trace_from_google_cloud
-          _trace_client = Google::Cloud::Trace.new
-          Google::Cloud::Trace.get
-        end
-      end
-    end
-  end
-end

data/lib/minato/trace/middleware/integrate_with_cloud_logging.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Minato
-  module Trace
-    module Middleware
-      class IntegrateWithCloudLogging
-        def call(log)
-          return log unless ::Rails.env.production? && Minato::Trace.enabled?
-
-          add_trace_to_logs(log)
-        end
-
-        private
-
-        def add_trace_to_logs(log)
-          return log if current_cloud_trace.nil?
-
-          trace_log = "projects/#{current_cloud_trace.trace.project_id}/traces/#{current_cloud_trace.trace.trace_id}"
-
-          log.merge({ "logging.googleapis.com/trace": trace_log,
-                      "logging.googleapis.com/spanId": current_cloud_trace.span_id.to_s })
-        end
-
-        def current_cloud_trace
-          @current_cloud_trace ||= current_cloud_trace_from_google_cloud
-        end
-
-        def current_cloud_trace_from_google_cloud
-          _trace_client = Google::Cloud::Trace.new
-          Google::Cloud::Trace.get
-        end
-      end
-    end
-  end
-end

data/lib/minato/trace/middleware.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "minato/trace/middleware/distributed_trace_context"
-require "minato/trace/middleware/integrate_with_cloud_logging"
-
-module Minato
-  module Trace
-    module Middleware
-    end
-  end
-end