solarwinds_apm 6.0.0 → 6.0.1

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

data/lib/solarwinds_apm/opentelemetry/solarwinds_sampler.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,27 +10,27 @@ module SolarWindsAPM
   module OpenTelemetry
     # SolarWindsSampler
     class SolarWindsSampler
-      INTERNAL_BUCKET_CAPACITY   = "BucketCapacity".freeze
-      INTERNAL_BUCKET_RATE       = "BucketRate".freeze
-      INTERNAL_SAMPLE_RATE       = "SampleRate".freeze
-      INTERNAL_SAMPLE_SOURCE     = "SampleSource".freeze
-      INTERNAL_SW_KEYS           = "SWKeys".freeze
+      INTERNAL_BUCKET_CAPACITY   = 'BucketCapacity'
+      INTERNAL_BUCKET_RATE       = 'BucketRate'
+      INTERNAL_SAMPLE_RATE       = 'SampleRate'
+      INTERNAL_SAMPLE_SOURCE     = 'SampleSource'
+      INTERNAL_SW_KEYS           = 'SWKeys'
       LIBOBOE_CONTINUED          = -1
-      SW_TRACESTATE_CAPTURE_KEY  = "sw.w3c.tracestate".freeze
-      SW_TRACESTATE_ROOT_KEY     = "sw.tracestate_parent_id".freeze
+      SW_TRACESTATE_CAPTURE_KEY  = 'sw.w3c.tracestate'
+      SW_TRACESTATE_ROOT_KEY     = 'sw.tracestate_parent_id'
       UNSET                      = -1
       SWO_TRACING_ENABLED        = 1
       SWO_TRACING_DISABLED       = 0
       SWO_TRACING_UNSET          = -1
-      XTRACEOPTIONS_RESP_AUTH    = "auth".freeze
-      XTRACEOPTIONS_RESP_IGNORED = "ignored".freeze
-      XTRACEOPTIONS_RESP_TRIGGER_IGNORED       = "ignored".freeze
-      XTRACEOPTIONS_RESP_TRIGGER_NOT_REQUESTED = "not-requested".freeze
-      XTRACEOPTIONS_RESP_TRIGGER_TRACE         = "trigger-trace".freeze
+      XTRACEOPTIONS_RESP_AUTH    = 'auth'
+      XTRACEOPTIONS_RESP_IGNORED = 'ignored'
+      XTRACEOPTIONS_RESP_TRIGGER_IGNORED       = 'ignored'
+      XTRACEOPTIONS_RESP_TRIGGER_NOT_REQUESTED = 'not-requested'
+      XTRACEOPTIONS_RESP_TRIGGER_TRACE         = 'trigger-trace'
 
       attr_reader :description
 
-      def initialize(config={})
+      def initialize(config = {})
         @config = config
       end
 
@@ -42,8 +44,7 @@ module SolarWindsAPM
       # trace_id
       # parent_context: OpenTelemetry::Context
       def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
-
-        SolarWindsAPM.logger.debug do 
+        SolarWindsAPM.logger.debug do
           "[#{self.class}/#{__method__}] should_sample? start parameters \n
                                         trace_id: #{trace_id.unpack1('H*')}\n
                                         parent_context:  #{parent_context}\n
@@ -54,24 +55,31 @@ module SolarWindsAPM
                                         attributes: #{attributes}"
         end
 
-        parent_span_context = ::OpenTelemetry::Trace.current_span(parent_context).context        
+        parent_span_context = ::OpenTelemetry::Trace.current_span(parent_context).context
         xtraceoptions       = ::SolarWindsAPM::XTraceOptions.new(parent_context)
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] parent_span_context: #{parent_span_context.inspect}\n xtraceoptions: #{xtraceoptions.inspect}"}
+        SolarWindsAPM.logger.debug do
+          "[#{self.class}/#{__method__}] parent_span_context: #{parent_span_context.inspect}\n xtraceoptions: #{xtraceoptions.inspect}"
+        end
 
         liboboe_decision    = calculate_liboboe_decision(parent_span_context, xtraceoptions, name, kind, attributes)
         otel_decision       = otel_decision_from_liboboe(liboboe_decision)
         new_trace_state     = calculate_trace_state(liboboe_decision, parent_span_context, xtraceoptions)
-        new_attributes      = otel_sampled?(otel_decision)? calculate_attributes(attributes, liboboe_decision, new_trace_state, parent_span_context, xtraceoptions) : nil
-        sampling_result     = ::OpenTelemetry::SDK::Trace::Samplers::Result.new(decision: otel_decision, 
-                                                                                attributes: new_attributes, 
+        new_attributes      = if otel_sampled?(otel_decision)
+                                calculate_attributes(attributes, liboboe_decision,
+                                                     new_trace_state, parent_span_context, xtraceoptions)
+                              end
+        sampling_result     = ::OpenTelemetry::SDK::Trace::Samplers::Result.new(decision: otel_decision,
+                                                                                attributes: new_attributes,
                                                                                 tracestate: new_trace_state)
-        
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] should_sample? end with sampling_result: #{sampling_result.inspect} from otel_decision: #{otel_decision.inspect} and new_attributes: #{new_attributes.inspect}"}
+
+        SolarWindsAPM.logger.debug do
+          "[#{self.class}/#{__method__}] should_sample? end with sampling_result: #{sampling_result.inspect} from otel_decision: #{otel_decision.inspect} and new_attributes: #{new_attributes.inspect}"
+        end
         sampling_result
       rescue StandardError => e
-        SolarWindsAPM.logger.info {"[#{self.class}/#{__method__}] sampler error: #{e.message}"}
-        ::OpenTelemetry::SDK::Trace::Samplers::Result.new(decision: ::OpenTelemetry::SDK::Trace::Samplers::Decision::DROP, 
-                                                          attributes: attributes, 
+        SolarWindsAPM.logger.info { "[#{self.class}/#{__method__}] sampler error: #{e.message}" }
+        ::OpenTelemetry::SDK::Trace::Samplers::Result.new(decision: ::OpenTelemetry::SDK::Trace::Samplers::Decision::DROP,
+                                                          attributes: attributes,
                                                           tracestate: ::OpenTelemetry::Trace::Tracestate::DEFAULT)
       end
 
@@ -87,29 +95,31 @@ module SolarWindsAPM
       # return decision Hash
       def calculate_liboboe_decision(parent_span_context, xtraceoptions, name, kind, attributes)
         tracestring = Utils.traceparent_from_context(parent_span_context) if parent_span_context.valid? && parent_span_context.remote?
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] tracestring: #{tracestring}"}
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] tracestring: #{tracestring}" }
 
         # otel-ruby contrib use different key to store url info, currently it's using http.target for path
-        url_path = attributes.nil?? '' : attributes['http.target']
+        url_path = attributes.nil? ? '' : attributes['http.target']
         transaction_naming_key = "#{url_path}-#{name}-#{kind}"
         tracing_mode           = SolarWindsAPM::TransactionCache.get(transaction_naming_key)
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] transaction cache: #{transaction_naming_key}; tracing_mode: #{tracing_mode}."}
+        SolarWindsAPM.logger.debug do
+          "[#{self.class}/#{__method__}] transaction cache: #{transaction_naming_key}; tracing_mode: #{tracing_mode}."
+        end
 
         unless tracing_mode
-          trans_settings = SolarWindsAPM::TransactionSettings.new(url_path: url_path, name: name, kind: kind)          
+          trans_settings = SolarWindsAPM::TransactionSettings.new(url_path: url_path, name: name, kind: kind)
           tracing_mode   = trans_settings.calculate_trace_mode == 1 ? SWO_TRACING_ENABLED : SWO_TRACING_DISABLED
           SolarWindsAPM::TransactionCache.set(transaction_naming_key, tracing_mode)
         end
 
         sw_member_value    = parent_span_context.tracestate[SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY]
