appoptics_apm_mnfst 4.5.2

data/ext/oboe_metal/extconf.rb

@@ -0,0 +1,114 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'mkmf'
+require 'rbconfig'
+require 'open-uri'
+require 'no_proxy_fix'
+
+ext_dir = File.expand_path(File.dirname(__FILE__))
+
+# Check if we're running in JRuby
+jruby = defined?(JRUBY_VERSION) ? true : false
+
+# Set the mkmf lib paths so we have no issues linking to
+# the AppOpticsAPM libs.
+ao_lib_dir = File.join(ext_dir, 'lib')
+ao_include = File.join(ext_dir, 'src')
+
+# Download the appropriate liboboe from S3(via rake for testing) or files.appoptics.com (production)
+version = File.read(File.join(ao_include, 'VERSION')).chomp
+if ENV['APPOPTICS_FROM_S3'].to_s.downcase == 'true'
+  ao_path = File.join('https://s3-us-west-2.amazonaws.com/rc-files-t2/c-lib/', version)
+  puts "Fetching c-lib from S3"
+else
+  ao_path = File.join('https://files.appoptics.com/c-lib', version)
+end
+ao_arch = `ldd --version 2>&1` =~ /musl/ ? 'alpine-x86_64' : 'x86_64'
+ao_clib = "liboboe-1.0-#{ao_arch}.so.0.0.0"
+ao_item = File.join(ao_path, ao_clib)
+ao_checksum_item = "#{ao_item}.sha256"
+clib = File.join(ao_lib_dir, ao_clib)
+
+retries = 3
+success = false
+while retries > 0
+  begin
+    # download
+    download = open(ao_item, 'rb')
+    IO.copy_stream(download, clib)
+
+    checksum = open(ao_checksum_item, 'r').read.chomp
+    clib_checksum = Digest::SHA256.file(clib).hexdigest
+
+    # verify_checksum
+    if clib_checksum != checksum
+      $stderr.puts '== ERROR ================================================================='
+      $stderr.puts 'Checksum Verification failed for the c-extension of the appoptics_apm gem.'
+      $stderr.puts 'appoptics_apm will not instrument the code. No tracing will occur.'
+      $stderr.puts 'Contact support@appoptics.com if the problem persists.'
+      $stderr.puts '=========================================================================='
+      create_makefile('oboe_noop', 'noop')
+      retries = 0
+    else
+      success = true
+      retries = 0
+    end
+  rescue => e
+    File.write(clib, '')
+    retries -= 1
+    if retries == 0
+      $stderr.puts '== ERROR =========================================================='
+      $stderr.puts 'Download of the c-extension for the appoptics_apm gem failed.'
+      $stderr.puts 'appoptics_apm will not instrument the code. No tracing will occur.'
+      $stderr.puts 'Contact support@appoptics.com if the problem persists.'
+      $stderr.puts "error:\n#{e.message}"
+      $stderr.puts '==================================================================='
+      create_makefile('oboe_noop', 'noop')
+    end
+    sleep 0.5
+  end
+end
+
+if success
+  # Create relative symlinks for the AppOpticsAPM library
+  Dir.chdir(ao_lib_dir) do
+    File.symlink(ao_clib, 'liboboe.so')
+    File.symlink(ao_clib, 'liboboe-1.0.so.0')
+  end
+
+  dir_config('oboe', 'src', 'lib')
+
+  # create Makefile
+  if jruby || ENV.key?('APPOPTICS_URL')
+    # Build the noop extension under JRuby and Heroku.
+    # The oboe-heroku gem builds it's own c extension which links to
+    # libs specific to a Heroku dyno
+    # FIXME: For JRuby we need to remove the c extension entirely
+    create_makefile('oboe_noop', 'noop')
+
+  elsif have_library('oboe', 'oboe_config_get_revision', 'oboe.h')
+
+    $libs = append_library($libs, 'oboe')
+    $libs = append_library($libs, 'stdc++')
+
+    $CFLAGS << " #{ENV['CFLAGS']}"
+    $CPPFLAGS << " #{ENV['CPPFLAGS']}"
+    $LIBS << " #{ENV['LIBS']}"
+    $LDFLAGS << " #{ENV['LDFLAGS']} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib'"
+
+    create_makefile('oboe_metal', 'src')
+
+  else
+    $stderr.puts   '== ERROR ========================================================='
+    if have_library('oboe')
+      $stderr.puts "The c-library either needs to be updated or doesn't match the OS."
+      $stderr.puts 'No tracing will occur.'
+    else
+      $stderr.puts 'Could not find a matching c-library. No tracing will occur.'
+    end
+    $stderr.puts   'Contact support@appoptics.com if the problem persists.'
+    $stderr.puts   '=================================================================='
+    create_makefile('oboe_noop', 'noop')
+  end
+end

