newrelic_rpm 5.2.0.345 → 5.3.0.346

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f27f55d62839f2426dcc139af19e97f815c70783944d4c67363a7d54a5e208
-  data.tar.gz: 6543b4fa585ab70291df98c295818ccb74eb4d2ab00a9ac3f5093c7b89656d4d
+  metadata.gz: a104aa20426e4da3129e97dfaa651e7232ef804cf91de87b0aa4ac68d00d3fe7
+  data.tar.gz: f8ae7ba61e0dc5442212c8d4a8d985d4e9ac353c23e9ff61ebb709ff11bfd28a
 SHA512:
-  metadata.gz: 658044904957344ad87805e072168e9f366453733f0b9e42051230c2999be7170bfe5cac64c402e0ced3483e1f3d5ce091622c01d2ecb685e4354b41e6a11a38
-  data.tar.gz: ec9e153d940103faddd85fca6b00191e9214770aa5c7b5d1318fff41e3ff6d69f9720d2300847571ed1ba92b7d9c468fce5afc8dc6cfa711807405384d6cc94e
+  metadata.gz: 58d78970fa151543b165d1ef8b37a9ab7adefabf35ccad2292df5038812a1d5d5524f21cb7822a8d99bc4eabed8ceafc537b6f913b829f2a25ff0cf19a399e3a
+  data.tar.gz: 6859b4ba6ceaab1faeac5634ea264e015329f20af436872da764e3f17ac6b22f2ad2cbfc4604eccc883d9f7b1a0ef5c1fb193c9faf7fdbfab107bae3a2109b8d

data/.gitignore

@@ -14,6 +14,7 @@ tags
 *.swp
 *.swo
 
+/doc/
 /log/
 /lerg/
 gems/newrelic_rpm.gemspec

data/.travis.yml

@@ -9,6 +9,7 @@ language: ruby
 sudo: required
 
 before_install:
+  - sudo apt-get update && sudo apt-get install --only-upgrade openssl && sudo apt-get install --only-upgrade libssl-dev
   - gem --version
   - gem update --system
   - ./test/script/before_install/gemstash_mirror.sh

data/.yardopts

@@ -2,6 +2,8 @@
 --api public
 lib/new_relic/agent.rb
 lib/new_relic/agent/method_tracer.rb
+lib/new_relic/agent/distributed_tracing.rb
+lib/new_relic/agent/distributed_trace_payload.rb
 lib/new_relic/agent/external.rb
 lib/new_relic/agent/instrumentation/controller_instrumentation.rb
 lib/new_relic/agent/instrumentation/rack.rb
@@ -19,5 +21,5 @@ lib/new_relic/rack.rb
 lib/new_relic/agent/transaction/external_request_segment.rb
 -
 LICENSE
-CHANGELOG
+CHANGELOG.md
 CONTRIBUTING.md

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 # New Relic Ruby Agent Release Notes #
 
