Merge pull request #51 from librato/custom_transaction_name_AO-7719

Custom transaction name ao 7719

Author: Maia Engeli

.gitignore

@@ -15,6 +15,7 @@ ext/oboe_metal/src/oboe.h
 ext/oboe_metal/src/oboe.hpp
 ext/oboe_metal/src/oboe_debug.h
 ext/oboe_metal/src/oboe_wrap.cxx
+ext/oboe_metal/src/bson/*
 log/
 .vagrant
 gemfiles/.bundle

.travis.yml

@@ -5,6 +5,11 @@ cache:
   directories:
   - vendor/bundle
 
+env:
+  - DBTYPE=mysql
+  - DBTYPE=mysql2
+  - DBTYPE=postgresql
+
 rvm:
   - 2.5.0
   - 2.4.3
@@ -23,11 +28,6 @@ gemfile:
   - gemfiles/rails51.gemfile
   - gemfiles/delayed_job.gemfile
 
-env:
-  - DBTYPE=mysql
-  - DBTYPE=mysql2
-  - DBTYPE=postgresql
-
 matrix:
   exclude:
     - rvm: 2.5.0
@@ -103,6 +103,8 @@ before_script:
   - psql -c 'create database travis_ci_test;' -U postgres
   - mysql -e 'create database travis_ci_test;'
   - sleep 10
+  - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
+  - export APPOPTICS_TOKEN_BUCKET_RATE=1000
 
 script: "N=1 bundle exec rake test"
 

Dockerfile_test

@@ -1,5 +1,8 @@
 FROM ubuntu:16.04
 
+# to use with ./run_tests_docker.rb
+# docker build -f Dockerfile_test -t ruby_appoptics_apm .
+
 # install OS packages
 RUN apt-get update \
     && apt-get install -y --no-install-recommends \
@@ -36,7 +39,7 @@ RUN . ~/.profile \
     && rbenv install 2.3.6 \
     && rbenv install 2.4.3 \
     && rbenv install 2.5.0
-#    && rbenv install jruby-9.0.5.0
+#    && rbenv install jruby-9.1.16.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 \
@@ -65,3 +68,5 @@ RUN apt-get update && \
 ENV PATH="/root/.rbenv/bin:/root/.rbenv/shims:$PATH"
 ENV RUBY_ENV=test
 ENV DOCKER_PSQL_PASS=docker
+ENV APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
+ENV APPOPTICS_TOKEN_BUCKET_RATE=1000

Rakefile

@@ -73,13 +73,23 @@ task :fetch_ext_deps do
   end
 
   # The c-lib version is different from the gem version
-  oboe_version = ENV['OBOE_VERSION'] || '2.0.10' # 'latest'
-  oboe_src_dir = "https://s3-us-west-2.amazonaws.com/rc-files-t2/c-lib/#{oboe_version}"
+  oboe_version = ENV['OBOE_VERSION'] || 'latest'
+  oboe_s3_dir = "https://s3-us-west-2.amazonaws.com/rc-files-t2/c-lib/#{oboe_version}"
   ext_src_dir = File.expand_path('ext/oboe_metal/src')
 
   # VERSION is used by extconf.rb to download the correct liboboe when installing the gem
-  %w(oboe.i oboe.h oboe.hpp oboe_debug.h VERSION).each do |filename|
-    remote_file = File.join(oboe_src_dir, filename)
+  remote_file = File.join(oboe_s3_dir, 'VERSION')
+  local_file = File.join(ext_src_dir, 'VERSION')
+  puts "fetching #{remote_file} to #{local_file}"
+  open(remote_file, 'rb') do |rf|
+    content = rf.read
+    File.open(local_file, 'wb') { |f| f.puts content }
+  end
+
+  # oboe and bson header files
+  FileUtils.mkdir_p(File.join(ext_src_dir, 'bson'))
+  %w(oboe.h oboe.hpp oboe_debug.h oboe.i bson/bson.h bson/platform_hacks.h).each do |filename|
+    remote_file = File.join(oboe_s3_dir, 'include', filename)
     local_file = File.join(ext_src_dir, filename)
 
     puts "fetching #{remote_file} to #{local_file}"
@@ -88,6 +98,7 @@ task :fetch_ext_deps do
       File.open(local_file, 'wb') { |f| f.puts content }
     end
   end
+
   FileUtils.cd(ext_src_dir) do
     system('swig -c++ -ruby -module oboe_metal oboe.i')
     FileUtils.rm('oboe.i')

appoptics_apm.gemspec

@@ -15,11 +15,13 @@ Gem::Specification.new do |s|
   s.description = %q{The AppOpticsAPM gem provides performance instrumentation for MRI Ruby and related frameworks.}
 
   s.extra_rdoc_files = ["LICENSE"]
-  s.files = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|gemfiles|examples)/}) }
+  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_debug.h',
               'ext/oboe_metal/src/oboe_wrap.cxx',
+              'ext/oboe_metal/src/bson/bson.h',
+              'ext/oboe_metal/src/bson/platform_hacks.h',
               'ext/oboe_metal/src/VERSION']
 
   # TODO this is commented out util we can actually provide gems for different platforms

ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-2.0.10
+2.1.0

lib/appoptics_apm.rb

@@ -60,6 +60,8 @@
     require 'appoptics_apm/frameworks/sinatra'
     require 'appoptics_apm/frameworks/padrino'
     require 'appoptics_apm/frameworks/grape'
+  else
+    require 'appoptics_apm/noop/context'
   end
 
   # Load Ruby module last.  If there is no framework detected,

lib/appoptics_apm/api/logging.rb

@@ -40,7 +40,7 @@ module Logging
       #
       # Returns nothing.
       def log(layer, label, opts = {}, event=nil)
-        return if !AppOpticsAPM.tracing?
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
         event ||= AppOpticsAPM::Context.createEvent
         log_event(layer, label, event, opts)
@@ -66,11 +66,11 @@ def log(layer, label, opts = {}, event=nil)
       #
       # Returns nothing.
       def log_exception(layer, exn, opts = {})
-        return if !AppOpticsAPM.tracing? || exn.instance_variable_get(:@oboe_logged)
+        return AppOpticsAPM::Context.toString if !AppOpticsAPM.tracing? || exn.instance_variable_get(:@oboe_logged)
 
         unless exn
           AppOpticsAPM.logger.debug '[appoptics_apm/debug] log_exception called with nil exception'
-          return
+          return AppOpticsAPM::Context.toString
         end
 
         opts.merge!(:ErrorClass => exn.class.name,
@@ -180,12 +180,11 @@ def log_start(layer, xtrace = nil, opts = {})
       #
       # Returns an xtrace metadata string if we are tracing
       def log_end(layer, opts = {})
-        return unless AppOpticsAPM.tracing?
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
-        log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts) if AppOpticsAPM.tracing?
-        AppOpticsAPM::Context.toString
+        log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts)
       ensure
-        # FIXME has_incoming_context commented out, it has importance for JRuby only and breaks ruby tests
+        # FIXME has_incoming_context commented out, it has importance for JRuby only but breaks Ruby tests
         AppOpticsAPM::Context.clear # unless AppOpticsAPM.has_incoming_context?
       end
 
@@ -206,7 +205,7 @@ def log_end(layer, opts = {})
       #
       # Returns an xtrace metadata string if we are tracing
       def log_entry(layer, opts = {}, op = nil)
-        return unless AppOpticsAPM.tracing?
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
         AppOpticsAPM.layer_op = op.to_sym if op
         log_event(layer, :entry, AppOpticsAPM::Context.createEvent, opts)
@@ -228,7 +227,7 @@ def log_entry(layer, opts = {}, op = nil)
       #
       # Returns an xtrace metadata string if we are tracing
       def log_info(layer, opts = {})
-        return unless AppOpticsAPM.tracing?
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
         log_event(layer, :info, AppOpticsAPM::Context.createEvent, opts)
       end
@@ -251,7 +250,7 @@ def log_info(layer, opts = {})
       #
       # Returns an xtrace metadata string  if we are tracing
       def log_exit(layer, opts = {}, op = nil)
-        return unless AppOpticsAPM.tracing?
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
         AppOpticsAPM.layer_op = nil if op
         log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts)
@@ -270,7 +269,7 @@ def log_exit(layer, opts = {}, op = nil)
       # * +traces+ - An array with X-Trace strings returned from the requests
       #
       def log_multi_exit(layer, traces)
-        return unless AppOpticsAPM.tracing?
+        return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
         task_id = AppOpticsAPM::XTrace.task_id(AppOpticsAPM::Context.toString)
         event = AppOpticsAPM::Context.createEvent
         traces.each do |trace|
@@ -289,7 +288,7 @@ def log_multi_exit(layer, traces)
       # * +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
-        return unless context.isValid
+        return AppOpticsAPM::Context.toString unless context.isValid
 
         event = context.createEvent
         event.addInfo(APPOPTICS_STR_LAYER, layer.to_s)
@@ -299,6 +298,7 @@ def log_init(layer = :rack, opts = {})
         end
 
         AppOpticsAPM::Reporter.sendStatus(event, context)
+        AppOpticsAPM::Context.toString
       end
 
       private
@@ -353,6 +353,7 @@ def log_event(layer, label, event, opts = {})
         end if !opts.nil? && opts.any?
 
         AppOpticsAPM::Reporter.sendReport(event)
+        AppOpticsAPM::Context.toString
       end
 
     end

lib/appoptics_apm/api/tracing.rb

@@ -51,7 +51,8 @@ module Tracing
       #
       # Returns the result of the block.
       def trace(layer, opts = {}, protect_op = nil)
-        return if protect_op && AppOpticsAPM.layer_op == protect_op.to_sym
+        return if !AppOpticsAPM.loaded || (protect_op && AppOpticsAPM.layer_op == protect_op.to_sym)
+
         log_entry(layer, opts, protect_op)
         begin
           yield
@@ -158,6 +159,32 @@ def start_trace_with_target(layer, xtrace, target, opts = {})
           AppOpticsAPM::Context.clear
         end
       end
+
+      # Public: Set a ThreadLocal custom transaction name to be used when sending a trace or metrics for the
+      # current transaction
+      #
+      # In addition to setting a transaction name here there is also a configuration
+      # AppOpticsAPM::Config['transaction_name']['prepend_domain'] which allows to have the domain prepended
+      # to the transaction name
+      #
+      # ===== Arguments
+      # * +name+ - A non-empty string with the custom transaction name
+      #
+      def set_transaction_name(name)
+        if name.is_a?(String) && name.strip != ''
+          AppOpticsAPM.transaction_name = name
+        else
+          AppOpticsAPM.logger.debug "[appoptics_apm/api] Could not set transaction name, provided name is empty or not a String."
+        end
+        AppOpticsAPM.transaction_name
+      end
+
+
+      # this is provided for testing
+      # returns the current transaction name
+      def get_transaction_name
+        AppOpticsAPM.transaction_name
+      end
     end
   end
 end

lib/appoptics_apm/base.rb

@@ -42,6 +42,12 @@ module AppOpticsAPMBase
   thread_local :sample_rate
   thread_local :layer
   thread_local :layer_op
+
+  # transaction_name is used for custom transaction naming
+  # It needs to be globally accessible, but is only set by the request processors of the different frameworks
+  # and read by rack
+  thread_local :transaction_name
+
   # Semaphore used during the test suite to test
   # global config options.
   thread_local :config_lock
@@ -54,7 +60,7 @@ module AppOpticsAPMBase
   # X-Trace request header, tracing may have already been started
   # by Joboe.  Such a scenario occurs when the application is being
   # hosted by a Java container (such as Tomcat or Glassfish) and
-  # JAppOpticsAPM has already initiated tracing.  In this case, we shouldn't
+  # AppOpticsAPM has already initiated tracing.  In this case, we shouldn't
   # pickup the X-Trace context in the X-Trace header and we shouldn't
   # set the outgoing response X-Trace header or clear context.
   # Yeah I know.  Yuck.