appoptics_apm-zearn 4.13.1

data/lib/appoptics_apm/noop/profiling.rb

@@ -0,0 +1,21 @@
+module AppOpticsAPM
+
+  # override the Ruby method, so that no code related to profiling gets executed
+  class Profiling
+
+    def self.run
+      yield
+    end
+  end
+
+  # these put the c-functions into "noop"
+  module CProfiler
+    def self.set_interval(_)
+      # do nothing
+    end
+
+    def self.get_tid
+      return 0
+    end
+  end
+end

data/lib/appoptics_apm/oboe_init_options.rb

@@ -0,0 +1,211 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
+require 'singleton'
+
+module AppOpticsAPM
+
+  class OboeInitOptions
+    include Singleton
+
+    attr_reader :reporter, :host, :service_name, :ec2_md_timeout, :grpc_proxy  # exposing these mainly for testing
+
+    # TODO decide if these globals are useful when testing
+    # OBOE_HOSTNAME_ALIAS = 0
+    # OBOE_DEBUG_LEVEL = 1
+    # OBOE_LOGFILE = 2
+    #
+    # OBOE_MAX_TRANSACTIONS = 3
+    # OBOE_FLUSH_MAX_WAIT_TIME = 4
+    # OBOE_EVENTS_FLUSH_INTERVAL = 5
+    # OBOE_EVENTS_FLUSH_BATCH_SIZE = 6
+    #
+    # OBOE_REPORTER = 7
+    # OBOE_COLLECTOR = 8
+    # OBOE_SERVICE_KEY = 9
+    # OBOE_TRUSTEDPATH = 10
+    #
+    # OBOE_BUFSIZE = 11
+    # OBOE_TRACE_METRICS = 12
+    # OBOE_HISTOGRAM_PRECISION = 13
+    # OBOE_TOKEN_BUCKET_CAPACITY = 14
+    # OBOE_TOKEN_BUCKET_RATE = 15
+    # OBOE_FILE_SINGLE = 16
+
+    def initialize
+      # optional hostname alias
+      @hostname_alias = ENV['APPOPTICS_HOSTNAME_ALIAS'] || AppOpticsAPM::Config[:hostname_alias] || ''
+      # level at which log messages will be written to log file (0-6)
+      @debug_level = (ENV['APPOPTICS_DEBUG_LEVEL'] || AppOpticsAPM::Config[:debug_level] || 3).to_i
+      # file name including path for log file
+      # TODO eventually find better way to combine ruby and oboe logs
+      @log_file_path = ENV['APPOPTICS_LOGFILE'] || ''
+      # maximum number of transaction names to track
+      @max_transactions = (ENV['APPOPTICS_MAX_TRANSACTIONS'] || -1).to_i
+      # maximum wait time for flushing data before terminating in milli seconds
+      @max_flush_wait_time = (ENV['APPOPTICS_FLUSH_MAX_WAIT_TIME'] || -1).to_i
+      # events flush timeout in seconds (threshold for batching messages before sending off)
+      @events_flush_interval = (ENV['APPOPTICS_EVENTS_FLUSH_INTERVAL'] || -1).to_i
+      # events flush batch size in KB (threshold for batching messages before sending off)
+      @event_flush_batch_size = (ENV['APPOPTICS_EVENTS_FLUSH_BATCH_SIZE'] || -1).to_i
+
+      # the reporter to be used (ssl, upd, file, null)
+      # collector endpoint (reporter=ssl), udp address (reporter=udp), or file path (reporter=file)
+      @reporter, @host = reporter_and_host
+
+      # the service key
+      @service_key = read_and_validate_service_key
+      # path to the SSL certificate (only for ssl)
+      @trusted_path = ENV['APPOPTICS_TRUSTEDPATH'] || ''
+      # size of the message buffer
+      @buffer_size = (ENV['APPOPTICS_BUFSIZE'] || -1).to_i
+      # flag indicating if trace metrics reporting should be enabled (default) or disabled
+      @trace_metrics = (ENV['APPOPTICS_TRACE_METRICS'] || -1).to_i
+      # the histogram precision (only for ssl)
+      @histogram_precision = (ENV['APPOPTICS_HISTOGRAM_PRECISION'] || -1).to_i
+      # custom token bucket capacity
+      @token_bucket_capacity = (ENV['APPOPTICS_TOKEN_BUCKET_CAPACITY'] || -1).to_i
+      # custom token bucket rate
+      @token_bucket_rate = (ENV['APPOPTICS_TOKEN_BUCKET_RATE'] || -1).to_i
+      # use single files in file reporter for each event
+      @file_single = (ENV['APPOPTICS_REPORTER_FILE_SINGLE'].to_s.downcase == 'true') ? 1 : 0
+      # timeout for ec2 metadata
+      @ec2_md_timeout = read_and_validate_ec2_md_timeout
+      @grpc_proxy = read_and_validate_proxy
+      # hardcoded arg for lambda (lambda not supported yet)
+      # hardcoded arg for grpc hack
+    end
+
+    def re_init # for testing with changed ENV vars
+      initialize
+    end
+
+    def array_for_oboe
+      [
+        @hostname_alias,         # 0
+        @debug_level,            # 1
+        @log_file_path,          # 2
+        @max_transactions,       # 3
+        @max_flush_wait_time,    # 4
+        @events_flush_interval,  # 5
+        @event_flush_batch_size, # 6
+
+        @reporter,               # 7
+        @host,                   # 8
+        @service_key,            # 9
+        @trusted_path,           #10
+        @buffer_size,            #11
+        @trace_metrics,          #12
+        @histogram_precision,    #13
+        @token_bucket_capacity,  #14
+        @token_bucket_rate,      #15
+        @file_single,            #16
+        @ec2_md_timeout,         #17
+        @grpc_proxy,             #18
+        0,                       # arg for lambda
+        1                        # arg for grpc hack, hardcoded to include hack
+      ]
+    end
+
+    def service_key_ok?
+      return !@service_key.empty? || @reporter != 'ssl'
+    end
+
+    private
+
+    def reporter_and_host
+
+      reporter = ENV['APPOPTICS_REPORTER'] || 'ssl'
+      # override with 'file', e.g. when running tests
+      # changed my mind => set the right reporter in the env when running tests !!!
+      # reporter = 'file' if ENV.key?('APPOPTICS_GEM_TEST')
+
+      host = ''
+      case reporter
+      when 'ssl', 'file'
+        host = ENV['APPOPTICS_COLLECTOR'] || ''
+      when 'udp'
+        host = ENV['APPOPTICS_COLLECTOR'] ||
+                "#{AppOpticsAPM::Config[:reporter_host]}:#{AppOpticsAPM::Config[:reporter_port]}"
+        # TODO decide what to do
+        # ____ AppOpticsAPM::Config[:reporter_host] and
+        # ____ AppOpticsAPM::Config[:reporter_port] were moved here from
+        # ____ oboe_metal.rb and are not documented anywhere
+        # ____ udp is for internal use only
+      when 'null'
+        host = ''
+      end
+
+      [reporter, host]
+    end
+
+    def read_and_validate_service_key
+      return '' unless @reporter == 'ssl'
+
+      service_key = ENV['APPOPTICS_SERVICE_KEY'] || AppOpticsAPM::Config[:service_key]
+      unless service_key
+        AppOpticsAPM.logger.error "[appoptics_apm/oboe_options] APPOPTICS_SERVICE_KEY not configured."
+        return ''
+      end
+
+      match = service_key.match( /([^:]+)(:{0,1})(.*)/ )
+      token = match[1]
+      service_name = match[3]
+
+      return '' unless validate_token(token)
+      return '' unless validate_transform_service_name(service_name)
+
+      return "#{token}:#{service_name}"
+    end
+
+    def validate_token(token)
+      if (token !~ /^[0-9a-fA-F]{64}|[0-9a-zA-Z_-]{71}$/) && ENV['APPOPTICS_COLLECTOR'] !~ /java-collector:1222/
+        masked = "#{token[0..3]}...#{token[-4..-1]}"
+        AppOpticsAPM.logger.error "[appoptics_apm/oboe_options] APPOPTICS_SERVICE_KEY problem. API Token in wrong format. Masked token: #{masked}"
+        return false
+      end
+
+      true
+    end
+
+    def validate_transform_service_name(service_name)
+      service_name = 'test_ssl_collector' if ENV['APPOPTICS_COLLECTOR'] =~ /java-collector:1222/
+      if service_name.empty?
+        AppOpticsAPM.logger.error "[appoptics_apm/oboe_options] APPOPTICS_SERVICE_KEY problem. Service Name is missing"
+        return false
+      end
+
+      name = service_name.dup
+      name.downcase!
+      name.gsub!(/[^a-z0-9.:_-]/, '')
+      name = name[0..254]
+
+      if name != service_name
+        AppOpticsAPM.logger.warn "[appoptics_apm/oboe_options] APPOPTICS_SERVICE_KEY problem. Service Name transformed from #{service_name} to #{name}"
+        service_name = name
+      end
+      @service_name = service_name # instance variable used in testing
+      true
+    end
+
+    def read_and_validate_ec2_md_timeout
+      timeout = ENV['APPOPTICS_EC2_METADATA_TIMEOUT'] || AppOpticsAPM::Config[:ec2_metadata_timeout]
+      return 1000 unless timeout.is_a?(Integer) || timeout =~ /^\d+$/
+      timeout = timeout.to_i
+      return timeout.between?(0, 3000) ? timeout : 1000
+    end
+
+    def read_and_validate_proxy
+      proxy = ENV['APPOPTICS_PROXY'] || AppOpticsAPM::Config[:http_proxy] || ''
+      return proxy if proxy == ''
+
+      unless proxy =~ /http:\/\/.*:\d+$/
+        AppOpticsAPM.logger.error "[appoptics_apm/oboe_options] APPOPTICS_PROXY/http_proxy doesn't start with 'http://', #{proxy}"
+        return '' # try without proxy, it may work, shouldn't crash but may not report
+      end
+
+      proxy
+    end
+  end
+end
+

