solarwinds_apm 6.1.2 → 7.0.0.prev1

data/lib/solarwinds_apm/otel_lambda_config.rb

@@ -1,56 +0,0 @@
-# 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.
-
-require 'solarwinds_apm/constants'
-require 'solarwinds_apm/api'
-require 'solarwinds_apm/support'
-require 'solarwinds_apm/opentelemetry'
-
-module SolarWindsAPM
-  # OTelLambdaConfig module
-  module OTelLambdaConfig
-    def self.initialize
-      return unless defined?(::OpenTelemetry::SDK::Configurator)
-
-      if ENV['OTEL_TRACES_EXPORTER'].to_s.empty?
-        ENV['OTEL_TRACES_EXPORTER'] = 'otlp'
-      elsif !ENV['OTEL_TRACES_EXPORTER'].include? 'otlp'
-        ENV['OTEL_TRACES_EXPORTER'] += ',otlp'
-      end
-
-      ENV['OTEL_RESOURCE_ATTRIBUTES'] = "sw.apm.version=#{SolarWindsAPM::Version::STRING},sw.data.module=apm,service.name=#{ENV['OTEL_SERVICE_NAME'] || ENV.fetch('AWS_LAMBDA_FUNCTION_NAME', nil)}," + ENV['OTEL_RESOURCE_ATTRIBUTES'].to_s
-      ::OpenTelemetry::SDK.configure(&:use_all)
-
-      # append our propagators
-      ::OpenTelemetry.propagation.instance_variable_get(:@propagators).append(SolarWindsAPM::OpenTelemetry::SolarWindsPropagator::TextMapPropagator.new)
-
-      # register metrics_exporter to meter_provider
-      ::OpenTelemetry.meter_provider.add_metric_reader(::OpenTelemetry::Exporter::OTLP::Metrics::MetricsExporter.new)
-
-      # append our processors
-      ::OpenTelemetry.tracer_provider.add_span_processor(SolarWindsAPM::OpenTelemetry::OTLPProcessor.new)
-
-      # configure sampler afterwards
-      ::OpenTelemetry.tracer_provider.sampler = ::OpenTelemetry::SDK::Trace::Samplers.parent_based(
-        root: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new,
-        remote_parent_sampled: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new,
-        remote_parent_not_sampled: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new
-      )
-
-      SolarWindsAPM.logger.info do
-        "[#{name}/#{__method__}] SolarWindsAPM lambda configuration initialized \
-        \n                                               Installed instrumentation: #{::OpenTelemetry.tracer_provider.instance_variable_get(:@registry).keys} \
-        \n                                               SpanProcessor: #{::OpenTelemetry.tracer_provider.instance_variable_get(:@span_processors).map(&:class)} \
-        \n                                               Sampler: #{::OpenTelemetry.tracer_provider.instance_variable_get(:@sampler).inspect} \
-        \n                                               Resource: #{::OpenTelemetry.tracer_provider.instance_variable_get(:@resource).inspect}"
-      end
-
-      nil
-    end
-  end
-end

data/lib/solarwinds_apm/patch/dummy_patch.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module SolarWindsAPM
-  module Patch
-    module DummyPatch
-    end
-  end
-end

data/lib/solarwinds_apm/support/oboe_tracing_mode.rb

@@ -1,33 +0,0 @@
-# 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
-  # OboeTracingMode
-  # Used in solarwinds_sampler
-  class OboeTracingMode
-    OBOE_SETTINGS_UNSET = -1
-    OBOE_TRACE_DISABLED = 0
-    OBOE_TRACE_ENABLED = 1
-    OBOE_TRIGGER_DISABLED = 0
-    OBOE_TRIGGER_ENABLED = 1
-
-    def self.get_oboe_trace_mode(tracing_mode)
-      mode = OBOE_SETTINGS_UNSET
-      mode = OBOE_TRACE_ENABLED if tracing_mode == :enabled
-      mode = OBOE_TRACE_DISABLED if tracing_mode == :disabled
-      mode
-    end
-
-    def self.get_oboe_trigger_trace_mode(trigger_trace_mode)
-      mode = OBOE_SETTINGS_UNSET
-      mode = OBOE_TRIGGER_ENABLED if trigger_trace_mode == :enabled
-      mode = OBOE_TRIGGER_DISABLED if trigger_trace_mode == :disabled
-      mode
-    end
-  end
-end

data/lib/solarwinds_apm/support/support_report.rb