data/ext/oboe_metal/noop/noop.c

@@ -0,0 +1,7 @@
+#include <ruby.h>
+
+/* ruby calls this to load the extension */
+void Init_oboe_noop(void) {
+  /* assume we haven't yet defined Hola */
+  VALUE klass = rb_define_class("OboeNoop", rb_cObject);
+}

data/ext/oboe_metal/src/VERSION

@@ -0,0 +1 @@
+4.0.0

data/init.rb

@@ -0,0 +1,4 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'appoptics_apm'

data/lib/appoptics_apm.rb

@@ -0,0 +1,76 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+begin
+  require 'openssl'
+  require 'appoptics_apm/version'
+  require 'appoptics_apm/thread_local'
+  require 'appoptics_apm/logger'
+  require 'appoptics_apm/util'
+  require 'appoptics_apm/xtrace'
+  require 'appoptics_apm/support'
+  require 'appoptics_apm/base'
+  AppOpticsAPM.loaded = false
+
+  require 'appoptics_apm/config'
+  AppOpticsAPM::Config.load_config_file
+
+  begin
+    if RUBY_PLATFORM == 'java'
+      require '/usr/local/tracelytics/tracelyticsagent.jar'
+      require 'joboe_metal'
+    elsif RUBY_PLATFORM =~ /linux/
+      require_relative './oboe_metal.so'
+      require 'oboe_metal.rb'  # sets AppOpticsAPM.loaded = true if successful
+    else
+      $stderr.puts '==================================================================='
+      $stderr.puts "AppOptics warning: Platform #{RUBY_PLATFORM} not yet supported."
+      $stderr.puts 'see: https://docs.appoptics.com/kb/apm_tracing/supported_platforms/'
+      $stderr.puts 'Tracing disabled.'
+      $stderr.puts 'Contact support@appoptics.com if this is unexpected.'
+      $stderr.puts '==================================================================='
+    end
+  rescue LoadError => e
+    unless ENV['RAILS_GROUP'] == 'assets' or ENV['IGNORE_APPOPTICS_WARNING']
+      $stderr.puts '=============================================================='
+      $stderr.puts 'Missing AppOpticsAPM libraries.  Tracing disabled.'
+      $stderr.puts "Error: #{e.message}"
+      $stderr.puts 'See: https://docs.appoptics.com/kb/apm_tracing/ruby/'
+      $stderr.puts '=============================================================='
+    end
+  end
+
+  # appoptics_apm/loading can set AppOpticsAPM.loaded = false if the service key is not working
+  require 'appoptics_apm/loading'
+  require 'appoptics_apm/legacy_method_profiling'
+  require 'appoptics_apm/method_profiling'
+
+  if AppOpticsAPM.loaded
+    # tracing mode is configured via config file but can only be set once we have oboe_metal loaded
+    AppOpticsAPM.set_tracing_mode(AppOpticsAPM::Config[:tracing_mode].to_sym)
+    require 'appoptics_apm/instrumentation'
+
+    # Frameworks
+    require 'appoptics_apm/frameworks/rails'
+    require 'appoptics_apm/frameworks/sinatra'
+    require 'appoptics_apm/frameworks/padrino'
+    require 'appoptics_apm/frameworks/grape'
+  else
+    $stderr.puts '=============================================================='
+    $stderr.puts 'AppOpticsAPM not loaded. Tracing disabled.'
+    $stderr.puts 'Service Key may be wrong or missing.'
+    $stderr.puts '=============================================================='
+    require 'appoptics_apm/noop/context'
+    require 'appoptics_apm/noop/metadata'
+  end
+
+  # Load Ruby module last.  If there is no framework detected,
+  # it will load all of the Ruby instrumentation
+  require 'appoptics_apm/ruby'
+  require 'oboe/backward_compatibility'
+
+  require 'appoptics_apm/test' if ENV['APPOPTICS_GEM_TEST']
+rescue => e
+  $stderr.puts "[appoptics_apm/error] Problem loading: #{e.inspect}"
+  $stderr.puts e.backtrace
+end

