newrelic_rpm 6.2.0.354 → 6.15.0

data/lib/new_relic/agent/transaction_error_primitive.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 # This module was introduced and largely extracted from the transaction event aggregator
 # when the synthetics container was extracted from it. Its purpose is to create the data
@@ -8,7 +8,8 @@
 # the transaction event aggregator and the synthetics container.
 
 require 'new_relic/agent/payload_metric_mapping'
-require 'new_relic/agent/distributed_trace_payload'
+require 'new_relic/agent/distributed_tracing/distributed_trace_payload'
+require 'new_relic/agent/distributed_tracing/distributed_trace_attributes'
 
 module NewRelic
   module Agent
@@ -31,16 +32,17 @@ module NewRelic
       SYNTHETICS_JOB_ID_KEY          = "nr.syntheticsJobId".freeze
       SYNTHETICS_MONITOR_ID_KEY      = "nr.syntheticsMonitorId".freeze
       PRIORITY_KEY                   = "priority".freeze
+      SPAN_ID_KEY                    = "spanId".freeze
 
-      def create noticed_error, payload
+      def create noticed_error, payload, span_id
         [
-          intrinsic_attributes_for(noticed_error, payload),
+          intrinsic_attributes_for(noticed_error, payload, span_id),
           noticed_error.custom_attributes,
           noticed_error.agent_attributes
         ]
       end
 
-      def intrinsic_attributes_for noticed_error, payload
+      def intrinsic_attributes_for noticed_error, payload, span_id
         attrs = {
           TYPE_KEY => SAMPLE_TYPE,
           ERROR_CLASS_KEY => noticed_error.exception_class_name,
@@ -49,16 +51,17 @@ module NewRelic
           TIMESTAMP_KEY => noticed_error.timestamp.to_f
         }
 
+        attrs[SPAN_ID_KEY] = span_id if span_id
         attrs[PORT_KEY] = noticed_error.request_port if noticed_error.request_port
 
         if payload
           attrs[NAME_KEY] = payload[:name]
           attrs[DURATION_KEY] = payload[:duration]
-          attrs[SAMPLED_KEY] = payload[:'sampled'] if Agent.config[:'distributed_tracing.enabled']
-          attrs[PRIORITY_KEY] = payload[:'priority']
+          attrs[SAMPLED_KEY] = payload[:sampled] if payload.key?(:sampled)
+          attrs[PRIORITY_KEY] = payload[:priority]
           append_synthetics payload, attrs
           append_cat payload, attrs
-          append_distributed_trace_intrinsics payload, attrs
+          DistributedTraceAttributes.copy_to_hash payload, attrs
           PayloadMetricMapping.append_mapped_metrics payload[:metrics], attrs
         end
 
@@ -75,14 +78,6 @@ module NewRelic
         sample[GUID_KEY] = payload[:guid] if payload[:guid]
         sample[REFERRING_TRANSACTION_GUID_KEY] = payload[:referring_transaction_guid] if payload[:referring_transaction_guid]
       end
-
-      def append_distributed_trace_intrinsics payload, sample
-        return unless Agent.config[:'distributed_tracing.enabled']
-        DistributedTracePayload::INTRINSIC_KEYS.each do |key|
-          value = payload[key]
-          sample[key] = value unless value.nil?
-        end
-      end
     end
   end
 end

data/lib/new_relic/agent/transaction_event_aggregator.rb

@@ -1,7 +1,7 @@
 # -*- ruby -*-
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'newrelic_rpm' unless defined?( NewRelic )
 require 'new_relic/agent' unless defined?( NewRelic::Agent )

data/lib/new_relic/agent/transaction_event_primitive.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 # This module was introduced and largely extracted from the transaction event aggregator
 # when the synthetics container was extracted from it. Its purpose is to create the data
@@ -8,7 +9,7 @@
 # the transaction event aggregator and the synthetics container.
 
 require 'new_relic/agent/payload_metric_mapping'
-require 'new_relic/agent/distributed_trace_payload'
+require 'new_relic/agent/distributed_tracing/distributed_trace_attributes'
 
 module NewRelic
   module Agent
@@ -16,30 +17,28 @@ module NewRelic
       include NewRelic::Coerce
       extend self
 
+      COMMA = ','
+
       # The type field of the sample