@@ -1,99 +0,0 @@
-# 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.
-
-require 'rbconfig'
-require 'logger'
-
-##
-# This module is used to debug problematic setups and/or environments.
-# Depending on the environment, output may be to stdout or the framework
-# log file (e.g. log/production.log)
-module SolarWindsAPM
-  ##
-  # yesno
-  #
-  # Utility method to translate value/nil to "yes"/"no" strings
-  def self.yesno(condition)
-    condition ? 'yes' : 'no'
-  end
-
-  def self.support_report
-    @logger_level = SolarWindsAPM.logger.level
-    SolarWindsAPM.logger.level = ::Logger::DEBUG
-
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn '* BEGIN SolarWindsAPM Support Report'
-    SolarWindsAPM.logger.warn '*   Please email the output of this report to SWO-support@solarwinds.com'
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn "Ruby: #{RUBY_DESCRIPTION}"
-    SolarWindsAPM.logger.warn "PROGRAM_NAME: #{$PROGRAM_NAME}" # replace $0 to get executing script
-    SolarWindsAPM.logger.warn "ARGV: #{ARGV.inspect}"
-    SolarWindsAPM.logger.warn "SolarWindsAPM.loaded == #{SolarWindsAPM.loaded}"
-
-    SolarWindsAPM.logger.warn "SolarWindsAPM::Ruby defined?: #{yesno(defined?(SolarWindsAPM::Ruby))}"
-    SolarWindsAPM.logger.warn "SolarWindsAPM.reporter: #{SolarWindsAPM.reporter}"
-
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn '* Frameworks'
-    SolarWindsAPM.logger.warn '********************************************************'
-
-    using_rails = defined?(::Rails)
-    SolarWindsAPM.logger.warn "Using Rails?: #{yesno(using_rails)}"
-    if using_rails
-      SolarWindsAPM.logger.warn "SolarWindsAPM::Rails loaded?: #{yesno(defined?(SolarWindsAPM::Rails))}"
-      SolarWindsAPM.logger.warn "SolarWindsAPM::Rack middleware loaded?: #{yesno(::Rails.configuration.middleware.include?(SolarWindsAPM::Rack))}" if defined?(SolarWindsAPM::Rack)
-    end
-
-    using_sinatra = defined?(::Sinatra)
-    SolarWindsAPM.logger.warn "Using Sinatra?: #{yesno(using_sinatra)}"
-
-    using_padrino = defined?(::Padrino)
-    SolarWindsAPM.logger.warn "Using Padrino?: #{yesno(using_padrino)}"
-
-    using_grape = defined?(::Grape)
-    SolarWindsAPM.logger.warn "Using Grape?: #{yesno(using_grape)}"
-
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn '* ActiveRecord Adapter'
-    SolarWindsAPM.logger.warn '********************************************************'
-    if defined?(::ActiveRecord)
-      if defined?(::ActiveRecord::Base.connection.adapter_name)
-        SolarWindsAPM.logger.warn "ActiveRecord adapter: #{::ActiveRecord::Base.connection.adapter_name}"
-      end
-    else
-      SolarWindsAPM.logger.warn 'No ActiveRecord'
-    end
-
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn '* SolarWindsAPM::Config Values'
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn SolarWindsAPM::Config.print_config.to_s
-
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn '* SolarWindsAPM::OTelConfig Values'
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn SolarWindsAPM::OTelConfig.print_config.to_s
-
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn '* OS, Platform + Env'
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn "host_os:  #{RbConfig::CONFIG['host_os']}"
-    SolarWindsAPM.logger.warn "sitearch: #{RbConfig::CONFIG['sitearch']}"
-    SolarWindsAPM.logger.warn "arch:     #{RbConfig::CONFIG['arch']}"
-    SolarWindsAPM.logger.warn "Platform: #{RUBY_PLATFORM}"
-
-    SolarWindsAPM.logger.warn '********************************************************'
-    SolarWindsAPM.logger.warn '* END SolarWindsAPM Support Report'
-    SolarWindsAPM.logger.warn '*   Support Email: technicalsupport@solarwinds.com'
-    SolarWindsAPM.logger.warn '*   Github: https://github.com/solarwinds/apm-ruby'
-    SolarWindsAPM.logger.warn '********************************************************'
-
-    SolarWindsAPM.logger.level = @logger_level
-    nil
-  end
-end

data/lib/solarwinds_apm/support/transaction_cache.rb

@@ -1,57 +0,0 @@
-# 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
-  # LRU TransactionCache with initial limit 1000
-  module TransactionCache
-    attr_reader :capacity
-
-    def self.initialize
-      @capacity = 1000
-      @cache = {}
-      @order = []
-    end
-
-    def self.get(key)
-      return nil unless @cache.key?(key)
-
-      @order.delete(key)
-      @order.push(key)
-      @cache[key]
-    end
-
-    def self.del(key)
-      @cache.delete(key)
-      @order.delete(key)
-    end
-
-    def self.clear
-      @cache.clear
-      @order.clear
-    end
-
-    def self.size
-      @cache.size
-    end
-
-    def self.set(key, value)
-      if @cache.key?(key)
-        @cache.delete(key)
-      elsif @order.size >= @capacity
-        evict_key = @order.shift
-        @cache.delete(evict_key)
-      end
-
-      @cache[key] = value
-      @order.push(key)
-      SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] current TransactionCache #{@cache.inspect}" }
-    end
-  end
-end
-
-SolarWindsAPM::TransactionCache.initialize