-        trigger_trace_mode = SolarWindsAPM::OboeTracingMode.get_oboe_trigger_trace_mode(@config["trigger_trace"])
+        trigger_trace_mode = SolarWindsAPM::OboeTracingMode.get_oboe_trigger_trace_mode(@config['trigger_trace'])
         sample_rate        = UNSET
         options            = xtraceoptions&.options
         trigger_trace      = xtraceoptions&.intify_trigger_trace || 0
         signature          = xtraceoptions&.signature
         timestamp          = xtraceoptions&.timestamp
 
-        SolarWindsAPM.logger.debug do 
+        SolarWindsAPM.logger.debug do
           "[#{self.class}/#{__method__}] get liboboe decision parameters: \n
                                          tracestring: #{tracestring}\n
                                          sw_member_value: #{sw_member_value}\n
@@ -123,85 +133,96 @@ module SolarWindsAPM
         end
 
         args = [tracestring, sw_member_value, tracing_mode, sample_rate,
-                trigger_trace, trigger_trace_mode, options, signature,timestamp]
-
-        do_metrics, do_sample, rate, source, bucket_rate,
-          bucket_cap, decision_type, auth, status_msg, auth_msg,
-            status = SolarWindsAPM::Context.getDecisions(*args)
-
-        decision = {}
-        decision["do_metrics"]    = do_metrics > 0
-        decision["do_sample"]     = do_sample > 0 
-        decision["rate"]          = rate
-        decision["source"]        = source
-        decision["bucket_rate"]   = bucket_rate
-        decision["bucket_cap"]    = bucket_cap
-        decision["decision_type"] = decision_type
-        decision["auth"]          = auth
-        decision["status_msg"]    = status_msg
-        decision["auth_msg"]      = auth_msg
-        decision["status"]        = status
-        decision
+                trigger_trace, trigger_trace_mode, options, signature, timestamp]
+
+        if SolarWindsAPM::OboeInitOptions.instance.lambda_env
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] get decision from oboe_api" }
+          # trigger trace disabled at this point (https://swicloud.atlassian.net/wiki/spaces/NIT/pages/3753116438/AWS+Lambda+Instrumentation+POC#Concerns)
+          do_metrics, do_sample, rate, source, bucket_rate,
+            bucket_cap, decision_type, auth, status_msg, auth_msg,
+              status = SolarWindsAPM.oboe_api.getTracingDecision(*args)
+        else
+          do_metrics, do_sample, rate, source, bucket_rate,
+            bucket_cap, decision_type, auth, status_msg, auth_msg,
+              status = SolarWindsAPM::Context.getDecisions(*args)
+        end
+
+        {
+          'do_metrics' => do_metrics.positive?,
+          'do_sample' => do_sample.positive?,
+          'rate' => rate,
+          'source' => source,
+          'bucket_rate' => bucket_rate,
+          'bucket_cap' => bucket_cap,
+          'decision_type' => decision_type,
+          'auth' => auth,
+          'status_msg' => status_msg,
+          'auth_msg' => auth_msg,
+          'status' => status
+        }
       end
 
       def otel_decision_from_liboboe(liboboe_decision)
-
         decision = ::OpenTelemetry::SDK::Trace::Samplers::Decision::DROP
-        if liboboe_decision["do_sample"]
-          decision = ::OpenTelemetry::SDK::Trace::Samplers::Decision::RECORD_AND_SAMPLE  # even if not do_metrics
-        elsif liboboe_decision["do_metrics"]
+        if liboboe_decision['do_sample']
+          decision = ::OpenTelemetry::SDK::Trace::Samplers::Decision::RECORD_AND_SAMPLE # even if not do_metrics
+        elsif liboboe_decision['do_metrics']
           decision = ::OpenTelemetry::SDK::Trace::Samplers::Decision::RECORD_ONLY
         end