-  ## v5.2.0 ##
+## v5.3.0 ##
+
+  * Distributed Tracing
+
+    Distributed tracing lets you see the path that a request takes as
+    it travels through your distributed system. By showing the
+    distributed activity through a unified view, you can troubleshoot
+    and understand a complex system better than ever before.
+
+    Distributed tracing is available with an APM Pro or equivalent
+    subscription. To see a complete distributed trace, you need to
+    enable the feature on a set of neighboring services. Enabling
+    distributed tracing changes the behavior of some New Relic
+    features, so carefully consult the
+    [transition guide](https://docs.newrelic.com/docs/transition-guide-distributed-tracing)
+    before you enable this feature.
+
+    To enable distributed tracing, set the
+    `distributed_tracing.enabled` configuration option to `true`.
+
+## v5.2.0 ##
 
   * Use priority sampling for errors and custom events
 
@@ -14,7 +34,12 @@
     The agent will now complete the process of wrapping datastore
     operations even if an error occurs during execution of a callback.
 
-  ## v5.1.0 ##
+  * Span Events
+
+    Finished segments whose `sampled` property is `true` will now post
+    Span events to Insights.
+
+## v5.1.0 ##
 
   * Rails 5.2 support
 
@@ -68,7 +93,7 @@
     data to New Relic. This version truncates long traces to 50 frames
     (split evenly between the top and bottom of the trace).
 
-  ## v5.0.0 ##
+## v5.0.0 ##
 
   * SSL connections to New Relic are now mandatory
 
@@ -107,7 +132,7 @@
     works correctly with this new behavior. Thanks to Jimmy Zhang for
     the contribution.
 
-  ## v4.8.0 ##
+## v4.8.0 ##
 
   * Initialize New Relic Agent before config initializers
 
@@ -129,7 +154,7 @@
   It is now an agent attribute that can be controlled via the attributes config.
   For more information on agent attributes [see here](https://docs.newrelic.com/docs/agents/manage-apm-agents/agent-data/agent-attributes).
 
-  ## 4.7.1 ##
+## 4.7.1 ##
 
   * Bugfix for Manual Browser Instrumentation
 
@@ -139,7 +164,7 @@
   instrumentation. Those changes have been reverted. We will revisit this issue
   in an upcoming release.
 
-  ## v4.7.0 ##
+## v4.7.0 ##
 
   * Expected Error API
 

data/lib/new_relic/agent/adaptive_sampler.rb

@@ -6,15 +6,16 @@ module NewRelic
   module Agent
     class AdaptiveSampler
 
-      def initialize target_samples = 10, interval_duration = 60
+      def initialize target_samples = 10, period_duration = 60
         @target = target_samples
         @seen = 0
         @seen_last = 0
         @sampled_count = 0
-        @interval_duration = interval_duration
-        @first_interval = true
-        @interval_start = Time.now.to_f
+        @period_duration = period_duration
+        @first_period = true
+        @period_start = Time.now.to_f
         @lock = Mutex.new
+        register_config_callbacks
       end
 
       # Called at the beginning of each transaction, increments seen and
@@ -22,13 +23,13 @@ module NewRelic
       # sampled. This uses the adaptive sampling algorithm.
       def sampled?
         @lock.synchronize do
-          reset_if_interval_expired!
-          sampled = if @first_interval
+          reset_if_period_expired!
+          sampled = if @first_period
             @sampled_count < 10
           elsif @sampled_count < @target
             rand(@seen_last) < @target
           else
-            rand(@seen) < (@target ** (@target / @sampled_count) - @target ** 0.51)
+            rand(@seen) < (@target ** (@target / @sampled_count) - @target ** 0.5)
           end
 
           @sampled_count += 1 if sampled
@@ -51,18 +52,53 @@ module NewRelic
 
       private
 
-      def reset_if_interval_expired!
+      def reset_if_period_expired!
         now = Time.now.to_f
-        return unless @interval_start + @interval_duration <= now
+        return unless @period_start + @period_duration <= now
 
-        elapsed_intervals = Integer((now - @interval_start) / @interval_duration)
-        @interval_start = @interval_start + elapsed_intervals * @interval_duration
+        elapsed_periods = Integer((now - @period_start) / @period_duration)
+        @period_start = @period_start + elapsed_periods * @period_duration
 
-        @first_interval = false
-        @seen_last = elapsed_intervals > 1 ? 0 : @seen
+        @first_period = false
+        @seen_last = elapsed_periods > 1 ? 0 : @seen
         @seen = 0
         @sampled_count = 0
       end
+
+      def register_config_callbacks
+        register_sampling_target_callback
+        register_sampling_period_callback
+      end
+
+      def register_sampling_target_callback
+        NewRelic::Agent.config.register_callback(:sampling_target) do |target|
+          target_changed = false
+          @lock.synchronize do
+            if @target != target
+              @target = target
+              target_changed = true
+            end
+          end
+          if target_changed
+            NewRelic::Agent.logger.debug "Sampling target set to: #{target}"
+          end
+        end
+      end
+
+      def register_sampling_period_callback
+        NewRelic::Agent.config.register_callback(:sampling_target_period_in_seconds) do |period_duration|
+          period_changed = false
+          @lock.synchronize do
+            if @period_duration != period_duration
+              @period_duration = period_duration
+              period_changed = true
+            end
+          end
+          if period_changed
+            NewRelic::Agent.logger.debug "Sampling period set to: #{period_duration}"
+          end
+        end
+      end
     end
   end
 end

data/lib/new_relic/agent/agent.rb

@@ -22,6 +22,7 @@ require 'new_relic/agent/distributed_trace_monitor'
 require 'new_relic/agent/synthetics_monitor'
 require 'new_relic/agent/transaction_event_recorder'
 require 'new_relic/agent/custom_event_aggregator'
+require 'new_relic/agent/span_event_aggregator'
 require 'new_relic/agent/sampler_collection'
 require 'new_relic/agent/javascript_instrumentor'
 require 'new_relic/agent/vm/monotonic_gc_profiler'
@@ -61,14 +62,15 @@ module NewRelic
         @harvest_samplers          = NewRelic::Agent::SamplerCollection.new(@events)
         @monotonic_gc_profiler     = NewRelic::Agent::VM::MonotonicGCProfiler.new
         @javascript_instrumentor   = NewRelic::Agent::JavascriptInstrumentor.new(@events)
-        @adaptive_sampler          = NewRelic::Agent::AdaptiveSampler.new
+        @adaptive_sampler          = NewRelic::Agent::AdaptiveSampler.new(self.class.config[:sampling_target],
+                                                                          self.class.config[:sampling_target_period_in_seconds])
 
         @harvester       = NewRelic::Agent::Harvester.new(@events)
         @after_fork_lock = Mutex.new
 
         @transaction_event_recorder = NewRelic::Agent::TransactionEventRecorder.new
-
-        @custom_event_aggregator      = NewRelic::Agent::CustomEventAggregator.new
+        @custom_event_aggregator    = NewRelic::Agent::CustomEventAggregator.new
+        @span_event_aggregator      = NewRelic::Agent::SpanEventAggregator.new
 
         @connect_state      = :pending
         @connect_attempts   = 0
@@ -140,6 +142,7 @@ module NewRelic
         # GC::Profiler.total_time is not monotonic so we wrap it.
         attr_reader :monotonic_gc_profiler
         attr_reader :custom_event_aggregator
+        attr_reader :span_event_aggregator
         attr_reader :transaction_event_recorder
         attr_reader :attribute_filter
         attr_reader :adaptive_sampler
@@ -546,6 +549,7 @@ module NewRelic
           @transaction_sampler.reset!
           @transaction_event_recorder.drop_buffered_data
           @custom_event_aggregator.reset!
+          @span_event_aggregator.reset!
           @sql_sampler.reset!
 
           if Agent.config[:clear_transaction_state_after_fork]
@@ -1108,8 +1112,9 @@ module NewRelic
 
         def harvest_and_send_analytic_event_data
           harvest_and_send_from_container(transaction_event_aggregator, :analytic_event_data)
-          harvest_and_send_from_container(synthetics_event_aggregator, :analytic_event_data)
-          harvest_and_send_from_container(@custom_event_aggregator,      :custom_event_data)
+          harvest_and_send_from_container(synthetics_event_aggregator,  :analytic_event_data)
+          harvest_and_send_from_container(@custom_event_aggregator,     :custom_event_data)
+          harvest_and_send_from_container(span_event_aggregator,        :span_event_data)
         end
 
         def harvest_and_send_error_event_data
@@ -1138,6 +1143,10 @@ module NewRelic
           transmit_single_data_type(:harvest_and_send_analytic_event_data, "TransactionEvent")
         end
 
+        def transmit_span_event_data
+          transmit_single_data_type(:harvest_and_send_span_event_data, "SpanEvent")
+        end
+
         def transmit_single_data_type(harvest_method, supportability_name)
           now = Time.now
 

data/lib/new_relic/agent/configuration/default_source.rb

@@ -1676,12 +1676,64 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'If <code>true</code>, the agent will clear <code>TransactionState</code> in <code>Agent.drop_buffered_data</code>.'
         },
+        :account_id => {
+          :default => nil,
+          :allow_nil => true,
+          :public => false,
+          :type => String,
+          :allowed_from_server => true,
+          :description => 'The account id associated with this application.'
+        },
+        :primary_application_id => {
+          :default => nil,
+          :allow_nil => true,
+          :public => false,
+          :type => String,
+          :allowed_from_server => true,
+          :description => 'The primary id associated with this application.'
+        },
         :'distributed_tracing.enabled' => {
           :default     => false,
-          :public      => false,
+          :public      => true,
           :type        => Boolean,
           :allowed_from_server => false,
-          :description => 'If <code>true</code> enables experimental distributed tracing feature.'
+          :description => 'Distributed tracing lets you see the path that a request takes through your distributed system. Enabling distributed tracing changes the behavior of some New Relic features, so carefully consult the <a href="https://docs.newrelic.com/docs/transition-guide-distributed-tracing">transition guide</a> before you enable this feature.'
+        },
+        :trusted_account_key => {
+          :default => nil,
+          :allow_nil => true,
+          :public => false,
+          :type => String,
+          :allowed_from_server => true,
+          :description => 'A shared key to validate that a distributed trace payload came from a trusted account.'
+        },
+        :sampling_target => {
+          :default => 10,
+          :public => false,
+          :type => Integer,
+          :allowed_from_server => true,
+          :description => 'The target number of transactions to mark as sampled during a sampled period.'
+        },
+        :sampling_target_period_in_seconds => {
+          :default => 60,
+          :public => false,
+          :type => Integer,
+          :allowed_from_server => true,
+          :description => 'The period during which a target number of transactions should be marked as sampled.'
+        },
+        :'span_events.enabled' => {
+          :default => true,
+          :public => false,
+          :type => Boolean,
+          :allowed_from_server => true,
+          :description => 'If <code>true</code>, enables span event sampling.'
+        },
+        :'span_events.max_samples_stored' => {
+          :default => 1000,
+          :public => false,
+          :type => Integer,
+          :allowed_from_server => true,
+          :description => 'Defines the maximum number of span events reported from a single harvest.'
         }
       }.freeze
     end

