solarwinds_apm 5.0.0

data/lib/solarwinds_apm/support/transaction_metrics.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2018 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  ##
+  # This module sends the duration of the call and
+  # sets the transaction_name
+  #
+  class TransactionMetrics
+    class << self
+
+      ##
+      # sends the duration of the call and
+      # sets the transaction_name
+      def metrics(env, settings)
+        if settings.do_metrics
+          req = ::Rack::Request.new(env)
+          # TODO rails 3x is not supported anymore ...
+          url = req.url   # saving it here because rails3.2 overrides it when there is a 500 error
+          start = Time.now
+
+          begin
+            status, headers, response = yield
+
+            SolarWindsAPM.transaction_name = send_metrics(env, req, url, start, status)
+          rescue
+            SolarWindsAPM.transaction_name = send_metrics(env, req, url, start, status || '500')
+            raise
+          end
+        else
+          status, headers, response = yield
+          SolarWindsAPM.transaction_name = "#{domain(req)}#{transaction_name(env)}" if settings.do_sample
+        end
+
+        [status, headers, response]
+      end
+
+      private
+
+      def send_metrics(env, req, url, start, status)
+        name = transaction_name(env)
+
+        status = status.to_i
+        error = status.between?(500,599) ? 1 : 0
+        duration =(1000 * 1000 * (Time.now - start)).round(0)
+        method = req.request_method
+        # SolarWindsAPM.logger.warn "%%% Sending metrics: #{name}, #{url}, #{status} %%%"
+        SolarWindsAPM::Span.createHttpSpan(name, url, domain(req), duration, status, method, error) || ''
+      end
+
+      def domain(req)
+        if SolarWindsAPM::Config['transaction_name']['prepend_domain']
+          [80, 443].include?(req.port) ? req.host : "#{req.host}:#{req.port}"
+        end
+      end
+
+      def transaction_name(env)
+        return SolarWindsAPM.transaction_name  if SolarWindsAPM.transaction_name
+
+        if env['solarwinds_apm.controller'] && env['solarwinds_apm.action']
+          [env['solarwinds_apm.controller'], env['solarwinds_apm.action']].join('.')
+        end
+      end
+
+    end
+  end
+end

data/lib/solarwinds_apm/support/transaction_settings.rb