-        SolarWindsAPM.logger.debug {"otel decision: #{decision} created from liboboe_decision: #{liboboe_decision}"}
+        SolarWindsAPM.logger.debug { "otel decision: #{decision} created from liboboe_decision: #{liboboe_decision}" }
         decision
       end
 
       ##
-      # add sw=value and xtrace_options_response=value into the old/new tracestate 
+      # add sw=value and xtrace_options_response=value into the old/new tracestate
       # the returned value tracestate will be used in propagating to next services
       def calculate_trace_state(liboboe_decision, parent_span_context, xtraceoptions)
-        if !parent_span_context.valid?
-          trace_state = create_new_trace_state(parent_span_context, liboboe_decision)
-        elsif parent_span_context.tracestate.nil?
+        if !parent_span_context.valid? || parent_span_context.tracestate.nil?
           trace_state = create_new_trace_state(parent_span_context, liboboe_decision)
         else
-          trace_state = parent_span_context.tracestate.set_value(SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY, 
-                                                                 sw_from_span_and_decision(parent_span_context, liboboe_decision))
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] updated trace_state:  #{trace_state.inspect}"}
+          trace_state = parent_span_context.tracestate.set_value(SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY,
+                                                                 sw_from_span_and_decision(parent_span_context,
+                                                                                           liboboe_decision))
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] updated trace_state:  #{trace_state.inspect}" }
         end
 
         # for setting up the xtrace_options_response
         if xtraceoptions&.options
-          trace_state = trace_state.set_value(XTraceOptions.sw_xtraceoptions_response_key.to_s, 
-                                              create_xtraceoptions_response_value(liboboe_decision, parent_span_context, xtraceoptions)) 
+          trace_state = trace_state.set_value(XTraceOptions.sw_xtraceoptions_response_key.to_s,
+                                              create_xtraceoptions_response_value(liboboe_decision,
+                                                                                  parent_span_context, xtraceoptions))
         end
         trace_state
       end
 
       ##
-      # 
+      #
       def create_new_trace_state(parent_span_context, liboboe_decision)
         decision = sw_from_span_and_decision(parent_span_context, liboboe_decision)
-        trace_state = ::OpenTelemetry::Trace::Tracestate.from_hash({SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY => decision}) # e.g. sw=3e222c863a04123a-01
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] created new trace_state: #{trace_state.inspect}"}
+        trace_state = ::OpenTelemetry::Trace::Tracestate.from_hash({ SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY => decision }) # e.g. sw=3e222c863a04123a-01
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] created new trace_state: #{trace_state.inspect}" }
         trace_state
       end
 
       ##
       #
       def create_xtraceoptions_response_value(liboboe_decision, parent_span_context, xtraceoptions)
-
         response = []
         w3c_sanitized = SolarWindsAPM::Constants::INTL_SWO_EQUALS_W3C_SANITIZED
         w3c_sanitized_comma = SolarWindsAPM::Constants::INTL_SWO_COMMA_W3C_SANITIZED
-        response << [XTRACEOPTIONS_RESP_AUTH, liboboe_decision['auth_msg']].join(w3c_sanitized) if xtraceoptions.signature && liboboe_decision['auth_msg']
-        
-        if !liboboe_decision["auth"] || liboboe_decision["auth"] < 1
+        if xtraceoptions.signature && liboboe_decision['auth_msg']
+          response << [XTRACEOPTIONS_RESP_AUTH,
+                       liboboe_decision['auth_msg']].join(w3c_sanitized)
+        end
+
+        if !liboboe_decision['auth'] || liboboe_decision['auth'] < 1
           if xtraceoptions.trigger_trace
             # If a traceparent header was provided then oboe does not generate the message
-            tracestring = Utils.traceparent_from_context(parent_span_context) if parent_span_context.valid? && parent_span_context.remote?  
-            trigger_msg = tracestring && liboboe_decision['decision_type'] == 0 ? XTRACEOPTIONS_RESP_TRIGGER_IGNORED : liboboe_decision['status_msg']
-            SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] tracestring: #{tracestring}; trigger_msg: #{trigger_msg}"}
+            tracestring = Utils.traceparent_from_context(parent_span_context) if parent_span_context.valid? && parent_span_context.remote?
+            trigger_msg = tracestring && (liboboe_decision['decision_type']).zero? ? XTRACEOPTIONS_RESP_TRIGGER_IGNORED : liboboe_decision['status_msg']
+            SolarWindsAPM.logger.debug do
+              "[#{self.class}/#{__method__}] tracestring: #{tracestring}; trigger_msg: #{trigger_msg}"
+            end
           else
             trigger_msg = XTRACEOPTIONS_RESP_TRIGGER_NOT_REQUESTED
           end
@@ -210,80 +231,96 @@ module SolarWindsAPM
         end
 
         # appending ignored value from xtraceoptions to response. e.g. response << ignored####invalidkeys,invalidkeys,invalidkeys
-        response << [XTRACEOPTIONS_RESP_IGNORED, xtraceoptions.ignored.join(w3c_sanitized_comma)].join(w3c_sanitized) unless xtraceoptions.ignored.empty?
+        unless xtraceoptions.ignored.empty?
+          response << [XTRACEOPTIONS_RESP_IGNORED,
+                       xtraceoptions.ignored.join(w3c_sanitized_comma)].join(w3c_sanitized)
+        end
         joined_response = response.join(';')
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] final response_value: #{joined_response}"}
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] final response_value: #{joined_response}" }
         joined_response
       end
 
       ##
-      # calculate_attributes is used for getting the otel Result class in last step of sampler should_sample? 
+      # calculate_attributes is used for getting the otel Result class in last step of sampler should_sample?
       # e.g. result = Result.new(decision: otel_decision, attributes: new_attributes, tracestate: new_trace_state)
       # calculate_attributes use new_trace_state that is derived from current span information and old tracestate from parent_span_context.tracestate
       # the sw.w3c.tracestate should perserve the old tracestate value for debugging purpose
       def calculate_attributes(attributes, liboboe_decision, trace_state, parent_span_context, xtraceoptions)
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] new_trace_state: #{trace_state.inspect}"}
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] new_trace_state: #{trace_state.inspect}" }
         new_attributes = attributes.dup || {}
 
         # Always (root or is_remote) set _INTERNAL_SW_KEYS if injected
         new_attributes[INTERNAL_SW_KEYS] = xtraceoptions.sw_keys if xtraceoptions.sw_keys
 
         # Always (root or is_remote) set custom KVs if extracted from x-trace-options
-        xtraceoptions.custom_kvs&.each {|k,v| new_attributes[k] = v}
+        xtraceoptions.custom_kvs&.each { |k, v| new_attributes[k] = v }
 
-        # Always (root or is_remote) set service entry internal KVs       
-        new_attributes[INTERNAL_BUCKET_CAPACITY] = liboboe_decision["bucket_cap"].to_s
-        new_attributes[INTERNAL_BUCKET_RATE]     = liboboe_decision["bucket_rate"].to_s
-        new_attributes[INTERNAL_SAMPLE_RATE]     = liboboe_decision["rate"]
-        new_attributes[INTERNAL_SAMPLE_SOURCE]   = liboboe_decision["source"]
+        # Always (root or is_remote) set service entry internal KVs
+        new_attributes[INTERNAL_BUCKET_CAPACITY] = liboboe_decision['bucket_cap'].to_s
+        new_attributes[INTERNAL_BUCKET_RATE]     = liboboe_decision['bucket_rate'].to_s
+        new_attributes[INTERNAL_SAMPLE_RATE]     = liboboe_decision['rate']
+        new_attributes[INTERNAL_SAMPLE_SOURCE]   = liboboe_decision['source']
 
         # set sw.tracestate_parent_id if its tracestate contains "sw"
         sw_value = parent_span_context.tracestate.value(SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY)