data/lib/appoptics_apm/api.rb

@@ -0,0 +1,20 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+
+  module API
+    extend AppOpticsAPM::API::Logging
+    extend AppOpticsAPM::API::Metrics
+    extend AppOpticsAPM::API::Profiling
+    extend AppOpticsAPM::API::LayerInit
+    extend AppOpticsAPM::API::Util
+
+    require_relative './sdk/tracing'
+    require_relative './sdk/custom_metrics'
+
+    extend AppOpticsAPM::SDK::Tracing
+    extend AppOpticsAPM::SDK::CustomMetrics
+    extend AppOpticsAPM::API::Tracing
+  end
+end

data/lib/appoptics_apm/api/layerinit.rb

@@ -0,0 +1,41 @@
+#--
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+#++
+
+module AppOpticsAPM
+  module API
+    ##
+    # Provides methods related to layer initialization and reporting
+    module LayerInit #:nodoc:
+      # Internal: Report that instrumentation for the given layer has been
+      # installed, as well as the version of instrumentation and version of
+      # layer.
+      #
+      def report_init(layer = :rack) #:nodoc:
+        # Don't send __Init in test or if AppOpticsAPM
+        # isn't fully loaded (e.g. missing c-extension)
+        return if ENV.key?('APPOPTICS_GEM_TEST') || !AppOpticsAPM.loaded
+
+        platform_info = AppOpticsAPM::Util.build_init_report
+        log_init(layer, platform_info)
+      end
+
+      ##
+      # :nodoc:
+      # Deprecated:
+      # force_trace has been deprecated and will be removed in a subsequent version.
+      #
+      def force_trace
+        AppOpticsAPM.logger.warn '[appoptics_apm/api] AppOpticsAPM::API::LayerInit.force_trace has been deprecated and will be ' \
+                         'removed in a subsequent version.'
+
+        saved_mode = AppOpticsAPM::Config[:tracing_mode]
+        AppOpticsAPM::Config[:tracing_mode] = :always
+        yield
+      ensure
+        AppOpticsAPM::Config[:tracing_mode] = saved_mode
+      end
+    end
+  end
+end

data/lib/appoptics_apm/api/logging.rb