data/lib/new_relic/agent/configuration/server_source.rb

@@ -10,6 +10,7 @@ module NewRelic
         # response, but should still be merged in as config settings to the
         # main agent configuration.
         TOP_LEVEL_KEYS = [
+          "account_id",
           "apdex_t",
           "application_id",
           "beacon",
@@ -24,7 +25,11 @@ module NewRelic
           "error_beacon",
           "js_agent_file",
           "js_agent_loader",
-          "trusted_account_ids"
+          "primary_application_id",
+          "sampling_target",
+          "sampling_target_period_in_seconds",
+          "trusted_account_ids",
+          "trusted_account_key"
         ]
 
         def initialize(connect_reply, existing_config={})

data/lib/new_relic/agent/cross_app_tracing.rb

@@ -51,7 +51,9 @@ module NewRelic
       end
 
       def cross_application_tracer_enabled?
-        NewRelic::Agent.config[:"cross_application_tracer.enabled"] || NewRelic::Agent.config[:cross_application_tracing]
+        !NewRelic::Agent.config[:"distributed_tracing.enabled"] &&
+          (NewRelic::Agent.config[:"cross_application_tracer.enabled"] ||
+           NewRelic::Agent.config[:cross_application_tracing])
       end
 
       def obfuscator

data/lib/new_relic/agent/database.rb