-        new_attributes[SW_TRACESTATE_ROOT_KEY] =  sw_value.split("-")[0] if sw_value && parent_span_context.remote?
+        new_attributes[SW_TRACESTATE_ROOT_KEY] = sw_value.split('-')[0] if sw_value && parent_span_context.remote?
 
         # If unsigned or signed TT (root or is_remote), set TriggeredTrace
         new_attributes[SolarWindsAPM::Constants::INTERNAL_TRIGGERED_TRACE] = true if xtraceoptions.trigger_trace
 
         # Trace's root span has no valid traceparent nor tracestate so we can't calculate remaining attributes
         if !parent_span_context.valid? || trace_state.nil?
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] No valid traceparent or no tracestate - returning attributes: #{new_attributes}"}
+          SolarWindsAPM.logger.debug do
+            "[#{self.class}/#{__method__}] No valid traceparent or no tracestate - returning attributes: #{new_attributes}"
+          end
           return new_attributes.freeze || nil
         end
 
-        new_attributes = add_tracestate_capture_to_new_attributes(new_attributes, liboboe_decision, trace_state, parent_span_context)
+        new_attributes = add_tracestate_capture_to_new_attributes(new_attributes, liboboe_decision, trace_state,
+                                                                  parent_span_context)
         new_attributes.freeze
       end
 
       ##
-      # 
+      #
       def add_tracestate_capture_to_new_attributes(new_attributes, liboboe_decision, trace_state, parent_span_context)
-        
         tracestate_capture = new_attributes[SW_TRACESTATE_CAPTURE_KEY]
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] tracestate_capture #{tracestate_capture.inspect}; new_attributes #{new_attributes.inspect}"}
+        SolarWindsAPM.logger.debug do
+          "[#{self.class}/#{__method__}] tracestate_capture #{tracestate_capture.inspect}; new_attributes #{new_attributes.inspect}"
+        end
 
         if tracestate_capture.nil?
           trace_state_no_response = trace_state.delete(XTraceOptions.sw_xtraceoptions_response_key)
-        else 
+        else
           # retain all potential tracestate pairs for attributes and generate new sw=key for tracestate based on root parent_span_id
           attr_trace_state        = ::OpenTelemetry::Trace::Tracestate.from_string(tracestate_capture)
-          new_attr_trace_state    = attr_trace_state.set_value(SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY, sw_from_span_and_decision(parent_span_context,liboboe_decision))
+          new_attr_trace_state    = attr_trace_state.set_value(SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY,
+                                                               sw_from_span_and_decision(parent_span_context,
+                                                                                         liboboe_decision))
           trace_state_no_response = new_attr_trace_state.delete(XTraceOptions.sw_xtraceoptions_response_key)
         end
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] trace_state_no_response #{trace_state_no_response.inspect}"}
+        SolarWindsAPM.logger.debug do
+          "[#{self.class}/#{__method__}] trace_state_no_response #{trace_state_no_response.inspect}"
+        end
 
         trace_state_no_response = parent_span_context.tracestate.delete(XTraceOptions.sw_xtraceoptions_response_key)
         no_sw_count             = trace_state_no_response.to_h.count { |k, _v| k != 'sw' }
 
-        new_attributes[SW_TRACESTATE_CAPTURE_KEY] = Utils.trace_state_header(trace_state_no_response) if no_sw_count > 0 
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] new_attributes after add_tracestate_capture_to_new_attributes: #{new_attributes.inspect}"}
-        
+        if no_sw_count.positive?
+          new_attributes[SW_TRACESTATE_CAPTURE_KEY] =
+            Utils.trace_state_header(trace_state_no_response)
+        end
+        SolarWindsAPM.logger.debug do
+          "[#{self.class}/#{__method__}] new_attributes after add_tracestate_capture_to_new_attributes: #{new_attributes.inspect}"
+        end
+
         new_attributes
       end
 
       # formats tracestate sw value from span_id and liboboe decision as 16-byte span_id with 8-bit trace_flags e.g. 1a2b3c4d5e6f7g8h-01
       def sw_from_span_and_decision(parent_span_context, liboboe_decision)
