newrelic-infinite_tracing 8.9.0 → 8.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6712a9c3ffb94789cc17ccdcce33735ba3afdfd6bab87b2e03e98f54eba7f1c
-  data.tar.gz: b9e852c742440d75b8c89ba20cd49a92164ead327ddedbeedeefdff674970282
+  metadata.gz: 3d82f3d8556283da9e25f2789f9e83fac58f65b3df011af7d2adf2fd32894917
+  data.tar.gz: '0995598d2923cafdbc3eb38a663500ea48e37ba207cb6c58a1e8a15dbcb25d58'
 SHA512:
-  metadata.gz: a9cca5b997416ec8b89e45c7833b185429343ce89e899eddcf1620316aaa09a51258c2b505c49cf4b6f69f8ee7daab596edb5dcdb3965bc9a0ee7efc0fce944a
-  data.tar.gz: 3197dc1c5cf9c01631b7a7499fa70b74e218b52c70302f85a03dbc39317feb47122e79331c6575df22ac181b5a84a38aee01374b39ed176e4e876bbbe0b3715a
+  metadata.gz: 2aeb0110716ff65afcc46ef898690cdd951d8318273709840ed303657679dd4fa8110f7dd229fcce0b0a36806d8ced9e16e20297dae1d19f1a4d88093c48f7a2
+  data.tar.gz: d41478145f1891e1f02d5df82bbca1fe711c5d5a99fd352c118e6441635f86cbbf0255b963e791e2d87c1aefb3085a65786306491e89a18032c9907462e6cd0b

data/Gemfile

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

data/Rakefile

@@ -1,3 +1,7 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'rake/testtask'
 require "#{File.dirname(__FILE__)}/tasks/all.rb"
@@ -12,7 +16,7 @@ task :console do
 end
 
 Rake::TestTask.new do |t|
-  ROOT = File.join File.dirname(__FILE__)
+  ROOT = File.join(File.dirname(__FILE__))
   $LOAD_PATH << ROOT
 
   file_pattern = "#{ROOT}/**/*_test.rb"

data/lib/infinite_tracing/agent_integrations/agent.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
 module NewRelic::Agent
-  NewRelic::Agent.logger.debug "Installing Infinite Tracer in Agent"
+  NewRelic::Agent.logger.debug("Installing Infinite Tracer in Agent")
 
   Agent.class_eval do
     def new_infinite_tracer
@@ -12,7 +11,7 @@ module NewRelic::Agent
       # entire start up process for the Agent.
       InfiniteTracing::Client.new.tap do |client|
         @infinite_tracer_thread = InfiniteTracing::Worker.new(:infinite_tracer) do
-          NewRelic::Agent.logger.debug "Opening Infinite Tracer Stream with gRPC server"
+          NewRelic::Agent.logger.debug("Opening Infinite Tracer Stream with gRPC server")
           client.start_streaming
         end
       end
@@ -22,18 +21,19 @@ module NewRelic::Agent
     # this clears the data, clears connection attempts, and
     # waits a while to reconnect.
     def handle_force_restart(error)
-      ::NewRelic::Agent.logger.debug error.message
+      ::NewRelic::Agent.logger.debug(error.message)
       drop_buffered_data
       @service.force_restart if @service
       @connect_state = :pending
       close_infinite_tracer
-      sleep 30
+      sleep(30)
     end
 
     # Whenever we reconnect, close and restart
     def close_infinite_tracer
-      NewRelic::Agent.logger.debug "Closing infinite tracer threads"
+      NewRelic::Agent.logger.debug("Closing infinite tracer threads")
       return unless @infinite_tracer_thread
+
       @infinite_tracer_thread.join
       @infinite_tracer_thread.stop
       @infinite_tracer_thread = nil

data/lib/infinite_tracing/agent_integrations/datastore_segment.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -12,7 +11,7 @@ module NewRelic
           return if transaction.ignore?
 
           tracer = ::NewRelic::Agent.agent.infinite_tracer
-          tracer << Proc.new { SpanEventPrimitive.for_datastore_segment self }
+          tracer << proc { SpanEventPrimitive.for_datastore_segment(self) }
         end
       end
     end

data/lib/infinite_tracing/agent_integrations/external_request_segment.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -12,7 +11,7 @@ module NewRelic
           return if transaction.ignore?
 
           tracer = ::NewRelic::Agent.agent.infinite_tracer
-          tracer << Proc.new { SpanEventPrimitive.for_external_request_segment self }
+          tracer << proc { SpanEventPrimitive.for_external_request_segment(self) }
         end
       end
     end

data/lib/infinite_tracing/agent_integrations/segment.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -16,7 +15,7 @@ module NewRelic
           return if transaction.ignore?
 
           tracer = ::NewRelic::Agent.agent.infinite_tracer
-          tracer << Proc.new { SpanEventPrimitive.for_segment self }
+          tracer << proc { SpanEventPrimitive.for_segment(self) }
         end
       end
     end

