newrelic_rpm 4.3.0.335 → 4.4.0.336

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c39aaf49c14d8f52c0ad1551e36d973c7ec9130
-  data.tar.gz: dda64be5f11fe80294aaac0c4435442aabdd69f2
+  metadata.gz: b9d189b04c1171316153a227be91c6abad18f00a
+  data.tar.gz: 2b1c100c3778ba5fa95937d6d87bbe9949fb99a1
 SHA512:
-  metadata.gz: 504238d5388bcc1857fe19282a581f5011597c9a21484c321a7696628a2f078b6c232e1f2a11c417440b07db9860892a6a1a6448d1b9c64c61e289096130f1b5
-  data.tar.gz: 04b9adc55208fb75aa0437aadf72a7daf7c74730f55b0f3c9658dd38cafb7d5ca3170f80154036eebbe0d6eddacb1c468f54c28e1e0eaeca728698a226a08b02
+  metadata.gz: e77e92639fc53364aaf68627c4d41f1bc9e61ad6f2ce1978732d206a3b7eaf84ee72f06a934a92087179b3c534ea4803d7da5fe6d134416bd32b14f1e7532483
+  data.tar.gz: 566143ee90b3f3c027cb4201824766986d62c66cc78f2311da53861f23dcd272deb528dabceb36efd37db5fcc8e9f8b28f45d12f3729362feea58044dbe87b76

data/.yardopts

@@ -7,6 +7,7 @@ lib/new_relic/agent/instrumentation/rack.rb
 lib/new_relic/agent/instrumentation/metric_frame.rb
 lib/new_relic/agent/stats_engine/metric_stats.rb
 lib/new_relic/agent/datastores.rb
+lib/new_relic/agent/messaging.rb
 lib/new_relic/agent/sql_sampler.rb
 lib/new_relic/agent/transaction.rb
 lib/new_relic/agent/transaction_sampler.rb

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # New Relic Ruby Agent Release Notes #
 
+## v4.4.0 ##
+
+  * Include test helper for 3rd party use
+
+  In 4.2.0, all test files were excluded from being packaged in the gem. An
+  agent class method `NewRelic::Agent.require_test_helper` was used by 3rd
+  party gem authors to test extensions to the agent. The required file is now
+  included in the gem.
+
+  * Collect cloud metadata from Azure, GCP, PCF, and AWS cloud platform
+
+  The agent now collects additional metadata when running in AWS, GCP, Azure, and
+  PCF. This information is used to provide an enhanced experience when the agent
+  is deployed on those platforms.
+
+  * Install `at_exit` hook when running JRuby
+
+  The agent now installs an `at_exit` hook when running JRuby, which wasn't
+  done before because of constraints related to older JRuby versions that
+  are no longer supported.
+
+  * User/Utilization and System/Utilization metrics not recorded after Resque forks
+
+  The agent no longer records invalid User/Utilization and System/Utilization
+  metrics, which can lead to negative values, in forks of Resque processes.
+
+  * Add `identifier` field to agent connect settings
+
+  The agent now includes a unique identifier in its connect settings, ensuring
+  that when multiple agents connect to multiple different apps, data are reported
+  for each of the apps.
+
+  * Clear transaction state after forking now opt-in
+
+  The agent waits to connect until the first web request when it detects it's
+  running in a forking dispatcher. When clearing the transaction state in this
+  situation we lose the first frame of the transaction and the subsequent
+  trace becomes corrupted. We've made this feature opt-in and is turned off by
+  default. This behavior only affects the first transaction after a dispatcher
+  forks.
+
 ## v4.3.0 ##
 
   * Instrumentation for the Bunny AMQP Client

data/lib/new_relic/agent/agent.rb

@@ -377,7 +377,6 @@ module NewRelic
           def should_install_exit_handler?
             (
               Agent.config[:send_data_on_exit]  &&
-              !NewRelic::LanguageSupport.jruby? &&
               !sinatra_classic_app?
             )
           end
@@ -543,7 +542,9 @@ module NewRelic
           @transaction_event_recorder.drop_buffered_data
           @custom_event_aggregator.reset!
           @sql_sampler.reset!
-          TransactionState.tl_clear
+          if Agent.config[:clear_transaction_state_after_fork]
+            TransactionState.tl_clear
+          end
         end
 
         # Clear out state for any objects that we know lock from our parents
@@ -803,7 +804,8 @@ module NewRelic
               :environment   => @environment_report,
               :settings      => Agent.config.to_collector_hash,
               :high_security => Agent.config[:high_security],
-              :utilization   => UtilizationData.new.to_collector_hash
+              :utilization   => UtilizationData.new.to_collector_hash,
+              :identifier    => "ruby:#{local_host}:#{Agent.config.app_names.sort.join(',')}"
             }
           end
 

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

@@ -1561,8 +1561,33 @@ module NewRelic
           :public      => true,
           :type        => Boolean,
           :allowed_from_server => false,
+          :dynamic_name => true,
           :description => 'If <code>true</code>, the agent automatically detects that it is running in an AWS environment.'
         },
+        :'utilization.detect_azure' => {
+          :default      => true,
+          :public       => true,
+          :type         => Boolean,
+          :allowed_from_server => false,
+          :dynamic_name => true,
+          :description  => 'If <code>true</code>, the agent automatically detects that it is running in an Azure environment.'
+        },
+        :'utilization.detect_gcp' => {
+          :default     => true,
+          :public      => true,
+          :type        => Boolean,
+          :allowed_from_server => false,
+          :dynamic_name => true,
+          :description => 'If <code>true</code>, the agent automatically detects that it is running in an Google Cloud Platform environment.'
+        },
+        :'utilization.detect_pcf' => {
+          :default     => true,
+          :public      => true,
+          :type        => Boolean,
+          :allowed_from_server => false,
+          :dynamic_name => true,
+          :description => 'If <code>true</code>, the agent automatically detects that it is running in a Pivotal Cloud Foundry environment.'
+        },
         :'utilization.detect_docker' => {
           :default     => true,
           :public      => true,
@@ -1607,6 +1632,13 @@ module NewRelic
           :type        => Boolean,
           :allowed_from_server => false,
           :description => 'If <code>false</code>, the agent will not add <code>database_name</code> parameter to transaction or slow sql traces.'
+        },
+        :'clear_transaction_state_after_fork' => {
+          :default     => false,
+          :public      => true,
+          :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>.'
         }
       }.freeze
     end

data/lib/new_relic/agent/samplers/cpu_sampler.rb

@@ -50,7 +50,8 @@ module NewRelic
         def poll
           now = Time.now
           t = Process.times
-          if @last_time
+
+          if @last_time && t.utime != 0.0 && t.stime != 0.0
             elapsed = now - @last_time
             return if elapsed < 1 # Causing some kind of math underflow
 
@@ -62,10 +63,10 @@ module NewRelic
 
             # Calculate the true utilization by taking cpu times and dividing by
             # elapsed time X processor_count.
-
             record_user_util(usertime / (elapsed * @processor_count))
             record_system_util(systemtime / (elapsed * @processor_count))
           end
+
           @last_utime = t.utime
           @last_stime = t.stime
           @last_time = now

data/lib/new_relic/agent/system_info.rb

@@ -251,6 +251,40 @@ module NewRelic
           nil
         end
       end