-      SAMPLE_TYPE              = 'Transaction'.freeze
+      SAMPLE_TYPE              = 'Transaction'
 
       # Strings for static keys of the sample structure
-      TYPE_KEY                       = 'type'.freeze
-      TIMESTAMP_KEY                  = 'timestamp'.freeze
-      NAME_KEY                       = 'name'.freeze
-      DURATION_KEY                   = 'duration'.freeze
-      ERROR_KEY                      = 'error'.freeze
-      SAMPLED_KEY                    = 'sampled'.freeze
-      PRIORITY_KEY                   = 'priority'.freeze
-      GUID_KEY                       = 'nr.guid'.freeze
-      REFERRING_TRANSACTION_GUID_KEY = 'nr.referringTransactionGuid'.freeze
-      CAT_PATH_HASH_KEY              = 'nr.pathHash'.freeze
-      CAT_REFERRING_PATH_HASH_KEY    = 'nr.referringPathHash'.freeze
-      CAT_ALTERNATE_PATH_HASHES_KEY  = 'nr.alternatePathHashes'.freeze
-      APDEX_PERF_ZONE_KEY            = 'nr.apdexPerfZone'.freeze
-      SYNTHETICS_RESOURCE_ID_KEY     = "nr.syntheticsResourceId".freeze
-      SYNTHETICS_JOB_ID_KEY          = "nr.syntheticsJobId".freeze
-      SYNTHETICS_MONITOR_ID_KEY      = "nr.syntheticsMonitorId".freeze
-
-
-      # To avoid allocations when we have empty custom or agent attributes
-      EMPTY_HASH = {}.freeze
+      TYPE_KEY                       = 'type'
+      TIMESTAMP_KEY                  = 'timestamp'
+      NAME_KEY                       = 'name'
+      DURATION_KEY                   = 'duration'
+      ERROR_KEY                      = 'error'
+      SAMPLED_KEY                    = 'sampled'
+      PRIORITY_KEY                   = 'priority'
+      GUID_KEY                       = 'nr.guid'
+      REFERRING_TRANSACTION_GUID_KEY = 'nr.referringTransactionGuid'
+      CAT_PATH_HASH_KEY              = 'nr.pathHash'
+      CAT_REFERRING_PATH_HASH_KEY    = 'nr.referringPathHash'
+      CAT_ALTERNATE_PATH_HASHES_KEY  = 'nr.alternatePathHashes'
+      APDEX_PERF_ZONE_KEY            = 'nr.apdexPerfZone'
+      SYNTHETICS_RESOURCE_ID_KEY     = "nr.syntheticsResourceId"
+      SYNTHETICS_JOB_ID_KEY          = "nr.syntheticsJobId"
+      SYNTHETICS_MONITOR_ID_KEY      = "nr.syntheticsMonitorId"
 
       def create(payload)
         intrinsics = {
@@ -51,11 +50,11 @@ module NewRelic
         PRIORITY_KEY  => payload[:priority]
         }
 
-        intrinsics[SAMPLED_KEY] = payload[:'sampled'] if Agent.config[:'distributed_tracing.enabled']
+        intrinsics[SAMPLED_KEY] = payload[:sampled] if payload.key?(:sampled)
 
-        NewRelic::Agent::PayloadMetricMapping.append_mapped_metrics(payload[:metrics], intrinsics)
+        PayloadMetricMapping.append_mapped_metrics(payload[:metrics], intrinsics)
         append_optional_attributes(intrinsics, payload)
-        append_distributed_trace_intrinsics(intrinsics, payload)
+        DistributedTraceAttributes.copy_to_hash payload, intrinsics
 
         attributes = payload[:attributes]
 
@@ -76,22 +75,12 @@ module NewRelic
         append_cat_alternate_path_hashes(sample, payload)
       end
 
-      COMMA = ','.freeze
-
       def append_cat_alternate_path_hashes(sample, payload)
         if payload.include?(:cat_alternate_path_hashes)
           sample[CAT_ALTERNATE_PATH_HASHES_KEY] = payload[:cat_alternate_path_hashes].sort.join(COMMA)
         end
       end
 
-      def append_distributed_trace_intrinsics(sample, payload)
-        return unless Agent.config[:'distributed_tracing.enabled']
-        DistributedTracePayload::INTRINSIC_KEYS.each do |key|
-          value = payload[key]
-          sample[key] = value unless value.nil?
-        end
-      end
-
       def optionally_append(sample_key, payload_key, sample, payload)
         if payload.include?(payload_key)
           sample[sample_key] = string(payload[payload_key])
@@ -100,19 +89,19 @@ module NewRelic
 
       def custom_attributes attributes
         if attributes
-          result = attributes.custom_attributes_for(NewRelic::Agent::AttributeFilter::DST_TRANSACTION_EVENTS)
+          result = attributes.custom_attributes_for(AttributeFilter::DST_TRANSACTION_EVENTS)
           result.freeze
         else
-          EMPTY_HASH
+          NewRelic::EMPTY_HASH
         end
       end
 
       def agent_attributes attributes
         if attributes
-          result = attributes.agent_attributes_for(NewRelic::Agent::AttributeFilter::DST_TRANSACTION_EVENTS)
+          result = attributes.agent_attributes_for(AttributeFilter::DST_TRANSACTION_EVENTS)
           result.freeze
         else
-          EMPTY_HASH
+          NewRelic::EMPTY_HASH
         end
       end
     end

data/lib/new_relic/agent/transaction_event_recorder.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 require 'new_relic/agent/transaction_event_aggregator'
 require 'new_relic/agent/synthetics_event_aggregator'
 require 'new_relic/agent/transaction_event_primitive'
@@ -14,9 +14,9 @@ module NewRelic
       attr_reader :transaction_event_aggregator
       attr_reader :synthetics_event_aggregator
 
-      def initialize
-        @transaction_event_aggregator = NewRelic::Agent::TransactionEventAggregator.new
-        @synthetics_event_aggregator = NewRelic::Agent::SyntheticsEventAggregator.new
+      def initialize events
+        @transaction_event_aggregator = NewRelic::Agent::TransactionEventAggregator.new events
+        @synthetics_event_aggregator = NewRelic::Agent::SyntheticsEventAggregator.new events
       end
 
       def record payload

data/lib/new_relic/agent/transaction_metrics.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 # This class represents a set of metrics that were recorded during a single
 # transaction. Since the name of the transaction is not known until its end, we

data/lib/new_relic/agent/transaction_sampler.rb

@@ -1,10 +1,9 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/transaction/slowest_sample_buffer'
 require 'new_relic/agent/transaction/synthetics_sample_buffer'
-require 'new_relic/agent/transaction/xray_sample_buffer'
 require 'new_relic/agent/transaction/trace_builder'
 
 module NewRelic
@@ -19,13 +18,10 @@ module NewRelic
     #
     # @api public
     class TransactionSampler
-      attr_reader :last_sample, :xray_sample_buffer
+      attr_reader :last_sample
 
       def initialize
-        @xray_sample_buffer = NewRelic::Agent::Transaction::XraySampleBuffer.new
-
         @sample_buffers = []
-        @sample_buffers << @xray_sample_buffer
         @sample_buffers << NewRelic::Agent::Transaction::SlowestSampleBuffer.new
         @sample_buffers << NewRelic::Agent::Transaction::SyntheticsSampleBuffer.new
 

data/lib/new_relic/agent/transaction_time_aggregator.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 # This module powers the Busy calculation for the Capacity report in
 # APM (https://rpm.newrelic.com/accounts/.../applications/.../optimize/capacity_analysis).

data/lib/new_relic/agent/utilization/aws.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/utilization/vendor'
 

data/lib/new_relic/agent/utilization/azure.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   module Agent

data/lib/new_relic/agent/utilization/gcp.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/utilization/vendor'
 

data/lib/new_relic/agent/utilization/pcf.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/utilization/vendor'
 

data/lib/new_relic/agent/utilization/vendor.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'net/http'
 

data/lib/new_relic/agent/utilization_data.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/utilization/aws'
 require 'new_relic/agent/utilization/gcp'

data/lib/new_relic/agent/vm/jruby_vm.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'thread'
 require 'new_relic/agent/vm/snapshot'

data/lib/new_relic/agent/vm/monotonic_gc_profiler.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 # The GC::Profiler class available on MRI has to be reset periodically to avoid
 # memory "leaking" in the underlying implementation. However, it's a major

data/lib/new_relic/agent/vm/mri_vm.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'thread'
 require 'new_relic/agent/vm/snapshot'
@@ -45,9 +45,11 @@ module NewRelic
 
         def gather_ruby_vm_stats(snap)
           if supports?(:method_cache_invalidations)
-            vm_stats = RubyVM.stat
-            snap.method_cache_invalidations = vm_stats[:global_method_state]
-            snap.constant_cache_invalidations = vm_stats[:global_constant_state]
+            snap.method_cache_invalidations = RubyVM.stat[:global_method_state]
+          end
+
+          if supports?(:constant_cache_invalidations)
+            snap.constant_cache_invalidations = RubyVM.stat[:global_constant_state]
           end
         end
 
@@ -66,7 +68,7 @@ module NewRelic
           when :minor_gc_count
             RUBY_VERSION >= '2.1.0'
           when :method_cache_invalidations
-            RUBY_VERSION >= '2.1.0'
+            RUBY_VERSION >= '2.1.0' && RUBY_VERSION < '3.0.0'
           when :constant_cache_invalidations
             RUBY_VERSION >= '2.1.0'
           else

data/lib/new_relic/agent/vm/snapshot.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   module Agent

data/lib/new_relic/agent/vm.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/language_support'
 require 'new_relic/agent/vm/mri_vm'

data/lib/new_relic/agent/worker_loop.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'thread'
 

data/lib/new_relic/agent.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'forwardable'
 
@@ -26,16 +26,15 @@ module NewRelic
 
     require 'new_relic/version'
     require 'new_relic/local_environment'
-    require 'new_relic/metrics'
     require 'new_relic/metric_spec'
     require 'new_relic/metric_data'
     require 'new_relic/noticed_error'
+    require 'new_relic/agent/noticible_error'
     require 'new_relic/supportability_helper'
 
     require 'new_relic/agent/encoding_normalizer'
     require 'new_relic/agent/stats'
     require 'new_relic/agent/chained_call'
-    require 'new_relic/agent/cross_app_monitor'
     require 'new_relic/agent/agent'
     require 'new_relic/agent/method_tracer'
     require 'new_relic/agent/worker_loop'
@@ -47,6 +46,7 @@ module NewRelic
     require 'new_relic/agent/error_collector'
     require 'new_relic/agent/sampler'
     require 'new_relic/agent/database'
+    require 'new_relic/agent/database_adapter'
     require 'new_relic/agent/datastores'
     require 'new_relic/agent/pipe_channel_manager'
     require 'new_relic/agent/configuration'
@@ -55,6 +55,9 @@ module NewRelic
     require 'new_relic/agent/system_info'
     require 'new_relic/agent/external'
     require 'new_relic/agent/deprecator'
+    require 'new_relic/agent/logging'
+    require 'new_relic/agent/distributed_tracing'
+    require 'new_relic/agent/attribute_processing'
 
     require 'new_relic/agent/instrumentation/controller_instrumentation'
 
@@ -350,10 +353,9 @@ module NewRelic
     # @api public
     #
     def manual_start(options={})
-      record_api_supportability_metric(:manual_start)
-
       raise "Options must be a hash" unless Hash === options
       NewRelic::Control.instance.init_plugin({ :agent_enabled => true, :sync_startup => true }.merge(options))
+      record_api_supportability_metric(:manual_start)
     end
 
     # Register this method as a callback for processes that fork
@@ -567,6 +569,12 @@ module NewRelic
     # these custom attributes will also be present in the script injected into
     # the response body, making them available on Insights PageView events.
     #
+    #
+    # @param [Hash] params      A Hash of attributes to be attached to the transaction event.
+    #                           Keys should be strings or symbols, and values
+    #                           may be strings, symbols, numeric values or
+    #                           booleans.
+    #
     # @api public
     #
     def add_custom_attributes(params) #THREAD_LOCAL_ACCESS
@@ -575,11 +583,43 @@ module NewRelic
       if params.is_a? Hash
         txn = Transaction.tl_current
         txn.add_custom_attributes(params) if txn
+
+        segment = ::NewRelic::Agent::Tracer.current_segment
+        if segment
+          # Make sure not to override existing segment-level custom attributes
+          segment_custom_keys = segment.attributes.custom_attributes.keys.map(&:to_sym)
+          segment.add_custom_attributes(params.reject { |k, _v| segment_custom_keys.include?(k.to_sym) })
+        end
       else
         ::NewRelic::Agent.logger.warn("Bad argument passed to #add_custom_attributes. Expected Hash but got #{params.class}")
       end
     end
 
