solarwinds_apm 6.0.0.prev6 → 6.0.1

data/lib/solarwinds_apm/opentelemetry/solarwinds_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 2023 SolarWinds Worldwide, LLC. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:http://www.apache.org/licenses/LICENSE-2.0
@@ -8,56 +10,46 @@ module SolarWindsAPM
   module OpenTelemetry
     # reference: OpenTelemetry::SDK::Trace::SpanProcessor
     class SolarWindsProcessor
-      HTTP_METHOD      = "http.method".freeze
-      HTTP_ROUTE       = "http.route".freeze
-      HTTP_STATUS_CODE = "http.status_code".freeze
-      HTTP_URL         = "http.url".freeze
+      HTTP_METHOD      = 'http.method'
+      HTTP_ROUTE       = 'http.route'
+      HTTP_STATUS_CODE = 'http.status_code'
+      HTTP_URL         = 'http.url'
       LIBOBOE_HTTP_SPAN_STATUS_UNAVAILABLE = 0
 
       attr_reader :txn_manager
 
-      def initialize(exporter, txn_manager)
-        @exporter = exporter
+      def initialize(txn_manager)
         @txn_manager = txn_manager
       end
 
       # Called when a {Span} is started, if the {Span#recording?}
       # returns true.
       #
-      # This method is called synchronously on the execution thread, should
-      # not throw or block the execution thread.
-      #
       # @param [Span] span the {Span} that just started.
       # @param [Context] parent_context the parent {Context} of the newly
       #  started span.
       def on_start(span, parent_context)
+        SolarWindsAPM.logger.debug do
+          "[#{self.class}/#{__method__}] processor on_start span: #{span.inspect}, parent_context: #{parent_context.inspect}"
+        end
 
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] processor on_start span: #{span.inspect}, parent_context: #{parent_context.inspect}"}
-
-        parent_span = ::OpenTelemetry::Trace.current_span(parent_context)
-        return if parent_span && parent_span.context != ::OpenTelemetry::Trace::SpanContext::INVALID && parent_span.context.remote? == false
+        return if non_entry_span(parent_context: parent_context)
 
         trace_flags = span.context.trace_flags.sampled? ? '01' : '00'
-        @txn_manager.set_root_context_h(span.context.hex_trace_id,"#{span.context.hex_span_id}-#{trace_flags}")
+        @txn_manager.set_root_context_h(span.context.hex_trace_id, "#{span.context.hex_span_id}-#{trace_flags}")
+        span.add_attributes({ 'sw.is_entry_span' => true })
       rescue StandardError => e
-        SolarWindsAPM.logger.info {"[#{self.class}/#{__method__}] processor on_start error: #{e.message}"}
+        SolarWindsAPM.logger.info { "[#{self.class}/#{__method__}] processor on_start error: #{e.message}" }
       end
 
       # Called when a {Span} is ended, if the {Span#recording?}
       # returns true.
       #
-      # This method is called synchronously on the execution thread, should
-      # not throw or block the execution thread.
-      # Only calculate inbound metrics for service root spans
-      #
       # @param [Span] span the {Span} that just ended.
       def on_finish(span)
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] processor on_finish span: #{span.inspect}"}
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] processor on_finish span: #{span.inspect}" }
 
-        if span.parent_span_id != ::OpenTelemetry::Trace::INVALID_SPAN_ID 
-          @exporter&.export([span.to_span_data]) if span.context.trace_flags.sampled?
-          return
-        end
+        return if non_entry_span(span: span)
 
         span_time  = calculate_span_time(start_time: span.start_timestamp, end_time: span.end_timestamp)
         domain     = nil
@@ -68,7 +60,7 @@ module SolarWindsAPM
           request_method = span.attributes[HTTP_METHOD]
           url_tran       = span.attributes[HTTP_URL]
 
-          SolarWindsAPM.logger.debug do 
+          SolarWindsAPM.logger.debug do
             "[#{self.class}/#{__method__}] createHttpSpan with\n
                                           trans_name: #{trans_name}\n
                                           url_tran: #{url_tran}\n
@@ -79,11 +71,12 @@ module SolarWindsAPM
                                           has_error: #{has_error}"
           end
 
