newrelic_rpm 4.5.0.337 → 4.6.0.338

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5163342ef18117639611f7ff1658dbd48aaaae2c
-  data.tar.gz: d2d78f11f66675e6887ea6a9a8ec3606d5e45704
+  metadata.gz: 3f0dcf7789c565bfbc24cc8b1c65ec3d3b05d715
+  data.tar.gz: 50ba88cad5a895adafc8c4923143b30f0d85f1e1
 SHA512:
-  metadata.gz: 3c371c48d1eaddd30865ee2d1fc1f3fef8fc55182c30d35be4d04b858d276132540f9ffb65f23ec5d231afc0be8991545032b2ef3628add899d1a3c473d7e7e6
-  data.tar.gz: 075fc7e970ac1c0d99ee4152550551cc85f3f764bfdd8ee6643f021710242ab2d47985d4c259f4adbd4544ae74826e2d900b1a9152bb882098f58d36d2e0aacb
+  metadata.gz: 98acebde2bc526125b36318ccd71e94dec996adb273894e25b38497ba3e4fe3b62d86613c5dc2d8cef198e0c83084584e8b7b5205002bb79155dbca323f3615c
+  data.tar.gz: 8d0f588e0b0c40b4398f2cee2a4d3d30d6f0022a584713c0f068d1546c2d975bc624e93b77c318cb94cbd4f59ecac0611e6f10c7d7fac04e5d15a197854f1d01

data/.yardopts

@@ -2,6 +2,7 @@
 --api public
 lib/new_relic/agent.rb
 lib/new_relic/agent/method_tracer.rb
+lib/new_relic/agent/external.rb
 lib/new_relic/agent/instrumentation/controller_instrumentation.rb
 lib/new_relic/agent/instrumentation/rack.rb
 lib/new_relic/agent/instrumentation/metric_frame.rb
@@ -15,6 +16,7 @@ lib/new_relic/rack/agent_hooks.rb
 lib/new_relic/rack/browser_monitoring.rb
 lib/new_relic/rack/error_collector.rb
 lib/new_relic/rack.rb
+lib/new_relic/agent/transaction/external_request_segment.rb
 -
 LICENSE
 CHANGELOG

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # New Relic Ruby Agent Release Notes #
 