data/lib/infinite_tracing/agent_integrations.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -6,7 +5,7 @@
 module NewRelic::Agent
   module InfiniteTracing
     if Config.enabled? || Config.test_framework?
-      NewRelic::Agent.logger.debug "Integrating Infinite Tracer with Agent"
+      NewRelic::Agent.logger.debug("Integrating Infinite Tracer with Agent")
 
       require_relative 'agent_integrations/agent'
       require_relative 'agent_integrations/segment'
@@ -14,7 +13,7 @@ module NewRelic::Agent
       require_relative 'agent_integrations/external_request_segment'
 
     else
-      NewRelic::Agent.logger.debug "Skipped Integrating Infinite Tracer with Agent"
+      NewRelic::Agent.logger.debug("Skipped Integrating Infinite Tracer with Agent")
     end
   end
 end

data/lib/infinite_tracing/channel.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -6,19 +5,55 @@
 module NewRelic::Agent
   module InfiniteTracing
     class Channel
+      COMPRESSION_LEVELS = %i[none low medium high].freeze
+      DEFAULT_COMPRESSION_LEVEL = :none
+
       def stub
-        NewRelic::Agent.logger.debug "Infinite Tracer Opening Channel to #{host_and_port}"
+        NewRelic::Agent.logger.debug("Infinite Tracer Opening Channel to #{host_and_port}")
 
-        Com::Newrelic::Trace::V1::IngestService::Stub.new \
+        Com::Newrelic::Trace::V1::IngestService::Stub.new( \
           host_and_port,
           credentials,
-          channel_override: channel
+          channel_override: channel,
+          channel_args: channel_args
+        )
       end
 
       def channel
         GRPC::Core::Channel.new(host_and_port, settings, credentials)
       end
 
+      def channel_args
+        return NewRelic::EMPTY_HASH unless compression_enabled?
+
+        GRPC::Core::CompressionOptions.new(compression_options).to_channel_arg_hash
+      end
+
+      def compression_enabled?
+        compression_level != :none
+      end
+
+      def compression_level
+        @compression_level ||= begin
+          level = if valid_compression_level?(configured_compression_level)
+            configured_compression_level
+          else
+            DEFAULT_COMPRESSION_LEVEL
+          end
+          NewRelic::Agent.logger.debug("Infinite Tracer compression level set to #{level}")
+          level
+        end
+      end
+
+      def compression_options
+        {default_algorithm: :gzip,
+         default_level: compression_level}
+      end
+
+      def configured_compression_level
+        NewRelic::Agent.config[:'infinite_tracing.compression_level']
+      end
+
       def credentials
         # Uses system configured certificates by default
         GRPC::Core::ChannelCredentials.new
@@ -34,6 +69,15 @@ module NewRelic::Agent
           'grpc.enable_deadline_checking' => 0
         }
       end
+
+      def valid_compression_level?(level)
+        return true if COMPRESSION_LEVELS.include?(level)
+
+        NewRelic::Agent.logger.error("Invalid compression level '#{level}' specified! Must be one of " \
+          "#{COMPRESSION_LEVELS.join('|')}. Using default level of '#{DEFAULT_COMPRESSION_LEVEL}'")
+
+        false
+      end
     end
   end
 end

data/lib/infinite_tracing/client.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -22,15 +21,20 @@ module NewRelic::Agent
         @lock = Mutex.new
       end
 
-      def << segment
+      def <<(segment)
         buffer << segment
       end
 
+      def batching_enabled?
+        NewRelic::Agent.config[:'infinite_tracing.batching']
+      end
+
       # Transfers spans in streaming buffer from previous
       # client (if any) and returns self (so we chain the call)
-      def transfer previous_client
+      def transfer(previous_client)
         return self unless previous_client
-        previous_client.buffer.transfer buffer
+
+        previous_client.buffer.transfer(buffer)
         self
       end
 
@@ -38,7 +42,7 @@ module NewRelic::Agent
       # client is currently suspended.
       def new_streaming_buffer
         buffer_class = suspended? ? SuspendedStreamingBuffer : StreamingBuffer
-        buffer_class.new Config.span_events_queue_size
+        buffer_class.new(Config.span_events_queue_size)
       end
 
       def buffer
@@ -50,30 +54,30 @@ module NewRelic::Agent
       end
 
       # Turns camelcase base class name into upper snake case version of the name.
-      def formatted_class_name class_name
+      def formatted_class_name(class_name)
         class_name = class_name.split(":")[-1]
         (class_name.gsub!(/(.)([A-Z])/, '\1_\2') || class_name).upcase
       end
 
       # Literal codes are all mapped to unique class names, so we can deduce the
       # name of the error to report in the metric from the error's class name.
-      def grpc_error_metric_name error
+      def grpc_error_metric_name(error)
         GRPC_ERROR_NAME_METRIC % formatted_class_name(error.class.name)
       end
 
       # Reports AND logs general response metric along with a more specific error metric