@@ -195,6 +195,20 @@ module NewRelic
           @host = host
           @port_path_or_id = port_path_or_id
           @database_name = database_name
+          @safe_sql = nil
+        end
+
+        # Returns an sql statement that will be in the form most permissable by
+        # the config. The format will be safe for transmission to New Relic.
+        def safe_sql
+          @safe_sql ||= case Database.record_sql_method
+            when :obfuscated
+              Database.obfuscate_sql(sql)
+            when :raw
+              sql.to_s
+            else
+              nil
+            end
         end
 
         # This takes a connection config hash from ActiveRecord or Sequel and

data/lib/new_relic/agent/distributed_trace_monitor.rb

@@ -8,14 +8,13 @@ require 'new_relic/agent/cross_app_tracing'
 module NewRelic
   module Agent
     class DistributedTraceMonitor < InboundRequestMonitor
-      NEWRELIC_TRACE_KEY  = 'HTTP_X_NEWRELIC_TRACE'.freeze
-      HTTP_TRANSPORT_TYPE = 'HTTP'.freeze
-
       def on_finished_configuring(events)
         return unless NewRelic::Agent.config[:'distributed_tracing.enabled']
         events.subscribe(:before_call, &method(:on_before_call))
       end
 
+      NEWRELIC_TRACE_KEY = 'HTTP_NEWRELIC'
+
       def on_before_call(request)
         return unless NewRelic::Agent.config[:'distributed_tracing.enabled']
         return unless payload = request[NEWRELIC_TRACE_KEY]
