scout_apm 2.4.24 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3876e11520a259f36044e5363edcb5aeeb4b21fa
-  data.tar.gz: cc1b0079ab39e11f40a864c49ef2fbe47047b186
+  metadata.gz: 2003c0ac2f53ba79444a99beff51200791cadd27
+  data.tar.gz: aaa6bac945f0c541a39e6326f79a1bbd4959a663
 SHA512:
-  metadata.gz: d027fd21baa97648867063ec267c53f1dab7cf1060c5f13a9c69f1ce70b89a78465fe0fdda20ddc4d44ea6b281c5673f3661fb0cb7f3b34982e4081e45041942
-  data.tar.gz: aee3351685dc70a95857ffc63bc8dfad81e6414ddb53146eaca3483fc0bd94ef29024da47079f62bc1d568cbc979afc20d6f960fa53e25b123136202fd10badd
+  metadata.gz: 516804f4427ca84b89ae752964d6e38653c29698c1f833b4facec0ed784dde8e5212c11fdca62fc6f837a94a5cebabcd68130331f89816374881901d5382f750
+  data.tar.gz: 07f51e83d3aa6b79d883113b430fd20a0814dcae613285be6f3547a588407f7aa5eb02d9b5972bf01b4c4ca8aaf3a9f2191ce0025afa016780d7a05caf65310c

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 2.5.0
+
+* Added timeline traces and an associated `timeline_traces: true` config option.
+* Increased timeline traces span limit to 2,500 from 500.
+
 # 2.4.24
 
 * Fix for prepending view instruments in the case of templates that lack a `virtual_path` (#257).

data/README.markdown

@@ -12,8 +12,8 @@ The Scout agent is engineered to do some wonderful things:
 
 * A unique focus on identifying those hard-to-investigate outliers like memory bloat, N+1s, and user-specific problems. [See an example workflow](http://scoutapp.com/newrelic-alternative).
 * [Low-overhead](http://blog.scoutapp.com/articles/2016/02/07/overhead-benchmarks-new-relic-vs-scout)
-* View your performance metrics during development with [DevTrace](https://help.apm.scoutapp.com/#devtrace) and in production via [server_timing](https://github.com/scoutapp/ruby_server_timing).
-* Production-Safe profiling of custom code via [ScoutProf](https://help.apm.scoutapp.com/#scoutprof) (BETA).
+* View your performance metrics during development with [DevTrace](https://docs.scoutapm.com/#devtrace) and in production via [server_timing](https://github.com/scoutapp/ruby_server_timing).
+* Production-Safe profiling of custom code via [ScoutProf](https://docs.scoutapm.com/#scoutprof) (BETA).
 
 ## Getting Started
 
@@ -25,7 +25,7 @@ Update your Gemfile
 
     bundle install
 
-Signup for a [Scout](https://apm.scoutapp.com) account and put the provided
+Signup for a [Scout](https://scoutapm.com) account and put the provided
 config file at `RAILS_ROOT/config/scout_apm.yml`.
 
 Your config file should look like:
@@ -35,6 +35,9 @@ Your config file should look like:
       key: YOUR_APPLICATION_KEY
       monitor: true
 
+    test:
+      monitor: false
+
     production:
       <<: *defaults
 
@@ -64,7 +67,7 @@ SCOUT_DEV_TRACE=true rails server
 ## Docs
 
 For the complete list of supported frameworks, Rubies, configuration options
-and more, see our [help site](https://help.apm.scoutapp.com/).
+and more, see our [help site](https://docs.scoutapm.com/).
 
 ## Help
 

data/lib/scout_apm.rb

@@ -15,6 +15,7 @@ require 'socket'
 require 'thread'
 require 'time'
 require 'yaml'
+require 'securerandom'
 
 #####################################
 # Gem Requires
@@ -44,6 +45,7 @@ require 'scout_apm/layer_converters/database_converter'
 require 'scout_apm/layer_converters/slow_request_converter'
 require 'scout_apm/layer_converters/request_queue_time_converter'
 require 'scout_apm/layer_converters/allocation_metric_converter'
+require 'scout_apm/layer_converters/trace_converter'
 require 'scout_apm/layer_converters/histograms'
 require 'scout_apm/layer_converters/find_layer_by_type'
 
@@ -136,6 +138,7 @@ require 'scout_apm/metric_stats'
 require 'scout_apm/db_query_metric_stats'
 require 'scout_apm/slow_transaction'
 require 'scout_apm/slow_job_record'
+require 'scout_apm/detailed_trace'
 require 'scout_apm/scored_item_set'
 require 'scout_apm/slow_request_policy'
 require 'scout_apm/slow_job_policy'

data/lib/scout_apm/agent_context.rb

@@ -205,7 +205,7 @@ module ScoutApm
       if !@config.any_keys_found?
         logger.info("No configuration file loaded, and no configuration found in ENV. " +
                     "For assistance configuring Scout, visit " +
-                    "https://help.apm.scoutapp.com/#ruby-configuration-options")
+                    "https://docs.scoutapm.com/#ruby-configuration-options")
       end
     end
   end

data/lib/scout_apm/config.rb

@@ -6,7 +6,7 @@ require 'scout_apm/environment'
 # Valid Config Options:
 #
 # This list is complete, but some are old and unused, or for developers of
-# scout_apm itself. See the documentation at https://help.apm.scoutapp.com for
+# scout_apm itself. See the documentation at https://docs.scoutapm.com for
 # customer-focused documentation.
 #
 # application_root - override the detected directory of the application
@@ -32,6 +32,7 @@ require 'scout_apm/environment'
 # remote_agent_host - Internal: What host to bind to, and also send messages to for remote. Default: 127.0.0.1.
 # remote_agent_port - What port to bind the remote webserver to
 # start_resque_server_instrument - Used in special situations with certain Resque installs
+# timeline_traces - true/false to enable sending of of the timeline trace format.
 #
 # Any of these config settings can be set with an environment variable prefixed
 # by SCOUT_ and uppercasing the key: SCOUT_LOG_LEVEL for instance.
@@ -74,6 +75,7 @@ module ScoutApm
         'start_resque_server_instrument',
         'uri_reporting',
         'instrument_http_url_length',
+        'timeline_traces'
     ]
 
     ################################################################################
@@ -166,6 +168,7 @@ module ScoutApm
       'database_metric_report_limit' => IntegerCoercion.new,
       'instrument_http_url_length' => IntegerCoercion.new,
       'start_resque_server_instrument' => BooleanCoercion.new,
+      'timeline_traces' => BooleanCoercion.new
     }
 
 
@@ -273,6 +276,7 @@ module ScoutApm
         'instrument_http_url_length' => 300,
         'start_resque_server_instrument' => true, # still only starts if Resque is detected
         'collect_remote_ip' => true,
+        'timeline_traces' => true
       }.freeze
 
       def value(key)

data/lib/scout_apm/detailed_trace.rb

@@ -0,0 +1,216 @@
+# DetailedTrace contains all details about a certain transaction, spans with
+# start & stop times, tags, etc.
+
+# {
+# "version": 1,
+# "identity": {
+#   "transaction_id": "req-....",
+#   "revision": "abcdef",
+#   "start_instant": "01-01-01T00:00:00.0000Z",
+#   "stop_instant": "01-01-01T00:00:01.0000Z",
+#   "type": "Web",
+#   "naming": {
+#     "path": "/users",
+#     "code": "UsersController#index",
+#   },
+#   "score": {
+#     "total": 10.5,
+#     "percentile": 4.5,
+#     "age": 2.0,
+#     "memory_delta": 3,
+#     "allocations": 1
+#   }
+# },
+#
+# "tags": {
+#   "allocations": 1000
+# },
+#
+# "spans": [
+#   ...
+# ]
+
+class DetailedTrace
+  attr_reader :spans
+  attr_reader :tags
+
+  attr_reader :transaction_id
+  attr_reader :revision
+  attr_reader :start_instant
+  attr_reader :stop_instant
+  attr_reader :duration
+  attr_reader :type # "Web" or "Job"
+  attr_reader :host
+
+  attr_reader :path # /users/1
+  attr_reader :code # UsersController#show or similar
+
+  attr_reader :total_score
+  attr_reader :percentile_score
+  attr_reader :age_score
+  attr_reader :memory_delta_score
+  attr_reader :memory_allocations_score
+
+  VERSION = 1
+
+  def initialize(transaction_id, revision, host, start_instant, stop_instant, type, path, code, spans, tags)
+    @spans = spans
+    @tags = DetailedTraceTags(tags)
+
+    @transaction_id = transaction_id
+    @revision = revision
+    @host = host
+    @start_instant = start_instant
+    @stop_instant = stop_instant
+    @type = type
+
+    @path = path
+    @code = code
+
+    @total_score = 0
+    @percentile_score = 0
+    @age_score = 0
+    @memory_delta_score = 0
+    @memory_allocations_score = 0
+
+  end
+
+  def as_json(*)
+    {
+      :version => VERSION,
+      :identity => {
+        :transaction_id => transaction_id,
+        :revision => revision,
+        :host => host,
+        :start_instant => start_instant.iso8601(6),
+        :stop_instant => stop_instant.iso8601(6),
+        :type => type,
+        :naming => {
+          :path => path,
+          :code => code,
+        },
+        :score => {
+          :total => total_score,
+          :percentile => percentile_score,
+          :age => age_score,
+          :memory_delta => memory_delta_score,
+          :allocations => memory_allocations_score,
+        }
+      },
+      :tags => tags.as_json,
+      :spans => spans.as_json,
+    }
+  end
+
+  ########################
+  # Scorable interface
+  #
+  # Needed so we can merge ScoredItemSet instances
+  def call
+    self
+  end
+
+  def name
+    code
+  end
+
+  def score
+    @total_score
+  end
+
+end
+
+##########
+#  SPAN  #
+##########
+
+#
+# {
+#   "type": "Standard",
+#   "identity": {
+#     "id": "....",
+#     "parent_id": "....",
+#     "start_time": "01-01-01T00:00:00.0000Z",
+#     "stop_time": "01-01-01T00:00:00.0001Z",
+#     "operation": "SQL/User/find"
+#   },
+#   "tags": {
+#     "allocations": 1000,
+#     "db.statement": "SELECT * FROM users where id = 1",
+#     "db.rows": 1,
+#     "backtrace": [ {
+#       "file": "app/controllers/users_controller.rb",
+#       "line": 10,
+#       "function": "index"
+#     } ]
+#   }
+class DetailedTraceSpan
+  attr_reader :tags
+
+  attr_reader :span_type
+  attr_reader :span_id, :parent_id
+  attr_reader :start_instant, :stop_instant
+
+  # What is the "name" of this span.
+  #
+  # Examples:
+  #   SQL/User/find
+  #   Controller/Users/index
+  #   HTTP/GET/example.com
+  attr_reader :operation
+
+  def initialize(span_id, parent_id, start_instant, stop_instant, operation, tags)
+    # This will be dynamic when we implement limited spans
+    @span_type = "Standard"
+
+    @span_id = span_id
+    @parent_id = parent_id
+
+    @start_instant = start_instant
+    @stop_instant = stop_instant
+    @operation = operation
+    @tags = DetailedTraceTags(tags)
+  end
+
+  def as_json(*)
+    {
+      :type => @span_type,
+      :identity => {
+        :id => span_id,
+        :parent_id => parent_id,
+        :start_instant => start_instant.iso8601(6),
+        :stop_instant => stop_instant.iso8601(6),
+        :operation => operation,
+      },
+      :tags => @tags.as_json,
+    }
+  end
+end
+
+
+#############
+#  content  #
+#############
+
+# Tags for either a request, or a span
+class DetailedTraceTags
+  attr_reader :tags
+
+  def initialize(hash)
+    @tags = hash
+  end
+
+  def as_json(*)
+    @tags.as_json
+  end
+end
+
+# Converter function to turn an input into a DetailedTraceTags object
+def DetailedTraceTags(arg)
+  if DetailedTraceTags === arg
+    arg
+  elsif Hash === arg
+    DetailedTraceTags.new(arg)
+  end
+end
+

data/lib/scout_apm/fake_store.rb

@@ -17,6 +17,9 @@ module ScoutApm
     def track_one!(type, name, value, options={})
     end
 
+    def track_trace!(trace, type)
+    end
+
     def track_histograms!(histograms, options={})
     end
 

data/lib/scout_apm/layer.rb

@@ -46,6 +46,8 @@ module ScoutApm
     # If no annotations are ever set, this will return nil
     attr_reader :annotations
 
+    attr_reader :allocations_start, :allocations_stop
+
     BACKTRACE_CALLER_LIMIT = 50 # maximum number of lines to send thru for backtrace analysis
 
     def initialize(type, name, start_time = Time.now)

data/lib/scout_apm/layer_converters/slow_job_converter.rb

@@ -15,6 +15,7 @@ module ScoutApm
         # Let the store know we're here, and if it wants our data, it will call
         # back into #call
         @store.track_slow_job!(self)
+
         nil # not returning anything in the layer results ... not used
       end
 
@@ -54,7 +55,8 @@ module ScoutApm
           mem_delta,
           job_layer.total_allocations,
           score,
-          limited?
+          limited?,
+          span_trace
         )
       end
 
@@ -89,6 +91,12 @@ module ScoutApm
       def skip_layer?(layer); super(layer) || layer == queue_layer; end
       def queue_layer; layer_finder.queue; end
       def job_layer; layer_finder.job; end
+
+      def span_trace
+        ScoutApm::LayerConverters::TraceConverter.
+          new(@context, @request, @layer_finder, @store).
+          call
+      end
     end
   end
 end

data/lib/scout_apm/layer_converters/slow_request_converter.rb

@@ -11,6 +11,7 @@ module ScoutApm
         # Let the store know we're here, and if it wants our data, it will call
         # back into #call
         @store.track_slow_transaction!(self)
+
         nil # not returning anything in the layer results ... not used
       end
 
@@ -51,7 +52,8 @@ module ScoutApm
                             mem_delta,
                             root_layer.total_allocations,
                             @points,
-                            limited?)
+                            limited?,
+                            span_trace)
       end
 
       # Full metrics from this request. These get stored permanently in a SlowTransaction.
@@ -81,6 +83,17 @@ module ScoutApm
 
         [metric_hash, allocation_metric_hash]
       end
+
+      ###########################################################
+      #  Also create a new style trace. This is not a good      #
+      #  spot for this long term, but fixes an issue for now.   #
+      ###########################################################
+      
+      def span_trace
+        ScoutApm::LayerConverters::TraceConverter.
+          new(@context, @request, @layer_finder, @store).
+          call
+      end
     end
   end
 end

data/lib/scout_apm/layer_converters/trace_converter.rb

@@ -0,0 +1,180 @@
+module ScoutApm
+  module LayerConverters
+    class TraceConverter < ConverterBase
+      ###################
+      #  Converter API  #
+      ###################
+
+
+      def record!
+        @points = context.slow_request_policy.score(request)
+
+        # Let the store know we're here, and if it wants our data, it will call
+        # back into #call
+        @store.track_trace!(self)
+
+        nil # not returning anything in the layer results ... not used
+      end
+
+      #####################
+      #  ScoreItemSet API #
+      #####################
+      def name; request.unique_name; end
+      def score; @points; end
+
+      # Unconditionally attempts to convert this into a DetailedTrace object.
+      # Can return nil if the request didn't have any scope_layer or if `timeline_traces` aren't enabled.
+      def call
+        return nil unless scope_layer
+        return nil unless context.config.value('timeline_traces')
+
+        # Since this request is being stored, update the needed counters
+        context.slow_request_policy.stored!(request)
+
+        # record the change in memory usage
+        mem_delta = ScoutApm::Instruments::Process::ProcessMemory.new(context).rss_to_mb(@request.capture_mem_delta!)
+
+        transaction_id = request.transaction_id
+        revision = context.environment.git_revision.sha
+        start_instant = request.root_layer.start_time
+        stop_instant = request.root_layer.stop_time
+        type = if request.web?
+                 "Web"
+               elsif request.job?
+                 "Job"
+               else
+                 "Unknown"
+               end
+
+        # Create request tags
+        #
+        tags = {
+          :allocations => request.root_layer.total_allocations,
+          :mem_delta => mem_delta,
+        }.merge(request.context.to_flat_hash)
+
+        host = context.environment.hostname
+        path = request.annotations[:uri] || ""
+        code = "" # User#index for instance
+
+        spans = create_spans(request.root_layer)
+
+        DetailedTrace.new(
+          transaction_id,
+          revision,
+          host,
+          start_instant,
+          stop_instant,
+          type,
+
+          path,
+          code,
+
+          spans,
+          tags
+
+          # total_score = 0,
+          # percentile_score = 0,
+          # age_score = 0,
+          # memory_delta_score = 0,
+          # memory_allocations_score = 0
+        )
+      end
+
+      # Returns an array of span objects. Uses recursion to get all children
+      # wired up w/ correct parent_ids
+      def create_spans(layer, parent_id = nil)
+        span_id = ScoutApm::Utils::SpanId.new.to_s
+
+        start_instant = layer.start_time
+        stop_instant = layer.stop_time
+        operation = layer.legacy_metric_name
+        tags = {
+          :start_allocations => layer.allocations_start,
+          :stop_allocations => layer.allocations_stop,
+        }
+        if layer.desc
+          tags[:desc] = layer.desc.to_s
+        end
+        if layer.annotations && layer.annotations[:record_count]
+          tags["db.record_count"] = layer.annotations[:record_count]
+        end
+        if layer.annotations && layer.annotations[:class_name]
+          tags["db.class_name"] = layer.annotations[:class_name]
+        end
+        if layer.backtrace
+          tags[:backtrace] = backtrace_parser(layer.backtrace) rescue nil
+        end
+
+        # Collect up self, and all children into result array
+        result = []
+        result << DetailedTraceSpan.new(
+          span_id.to_s,
+          parent_id.to_s,
+          start_instant,
+          stop_instant,
+          operation,
+          tags)
+
+        layer.children.each do |child|
+          unless over_span_limit?(result)
+            result += create_spans(child, span_id)
+          end
+        end
+
+        return result
+      end
+
+      # Take an array of ruby backtrace lines and split it into an array of hashes like:
+      # ["/Users/cschneid/.rvm/rubies/ruby-2.2.7/lib/ruby/2.2.0/irb/workspace.rb:86:in `eval'", ...]
+      #    turns into:
+      # [ {
+      #     "file": "app/controllers/users_controller.rb",
+      #     "line": 10,
+      #     "function": "index"
+      # },
+      # ]
+      def backtrace_parser(lines)
+        bt = ScoutApm::Utils::BacktraceParser.new(lines).call
+
+        bt.map do |line|
+          match = line.match(/(.*):(\d+):in `(.*)'/)
+          {
+            "file" => match[1],
+            "line" => match[2],
+            "function" => match[3],
+          }
+        end
+
+      end
+
+      ################################################################################
+      # Limit Handling
+      ################################################################################
+
+      # To prevent huge traces from being generated, we should stop collecting
+      # spans as we go beyond some reasonably large count.
+
+      MAX_SPANS = 2500
+
+      def over_span_limit?(spans)
+        if spans.size > MAX_SPANS
+          log_over_span_limit
+          @limited = true
+        else
+          false
+        end
+      end
+
+      def log_over_span_limit
+        unless limited?
+          context.logger.debug "Not recording additional spans for #{name}. Over the span limit."
+        end
+      end
+
+      def limited?
+        !! @limited
+      end
+    end
+  end
+end

data/lib/scout_apm/reporting.rb

@@ -83,10 +83,11 @@ module ScoutApm
       slow_jobs = reporting_period.slow_jobs_payload
       histograms = reporting_period.histograms
       db_query_metrics = reporting_period.db_query_metrics_payload
+      traces = (slow_transactions.map(&:span_trace) + slow_jobs.map(&:span_trace)).compact
 
       log_deliver(metrics, slow_transactions, metadata, slow_jobs, histograms)
 
-      payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics)
+      payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
       logger.debug("Sending payload w/ Headers: #{headers.inspect}")
 
       reporter.report(payload, headers)

data/lib/scout_apm/serializers/payload_serializer.rb

@@ -2,9 +2,9 @@
 module ScoutApm
   module Serializers
     class PayloadSerializer
-      def self.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics)
+      def self.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
         if ScoutApm::Agent.instance.context.config.value("report_format") == 'json'
-          ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics)
+          ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
         else
           metadata = metadata.dup
           metadata.default = nil

data/lib/scout_apm/serializers/payload_serializer_to_json.rb

@@ -2,7 +2,7 @@ module ScoutApm
   module Serializers
     module PayloadSerializerToJson
       class << self
-        def serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics)
+        def serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
           metadata.merge!({:payload_version => 2})
 
           jsonify_hash({:metadata => metadata,
@@ -14,6 +14,7 @@ module ScoutApm
                         :db_metrics => {
                           :query => DbQuerySerializerToJson.new(db_query_metrics).as_json,
                         },
+                        :span_traces => traces.map{ |t| t.as_json },
           })
         end
 

data/lib/scout_apm/slow_job_record.rb

@@ -23,7 +23,9 @@ module ScoutApm
     attr_reader :git_sha
     attr_reader :truncated_metrics
 
-    def initialize(agent_context, queue_name, job_name, time, total_time, exclusive_time, context, metrics, allocation_metrics, mem_delta, allocations, score, truncated_metrics)
+    attr_reader :span_trace
+
+    def initialize(agent_context, queue_name, job_name, time, total_time, exclusive_time, context, metrics, allocation_metrics, mem_delta, allocations, score, truncated_metrics, span_trace)
       @queue_name = queue_name
       @job_name = job_name
       @time = time
@@ -40,6 +42,8 @@ module ScoutApm
       @score = score
       @truncated_metrics = truncated_metrics
 
+      @span_trace = span_trace
+
       agent_context.logger.debug { "Slow Job [#{metric_name}] - Call Time: #{total_call_time} Mem Delta: #{mem_delta}"}
     end
 

data/lib/scout_apm/slow_transaction.rb

@@ -13,13 +13,14 @@ module ScoutApm
     attr_reader :prof
     attr_reader :mem_delta
     attr_reader :allocations
+    attr_reader :span_trace
     attr_accessor :hostname # hack - we need to reset these server side.
     attr_accessor :seconds_since_startup # hack - we need to reset these server side.
     attr_accessor :git_sha # hack - we need to reset these server side.
 
     attr_reader :truncated_metrics # True/False that says if we had to truncate the metrics of this trace
 
-    def initialize(agent_context, uri, metric_name, total_call_time, metrics, allocation_metrics, context, time, raw_stackprof, mem_delta, allocations, score, truncated_metrics)
+    def initialize(agent_context, uri, metric_name, total_call_time, metrics, allocation_metrics, context, time, raw_stackprof, mem_delta, allocations, score, truncated_metrics, span_trace)
       @uri = uri
       @metric_name = metric_name
       @total_call_time = total_call_time
@@ -35,6 +36,7 @@ module ScoutApm
       @score = score
       @git_sha = agent_context.environment.git_revision.sha
       @truncated_metrics = truncated_metrics
+      @span_trace = span_trace
 
       agent_context.logger.debug { "Slow Request [#{uri}] - Call Time: #{total_call_time} Mem Delta: #{mem_delta} Score: #{score}"}
     end

data/lib/scout_apm/store.rb

@@ -189,7 +189,6 @@ module ScoutApm
 
   # One period of Storage. Typically 1 minute
   class StoreReportingPeriod
-
     # A ScoredItemSet holding the "best" traces for the period
     attr_reader :request_traces
 

data/lib/scout_apm/tracked_request.rb

@@ -42,6 +42,9 @@ module ScoutApm
     # the name is determined from the name of the Controller or Job layer.
     attr_accessor :name_override
 
+    # A unique, but otherwise meaningless String to identify this request. UUID
+    attr_reader :transaction_id
+
     # When we see these layers, it means a real request is going through the
     # system. We toggle a flag to turn on some slightly more expensive
     # instrumentation (backtrace collection and the like) that would be too
@@ -64,6 +67,7 @@ module ScoutApm
       @mem_start = mem_usage
       @recorder = agent_context.recorder
       @real_request = false
+      @transaction_id = ScoutApm::Utils::TransactionId.new.to_s
       ignore_request! if @recorder.nil?
     end
 
@@ -275,6 +279,8 @@ module ScoutApm
 
       @agent_context.transaction_time_consumed.add(unique_name, root_layer.total_call_time)
 
+      context.add(:transaction_id => transaction_id)
+
       # Make a constant, then call converters.dup.each so it isn't inline?
       converters = {
         :histograms => LayerConverters::Histograms,
@@ -287,6 +293,11 @@ module ScoutApm
 
         :slow_job => LayerConverters::SlowJobConverter,
         :slow_req => LayerConverters::SlowRequestConverter,
+
+        # This is now integrated into the slow_job and slow_req converters, so that
+        # we get the exact same set of traces either way. We can call it
+        # directly when we move away from the legacy trace styles.
+        # :traces => LayerConverters::TraceConverter,
       }
 
       walker = LayerConverters::DepthFirstWalker.new(self.root_layer)

data/lib/scout_apm/utils/unique_id.rb

@@ -11,5 +11,32 @@ module ScoutApm
         s
       end
     end
+
+    # Represents a random ID that we can use to track a certain transaction.
+    # The `trans` prefix is only for ease of reading logs - it should not be
+    # interpreted to convey any sort of meaning.
+    class TransactionId
+      def initialize
+        @random = SecureRandom.hex(16)
+      end
+
+      def to_s
+        "trans-#{@random}"
+      end
+    end
+
+    # Represents a random ID that we can use to track a certain span. The
+    # `span` prefix is only for ease of reading logs - it should not be
+    # interpreted to convey any sort of meaning.
+    class SpanId
+      def initialize
+        @random = SecureRandom.hex(16)
+      end
+
+      def to_s
+        "span-#{@random}"
+      end
+    end
+
   end
 end

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "2.4.24"
+  VERSION = "2.5.0"
 end

data/test/unit/serializers/payload_serializer_test.rb

@@ -8,7 +8,7 @@ class PayloadSerializerTest < Minitest::Test
       :unique_id => "unique_idz",
       :agent_version => 123
     }
-    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {}, [], [], [], {})
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {}, [], [], [], {}, [])
 
     # symbol keys turn to strings
     formatted_metadata = {
@@ -49,7 +49,7 @@ class PayloadSerializerTest < Minitest::Test
         stats.total_exclusive_time = 0.078132088
       }
     }
-    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize({}, metrics, {}, [], [], [], {})
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize({}, metrics, {}, [], [], [], {}, [])
     formatted_metrics = [
       {
         "key" => {
@@ -94,7 +94,7 @@ class PayloadSerializerTest < Minitest::Test
       :quotie => "here are some \"quotes\"",
       :payload_version => 2,
     }
-    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {}, [], [], [], {})
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {}, [], [], [], {}, [])
 
     # symbol keys turn to strings
     formatted_metadata = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.4.24
+  version: 2.5.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -210,6 +210,7 @@ files:
 - lib/scout_apm/db_query_metric_set.rb
 - lib/scout_apm/db_query_metric_stats.rb
 - lib/scout_apm/debug.rb
+- lib/scout_apm/detailed_trace.rb
 - lib/scout_apm/environment.rb
 - lib/scout_apm/extensions/config.rb
 - lib/scout_apm/extensions/transaction_callback_payload.rb
@@ -264,6 +265,7 @@ files:
 - lib/scout_apm/layer_converters/request_queue_time_converter.rb
 - lib/scout_apm/layer_converters/slow_job_converter.rb
 - lib/scout_apm/layer_converters/slow_request_converter.rb
+- lib/scout_apm/layer_converters/trace_converter.rb
 - lib/scout_apm/limited_layer.rb
 - lib/scout_apm/logger.rb
 - lib/scout_apm/metric_meta.rb
@@ -392,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.6.14.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring