appoptics_apm 4.4.1 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c47f21237c21b5074eae5806315b7abc78380b75a964385c611157d561ef9e9
-  data.tar.gz: cca745771a727e6e85fb2e5accfa380f20bd2932f2ecf0bf23fdf84d8fdbd923
+  metadata.gz: 54c8c572a8723e86a62a48fbd32aaa6659454ab9f463f06d8b46d268139c1a30
+  data.tar.gz: b147aa117802cee2b26e1362239fad37211979f13c52cb66a3784ab7c361490c
 SHA512:
-  metadata.gz: 97639be2a19811b48f8de96867b86d912727834108d3770ab10bb447e8be07de02a8e4b9db985a1227735980fb3831dd4338ccaa253c069feb3e250600c8a7ec
-  data.tar.gz: 6d7c6a513f80161d3848c9a857de69504d42deffe64d125390d8b98ffdbf017f8101e9afa326ee78fbbd04b6b1a1b713b52aded8cbd7c1b9331d57ca6ce80d96
+  metadata.gz: d0cd3f37c066dd3b3a5bc1a8449b1d2342f6f6292b412a61defe946abf77cbe67b3ee91180357784ad3303f370e34c93b9f5c76c195b4613c9ebff5dfd491f44
+  data.tar.gz: 5960b044aa3cd9ed21e22925504a215e935484d66427a3c29bd374ea19fb2c3eb76c8b035e2ffab8b7d20ee8bd51b2d05338c9630a08373d60d388a21c7f6006

data/.gitignore

@@ -4,6 +4,7 @@ gemfiles/*.lock
 .ruby-version
 *~
 *.swp
+.env
 lib/oboe_metal.so
 ext/oboe_metal/Makefile
 ext/oboe_metal/mkmf.log
@@ -24,4 +25,5 @@ swig*
 .yardoc
 coverage
 doc
-.*byebug*
+.*byebug*
+gemfiles/vendor*

data/.travis.yml

@@ -14,8 +14,8 @@ rvm:
   - 2.5.3
   - 2.4.5
   - 2.3.8
-#  - jruby-9.0.5.0
   - ruby-head
+#  - jruby-9.0.5.0
 
 gemfile:
   - gemfiles/libraries.gemfile

data/appoptics_apm.gemspec

@@ -41,11 +41,11 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
 
   s.add_runtime_dependency('json', '>= 0')
   s.add_runtime_dependency('no_proxy_fix', '~> 0.1.2', '>= 0.1.2')
-  s.add_runtime_dependency('simplecov', '>= 0.16.0') if ENV["SIMPLECOV_COVERAGE"]
-  s.add_runtime_dependency('simplecov-console', '>= 0.4.0') if ENV["SIMPLECOV_COVERAGE"]
 
   # Development dependencies used in gem development & testing
   s.add_development_dependency('rake', '>= 0.9.0')
+  s.add_development_dependency('simplecov', '>= 0.16.0') if ENV["SIMPLECOV_COVERAGE"]
+  s.add_development_dependency('simplecov-console', '>= 0.4.0') if ENV["SIMPLECOV_COVERAGE"]
 
   unless defined?(JRUBY_VERSION)
     s.add_development_dependency('byebug', '>= 8.0.0')

data/lib/appoptics_apm.rb

@@ -44,6 +44,7 @@ begin
     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'
@@ -59,6 +60,10 @@ begin
     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'
   end
 

data/lib/appoptics_apm/api/logging.rb

@@ -42,7 +42,7 @@ module AppOpticsAPM
       #   AppOpticsAPM::API.log('logical_layer', 'exit')
       #
       # Returns nothing.
-      def log(layer, label, opts = {}, event=nil)
+      def log(layer, label, opts = {}, event = nil)
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
         event ||= AppOpticsAPM::Context.createEvent

data/lib/appoptics_apm/api/metrics.rb

@@ -22,7 +22,7 @@ module  AppOpticsAPM
         start = Time.now
         yield
       ensure
-        duration =(1000 * 1000 * (Time.now - start)).round(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)
         AppOpticsAPM.transaction_name = nil

data/lib/appoptics_apm/config.rb

@@ -14,8 +14,8 @@ module AppOpticsAPM
     @@instrumentation = [:action_controller, :action_controller_api, :action_view,
                          :active_record, :bunnyclient, :bunnyconsumer, :cassandra, :curb,
                          :dalli, :delayed_jobclient, :delayed_jobworker,
-                         :em_http_request, :excon, :faraday, :grpc_client, :grape,
-                         :httpclient, :memcached, :mongo, :moped, :nethttp, :padrino, :rack, :redis,
+                         :em_http_request, :excon, :faraday, :grpc_client, :grpc_server, :grape,
+                         :httpclient, :nethttp, :memcached, :mongo, :moped, :padrino, :rack, :redis,
                          :resqueclient, :resqueworker, :rest_client,
                          :sequel, :sidekiqclient, :sidekiqworker, :sinatra, :typhoeus]
 

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

@@ -7,7 +7,7 @@ require 'appoptics_apm/frameworks/rails/inst/connection_adapters/postgresql'
 
 if AppOpticsAPM::Config[:active_record][:enabled] && !defined?(JRUBY_VERSION)
   begin
-    adapter = ActiveRecord::Base.configurations[Rails.env]['adapter']
+    adapter = ActiveRecord::Base.connection_config[:adapter]
 
     if Rails::VERSION::MAJOR < 5
       require 'appoptics_apm/frameworks/rails/inst/connection_adapters/utils'

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

@@ -20,15 +20,10 @@ module AppOpticsAPM
           opts[:Name] = name.to_s if name
           opts[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:active_record][:collect_backtraces]
 
-          if ::Rails::VERSION::MAJOR == 2
-            config = ::Rails.configuration.database_configuration[::Rails.env]
-          else
-            config = ActiveRecord::Base.connection.instance_variable_get(:@config)
-          end
-
+          config = ActiveRecord::Base.connection_config
           if config
-            opts[:Database]   = config['database'] if config.key?('database')
-            opts[:RemoteHost] = config['host']     if config.key?('host')
+            opts[:Database]   = config[:database] if config.key?(:database)
+            opts[:RemoteHost] = config[:host]     if config.key?(:host)
             adapter_name = config[:adapter]
 
             case adapter_name

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

@@ -26,15 +26,10 @@ module AppOpticsAPM
               opts[:Backtrace] = AppOpticsAPM::API.backtrace
             end
 
-            if ::Rails::VERSION::MAJOR == 2
-              config = ::Rails.configuration.database_configuration[::Rails.env]
-            else
-              config = ActiveRecord::Base.connection.instance_variable_get(:@config)
-            end
-
+            config = ActiveRecord::Base.connection_config
             if config
-              opts[:Database]   = config['database'] if config.key?('database')
-              opts[:RemoteHost] = config['host']     if config.key?('host')
+              opts[:Database]   = config[:database] if config.key?(:database)
+              opts[:RemoteHost] = config[:host]     if config.key?(:host)
               adapter_name = config[:adapter]
 
               case adapter_name
@@ -49,7 +44,7 @@ module AppOpticsAPM
             AppOpticsAPM.logger.debug e.backtrace.join('\n')
           end
 
-          opts || {}
+          opts
         end
 
         # We don't want to trace framework caches.  Only instrument SQL that

data/lib/appoptics_apm/inst/grpc_server.rb

@@ -0,0 +1,120 @@
+# Copyright (c) 2018 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module GRPC
+
+    if defined? ::GRPC
+      STATUSCODES = {}
+      ::GRPC::Core::StatusCodes.constants.each { |code| STATUSCODES[::GRPC::Core::StatusCodes.const_get(code)] = code }
+    end
+
+    module RpcDesc
+
+      def self.included(klass)
+        ::AppOpticsAPM::Util.method_alias(klass, :handle_request_response, ::GRPC::RpcDesc)
+        ::AppOpticsAPM::Util.method_alias(klass, :handle_client_streamer, ::GRPC::RpcDesc)
+        ::AppOpticsAPM::Util.method_alias(klass, :handle_server_streamer, ::GRPC::RpcDesc)
+        ::AppOpticsAPM::Util.method_alias(klass, :handle_bidi_streamer, ::GRPC::RpcDesc)
+        ::AppOpticsAPM::Util.method_alias(klass, :run_server_method, ::GRPC::RpcDesc)
+      end
+
+      def grpc_tags(active_call, mth)
+        tags = {
+            'Spec' => 'grpc_server',
+            'URL' => active_call.metadata['method'],
+            'Controller' => mth.owner.to_s,
+            'Action' => mth.name.to_s,
+            'HTTP-Host' => active_call.peer
+        }
+
+        if request_response?
+          tags['GRPCMethodType'] = 'UNARY'
+        elsif client_streamer?
+          tags['GRPCMethodType'] = 'CLIENT_STREAMING'
+        elsif server_streamer?
+          tags['GRPCMethodType'] = 'SERVER_STREAMING'
+        else  # is a bidi_stream
+          tags['GRPCMethodType'] = 'BIDI_STREAMING'
+        end
+
+        tags
+      end
+
+      def handle_request_response_with_appoptics(active_call, mth, inter_ctx)
+        handle_call('handle_request_response_without_appoptics', active_call, mth, inter_ctx)
+      end
+
+      def handle_client_streamer_with_appoptics(active_call, mth, inter_ctx)
+        handle_call('handle_client_streamer_without_appoptics', active_call, mth, inter_ctx)
+      end
+
+      def handle_server_streamer_with_appoptics(active_call, mth, inter_ctx)
+        handle_call('handle_server_streamer_without_appoptics', active_call, mth, inter_ctx)
+      end
+
+      def handle_bidi_streamer_with_appoptics(active_call, mth, inter_ctx)
+        handle_call('handle_bidi_streamer_without_appoptics', active_call, mth, inter_ctx)
+      end
+
+      # status codes need to be determined in this lower method, because they may not get raised to the
+      # next instrumented method
+      def handle_call(without, active_call, mth, inter_ctx)
+        begin
+          send(without, active_call, mth, inter_ctx)
+        rescue ::GRPC::Core::CallError, ::GRPC::BadStatus, ::GRPC::Core::OutOfTime, StandardError, NotImplementedError => e
+          log_grpc_exception(active_call, e)
+          raise e
+        end
+      end
+
+      def run_server_method_with_appoptics(active_call, mth, inter_ctx)
+        tags = grpc_tags(active_call, mth)
+        AppOpticsAPM::API.log_start('grpc-server', active_call.metadata['x-trace'], tags)
+
+        exit_event = AppOpticsAPM::Event.startTrace(AppOpticsAPM::Context.get)
+        active_call.merge_metadata_to_send({ 'x-trace' => exit_event.metadataString })
+        begin
+          AppOpticsAPM::API.send_metrics('grpc-server', tags) do
+            run_server_method_without_appoptics(active_call, mth, inter_ctx)
+          end
+        rescue => e
+          log_grpc_exception(active_call, e)
+          raise e
+        ensure
+          tags['GRPCStatus'] = active_call.metadata_to_send.delete('grpc_status')
+          tags['GRPCStatus'] ||= active_call.status ? AppOpticsAPM::GRPC::STATUSCODES[active_call.status.code].to_s : 'OK'
+          tags['Backtrace'] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:grpc_server][:collect_backtraces]
+
+          exit_event.addEdge(AppOpticsAPM::Context.get)
+          AppOpticsAPM::API.log_end('grpc-server', tags, exit_event)
+        end
+      end
+
+      private
+
+      def log_grpc_exception(active_call, e)
+        unless e.instance_variable_get(:@exn_logged)
+          AppOpticsAPM::API.log_exception('grpc-server', e)
+
+          unless active_call.metadata_sent
+            if e.class == ::GRPC::Core::OutOfTime
+              active_call.merge_metadata_to_send({ 'grpc_status' => 'DEADLINE_EXCEEDED' })
+            elsif e.respond_to?(:code)
+              active_call.merge_metadata_to_send({ 'grpc_status' =>  AppOpticsAPM::GRPC::STATUSCODES[e.code].to_s })
+            else
+              active_call.merge_metadata_to_send({ 'grpc_status' =>  'UNKNOWN' })
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end
+
+if defined?(GRPC) && AppOpticsAPM::Config['grpc_server'][:enabled]
+  # server side is instrumented in RpcDesc
+  AppOpticsAPM::Util.send_include(GRPC::RpcDesc, AppOpticsAPM::GRPC::RpcDesc)
+end

data/lib/appoptics_apm/version.rb

@@ -7,8 +7,8 @@ module AppOpticsAPM
   # appoptics_apm.gemspec during gem build process
   module Version
     MAJOR = 4
-    MINOR = 4
-    PATCH = 1
+    MINOR = 5
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/oboe_metal.rb

@@ -31,8 +31,13 @@ module AppOpticsAPM
           when 'udp'
             ENV['APPOPTICS_REPORTER_UDP'] = "#{AppOpticsAPM::Config[:reporter_host]}:#{AppOpticsAPM::Config[:reporter_port]}"
           else # default is ssl, service_key is mandatory
-            if AppOpticsAPM::Config[:service_key].to_s == '' && ENV['APPOPTICS_SERVICE_KEY'].to_s == ''
-              AppOpticsAPM.logger.warn "[appoptics_apm/warn] APPOPTICS_SERVICE_KEY not set. Cannot submit data."
+            service_key = ENV['APPOPTICS_SERVICE_KEY'].to_s || AppOpticsAPM::Config[:service_key].to_s
+            if service_key == ''
+              AppOpticsAPM.logger.warn '[appoptics_apm/warn] APPOPTICS_SERVICE_KEY not set. Cannot submit data.'
+              AppOpticsAPM.loaded = false
+              return
+            elsif service_key !~ /^[0-9a-fA-F]{64}:[-.:_?\\\/\w ]{1,255}$/
+              AppOpticsAPM.logger.warn '[appoptics_apm/warn] APPOPTICS_SERVICE_KEY problem. No service name or api token in wrong format. Cannot submit data.'
               AppOpticsAPM.loaded = false
               return
             end

data/lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb

@@ -177,6 +177,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:excon][:enabled] = true
   AppOpticsAPM::Config[:faraday][:enabled] = true
   AppOpticsAPM::Config[:grpc_client][:enabled] = true
+  AppOpticsAPM::Config[:grpc_server][:enabled] = true
   AppOpticsAPM::Config[:grape][:enabled] = true
   AppOpticsAPM::Config[:httpclient][:enabled] = true
   AppOpticsAPM::Config[:memcached][:enabled] = true
@@ -243,6 +244,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:faraday][:collect_backtraces] = false
   AppOpticsAPM::Config[:grape][:collect_backtraces] = true
   AppOpticsAPM::Config[:grpc_client][:collect_backtraces] = false
+  AppOpticsAPM::Config[:grpc_server][:collect_backtraces] = false
   AppOpticsAPM::Config[:httpclient][:collect_backtraces] = true
   AppOpticsAPM::Config[:memcached][:collect_backtraces] = false
   AppOpticsAPM::Config[:mongo][:collect_backtraces] = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.5.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -193,6 +193,7 @@ files:
 - lib/appoptics_apm/inst/excon.rb
 - lib/appoptics_apm/inst/faraday.rb
 - lib/appoptics_apm/inst/grpc_client.rb
+- lib/appoptics_apm/inst/grpc_server.rb
 - lib/appoptics_apm/inst/http.rb
 - lib/appoptics_apm/inst/httpclient.rb
 - lib/appoptics_apm/inst/memcached.rb