-        trace_flag = (liboboe_decision["do_sample"] == true) ? "01" : "00"
-        [parent_span_context.hex_span_id, trace_flag].join("-")
+        trace_flag = liboboe_decision['do_sample'] == true ? '01' : '00'
+        [parent_span_context.hex_span_id, trace_flag].join('-')
       end
 
       def otel_sampled?(otel_decision)

data/lib/solarwinds_apm/opentelemetry.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
@@ -7,8 +9,9 @@
 require 'opentelemetry/sdk'
 require 'opentelemetry/instrumentation/all'
 
-require_relative './opentelemetry/solarwinds_propagator'
-require_relative './opentelemetry/solarwinds_processor'
-require_relative './opentelemetry/solarwinds_sampler'
-require_relative './opentelemetry/solarwinds_exporter'
-require_relative './opentelemetry/solarwinds_response_propagator'
+require_relative 'opentelemetry/solarwinds_propagator'
+require_relative 'opentelemetry/solarwinds_processor'
+require_relative 'opentelemetry/solarwinds_sampler'
+require_relative 'opentelemetry/solarwinds_exporter'
+require_relative 'opentelemetry/solarwinds_response_propagator'
+require_relative 'opentelemetry/otlp_processor'

data/lib/solarwinds_apm/otel_config.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
@@ -15,20 +17,21 @@ module SolarWindsAPM
 
     @@agent_enabled    = true
 
-    def self.disable_agent
-      return unless @@agent_enabled  # only show the msg once
+    def self.disable_agent(reason: nil)
+      return unless @@agent_enabled # only show the msg once
 
       @@agent_enabled = false
-      SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Agent disabled. No Trace exported."}
+      SolarWindsAPM.logger.warn { "[#{name}/#{__method__}] SolarWindsAPM disabled. No Trace exported. Reason: #{reason}" }
     end
 
     def self.resolve_sampler
-      sampler_config = {"trigger_trace" => SolarWindsAPM::Config[:trigger_tracing_mode]}
+      sampler_config = { 'trigger_trace' => SolarWindsAPM::Config[:trigger_tracing_mode] }
       @@config[:sampler] =
         ::OpenTelemetry::SDK::Trace::Samplers.parent_based(
           root: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new(sampler_config),
           remote_parent_sampled: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new(sampler_config),
-          remote_parent_not_sampled: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new(sampler_config))
+          remote_parent_not_sampled: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new(sampler_config)
+        )
     end
 
     #
@@ -36,18 +39,20 @@ module SolarWindsAPM
     #
     def self.resolve_response_propagator
       response_propagator  = SolarWindsAPM::OpenTelemetry::SolarWindsResponsePropagator::TextMapPropagator.new
-      rack_setting         = @@config_map["OpenTelemetry::Instrumentation::Rack"]
-      
+      rack_setting         = @@config_map['OpenTelemetry::Instrumentation::Rack']
+
       if rack_setting
         if rack_setting[:response_propagators].instance_of?(Array)
           rack_setting[:response_propagators].append(response_propagator)
         elsif rack_setting[:response_propagators].nil?
           rack_setting[:response_propagators] = [response_propagator]
         else
-          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Rack response propagator resolve failed. Provided type #{rack_setting[:response_propagators].class}, please provide Array e.g. [#{rack_setting[:response_propagators]}]"}
+          SolarWindsAPM.logger.warn do
+            "[#{name}/#{__method__}] Rack response propagator resolve failed. Provided type #{rack_setting[:response_propagators].class}, please provide Array e.g. [#{rack_setting[:response_propagators]}]"
+          end
         end
       else
-        @@config_map["OpenTelemetry::Instrumentation::Rack"] = {response_propagators: [response_propagator]}
+        @@config_map['OpenTelemetry::Instrumentation::Rack'] = { response_propagators: [response_propagator] }
       end
     end
 
