appoptics_apm 4.12.2 → 4.13.0

data/ext/oboe_metal/test/test.h

@@ -0,0 +1,11 @@
+#ifndef TEST_H
+#define TEST_H
+
+class RubyCallsFrames {
+    public:
+    static VALUE c_get_frames();
+};
+
+void Init_RubyCallsFrames();
+
+#endif //TEST_H

data/ext/oboe_metal/test/test_main.cc

@@ -0,0 +1,32 @@
+#include "gtest/gtest.h"
+// #include "gmock/gmock.h"
+#include <ruby/ruby.h>
+#include "../src/profiling.h"
+#include "../src/frames.h"
+#include "test.h"
+
+#ifndef FRAMES_BUFFER
+#define FRAMES_BUFFER
+
+using namespace std;
+
+int main(int argc, char **argv) {
+    int state = -1;
+
+    // order important! init ruby before adding functions!
+    ruby_init();
+    Init_RubyCallsFrames();
+
+    // !!! if the require path is wrong, cmake will segfault !!!
+    string path(std::getenv("TEST_DIR"));
+    string cmd("require '" + path + "/" + "ruby_test_helper.rb" + "'");
+    rb_eval_string(cmd.c_str());
+
+    ::testing::InitGoogleTest(&argc, argv);
+
+    state = RUN_ALL_TESTS();
+
+    ruby_cleanup(0);
+    return state;
+}
+#endif //FRAMES_BUFFER

data/lib/appoptics_apm/api/metrics.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
 module  AppOpticsAPM
   module API
     module Metrics

data/lib/appoptics_apm/base.rb

@@ -136,7 +136,7 @@ module AppOpticsAPMBase
   #
   def tracing_layer_op?(operation)
     unless AppOpticsAPM.layer_op.nil? || AppOpticsAPM.layer_op.is_a?(Array)
-      AppOpticsAPM.logger.error('[appopticsapm/logging] INTERNAL: layer_op should be nil or an array, please report to support@appoptics.com')
+      AppOpticsAPM.logger.error('[appopticsapm/logging] INTERNAL: layer_op should be nil or an array, please report to technicalsupport@solarwinds.com')
       return false
     end
 

data/lib/appoptics_apm/config.rb

@@ -224,6 +224,17 @@ module AppOpticsAPM
             Regexp.new(AppOpticsAPM::Config[:dnt_regexp], AppOpticsAPM::Config[:dnt_opts] || nil)
         end
 
+      elsif key == :profiling_interval
+        if value.is_a?(Integer) && value > 0
+          value = [100, value].min
+        else
+          value = 10
+        end
+        @@config[:profiling_interval] = value
+        # CProfiler may not be loaded yet, the profiler will send the value
+        # after it is loaded
+        AppOpticsAPM::CProfiler.set_interval(value) if defined? AppOpticsAPM::CProfiler
+
       elsif key == :transaction_settings
         if value.is_a?(Hash)
           AppOpticsAPM::TransactionSettings.compile_url_settings(value[:url])
@@ -262,8 +273,6 @@ module AppOpticsAPM
     end
     # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
-
-
     def self.method_missing(sym, *args)
       class_var_name = "@@#{sym}"
 

data/lib/appoptics_apm/frameworks/rails/inst/connection_adapters/utils5x.rb

@@ -26,7 +26,13 @@ module AppOpticsAPM
               opts[:Backtrace] = AppOpticsAPM::API.backtrace
             end
 
-            config = ActiveRecord::Base.connection_config
+            if ActiveRecord::Base.method_defined?(:connection_db_config)
+              # Rails 6.1++ deprecates connection_config
+              config = ActiveRecord::Base.connection_db_config.configuration_hash
+            else
+              config = ActiveRecord::Base.connection_config
+            end
+
             if config
               opts[:Database]   = config[:database] if config.key?(:database)
               opts[:RemoteHost] = config[:host]     if config.key?(:host)

data/lib/appoptics_apm/inst/rack.rb

@@ -40,12 +40,15 @@ if AppOpticsAPM.loaded
         options = AppOpticsAPM::XTraceOptions.new(env['HTTP_X_TRACE_OPTIONS'], env['HTTP_X_TRACE_OPTIONS_SIGNATURE'])
         xtrace = AppOpticsAPM::XTrace.valid?(env['HTTP_X_TRACE']) ? (env['HTTP_X_TRACE']) : nil
         settings = AppOpticsAPM::TransactionSettings.new(url, xtrace, options)