+
+      def self.boot_id
+        return nil unless linux?
+        if bid = proc_try_read('/proc/sys/kernel/random/boot_id')
+          bid.chomp!
+
+          if bid.ascii_only?
+            if bid.empty?
+              ::NewRelic::Agent.logger.debug("boot_id not found in /proc/sys/kernel/random/boot_id")
+              ::NewRelic::Agent.increment_metric "Supportability/utilization/boot_id/error"
+              nil
+
+            elsif bid.bytesize == 36
+              bid
+
+            else
+              ::NewRelic::Agent.logger.debug("Found boot_id with invalid length: #{bid}")
+              ::NewRelic::Agent.increment_metric "Supportability/utilization/boot_id/error"
+              bid[0,128]
+
+            end
+          else
+            ::NewRelic::Agent.logger.debug("Found boot_id with non-ASCII characters: #{bid}")
+            ::NewRelic::Agent.increment_metric "Supportability/utilization/boot_id/error"
+            nil
+
+          end
+        else
+          ::NewRelic::Agent.logger.debug("boot_id not found in /proc/sys/kernel/random/boot_id")
+          ::NewRelic::Agent.increment_metric "Supportability/utilization/boot_id/error"
+          nil
+
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,18 @@
+# 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/utilization/vendor'
+
+module NewRelic
+  module Agent
+    module Utilization
+      class AWS < Vendor
+        vendor_name "aws"
+        endpoint "http://169.254.169.254/2016-09-02/dynamic/instance-identity/document"
+        keys ["instanceId", "instanceType", "availabilityZone"]
+        key_transforms :to_sym
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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.
+
+module NewRelic
+  module Agent
+    module Utilization
+      class Azure < Vendor
+        vendor_name "azure"
+        endpoint "http://169.254.169.254/metadata/instance/compute?api-version=2017-03-01"
+        headers "Metadata" => "true"
+        keys ["vmId", "name", "vmSize", "location"]
+        key_transforms :to_sym
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# 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/utilization/vendor'
+
+module NewRelic
+  module Agent
+    module Utilization
+      class GCP < Vendor
+        vendor_name "gcp"
+        endpoint "http://metadata.google.internal/computeMetadata/v1/instance/?recursive=true"
+        headers "Metadata-Flavor" => "Google"
+        keys ["id", "machineType", "name", "zone"]
+        key_transforms :to_sym
+
+        MACH_TYPE = 'machineType'.freeze
+        ZONE = 'zone'.freeze
+
+        def prepare_response response
+          body = JSON.parse response.body
+          body[MACH_TYPE] = trim_leading body[MACH_TYPE]
+          body[ZONE] = trim_leading body[ZONE]
+          body
+        end
+
+        SLASH = '/'.freeze
+
+        def trim_leading value
+          value.split(SLASH).last
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# 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/utilization/vendor'
+
+module NewRelic
+  module Agent
+    module Utilization
+      class PCF < Vendor
+        vendor_name "pcf"
+        keys ["CF_INSTANCE_GUID", "CF_INSTANCE_IP", "MEMORY_LIMIT"]
+        key_transforms [:downcase, :to_sym]
+
+        def detect
+          begin
+            return false unless pcf_keys_present?
+            process_response ENV
+          rescue
+            NewRelic::Agent.logger.error "Error occurred detecting: #{vendor_name}", e
+            record_supportability_metric
+            false
+          end
+        end
+
+        def pcf_keys_present?
+          !(ENV.keys & keys).empty?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+# 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 'net/http'
+
+module NewRelic
+  module Agent
+    module Utilization
+      class Vendor
+        class << self
+          def vendor_name vendor_name = nil
+            vendor_name ? @vendor_name = vendor_name.freeze : @vendor_name
+          end
+
+          def endpoint endpoint = nil
+            endpoint ? @endpoint = URI(endpoint) : @endpoint
+          end
+
+          def headers headers = nil
+            headers ? @headers = headers.freeze : @headers
+          end
+
+          def keys keys = nil
+            keys ? @keys = keys.freeze : @keys
+          end
+
+          def key_transforms key_transforms = nil
+            key_transforms ? @key_transforms = Array(key_transforms).freeze : @key_transforms
+          end
+        end
+
+        attr_reader :metadata
+
+        def initialize
+          @metadata = {}
+        end
+
+        [:vendor_name, :endpoint, :headers, :keys, :key_transforms].each do |method_name|
+          define_method(method_name) { self.class.send(method_name) }
+        end
+
+        SUCCESS = '200'.freeze
+
+        def detect
+          response = request_metadata
+          return false unless response
+
+          begin
+            if response.code == SUCCESS
+              process_response prepare_response(response)
+            else
+              false
+            end
+          rescue => e
+            NewRelic::Agent.logger.error "Error occurred detecting: #{vendor_name}", e
+            record_supportability_metric
+            false
+          end
+        end
+
+        private
+
+        def request_metadata
+          Timeout.timeout 1 do
+            response = nil
+            Net::HTTP.start endpoint.host, endpoint.port do |http|
+              req = Net::HTTP::Get.new endpoint, headers
+              response = http.request req
+            end
+            response
+          end
+        rescue
+          NewRelic::Agent.logger.debug "#{vendor_name} environment not detected"
+        end
+
+        def prepare_response response
+          JSON.parse response.body
+        end
+
+        def process_response response
+          keys.each do |key|
+            normalized = normalize response[key]
+            if normalized
+              @metadata[transform_key(key)] = normalized
+            else
+              @metadata.clear
+              record_supportability_metric
+              return false
+            end
+          end
+          true
+        end
+
+        def normalize value
+          return if value.nil?
+
+          value = value.to_s
+          value = value.dup if value.frozen?
+
+          value.force_encoding Encoding::UTF_8
+          value.strip!
+
+          return unless valid_length? value
+          return unless valid_chars? value
+
+          value
+        end
+
+        def valid_length? value
+          if value.bytesize <= 255
+            true
+          else
+            NewRelic::Agent.logger.warn "Found invalid length value while detecting: #{vendor_name}"
+            false
+          end
+        end
+
+        VALID_CHARS = /^[0-9a-zA-Z_ .\/-]$/
+
+        def valid_chars? value
+          value.each_char do |ch|
+            next if ch =~ VALID_CHARS
+            code_point = ch[0].ord # this works in Ruby 1.8.7 - 2.1.2
+            next if code_point >= 0x80
+
+            NewRelic::Agent.logger.warn "Found invalid character while detecting: #{vendor_name}"
+            return false # it's in neither set of valid characters
+          end
+          true
+        end
+
+        def transform_key key
+          return key unless key_transforms
+          key_transforms.inject(key) { |memo, transform| memo.send(transform) }
+        end
+
+        def record_supportability_metric
+          NewRelic::Agent.increment_metric "Supportability/utilization/#{vendor_name}/error"
+        end
+      end
+    end
+  end
+end