solarwinds_apm 5.0.0

data/lib/solarwinds_apm/api/logging.rb

@@ -0,0 +1,356 @@
+#--
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+#++
+
+# Make sure Set is loaded if possible.
+begin
+  require 'set'
+rescue LoadError
+  class Set; end # :nodoc:
+end
+
+module SolarWindsAPM
+  module API
+    ##
+    # This modules provides the X-Trace logging facilities.
+    #
+    # These are the lower level methods, please see SolarWindsAPM::SDK
+    # for the higher level methods
+    #
+    # If using these directly make sure to always match a start/end and entry/exit to
+    # avoid broken traces.
+    module Logging
+      @@ints_or_nil = [Integer, Float, NilClass, String]
+
+      ##
+      # Public: Report an event in an active trace.
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +label+ - The label for the reported event. See SDK documentation for reserved labels and usage.
+      # * +kvs+  - A hash containing key/value pairs that will be reported along with this event (optional).
+      # * +event+ - An event to be used instead of generating a new one (see also start_trace_with_target)
+      #
+      # ==== Example
+      #
+      #   SolarWindsAPM::API.log('logical_layer', 'entry')
+      #   SolarWindsAPM::API.log('logical_layer', 'info', { :list_length => 20 })
+      #   SolarWindsAPM::API.log('logical_layer', 'exit')
+      #
+      # Returns nothing.
+      def log(layer, label, kvs = {}, event = nil)
+        return SolarWindsAPM::Context.toString unless SolarWindsAPM.tracing?
+
+        event ||= SolarWindsAPM::Context.createEvent
+        log_event(layer, label, event, kvs)
+      end
+
+      ##
+      # Public: Report an exception.
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +exception+ - The exception to report, responds to :message and :backtrace(optional)
+      # * +kvs+ - Custom params if you want to log extra information
+      #
+      # ==== Example
+      #
+      #   begin
+      #     my_iffy_method
+      #   rescue Exception => e
+      #     SolarWindsAPM::API.log_exception('rails', e, { user: user_id })
+      #     raise
+      #   end
+      #
+      # Returns nothing.
+      def log_exception(layer, exception, kvs = {})
+        return SolarWindsAPM::Context.toString if !SolarWindsAPM.tracing? || exception.instance_variable_get(:@exn_logged)
+
+        unless exception
+          SolarWindsAPM.logger.debug '[solarwinds_apm/debug] log_exception called with nil exception'
+          return SolarWindsAPM::Context.toString
+        end
+
+        exception.message << exception.class.name if exception.message.length < 4
+        kvs.merge!(:Spec => 'error',
+                   :ErrorClass => exception.class.name,
+                   :ErrorMsg => exception.message)
+
+        if exception.respond_to?(:backtrace) && exception.backtrace
+          kvs.merge!(:Backtrace => exception.backtrace.join("\r\n"))
+        end
+
+        exception.instance_variable_set(:@exn_logged, true)
+        log(layer, :error, kvs)
+      end
+
+      ##
+      # Public: Start a trace depending on TransactionSettings
+      # or decide whether or not to start a trace, and report an entry event
+      # appropriately.
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      # * +headers+ - the request headers, they may contain w3c trace_context data
+      # * +settings+ - An instance of TransactionSettings
+      # * +url+ - String of the current url, it may be configured to be excluded from tracing
+      #
+      # ==== Example
+      #
+      #   SolarWindsAPM::API.log_start(:layer_name, { :id => @user.id })
+      #
+      # Returns a metadata string if we are tracing
+      #
+      def log_start(layer, kvs = {}, headers = {}, settings = nil, url = nil)
+        return unless SolarWindsAPM.loaded
+
+        # This is a bit ugly, but here is the best place to reset the layer_op thread local var.
+        SolarWindsAPM.layer_op = nil
+
+        settings ||= SolarWindsAPM::TransactionSettings.new(url, headers)
+        SolarWindsAPM.trace_context.add_traceinfo(kvs)
+        tracestring = SolarWindsAPM.trace_context.tracestring
+
+        if settings.do_sample
+          kvs[:SampleRate]        = settings.rate
+          kvs[:SampleSource]      = settings.source
+
+          SolarWindsAPM::TraceString.set_sampled(tracestring) if tracestring
+          event = create_start_event(tracestring)
+          log_event(layer, :entry, event, kvs)
+        else
+          create_nontracing_context(tracestring)
+          SolarWindsAPM::Context.toString
+        end
+      end
+
+      ##
+      # Public: Report an exit event and potentially clear the tracing context.
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   SolarWindsAPM::API.log_end(:layer_name, { :id => @user.id })
+      #
+      # Returns a metadata string if we are tracing
+      #
+      def log_end(layer, kvs = {}, event = nil)
+        return SolarWindsAPM::Context.toString unless SolarWindsAPM.tracing?
+
+        event ||= SolarWindsAPM::Context.createEvent
+        log_event(layer, :exit, event, kvs)
+      ensure
+        SolarWindsAPM::Context.clear
+        SolarWindsAPM.trace_context = nil
+        SolarWindsAPM.transaction_name = nil
+      end
+
+      ##
+      # Public: Log an entry event
+      #
+      # A helper method to create and log an entry event
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      # * +op+ - To identify the current operation being traced.  Used to avoid double tracing recursive calls.
+      #
+      # ==== Example
+      #
+      #   SolarWindsAPM::API.log_entry(:layer_name, { :id => @user.id })
+      #
+      # Returns a metadata string
+      #
+      def log_entry(layer, kvs = {}, op = nil)
+        return SolarWindsAPM::Context.toString unless SolarWindsAPM.tracing?
+
+        if op
+          # check if re-entry but also add op to list for log_exit
+          re_entry = SolarWindsAPM.layer_op&.last == op.to_sym
+          SolarWindsAPM.layer_op = (SolarWindsAPM.layer_op || []) << op.to_sym
+          return SolarWindsAPM::Context.toString if re_entry
+        end
+
+        event ||= SolarWindsAPM::Context.createEvent
+        log_event(layer, :entry, event, kvs)
+      end
+
+      ##
+      # Public: Log an info event
+      #
+      # A helper method to create and log an info event
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   SolarWindsAPM::API.log_info(:layer_name, { :id => @user.id })
+      #
+      # Returns a metadata string if we are tracing
+      #
+      def log_info(layer, kvs = {})
+        return SolarWindsAPM::Context.toString unless SolarWindsAPM.tracing?
+
+        kvs[:Spec] = 'info'
+        log_event(layer, :info, SolarWindsAPM::Context.createEvent, kvs)
+      end
+
+      ##
+      # Public: Log an exit event
+      #
+      # A helper method to create and log an exit event
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+  - A hash containing key/value pairs that will be reported along with this event (optional).
+      # * +op+    - Used to avoid double tracing recursive calls, needs to be the same in +log_exit+ that corresponds to a
+      #   +log_entry+
+      #
+      # ==== Example
+      #
+      #   SolarWindsAPM::API.log_exit(:layer_name, { :id => @user.id })
+      #
+      # Returns a metadata string  if we are tracing
+      def log_exit(layer, kvs = {}, op = nil)
+        return SolarWindsAPM::Context.toString unless SolarWindsAPM.tracing?
+
+        if op
+          if SolarWindsAPM.layer_op&.last == op.to_sym
+            SolarWindsAPM.layer_op.pop
+          else
+            SolarWindsAPM.logger.warn "[ruby/logging] op parameter of exit event doesn't correspond to an entry event op"
+          end
+          # check if the next op is the same, don't log event if so
+          return SolarWindsAPM::Context.toString if SolarWindsAPM.layer_op&.last == op.to_sym
+        end
+
+        log_event(layer, :exit, SolarWindsAPM::Context.createEvent, kvs)
+      end
+
+      ##
+      #:nodoc:
+      # Internal: Reports agent init to the collector
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event
+      def log_init(layer = :rack, kvs = {})
+        context = SolarWindsAPM::Metadata.makeRandom
+        return SolarWindsAPM::Context.toString unless context.isValid
+
+        event = context.createEvent
+        event.addInfo(SW_APM_STR_LAYER, layer.to_s)
+        event.addInfo(SW_APM_STR_LABEL, 'single')
+        kvs.each do |k, v|
+          event.addInfo(k, v.to_s)
+        end
+
+        SolarWindsAPM::Reporter.sendStatus(event, context)
+        SolarWindsAPM::Context.toString
+      end
+
+      private
+
+      ##
+      #:nodoc:
+      # @private
+      # Internal: Report an event.
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +label+ - The label for the reported event.  See API documentation for reserved labels and usage.
+      # * +event+ - The pre-existing SolarWindsAPM context event.  See SolarWindsAPM::Context.createEvent
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   entry = SolarWindsAPM::Context.createEvent
+      #   SolarWindsAPM::API.log_event(:layer_name, 'entry',  entry_event, { :id => @user.id })
+      #
+      #   exit_event = SolarWindsAPM::Context.createEvent
+      #   exit_event.addEdge(entry.getMetadata)
+      #   SolarWindsAPM::API.log_event(:layer_name, 'exit',  exit_event, { :id => @user.id })
+      #
+      def log_event(layer, label, event, kvs = {})
+        event.addInfo(SW_APM_STR_LAYER, layer.to_s.freeze) if layer
+        event.addInfo(SW_APM_STR_LABEL, label.to_s.freeze)
+
+        SolarWindsAPM.layer = layer.to_sym if label == :entry
+        SolarWindsAPM.layer = nil          if label == :exit
+
+        kvs.each do |k, v|
+          value = nil
+
+          next unless valid_key? k
+
+          if @@ints_or_nil.include?(v.class)
+            value = v
+          elsif v.class == Set
+            value = v.to_a.to_s
+          else
+            value = v.to_s if v.respond_to?(:to_s)
+          end
+
+          begin
+            event.addInfo(k.to_s, value)
+          rescue ArgumentError => e
+            SolarWindsAPM.logger.debug "[solarwinds_apm/debug] Couldn't add event KV: #{k} => #{v.class}"
+            SolarWindsAPM.logger.debug "[solarwinds_apm/debug] #{e.message}"
+          end
+        end if !kvs.nil? && kvs.any?
+
+        SolarWindsAPM::Reporter.sendReport(event)
+        SolarWindsAPM::Context.toString
+      end
+
+      def create_start_event(tracestring = nil)
+        if SolarWindsAPM::TraceString.sampled?(tracestring)
+          md = SolarWindsAPM::Metadata.fromString(tracestring)
+          SolarWindsAPM::Context.fromString(tracestring)
+          md.createEvent
+        else
+          md = SolarWindsAPM::Metadata.makeRandom(true)
+          SolarWindsAPM::Context.set(md)
+          SolarWindsAPM::Event.startTrace(md)
+        end
+      end
+
+      public
+
+      def create_nontracing_context(tracestring)
+        if SolarWindsAPM::TraceString.valid?(tracestring)
+          # continue valid incoming tracestring
+          # use it for current context, ensuring sample bit is not set
+          SolarWindsAPM::TraceString.unset_sampled(tracestring)
+          SolarWindsAPM::Context.fromString(tracestring)
+        else
+          # discard invalid incoming tracestring
+          # create a new context, ensuring sample bit not set
+          md = SolarWindsAPM::Metadata.makeRandom(false)
+          SolarWindsAPM::Context.fromString(md.toString)
+        end
+      end
+
+      # need to set the module context to public, otherwise the following `extends` will be private in api.rb
+
+      public
+
+    end
+  end
+end