+## v4.6.0 ##
+
+  * Public API for External Requests
+
+  The agent now has public API for instrumenting external requests and linking
+  up transactions via cross application tracing. See the [API Guide](https://docs.newrelic.com/docs/agents/ruby-agent/customization/ruby-agent-api-guide#externals)
+  for more details this new functionality.
+
 ## v4.5.0 ##
 
   * Send synthetics headers even when CAT disabled

data/lib/new_relic/agent.rb

@@ -54,6 +54,7 @@ module NewRelic
     require 'new_relic/agent/rules_engine'
     require 'new_relic/agent/http_clients/uri_util'
     require 'new_relic/agent/system_info'
+    require 'new_relic/agent/external'
 
     require 'new_relic/agent/instrumentation/controller_instrumentation'
 

data/lib/new_relic/agent/agent.rb

@@ -19,6 +19,7 @@ require 'new_relic/agent/database'
 require 'new_relic/agent/commands/agent_command_router'
 require 'new_relic/agent/event_listener'
 require 'new_relic/agent/cross_app_monitor'
+require 'new_relic/agent/distributed_trace_monitor'
 require 'new_relic/agent/synthetics_monitor'
 require 'new_relic/agent/synthetics_event_buffer'
 require 'new_relic/agent/transaction_event_recorder'
@@ -29,6 +30,7 @@ require 'new_relic/agent/vm/monotonic_gc_profiler'
 require 'new_relic/agent/utilization_data'
 require 'new_relic/environment_report'
 require 'new_relic/agent/attribute_filter'
+require 'new_relic/agent/throughput_monitor'
 
 module NewRelic
   module Agent
@@ -48,18 +50,20 @@ module NewRelic
 
         @service = NewRelicService.new
 
-        @events                = NewRelic::Agent::EventListener.new
-        @stats_engine          = NewRelic::Agent::StatsEngine.new
-        @transaction_sampler   = NewRelic::Agent::TransactionSampler.new
-        @sql_sampler           = NewRelic::Agent::SqlSampler.new
-        @agent_command_router  = NewRelic::Agent::Commands::AgentCommandRouter.new(@events)
-        @cross_app_monitor     = NewRelic::Agent::CrossAppMonitor.new(@events)
-        @synthetics_monitor    = NewRelic::Agent::SyntheticsMonitor.new(@events)
-        @error_collector       = NewRelic::Agent::ErrorCollector.new
-        @transaction_rules     = NewRelic::Agent::RulesEngine.new
-        @harvest_samplers      = NewRelic::Agent::SamplerCollection.new(@events)
-        @monotonic_gc_profiler = NewRelic::Agent::VM::MonotonicGCProfiler.new
-        @javascript_instrumentor = NewRelic::Agent::JavascriptInstrumentor.new(@events)
+        @events                    = NewRelic::Agent::EventListener.new
+        @stats_engine              = NewRelic::Agent::StatsEngine.new
+        @transaction_sampler       = NewRelic::Agent::TransactionSampler.new
+        @sql_sampler               = NewRelic::Agent::SqlSampler.new
+        @agent_command_router      = NewRelic::Agent::Commands::AgentCommandRouter.new(@events)
+        @cross_app_monitor         = NewRelic::Agent::CrossAppMonitor.new(@events)
+        @distributed_trace_monitor = NewRelic::Agent::DistributedTraceMonitor.new(@events)
+        @synthetics_monitor        = NewRelic::Agent::SyntheticsMonitor.new(@events)
+        @error_collector           = NewRelic::Agent::ErrorCollector.new
+        @transaction_rules         = NewRelic::Agent::RulesEngine.new
+        @harvest_samplers          = NewRelic::Agent::SamplerCollection.new(@events)
+        @monotonic_gc_profiler     = NewRelic::Agent::VM::MonotonicGCProfiler.new
+        @javascript_instrumentor   = NewRelic::Agent::JavascriptInstrumentor.new(@events)
+        @throughput_monitor        = NewRelic::Agent::ThroughputMonitor.new
 
         @harvester       = NewRelic::Agent::Harvester.new(@events)
         @after_fork_lock = Mutex.new
@@ -140,6 +144,7 @@ module NewRelic
         attr_reader :custom_event_aggregator
         attr_reader :transaction_event_recorder
         attr_reader :attribute_filter
+        attr_reader :throughput_monitor
 
         def transaction_event_aggregator
           @transaction_event_recorder.transaction_event_aggregator
@@ -543,6 +548,7 @@ module NewRelic
           @transaction_event_recorder.drop_buffered_data
           @custom_event_aggregator.reset!
           @sql_sampler.reset!
+
           if Agent.config[:clear_transaction_state_after_fork]
             TransactionState.tl_clear
           end
@@ -1148,6 +1154,7 @@ module NewRelic
             harvest_and_send_for_agent_commands
           end
         ensure
+          throughput_monitor.reset!
           NewRelic::Agent::Database.close_connections
           duration = (Time.now - now).to_f
           NewRelic::Agent.record_metric('Supportability/Harvest', duration)

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

@@ -1639,6 +1639,13 @@ module NewRelic
           :type        => Boolean,
           :allowed_from_server => false,
           :description => 'If <code>true</code>, the agent will clear <code>TransactionState</code> in <code>Agent.drop_buffered_data</code>.'
+        },
+        :'distributed_tracing.enabled' => {
+          :default     => false,
+          :public      => false,
+          :type        => Boolean,
+          :allowed_from_server => false,
+          :description => 'If <code>true</code> enables experimental distributed tracing feature.'
         }
       }.freeze
     end

data/lib/new_relic/agent/distributed_trace_monitor.rb

@@ -0,0 +1,29 @@
+# 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.
+
+require 'new_relic/agent/inbound_request_monitor'
+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
+
+      def on_before_call(request)
+        return unless CrossAppTracing.cross_app_enabled?
+        return unless payload = request[NEWRELIC_TRACE_KEY]
+
+        state = NewRelic::Agent::TransactionState.tl_get
+        txn = state.current_transaction
+        txn.accept_distributed_trace_payload HTTP_TRANSPORT_TYPE, payload
+      end
+    end
+  end
+end

data/lib/new_relic/agent/distributed_trace_payload.rb

@@ -0,0 +1,223 @@
+# 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.
+require 'json'
+require 'base64'
+
+module NewRelic
+  module Agent
+    class DistributedTracePayload
+      VERSION =[0, 0].freeze
+      CALLER_TYPE = "App".freeze
+      POUND = '#'.freeze
+
+      # Key names for serialization
+      VERSION_KEY             = 'v'.freeze
+      DATA_KEY                = 'd'.freeze
+      CALLER_TYPE_KEY         = 'ty'.freeze
+      CALLER_ACCOUNT_KEY      = 'ac'.freeze
+      CALLER_APP_KEY          = 'ap'.freeze
+      ID_KEY                  = 'id'.freeze
+      TRIP_ID_KEY             = 'tr'.freeze
+      SAMPLED_KEY             = 'sa'.freeze
+      PARENT_IDS_KEY          = 'pa'.freeze
+      DEPTH_KEY               = 'de'.freeze
+      ORDER_KEY               = 'or'.freeze
+      TIMESTAMP_KEY           = 'ti'.freeze
+      HOST_KEY                = 'ho'.freeze
+      SYNTHETICS_KEY          = 'sy'.freeze
+      SYNTHETICS_RESOURCE_KEY = 'r'.freeze
+      SYNTHETICS_JOB_KEY      = 'j'.freeze
+      SYNTHETICS_MONITOR_KEY  = 'm'.freeze
+
+      # Intrinsic Keys
+      CALLER_TYPE_INTRINSIC_KEY                = "caller.type".freeze
+      CALLER_APP_INTRINSIC_KEY                 = "caller.app".freeze
+      CALLER_ACCOUNT_ID_INTRINSIC_KEY          = "caller.account".freeze
+      CALLER_TRANSPORT_TYPE_INTRINSIC_KEY      = "caller.transportType".freeze
+      CALLER_TRANSPORT_DURATION_INTRINSIC_KEY  = "caller.transportDuration".freeze
+      CALLER_HOST_INTRINSIC_KEY                = "caller.host".freeze
+      DEPTH_INTRINSIC_KEY                      = "nr.depth".freeze
+      ORDER_INTRINSIC_KEY                      = "nr.order".freeze
+      GUID_INTRINSIC_KEY                       = "nr.guid".freeze
+      REFERRING_TRANSACTION_GUID_INTRINSIC_KEY = "nr.referringTransactionGuid".freeze
+      TRIP_ID_INTRINSIC_KEY                    = "nr.tripId".freeze
+      PARENT_IDS_INTRINSIC_KEY                 = "nr.parentIds".freeze
+      COMMA                                    = ",".freeze
+
+      INTRINSIC_KEYS = [
+        CALLER_TYPE_INTRINSIC_KEY,
+        CALLER_APP_INTRINSIC_KEY,
+        CALLER_ACCOUNT_ID_INTRINSIC_KEY,
+        CALLER_TRANSPORT_TYPE_INTRINSIC_KEY,
+        CALLER_TRANSPORT_DURATION_INTRINSIC_KEY,
+        CALLER_HOST_INTRINSIC_KEY,
+        DEPTH_INTRINSIC_KEY,
+        ORDER_INTRINSIC_KEY,
+        GUID_INTRINSIC_KEY,
+        REFERRING_TRANSACTION_GUID_INTRINSIC_KEY,
+        TRIP_ID_INTRINSIC_KEY,
+        PARENT_IDS_INTRINSIC_KEY
+      ].freeze
+
+      class << self
+        def for_transaction transaction, uri=nil
+          payload = new
+          return payload unless connected?
+
+          payload.version = VERSION
+          payload.caller_type = CALLER_TYPE
+
+          # 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.caller_account_id = account_id
+
+          payload.caller_app_id =  if Agent.config[:application_id].empty?
+            fallback_app_id
+          else
+            Agent.config[:application_id]
+          end
+
+          payload.timestamp = (Time.now.to_f * 1000).round
+          payload.id = transaction.guid
+          payload.trip_id = transaction.distributed_tracing_trip_id
+          payload.sampled = transaction.sampled?
+          payload.parent_ids = transaction.parent_ids
+          payload.depth = transaction.depth + 1
+          payload.order = transaction.order
+          payload.host = uri.host if uri
+
+          if transaction.synthetics_payload
+            payload.synthetics_resource = transaction.synthetics_payload[2]
+            payload.synthetics_job = transaction.synthetics_payload[3]
+            payload.synthetics_monitor = transaction.synthetics_payload[4]
+          end
+
+          payload
+        end
+
+        def from_json serialized_payload
+          raw_payload = JSON.parse serialized_payload
+          payload_data = raw_payload[DATA_KEY]
+
+          payload = new
+          payload.version           = raw_payload[VERSION_KEY]
+          payload.caller_type       = payload_data[CALLER_TYPE_KEY]
+          payload.caller_account_id = payload_data[CALLER_ACCOUNT_KEY]
+          payload.caller_app_id     = payload_data[CALLER_APP_KEY]
+          payload.timestamp         = payload_data[TIMESTAMP_KEY]
+          payload.id                = payload_data[ID_KEY]
+          payload.trip_id           = payload_data[TRIP_ID_KEY]
+          payload.sampled           = payload_data[SAMPLED_KEY]
+          payload.parent_ids        = payload_data[PARENT_IDS_KEY]
+          payload.depth             = payload_data[DEPTH_KEY]
+          payload.order             = payload_data[ORDER_KEY]
+          payload.host              = payload_data[HOST_KEY]
+
+          if payload_synthetics = payload_data[SYNTHETICS_KEY]
+            payload.synthetics_resource = payload_synthetics[SYNTHETICS_RESOURCE_KEY]
+            payload.synthetics_job      = payload_synthetics[SYNTHETICS_JOB_KEY]
+            payload.synthetics_monitor  = payload_synthetics[SYNTHETICS_MONITOR_KEY]
+          end
+
+          payload
+        end
+
+        def from_http_safe http_safe_payload
+          decoded_payload = Base64.strict_decode64 http_safe_payload
+          from_json decoded_payload
+        end
+
+        #assigns intrinsics for the first distributed trace in a trip
+        def assign_initial_intrinsics transaction, payload
+          payload[TRIP_ID_INTRINSIC_KEY] = transaction.distributed_tracing_trip_id
+          payload[DEPTH_INTRINSIC_KEY] = transaction.depth
+          payload[PARENT_IDS_INTRINSIC_KEY] = transaction.parent_ids
+        end
+
+        private
+
+        # We use the presence of the cross_process_id in the config to tell if we
+        # have connected yet.
+        def connected?
+          !!Agent.config[:'cross_process_id']
+        end
+      end
+
+      attr_accessor :version,
+                    :caller_type,
+                    :caller_transport_type,
+                    :caller_account_id,
+                    :caller_app_id,
+                    :id,
+                    :trip_id,
+                    :sampled,
+                    :parent_ids,
+                    :synthetics_resource,
+                    :synthetics_job,
+                    :synthetics_monitor,
+                    :order,
+                    :depth,
+                    :timestamp,
+                    :host
+
+      alias_method :sampled?, :sampled
+
+      def synthetics?
+        !!(synthetics_resource || synthetics_job || synthetics_monitor)
+      end
+
+      def to_json
+        result = {
+          VERSION_KEY => version
+        }
+
+        result[DATA_KEY] = {
+          CALLER_TYPE_KEY    => caller_type,
+          CALLER_ACCOUNT_KEY => caller_account_id,
+          CALLER_APP_KEY     => caller_app_id,
+          ID_KEY             => id,
+          TRIP_ID_KEY        => trip_id,
+          SAMPLED_KEY        => sampled,
+          PARENT_IDS_KEY     => parent_ids,
+          DEPTH_KEY          => depth,
+          ORDER_KEY          => order,
+          HOST_KEY           => host,
+          TIMESTAMP_KEY      => timestamp,
+        }
+
+        if synthetics?
+          result[DATA_KEY][SYNTHETICS_KEY] = {
+            SYNTHETICS_RESOURCE_KEY => synthetics_resource,
+            SYNTHETICS_JOB_KEY      => synthetics_job,
+            SYNTHETICS_MONITOR_KEY  => synthetics_monitor
+          }
+        end
+
+        JSON.dump(result)
+      end
+
+      alias_method :text, :to_json
+
+      def http_safe
+        Base64.strict_encode64 to_json
+      end
+
+      def assign_intrinsics transaction, payload
+        payload[CALLER_TYPE_INTRINSIC_KEY] = caller_type
+        payload[CALLER_APP_INTRINSIC_KEY] = caller_app_id
+        payload[CALLER_ACCOUNT_ID_INTRINSIC_KEY] = caller_account_id
+        payload[CALLER_TRANSPORT_TYPE_INTRINSIC_KEY] = caller_transport_type
+        payload[CALLER_TRANSPORT_DURATION_INTRINSIC_KEY] = transaction.transport_duration
+        payload[CALLER_HOST_INTRINSIC_KEY] = host
+        payload[DEPTH_INTRINSIC_KEY] = depth
+        payload[ORDER_INTRINSIC_KEY] = order
+        payload[GUID_INTRINSIC_KEY] = transaction.guid
+        payload[REFERRING_TRANSACTION_GUID_INTRINSIC_KEY] = id
+        payload[TRIP_ID_INTRINSIC_KEY] = trip_id
+        payload[PARENT_IDS_INTRINSIC_KEY] = parent_ids.join COMMA if parent_ids
+      end
+    end
+  end
+end

data/lib/new_relic/agent/distributed_trace_priority_sampled_buffer.rb

@@ -0,0 +1,72 @@
+# 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.
+
+require 'new_relic/agent/event_buffer'
+require 'set'
+
+module NewRelic
+  module Agent
+    class DistributedTracePrioritySampledBuffer < SampledBuffer
+      attr_reader :seen_lifetime, :captured_lifetime
+
+      def initialize(capacity)
+        @low_priority_indices = []
+        @high_priority_indices = Set.new
+        super
+      end
+
+      def append_sampled(x = nil, &blk)
+        raise ArgumentError, "Expected argument or block, but received both" if x && blk
+
+        @seen += 1
+        @seen_lifetime += 1
+        if @items.size < @capacity
+          x = blk.call if block_given?
+          insert_high_priority x
+          @captured_lifetime += 1
+          return x
+        elsif !@low_priority_indices.empty? # overwite random low priority sample
+          m = rand(@low_priority_indices.size)
+          insert_high_priority x, @low_priority_indices.delete_at(m)
+          return x
+        else
+          NewRelic::Agent.increment_metric "Supportability/DistributedTracing/SampledBufferFailure/BufferFull"
+          return nil
+        end
+      end
+
+      def append_event(x = nil, &blk)
+        raise ArgumentError, "Expected argument or block, but received both" if x && blk
+
+        if @items.size < @capacity
+          x = blk.call if block_given?
+          insert_low_priority x
+          @captured_lifetime += 1
+          return x
+        else
+          m = rand(@seen) # [0, @seen)
+          if m < @capacity && !@high_priority_indices.include?(m)
+            x = blk.call if block_given?
+            insert_low_priority x, m
+            return x
+          else
+            # discard current sample
+            return nil
+          end
+        end
+      end
+
+      def insert_low_priority x, index = @items.size
+        @items[index] = x
+        @low_priority_indices << index
+      end
+
+      def insert_high_priority x, index = @items.size
+        @items[index] = x
+        @high_priority_indices << index
+      end
+    end
+  end
+end
+