Merge pull request #182 from solarwinds/NH-105128

NH-105128: init add endpoint logic

Author: xuan-cao-swi

gemfiles/test_gems.gemfile

@@ -32,6 +32,7 @@ group :development, :test do
   gem 'simplecov', require: false, group: :test
   gem 'simplecov-console'
   gem 'webmock' if RUBY_VERSION >= '2.0.0'
+  gem 'grpc', '~> 1.71'
 
   gem 'opentelemetry-sdk'
   gem 'opentelemetry-instrumentation-all'

lib/oboe_metal.rb

@@ -39,7 +39,7 @@ def start
         options = SolarWindsAPM::OboeInitOptions.instance.array_for_oboe # creates an array with the options in the right order
         SolarWindsAPM.reporter = Oboe_metal::Reporter.new(*options)
         SolarWindsAPM.loaded = true
-        report_init if (options[22]).zero? # report init at beginning if no after fork enabled
+        report_init if options[22].zero? # report init at beginning if no after fork enabled
       rescue StandardError => e
         warn e.message
         SolarWindsAPM.loaded = false

lib/solarwinds_apm/oboe_init_options.rb

@@ -126,9 +126,12 @@ def reporter_and_host
 
     def read_and_validate_service_key
       service_key_checker = SolarWindsAPM::ServiceKeyChecker.new(@reporter, @lambda_env)
-      service_key = service_key_checker.read_and_validate_service_key
-      @service_name = service_key.split(':', 2).last # instance variable used in testing
-      service_key
+      if service_key_checker.token.nil?
+        ''
+      else
+        @service_name = service_key_checker.service_name # instance variable used in testing
+        "#{service_key_checker.token}:#{service_key_checker.service_name}"
+      end
     end
 
     def read_and_validate_ec2_md_timeout

lib/solarwinds_apm/opentelemetry/solarwinds_sampler.rb

