[sdk] add log_info and log_exception to the SDK

[AO-11876]

Author: prettycoder

lib/appoptics_apm/api.rb

@@ -13,6 +13,7 @@ module API
     require_relative './sdk/tracing'
     require_relative './sdk/custom_metrics'
     require_relative './sdk/current_trace'
+    require_relative './sdk/logging' # to make sure it is loaded <- not very elegant
 
     extend AppOpticsAPM::SDK::Tracing
     extend AppOpticsAPM::SDK::CustomMetrics

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 while rescuing an exception
+      #
+      # === 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

test/unit/api_sdk/sdk_test.rb

@@ -409,6 +409,41 @@ def computation_with_appoptics(n)
     end
   end
 
+  describe 'log events' do
+    before do
+      clear_all_traces
+    end
+
+    after do
+      clear_all_traces
+      AppOpticsAPM::Context.clear
+    end
+
+    it 'SDK should log exceptions' do
+      AppOpticsAPM::SDK.start_trace('test_01')  do
+        AppOpticsAPM::SDK.log_exception( StandardError.new, { the: 'exception' })
+      end
+
+      traces = get_all_traces
+      traces.size == 3
+
+      traces[1]['Label'].must_equal 'error'
+      traces[1]['the'].must_equal 'exception'
+    end
+
+    it 'SDK should log info' do
+      AppOpticsAPM::SDK.start_trace('test_01')  do
+        AppOpticsAPM::SDK.log_info( { the: 'information' })
+      end
+
+      traces = get_all_traces
+      traces.size == 3
+
+      traces[1]['Label'].must_equal 'info'
+      traces[1]['the'].must_equal 'information'
+    end
+  end
+
   describe 'set_transaction_name' do
 
     it 'should not set the transaction name if the arg is not a string or an empty string' do