newrelic_rpm 3.13.2.302 → 3.14.0.305

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47cf4894ee829e2a907a02048cdfb2e86864db94
-  data.tar.gz: 2091fb2447fef00e3ae581698328d43f190094d7
+  metadata.gz: 50bd75d704008669a67edbf82f40967d3465fb59
+  data.tar.gz: 82b7cf098d58c681ea061926fa1568429687cb62
 SHA512:
-  metadata.gz: 165e4c5b83e06fe422b0df838c342012ce681fb01fecdd7bafa65d5627130fd1d3ddd72a3bfa13e96cd6fdf11f697677f6145588fb910724c48084e049cfe22a
-  data.tar.gz: b0eb8ed8caa69e608e9ae6f2b7246e2c9783803b866c70115f1df8afb6f9c3dc31d86921933a4712e9884b7acbcf960f0b7fcbf4613739b761e85c748d0ad091
+  metadata.gz: 6160292363ad82115f434f5e6a6e6182ffd2f871aced553cf8465920ead0325a8146f3f5d00a318411b45ce882eafef5ea765bc68379cbb7ae3ab2c13190606e
+  data.tar.gz: 9398fc0ec397fb3ce9b58dfab6b6b0588248907bd6531fba226edbd919708aeeea5a0fe54c815cd65f8a3caf267bf60c1559445b1e339e8c10adcda76f16dc66

data/CHANGELOG

@@ -1,5 +1,25 @@
 # New Relic Ruby Agent Release Notes #
 
+## v3.14.0 ##
+
+  * pruby marshaller removed
+
+  The deprecated pruby marshaller has now been removed; the `marshaller` config
+  option now only accepts `json`. Customers still running Ruby 1.8.7/REE must
+  add the `json` gem to their Gemfile, or (preferably) upgrade to Ruby 1.9.3 or
+  newer.
+
+  * Log dates in ISO 8601 format
+
+  The agent will now log dates in ISO 8601 (YYYY-mm-dd) format, instead of
+  mm/dd/yy.
+
+  * Additional attributes collected
+
+  The agent now collects the following information in web transactions (not
+  yet shown in the New Relic UI): Accept, Host, User-Agent, Content-Length HTTP
+  request headers, HTTP request method, and Content-Type HTTP response header.
+
 ## v3.13.2 ##
 
   * Don't fail to send data when using 'mathn' library

data/README.md

@@ -21,21 +21,9 @@ automatically in Rails applications.
 
 ## Supported Environments
 