@@ -23,9 +22,20 @@ module NewRelic
         state = NewRelic::Agent::TransactionState.tl_get
         txn = state.current_transaction
         if txn.accept_distributed_trace_payload payload
-          txn.distributed_trace_payload.caller_transport_type = HTTP_TRANSPORT_TYPE
+          txn.distributed_trace_payload.caller_transport_type = transport_type(request)
         end
       end
+
+      URL_SCHEMES = {
+        'http'  => 'HTTP'.freeze,
+        'https' => 'HTTPS'.freeze
+      }
+
+      RACK_URL_SCHEME = 'rack.url_scheme'.freeze
+
+      def transport_type(request)
+        URL_SCHEMES[request[RACK_URL_SCHEME]]
+      end
     end
   end
 end

data/lib/new_relic/agent/distributed_trace_payload.rb

@@ -3,9 +3,16 @@
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 require 'json'
 require 'base64'
+require 'set'
 
 module NewRelic
   module Agent
+    #
+    # This class contains properties related to distributed traces.
+    # To obtain an instance, call
+    # {DistributedTracing#create_distributed_trace_payload}
+    #
+    # @api public
     class DistributedTracePayload
       VERSION =[0, 1].freeze
       PARENT_TYPE = "App".freeze
@@ -17,10 +24,11 @@ module NewRelic
       PARENT_TYPE_KEY            = 'ty'.freeze
       PARENT_ACCOUNT_ID_KEY      = 'ac'.freeze
       PARENT_APP_KEY             = 'ap'.freeze
+      TRUSTED_ACCOUNT_KEY        = 'tk'.freeze
       ID_KEY                     = 'id'.freeze
+      TX_KEY                     = 'tx'.freeze
       TRACE_ID_KEY               = 'tr'.freeze
       SAMPLED_KEY                = 'sa'.freeze
-      PARENT_ID_KEY              = 'pa'.freeze
       TIMESTAMP_KEY              = 'ti'.freeze
       PRIORITY_KEY               = 'pr'.freeze
 
@@ -32,9 +40,9 @@ module NewRelic
       PARENT_TRANSPORT_DURATION_INTRINSIC_KEY  = "parent.transportDuration".freeze
       GUID_INTRINSIC_KEY                       = "guid".freeze
       TRACE_ID_INTRINSIC_KEY                   = "traceId".freeze
-      TRIP_ID_INTRINSIC_KEY                    = "nr.tripId".freeze
       PARENT_ID_INTRINSIC_KEY                  = "parentId".freeze
-      GRANDPARENT_ID_INTRINSIC_KEY             = "grandparentId".freeze
+      PARENT_SPAN_ID_INTRINSIC_KEY             = "parentSpanId".freeze
+      SAMPLED_INTRINSIC_KEY                    = "sampled".freeze
       COMMA                                    = ",".freeze
 
       INTRINSIC_KEYS = [
@@ -45,58 +53,54 @@ module NewRelic
         PARENT_TRANSPORT_DURATION_INTRINSIC_KEY,
         GUID_INTRINSIC_KEY,
         TRACE_ID_INTRINSIC_KEY,
-        TRIP_ID_INTRINSIC_KEY,
         PARENT_ID_INTRINSIC_KEY,
-        GRANDPARENT_ID_INTRINSIC_KEY
+        PARENT_SPAN_ID_INTRINSIC_KEY,
+        SAMPLED_INTRINSIC_KEY
       ].freeze
 
       # Intrinsic Values
-      PARENT_TRANSPORT_TYPE_UNKNOWN = 'unknown'.freeze
+      PARENT_TRANSPORT_TYPE_UNKNOWN = 'Unknown'.freeze
 
       class << self