-          liboboe_txn_name = SolarWindsAPM::Span.createHttpSpan(trans_name,url_tran,domain,span_time,status_code,request_method,has_error)
-  
+          liboboe_txn_name = SolarWindsAPM::Span.createHttpSpan(trans_name, url_tran, domain, span_time, status_code,
+                                                                request_method, has_error)
+
         else
-          
-          SolarWindsAPM.logger.debug do 
+
+          SolarWindsAPM.logger.debug do
             "[#{self.class}/#{__method__}] createSpan with \n
                                           trans_name: #{trans_name}\n
                                           domain: #{domain}\n
@@ -94,37 +87,30 @@ module SolarWindsAPM
           liboboe_txn_name = SolarWindsAPM::Span.createSpan(trans_name, domain, span_time, has_error)
         end
 
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] liboboe_txn_name: #{liboboe_txn_name}"}
-        @txn_manager["#{span.context.hex_trace_id}-#{span.context.hex_span_id}"] = liboboe_txn_name if span.context.trace_flags.sampled?
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] liboboe_txn_name: #{liboboe_txn_name}" }
+        if span.context.trace_flags.sampled?
+          @txn_manager["#{span.context.hex_trace_id}-#{span.context.hex_span_id}"] =
+            liboboe_txn_name
+        end
         @txn_manager.delete_root_context_h(span.context.hex_trace_id)
-        @exporter&.export([span.to_span_data]) if span.context.trace_flags.sampled?
       rescue StandardError => e
-        SolarWindsAPM.logger.info {"[#{self.class}/#{__method__}] can't flush span to exporter; processor on_finish error: #{e.message}"}
-        ::OpenTelemetry::SDK::Trace::Export::FAILURE
+        SolarWindsAPM.logger.info do
+          "[#{self.class}/#{__method__}] solarwinds_processor on_finish error: #{e.message}"
+        end
       end
 
-      # Export all ended spans to the configured `Exporter` that have not yet
-      # been exported.
-      #
-      # This method should only be called in cases where it is absolutely
-      # necessary, such as when using some FaaS providers that may suspend
-      # the process after an invocation, but before the `Processor` exports
-      # the completed spans.
-      #
       # @param [optional Numeric] timeout An optional timeout in seconds.
       # @return [Integer] Export::SUCCESS if no error occurred, Export::FAILURE if
       #   a non-specific failure occurred, Export::TIMEOUT if a timeout occurred.