-* Ruby 1.8.7, REE, 1.9.x, 2.0.x, 2.1.x, 2.2.x
-* JRuby 1.6 and 1.7
-* Rubinius 2.x (Experimental support only)
-* Rails 2.1 or later for Production Mode
-* Rails 2.3 or later for Developer Mode
-* Sinatra
-* Rack
-
-An up to date list of Ruby versions and frameworks for the latest agent
+An up-to-date list of Ruby versions and frameworks for the latest agent
 can be found on [our docs site](http://docs.newrelic.com/docs/ruby/supported-frameworks).
 
-Any Rack based framework should work but may not be tested.  Install
-the Ruby Agent as a gem and add the Developer Mode middleware if
-desired.  Report any problems by visiting support.newrelic.com.
-
 You can also monitor non-web applications. Refer to the "Other
 Environments" section under "Getting Started".
 

data/lib/new_relic/agent/agent.rb

@@ -528,6 +528,14 @@ module NewRelic
             return false
           end
 
+          unless NewRelic::Agent::NewRelicService::JsonMarshaller.is_supported?
+            NewRelic::Agent.logger.error "JSON marshaller requested, but the 'json' gem was not available. ",
+              "You will need to: 1) upgrade to Ruby 1.9.3 or newer (strongly recommended), ",
+              "2) add the 'json' gem to your Gemfile or operating environment, ",
+              "or 3) use a version of newrelic_rpm prior to 3.14.0."
+            return false
+          end
+
           return true
         end
 
@@ -547,7 +555,7 @@ module NewRelic
         # Clear out the metric data, errors, and transaction traces, etc.
         def drop_buffered_data
           @stats_engine.reset!
-          @error_collector.reset!
+          @error_collector.drop_buffered_data
           @transaction_sampler.reset!
           @transaction_event_aggregator.reset!
           @custom_event_aggregator.reset!
@@ -915,7 +923,8 @@ module NewRelic
           case endpoint
           when :metric_data             then @stats_engine
           when :transaction_sample_data then @transaction_sampler
-          when :error_data              then @error_collector
+          when :error_data              then @error_collector.error_trace_aggregator
+          when :error_event_data        then @error_collector.error_event_aggregator
           when :analytic_event_data     then @transaction_event_aggregator
           when :custom_event_data       then @custom_event_aggregator
           when :sql_trace_data          then @sql_sampler
@@ -1006,19 +1015,31 @@ module NewRelic
         # The given container should respond to:
         #
         #  #harvest!
-        #    returns an enumerable collection of data items to be sent to the
-        #    collector.
+        #    returns a payload that contains enumerable collection of data items and
+        #    optional metadata to be sent to the collector.
         #
         #  #reset!
         #    drop any stored data and reset to a clean state.
         #
-        #  #merge!(items)
-        #    merge the given items back into the internal buffer of the
-        #    container, so that they may be harvested again later.
+        #  #merge!(payload)
+        #    merge the given pyalod back into the internal buffer of the
+        #    container, so that it may be harvested again later.
         #
         def harvest_and_send_from_container(container, endpoint)
-          items = harvest_from_container(container, endpoint)
-          send_data_to_endpoint(endpoint, items, container) unless items.empty?
+          payload = harvest_from_container(container, endpoint)
+          sample_count = harvest_size container, payload
+          if sample_count > 0
+            NewRelic::Agent.logger.debug("Sending #{sample_count} items to #{endpoint}")
+            send_data_to_endpoint(endpoint, payload, container)
+          end
+        end
+
+        def harvest_size container, items
+          if container.respond_to?(:has_metadata?) && container.has_metadata? && !items.empty?
+            items.last.size
+          else
+            items.size
+          end
         end
 
         def harvest_from_container(container, endpoint)
@@ -1032,10 +1053,9 @@ module NewRelic
           items
         end
 
-        def send_data_to_endpoint(endpoint, items, container)
-          NewRelic::Agent.logger.debug("Sending #{items.size} items to #{endpoint}")
+        def send_data_to_endpoint(endpoint, payload, container)
           begin
-            @service.send(endpoint, items)
+            @service.send(endpoint, payload)
           rescue ForceRestartException, ForceDisconnectException
             raise
           rescue SerializationError => e
@@ -1044,10 +1064,10 @@ module NewRelic
             NewRelic::Agent.logger.warn("#{endpoint} data was rejected by remote service, discarding. Error: ", e)
           rescue ServerConnectionException => e
             log_remote_unavailable(endpoint, e)
-            container.merge!(items)
+            container.merge!(payload)
           rescue => e
             NewRelic::Agent.logger.info("Unable to send #{endpoint} data, will try again later. Error: ", e)
-            container.merge!(items)
+            container.merge!(payload)
           end
         end
 
@@ -1075,7 +1095,7 @@ module NewRelic
         end
 
         def harvest_and_send_errors
-          harvest_and_send_from_container(@error_collector, :error_data)
+          harvest_and_send_from_container(@error_collector.error_trace_aggregator, :error_data)
         end
 
         def harvest_and_send_analytic_event_data
@@ -1083,6 +1103,10 @@ module NewRelic
           harvest_and_send_from_container(@custom_event_aggregator,      :custom_event_data)
         end
 
+        def harvest_and_send_error_event_data
+          harvest_and_send_from_container @error_collector.error_event_aggregator, :error_event_data
+        end
+
         def check_for_and_handle_agent_commands
           begin
             @agent_command_router.check_for_and_handle_agent_commands
@@ -1126,6 +1150,7 @@ module NewRelic
           @events.notify(:before_harvest)
           @service.session do # use http keep-alive
             harvest_and_send_errors
+            harvest_and_send_error_event_data
             harvest_and_send_transaction_traces
             harvest_and_send_slowest_sql
             harvest_and_send_timeslice_data

data/lib/new_relic/agent/agent_logger.rb

@@ -165,7 +165,7 @@ module NewRelic
         @hostname = NewRelic::Agent::Hostname.get
         @prefix = wants_stdout? ? '** [NewRelic]' : ''
         @log.formatter = Proc.new do |severity, timestamp, progname, msg|
-          "#{@prefix}[#{timestamp.strftime("%m/%d/%y %H:%M:%S %z")} #{@hostname} (#{$$})] #{severity} : #{msg}\n"
+          "#{@prefix}[#{timestamp.strftime("%F %H:%M:%S %z")} #{@hostname} (#{$$})] #{severity} : #{msg}\n"
         end
       end
 

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

@@ -121,10 +121,6 @@ module NewRelic
           Proc.new { NewRelic::Control.instance.local_env.discovered_dispatcher }
         end
 
-        def self.marshaller
-          Proc.new { NewRelic::Agent::NewRelicService::JsonMarshaller.is_supported? ? 'json' : 'pruby' }
-        end
-
         # On Rubies with string encodings support (1.9.x+), default to always
         # normalize encodings since it's safest and fast. Without that support
         # the conversions are too expensive, so only enable if overridden to.
@@ -935,6 +931,20 @@ module NewRelic
           :allowed_from_server => true,
           :description => 'Specifies a comma-delimited list of error classes that the agent should ignore.'
         },