+
         def for_transaction transaction
-          payload = new
-          return payload unless connected?
+          return nil unless connected?
 
+          payload = new
           payload.version = VERSION
           payload.parent_type = PARENT_TYPE
+          payload.parent_account_id = Agent.config[:account_id]
+          payload.parent_app_id = Agent.config[:primary_application_id]
 
-          # We should not rely on the xp_id being formulated this way, but we have
-          # seen nil account ids coming down in staging for some accounts
-          account_id, fallback_app_id = Agent.config[:cross_process_id].split(POUND)
-          payload.parent_account_id = account_id
-
-          payload.parent_app_id =  if Agent.config[:application_id].empty?
-            fallback_app_id
-          else
-            Agent.config[:application_id]
-          end
+          assign_trusted_account_key(payload, payload.parent_account_id)
 
+          payload.id = current_segment_id(transaction)
+          payload.transaction_id = transaction.guid
           payload.timestamp = (Time.now.to_f * 1000).round
-          payload.id = transaction.guid
           payload.trace_id = transaction.trace_id
           payload.sampled = transaction.sampled?
           payload.priority = transaction.priority
-          payload.parent_id = transaction.parent_id
 
           payload
         end
 
         def from_json serialized_payload
           raw_payload = JSON.parse serialized_payload
+          return raw_payload if raw_payload.nil?
           payload_data = raw_payload[DATA_KEY]
 
           payload = new
-          payload.version           = raw_payload[VERSION_KEY]
-          payload.parent_type       = payload_data[PARENT_TYPE_KEY]
-          payload.parent_account_id = payload_data[PARENT_ACCOUNT_ID_KEY]
-          payload.parent_app_id     = payload_data[PARENT_APP_KEY]
-          payload.timestamp         = payload_data[TIMESTAMP_KEY]
-          payload.id                = payload_data[ID_KEY]
-          payload.trace_id          = payload_data[TRACE_ID_KEY]
-          payload.sampled           = payload_data[SAMPLED_KEY]
-          payload.priority          = payload_data[PRIORITY_KEY]
-          payload.parent_id         = payload_data[PARENT_ID_KEY]
+          payload.version             = raw_payload[VERSION_KEY]
+          payload.parent_type         = payload_data[PARENT_TYPE_KEY]
+          payload.parent_account_id   = payload_data[PARENT_ACCOUNT_ID_KEY]
+          payload.parent_app_id       = payload_data[PARENT_APP_KEY]
+          payload.trusted_account_key = payload_data[TRUSTED_ACCOUNT_KEY]
+          payload.timestamp           = payload_data[TIMESTAMP_KEY]
+          payload.id                  = payload_data[ID_KEY]
+          payload.transaction_id      = payload_data[TX_KEY]
+          payload.trace_id            = payload_data[TRACE_ID_KEY]
+          payload.sampled             = payload_data[SAMPLED_KEY]
+          payload.priority            = payload_data[PRIORITY_KEY]
 
           payload
         end
@@ -106,11 +110,10 @@ module NewRelic
           from_json decoded_payload
         end
 
-        # Assigns intrinsics for the first distributed trace in a trip
-        def assign_intrinsics_for_first_trace transaction, transaction_payload
+        def assign_initial_intrinsics transaction, transaction_payload
           transaction_payload[GUID_INTRINSIC_KEY] = transaction.guid
           transaction_payload[TRACE_ID_INTRINSIC_KEY] = transaction.trace_id
-          transaction_payload[TRIP_ID_INTRINSIC_KEY]  = transaction.trace_id
+          transaction_payload[SAMPLED_INTRINSIC_KEY] = transaction.sampled?
         end
 
         def major_version_matches?(payload)
@@ -119,27 +122,48 @@ module NewRelic
 
         private
 
-        # We use the presence of the cross_process_id in the config to tell if we
-        # have connected yet.
+        # We use the presence of the account_id and primary_application in the
+        # config to tell if we have connected yet.
         def connected?