-      def force_flush(timeout: nil)
-        @exporter&.force_flush(timeout: timeout) || ::OpenTelemetry::SDK::Trace::Export::SUCCESS
+      def force_flush(timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
+        ::OpenTelemetry::SDK::Trace::Export::SUCCESS
       end
 
-      # Called when {TracerProvider#shutdown} is called.
-      #
       # @param [optional Numeric] timeout An optional timeout in seconds.
       # @return [Integer] Export::SUCCESS if no error occurred, Export::FAILURE if
       #   a non-specific failure occurred, Export::TIMEOUT if a timeout occurred.
-      def shutdown(timeout: nil)
-        @exporter&.shutdown(timeout: timeout) || ::OpenTelemetry::SDK::Trace::Export::SUCCESS
+      def shutdown(timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
+        ::OpenTelemetry::SDK::Trace::Export::SUCCESS
       end
 
       private
@@ -147,16 +133,28 @@ module SolarWindsAPM
         span.attributes[HTTP_STATUS_CODE] || LIBOBOE_HTTP_SPAN_STATUS_UNAVAILABLE
       end
 
+      # check if it's entry span based on no parent or parent is remote
+      def non_entry_span(span: nil, parent_context: nil)
+        if parent_context
+          parent_span = ::OpenTelemetry::Trace.current_span(parent_context)
+          parent_span && parent_span.context != ::OpenTelemetry::Trace::SpanContext::INVALID && parent_span.context.remote? == false
+        elsif span
+          span.attributes['sw.is_entry_span'] != true
+        end
+      end
+
       # Get trans_name and url_tran of this span instance.
       # Predecessor order: custom SDK > env var SW_APM_TRANSACTION_NAME > automatic naming
       def calculate_transaction_names(span)
         trace_span_id = "#{span.context.hex_trace_id}-#{span.context.hex_span_id}"
         trans_name = @txn_manager.get(trace_span_id)
         if trans_name
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] found trans name from txn_manager: #{trans_name} by #{trace_span_id}"}
+          SolarWindsAPM.logger.debug do
+            "[#{self.class}/#{__method__}] found trans name from txn_manager: #{trans_name} by #{trace_span_id}"
+          end
           @txn_manager.del(trace_span_id)
-        elsif ENV.has_key?('SW_APM_TRANSACTION_NAME') && ENV['SW_APM_TRANSACTION_NAME'] != ''
-          trans_name =  ENV['SW_APM_TRANSACTION_NAME']
+        elsif ENV.key?('SW_APM_TRANSACTION_NAME') && ENV['SW_APM_TRANSACTION_NAME'] != ''
+          trans_name = ENV.fetch('SW_APM_TRANSACTION_NAME', nil)
         else
           trans_name = span.attributes[HTTP_ROUTE] || nil
           trans_name = span.name if span.name && (trans_name.nil? || trans_name.empty?)
@@ -173,4 +171,4 @@ module SolarWindsAPM
       end
     end
   end
-end
+end

data/lib/solarwinds_apm/opentelemetry/solarwinds_propagator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 2023 SolarWinds Worldwide, LLC. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:http://www.apache.org/licenses/LICENSE-2.0
@@ -10,14 +12,14 @@ module SolarWindsAPM
       # TextMapPropagator
       # propagator error will be rescued by OpenTelemetry::Context::Propagation::TextMapPropagator
       class TextMapPropagator
-        TRACESTATE_HEADER_NAME    = "tracestate".freeze
-        XTRACEOPTIONS_HEADER_NAME = "x-trace-options".freeze
-        XTRACEOPTIONS_SIGNATURE_HEADER_NAME = "x-trace-options-signature".freeze
-        INTL_SWO_X_OPTIONS_KEY    = "sw_xtraceoptions".freeze
-        INTL_SWO_SIGNATURE_KEY    = "sw_signature".freeze
+        TRACESTATE_HEADER_NAME    = 'tracestate'
+        XTRACEOPTIONS_HEADER_NAME = 'x-trace-options'
+        XTRACEOPTIONS_SIGNATURE_HEADER_NAME = 'x-trace-options-signature'
+        INTL_SWO_X_OPTIONS_KEY    = 'sw_xtraceoptions'
+        INTL_SWO_SIGNATURE_KEY    = 'sw_signature'
 
         private_constant \
-          :TRACESTATE_HEADER_NAME, :XTRACEOPTIONS_HEADER_NAME, 
+          :TRACESTATE_HEADER_NAME, :XTRACEOPTIONS_HEADER_NAME,
           :XTRACEOPTIONS_SIGNATURE_HEADER_NAME, :INTL_SWO_X_OPTIONS_KEY, :INTL_SWO_SIGNATURE_KEY
 
         # Extract trace context from the supplied carrier.
@@ -31,11 +33,11 @@ module SolarWindsAPM
         #
         # @return [Context] context updated with extracted baggage, or the original context
         #   if extraction fails
-        def extract(carrier, context: ::OpenTelemetry::Context.current, getter: ::OpenTelemetry::Context::Propagation.text_map_getter)
-
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] extract context: #{context.inspect}"}
+        def extract(carrier, context: ::OpenTelemetry::Context.current,
+                    getter: ::OpenTelemetry::Context::Propagation.text_map_getter)
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] extract context: #{context.inspect}" }
 
-          context = context.nil?? ::OpenTelemetry::Context.new({}) : context
+          context = ::OpenTelemetry::Context.new({}) if context.nil?
           context = inject_extracted_header(carrier, context, getter, XTRACEOPTIONS_HEADER_NAME, INTL_SWO_X_OPTIONS_KEY)
           inject_extracted_header(carrier, context, getter, XTRACEOPTIONS_SIGNATURE_HEADER_NAME, INTL_SWO_SIGNATURE_KEY)
         end
@@ -47,31 +49,37 @@ module SolarWindsAPM
         # @param [optional Setter] setter If the optional setter is provided, it
         #   will be used to write context into the carrier, otherwise the default
         #   text map setter will be used.