+        profile_spans = AppOpticsAPM::Config['profiling'] == :enabled ? 1 : -1
 
         response =
           propagate_xtrace(env, settings, xtrace) do
-            sample(env, settings, options) do
-              AppOpticsAPM::TransactionMetrics.metrics(env, settings) do
-                @app.call(env)
+            sample(env, settings, options, profile_spans) do
+              AppOpticsAPM::Profiling.run do
+                AppOpticsAPM::TransactionMetrics.metrics(env, settings) do
+                  @app.call(env)
+                end
               end
             end
           end || [500, {}, nil]
@@ -124,7 +127,7 @@ if AppOpticsAPM.loaded
         [status, headers, response]
       end
 
-      def sample(env, settings, options)
+      def sample(env, settings, options, profile_spans)
         xtrace = env['HTTP_X_TRACE']
         if settings.do_sample
           begin
@@ -137,13 +140,17 @@ if AppOpticsAPM.loaded
             status, headers, response = yield
 
             AppOpticsAPM::API.log_exit(:rack, { Status: status,
-                                                TransactionName: AppOpticsAPM.transaction_name })
+                                                TransactionName: AppOpticsAPM.transaction_name,
+                                                ProfileSpans: profile_spans})
+
             [status, headers, response]
           rescue Exception => e
             # it is ok to rescue Exception here because we are reraising it (we just need a chance to log_end)
             AppOpticsAPM::API.log_exception(:rack, e)
             AppOpticsAPM::API.log_exit(:rack, { Status: status,
-                                                TransactionName: AppOpticsAPM.transaction_name })
+                                                TransactionName: AppOpticsAPM.transaction_name,
+                                                ProfileSpans: profile_spans
+                                              })
             raise
           end
         else

data/lib/appoptics_apm/inst/redis.rb

@@ -76,8 +76,7 @@ module AppOpticsAPM
 
           kvs[:KVOp] = command[0]
           kvs[:RemoteHost] = @options[:host]
-
-          unless NO_KEY_OPS.include?(op) || (command[1].is_a?(Array) && command[1].count > 1)
+          unless NO_KEY_OPS.include?(op) || op == :del && command[1..-1].flatten.count > 1
             if command[1].is_a?(Array)
               kvs[:KVKey] = command[1].first
             else

data/lib/appoptics_apm/noop/context.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
 ####
 # noop version of AppOpticsAPM::Context
 #

data/lib/appoptics_apm/noop/metadata.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
 ####
 # noop version of AppOpticsAPM::Metadata
 #
@@ -19,4 +22,4 @@ module AppOpticsAPM
       false
     end
   end
-end
+end

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

@@ -72,6 +72,8 @@ module AppOpticsAPM
       # 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