-          !!Agent.config[:'cross_process_id']
+          Agent.config[:account_id] && Agent.config[:primary_application_id]
+        end
+
+        def assign_trusted_account_key payload, account_id
+          trusted_account_key = Agent.config[:trusted_account_key]
+
+          if account_id != trusted_account_key
+            payload.trusted_account_key = trusted_account_key
+          end
+        end
+
+        def current_segment_id(transaction)
+          if Agent.config[:'span_events.enabled'] && transaction.sampled? &&
+              transaction.current_segment
+            transaction.current_segment.guid
+          end
         end
       end
 
       attr_accessor :version,
                     :parent_type,
-                    :caller_transport_type,
                     :parent_account_id,
                     :parent_app_id,
+                    :trusted_account_key,
                     :id,
+                    :transaction_id,
                     :trace_id,
                     :sampled,
                     :priority,
-                    :parent_id,
                     :timestamp
 
       alias_method :sampled?, :sampled
 
+      attr_reader :caller_transport_type
+
+      def caller_transport_type=(type)
+        @caller_transport_type = valid_transport_type_for(type)
+      end
+
       def initialize
         @caller_transport_type = PARENT_TRANSPORT_TYPE_UNKNOWN
       end
@@ -153,25 +177,39 @@ module NewRelic
           PARENT_TYPE_KEY       => parent_type,
           PARENT_ACCOUNT_ID_KEY => parent_account_id,
           PARENT_APP_KEY        => parent_app_id,
-          ID_KEY                => id,
+          TX_KEY                => transaction_id,
           TRACE_ID_KEY          => trace_id,
           SAMPLED_KEY           => sampled,
           PRIORITY_KEY          => priority,
-          PARENT_ID_KEY         => parent_id,
-          # GRANDPARENT_ID_KEY does not go into the outbound JSON payload;
-          # the callee will take our parent ID as its grandparent ID
-          TIMESTAMP_KEY      => timestamp,
+          TIMESTAMP_KEY         => timestamp,
         }
 
+        result[DATA_KEY][ID_KEY]              = id if id
+        result[DATA_KEY][TRUSTED_ACCOUNT_KEY] = trusted_account_key if trusted_account_key
+
         JSON.dump(result)
       end
 
-      alias_method :text, :to_json
-
+      # Encode this payload as a string suitable for passing via an
+      # HTTP header.
+      #
+      # @return [String] Payload translated to JSON and encoded for
+      #                  inclusion in headers
+      #
+      # @api public
       def http_safe
         Base64.strict_encode64 to_json
       end
 
+      # Represent this payload as a raw JSON string.
+      #
+      # @return [String] Payload translated to JSON
+      #
+      # @api public
+      def text
+        to_json
+      end
+
       def assign_intrinsics transaction, transaction_payload
         transaction_payload[PARENT_TYPE_INTRINSIC_KEY] = parent_type
         transaction_payload[PARENT_APP_INTRINSIC_KEY] = parent_app_id
@@ -180,9 +218,28 @@ module NewRelic
         transaction_payload[PARENT_TRANSPORT_DURATION_INTRINSIC_KEY] = transaction.transport_duration
         transaction_payload[GUID_INTRINSIC_KEY] = transaction.guid
         transaction_payload[TRACE_ID_INTRINSIC_KEY] = trace_id
-        transaction_payload[TRIP_ID_INTRINSIC_KEY] = trace_id
         transaction_payload[PARENT_ID_INTRINSIC_KEY] = transaction.parent_id if transaction.parent_id
-        transaction_payload[GRANDPARENT_ID_INTRINSIC_KEY] = transaction.grandparent_id if transaction.grandparent_id
+        transaction_payload[PARENT_SPAN_ID_INTRINSIC_KEY] = id if id
+        transaction_payload[SAMPLED_INTRINSIC_KEY] = transaction.sampled?
+      end
+
+      private
+
+      ALLOWABLE_TRANSPORT_TYPES = Set.new(%w[
+        Unknown
+        HTTP
+        HTTPS
+        Kafka
+        JMS
+        IronMQ
+        AMQP
+        Queue
+        Other
+      ]).freeze
+
+      def valid_transport_type_for(value)
+        return value if ALLOWABLE_TRANSPORT_TYPES.include?(value)
+        PARENT_TRANSPORT_TYPE_UNKNOWN
       end
     end
   end