+        :'error_collector.capture_events' => {
+          :default => value_of(:'error_collector.enabled'),
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => true,
+          :description => 'Enable or disable the collection of TransactionError events.'
+        },
+        :'error_collector.max_event_samples_stored' => {
+          :default => 100,
+          :public => true,
+          :type => Fixnum,
+          :allowed_from_server => true,
+          :description => 'The number of TransactionError samples sent to Insights per harvest cycle.'
+        },
         :'rum.enabled' => {
           :default => true,
           :public => false,
@@ -1116,11 +1126,11 @@ module NewRelic
           :description => 'Maximum overhead percentage for thread profiling before agent reduces polling frequency'
         },
         :marshaller => {
-          :default => DefaultSource.marshaller,
+          :default => 'json',
           :public => true,
           :type => String,
           :allowed_from_server => false,
-          :description => 'Specifies a marshaller for transmitting data to the New Relic <a href="/docs/apm/new-relic-apm/getting-started/glossary#collector">collector</a>) (e.g json, pruby).'
+          :description => 'Specifies a marshaller for transmitting data to the New Relic <a href="/docs/apm/new-relic-apm/getting-started/glossary#collector">collector</a>). Currently \'json\' is the only valid value for this setting. The pruby marshaller has been removed as of 3.14.0.'
         },
         :'analytics_events.enabled' => {
           :default => true,

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

@@ -96,7 +96,8 @@ module NewRelic
             'slow_sql.enabled'               => 'collect_traces',
             'error_collector.enabled'        => 'collect_errors',
             'analytics_events.enabled'       => 'collect_analytics_events',
-            'custom_insights_events.enabled' => 'collect_custom_events'
+            'custom_insights_events.enabled' => 'collect_custom_events',
+            'error_collector.capture_events' => 'collect_error_events'
           }
           gated_features.each do |config_key, gate_key|
             if connect_reply.has_key?(gate_key)

data/lib/new_relic/agent/error_collector.rb