@@ -56,19 +61,20 @@ module SolarWindsAPM
     end
 
     def self.print_config
-      @@config.each do |k,v|
-        SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Config Key/Value: #{k}, #{v.class}"}
+      @@config.each do |k, v|
+        SolarWindsAPM.logger.debug { "[#{name}/#{__method__}] Config Key/Value: #{k}, #{v.class}" }
       end
-      @@config_map.each do |k,v|
-        SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Config Key/Value: #{k}, #{v}"}
+      @@config_map.each do |k, v|
+        SolarWindsAPM.logger.debug { "[#{name}/#{__method__}] Config Key/Value: #{k}, #{v}" }
       end
       nil
     end
 
     def self.resolve_solarwinds_processor
       txn_manager = SolarWindsAPM::TxnNameManager.new
-      exporter    = SolarWindsAPM::OpenTelemetry::SolarWindsExporter.new(txn_manager: txn_manager)
-      @@config[:span_processor] = SolarWindsAPM::OpenTelemetry::SolarWindsProcessor.new(exporter, txn_manager)
+      exporter = SolarWindsAPM::OpenTelemetry::SolarWindsExporter.new(txn_manager: txn_manager)
+      @@config[:metrics_processor] = SolarWindsAPM::OpenTelemetry::SolarWindsProcessor.new(txn_manager)
+      @@config[:span_processor] = ::OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(exporter)
     end
 
     def self.resolve_solarwinds_propagator
@@ -77,21 +83,17 @@ module SolarWindsAPM
 
     def self.validate_propagator(propagators)
       if propagators.nil?
-        disable_agent
+        disable_agent(reason: 'propagators are invaliad.')
         return
       end
 
-      SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] propagators: #{propagators.map(&:class)}"}
-      unless ([::OpenTelemetry::Trace::Propagation::TraceContext::TextMapPropagator, ::OpenTelemetry::Baggage::Propagation::TextMapPropagator] - propagators.map(&:class)).empty? # rubocop:disable Style/GuardClause
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Missing tracecontext propagator."}
-        disable_agent
-      end
+      SolarWindsAPM.logger.debug { "[#{name}/#{__method__}] propagators: #{propagators.map(&:class)}" }
+      disable_agent(reason: 'Missing tracecontext propagator.') unless ([::OpenTelemetry::Trace::Propagation::TraceContext::TextMapPropagator, ::OpenTelemetry::Baggage::Propagation::TextMapPropagator] - propagators.map(&:class)).empty?
     end
 
     def self.initialize
       unless defined?(::OpenTelemetry::SDK::Configurator)
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] missing OpenTelemetry::SDK::Configurator; opentelemetry seems not loaded."}
-        disable_agent
+        disable_agent(reason: 'missing OpenTelemetry::SDK::Configurator; opentelemetry seems not loaded.')
         return
       end
 
@@ -119,6 +121,7 @@ module SolarWindsAPM
       ::OpenTelemetry.propagation.instance_variable_get(:@propagators).append(@@config[:propagators])
 
       # append our processors (with our exporter)
+      ::OpenTelemetry.tracer_provider.add_span_processor(@@config[:metrics_processor])
       ::OpenTelemetry.tracer_provider.add_span_processor(@@config[:span_processor])
 
       # configure sampler afterwards
@@ -140,14 +143,18 @@ module SolarWindsAPM
     #
     def self.initialize_with_config
       unless block_given?
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Block not given while doing in-code configuration. Agent disabled."}
+        SolarWindsAPM.logger.warn do
+          "[#{name}/#{__method__}] Block not given while doing in-code configuration. Agent disabled."
+        end
         return
       end
 
       yield @@config_map
 
       if @@config_map.empty?
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] No configuration given for in-code configuration. Agent disabled."}
+        SolarWindsAPM.logger.warn do
+          "[#{name}/#{__method__}] No configuration given for in-code configuration. Agent disabled."
+        end
         return
       end