-      def record_error_metrics_and_log error
-        NewRelic::Agent.record_metric RESPONSE_ERROR_METRIC, 0.0
-        if error.is_a? GRPC::BadStatus
-          NewRelic::Agent.record_metric grpc_error_metric_name(error), 0.0
+      def record_error_metrics_and_log(error)
+        NewRelic::Agent.record_metric(RESPONSE_ERROR_METRIC, 0.0)
+        if error.is_a?(GRPC::BadStatus)
+          NewRelic::Agent.record_metric(grpc_error_metric_name(error), 0.0)
         else
-          NewRelic::Agent.record_metric GRPC_OTHER_ERROR_METRIC, 0.0
+          NewRelic::Agent.record_metric(GRPC_OTHER_ERROR_METRIC, 0.0)
         end
-        NewRelic::Agent.logger.warn "gRPC response error received.", error
+        NewRelic::Agent.logger.warn("gRPC response error received.", error)
       end
 
-      def handle_error error
-        record_error_metrics_and_log error
+      def handle_error(error)
+        record_error_metrics_and_log(error)
 
         case error
         when GRPC::Unavailable then restart
@@ -81,7 +85,7 @@ module NewRelic::Agent
         when GRPC::Unimplemented then suspend
         else
           # Set exponential backoff to false so we'll reconnect at periodic (15 second) intervals instead
-          start_streaming false
+          start_streaming(false)
         end
       end
 
@@ -95,8 +99,8 @@ module NewRelic::Agent
       # server and re-establish the gRPC bi-directional stream.  Useful for the server
       # to initiate a load-balancing scheme.
       def handle_close
-        NewRelic::Agent.logger.debug "The gRPC Trace Observer closed the stream with OK response. " \
-          "Restarting the stream."
+        NewRelic::Agent.logger.debug("The gRPC Trace Observer closed the stream with OK response. " \
+          "Restarting the stream.")
         start_streaming
       end
 
@@ -105,11 +109,12 @@ module NewRelic::Agent
       # The Suspended Streaming Buffer will be installed in this state.
       def suspend
         return if suspended?
+
         @lock.synchronize do
           @suspended = true
           @buffer = new_streaming_buffer
-          NewRelic::Agent.logger.warn "The Trace Observer host signaled to suspend streaming span events. " \
-            "No more span events will be sent during this session."
+          NewRelic::Agent.logger.warn("The Trace Observer host signaled to suspend streaming span events. " \
+            "No more span events will be sent during this session.")
         end
       end
 
@@ -123,7 +128,7 @@ module NewRelic::Agent
         @lock.synchronize do
           old_buffer = @buffer
           @buffer = new_streaming_buffer
-          old_buffer.transfer @buffer
+          old_buffer.transfer(@buffer)
         end
       end
 
@@ -135,24 +140,30 @@ module NewRelic::Agent
 
       def stop
         return unless @response_handler
+
         @lock.synchronize do
           @response_handler.stop
           @response_handler = nil
         end
       end
 
-      def start_streaming exponential_backoff = true
+      def start_streaming(exponential_backoff = true)
         return if suspended?
+
         Connection.instance.wait_for_agent_connect
-        @lock.synchronize { @response_handler = record_spans exponential_backoff }
+        @lock.synchronize { response_handler(exponential_backoff) }
+      end
+
+      def record_spans(exponential_backoff)
+        RecordStatusHandler.new(self, Connection.record_spans(self, buffer.enumerator, exponential_backoff))
       end
 
-      def record_spans exponential_backoff
-        RecordStatusHandler.new self, Connection.record_spans(self, buffer.enumerator, exponential_backoff)
+      def record_span_batches(exponential_backoff)
+        RecordStatusHandler.new(self, Connection.record_span_batches(self, buffer.batch_enumerator, exponential_backoff))
       end
 
-      def record_span_batches exponential_backoff
-        RecordStatusHandler.new self, Connection.record_span_batches(self, buffer.batch_enumerator, exponential_backoff)
+      def response_handler(backoff)
+        @response_handler = batching_enabled? ? record_span_batches(backoff) : record_spans(backoff)
       end
     end
   end

data/lib/infinite_tracing/config.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -48,18 +47,18 @@ module NewRelic::Agent
       end
 
       # removes the scheme and port from a host entry.
-      def without_scheme_or_port url
+      def without_scheme_or_port(url)
         url.gsub(%r{^https?://|:\d+$}, '')
       end
 
       def trace_observer_host
-        without_scheme_or_port NewRelic::Agent.config[:'infinite_tracing.trace_observer.host']
+        without_scheme_or_port(NewRelic::Agent.config[:'infinite_tracing.trace_observer.host'])
       end
 
       # If the port is declared on the host entry, it overrides the port entry because otherwise
       # we'd need to figure out if user supplied the port or if the default source config set
       # the port.  To help with debugging configuration issues, we log whenever the port entry
-      # is overriden by the presence of the port on the host entry.
+      # is overridden by the presence of the port on the host entry.
       def port_from_host_entry
         port_str = NewRelic::Agent.config[:'infinite_tracing.trace_observer.host'].scan(%r{:(\d+)$}).flatten
         if port = (port_str[0] and port_str[0].to_i)
@@ -75,7 +74,7 @@ module NewRelic::Agent
       end
 
       # The scheme is based on whether the Trace Observer is running locally or remotely.
-      # Remote unsecure (unencypted) streaming is disallowed!
+      # Remote unsecure (unencrypted) streaming is disallowed!
       def trace_observer_scheme
         local? ? NewRelic::HTTP : NewRelic::HTTPS
       end
@@ -85,7 +84,7 @@ module NewRelic::Agent
         if trace_observer_configured?
           URI("#{trace_observer_scheme}://#{trace_observer_host_and_port}")
         else
-          NewRelic::Agent.logger.error TRACE_OBSERVER_NOT_CONFIGURED_ERROR
+          NewRelic::Agent.logger.error(TRACE_OBSERVER_NOT_CONFIGURED_ERROR)
           raise TRACE_OBSERVER_NOT_CONFIGURED_ERROR
         end
       end

data/lib/infinite_tracing/connection.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -25,9 +24,10 @@ module NewRelic::Agent
         begin
           Connection.instance.notify_agent_started
         rescue => error
-          NewRelic::Agent.logger.error \
+          NewRelic::Agent.logger.error( \
             "Error during notify :server_source_configuration_added event",
             error
+          )
         end
       end
 
@@ -43,15 +43,15 @@ module NewRelic::Agent
         # RPC calls will pass the calling client instance in.  We track this
         # so we're able to signal the client to restart when connectivity to the
         # server is disrupted.
-        def record_spans client, enumerator, exponential_backoff
-          instance.record_spans client, enumerator, exponential_backoff
+        def record_spans(client, enumerator, exponential_backoff)
+          instance.record_spans(client, enumerator, exponential_backoff)
         end
 
         # RPC calls will pass the calling client instance in.  We track this
         # so we're able to signal the client to restart when connectivity to the
         # server is disrupted.
-        def record_span_batches client, enumerator, exponential_backoff
-          instance.record_span_batch client, enumerator, exponential_backoff
+        def record_span_batches(client, enumerator, exponential_backoff)
+          instance.record_span_batches(client, enumerator, exponential_backoff)
         end
 
         def metadata
@@ -61,17 +61,17 @@ module NewRelic::Agent
 
       # We attempt to connect and record spans with reconnection backoff in order to deal with
       # unavailable errors coming from the stub being created and record_span call
-      def record_spans client, enumerator, exponential_backoff
+      def record_spans(client, enumerator, exponential_backoff)
         @active_clients[client] = client
-        with_reconnection_backoff(exponential_backoff) { rpc.record_span enumerator, metadata: metadata }
+        with_reconnection_backoff(exponential_backoff) { rpc.record_span(enumerator, metadata: metadata) }
       end
 
       # RPC calls will pass the calling client instance in.  We track this
       # so we're able to signal the client to restart when connectivity to the
       # server is disrupted.
-      def record_span_batches client, enumerator, exponential_backoff
+      def record_span_batches(client, enumerator, exponential_backoff)
         @active_clients[client] = client
-        with_reconnection_backoff(exponential_backoff) { rpc.record_span_batch enumerator, metadata: metadata }
+        with_reconnection_backoff(exponential_backoff) { rpc.record_span_batch(enumerator, metadata: metadata) }
       end
 
       # Acquires the new channel stub for the RPC calls.
@@ -147,21 +147,21 @@ module NewRelic::Agent
       end
 
       # Continues retrying the connection at backoff intervals until a successful connection is made
-      def with_reconnection_backoff exponential_backoff = true, &block
+      def with_reconnection_backoff(exponential_backoff = true, &block)
         @connection_attempts = 0
         begin
           yield
         rescue => exception
           retry_connection_period = retry_connection_period(exponential_backoff)
-          ::NewRelic::Agent.logger.error "Error establishing connection with infinite tracing service:", exception
-          ::NewRelic::Agent.logger.info "Will re-attempt infinte tracing connection in #{retry_connection_period} seconds"
-          sleep retry_connection_period
+          ::NewRelic::Agent.logger.error("Error establishing connection with infinite tracing service:", exception)
+          ::NewRelic::Agent.logger.info("Will re-attempt infinite tracing connection in #{retry_connection_period} seconds")
+          sleep(retry_connection_period)
           note_connect_failure
           retry
         end
       end
 
-      def retry_connection_period exponential_backoff = true
+      def retry_connection_period(exponential_backoff = true)
         if exponential_backoff
           NewRelic::CONNECT_RETRY_PERIODS[@connection_attempts] || NewRelic::MAX_RETRY_PERIOD
         else

data/lib/infinite_tracing/constants.rb

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

data/lib/infinite_tracing/proto/infinite_tracing_pb.rb

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

data/lib/infinite_tracing/proto/infinite_tracing_services_pb.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -6,7 +5,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: infinite_tracing.proto for package 'com.newrelic.trace.v1'
 # Original file comments:
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 #

data/lib/infinite_tracing/proto.rb

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

data/lib/infinite_tracing/record_status_handler.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -6,7 +5,7 @@
 module NewRelic::Agent
   module InfiniteTracing
     class RecordStatusHandler
-      def initialize client, enumerator
+      def initialize(client, enumerator)
         @client = client
         @enumerator = enumerator
         @messages_seen = nil
@@ -18,34 +17,40 @@ module NewRelic::Agent
         @messages_seen ? @messages_seen.messages_seen : 0
       end
 
-      def start_handler
-        Worker.new self.class.name do
-          begin
-            @enumerator.each do |response|
-              break if response.nil? || response.is_a?(Exception)
-              @lock.synchronize do
-                @messages_seen = response
-                NewRelic::Agent.logger.debug "gRPC Infinite Tracer Observer saw #{messages_seen} messages"
-              end
-            end
-            NewRelic::Agent.logger.debug "gRPC Infinite Tracer Observer closed the stream"
-            @client.handle_close
-          rescue => error
-            @client.handle_error error
-          end
-        end
-      rescue => error
-        NewRelic::Agent.logger.error "gRPC Worker Error", error
-      end
-
       def stop
         return if @worker.nil?
+
         @lock.synchronize do
-          NewRelic::Agent.logger.debug "gRPC Stopping Response Handler"
+          NewRelic::Agent.logger.debug("gRPC Stopping Response Handler")
           @worker.stop
           @worker = nil
         end
       end
+
+      private
+
+      def handle_response
+        @enumerator.each do |response|
+          break if response.nil? || response.is_a?(Exception)
+
+          @lock.synchronize do
+            @messages_seen = response
+            NewRelic::Agent.logger.debug("gRPC Infinite Tracer Observer saw #{messages_seen} messages")
+          end
+        end
+      end
+
+      def start_handler
+        Worker.new(self.class.name) do
+          handle_response
+          NewRelic::Agent.logger.debug("gRPC Infinite Tracer Observer closed the stream")
+          @client.handle_close
+        rescue => error
+          @client.handle_error(error)
+        end
+      rescue => error
+        NewRelic::Agent.logger.error("gRPC Worker Error", error)
+      end
     end
   end
 end

data/lib/infinite_tracing/streaming_buffer.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -18,10 +17,14 @@ module NewRelic::Agent
       DEFAULT_QUEUE_SIZE = 10_000
       FLUSH_DELAY = 0.005
       MAX_FLUSH_WAIT = 3 # three seconds
+      # To ensure that two bits of info for the same transaction
+      # are recognized as belonging together, set a maximum time
+      # in seconds to elapse between batch submissions.
+      MAX_BATCH_HOLD = 5
 
       attr_reader :queue
 
-      def initialize max_size = DEFAULT_QUEUE_SIZE
+      def initialize(max_size = DEFAULT_QUEUE_SIZE)
         @max_size = max_size
         @lock = Mutex.new
         @queue = Queue.new
@@ -30,9 +33,9 @@ module NewRelic::Agent
 
       # Dumps the contents of this streaming buffer onto
       # the given buffer and closes the queue
-      def transfer new_buffer
+      def transfer(new_buffer)
         @lock.synchronize do
-          until @queue.empty? do new_buffer.push @queue.pop end
+          until @queue.empty? do new_buffer.push(@queue.pop) end
           @queue.close
         end
       end
@@ -45,11 +48,11 @@ module NewRelic::Agent
       # When a restart signal is received, the queue is
       # locked with a mutex, blocking the push until
       # the queue has restarted.
-      def << segment
+      def <<(segment)
         @lock.synchronize do
           clear_queue if @queue.size >= @max_size
-          NewRelic::Agent.increment_metric SPANS_SEEN_METRIC
-          @queue.push segment
+          NewRelic::Agent.increment_metric(SPANS_SEEN_METRIC)
+          @queue.push(segment)
         end
       end
 
@@ -57,19 +60,19 @@ module NewRelic::Agent
       # supportability metric for the event.
       def clear_queue
         @queue.clear
-        NewRelic::Agent.increment_metric QUEUE_DUMPED_METRIC
+        NewRelic::Agent.increment_metric(QUEUE_DUMPED_METRIC)
       end
 
       # Waits for the queue to be fully consumed or for the
       # waiting consumers to release.
       def flush_queue
-        @queue.num_waiting.times { @queue.push nil }
+        @queue.num_waiting.times { @queue.push(nil) }
         close_queue
 
         # Logs if we're throwing away spans because nothing's
         # waiting to take them off the queue.
         if @queue.num_waiting == 0 && !@queue.empty?
-          NewRelic::Agent.logger.warn "Discarding #{@queue.size} segments on Streaming Buffer"
+          NewRelic::Agent.logger.warn("Discarding #{@queue.size} segments on Streaming Buffer")
           return
         end
 
@@ -92,10 +95,11 @@ module NewRelic::Agent
       # application thread.
       def enumerator
         return enum_for(:enumerator) unless block_given?
+
         loop do
           if segment = @queue.pop(false)
-            NewRelic::Agent.increment_metric SPANS_SENT_METRIC
-            yield transform(segment)
+            NewRelic::Agent.increment_metric(SPANS_SENT_METRIC)
+            yield(transform(segment))
 
           else
             raise ClosedQueueError
@@ -117,18 +121,21 @@ module NewRelic::Agent
       # the gRPC call's thread rather than in the main
       # application thread.
       def batch_enumerator
-        return enum_for(:enumerator) unless block_given?
+        return enum_for(:batch_enumerator) unless block_given?
+
+        last_time = Process.clock_gettime(Process::CLOCK_REALTIME)
         loop do
           if proc_or_segment = @queue.pop(false)
-            NewRelic::Agent.increment_metric SPANS_SENT_METRIC
+            NewRelic::Agent.increment_metric(SPANS_SENT_METRIC)
             @batch << transform(proc_or_segment)
-            if @batch.size >= BATCH_SIZE
-              yield SpanBatch.new(spans: @batch)
+            if batch_ready?(last_time)
+              yield(SpanBatch.new(spans: @batch))
+              last_time = Process.clock_gettime(Process::CLOCK_REALTIME)
               @batch.clear
             end
 
           else
-            yield SpanBatch.new(spans: @batch) unless @batch.empty?
+            yield(SpanBatch.new(spans: @batch)) unless @batch.empty?
             raise ClosedQueueError
           end
         end
@@ -136,7 +143,11 @@ module NewRelic::Agent
 
       private
 
-      def span_event proc_or_segment
+      def batch_ready?(last_time)
+        @batch.size >= BATCH_SIZE || Process.clock_gettime(Process::CLOCK_REALTIME) - last_time >= MAX_BATCH_HOLD
+      end
+
+      def span_event(proc_or_segment)
         if proc_or_segment.is_a?(Proc)
           proc_or_segment.call
         else
@@ -144,8 +155,8 @@ module NewRelic::Agent
         end
       end
 
-      def transform proc_or_segment
-        Span.new Transformer.transform(span_event proc_or_segment)
+      def transform(proc_or_segment)
+        Span.new(Transformer.transform(span_event(proc_or_segment)))
       end
     end
   end

data/lib/infinite_tracing/suspended_streaming_buffer.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -13,16 +12,16 @@ module NewRelic::Agent
       extend Forwardable
       def_delegators :@empty_buffer, :empty?, :push
 
-      def initialize max_size = DEFAULT_QUEUE_SIZE
+      def initialize(max_size = DEFAULT_QUEUE_SIZE)
         @empty_buffer = NewRelic::EMPTY_ARRAY
       end
 
       # updates the seen metric and discards the segment
-      def << segment
-        NewRelic::Agent.increment_metric SPANS_SEEN_METRIC
+      def <<(segment)
+        NewRelic::Agent.increment_metric(SPANS_SEEN_METRIC)
       end
 
-      def transfer new_buffer
+      def transfer(new_buffer)
         # NOOP
       end
 

data/lib/infinite_tracing/transformer.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -8,7 +7,7 @@ module NewRelic::Agent
     module Transformer
       extend self
 
-      def transform span_event
+      def transform(span_event)
         intrinsics, user_attributes, agent_attributes = span_event
         {
           "trace_id" => intrinsics[NewRelic::Agent::SpanEventPrimitive::TRACE_ID_KEY],
@@ -34,11 +33,11 @@ module NewRelic::Agent
         KLASS_TO_ARG[BigDecimal] = :double_value
       end
 
-      def safe_param_name value
+      def safe_param_name(value)
         KLASS_TO_ARG[value.class] || raise("Unhandled class #{value.class.name}")
       end
 
-      def hash_to_attributes values
+      def hash_to_attributes(values)
         values.map do |key, value|
           begin
             [key, AttributeValue.new(safe_param_name(value) => value)]

data/lib/infinite_tracing/version.rb

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

data/lib/infinite_tracing/worker.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -12,7 +11,7 @@ module NewRelic::Agent
     class Worker
       attr_reader :name, :error
 
-      def initialize name, &job
+      def initialize(name, &job)
         @name = name
         @job = job
         @error = nil
@@ -23,8 +22,10 @@ module NewRelic::Agent
 
       def status
         return "error" if error?
+
         @lock.synchronize do
           return "stopped" if @worker_thread.nil?
+
           @worker_thread.status || "idle"
         end
       end
@@ -33,16 +34,18 @@ module NewRelic::Agent
         !!@error
       end
 
-      def join timeout = nil
+      def join(timeout = nil)
         return unless @worker_thread
-        NewRelic::Agent.logger.debug "joining worker #{@name} thread..."
-        @worker_thread.join timeout
+
+        NewRelic::Agent.logger.debug("joining worker #{@name} thread...")
+        @worker_thread.join(timeout)
       end
 
       def stop
         @lock.synchronize do
           return unless @worker_thread
-          NewRelic::Agent.logger.debug "stopping worker #{@name} thread..."
+
+          NewRelic::Agent.logger.debug("stopping worker #{@name} thread...")
           @worker_thread.kill
           @worker_thread = nil
         end
@@ -51,8 +54,8 @@ module NewRelic::Agent
       private
 
       def start_thread
-        NewRelic::Agent.logger.debug "starting worker #{@name} thread..."
-        @worker_thread = Thread.new do
+        NewRelic::Agent.logger.debug("starting worker #{@name} thread...")
+        @worker_thread = NewRelic::Agent::Threading::AgentThread.create("infinite_tracing_worker") do
           catch(:exit) do
             begin
               @job.call
@@ -63,7 +66,7 @@ module NewRelic::Agent
           end
         end
         @worker_thread.abort_on_exception = true
-        if @worker_thread.respond_to? :report_on_exception
+        if @worker_thread.respond_to?(:report_on_exception)
           @worker_thread.report_on_exception = NewRelic::Agent.config[:log_level] == "debug"
         end
       end

data/lib/infinite_tracing.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -7,7 +6,7 @@ require 'uri'
 
 require 'newrelic_rpm'
 
-NewRelic::Agent.logger.debug "Detected New Relic Infinite Tracing Gem"
+NewRelic::Agent.logger.debug("Detected New Relic Infinite Tracing Gem")
 
 require 'infinite_tracing/version'
 require 'infinite_tracing/config'
@@ -20,7 +19,7 @@ DependencyDetection.defer do
   end
 
   executes do
-    NewRelic::Agent.logger.debug "Loading New Relic Infinite Tracing Library"
+    NewRelic::Agent.logger.debug("Loading New Relic Infinite Tracing Library")
 
     require 'infinite_tracing/proto'
 

data/lib/new_relic/infinite_tracing.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -7,7 +6,7 @@ require 'uri'
 
 require 'newrelic_rpm'
 
-NewRelic::Agent.logger.debug "Detected New Relic Infinite Tracing Gem"
+NewRelic::Agent.logger.debug("Detected New Relic Infinite Tracing Gem")
 
 require 'new_relic/infinite_tracing/version'
 require 'new_relic/infinite_tracing/config'
@@ -20,7 +19,7 @@ DependencyDetection.defer do
   end
 
   executes do
-    NewRelic::Agent.logger.debug "Loading New Relic Infinite Tracing Library"
+    NewRelic::Agent.logger.debug("Loading New Relic Infinite Tracing Library")
 
     require 'new_relic/infinite_tracing/proto'
 

data/lib/newrelic/infinite_tracing.rb

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

data/lib/proto/infinite_tracing.proto

@@ -1,4 +1,3 @@
-// encoding: utf-8
 // This file is distributed under New Relic's license terms.
 // See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
@@ -39,4 +38,4 @@ message AttributeValue {
 
 message RecordStatus {
   uint64 messages_seen = 1;
-}
+}

data/newrelic-infinite_tracing.gemspec

@@ -1,4 +1,3 @@
-#-*- coding: utf-8 -*-
 # frozen_string_literal: true
 
 require 'fileutils'
@@ -12,13 +11,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'new_relic/version'
 
 Gem::Specification.new do |s|
-  def self.copy_files filelist
-    subfolder = File.expand_path File.dirname(__FILE__)
+  def self.copy_files(filelist)
+    subfolder = File.expand_path(File.dirname(__FILE__))
 
     filelist.each do |filename|
       source_full_filename = File.expand_path(filename)
       dest_full_filename = File.join(subfolder, File.basename(filename))
-      FileUtils.cp source_full_filename, dest_full_filename
+      FileUtils.cp(source_full_filename, dest_full_filename)
     end
   end
 
@@ -27,12 +26,12 @@ Gem::Specification.new do |s|
     "../CONTRIBUTING.md"
   ]
 
-  self.copy_files shared_files
+  self.copy_files(shared_files)
 
   s.name = "newrelic-infinite_tracing"
   s.version = NewRelic::VERSION::STRING
   s.required_ruby_version = '>= 2.5.0'
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to?(:required_rubygems_version=)
   s.authors = ["Tanna McClure", "Kayla Reopelle", "James Bunch", "Hannah Ramadan"]
   s.licenses = ['Apache-2.0']
   s.description = <<-EOS
@@ -69,7 +68,7 @@ Gem or plugin, hosted on https://github.com/newrelic/newrelic-ruby-agent/
   s.files = file_list
 
   s.homepage = "https://github.com/newrelic/newrelic-ruby-agent/tree/main/infinite_tracing"
-  s.require_paths = ["lib", "infinite_tracing"]
+  s.require_paths = %w[lib infinite_tracing]
   s.summary = "New Relic Infinite Tracing for the Ruby agent"
 
   s.add_dependency 'newrelic_rpm', NewRelic::VERSION::STRING
@@ -78,7 +77,8 @@ Gem or plugin, hosted on https://github.com/newrelic/newrelic-ruby-agent/
   s.add_development_dependency 'rake', '12.3.3'
   s.add_development_dependency 'rb-inotify', '0.9.10' # locked to support < Ruby 2.3 (and listen 3.0.8)
   s.add_development_dependency 'listen', '3.0.8' # locked to support < Ruby 2.3
-  s.add_development_dependency 'minitest', '~> 5.14.0'
+  s.add_development_dependency 'minitest', '~> 5.15'
+  s.add_development_dependency 'minitest-stub-const', '0.6'
   s.add_development_dependency 'mocha', '~> 1.9.0'
   s.add_development_dependency 'pry-nav', '~> 0.3.0'
   s.add_development_dependency 'pry-stack_explorer', '~> 0.4.9'

data/tasks/all.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 # This is required to load in task definitions
 Dir.glob(File.join(File.dirname(__FILE__), '*.rake')) do |file|

data/tasks/helpers/license.rb

@@ -0,0 +1,25 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module License
+  def extract_license_terms(file_contents)
+    text = []
+    text << file_contents.shift while !file_contents.empty? && file_contents[0] =~ /^#/
+    text << ""
+    text
+  end
+
+  def add_license_preamble_and_remove_requires(output_path)
+    gemspec_path = File.expand_path(File.join(output_path, '..', '..', '..', '..', '..'))
+    license_terms = extract_license_terms(File.readlines(File.join(gemspec_path, "Gemfile")))
+    Dir.glob(File.join(output_path, "*.rb")) do |filename|
+      contents = File.readlines(filename)
+      contents.reject! { |r| r =~ /^\s*require\s.*$/ }
+      File.open(filename, 'w') do |output|
+        output.puts license_terms
+        output.puts contents
+      end
+    end
+  end
+end

data/tasks/proto.rake

@@ -1,38 +1,18 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require_relative 'helpers/license'
+include License
 
 namespace :proto do
   desc "Generate proto files"
-
   task :generate do
-    def extract_license_terms file_contents
-      text = []
-      text << file_contents.shift while !file_contents.empty? && file_contents[0] =~ /^#/
-      text << ""
-      text
-    end
-
-    # adds the NewRelic License notice to the top of the generated files
-    # Removes require lines since these are replicated in the proto.rb file.
-    def add_license_preamble_and_remove_requires output_path
-      gemspec_path = File.expand_path(File.join(output_path, '..', '..', '..', '..', '..'))
-      license_terms = extract_license_terms File.readlines(File.join(gemspec_path, "Gemfile"))
-      Dir.glob(File.join output_path, "*.rb") do |filename|
-        contents = File.readlines filename
-        contents.reject! { |r| r =~ /^\s*require\s.*$/ }
-        File.open(filename, 'w') do |output|
-          output.puts license_terms
-          output.puts contents
-        end
-      end
-    end
-
-    gem_folder = File.expand_path File.join(File.dirname(__FILE__), "..")
-    proto_filename = File.join gem_folder, "lib", "new_relic", "proto", "infinite_tracing.proto"
-    output_path = File.join gem_folder, "lib", "new_relic", "infinite_tracing", "proto"
+    gem_folder = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+    proto_filename = File.join(gem_folder, "lib", "new_relic", "proto", "infinite_tracing.proto")
+    output_path = File.join(gem_folder, "lib", "new_relic", "infinite_tracing", "proto")
 
-    FileUtils.mkdir_p output_path
+    FileUtils.mkdir_p(output_path)
     cmd = [
       "grpc_tools_ruby_protoc",
       "-I#{gem_folder}/lib/new_relic/proto",
@@ -40,9 +20,9 @@ namespace :proto do
       "--grpc_out=#{output_path} #{proto_filename}"
     ].join(" ")
 
-    if system cmd
+    if system(cmd)
       puts "Proto file generated!"
-      add_license_preamble_and_remove_requires output_path
+      add_license_preamble_and_remove_requires(output_path)
     else
       puts "Failed to generate proto file."
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic-infinite_tracing
 version: !ruby/object:Gem::Version
-  version: 8.9.0
+  version: 8.12.0
 platform: ruby
 authors:
 - Tanna McClure
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: newrelic_rpm
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.9.0
+        version: 8.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.9.0
+        version: 8.12.0
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
@@ -89,14 +89,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.0
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.0
+        version: '5.15'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -259,6 +273,7 @@ files:
 - lib/proto/infinite_tracing.proto
 - newrelic-infinite_tracing.gemspec
 - tasks/all.rb
+- tasks/helpers/license.rb
 - tasks/proto.rake
 homepage: https://github.com/newrelic/newrelic-ruby-agent/tree/main/infinite_tracing
 licenses: