hypertrace-agent 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d22bcf228d92b8f9d0b2f15859d8fe3ad2682ad81254c71a41cc766752ea03e8
-  data.tar.gz: 101e6f0dab77ab8baf63ea6682dd7d93b5336ca0f84525ddb36ee053a5525b07
+  metadata.gz: 5f6326f5fd71561a9650dd5c9ad8098a9da9cf8d1632d86a4a708f4ef53d0c0d
+  data.tar.gz: 5e97a94ab436dfcf90a0f5d2c6b835fc4b5700798b0ce697a1ecc8d8a6ac3c4b
 SHA512:
-  metadata.gz: 57b075dc324c1fe9c374b268ae365fda2480afcb4651dac118ddc26f9eafa8c3495444fdcee4d0e7462589269710672640ce7c6eac0a3bf790845752b5e9e40c
-  data.tar.gz: 044dd0ec7a3bf16737b31c9b7fbd3d8d38c791c2e404d785404d143b7be13e24316fd1525f848b1aa55d8fd4f051753cd9e6af99ead448535d2e94d183896c72
+  metadata.gz: 042e6e70677f70145a1f6acd60e59af6f560a0f1b496fd04833b0015ca0204b95a00d168d0a051207629cafc5843b3ae22fa54d0ab15a9fdf5d0b88c1e420c84
+  data.tar.gz: 0ac7871f61b712e9a85cb77e4bda7654bf7419b0444fcb17ecd180f8da58869ff941832556ae85b5d07861f34afb8b8477396330a53afbd2350af4f5a94e2461

data/lib/hypertrace/otlp_http_exporter.rb

@@ -0,0 +1,118 @@
+require 'opentelemetry/sdk'
+require 'opentelemetry/exporter/otlp'
+require 'opentelemetry/exporter/otlp/exporter'
+
+class Hypertrace::OtlpHttpExporter < OpenTelemetry::Exporter::OTLP::Exporter
+
+  def initialize(endpoint: config_opt('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', 'OTEL_EXPORTER_OTLP_ENDPOINT', default: 'https://localhost:4318/v1/traces'), # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+                 certificate_file: config_opt('OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE', 'OTEL_EXPORTER_OTLP_CERTIFICATE'),
+                 ssl_verify_mode: self.class.ssl_verify_mode,
+                 headers: config_opt('OTEL_EXPORTER_OTLP_TRACES_HEADERS', 'OTEL_EXPORTER_OTLP_HEADERS', default: {}),
+                 compression: config_opt('OTEL_EXPORTER_OTLP_TRACES_COMPRESSION', 'OTEL_EXPORTER_OTLP_COMPRESSION', default: 'gzip'),
+                 timeout: config_opt('OTEL_EXPORTER_OTLP_TRACES_TIMEOUT', 'OTEL_EXPORTER_OTLP_TIMEOUT', default: 10),
+                 metrics_reporter: nil,
+                 allowed_request_headers: [],
+                 allowed_response_headers: [],
+                 drop_attributes: [],
+                 supported_instrumentation_libraries: [],
+                 use_all: false,
+                 is_hypertrace: false,
+                 custom_resource: nil
+
+  )
+
+    super(
+      endpoint: endpoint,
+      certificate_file: certificate_file,
+      ssl_verify_mode: ssl_verify_mode,
+      headers: headers,
+      compression: compression,
+      timeout: timeout,
+      metrics_reporter: metrics_reporter
+    )
+
+    # If a user specifies use_all that means we need to keep all spans
+    # If a user specifies supported libraries that means we should drop spans that aren't from those libraries
+    if use_all && supported_instrumentation_libraries.length > 0
+      raise ArgumentError.new("Must use either use_all or supported_instrumentation_libraries, cannot specify both")
+    end
+
+    # if passed is_hypertrace all spans + attributes will be kept, we should be the only one passing this
+    @is_hypertrace = is_hypertrace
+    # List of request headers to allow, not used by hypertrace
+    @allowed_request_headers = []
+    # List of response headers to allow, not used by hypertrace
+    @allowed_response_headers = []
+    allowed_request_headers.each do |req_header|
+      @allowed_request_headers << "http.request.header.#{req_header}"
+    end
+    allowed_response_headers.each do |res_header|
+      @allowed_response_headers << "http.response.header.#{res_header}"
+    end
+    # List of instrumentation libraries to report for this exporter
+    @supported_instrumentation_libraries = supported_instrumentation_libraries
+    # If c.use_all is used to configure OTEL sdk this option should be used
+    # We won't drop any spans based on Instrumentation library
+    @use_all = use_all
+    # List of attributes to always drop
+    @drop_attributes = drop_attributes
+    # An override resource object to override default configured resource
+    @custom_resource = custom_resource
+  end
+
+  def export(span_data, timeout: nil)
+    # Drop spans if not from a supported library
+    span_data = drop_extra_spans(span_data)
+    # Remove any attributes that shouldn't be reported
+    span_data = drop_attributes(span_data)
+    # Override the default configured resource - only used by Hypertrace
+    span_data = customize_resource(span_data)
+    super
+  end
+
+  def drop_extra_spans(span_data)
+    return span_data if @use_all
+    filtered_spans = span_data.select do |span|
+      name = span.instrumentation_library.name
+      # If a user uses a manually created span we should keep it, ex: instrumentation_library.name = "My-tracer"
+      # If a user is using an OTel Library the value will be like: OpenTelemetry::Instrumentation::Rack
+      !name.include?("OpenTelemetry") || @supported_instrumentation_libraries.include?(name)
+    end
+    filtered_spans
+  end
+
+  def drop_attributes span_data
+    return span_data if @is_hypertrace
+    span_data.each do |span|
+      new_attributes = {}
+
+      span[:attributes].each do |key, value|
+        if @drop_attributes.include?(key)
+          next
+        elsif key.start_with?('http.request.header.')
+          if @allowed_request_headers.include?(key)
+            new_attributes[key] = value
+          end
+          next
+        elsif key.start_with?('http.response.header.')
+          if @allowed_response_headers.include?(key)
+            new_attributes[key] = value
+          end
+          next
+        else
+          new_attributes[key] = value
+        end
+      end
+      span[:attributes] = new_attributes
+    end
+    span_data
+  end
+
+  def customize_resource span_data
+    return span_data unless @custom_resource
+    span_data.each do |span|
+      span.resource = @custom_resource
+    end
+    span_data
+  end
+end

data/lib/hypertrace/ruby_agent.rb

@@ -32,21 +32,48 @@ class Hypertrace::RubyAgent
   include Hypertrace::Logging
   include Singleton
 
+  SUPPORTED_INSTRUMENTATIONS = [
+    'OpenTelemetry::Instrumentation::ActionPack',
+    'OpenTelemetry::Instrumentation::ActionView',
+    'OpenTelemetry::Instrumentation::ActiveRecord',
+    'OpenTelemetry::Instrumentation::ActiveSupport',
+    'OpenTelemetry::Instrumentation::Faraday',
+    'OpenTelemetry::Instrumentation::Mongo',
+    'OpenTelemetry::Instrumentation::Mysql2',
+    'OpenTelemetry::Instrumentation::PG',
+    'OpenTelemetry::Instrumentation::Rack',
+    'OpenTelemetry::Instrumentation::Sinatra',
+    'OpenTelemetry::Instrumentation::Net::HTTP',
+    'OpenTelemetry::Instrumentation::HTTP',
+    'OpenTelemetry::Instrumentation::RestClient'
+  ].freeze
+
+  SUPPORTED_INSTRUMENTATIONS_ADDITIONAL_PATCH = {
+    'OpenTelemetry::Instrumentation::Faraday' => ['./instrumentation/faraday_patch'],
+    'OpenTelemetry::Instrumentation::Rack' => ['./instrumentation/rack', './instrumentation/rack_env_getter'],
+    'OpenTelemetry::Instrumentation::Net::HTTP' => ['./instrumentation/net_http_patch'],
+    'OpenTelemetry::Instrumentation::HTTP' => ['./instrumentation/http_patch'],
+    'OpenTelemetry::Instrumentation::RestClient' => ['./instrumentation/rest_client_patch'],
+  }
+
   def self.instrument!
     self.instance.instrument!
   end
 
+  def self.instrument_as_additional!
+    self.instance.instrument_as_additional!
+  end
+
   def self.config
     self.instance.config
   end
 
   def initialize(version = Hypertrace::VERSION)
-    log.info {"Initializing Hypertrace"}
-    configure_otel_logger!
+    log.info { "Initializing Hypertrace" }
     @config = Hypertrace::Config::Config.new
     @version = version
-    log.info {"Hypertrace version: #{Hypertrace::VERSION}"}
-    log.info {"Ruby version: #{RUBY_VERSION}"}
+    log.info { "Hypertrace version: #{Hypertrace::VERSION}" }
+    log.info { "Ruby version: #{RUBY_VERSION}" }
   end
 
   def config
@@ -57,47 +84,71 @@ class Hypertrace::RubyAgent
     initalize_tracer
   end
 
-  def initalize_tracer
+  def instrument_as_additional!
     resource = OpenTelemetry::SDK::Resources::Resource.create(create_resource_attributes)
+    exporter = create_resource_customized_exporter resource
+    span_processor = create_span_processor exporter
 
-    # TODO: Extra resource Attributes From Config
-    exporter = create_exporter
-    OpenTelemetry::SDK.configure do |c|
-      if ENV['HT_CI_TEST'] != nil
-        span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(EXPORTER)
-        c.add_span_processor span_processor
-      else
-        c.add_span_processor OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(exporter)
-      end
-      c.resource = resource
-
-      c.use 'OpenTelemetry::Instrumentation::ActionPack'
-      c.use 'OpenTelemetry::Instrumentation::ActionView'
-      c.use 'OpenTelemetry::Instrumentation::ActiveRecord'
-      c.use 'OpenTelemetry::Instrumentation::ActiveSupport'
-      c.use 'OpenTelemetry::Instrumentation::Faraday'
-      c.use 'OpenTelemetry::Instrumentation::Mongo'
-      c.use 'OpenTelemetry::Instrumentation::Mysql2'
-      c.use 'OpenTelemetry::Instrumentation::PG'
-      c.use 'OpenTelemetry::Instrumentation::Rack'
-      c.use 'OpenTelemetry::Instrumentation::Sinatra'
-      c.use 'OpenTelemetry::Instrumentation::Net::HTTP'
-      c.use 'OpenTelemetry::Instrumentation::HTTP'
-      c.use 'OpenTelemetry::Instrumentation::RestClient'
+    existing_processors = OpenTelemetry.tracer_provider.instance_variable_get(:"@span_processors")
+    if existing_processors.nil? || existing_processors&.empty?
+      log.error("No existing tracer_provider found, continuing without Hypertrace instrumentation")
+      return
     end
+    existing_processors << span_processor
+    OpenTelemetry.tracer_provider.instance_variable_set(:'@span_processors', existing_processors)
+    # We don't pass a span_processor or resource because we have to add it to the already configured tracer provider
+    # The resource will be added at the export phase
+    configure_instrumentation nil, nil
+    configure_propagators
+  end
 
-    apply_custom_patch './instrumentation/rack'
-    apply_custom_patch './instrumentation/net_http_patch'
-    apply_custom_patch './instrumentation/http_patch'
-    apply_custom_patch './instrumentation/faraday_patch'
-    apply_custom_patch './instrumentation/rest_client_patch'
-    apply_custom_patch './instrumentation/rack_env_getter'
+  def create_span_processor exporter
+    return OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(EXPORTER) if ENV['HT_CI_TEST'] != nil
+    return OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(exporter)
+  end
 