data/lib/appoptics_apm/ruby.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  ##
+  # This module provides a method to manually initialize the
+  # Ruby instrumentation.  Normally this is done by detecting
+  # frameworks at load time and inserting initialization hooks.
+  module Ruby
+    class << self
+      def initialize
+        load
+      end
+
+      ##
+      # The core method to load Ruby instrumentation.  Call this
+      # from raw Ruby scripts or in Ruby applications where a
+      # supported framework isn't being used.  Supported frameworks
+      # will instead be detected at load time and initialization is
+      # automatic.
+      def load
+        # In case some apps call this manually, make sure
+        # that the gem is fully loaded and not in no-op
+        # mode (e.g. on unsupported platforms etc.)
+        if AppOpticsAPM.loaded
+          AppOpticsAPM::Inst.load_instrumentation
+        end
+      end
+    end
+  end
+end
+
+if AppOpticsAPM.loaded && !AppOpticsAPM.framework?
+  AppOpticsAPM::Ruby.load
+end

data/lib/appoptics_apm/sdk/current_trace.rb

@@ -0,0 +1,77 @@
+#--
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+#++
+
+module AppOpticsAPM
+  module SDK
+
+    module CurrentTrace
+
+      # Creates an instance of {TraceId} with instance methods {TraceId#id}, {TraceId#for_log}
+      # and {TraceId#hash_for_log}.
+      #
+      # === Example:
+      #
+      #   trace = AppOpticsAPM::SDK.current_trace
+      #   trace.id             # '7435A9FE510AE4533414D425DADF4E180D2B4E36-0'
+      #   trace.for_log        # 'ao.traceId=7435A9FE510AE4533414D425DADF4E180D2B4E36-0' or '' depends on Config
+      #   trace.hash_for_log   # { ao: { traceId: '7435A9FE510AE4533414D425DADF4E180D2B4E36-0 } }  or {} depends on Config
+      #
+      # Configure traceId injection with lograge:
+      #
+      #    Lograge.custom_options = lambda do |event|
+      #       AppOpticsAPM::SDK.current_trace.hash_for_log
+      #    end
+      #
+      def current_trace
+        TraceId.new
+      end
+
+      # @attr id the current traceId, it looks like: '7435A9FE510AE4533414D425DADF4E180D2B4E36-0'
+      #          and ends in '-1' if the request is sampled and '-0' otherwise.
+      #          Results in '0000000000000000000000000000000000000000-0'
+      #          if the CurrentTrace instance was created outside of the context
+      #          of a request.
+      class TraceId
+        attr_reader :id
+
+        def initialize
+          @xtrace = AppOpticsAPM::Context.toString
+          task_id = AppOpticsAPM::XTrace.task_id(@xtrace)
+          sampled = AppOpticsAPM::XTrace.sampled?(@xtrace)
+          @id = "#{task_id}-#{sampled ? 1 : 0}"
+        end
+
+        # for_log returns a string in the format 'traceId=<current_trace.id>' or ''.
+        #          An empty string is returned depending on the setting for
+        #          <tt>AppOpticsAPM::Config[:log_traceId]</tt>, which can be :never,
+        #          :sampled, :traced, or :always.
+        #
+        def for_log
+          @for_log ||= log? ? "ao.traceId=#{@id}" : ''
+        end
+
+        def hash_for_log
+          @hash_for_log ||= log? ? { ao: { traceId: @id } } : {}
+        end
+
+        def log? # should the traceId be added to the log?
+          case AppOpticsAPM::Config[:log_traceId]
+          when :never, nil
+            false
+          when :always
+            AppOpticsAPM::XTrace.ok?(@xtrace)
+          when :traced
+            AppOpticsAPM::XTrace.valid?(@xtrace)
+          when :sampled
+            AppOpticsAPM::XTrace.sampled?(@xtrace)
+          end
+        end
+      end
+
+    end
+
+    extend CurrentTrace
+  end
+end