@@ -221,7 +221,7 @@ def create_xtraceoptions_response_value(liboboe_decision, parent_span_context, x
           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']).zero? ? XTRACEOPTIONS_RESP_TRIGGER_IGNORED : liboboe_decision['status_msg']
+            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

lib/solarwinds_apm/support/otlp_endpoint.rb

@@ -0,0 +1,89 @@
+# 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
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+module SolarWindsAPM
+  # OTLPEndPoint
+  class OTLPEndPoint
+    SWO_APM_ENDPOINT_REGEX = /^apm\.collector\.([a-z]{2}-\d{2})\.([^.]+)\.solarwinds\.com(?::\d+)?$/
+    SWO_APM_ENDPOINT_DEFAULT = 'apm.collector.na-01.cloud.solarwinds.com:443'
+
+    SWO_OTLP_GENERAL_ENDPOINT_REGEX = %r{^https://otel\.collector\.[a-z0-9-]+\.[a-z0-9-]+\.solarwinds\.com(?::\d+)?$}
+    SWO_OTLP_SIGNAL_ENDPOINT_REGEX = %r{^https://otel\.collector\.[a-z0-9-]+\.[a-z0-9-]+\.solarwinds\.com(?::\d+)?/v1/(?:logs|metrics|traces)$}
+    SWO_OTLP_ENDPOINT_DEFAULT = 'https://otel.collector.na-01.cloud.solarwinds.com:443'
+
+    OTEL_SIGNAL_TYPE = %w[TRACES METRICS LOGS].freeze
+
+    def initialize
+      @token = nil
+    end
+
+    def config_otlp_token_and_endpoint
+      matches = ENV['SW_APM_COLLECTOR'].to_s.match(SWO_APM_ENDPOINT_REGEX)
+
+      resolve_get_setting_endpoint(matches)
+
+      service_key_checker = SolarWindsAPM::ServiceKeyChecker.new('ssl', SolarWindsAPM::Utils.determine_lambda_env)
+      @token = service_key_checker.token unless service_key_checker.token.nil?
+
+      OTEL_SIGNAL_TYPE.each do |data_type|
+        config_token(data_type)
+        configure_otlp_endpoint(data_type, matches)
+      end
+    end
+
+    # APM Libraries should only set the bearer token header as a convenience if:
+    # The OTEL config for exporter OTLP headers is not already set, i.e. explicitly configured by the end user, AND
+    # The OTLP export endpoint is SWO, i.e. host is otel.collector.*.*.solarwinds.com
+    def config_token(data_type)
+      data_type_upper = data_type.upcase
+
+      return unless @token
+
+      # puts "#{ENV["OTEL_EXPORTER_OTLP_#{data_type_upper}_ENDPOINT"].to_s.match?(SWO_OTLP_SIGNAL_ENDPOINT_REGEX)}"
+      # puts "#{ENV['OTEL_EXPORTER_OTLP_ENDPOINT'].to_s.match?(SWO_OTLP_GENERAL_ENDPOINT_REGEX)}"
+      if ENV["OTEL_EXPORTER_OTLP_#{data_type_upper}_HEADERS"].to_s.empty? && ENV["OTEL_EXPORTER_OTLP_#{data_type_upper}_ENDPOINT"].to_s.match?(SWO_OTLP_SIGNAL_ENDPOINT_REGEX)
+        ENV["OTEL_EXPORTER_OTLP_#{data_type_upper}_HEADERS"] = "authorization=Bearer #{@token}"
+      elsif ENV['OTEL_EXPORTER_OTLP_HEADERS'].to_s.empty? && ENV['OTEL_EXPORTER_OTLP_ENDPOINT'].to_s.match?(SWO_OTLP_GENERAL_ENDPOINT_REGEX)
+        ENV['OTEL_EXPORTER_OTLP_HEADERS'] = "authorization=Bearer #{@token}"
+      end
+    end
+
+    def configure_otlp_endpoint(data_type, matches)
+      data_type_upper = data_type.upcase
+      data_type_lower = data_type.downcase
+      otlp_endpoint_source = if ENV["OTEL_EXPORTER_OTLP_#{data_type_upper}_ENDPOINT"]
+                               "#{data_type_lower}_endpoint"
+                             elsif ENV['OTEL_EXPORTER_OTLP_ENDPOINT']
+                               'general_endpoint'
+                             else
+                               'no_endpoint'
+                             end
+
+      SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] otlp_endpoint_source: #{otlp_endpoint_source}" }
+
+      return unless otlp_endpoint_source == 'no_endpoint'
+
+      if matches&.size == 3
+        region = matches[1]
+        env    = matches[2]
+        ENV["OTEL_EXPORTER_OTLP_#{data_type_upper}_ENDPOINT"] = "https://otel.collector.#{region}.#{env}.solarwinds.com:443/v1/#{data_type_lower}"
+      else
+        ENV["OTEL_EXPORTER_OTLP_#{data_type_upper}_ENDPOINT"] = "https://otel.collector.na-01.cloud.solarwinds.com:443/v1/#{data_type_lower}"
+      end
+    end
+
+    # only valid value is apm.collector.*.*.solarwinds.com
+    # If SW APM config for collector is not set, the fallback: apm.collector.na-01.cloud.solarwinds.com
+    def resolve_get_setting_endpoint(matches)
+      return if matches&.size == 3
+
+      SolarWindsAPM.logger.warn { "[#{self.class}/#{__method__}] SW_APM_COLLECTOR format invalid: #{ENV.fetch('SW_APM_COLLECTOR', nil)}. Valid formt: apm.collector.*.*.solarwinds.com" }
+      ENV['SW_APM_COLLECTOR'] = SWO_APM_ENDPOINT_DEFAULT
+    end
+  end
+end

lib/solarwinds_apm/support/service_key_checker.rb

@@ -10,27 +10,30 @@ module SolarWindsAPM
   # ServiceKeyChecker
   # It is a service that validate the service_key
   class ServiceKeyChecker
+    attr_reader :token, :service_name
+
     def initialize(reporter, is_lambda)
       @reporter = reporter
       @is_lambda = is_lambda
+      read_and_validate_service_key
     end
 
     def read_and_validate_service_key
-      return '' unless @reporter == 'ssl'
-      return '' if @is_lambda
+      return unless @reporter == 'ssl'
+      return if @is_lambda
 
       service_key = fetch_service_key
       if service_key.empty?
         SolarWindsAPM.logger.error { "[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY not configured." }
-        return ''
+        return
       end
 
       token, _, service_name = parse_service_key(service_key)
       if token.empty?
         SolarWindsAPM.logger.error do
           "[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY problem. API Token in wrong format. Masked token: #{token[0..3]}...#{token[-4..]}"
         end
-        return ''
+        return
       end
 
       # if no service_name from service_key, then the SW_APM_SERVICE_KEY is not right format, return
@@ -39,7 +42,7 @@ def read_and_validate_service_key
         SolarWindsAPM.logger.warn do
           "[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY format problem. Service Name is missing."
         end
-        return ''
+        return
       end
 
       service_name = transform_service_name(service_name)
@@ -55,7 +58,8 @@ def read_and_validate_service_key
         service_name = transform_service_name(otel_service_name)
       end
 
-      "#{token}:#{service_name}"
+      @token = token
+      @service_name = service_name
     end
 
     private

lib/solarwinds_apm/support/utils.rb

@@ -29,5 +29,14 @@ def self.traceparent_from_context(span_context)
       end
       xtr
     end
+
+    def self.determine_lambda_env
+      if ENV['LAMBDA_TASK_ROOT'].to_s.empty? && ENV['AWS_LAMBDA_FUNCTION_NAME'].to_s.empty?
+        false
+      else
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] lambda environment - LAMBDA_TASK_ROOT: #{ENV.fetch('LAMBDA_TASK_ROOT', nil)}; AWS_LAMBDA_FUNCTION_NAME: #{ENV.fetch('AWS_LAMBDA_FUNCTION_NAME', nil)}" }
+        true
+      end
+    end
   end
 end

test/minitest_helper.rb

@@ -18,6 +18,7 @@
 require 'lumberjack'
 require 'logging'
 require 'bson'
+require 'grpc'
 
 require './lib/solarwinds_apm/version'
 require './lib/solarwinds_apm/logger'