+    # Add custom attributes to the span event for the current span. Attributes will be visible on spans in the
+    # New Relic Distributed Tracing UI and on span events in New Relic Insights.
+    #
+    # Custom attributes will not be transmitted when +high_security+ setting is enabled or
+    # +custom_attributes+ setting is disabled.
+    #
+    # @param [Hash] params      A Hash of attributes to be attached to the span event.
+    #                           Keys should be strings or symbols, and values
+    #                           may be strings, symbols, numeric values or
+    #                           booleans.
+    #
+    # @see https://docs.newrelic.com/docs/using-new-relic/welcome-new-relic/get-started/glossary#span
+    # @api public
+    def add_custom_span_attributes params
+      record_api_supportability_metric :add_custom_span_attributes
+
+      if params.is_a? Hash
+        if segment = NewRelic::Agent::Tracer.current_segment
+          segment.add_custom_attributes params
+        end
+      else
+        ::NewRelic::Agent.logger.warn "Bad argument passed to #add_custom_span_attributes. Expected Hash but got #{params.class}"
+      end
+    end
+
     # @!endgroup
 
     # @!group Transaction naming
@@ -588,7 +628,9 @@ module NewRelic
     # apply a reasonable default based on framework routing, but in
     # cases where this is insufficient, this can be used to manually
     # control the name of the transaction.
-    # The category of transaction can be specified via the +:category+ option:
+    #
+    # The category of transaction can be specified via the +:category+ option.
+    # The following are the only valid categories:
     #
     # * <tt>:category => :controller</tt> indicates that this is a
     #   controller action and will appear with all the other actions.
@@ -638,8 +680,8 @@ module NewRelic
     # @param [String] method the name of the finder method or other method to
     # identify the operation with.
     #
-    def with_database_metric_name(model, method = nil, product = nil, &block) #THREAD_LOCAL_ACCESS
-      if txn = Transaction.tl_current
+    def with_database_metric_name(model, method = nil, product = nil, &block)
+      if txn = Tracer.current_transaction
         txn.with_database_metric_name(model, method, product, &block)
       else
         yield
@@ -660,6 +702,54 @@ module NewRelic
       NewRelic::Agent.logger.debug "Ignoring exception during %p event notification" % [event_type]
     end
 
+    # @!group Trace and Entity metadata
+
+    TRACE_ID_KEY = 'trace.id'.freeze
+    SPAN_ID_KEY = 'span.id'.freeze
+    ENTITY_NAME_KEY = 'entity.name'.freeze
+    ENTITY_TYPE_KEY = 'entity.type'.freeze
+    ENTITY_GUID_KEY = 'entity.guid'.freeze
+    HOSTNAME_KEY = 'hostname'.freeze
+
+    ENTITY_TYPE = 'SERVICE'.freeze
+
+    # Returns a new hash containing trace and entity metadata that can be used
+    # to relate data to a trace or to an entity in APM.
+    #
+    # This hash includes:
+    # * trace.id    - The current trace id, if there is a current trace id. This
+    #   value may be omitted.
+    # * span.id     - The current span id, if there is a current span.  This
+    #   value may be omitted.
+    # * entity.name - The name of the current application. This is read from
+    #   the +app_name+ key in your config.  If there are multiple application
+    #   names, the first one is used.
+    # * entity.type - The entity type is hardcoded to the string +'SERVICE'+.
+    # * entity.guid - The guid of the current entity.
+    # * hostname    - The fully qualified hostname.
+    #
+    # @api public
+    def linking_metadata
+      metadata = Hash.new
+      metadata[ENTITY_NAME_KEY] = config[:app_name][0]
+      metadata[ENTITY_TYPE_KEY] = ENTITY_TYPE
+      metadata[HOSTNAME_KEY] = Hostname.get
+
+      if entity_guid = config[:entity_guid]
+        metadata[ENTITY_GUID_KEY] = entity_guid
+      end
+
+      if trace_id = Tracer.current_trace_id
+        metadata[TRACE_ID_KEY] = trace_id
+      end
+      if span_id = Tracer.current_span_id
+        metadata[SPAN_ID_KEY] = span_id
+      end
+      metadata
+    end
+
+    #@!endgroup
+
     # @!group Manual browser monitoring configuration
 
     # This method returns a string suitable for inclusion in a page - known as