data/lib/solarwinds_apm/api/memcache.rb

@@ -0,0 +1,37 @@
+#--
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+#++
+
+# TODO remove Memcache from API and into some Util module to be included in Modules that need
+# ____ these methods
+module SolarWindsAPM
+  module API
+    ##
+    # Utility methods for the Memcache instrumentation
+    # currently used by dalli and memcached
+    module Memcache #:nodoc:
+      MEMCACHE_OPS = %w(add append cas decr decrement delete fetch get incr increment prepend replace set)
+
+      def memcache_hit?(result)
+        result.nil? ? 0 : 1
+      end
+
+      def remote_host(key)
+        return unless defined?(Lib.memcached_server_by_key) &&
+                      defined?(@struct) && defined?(is_unix_socket?)
+
+        server_as_array = Lib.memcached_server_by_key(@struct, key.to_s)
+
+        return unless server_as_array.is_a?(Array)
+
+        server = server_as_array.first
+        if is_unix_socket?(server)
+          'localhost'
+        elsif defined?(server.hostname)
+          server.hostname
+        end
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/api/metrics.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
+module  SolarWindsAPM
+  module API
+    module Metrics
+
+      ##
+      # Internal: method to send duration for a transaction
+      # it checks if it can send metrics with the current transaction name
+      # or a default transaction name and sets the transaction name accordingly
+      #
+      # === Arguments:
+      #
+      # * +span+ the name of the current span (used to construct a transaction name if none is defined)
+      # * +kvs+ A hash containing key/value pairs, only the value of :TransactionName will be relevant
+      #
+      # === Returns:
+      # The result of the block.
+      #
+      # === Assigns:
+      # The transaction_name to kvs[:TransactionName]
+
+      def send_metrics(span, kvs)
+        start = Time.now
+        yield
+      ensure
+        # TODO send_metrics is currently used in grpc, sdk
+        # ____ the error (0,1) would have to be returned from yield
+        error = 0
+        duration = (1000 * 1000 * (Time.now - start)).to_i
+        transaction_name = determine_transaction_name(span, kvs)
+        kvs[:TransactionName] = SolarWindsAPM::Span.createSpan(transaction_name, nil, duration, error)
+        SolarWindsAPM.transaction_name = nil
+      end
+
+      private
+
+      ##
+      # Determine the transaction name to be set on the trace.
+      #
+      # === Argument:
+      # * +span+ the name of the current span (used to construct a transaction name if none is defined)
+      # * +kvs+ (hash, optional) the hash that may have values for 'Controller' and 'Action'
+      #
+      # === Returns:
+      # (string) the determined transaction name
+      #
+      def determine_transaction_name(span, kvs = {})
+        if SolarWindsAPM.transaction_name
+          SolarWindsAPM.transaction_name
+        elsif kvs['Controller'] && kvs['Action']
+          [kvs['Controller'], kvs['Action']].join('.')
+        elsif kvs[:Controller] && kvs[:Action]
+          [kvs[:Controller], kvs[:Action]].join('.')
+        else
+          "custom-#{span}"
+        end
+      end
+
+    end
+  end
+end

