appoptics_apm 4.12.1 → 4.12.2

data/README.md

@@ -12,8 +12,10 @@ It requires an [AppOptics](https://www.appoptics.com/) account to view metrics.
 [it's free](https://my.appoptics.com/sign_up).
 
 [![Gem Version](https://badge.fury.io/rb/appoptics_apm.svg)](https://badge.fury.io/rb/appoptics_apm)
-[![Build Status](https://travis-ci.org/appoptics/appoptics-apm-ruby.png?branch=master)](https://travis-ci.org/appoptics/appoptics-apm-ruby)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ac7f36241a23a3a82fc5/maintainability)](https://codeclimate.com/github/appoptics/appoptics-apm-ruby/maintainability)
+
+[comment]: <> ([![Build Status]&#40;https://travis-ci.org/appoptics/appoptics-apm-ruby.png?branch=master&#41;]&#40;https://travis-ci.org/appoptics/appoptics-apm-ruby&#41;)
+
+[comment]: <> ([![Maintainability]&#40;https://api.codeclimate.com/v1/badges/ac7f36241a23a3a82fc5/maintainability&#41;]&#40;https://codeclimate.com/github/appoptics/appoptics-apm-ruby/maintainability&#41;)
 
 _Note: The repository is now at https://github.com/appoptics/appoptics-apm-ruby  Please update your github remotes with 
 `git remote set-url origin git@github.com:appoptics/appoptics-apm-ruby.git`._

data/appoptics_apm.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.version = AppOpticsAPM::Version::STRING
   s.date = Time.now.strftime('%Y-%m-%d')
 
-  s.license = "Librato Open License, Version 1.0, https://bit.ly/2Kmm0mN"
+  s.license = "Apache-2.0"
 
   s.authors = ["Maia Engeli", "Peter Giacomo Lombardo", "Spiros Eliopoulos"]
   s.email = %q{support@appoptics.com}
@@ -26,9 +26,10 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
   s.extra_rdoc_files = ['LICENSE']
   s.files = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|gemfiles)/}) }
   s.files += ['ext/oboe_metal/src/oboe.h',
-              'ext/oboe_metal/src/oboe.hpp',
+              'ext/oboe_metal/src/oboe_api.cpp',
+              'ext/oboe_metal/src/oboe_api.hpp',
               'ext/oboe_metal/src/oboe_debug.h',
-              'ext/oboe_metal/src/oboe_wrap.cxx',
+              'ext/oboe_metal/src/oboe_swig_wrap.cc',
               'ext/oboe_metal/src/bson/bson.h',
               'ext/oboe_metal/src/bson/platform_hacks.h',
               'ext/oboe_metal/src/VERSION']

data/ext/oboe_metal/README.md

@@ -5,7 +5,7 @@ inspired by: https://dev.to/wataash/how-to-create-and-debug-ruby-gem-with-c-nati
 
 ## install ruby with sources
 
-rbenv is your friend ;) 😄 -k means keep sources
+rbenv is your friend ;) -k means keep sources
 
 ```
 rbenv install -k 2.6.3
@@ -66,4 +66,4 @@ Some inspiring examples here:
 
 https://jvns.ca/blog/2016/06/12/a-weird-system-call-process-vm-readv/
 
-https://medium.com/@zanker/finding-a-ruby-bug-with-gdb-56d6b321bc86
+https://medium.com/@zanker/finding-a-ruby-bug-with-gdb-56d6b321bc86

data/ext/oboe_metal/extconf.rb

@@ -8,6 +8,16 @@ require 'rbconfig'
 require 'open-uri'
 require 'no_proxy_fix'
 
+CONFIG['warnflags'] = CONFIG['warnflags'].gsub(/-Wdeclaration-after-statement/, '')
+                        .gsub(/-Wimplicit-function-declaration/, '')
+                        .gsub(/-Wimplicit-int/, '')
+                        .gsub(/-Wno-tautological-compare/, '')
+                        .gsub(/-Wno-self-assign/, '')
+                        .gsub(/-Wno-parentheses-equality/, '')
+                        .gsub(/-Wno-constant-logical-operand/, '')
+                        .gsub(/-Wno-cast-function-type/, '')
+init_mkmf(CONFIG)
+
 ext_dir = File.expand_path(File.dirname(__FILE__))
 
 # Check if we're running in JRuby
@@ -21,7 +31,7 @@ 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)
+  ao_path = File.join('https://rc-files-t2.s3-us-west-2.amazonaws.com/c-lib/', version)
   puts 'Fetching c-lib from S3'
 else
   ao_path = File.join('https://files.appoptics.com/c-lib', version)
@@ -29,7 +39,13 @@ end
 
 ao_arch = 'x86_64'
 if File.exist?('/etc/alpine-release')
-  version = open('/etc/alpine-release').read.chomp
+
+  if RUBY_VERSION < '2.5.0'
+    version = open('/etc/alpine-release').read.chomp
+  else
+    version = URI.open('/etc/alpine-release').read.chomp
+  end
+
   ao_arch =
     if Gem::Version.new(version) < Gem::Version.new('3.9')
       'alpine-libressl-x86_64'
@@ -48,13 +64,16 @@ success = false
 while retries > 0
   begin
     # download
-    # TODO warning: calling URI.open via Kernel#open is deprecated, call URI.open directly or use URI#open
-    # ____ URI.open is not supported in 2.4.5, let's use open until we can deprecate 2.4.5
-    download = open(ao_item, 'rb')
+    if RUBY_VERSION < '2.5.0'
+      download = open(ao_item, 'rb')
+      checksum = open(ao_checksum_item, 'r').read.chomp
+    else
+      download = URI.open(ao_item, 'rb')
+      checksum = URI.open(ao_checksum_item, 'r').read.chomp
+    end
     IO.copy_stream(download, clib)
-
-    checksum = open(ao_checksum_item, 'r').read.chomp
     clib_checksum = Digest::SHA256.file(clib).hexdigest
+    download.close
 
     # verify_checksum
     if clib_checksum != checksum
@@ -77,7 +96,7 @@ while retries > 0
       $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 "error: #{ao_item}\n#{e.message}"
       $stderr.puts '==================================================================='
       create_makefile('oboe_noop', 'noop')
     end
@@ -107,11 +126,21 @@ if success
     $libs = append_library($libs, 'stdc++')
 
     $CFLAGS << " #{ENV['CFLAGS']}"
-    $CPPFLAGS << " #{ENV['CPPFLAGS']}"
+    # $CPPFLAGS << " #{ENV['CPPFLAGS']} -std=c++11"
+    # TODO for debugging: -pg -gdwarf-2, remove for production
+    # $CPPFLAGS << " #{ENV['CPPFLAGS']} -std=c++11 -pg -gdwarf-2 -I$$ORIGIN/../ext/oboe_metal/include -I$$ORIGIN/../ext/oboe_metal/src"
+    $CPPFLAGS << " #{ENV['CPPFLAGS']} -std=c++11 -I$$ORIGIN/../ext/oboe_metal/include"
     $LIBS << " #{ENV['LIBS']}"
-    $LDFLAGS << " #{ENV['LDFLAGS']} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib'"
+    $LDFLAGS << " #{ENV['LDFLAGS']} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib'  -pg -lrt"
+    # $LDFLAGS << " #{ENV['LDFLAGS']} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib'"
+    $CXXFLAGS += " -std=c++11 "
+
+    # ____ include debug info, comment out when not debugging
+    # ____ -pg -> profiling info for gprof
+    # CONFIG["debugflags"] = "-ggdb3 -pg"
+    # CONFIG["optflags"] = "-O0"
 
-    create_makefile('oboe_metal', 'src')
+    create_makefile('libappoptics_apm', 'src')
 
   else
     $stderr.puts   '== ERROR ========================================================='

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-10.0.0
+10.1.0

data/ext/oboe_metal/src/init_appoptics_apm.cc

@@ -0,0 +1,20 @@
+#include <iostream>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void Init_oboe_metal(void);
+
+//void Init_profiling(void);
+
+void Init_libappoptics_apm() {
+    Init_oboe_metal();
+//     std::cout << "*** oboe_metal initialized ***" << std::endl;
+//    Init_profiling();
+//     std::cout << "*** profiling intitialized ***" << std::endl;
+}
+
+#ifdef __cplusplus
+}
+#endif

data/lib/appoptics_apm.rb

@@ -20,7 +20,7 @@ begin
       require '/usr/local/tracelytics/tracelyticsagent.jar'
       require 'joboe_metal'
     elsif RUBY_PLATFORM =~ /linux/
-      require_relative './oboe_metal.so'
+      require_relative './libappoptics_apm.so'
       require 'appoptics_apm/oboe_init_options'
       require 'oboe_metal.rb'  # sets AppOpticsAPM.loaded = true if successful
     else

data/lib/appoptics_apm/api/metrics.rb

@@ -22,9 +22,12 @@ module  AppOpticsAPM
         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] = AppOpticsAPM::Span.createSpan(transaction_name, nil, duration)
+        kvs[:TransactionName] = AppOpticsAPM::Span.createSpan(transaction_name, nil, duration, error)
         AppOpticsAPM.transaction_name = nil
       end
 

data/lib/appoptics_apm/frameworks/rails/inst/action_view.rb

@@ -6,35 +6,78 @@ if defined?(ActionView::Base) && AppOpticsAPM::Config[:action_view][:enabled]
   if Rails::VERSION::MAJOR >= 4
 
     AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting actionview' if AppOpticsAPM::Config[:verbose]
+    if ActionView.version >= Gem::Version.new('6.1.0') # the methods changed in this version
 
-    ActionView::PartialRenderer.class_eval do
-      alias :render_partial_without_appoptics :render_partial
-      def render_partial(*args)
-        entry_kvs = {}
-        begin
-          entry_kvs[:Partial] = AppOpticsAPM::Util.prettify(@options[:partial]) if @options.is_a?(Hash)
-        rescue => e
-          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+      ActionView::PartialRenderer.class_eval do
+        alias :render_partial_template_without_appoptics :render_partial_template
+
+        def render_partial_template(*args)
+          _, _, template, _, _ = args
+          entry_kvs = {}
+          begin
+            entry_kvs[:Partial] = template.virtual_path
+          rescue => e
+            AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+          end
+          AppOpticsAPM::SDK.trace(:partial, entry_kvs) do
+            entry_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_view][:collect_backtraces]
+            render_partial_template_without_appoptics(*args)
+          end
         end
+      end
+
+      ActionView::CollectionRenderer.class_eval do
+        alias :render_collection_without_appoptics :render_collection
 
-        AppOpticsAPM::SDK.trace('partial', entry_kvs) do
-          entry_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_view][:collect_backtraces]
-          render_partial_without_appoptics(*args)
+        def render_collection(*args)
+          _, _, _, template, _, _ = args
+          entry_kvs = {}
+          begin
+            entry_kvs[:Partial] = template.virtual_path
+          rescue => e
+            AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+          end
+          AppOpticsAPM::SDK.trace(:collection, entry_kvs) do
+            entry_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_view][:collect_backtraces]
+            render_collection_without_appoptics(*args)
+          end
         end
       end
 
-      alias :render_collection_without_appoptics :render_collection
-      def render_collection(*args)
-        entry_kvs = {}
-        begin
-          entry_kvs[:Partial] = AppOpticsAPM::Util.prettify(@path)
-        rescue => e
-          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+    else # Rails < 6.1.0
+
+      ActionView::PartialRenderer.class_eval do
+        alias :render_partial_without_appoptics :render_partial
+        def render_partial(*args)
+          template = @template || args[1]
+          entry_kvs = {}
+          begin
+            entry_kvs[:Partial] = template.virtual_path
+            # entry_kvs[:Partial] = AppOpticsAPM::Util.prettify(@options[:partial]) if @options.is_a?(Hash)
+          rescue => e
+            AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+          end
+
+          AppOpticsAPM::SDK.trace('partial', entry_kvs) do
+            entry_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_view][:collect_backtraces]
+            render_partial_without_appoptics(*args)
+          end
         end
 
-        AppOpticsAPM::SDK.trace('collection', entry_kvs) do
-          entry_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_view][:collect_backtraces]
-          render_collection_without_appoptics(*args)
+        alias :render_collection_without_appoptics :render_collection
+        def render_collection(*args)
+          template = @template || args[1]
+          entry_kvs = {}
+          begin
+            entry_kvs[:Partial] = template.virtual_path
+          rescue => e
+            AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+          end
+
+          AppOpticsAPM::SDK.trace('collection', entry_kvs) do
+            entry_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_view][:collect_backtraces]
+            render_collection_without_appoptics(*args)
+          end
         end
       end
 

data/lib/appoptics_apm/inst/http.rb

@@ -4,70 +4,78 @@
 require 'net/http'
 
 if AppOpticsAPM::Config[:nethttp][:enabled]
-
-  Net::HTTP.class_eval do
-    def request_with_appoptics(*args, &block)
-      # Avoid cross host tracing for blacklisted domains
-      blacklisted = AppOpticsAPM::API.blacklisted?(addr_port)
-
-      # If we're not tracing, just do a fast return. Since
-      # net/http.request calls itself, only trace
-      # once the http session has been started.
-      if !AppOpticsAPM.tracing? || !started?
-        unless blacklisted
-          xtrace = AppOpticsAPM::Context.toString
-          args[0]['X-Trace'] = xtrace if AppOpticsAPM::XTrace.valid?(xtrace)
-        end
-        return request_without_appoptics(*args, &block)
-      end
-
-      opts = {}
-      AppOpticsAPM::API.trace(:'net-http', opts) do
-        context = AppOpticsAPM::Context.toString
-        # task_id = AppOpticsAPM::XTrace.task_id(context)
-
-        # Collect KVs to report in the info event
-        if args.respond_to?(:first) && args.first
-          req = args.first
-
-          opts[:Spec] = 'rsc'
-          opts[:IsService] = 1
-          opts[:RemoteURL] = "#{use_ssl? ? 'https' : 'http'}://#{addr_port}"
-          opts[:RemoteURL] << (AppOpticsAPM::Config[:nethttp][:log_args] ? req.path : req.path.split('?').first)
-          opts[:HTTPMethod] = req.method
-          opts[:Blacklisted] = true if blacklisted
-          opts[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:nethttp][:collect_backtraces]
-
-          req['X-Trace'] = context unless blacklisted
-        end
-
-        begin
-          # The actual net::http call
-          resp = request_without_appoptics(*args, &block)
-
-          # Re-attach net::http edge unless blacklisted and is a valid X-Trace ID
-          unless blacklisted
-            xtrace = resp.get_fields('X-Trace')
-            xtrace = xtrace[0] if xtrace && xtrace.is_a?(Array)
-
-            AppOpticsAPM::XTrace.continue_service_context(context, xtrace)
+  module AppOpticsAPM
+    module Inst
+      module NetHttp
+        # Net::HTTP.class_eval do
+        # def request_with_appoptics(*args, &block)
+        def request(*args, &block)
+          # Avoid cross host tracing for blacklisted domains
+          blacklisted = AppOpticsAPM::API.blacklisted?(addr_port)
+
+          # If we're not tracing, just do a fast return. Since
+          # net/http.request calls itself, only trace
+          # once the http session has been started.
+          if !AppOpticsAPM.tracing? || !started?
+            if blacklisted # if the other site is blacklisted, we don't want to leak its X-trace
+              resp = super
+              resp.delete('X-Trace') # if resp['X-Trace']
+              return resp
+            else
+              xtrace = AppOpticsAPM::Context.toString
+              args[0]['X-Trace'] = xtrace if AppOpticsAPM::XTrace.valid?(xtrace)
+              return super
+            end
           end
 
-          opts[:HTTPStatus] = resp.code
-
-          # If we get a redirect, report the location header
-          if ((300..308).to_a.include? resp.code.to_i) && resp.header["Location"]
-            opts[:Location] = resp.header["Location"]
+          opts = {}
+          AppOpticsAPM::API.trace(:'net-http', opts) do
+            context = AppOpticsAPM::Context.toString
+
+            # Collect KVs to report in the exit event
+            if args.respond_to?(:first) && args.first
+              req = args.first
+
+              opts[:Spec] = 'rsc'
+              opts[:IsService] = 1
+              opts[:RemoteURL] = "#{use_ssl? ? 'https' : 'http'}://#{addr_port}"
+              opts[:RemoteURL] << (AppOpticsAPM::Config[:nethttp][:log_args] ? req.path : req.path.split('?').first)
+              opts[:HTTPMethod] = req.method
+              opts[:Blacklisted] = true if blacklisted
+              opts[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:nethttp][:collect_backtraces]
+
+              req['X-Trace'] = context unless blacklisted
+            end
+
+            begin
+              # The actual net::http call
+              resp = super
+              # Re-attach net::http edge unless blacklisted and is a valid X-Trace ID
+              xtrace = resp.get_fields('X-Trace')
+              if blacklisted
+                # we don't want the x-trace if it is from a blacklisted address
+                resp.delete('X-Trace') # if xtrace
+              else
+                xtrace = xtrace[0] if xtrace && xtrace.is_a?(Array)
+                AppOpticsAPM::XTrace.continue_service_context(context, xtrace)
+              end
+
+              opts[:HTTPStatus] = resp.code
+
+              # If we get a redirect, report the location header
+              if ((300..308).to_a.include? resp.code.to_i) && resp.header["Location"]
+                opts[:Location] = resp.header["Location"]
+              end
+
+              next resp
+            end
           end
-
-          next resp
         end
+
       end
     end
-
-    alias request_without_appoptics request
-    alias request request_with_appoptics
-
-    AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting net/http' if AppOpticsAPM::Config[:verbose]
   end
+
+  Net::HTTP.prepend(AppOpticsAPM::Inst::NetHttp)
+  AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting net/http' if AppOpticsAPM::Config[:verbose]
 end

data/lib/appoptics_apm/oboe_init_options.rb

@@ -8,7 +8,7 @@ module AppOpticsAPM
   class OboeInitOptions
     include Singleton
 
-    attr_reader :reporter, :host, :service_name, :ec2_md_timeout  # exposing these mainly for testing
+    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
@@ -71,6 +71,7 @@ module AppOpticsAPM
       @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
     end
 
     def re_init # for testing with changed ENV vars
@@ -97,7 +98,8 @@ module AppOpticsAPM
         @token_bucket_capacity,
         @token_bucket_rate,
         @file_single,
-        @ec2_md_timeout
+        @ec2_md_timeout,
+        @grpc_proxy
       ]
     end
 
@@ -183,11 +185,23 @@ module AppOpticsAPM
     end
 
     def read_and_validate_ec2_md_timeout
-      timeout = (ENV['APPOPTICS_EC2_METADATA_TIMEOUT'] || AppOpticsAPM::Config[:ec2_metadata_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