appoptics_apm 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2241f5dc133a92728858f309f3e6170375eb4a8
-  data.tar.gz: 1f15fd34cdfefc40f301023978e9c45d829da646
+  metadata.gz: 14962bf4e9f8b8b81ca0e153a11aea4d14d6e301
+  data.tar.gz: 2738dbd25b94e1b2339958ca83ed68e1d9cfd4d3
 SHA512:
-  metadata.gz: ed57137d9aeafe9887869d77489e154ab655595e71d2ad0d5a49163f23fb7da76b4719405059eb5ed065fc5a3440f9c4ef9377c1630dd4c6074a640a4c88c131
-  data.tar.gz: ea25849f7ba00ce4cf66e82322fff7a7d6a015159bd2e7c31182650353abb99f901acaa567a139a0a3a99de0d9ef6053abaec6cdf795b8ca3f440a8f7ad9fa3c
+  metadata.gz: b0a701a61d0a71efeb0a046c8c2ed2aa34d0fb73ae7ae9d9cab4c04b60f46bec5a9c99ed10bde6c98a0f2d042742b0c280c7ce51b8786df9903306a0ea2e000a
+  data.tar.gz: acc3f8518f0afeb4023ba7d80f0d2168b240189c3321f43a057bb857827d0f82267d121ac41b5b4b5158ea14deda3d546af0996c1007dc6e4ab0d53a2f9ec350

data/.travis.yml

@@ -12,6 +12,7 @@ rvm:
 #  - jruby-9.0.5.0
 
 gemfile:
+  - gemfiles/noop.gemfile
   - gemfiles/libraries.gemfile
   - gemfiles/instrumentation_mocked.gemfile
   - gemfiles/frameworks.gemfile

data/Dockerfile_test

@@ -19,6 +19,7 @@ RUN apt-get update \
        less \
        tree \
        psmisc \
+       swig \
     && rm -rf /var/lib/apt/lists/*
 
 # rbenv setup
@@ -38,12 +39,12 @@ RUN .  ~/.profile \
 #    && rbenv install jruby-9.0.5.0
 
 # install swig 3.0.8
-RUN curl -SL http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.8/swig-3.0.8.tar.gz \
-    | tar xzC /tmp \
-    && cd /tmp/swig-3.0.8 \
-    && ./configure && make && make install \
-    && cd \
-    && rm -rf /tmp/swig-3.0.8
+#git statuRUN curl -SL http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.8/swig-3.0.8.tar.gz \
+#    | tar xzC /tmp \
+#    && cd /tmp/swig-3.0.8 \
+#    && ./configure && make && make install \
+#    && cd \
+#    && rm -rf /tmp/swig-3.0.8
 
 # install postgres, redis, and memcached
 RUN apt-get update \

data/Rakefile

@@ -51,6 +51,8 @@ Rake::TestTask.new do |t|
   when /instrumentation_mocked/
     # WebMock is interfering with other tests, so these have to run seperately
     t.test_files = FileList['test/mocked/*_test.rb']
+  when /noop/
+    t.test_files = FileList['test/noop/*_test.rb']
   end
 
   if defined?(JRUBY_VERSION)

data/docker-compose.yml

@@ -34,6 +34,28 @@ services:
        - MYSQL_HOST=mysql
        - APPOPTICS_MONGO_SERVER=mongo
 
+  ruby_appoptics_apm_alpine:
+     container_name: ruby_appoptics_apm_alpine
+     image: ruby_alpine
+     build:
+        context: .
+        dockerfile: ./Dockerfile_alpine
+     cpu_quota: 100000 # 1 cpu, assumes cpu_period of 1 second
+     mem_limit: 1G
+     volumes:
+       - .:/code/ruby-appoptics_apm
+     depends_on:
+       - wait
+     links:
+       - wait
+     environment:
+       - APPOPTICS_RABBITMQ_SERVER=rabbitmq
+       - DOCKER_MYSQL_PASS=admin
+       - MYSQL_ALLOW_EMPTY_PASSWORD=yes
+       - MYSQL_ROOT_PASSWORD=admin
+       - MYSQL_HOST=mysql
+       - APPOPTICS_MONGO_SERVER=mongo
+
   rabbitmq:
     container_name: rabbitmq
     image: rabbitmq:3-management

data/gemfiles/noop.gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+group :development, :test do
+  gem 'minitest'
+  gem 'minitest-reporters', '< 1.0.18'
+  gem 'minitest-debugger', :require => false
+  gem 'mocha'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'bson', '~> 4.0'
+  gem 'puma', '< 3.1.0'
+  if RUBY_VERSION >= '2.0.0'
+    gem 'webmock'
+  end
+end
+
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')

data/lib/appoptics_apm.rb

@@ -25,8 +25,8 @@ begin
         require '/usr/local/tracelytics/tracelyticsagent.jar'
         require 'joboe_metal'
       elsif RUBY_PLATFORM =~ /linux/
-        require "oboe_metal.so"
-        require "oboe_metal.rb"  # sets AppOpticsAPM.loaded = true  if successful
+        require '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."

data/lib/appoptics_apm/api.rb

@@ -4,8 +4,7 @@
 module AppOpticsAPM
   ##
   # This module implements the AppOpticsAPM tracing API.
-  # See: https://github.com/librato/ruby-appoptics#the-tracing-api
-  # and/or: http://rdoc.info/gems/appoptics_apm/AppOpticsAPM/API/Tracing
+  # See: https://docs.appoptics.com/kb/apm_tracing/ruby/sdk/
   module API
     def self.extend_with_tracing
       extend AppOpticsAPM::API::Logging

data/lib/appoptics_apm/api/layerinit.rb

@@ -7,7 +7,7 @@ module AppOpticsAPM
   module API
     ##
     # Provides methods related to layer initialization and reporting
-    module LayerInit
+    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.
@@ -22,6 +22,8 @@ module AppOpticsAPM
       end
 
       ##
+      # :nodoc:
+      # Deprecated:
       # force_trace has been deprecated and will be removed in a subsequent version.
       #
       def force_trace

data/lib/appoptics_apm/api/logging.rb

@@ -85,7 +85,7 @@ module AppOpticsAPM
       # Public: Decide whether or not to start a trace, and report an entry event
       # appropriately.
       #
-      # ==== Attributes
+      # ==== Arguments
       #
       # * +layer+ - The layer the reported event belongs to
       # * +xtrace+ - An xtrace metadata string, or nil.  Used for cross-application tracing.
@@ -95,7 +95,7 @@ module AppOpticsAPM
       #
       #   AppOpticsAPM::API.log_start(:layer_name, nil, { :id => @user.id })
       #
-      # Returns an xtrace metadata string
+      # 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]))
 
@@ -169,7 +169,7 @@ module AppOpticsAPM
       ##
       # Public: Report an exit event and potentially clear the tracing context.
       #
-      # ==== Attributes
+      # ==== 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).
@@ -178,14 +178,15 @@ module AppOpticsAPM
       #
       #   AppOpticsAPM::API.log_end(:layer_name, { :id => @user.id })
       #
-      # Returns an xtrace metadata string
+      # Returns an xtrace metadata string if we are tracing
       def log_end(layer, opts = {})
         return unless AppOpticsAPM.tracing?
 
-        log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts)
+        log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts) if AppOpticsAPM.tracing?
         AppOpticsAPM::Context.toString
       ensure
-        AppOpticsAPM::Context.clear unless AppOpticsAPM.has_incoming_context?
+        # FIXME has_incoming_context commented out, it has importance for JRuby only and breaks ruby tests
+        AppOpticsAPM::Context.clear # unless AppOpticsAPM.has_incoming_context?
       end
 
       ##
@@ -193,17 +194,17 @@ module AppOpticsAPM
       #
       # A helper method to create and log an entry event
       #
-      # ==== Attributes
+      # ==== Arguments
       #
       # * +layer+ - The layer the reported event belongs to
-      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      # * +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
+      # Returns an xtrace metadata string if we are tracing
       def log_entry(layer, opts = {}, op = nil)
         return unless AppOpticsAPM.tracing?
 
@@ -216,7 +217,7 @@ module AppOpticsAPM
       #
       # A helper method to create and log an info event
       #
-      # ==== Attributes
+      # ==== 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).
@@ -225,11 +226,11 @@ module AppOpticsAPM
       #
       #   AppOpticsAPM::API.log_info(:layer_name, { :id => @user.id })
       #
-      # Returns an xtrace metadata string
-      def log_info(layer, kvs = {})
+      # Returns an xtrace metadata string if we are tracing
+      def log_info(layer, opts = {})
         return unless AppOpticsAPM.tracing?
 
-        log_event(layer, :info, AppOpticsAPM::Context.createEvent, kvs)
+        log_event(layer, :info, AppOpticsAPM::Context.createEvent, opts)
       end
 
       ##
@@ -237,21 +238,22 @@ module AppOpticsAPM
       #
       # A helper method to create and log an exit event
       #
-      # ==== Attributes
+      # ==== 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+ - deprecated, has been used to avoid double tracing recursive calls, but is irrelevant in +log_exit+
+      # * +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 (TODO: does it?)
-      def log_exit(layer, opts = {}, _op = nil)
+      # Returns an xtrace metadata string  if we are tracing
+      def log_exit(layer, opts = {}, op = nil)
         return unless AppOpticsAPM.tracing?
 
-        AppOpticsAPM.layer_op = nil
+        AppOpticsAPM.layer_op = nil if op
         log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts)
       end
 
@@ -262,7 +264,7 @@ module AppOpticsAPM
       # If we return from a request that faned out multiple requests
       # we can add the collected X-Traces to the exit event
       #
-      # ==== Attributes
+      # ==== Arguments
       #
       # * +layer+ - The layer the reported event belongs to
       # * +traces+ - An array with X-Trace strings returned from the requests
@@ -281,15 +283,13 @@ module AppOpticsAPM
       #:nodoc:
       # Internal: Reports agent init to the collector
       #
-      # ==== Attributes
+      # ==== 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
-        if !context.isValid
-          return
-        end
+        return unless context.isValid
 
         event = context.createEvent
         event.addInfo(APPOPTICS_STR_LAYER, layer.to_s)
@@ -307,7 +307,7 @@ module AppOpticsAPM
       #:nodoc:
       # Internal: Report an event.
       #
-      # ==== Attributes
+      # ==== Arguments
       #
       # * +layer+ - The layer the reported event belongs to
       # * +label+ - The label for the reported event.  See API documentation for reserved labels and usage.

data/lib/appoptics_apm/api/memcache.rb

@@ -3,11 +3,13 @@
 # All rights reserved.
 #++
 
+# TODO remove Memcache from API and into some Util module to be included in Modules that need
+# ____ these methods
 module AppOpticsAPM
   module API
     ##
     # Utility methods for the Memcache instrumentation
-    module Memcache
+    module Memcache #:nodoc:
       MEMCACHE_OPS = %w(add append cas decr decrement delete fetch get incr increment prepend replace set)
 
       def memcache_hit?(result)

data/lib/appoptics_apm/api/profiling.rb

@@ -6,19 +6,21 @@
 module AppOpticsAPM
   module API
     ##
-    # Module that provides profiling of arbitrary blocks of code
+    # Module to create profiling traces for blocks of code or methods
     module Profiling
       ##
       # Public: Profile a given block of code. Detect any exceptions thrown by
       # the block and report errors.
       #
-      # profile_name - A name used to identify the block being profiled.
-      # report_kvs - A hash containing key/value pairs that will be reported along
-      #              with the event of this profile (optional).
-      # with_backtrace - Boolean to indicate whether a backtrace should
-      #                  be collected with this trace event.
+      # ==== Arguments
       #
-      # Example
+      # * +profile_name+ - A name used to identify the block being profiled.
+      # * +report_kvs+ - A hash containing key/value pairs that will be reported along
+      #   with the event of this profile (optional).
+      # * +with_backtrace+ - Boolean to indicate whether a backtrace should
+      #   be collected with this trace event.
+      #
+      # ==== Example
       #
       #   def computation(n)
       #     AppOpticsAPM::API.profile('fib', { :n => n }) do
@@ -32,40 +34,44 @@ module AppOpticsAPM
       def profile(profile_name, report_kvs = {}, with_backtrace = false)
         return yield unless AppOpticsAPM.tracing?
 
-        report_kvs[:Language] ||= :ruby
-        report_kvs[:ProfileName] ||= profile_name
-        report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if with_backtrace
-
-        AppOpticsAPM::API.log(nil, :profile_entry, report_kvs)
-
         begin
-          yield
-        rescue => e
-          log_exception(nil, e)
-          raise
-        ensure
-          exit_kvs = {}
-          exit_kvs[:Language] = :ruby
-          exit_kvs[:ProfileName] = report_kvs[:ProfileName]
-
-          AppOpticsAPM::API.log(nil, :profile_exit, exit_kvs)
+          report_kvs[:Language] ||= :ruby
+          report_kvs[:ProfileName] ||= profile_name
+          report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if with_backtrace
+
+          AppOpticsAPM::API.log(nil, :profile_entry, report_kvs)
+
+          begin
+            yield
+          rescue => e
+            log_exception(nil, e)
+            raise
+          ensure
+            exit_kvs = {}
+            exit_kvs[:Language] = :ruby
+            exit_kvs[:ProfileName] = report_kvs[:ProfileName]
+
+            AppOpticsAPM::API.log(nil, :profile_exit, exit_kvs)
+          end
         end
       end
 
       ##
-      # Public: Profile a method on a class or module.  That method can be of any (accessible)
+      # Public: Add profiling to a method on a class or module.  That method can be of any (accessible)
       # type (instance, singleton, private, protected etc.).
       #
-      # klass  - the class or module that has the method to profile
-      # method - the method to profile.  Can be singleton, instance, private etc...
-      # opts   - a hash specifying the one or more of the following options:
-      #   * :arguments  - report the arguments passed to <tt>method</tt> on each profile (default: false)
-      #   * :result     - report the return value of <tt>method</tt> on each profile (default: false)
-      #   * :backtrace  - report the return value of <tt>method</tt> on each profile (default: false)
-      #   * :name       - alternate name for the profile reported in the dashboard (default: method name)
-      # extra_kvs - a hash containing any additional KVs you would like reported with the profile
+      # ==== Arguments
+      #
+      # * +klass+  - the class or module that has the method to profile
+      # * +method+ - the method to profile.  Can be singleton, instance, private etc...
+      # * +opts+   - a hash specifying the one or more of the following options:
+      #   * +:arguments+  - report the arguments passed to <tt>method</tt> on each profile (default: false)
+      #   * +:result+     - report the return value of <tt>method</tt> on each profile (default: false)
+      #   * +:backtrace+  - report the return value of <tt>method</tt> on each profile (default: false)
+      #   * +:name+       - alternate name for the profile reported in the dashboard (default: method name)
+      # * +extra_kvs+ - a hash containing any additional key/value pairs you would like reported with the profile
       #
-      # Example
+      # ==== Example
       #
       #   opts = {}
       #   opts[:backtrace] = true

data/lib/appoptics_apm/api/tracing.rb

@@ -20,6 +20,8 @@ module AppOpticsAPM
     # * +:URL+ - request URI
     # * +:Method+
     #
+    # TODO complete the above
+    #
     # Invalid keys: +:Label+, +:Layer+, +:Edge+, +:Timestamp+, +:Timestamp_u+
     #
     module Tracing
@@ -56,7 +58,7 @@ module AppOpticsAPM
           log_exception(layer, e)
           raise
         ensure
-          log_exit(layer)
+          log_exit(layer, opts, protect_op)
         end
       end
 
@@ -67,17 +69,20 @@ module AppOpticsAPM
       # When start_trace returns control to the calling context, the oboe
       # context will be cleared.
       #
-      # layer - The layer the block of code belongs to.
-      # opts - A hash containing key/value pairs that will be reported along
-      # with the first event of this layer (optional).
+      # ==== Arguments
       #
-      # Example
+      # * +layer+  - name for the layer to be used as label in the trace view
+      # * +xtrace+ - (optional) incoming X-Trace identifier to be continued
+      # * +opts+   - (optional) hash containing key/value pairs that will be reported along
+      #   with the first event of this layer (optional)
+      #
+      # ==== Example
       #
       #   def handle_request(request, response)
       #     # ... code that modifies request and response ...
       #   end
       #
-      #   def handle_request_with_oboe(request, response)
+      #   def handle_request_with_appoptics(request, response)
       #     result, xtrace = start_trace('rails', request['X-Trace']) do
       #       handle_request(request, response)
       #     end
@@ -92,6 +97,8 @@ module AppOpticsAPM
       # of the block, and the second element of which is the oboe context that
       # was set when the block completed execution.
       def start_trace(layer, xtrace = nil, opts = {})
+        return [yield, nil] unless AppOpticsAPM.loaded
+
         log_start(layer, xtrace, opts)
         begin
           result = yield
@@ -113,19 +120,20 @@ module AppOpticsAPM
       # access to the exit event's trace id so we can set the header before any
       # work is done, and before any headers are sent back to the client.
       #
-      # layer - The layer the block of code belongs to.
-      # xtrace - string - The X-Trace to continue by the target
-      # target - has to respond to #[]=, The target object in which to place the trace information
-      # opts - A hash containing key/value pairs that will be reported along
-      #        with the first event of this layer (optional).
+      # ===== Arguments
+      # * +layer+ - The layer the block of code belongs to.
+      # * +xtrace+ - string - The X-Trace to continue by the target
+      # * +target+ - has to respond to #[]=, The target object in which to place the trace information
+      # * +opts+ - A hash containing key/value pairs that will be reported along
+      #   with the first event of this layer (optional).
       #
-      # Example:
+      # ==== Example
       #
       #   def handle_request(request, response)
       #     # ... code that does something with request and response ...
       #   end
       #
-      #   def handle_request_with_oboe(request, response)
+      #   def handle_request_with_appoptics(request, response)
       #     start_trace_with_target('rails', request['X-Trace'], response) do
       #       handle_request(request, response)
       #     end
@@ -133,6 +141,8 @@ module AppOpticsAPM
       #
       # Returns the result of the block.
       def start_trace_with_target(layer, xtrace, target, opts = {})
+        return yield unless AppOpticsAPM.loaded
+
         log_start(layer, xtrace, opts)
         exit_evt = AppOpticsAPM::Context.createEvent
         begin