@@ -2,6 +2,7 @@
 # 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/error_trace_aggregator'
+require 'new_relic/agent/error_event_aggregator'
 
 module NewRelic
   module Agent
@@ -16,27 +17,23 @@ module NewRelic
       MAX_ERROR_QUEUE_LENGTH = 20 unless defined? MAX_ERROR_QUEUE_LENGTH
       EXCEPTION_TAG_IVAR = :'@__nr_seen_exception' unless defined? EXCEPTION_TAG_IVAR
 
+      attr_reader :error_trace_aggregator, :error_event_aggregator
+
       # Returns a new error collector
       def initialize
         @error_trace_aggregator = ErrorTraceAggregator.new(MAX_ERROR_QUEUE_LENGTH)
-
+        @error_event_aggregator = ErrorEventAggregator.new
 
         # lookup of exception class names to ignore.  Hash for fast access
         @ignore = {}
 
         initialize_ignored_errors(Agent.config[:'error_collector.ignore_errors'])
 
-        Agent.config.register_callback(:'error_collector.enabled') do |config_enabled|
-          ::NewRelic::Agent.logger.debug "Errors will #{config_enabled ? '' : 'not '}be sent to the New Relic service."
-        end
         Agent.config.register_callback(:'error_collector.ignore_errors') do |ignore_errors|
           initialize_ignored_errors(ignore_errors)
         end
       end
 
-      def errors
-        @error_trace_aggregator.errors
-      end
 
       def initialize_ignored_errors(ignore_errors)
         @ignore.clear
@@ -46,7 +43,7 @@ module NewRelic
       end
 
       def enabled?
-        Agent.config[:'error_collector.enabled']
+        error_trace_aggregator.enabled? || error_event_aggregator.enabled?
       end
 
       def disabled?
@@ -200,11 +197,13 @@ module NewRelic
 
         state = ::NewRelic::Agent::TransactionState.tl_get
         increment_error_count!(state, exception, options)
-        @error_trace_aggregator.add_to_error_queue(create_noticed_error(exception, options))
-
+        noticed_error = create_noticed_error(exception, options)
+        error_trace_aggregator.add_to_error_queue(noticed_error)
+        error_event_aggregator.append_event(noticed_error, state.current_transaction.payload)
         exception
       rescue => e
         ::NewRelic::Agent.logger.warn("Failure when capturing error '#{exception}':", e)
+        nil
       end
 
       EMPTY_STRING = ''.freeze
@@ -214,6 +213,7 @@ module NewRelic
 
         noticed_error = NewRelic::NoticedError.new(error_metric, exception)
         noticed_error.request_uri = options.delete(:uri) || EMPTY_STRING
+        noticed_error.request_port = options.delete(:port)
         noticed_error.attributes  = options.delete(:attributes)
 
         noticed_error.file_name   = sense_method(exception, :file_name)
@@ -259,18 +259,10 @@ module NewRelic
         @error_trace_aggregator.notice_agent_error(exception)
       end
 
-      def merge!(errors)
-        @error_trace_aggregator.merge!(errors)
-      end
-
-      # Get the errors currently queued up.  Unsent errors are left
-      # over from a previous unsuccessful attempt to send them to the server.
-      def harvest!
-        @error_trace_aggregator.harvest!
-      end
-
-      def reset!
+      def drop_buffered_data
         @error_trace_aggregator.reset!
+        @error_event_aggregator.reset!
+        nil
       end
     end
   end

data/lib/new_relic/agent/error_event_aggregator.rb