-        def inject(carrier, context: ::OpenTelemetry::Context.current, setter: ::OpenTelemetry::Context::Propagation.text_map_setter)
+        def inject(carrier, context: ::OpenTelemetry::Context.current,
+                   setter: ::OpenTelemetry::Context::Propagation.text_map_setter)
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] inject context: #{context.inspect}" }
 
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] inject context: #{context.inspect}"}
-        
           span_context = ::OpenTelemetry::Trace.current_span(context)&.context
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] span_context #{span_context.inspect}"}
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] span_context #{span_context.inspect}" }
           return unless span_context&.valid?
 
-          trace_flag = span_context.trace_flags.sampled?? 1 : 0
+          trace_flag = span_context.trace_flags.sampled? ? 1 : 0
           sw_value   = "#{span_context.hex_span_id}-0#{trace_flag}"
-          trace_state_header = carrier[TRACESTATE_HEADER_NAME].nil?? nil : carrier[TRACESTATE_HEADER_NAME]
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] sw_value: #{sw_value}; trace_state_header: #{trace_state_header}"}
+          trace_state_header = carrier[TRACESTATE_HEADER_NAME].nil? ? nil : carrier[TRACESTATE_HEADER_NAME]
+          SolarWindsAPM.logger.debug do
+            "[#{self.class}/#{__method__}] sw_value: #{sw_value}; trace_state_header: #{trace_state_header}"
+          end
 
           # prepare carrier with carrier's or new tracestate
           if trace_state_header.nil?
             # only create new trace state if valid span_id
             unless span_context.span_id == ::OpenTelemetry::Trace::INVALID_SPAN_ID
-              trace_state = ::OpenTelemetry::Trace::Tracestate.create({SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY => sw_value})
-              SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] creating new trace state: #{trace_state.inspect}"}
+              trace_state = ::OpenTelemetry::Trace::Tracestate.create({ SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY => sw_value })
+              SolarWindsAPM.logger.debug do
+                "[#{self.class}/#{__method__}] creating new trace state: #{trace_state.inspect}"
+              end
               setter.set(carrier, TRACESTATE_HEADER_NAME, Utils.trace_state_header(trace_state))
             end
           else
             trace_state_from_string = ::OpenTelemetry::Trace::Tracestate.from_string(trace_state_header)
             trace_state = trace_state_from_string.set_value(SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY, sw_value)
-            SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] updating/adding trace state for injection #{trace_state.inspect}"}
+            SolarWindsAPM.logger.debug do
+              "[#{self.class}/#{__method__}] updating/adding trace state for injection #{trace_state.inspect}"
+            end
             setter.set(carrier, TRACESTATE_HEADER_NAME, Utils.trace_state_header(trace_state))
           end
         end
@@ -85,11 +93,11 @@ module SolarWindsAPM
         end
 
         private
-        
+
         def inject_extracted_header(carrier, context, getter, header, inject_key)
           extracted_header = getter.get(carrier, header)
           context = context.set_value(inject_key, extracted_header) if extracted_header
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] #{header}: #{inject_key} = #{extracted_header}"}
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] #{header}: #{inject_key} = #{extracted_header}" }
           context
         end
       end

data/lib/solarwinds_apm/opentelemetry/solarwinds_response_propagator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 2023 SolarWinds Worldwide, LLC. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:http://www.apache.org/licenses/LICENSE-2.0
@@ -10,13 +12,13 @@ module SolarWindsAPM
       # ResponsePropagator
       # response propagator error will be rescued by OpenTelemetry::Instrumentation::Rack::Middlewares::EventHandler
       class TextMapPropagator
-        HTTP_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS = "Access-Control-Expose-Headers".freeze
-        XTRACE_HEADER_NAME                        = "x-trace".freeze
-        XTRACEOPTIONS_RESPONSE_HEADER_NAME        = "x-trace-options-response".freeze
-        INTL_SWO_EQUALS                           = "=".freeze
+        HTTP_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS = 'Access-Control-Expose-Headers'
+        XTRACE_HEADER_NAME                        = 'x-trace'
+        XTRACEOPTIONS_RESPONSE_HEADER_NAME        = 'x-trace-options-response'
+        INTL_SWO_EQUALS                           = '='
 
         private_constant \