data/lib/solarwinds_apm/api/util.rb

@@ -0,0 +1,98 @@
+#--
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+#++
+
+require 'pp'
+
+module SolarWindsAPM
+  module API
+    ##
+    # General utility methods for the gem
+    module Util #:nodoc:
+      BACKTRACE_CUTOFF = 200
+
+      # Internal: Check whether the provided key is reserved or not. Reserved
+      # keys are either keys that are handled by liboboe calls or the solarwinds_apm gem.
+      #
+      # key - the key to check.
+      #
+      # Return a boolean indicating whether or not key is reserved.
+      def valid_key?(key)
+        ![:Label, :Layer, :Timestamp, :Timestamp_u].include?(key.to_sym)
+      end
+
+      # Internal: Get the current backtrace.
+      #
+      # from - int, from position in array of backtraces
+      # to - int, end position in array of backtraces, can be negative to count from the end
+      #
+      # Returns a string with each frame of the backtrace separated by '\r\n'.
+      #
+      def backtrace(from = 0, to = -1)
+        bt = Kernel.caller
+        trim_backtrace(bt[from..to]).join("\r\n")
+      end
+
+      # Internal: Trim a backtrace to a manageable size
+      #
+      # backtrace - the backtrace (an array of stack frames/from Kernel.caller)
+      #
+      # Returns a trimmed backtrace
+      def trim_backtrace(backtrace)
+        return backtrace unless backtrace.is_a?(Array) && backtrace.size > BACKTRACE_CUTOFF
+
+        # Trim backtraces by getting the first 180 and last 20 lines
+        backtrace[0, 180] + ['...[snip]...'] + backtrace[backtrace.size - 20, 20]
+      end
+
+      # Internal: Pretty print a list of arguments for reporting
+      #
+      # args - the list of arguments to work on
+      #
+      # Returns a pretty string representation of arguments
+      def pps(*args)
+        old_out = $stdout
+        begin
+          s = StringIO.new
+          $stdout = s
+          pp(*args)
+        ensure
+          $stdout = old_out
+        end
+        s.string
+      end
+
+      # Internal: Determine a string to report representing klass
+      #
+      # args - an instance of a Class, a Class or a Module
+      #
+      # Returns a string representation of klass
+      def get_class_name(klass)
+        kv = {}
+
+        if klass.to_s =~ /::/
+          klass.class.to_s.rpartition('::').last
+        else
+          if klass.is_a?(Class) && klass.is_a?(Module)
+            # Class
+            kv['Class'] = klass.to_s
+
+          elsif !klass.is_a?(Class) && !klass.is_a?(Module)
+            # Class instance
+            kv['Class'] = klass.class.to_s
+
+          else
+            # Module
+            kv['Module'] = klass.to_s
+          end
+        end
+        kv
+      end
+
+      def xtrace_v2?(xtr)
+        xtr && xtr.start_with?('2B')
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/api.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+
+  module API
+    extend SolarWindsAPM::API::Logging
+    extend SolarWindsAPM::API::Metrics
+    extend SolarWindsAPM::API::LayerInit
+    extend SolarWindsAPM::API::Util
+
+    require_relative './sdk/trace_context_headers'
+    require_relative './sdk/tracing'
+    require_relative './sdk/custom_metrics'
+    require_relative './sdk/current_trace_info'
+    require_relative './sdk/logging' # to make sure it is loaded <- not very elegant
+
+    extend SolarWindsAPM::SDK::Tracing
+    extend SolarWindsAPM::SDK::CustomMetrics
+  end
+end