data/lib/solarwinds_apm/support/x_trace_options.rb

@@ -1,138 +0,0 @@
-# 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
-  # XTraceOptions
-  class XTraceOptions
-    attr_reader :options, :signature, :trigger_trace, :timestamp,
-                :sw_keys, :custom_kvs, :ignored
-
-    ##
-    # use by Trigger Tracing
-    # TODO - refactor for w3c when ticket ready
-    #
-    # Params:
-    # +options+ : An X-Trace-Options @options string
-    # +signature+ : hmac signature to pass on for verification
-    #
-    # populates:
-    # - @force_trace (true|false)
-    # - @app_id (as given by Pingdom)
-    # - @probe_id (as given by Pingdom)
-    # - @loc (2 characters given by Pingdom)
-    # - @custom_kvs (hash)
-    # - @ignored (array)
-    #
-    # split it up by ';' separator
-    # kv assignment by '='
-    # currently valid keys:
-    # - force_trace (valid: 0,1) unless we use just a kv
-    # - application_id (format defined by pingdom (no validation))
-    # - probe_id
-    # - custom_* (';=' not allowed in key), value (validate max. length)
-    # - ts (unix timestamp)
-    # - other keys will be reported in the response options as ignored
-
-    SW_XTRACEOPTIONS_RESPONSE_KEY = 'xtrace_options_response'
-
-    def initialize(context)
-      SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] x_trace_options context: #{context.inspect}" }
-      @context = context.dup
-      @trigger_trace = false
-      @custom_kvs = {}
-      @sw_keys = nil
-      @ignored = []
-      @timestamp = 0
-      @options = options_header
-      @signature = obtain_signature
-
-      @options&.split(/;+/)&.each do |val|
-        k = val.split('=', 2)
-
-        next unless k[0] # it can be nil, eg when the header starts with ';'
-
-        k[0]&.strip!
-        case k[0]
-        when 'trigger-trace'
-          if k[1]
-            @ignored << 'trigger-trace'
-          else
-            @trigger_trace = true
-          end
-        when 'sw-keys'
-          if @sw_keys
-            SolarWindsAPM.logger.info { "[#{self.class}/#{__method__}] Duplicate key: #{k[0]}" }
-          else
-            @sw_keys = k[1].strip
-          end
-        when /^custom-[^\s]*$/
-          if @custom_kvs[k[0]]
-            SolarWindsAPM.logger.info { "[#{self.class}/#{__method__}] Duplicate key: #{k[0]}" }
-          else
-            @custom_kvs[k[0]] = k[1].strip
-          end
-        when 'ts'
-          if @timestamp.positive?
-            SolarWindsAPM.logger.info { "[#{self.class}/#{__method__}] Duplicate key: #{k[0]}" }
-          else
-            @timestamp = k[1].to_i
-          end
-        else
-          @ignored << k[0]
-        end
-      end
-      return if @ignored.empty?
-
-      SolarWindsAPM.logger.info("[#{self.class}/#{__method__}] Some keys were ignored: #{@ignored.join(',')}")
-    end
-
-    def add_kvs(kvs, settings)
-      return unless settings.auth_ok?
-
-      @custom_kvs.each { |k, v| kvs[k] = v } unless @custom_kvs.empty?
-      kvs['SWKeys'] = @sw_keys if @sw_keys
-      kvs['TriggeredTrace'] = true if settings.triggered_trace?
-    end
-
-    def obtain_signature
-      # INTL_SWO_SIGNATURE_KEY = sw_signature
-      signature = obtain_sw_value(SolarWindsAPM::Constants::INTL_SWO_SIGNATURE_KEY)
-      SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] x_trace_options option_signature: #{signature}" }
-      signature
-    end
-
-    def options_header
-      # INTL_SWO_X_OPTIONS_KEY = sw_xtraceoptions
-      header = obtain_sw_value(SolarWindsAPM::Constants::INTL_SWO_X_OPTIONS_KEY)
-      SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] x_trace_options option_header: #{header}" }
-      header
-    end
-
-    def obtain_sw_value(type)
-      sw_value = nil
-      instance_variable = @context&.instance_variable_get('@entries')
-      instance_variable&.each do |key, value|
-        next unless key.instance_of?(::String)
-
-        sw_value = value if key == type
-        SolarWindsAPM.logger.debug do
-          "[#{self.class}/#{__method__}] obtained sw value: #{type} #{key}: #{value.inspect}"
-        end
-      end
-      sw_value
-    end
-
-    def intify_trigger_trace
-      @trigger_trace ? 1 : 0
-    end
-
-    def self.sw_xtraceoptions_response_key
-      SW_XTRACEOPTIONS_RESPONSE_KEY
-    end
-  end
-end