data/lib/appoptics_apm/sdk/custom_metrics.rb

@@ -0,0 +1,94 @@
+#--
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+#++
+
+module AppOpticsAPM
+  module SDK
+
+    module CustomMetrics
+
+      # Send counts
+      #
+      # Use this method to report the number of times an action occurs. The metric counts reported are summed and flushed every 60 seconds.
+      #
+      # === Arguments:
+      #
+      # * +name+          (String) Name to be used for the metric. Must be 255 or fewer characters and consist only of A-Za-z0-9.:-*
+      # * +count+         (Integer, optional, default = 1): Count of actions being reported
+      # * +with_hostname+ (Boolean, optional, default = false): Indicates if the host name should be included as a tag for the metric
+      # * +tags_kvs+      (Hash, optional): List of key/value pairs to describe the metric. The key must be <= 64 characters, the value must be <= 255 characters, allowed characters: A-Za-z0-9.:-_
+      #
+      # === Example:
+      #
+      #   class WorkTracker
+      #     def counting(name, tags = {})
+      #       yield # yield to where work is done
+      #       AppOpticsAPM::SDK.increment_metric(name, 1, false, tags)
+      #     end
+      #   end
+      #
+      # === Returns:
+      # * 0 on success, error code on failure
+      #
+      def increment_metric(name, count = 1, with_hostname = false, tags_kvs = {})
+        return true unless AppOpticsAPM.loaded
+        with_hostname = with_hostname ? 1 : 0
+        tags, tags_count = make_tags(tags_kvs)
+        AppOpticsAPM::CustomMetrics.increment(name.to_s, count, with_hostname, nil, tags, tags_count) == 1
+      end
+
+      # Send values with counts
+      #
+      # Use this method to report a value for each or multiple counts. The metric values reported are aggregated and flushed every 60 seconds. The dashboard displays the average value per count.
+      #
+      # === Arguments:
+      #
+      # * +name+          (String) Name to be used for the metric. Must be 255 or fewer characters and consist only of A-Za-z0-9.:-*
+      # * +value+         (Numeric) Value to be added to the current sum
+      # * +count+         (Integer, optional, default = 1): Count of actions being reported
+      # * +with_hostname+ (Boolean, optional, default = false): Indicates if the host name should be included as a tag for the metric
+      # * +tags_kvs+      (Hash, optional): List of key/value pairs to describe the metric. The key must be <= 64 characters, the value must be <= 255 characters, allowed characters: A-Za-z0-9.:-_
+      #
+      # === Example:
+      #
+      #   class WorkTracker
+      #     def timing(name, tags = {})
+      #       start = Time.now
+      #       yield # yield to where work is done
+      #       duration = Time.now - start
+      #       AppOpticsAPM::SDK.summary_metric(name, duration, 1, false, tags)
+      #     end
+      #   end
+      #
+      # === Returns:
+      # * 0 on success, error code on failure
+      #
+      def summary_metric(name, value, count = 1, with_hostname = false, tags_kvs = {})
+        return true unless AppOpticsAPM.loaded
+        with_hostname = with_hostname ? 1 : 0
+        tags, tags_count = make_tags(tags_kvs)
+        AppOpticsAPM::CustomMetrics.summary(name.to_s, value, count, with_hostname, nil, tags, tags_count) == 1
+      end
+
+      private
+
+      def make_tags(tags_kvs)
+        unless tags_kvs.is_a?(Hash)
+          AppOpticsAPM.logger.warn("[appoptics_apm/metrics] CustomMetrics received tags_kvs that are not a Hash (found #{tags_kvs.class}), setting tags_kvs = {}")
+          tags_kvs = {}
+        end
+        count = tags_kvs.size
+        tags = AppOpticsAPM::MetricTags.new(count)
+
+        tags_kvs.each_with_index do |(k, v), i|
+          tags.add(i, k.to_s, v.to_s)
+        end
+
+        [tags, count]
+      end
+    end
+
+    extend CustomMetrics
+  end
+end

data/lib/appoptics_apm/sdk/logging.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+#
+
+module AppOpticsAPM
+  module SDK
+    module Logging
+
+      # Log an information event in the current span
+      #
+      # a possible use-case is to collect extra information during the execution of a request
+      #
+      # === Arguments:
+      # * +opts+   - (optional) hash containing key/value pairs that will be reported with this span.
+      #
+      def log_info(opts)
+        AppOpticsAPM::API.log_info(AppOpticsAPM.layer, opts)
+      end
+
+      # Log an exception/error event in the current span
+      #
+      # this may be helpful to track problems when an exception is rescued
+      #
+      # === Arguments:
+      # * +exception+ - an exception, must respond to :message and :backtrace
+      # * +opts+      - (optional) hash containing key/value pairs that will be reported with this span.
+      #
+      def log_exception(exception, opts = {})
+        AppOpticsAPM::API.log_exception(AppOpticsAPM.layer, exception, opts)
+      end
+
+    end
+
+    extend Logging
+
+  end
+end