@@ -80,26 +82,28 @@ module AppOpticsAPM
 
     def array_for_oboe
       [
-        @hostname_alias,
-        @debug_level,
-        @log_file_path,
-        @max_transactions,
-        @max_flush_wait_time,
-        @events_flush_interval,
-        @event_flush_batch_size,
-
-        @reporter,
-        @host,
-        @service_key,
-        @trusted_path,
-        @buffer_size,
-        @trace_metrics,
-        @histogram_precision,
-        @token_bucket_capacity,
-        @token_bucket_rate,
-        @file_single,
-        @ec2_md_timeout,
-        @grpc_proxy
+        @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
 
@@ -155,7 +159,7 @@ module AppOpticsAPM
     end
 
     def validate_token(token)
-      if (token !~ /^[0-9a-fA-F]{64}|[0-9a-zA-Z_-]{71}$/) && ENV['APPOPTICS_COLLECTOR'] != "sslcollector:12222"
+      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
@@ -165,7 +169,7 @@ module AppOpticsAPM
     end
 
     def validate_transform_service_name(service_name)
-      service_name = 'test_ssl_collector' if ENV['APPOPTICS_COLLECTOR'] == "sslcollector:12222"
+      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

data/lib/appoptics_apm/support/profiling.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2020 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  class Profiling
+
+    def self.run
+      # allow enabling and disabling and setting interval interactively
+      return yield unless AppOpticsAPM::Config.profiling == :enabled && AppOpticsAPM.tracing?
+
+      CProfiler.run(Thread.current, AppOpticsAPM::Config.profiling_interval) do
+        # for some reason `return` is needed here
+        # this is yielded by c-code, but why it needs `return` ... ????
+        return yield
+      end
+    end
+  end
+end

data/lib/appoptics_apm/support/transaction_metrics.rb

@@ -6,7 +6,7 @@ module AppOpticsAPM
   # This module sends the duration of the call and
   # sets the transaction_name
   #
-  module TransactionMetrics
+  class TransactionMetrics
     class << self
 
       ##

data/lib/appoptics_apm/support/transaction_settings.rb

@@ -20,11 +20,11 @@ module AppOpticsAPM
     attr_reader   :auth_msg, :do_propagate, :status_msg, :type, :source, :rate, :xtrace
                   #, :status
 
-    def initialize(url = '', xtrace = '', options = nil)
+    def initialize(url = '', xtrace = nil, options = nil)
       @do_metrics = false
       @do_sample = false
       @do_propagate = true
-      @xtrace = xtrace || ''
+      @xtrace = xtrace
       tracing_mode = AO_TRACING_ENABLED
 
       if AppOpticsAPM::Context.isValid

data/lib/appoptics_apm/support/x_trace_options.rb

@@ -95,7 +95,7 @@ module AppOpticsAPM
       response << "auth=#{settings.auth_msg}" if @signature
       if settings.auth_ok?
         if @trigger_trace
-          trigger_msg = !settings.xtrace.empty? && settings.type == 0 ? 'ignored' : settings.status_msg
+          trigger_msg = settings.xtrace && settings.type == 0 ? 'ignored' : settings.status_msg
         else
           trigger_msg = 'not-requested'
         end
@@ -107,4 +107,4 @@ module AppOpticsAPM
     end
 
   end
-end
+end

data/lib/appoptics_apm/support_report.rb

@@ -25,7 +25,7 @@ module AppOpticsAPM
 
     AppOpticsAPM.logger.warn '********************************************************'
     AppOpticsAPM.logger.warn '* BEGIN AppOpticsAPM Support Report'
-    AppOpticsAPM.logger.warn '*   Please email the output of this report to support@appoptics.com'
+    AppOpticsAPM.logger.warn '*   Please email the output of this report to technicalsupport@solarwinds.com'
     AppOpticsAPM.logger.warn '********************************************************'
     AppOpticsAPM.logger.warn "Ruby: #{RUBY_DESCRIPTION}"
     AppOpticsAPM.logger.warn "$0: #{$0}"
@@ -108,7 +108,7 @@ module AppOpticsAPM
 
     AppOpticsAPM.logger.warn '********************************************************'
     AppOpticsAPM.logger.warn '* END AppOpticsAPM Support Report'
-    AppOpticsAPM.logger.warn '*   Support Email: support@appoptics.com'
+    AppOpticsAPM.logger.warn '*   Support Email: technicalsupport@solarwinds.com'
     AppOpticsAPM.logger.warn '*   Github: https://github.com/librato/ruby-appoptics'
     AppOpticsAPM.logger.warn '********************************************************'
 

data/lib/appoptics_apm/test.rb

@@ -54,8 +54,8 @@ module AppOpticsAPM
         if ENV.key?('TRAVIS_PSQL_PASS')
           ENV['DATABASE_URL'] = "postgresql://postgres:#{ENV['TRAVIS_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
         elsif ENV.key?('POSTGRES_USER')
-          ENV['DATABASE_URL'] = "postgresql://#{ENV['POSTGRES_PASSWORD']}:#{ENV['POSTGRES_USER']}@#{ENV['PSQL_HOST']}:5432/travis_ci_test"
-          # ENV['DATABASE_URL'] = "postgresql://postgres@#{ENV['PSQL_HOST']}:5432/travis_ci_test"
+          port = ENV.key?('POSTGRES_PORT') ? ENV['POSTGRES_PORT'] : 5432
+          ENV['DATABASE_URL'] = "postgresql://#{ENV['POSTGRES_PASSWORD']}:#{ENV['POSTGRES_USER']}@#{ENV['POSTGRES_HOST']}:#{port}/travis_ci_test"
         else
           ENV['DATABASE_URL'] = 'postgresql://postgres@127.0.0.1:5432/travis_ci_test'
         end
@@ -69,7 +69,8 @@ module AppOpticsAPM
         if ENV.key?('TRAVIS_MYSQL_PASS')
           ENV['DATABASE_URL'] = "mysql://root:#{ENV['TRAVIS_MYSQL_PASS']}@127.0.0.1:3306/travis_ci_test"
         elsif ENV.key?('DOCKER_MYSQL_PASS')
-          ENV['DATABASE_URL'] = "mysql://root:#{ENV['DOCKER_MYSQL_PASS']}@#{ENV['MYSQL_HOST']}:3306/travis_ci_test"
+          port = ENV.key?('MYSQL_PORT') ? ENV['MYSQL_PORT'] : 3306
+          ENV['DATABASE_URL'] = "mysql://root:#{ENV['DOCKER_MYSQL_PASS']}@#{ENV['MYSQL_HOST']}:#{port}/travis_ci_test"
         else
           ENV['DATABASE_URL'] = 'mysql://root@127.0.0.1:3306/travis_ci_test'
         end

data/lib/appoptics_apm/util.rb

@@ -275,7 +275,7 @@ module AppOpticsAPM
 
           # oboe not loaded yet, can't use oboe_api function to read oboe VERSION
           clib_version_file = File.join(Gem::Specification.find_by_name('appoptics_apm').gem_dir, 'ext', 'oboe_metal', 'src', 'VERSION')
-          platform_info['Ruby.AppOpticsExtension.Version'] = File.read(clib_version_file).chomp
+          platform_info['Ruby.AppOpticsExtension.Version'] = File.read(clib_version_file).strip
           platform_info['RubyHeroku.AppOpticsAPM.Version'] = AppOpticsAPMHeroku::Version::STRING if defined?(AppOpticsAPMHeroku)
           platform_info['Ruby.TraceMode.Version']          = AppOpticsAPM::Config[:tracing_mode]
 

data/lib/appoptics_apm/version.rb

@@ -6,9 +6,9 @@ module AppOpticsAPM
   # The current version of the gem.  Used mainly by
   # appoptics_apm.gemspec during gem build process
   module Version
-    MAJOR = 4  # breaking,
-    MINOR = 12 # feature,
-    PATCH = 2  # fix => BFF
+    MAJOR = 4 # breaking,
+    MINOR = 13 # feature,
+    PATCH = 0  # fix => BFF
     PRE   = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

data/lib/appoptics_apm/xtrace.rb

@@ -7,7 +7,7 @@ module AppOpticsAPM
   # value
   #
   # TODO add unit tests
-  module XTrace
+  class XTrace
     class << self
       ##
       #  AppOpticsAPM::XTrace.valid?

data/lib/appoptics_apm.rb

@@ -28,7 +28,7 @@ begin
       AppOpticsAPM.logger.warn "AppOptics warning: Platform #{RUBY_PLATFORM} not yet supported."
       AppOpticsAPM.logger.warn 'see: https://docs.appoptics.com/kb/apm_tracing/supported_platforms/'
       AppOpticsAPM.logger.warn 'Tracing disabled.'
-      AppOpticsAPM.logger.warn 'Contact support@appoptics.com if this is unexpected.'
+      AppOpticsAPM.logger.warn 'Contact technicalsupport@solarwinds.com if this is unexpected.'
       AppOpticsAPM.logger.warn '==================================================================='
     end
   rescue LoadError => e
@@ -46,6 +46,7 @@ begin
 
   if AppOpticsAPM.loaded
     require 'appoptics_apm/instrumentation'
+    require 'appoptics_apm/support/profiling'
     require 'appoptics_apm/support/transaction_metrics'
     require 'appoptics_apm/support/x_trace_options'
 
@@ -62,6 +63,7 @@ begin
     AppOpticsAPM.logger.warn '=============================================================='
     require 'appoptics_apm/noop/context'
     require 'appoptics_apm/noop/metadata'
+    require 'appoptics_apm/noop/profiling'
   end
 
   # Load Ruby module last.  If there is no framework detected,