@@ -0,0 +1,233 @@
+# Copyright (c) 2018 SolarWinds, LLC.
+# All rights reserved.
+#
+
+AO_TRACING_ENABLED = 1
+AO_TRACING_DISABLED = 0
+AO_TRACING_UNSET = -1
+
+AO_TRACING_DECISIONS_OK = 0
+
+OBOE_SETTINGS_UNSET = -1
+
+module SolarWindsAPM
+  ##
+  # This module helps with setting up the transaction filters and applying them
+  #
+  class TransactionSettings
+
+    attr_accessor :do_sample, :do_metrics
+    attr_reader   :auth_msg, :do_propagate, :status_msg, :type, :source, :rate, :tracestring, :sw_member_value
+
+    def initialize(url = '', headers = {}, options = nil)
+      @do_metrics = false
+      @do_sample = false
+      @do_propagate = true
+
+      SolarWindsAPM.trace_context = SolarWindsAPM::TraceContext.new(headers)
+      @tracestring = SolarWindsAPM.trace_context.tracestring
+      @sw_member_value = SolarWindsAPM.trace_context.sw_member_value
+      tracing_mode = AO_TRACING_ENABLED
+
+      # TODO
+      #   NH-11132 will address this
+      # incoming tracing info has priority over existing context
+      # if SolarWindsAPM::Context.isValid && !@sw_member_value
+      #   @do_sample = SolarWindsAPM.tracing?
+      #   return
+      # end
+
+      if url && asset?(url)
+        @do_propagate = false
+        return
+      end
+
+      if tracing_mode_disabled? && !tracing_enabled?(url) ||
+        tracing_disabled?(url)
+
+        tracing_mode = AO_TRACING_DISABLED
+      end
+
+      # args (all optional)
+      # 0 char const *in_xtrace
+      # 1 char const *tracestate
+      # 2 int custom_tracing_mode
+      # 3 int custom_sample_rate
+      # 4 int request_type
+      # 5 int custom_trigger_mode
+      # 6 char const *header_options
+      # 7 char const *header_signature
+      # 8 long header_timestamp
+      args = [@tracestring, @sw_member_value] #0,1
+      args << tracing_mode #2
+      args << (SolarWindsAPM::Config[:sample_rate] || OBOE_SETTINGS_UNSET) #3
+
+      if options && (options.options || options.signature)
+        args << (options.trigger_trace ? 1 : 0) #4
+        args << (trigger_tracing_mode_disabled? ? 0 : 1) #5
+        args << options.options #6
+        args << options.signature #7
+        args << options.timestamp #8
+      end
+
+      metrics, sample, @rate, @source, @bucket_rate, @bucket_cap, @type, @auth, @status_msg, @auth_msg, @status =
+        SolarWindsAPM::Context.getDecisions(*args)
+
+      if @status > AO_TRACING_DECISIONS_OK
+        SolarWindsAPM.logger.warn "[solarwinds_apm/sample] Problem getting the sampling decisions: #{@status_msg} code: #{@status}"
+      end
+
+      @do_metrics = metrics > 0
+      @do_sample = sample > 0
+    end
+
+    def to_s
+      "do_propagate: #{do_propagate}, do_sample: #{do_sample}, do_metrics: #{do_metrics} rate: #{rate}, source: #{source}"
+    end
+
+    def add_kvs(kvs)
+      kvs[:SampleRate] = @rate
+      kvs[:SampleSource] = @source
+    end
+
+    def triggered_trace?
+      @type == 1
+    end
+
+    def auth_ok?
+      # @auth is undefined if initialize is called with an existing context
+      !@auth || @auth < 1
+    end
+
+    private
+
+    ##
+    # check the config setting for :tracing_mode
+    def tracing_mode_disabled?
+      SolarWindsAPM::Config[:tracing_mode] &&
+        [:disabled, :never].include?(SolarWindsAPM::Config[:tracing_mode])
+    end
+
+    ##
+    # tracing_enabled?
+    #
+    # Given a path, this method determines whether it matches any of the
+    # regexps to exclude it from metrics and traces
+    #
+    def tracing_enabled?(url)
+      return false unless SolarWindsAPM::Config[:url_enabled_regexps].is_a? Array
+      # once we only support Ruby >= 2.4.0 use `match?` instead of `=~`
+      return SolarWindsAPM::Config[:url_enabled_regexps].any? { |regex| regex =~ url }
+    rescue => e
+      SolarWindsAPM.logger.warn "[SolarWindsAPM/filter] Could not apply :enabled filter to path. #{e.inspect}"
+      true
+    end
+
+    ##
+    # tracing_disabled?
+    #
+    # Given a path, this method determines whether it matches any of the
+    # regexps to exclude it from metrics and traces
+    #
+    def tracing_disabled?(url)
+      return false unless SolarWindsAPM::Config[:url_disabled_regexps].is_a? Array
+      # once we only support Ruby >= 2.4.0 use `match?` instead of `=~`
+      return SolarWindsAPM::Config[:url_disabled_regexps].any? { |regex| regex =~ url }
+    rescue => e
+      SolarWindsAPM.logger.warn "[SolarWindsAPM/filter] Could not apply :disabled filter to path. #{e.inspect}"
+      false
+    end
+
+    def trigger_tracing_mode_disabled?
+      SolarWindsAPM::Config[:trigger_tracing_mode] &&
+        SolarWindsAPM::Config[:trigger_tracing_mode] == :disabled
+    end
+
+    ##
+    # asset?
+    #
+    # Given a path, this method determines whether it is a static asset
+    #
+    def asset?(path)
+      return false unless SolarWindsAPM::Config[:dnt_compiled]
+      # once we only support Ruby >= 2.4.0 use `match?` instead of `=~`
+      return SolarWindsAPM::Config[:dnt_compiled] =~ path
+    rescue => e
+      SolarWindsAPM.logger.warn "[SolarWindsAPM/filter] Could not apply do-not-trace filter to path. #{e.inspect}"
+      false
+    end
+
+    public
+
+    class << self
+
+      def asset?(path)
+        return false unless SolarWindsAPM::Config[:dnt_compiled]
+        # once we only support Ruby >= 2.4.0 use `match?` instead of `=~`
+        return SolarWindsAPM::Config[:dnt_compiled] =~ path
+      rescue => e
+        SolarWindsAPM.logger.warn "[SolarWindsAPM/filter] Could not apply do-not-trace filter to path. #{e.inspect}"
+        false
+      end
+
+      def compile_url_settings(settings)
+        if !settings.is_a?(Array) || settings.empty?
+          reset_url_regexps
+          return
+        end
+
+        # `tracing: disabled` is the default
+        disabled = settings.select { |v| !v.has_key?(:tracing) || v[:tracing] == :disabled }
+        enabled = settings.select { |v| v[:tracing] == :enabled }
+
+        SolarWindsAPM::Config[:url_enabled_regexps] = compile_regexp(enabled)
+        SolarWindsAPM::Config[:url_disabled_regexps] = compile_regexp(disabled)
+      end
+
+      def compile_regexp(settings)
+        regexp_regexp     = compile_url_settings_regexp(settings)
+        extensions_regexp = compile_url_settings_extensions(settings)
+
+        regexps = [regexp_regexp, extensions_regexp].flatten.compact
+
+        regexps.empty? ? nil : regexps
+      end
+
+      def compile_url_settings_regexp(value)
+        regexps = value.select do |v|
+          v.key?(:regexp) &&
+            !(v[:regexp].is_a?(String) && v[:regexp].empty?) &&
+            !(v[:regexp].is_a?(Regexp) && v[:regexp].inspect == '//')
+        end
+
+        regexps.map! do |v|
+          begin
+            v[:regexp].is_a?(String) ? Regexp.new(v[:regexp], v[:opts]) : Regexp.new(v[:regexp])
+          rescue
+            SolarWindsAPM.logger.warn "[solarwinds_apm/config] Problem compiling transaction_settings item #{v}, will ignore."
+            nil
+          end
+        end
+        regexps.keep_if { |v| !v.nil? }
+        regexps.empty? ? nil : regexps
+      end
+
+      def compile_url_settings_extensions(value)
+        extensions = value.select do |v|
+          v.key?(:extensions) &&
+            v[:extensions].is_a?(Array) &&
+            !v[:extensions].empty?
+        end
+        extensions = extensions.map { |v| v[:extensions] }.flatten
+        extensions.keep_if { |v| v.is_a?(String) }
+
+        extensions.empty? ? nil : Regexp.new("(#{Regexp.union(extensions).source})(\\?.+){0,1}$")
+      end
+
+      def reset_url_regexps
+        SolarWindsAPM::Config[:url_enabled_regexps] = nil
+        SolarWindsAPM::Config[:url_disabled_regexps] = nil
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/support/x_trace_options.rb