@@ -0,0 +1,375 @@
+#--
+# 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 AppOpticsAPM
+  module API
+    ##
+    # This modules provides the X-Trace logging facilities.
+    #
+    # These are the lower level methods, please see AppOpticsAPM::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]
+      @@ints_or_nil << Fixnum unless RUBY_VERSION >= '2.4'
+
+      ##
+      # 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.
+      # * +opts+  - 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
+      #
+      #   AppOpticsAPM::API.log('logical_layer', 'entry')
+      #   AppOpticsAPM::API.log('logical_layer', 'info', { :list_length => 20 })
+      #   AppOpticsAPM::API.log('logical_layer', 'exit')
+      #
+      # Returns nothing.
+      def log(layer, label, opts = {}, event = nil)
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
+
+        event ||= AppOpticsAPM::Context.createEvent
+        log_event(layer, label, event, opts)
+      end
+
+      ##
+      # Public: Report an exception.
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +exception+ - The exception to report
+      # * +opts+ - Custom params if you want to log extra information
+      #
+      # ==== Example
+      #
+      #   begin
+      #     my_iffy_method
+      #   rescue Exception => e
+      #     AppOpticsAPM::API.log_exception('rails', e, { user: user_id })
+      #     raise
+      #   end
+      #
+      # Returns nothing.
+      def log_exception(layer, exception, opts = {})
+        return AppOpticsAPM::Context.toString if !AppOpticsAPM.tracing? || exception.instance_variable_get(:@exn_logged)
+
+        unless exception
+          AppOpticsAPM.logger.debug '[appoptics_apm/debug] log_exception called with nil exception'
+          return AppOpticsAPM::Context.toString
+        end
+
+        exception.message << exception.class.name if exception.message.length < 4
+        opts.merge!(:Spec => 'error',
+                    :ErrorClass => exception.class.name,
+                    :ErrorMsg => exception.message)
+        opts.merge!(:Backtrace => exception.backtrace.join("\r\n")) if exception.backtrace
+
+        exception.instance_variable_set(:@exn_logged, true)
+        log(layer, :error, opts)
+      end
+
+      ##
+      # Public: Decide whether or not to start a trace, and report an entry event
+      # appropriately.
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +xtrace+ - An xtrace metadata string, or nil.  Used for cross-application tracing.
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   AppOpticsAPM::API.log_start(:layer_name, nil, { :id => @user.id })
+      #
+      # Returns an xtrace metadata string if we are tracing
+      def log_start(layer, xtrace = nil, opts = {})
+        return if !AppOpticsAPM.loaded || (opts.key?(:URL) && AppOpticsAPM::Util.static_asset?(opts[:URL]))
+
+        #--
+        # Is the below necessary? Only on JRuby? Could there be an existing context but not x-trace header?
+        # See discussion at:
+        # https://github.com/librato/ruby-tracelytics/pull/6/files?diff=split#r131029135
+        #
+        # Used by JRuby/Java webservers such as Tomcat
+        # AppOpticsAPM::Context.fromString(xtrace) if AppOpticsAPM.pickup_context?(xtrace)
+
+        # if AppOpticsAPM.tracing?
+        #   # Pre-existing context.  Either we inherited context from an
+        #   # incoming X-Trace request header or under JRuby, Joboe started
+        #   # tracing before the JRuby code was called (e.g. Tomcat)
+        #   AppOpticsAPM.is_continued_trace = true
+
+        #   if AppOpticsAPM.has_xtrace_header
+        #     opts[:TraceOrigin] = :continued_header
+        #   elsif AppOpticsAPM.has_incoming_context
+        #     opts[:TraceOrigin] = :continued_context
+        #   else
+        #     opts[:TraceOrigin] = :continued
+        #   end
+
+        # return log_entry(layer, opts)
+        # end
+        #++
+
+        # This is a bit ugly, but here is the best place to reset the layer_op thread local var.
+        AppOpticsAPM.layer_op = nil unless AppOpticsAPM::Context.isValid
+
+        if AppOpticsAPM.sample?(opts.merge(:xtrace => xtrace))
+          # Yes, we're sampling this request
+          # Probablistic tracing of a subset of requests based off of
+          # sample rate and sample source
+          opts[:SampleRate]        = AppOpticsAPM.sample_rate
+          opts[:SampleSource]      = AppOpticsAPM.sample_source
+          opts[:TraceOrigin]       = :always_sampled
+
+          if xtrace_v2?(xtrace)
+            # continue valid incoming xtrace
+            # use it for current context, ensuring sample bit is set
+            AppOpticsAPM::XTrace.set_sampled(xtrace)
+
+            md = AppOpticsAPM::Metadata.fromString(xtrace)
+            AppOpticsAPM::Context.fromString(xtrace)
+            log_event(layer, :entry, md.createEvent, opts)
+          else
+            # discard invalid incoming xtrace
+            # create a new context, ensuring sample bit set
+            md = AppOpticsAPM::Metadata.makeRandom(true)
+            AppOpticsAPM::Context.set(md)
+            log_event(layer, :entry, AppOpticsAPM::Event.startTrace(md), opts)
+          end
+        else
+          # No, we're not sampling this request
+          # set the context but don't log the event
+          if xtrace_v2?(xtrace)
+            # continue valid incoming xtrace
+            # use it for current context, ensuring sample bit is not set
+            AppOpticsAPM::XTrace.unset_sampled(xtrace)
+            AppOpticsAPM::Context.fromString(xtrace)
+          else
+            # discard invalid incoming xtrace
+            # create a new context, ensuring sample bit not set
+            md = AppOpticsAPM::Metadata.makeRandom(false)
+            AppOpticsAPM::Context.fromString(md.toString)
+          end
+        end
+        AppOpticsAPM::Context.toString
+      end
+
+      ##
+      # Public: Report an exit event and potentially clear the tracing context.
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   AppOpticsAPM::API.log_end(:layer_name, { :id => @user.id })
+      #
+      # Returns an xtrace metadata string if we are tracing
+      def log_end(layer, opts = {}, event = nil)
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
+
+        event ||= AppOpticsAPM::Context.createEvent
+        log_event(layer, :exit, event, opts)
+      ensure
+        # FIXME has_incoming_context commented out, it has importance for JRuby only but breaks Ruby tests
+        AppOpticsAPM::Context.clear # unless AppOpticsAPM.has_incoming_context?
+        AppOpticsAPM.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
+      # * +opts+ - 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
+      #
+      #   AppOpticsAPM::API.log_entry(:layer_name, { :id => @user.id })
+      #
+      # Returns an xtrace metadata string if we are tracing
+      def log_entry(layer, opts = {}, op = nil)
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
+
+        AppOpticsAPM.layer_op = (AppOpticsAPM.layer_op || []) << op.to_sym if op
+        log_event(layer, :entry, AppOpticsAPM::Context.createEvent, opts)
+      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
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   AppOpticsAPM::API.log_info(:layer_name, { :id => @user.id })
+      #
+      # Returns an xtrace metadata string if we are tracing
+      def log_info(layer, opts = {})
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
+
+        log_event(layer, :info, AppOpticsAPM::Context.createEvent, opts)
+      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
+      # * +opts+  - 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 true in +log_exit+ that corresponds to a
+      #   +log_entry+
+      #
+      # ==== Example
+      #
+      #   AppOpticsAPM::API.log_exit(:layer_name, { :id => @user.id })
+      #
+      # Returns an xtrace metadata string  if we are tracing
+      def log_exit(layer, opts = {}, op = nil)
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
+
+        AppOpticsAPM.layer_op.pop if op && AppOpticsAPM.layer_op.is_a?(Array) && AppOpticsAPM.layer_op.last == op.to_sym
+
+        log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts)
+      end
+
+      ##
+      # Public: Log an exit event from multiple requests
+      #
+      # A helper method to create and log an info event
+      # If we return from a request that faned out multiple requests
+      # we can add the collected X-Traces to the exit event
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +traces+ - An array with X-Trace strings returned from the requests
+      #
+      def log_multi_exit(layer, traces)
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
+        task_id = AppOpticsAPM::XTrace.task_id(AppOpticsAPM::Context.toString)
+        event = AppOpticsAPM::Context.createEvent
+        traces.each do |trace|
+          event.addEdgeStr(trace) if AppOpticsAPM::XTrace.task_id(trace) == task_id
+        end
+        log_event(layer, :exit, event)
+      end
+
+      ##
+      #:nodoc:
+      # Internal: Reports agent init to the collector
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event
+      def log_init(layer = :rack, opts = {})
+        context = AppOpticsAPM::Metadata.makeRandom
+        return AppOpticsAPM::Context.toString unless context.isValid
+
+        event = context.createEvent
+        event.addInfo(APPOPTICS_STR_LAYER, layer.to_s)
+        event.addInfo(APPOPTICS_STR_LABEL, 'single')
+        opts.each do |k, v|
+          event.addInfo(k, v.to_s)
+        end
+
+        AppOpticsAPM::Reporter.sendStatus(event, context)
+        AppOpticsAPM::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 AppOpticsAPM context event.  See AppOpticsAPM::Context.createEvent
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   entry = AppOpticsAPM::Context.createEvent
+      #   AppOpticsAPM::API.log_event(:layer_name, 'entry',  entry_event, { :id => @user.id })
+      #
+      #   exit_event = AppOpticsAPM::Context.createEvent
+      #   exit_event.addEdge(entry.getMetadata)
+      #   AppOpticsAPM::API.log_event(:layer_name, 'exit',  exit_event, { :id => @user.id })
+      #
+      def log_event(layer, label, event, opts = {})
+        event.addInfo(APPOPTICS_STR_LAYER, layer.to_s.freeze) if layer
+        event.addInfo(APPOPTICS_STR_LABEL, label.to_s.freeze)
+
+        AppOpticsAPM.layer = layer.to_sym if label == :entry
+        AppOpticsAPM.layer = nil          if label == :exit
+
+        opts.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
+            AppOpticsAPM.logger.debug "[appoptics_apm/debug] Couldn't add event KV: #{k} => #{v.class}"
+            AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{e.message}"
+          end
+        end if !opts.nil? && opts.any?
+
+        AppOpticsAPM::Reporter.sendReport(event)
+        AppOpticsAPM::Context.toString
+      end
+
+      # need to set the context to public, otherwise the following `extends` will be private in api.rb
+      public
+
+    end
+  end
+end