@@ -0,0 +1,124 @@
+# -*- 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.
+
+require 'new_relic/agent/sampled_buffer'
+require 'new_relic/agent/payload_metric_mapping'
+
+module NewRelic
+  module Agent
+    class ErrorEventAggregator
+      EVENT_TYPE = "TransactionError".freeze
+
+      def initialize
+        @lock = Mutex.new
+        @error_event_buffer = SampledBuffer.new Agent.config[:'error_collector.max_event_samples_stored']
+        register_config_callbacks
+      end
+
+      def enabled?
+        Agent.config[:'error_collector.capture_events']
+      end
+
+      def append_event noticed_error, transaction_payload
+        return unless enabled?
+
+        @lock.synchronize do
+          @error_event_buffer.append do
+            event_for_collector(noticed_error, transaction_payload)
+          end
+        end
+      end
+
+      def harvest!
+        @lock.synchronize do
+          samples = @error_event_buffer.to_a
+          # Eventually the logic for adding reservoir data will move to the sampled buffer
+          # so it can be shared with the other event aggregators. We'll first get it working
+          # here and then promote the functionality later.
+          stats = reservoir_stats
+          @error_event_buffer.reset!
+          [stats, samples]
+        end
+      end
+
+      def reset!
+        @lock.synchronize do
+          @error_event_buffer.reset!
+        end
+      end
+
+      # samples will have already been transformed into
+      # collector primitives by event_for_collector
+      def merge! payload
+        @lock.synchronize do
+          _, samples = payload
+          @error_event_buffer.decrement_lifetime_counts_by samples.count
+          samples.each { |s| @error_event_buffer.append s }
+        end
+      end
+
+      def has_metadata?
+        true
+      end
+
+      private
+
+      def reservoir_stats
+        {
+          :reservoir_size => Agent.config[:'error_collector.max_event_samples_stored'],
+          :events_seen => @error_event_buffer.num_seen
+        }
+      end
+
+      def register_config_callbacks
+        NewRelic::Agent.config.register_callback(:'error_collector.max_event_samples_stored') do |max_samples|
+          NewRelic::Agent.logger.debug "ErrorEventAggregator max_samples set to #{max_samples}"
+          @lock.synchronize { @error_event_buffer.capacity = max_samples }
+        end
+
+        NewRelic::Agent.config.register_callback(:'error_collector.capture_events') do |enabled|
+          ::NewRelic::Agent.logger.debug "Error events will #{enabled ? '' : 'not '}be sent to the New Relic service."
+        end
+      end
+
+      def event_for_collector noticed_error, transaction_payload
+        [
+          intrinsic_attributes_for(noticed_error, transaction_payload),
+          noticed_error.custom_attributes,
+          noticed_error.agent_attributes
+        ]
+      end
+
+      def intrinsic_attributes_for noticed_error, transaction_payload
+        attrs = {
+          :type => EVENT_TYPE,
+          :'error.class' => noticed_error.exception_class_name,
+          :'error.message' => noticed_error.message,
+          :timestamp => noticed_error.timestamp.to_f,
+          :transactionName => transaction_payload[:name],
+          :duration => transaction_payload[:duration]
+        }
+        attrs[:port] = noticed_error.request_port if noticed_error.request_port
+
+        append_synthetics transaction_payload, attrs
+        append_cat transaction_payload, attrs
+        PayloadMetricMapping.append_mapped_metrics transaction_payload[:metrics], attrs
+
+        attrs
+      end
+
+      def append_synthetics transaction_payload, sample
+        sample[:'nr.syntheticsResourceId'] = transaction_payload[:synthetics_resource_id] if transaction_payload[:synthetics_resource_id]
+        sample[:'nr.syntheticsJobId'] = transaction_payload[:synthetics_job_id] if transaction_payload[:synthetics_job_id]
+        sample[:'nr.syntheticsMonitorId'] = transaction_payload[:synthetics_monitor_id] if transaction_payload[:synthetics_monitor_id]
+      end
+
+      def append_cat transaction_payload, sample
+        sample[:'nr.transactionGuid'] = transaction_payload[:guid] if transaction_payload[:guid]
+        sample[:'nr.referringTransactionGuid'] = transaction_payload[:referring_transaction_guid] if transaction_payload[:referring_transaction_guid]
+      end
+    end
+  end
+end