@@ -0,0 +1,113 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  class XTraceOptions
+
+    attr_reader :options, :signature, :trigger_trace, :timestamp
+    attr_reader :sw_keys, :custom_kvs, :ignored # used in tests
+    
+    ##
+    # 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
+
+    def initialize(options, signature = nil)
+      @options = options.dup
+      @signature = signature.dup
+      @trigger_trace = false
+      @custom_kvs = {}
+      @sw_keys = nil
+      @ignored = []
+      @timestamp = 0
+
+      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 "[solarwinds_apm/x-trace-options] Duplicate key: #{k[0]}"
+          else
+            @sw_keys = k[1].strip
+          end
+        when /^custom-[^\s]*$/
+          if @custom_kvs[k[0]]
+            SolarWindsAPM.logger.info "[solarwinds_apm/x-trace-options] Duplicate key: #{k[0]}"
+          else
+            @custom_kvs[k[0]] = k[1].strip
+          end
+        when 'ts'
+          if @timestamp > 0
+            SolarWindsAPM.logger.info "[solarwinds_apm/x-trace-options] Duplicate key: #{k[0]}"
+          else
+            @timestamp = k[1].to_i
+          end
+        else
+          @ignored << k[0]
+        end
+      end
+      unless @ignored.empty?
+        msg = "[solarwinds_apm/x-trace-options] Some keys were ignored: #{@ignored.join(',')}"
+        SolarWindsAPM.logger.info(msg)
+      end
+    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 add_response_header(headers, settings)
+      return unless options
+
+      response = []
+      response << "auth=#{settings.auth_msg}" if @signature
+      if settings.auth_ok?
+        if @trigger_trace
+          trigger_msg = settings.tracestring && settings.type == 0 ? 'ignored' : settings.status_msg
+        else
+          trigger_msg = 'not-requested'
+        end
+        response << "trigger-trace=#{trigger_msg}"
+        response << "ignored=#{@ignored.join(',')}" unless @ignored.empty?
+      end
+
+      headers['X-Trace-Options-Response'] = response.join(';')
+    end
+
+  end
+end