-          :HTTP_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS, :XTRACE_HEADER_NAME, 
+          :HTTP_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS, :XTRACE_HEADER_NAME,
           :XTRACEOPTIONS_RESPONSE_HEADER_NAME
 
         def extract(carrier, context: ::OpenTelemetry::Context.current, getter: ::OpenTelemetry::Context::Propagation.text_map_getter) # rubocop:disable Lint/UnusedMethodArgument
@@ -30,22 +32,29 @@ module SolarWindsAPM
         # @param [optional Setter] setter If the optional setter is provided, it
         #   will be used to write context into the carrier, otherwise the default
         #   text map setter will be used.
-        def inject(carrier, context: ::OpenTelemetry::Context.current, setter: ::OpenTelemetry::Context::Propagation.text_map_setter)
-
+        def inject(carrier, context: ::OpenTelemetry::Context.current,
+                   setter: ::OpenTelemetry::Context::Propagation.text_map_setter)
           span_context = ::OpenTelemetry::Trace.current_span(context).context
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] context: #{context.inspect}; span_context: #{span_context.inspect}"}
+          SolarWindsAPM.logger.debug do
+            "[#{self.class}/#{__method__}] context: #{context.inspect}; span_context: #{span_context.inspect}"
+          end
           return unless span_context&.valid?
-          
+
           x_trace                = Utils.traceparent_from_context(span_context)
           exposed_headers        = [XTRACE_HEADER_NAME]
           xtraceoptions_response = recover_response_from_tracestate(span_context.tracestate)
 
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] x-trace: #{x_trace}; exposed headers: #{exposed_headers.inspect}; x-trace-options-response: #{xtraceoptions_response}"}
+          SolarWindsAPM.logger.debug do
+            "[#{self.class}/#{__method__}] x-trace: #{x_trace}; exposed headers: #{exposed_headers.inspect}; x-trace-options-response: #{xtraceoptions_response}"
+          end
           exposed_headers.append(XTRACEOPTIONS_RESPONSE_HEADER_NAME) unless xtraceoptions_response.empty?
 
           setter.set(carrier, XTRACE_HEADER_NAME, x_trace)
-          setter.set(carrier, XTRACEOPTIONS_RESPONSE_HEADER_NAME, xtraceoptions_response) unless xtraceoptions_response.empty?
-          setter.set(carrier, HTTP_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS, exposed_headers.join(","))
+          unless xtraceoptions_response.empty?
+            setter.set(carrier, XTRACEOPTIONS_RESPONSE_HEADER_NAME,
+                       xtraceoptions_response)
+          end
+          setter.set(carrier, HTTP_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS, exposed_headers.join(','))
         end
 
         # Returns the predefined propagation fields. If your carrier is reused, you
@@ -61,10 +70,14 @@ module SolarWindsAPM
         # sw_xtraceoptions_response_key -> xtrace_options_response
         def recover_response_from_tracestate(tracestate)
           sanitized = tracestate.value(XTraceOptions.sw_xtraceoptions_response_key)
-          sanitized = "" if sanitized.nil?
-          sanitized = sanitized.gsub(SolarWindsAPM::Constants::INTL_SWO_EQUALS_W3C_SANITIZED, SolarWindsAPM::Constants::INTL_SWO_EQUALS)
-          sanitized = sanitized.gsub(SolarWindsAPM::Constants::INTL_SWO_COMMA_W3C_SANITIZED, SolarWindsAPM::Constants::INTL_SWO_COMMA)
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] recover_response_from_tracestate sanitized: #{sanitized.inspect}"}
+          sanitized = '' if sanitized.nil?
+          sanitized = sanitized.gsub(SolarWindsAPM::Constants::INTL_SWO_EQUALS_W3C_SANITIZED,
+                                     SolarWindsAPM::Constants::INTL_SWO_EQUALS)
+          sanitized = sanitized.gsub(SolarWindsAPM::Constants::INTL_SWO_COMMA_W3C_SANITIZED,
+                                     SolarWindsAPM::Constants::INTL_SWO_COMMA)
+          SolarWindsAPM.logger.debug do
+            "[#{self.class}/#{__method__}] recover_response_from_tracestate sanitized: #{sanitized.inspect}"
+          end
           sanitized
         end
       end