+  def initalize_tracer
+    resource = OpenTelemetry::SDK::Resources::Resource.create(create_resource_attributes)
+    exporter = create_exporter
+    span_processor = create_span_processor(exporter)
+    # TODO: Extra resource Attributes From Config
+    configure_instrumentation span_processor, resource
     configure_propagators
   end
 
+  def configure_instrumentation span_processor, resource
+    OpenTelemetry::SDK.configure do |c|
+      c.add_span_processor span_processor if span_processor
+      c.resource = resource if resource
+
+      SUPPORTED_INSTRUMENTATIONS.each do |instrumentation_string|
+        c.use instrumentation_string
+        additional_patches = SUPPORTED_INSTRUMENTATIONS_ADDITIONAL_PATCH[instrumentation_string]
+        if additional_patches
+          additional_patches.each do |patch_file|
+            apply_custom_patch patch_file
+          end
+        end
+      end
+    end
+  end
+
   private
 
+  def create_resource_customized_exporter resource
+    exporter = nil
+    if config.reporting.trace_reporter_type == :OTLP
+      verify_mode = config.reporting.secure.value ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+      exporter = Hypertrace::OtlpHttpExporter.new(endpoint: config.reporting.endpoint.value,
+                                                  ssl_verify_mode: verify_mode,
+                                                  is_hypertrace: true,
+                                                  supported_instrumentation_libraries: SUPPORTED_INSTRUMENTATIONS,
+                                                  custom_resource: resource)
+      return exporter
+    end
+    log.error "Resource customized exporter not supported for zipkin, only OTLP HTTP"
+  end
+
   def create_exporter
     exporter = nil
     if config.reporting.trace_reporter_type == :OTLP
@@ -123,7 +174,7 @@ class Hypertrace::RubyAgent
       end
     end
     if propagator_list.empty?
-      log.warn{"No propagators were added!"}
+      log.warn { "No propagators were added!" }
     end
     OpenTelemetry.propagation = OpenTelemetry::Context::Propagation::CompositeTextMapPropagator.compose_propagators(propagator_list.compact)
   end
@@ -133,9 +184,9 @@ class Hypertrace::RubyAgent
   def apply_custom_patch file
     begin
       require_relative file
-      log.debug{"Applied patch for #{file}"}
+      log.debug { "Applied patch for #{file}" }
     rescue => _e
-      log.debug{"Unable to apply patch for #{file} this is most likely because the library is unavailable or an unsupported version"}
+      log.debug { "Unable to apply patch for #{file} this is most likely because the library is unavailable or an unsupported version" }
     end
   end
 
@@ -148,10 +199,4 @@ class Hypertrace::RubyAgent
       'telemetry.sdk.language': 'ruby'
     }.transform_keys(&:to_s)
   end
-
-  NULL_LOGGER = Logger.new(File::NULL)
-
-  def configure_otel_logger!
-    OpenTelemetry.logger = NULL_LOGGER
-  end
 end

data/lib/hypertrace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hypertrace
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/hypertrace.rb

@@ -8,6 +8,5 @@ require_relative './hypertrace/version'
 require_relative './hypertrace/env_var_settings'
 require_relative './hypertrace/logging'
 require_relative './hypertrace/config'
+require_relative './hypertrace/otlp_http_exporter'
 require_relative './hypertrace/ruby_agent'
-
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hypertrace-agent
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - prodion23
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -257,6 +257,7 @@ files:
 - lib/hypertrace/instrumentation/rest_client_patch.rb
 - lib/hypertrace/instrumentation/sinatra.rb
 - lib/hypertrace/logging.rb
+- lib/hypertrace/otlp_http_exporter.rb
 - lib/hypertrace/ruby_agent.rb
 - lib/hypertrace/version.rb
 - release.sh