data/lib/solarwinds_apm/support.rb

@@ -0,0 +1,12 @@
+# Copyright (c) SolarWinds, LLC.
+# All rights reserved
+
+pattern = File.join(File.dirname(__FILE__), 'support', '*.rb')
+Dir.glob(pattern) do |f|
+  begin
+    require f
+  rescue => e
+    SolarWindsAPM.logger.error "[solarwinds_apm/loading] Error loading support file '#{f}' : #{e}"
+    SolarWindsAPM.logger.debug "[solarwinds_apm/loading] #{e.backtrace.first}"
+  end
+end

data/lib/solarwinds_apm/support_report.rb

@@ -0,0 +1,113 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'rbconfig'
+require 'logger'
+
+module SolarWindsAPM
+  ##
+  # 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)
+
+  ##
+  # yesno
+  #
+  # Utility method to translate value/nil to "yes"/"no" strings
+  def self.yesno(x)
+    x ? 'yes' : 'no'
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+  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 technicalsupport@solarwinds.com'
+    SolarWindsAPM.logger.warn '********************************************************'
+    SolarWindsAPM.logger.warn "Ruby: #{RUBY_DESCRIPTION}"
+    SolarWindsAPM.logger.warn "$0: #{$0}"
+    SolarWindsAPM.logger.warn "$1: #{$1}" unless $1.nil?
+    SolarWindsAPM.logger.warn "$2: #{$2}" unless $2.nil?
+    SolarWindsAPM.logger.warn "$3: #{$3}" unless $3.nil?
+    SolarWindsAPM.logger.warn "$4: #{$4}" unless $4.nil?
+    SolarWindsAPM.logger.warn "SolarWindsAPM.loaded == #{SolarWindsAPM.loaded}"
+
+    on_heroku = SolarWindsAPM.heroku?
+    SolarWindsAPM.logger.warn "On Heroku?: #{yesno(on_heroku)}"
+    if on_heroku
+      SolarWindsAPM.logger.warn "SW_APM_URL: #{ENV['SW_APM_URL']}"
+    end
+
+    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))}"
+      if defined?(SolarWindsAPM::Rack)
+        SolarWindsAPM.logger.warn "SolarWindsAPM::Rack middleware loaded?: #{yesno(::Rails.configuration.middleware.include? SolarWindsAPM::Rack)}"
+      end
+    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::Config.print_config
+
+    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 RUBY_PLATFORM
+    SolarWindsAPM.logger.warn "RACK_ENV: #{ENV['RACK_ENV']}"
+    SolarWindsAPM.logger.warn "RAILS_ENV: #{ENV['RAILS_ENV']}" if using_rails
+
+    SolarWindsAPM.logger.warn '********************************************************'
+    SolarWindsAPM.logger.warn '* Raw __Init KVs'
+    SolarWindsAPM.logger.warn '********************************************************'
+    platform_info = SolarWindsAPM::Util.build_init_report
+    platform_info.each { |k,v|
+      SolarWindsAPM.logger.warn "#{k}: #{v}"
+    }
+
+    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/librato/ruby-solarwinds'
+    SolarWindsAPM.logger.warn '********************************************************'
+
+    SolarWindsAPM.logger.level = @logger_level
+    nil
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+end