newrelic_rpm 8.5.0 → 8.6.0

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

@@ -38,6 +38,12 @@ module NewRelic
         end
       end
 
+      def self.instrumentation_value_from_boolean(key)
+        Proc.new do
+          NewRelic::Agent.config[key] ? 'auto' : 'disabled'
+        end
+      end
+
       # Marks the config option as deprecated in the documentation once generated.
       # Does not appear in logs.
       def self.deprecated_description new_setting, description
@@ -354,21 +360,21 @@ module NewRelic
           :public => false,
           :type => String,
           :allowed_from_server => true,
-          :description => 'The [Entity GUID](/attribute-dictionary/span/entityguid) for the entity running this agent.'
+          :description => 'The [Entity GUID](/attribute-dictionary/span/entityguid) for the entity running your agent.'
         },
         :monitor_mode => {
           :default => value_of(:enabled),
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'When `true`, the agent transmits data about your app to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector).'
+          :description => 'When `true`, the agent transmits data about your application to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector).'
         },
         :test_mode => {
           :default => false,
           :public => false,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'Used in tests for agent to start up but not connect to collector. Formerly used `developer_mode` in test config for this purpose.'
+          :description => 'Used in tests for the agent to start up, but not connect to the collector. Formerly used `developer_mode` in test config for this purpose.'
         },
         :log_level => {
           :default => 'info',
@@ -680,6 +686,14 @@ module NewRelic
           :allowed_from_server => true,
           :description => 'Number of seconds betwixt connections to the New Relic error event collection services.'
         },
+        :'event_report_period.log_event_data' => {
+          :default => 60,
+          :public => false,
+          :type => Integer,
+          :dynamic_name => true,
+          :allowed_from_server => true,
+          :description => 'Number of seconds betwixt connections to the New Relic log event collection services.'
+        },
         :'event_report_period.span_event_data' => {
           :default => 60,
           :public => false,
@@ -1004,7 +1018,7 @@ module NewRelic
           :description => 'Controls auto-instrumentation of dalli gem for Memcache at start up.  May be one of [auto|prepend|chain|disabled].'
         },
         :'instrumentation.logger' => {
-          :default => "auto",
+          :default => instrumentation_value_from_boolean(:'application_logging.enabled'),
           :public => true,
           :type => String,
           :dynamic_name => true,
@@ -1017,7 +1031,7 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of Tilt at start up.  May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of the Tilt template rendering library at start up. May be one of [auto|prepend|chain|disabled].'
         },
         :disable_data_mapper => {
           :default => false,
@@ -1390,7 +1404,7 @@ module NewRelic
           :public => true,
           :type => Integer,
           :allowed_from_server => true,
-          :description => 'Defines the maximum number of [TransactionError events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights) sent to Insights per harvest cycle.'
+          :description => 'Defines the maximum number of [TransactionError events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights) reported per harvest cycle.'
         },
         :'rum.enabled' => {
           :default => true,
@@ -1508,7 +1522,7 @@ module NewRelic
           :deprecated => true,
           :description => deprecated_description(
             :'distributed_tracing-enabled',
-            'If `true`, enables [cross-application tracing](/docs/agents/ruby-agent/features/cross-application-tracing-ruby/)'
+            'If `true`, enables [cross-application tracing](/docs/agents/ruby-agent/features/cross-application-tracing-ruby/) when `distributed_tracing.enabled` is set to `false`.'
           )
         },
         :cross_application_tracing => {
@@ -1803,7 +1817,7 @@ module NewRelic
           :public => true,
           :type => String,
           :allowed_from_server => false,
-          :description => 'A dictionary of [label names](/docs/data-analysis/user-interface-functions/labels-categories-organize-your-apps-servers) and values that will be applied to the data sent from this agent. May also be expressed as a semicolon-delimited `;` string of colon-separated `:` pairs. For example, `<var>Server</var>:<var>One</var>;<var>Data Center</var>:<var>Primary</var>`.'
+          :description => 'A dictionary of [label names](/docs/data-analysis/user-interface-functions/labels-categories-organize-your-apps-servers) and values that will be applied to the data sent from your agent. May also be expressed as a semicolon-delimited `;` string of colon-separated `:` pairs. For example, `<var>Server</var>:<var>One</var>;<var>Data Center</var>:<var>Primary</var>`.'
         },
         :aggressive_keepalive => {
           :default => true,
@@ -1833,7 +1847,7 @@ module NewRelic
           :type => Array,
           :allowed_from_server => true,
           :transform => DefaultSource.method(:convert_to_regexp_list),
-          :description => 'Define transactions you want the agent to ignore, by specifying a list of patterns matching the URI you want to ignore.'
+          :description => 'Define transactions you want the agent to ignore, by specifying a list of patterns matching the URI you want to ignore. See documentation on (ignoring specific transactions)[https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ignoring-specific-transactions/#config-ignoring] for more details.'
         },
         :'synthetics.traces_limit' => {
           :default => 20,
@@ -1854,16 +1868,60 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => true,
-          :description => 'If `true`, the agent captures [New Relic Insights custom events](/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents).'
+          :description => 'If `true`, the agent captures [custom events](/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents).'
         },
         :'custom_insights_events.max_samples_stored' => {
           :default => 1000,
           :public => true,
           :type => Integer,
           :allowed_from_server => true,
-          :description => 'Specify a maximum number of custom Insights events to buffer in memory at a time.',
+          :description => 'Defines the maximum number of span events reported from a single harvest. Any Integer between 1 and 10000 is valid.',
           :dynamic_name => true
         },
+        :'application_logging.enabled' => {
+          :default => true,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => 'If `true`, enables log decoration and the collection of log events and metrics.'
+        },
+        :'application_logging.forwarding.enabled' => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => 'If `true`, the agent captures log records emitted by your application.'
+        },
+        :'application_logging.forwarding.max_samples_stored' => {
+          :default => 10000,
+          :public => true,
+          :type => Integer,
+          :allowed_from_server => true,
+          :description => 'Defines the maximum number of log records to buffer in memory at a time.',
+          :dynamic_name => true
+        },
+        :'application_logging.metrics.enabled' => {
+          :default => true,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => true,
+          :description => 'If `true`, the agent captures metrics related to logging for your application.'
+        },
+        :'application_logging.local_decorating.enabled' => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => 'If `true`, the agent decorates logs with metadata to link to entities, hosts, traces, and spans.'
+        },
+        :'instrumentation.active_support_logger' => {
+          :default => instrumentation_value_from_boolean(:'application_logging.enabled'),
+          :dynamic_name => true,
+          :public => true,
+          :type => String,
+          :allowed_from_server => false,
+          :description => 'Controls auto-instrumentation of ActiveSupport::Logger at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
         :disable_grape_instrumentation => {
           :default => false,
           :public => false,
@@ -2056,7 +2114,7 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'If `false`, custom attributes will not be sent on Insights events.'
+          :description => 'If `false`, custom attributes will not be sent on events.'
         },
         :'utilization.detect_aws' => {
           :default => true,
@@ -2155,7 +2213,7 @@ module NewRelic
           :public => false,
           :type => String,
           :allowed_from_server => true,
-          :description => 'The account id associated with this application.'
+          :description => 'The account id associated with your application.'
         },
         :primary_application_id => {
           :default => nil,
@@ -2163,7 +2221,7 @@ module NewRelic
           :public => false,
           :type => String,
           :allowed_from_server => true,
-          :description => 'The primary id associated with this application.'
+          :description => 'The primary id associated with your application.'
         },
         :'distributed_tracing.enabled' => {
           :default => true,

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

@@ -11,14 +11,16 @@ module NewRelic
         EVENT_HARVEST_CONFIG_KEY_MAPPING = {
           :analytic_event_data => :'transaction_events.max_samples_stored',
           :custom_event_data => :'custom_insights_events.max_samples_stored',
-          :error_event_data => :'error_collector.max_event_samples_stored'
+          :error_event_data => :'error_collector.max_event_samples_stored',
+          :log_event_data => :'application_logging.forwarding.max_samples_stored'
         }
 
         # not including span_event_data here because spans are handled separately in transform_span_event_harvest_config
         EVENT_HARVEST_EVENT_REPORT_PERIOD_KEY_MAPPING = {
           :analytic_event_data => :'transaction_event_data',
           :custom_event_data => :'custom_event_data',
-          :error_event_data => :'error_event_data'
+          :error_event_data => :'error_event_data',
+          :log_event_data => :'log_event_data'
         }
 
         def from_config(config)

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

@@ -79,6 +79,7 @@ module NewRelic
           :'transaction_events.max_samples_stored' => 'Supportability/EventHarvest/AnalyticEventData/HarvestLimit',
           :'custom_insights_events.max_samples_stored' => 'Supportability/EventHarvest/CustomEventData/HarvestLimit',
           :'error_collector.max_event_samples_stored' => 'Supportability/EventHarvest/ErrorEventData/HarvestLimit',
+          :'application_logging.forwarding.max_samples_stored' => 'Supportability/EventHarvest/LogEventData/HarvestLimit',
           :'span_events.max_samples_stored' => 'Supportability/SpanEvent/Limit',
           :event_report_period => 'Supportability/EventHarvest/ReportPeriod',
           :'event_report_period.span_event_data' => 'Supportability/SpanEvent/ReportPeriod'

data/lib/new_relic/agent/hostname.rb

@@ -2,6 +2,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.
 require 'socket'
+require 'new_relic/helper'
 
 module NewRelic
   module Agent
@@ -17,17 +18,22 @@ module NewRelic
         end
       end
 
-      # calling hostname with -f on some OS's (NetBSD, FreeBSD, Solaris)
-      # produces invalid option error, but doesn't raise exception.  Instead,
-      # we get back empty string.  So, solution here is to check for non-zero
-      # exit status and retry the command without the -f flag.
+      # Pass '-f' to the external executable 'hostname' to request the fully
+      # qualified domain name (fqdn). For implementations of 'hostname' that
+      # do not support '-f' (such as the one OpenBSD ships with), fall back
+      # to calling 'hostname' without the '-f'. If both ways of calling
+      # 'hostname' fail, or in a context where 'hostname' is not even
+      # available (within an AWS Lambda function, for example), call the
+      # 'get' method which uses Socket instead of an external executable.
       def self.get_fqdn
-        fqdn = %x(hostname -f 2>/dev/null).chomp!
-        fqdn = %x(hostname).chomp! unless $?.exitstatus.zero?
-        fqdn
-      rescue => e
-        NewRelic::Agent.logger.debug "Unable to determine fqdn #{e}"
-        nil
+        begin
+          NewRelic::Helper.run_command('hostname -f')
+        rescue NewRelic::CommandRunFailedError
+          NewRelic::Helper.run_command('hostname')
+        end
+      rescue NewRelic::CommandExecutableNotFoundError, NewRelic::CommandRunFailedError => e
+        NewRelic::Agent.logger.debug("#{e.class} - #{e.message}")
+        get
       end
 
       def self.heroku_dyno_name_prefix(dyno_name)

data/lib/new_relic/agent/instrumentation/active_support_logger/chain.rb

@@ -0,0 +1,23 @@
+# 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.
+
+module NewRelic::Agent::Instrumentation
+  module ActiveSupportLogger
+    module Chain
+      def instrument!
+        ::ActiveSupport::Logger.module_eval do
+          include NewRelic::Agent::Instrumentation::ActiveSupportLogger
+          def broadcast_with_new_relic(logger)
+            broadcast_with_tracing(logger) {
+              broadcast_without_newrelic(logger)
+            }
+          end
+
+          alias broadcast_without_newrelic broadcast
+          alias broadcast broadcast_with_new_relic
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/active_support_logger/instrumentation.rb

@@ -0,0 +1,20 @@
+# 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.
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      module ActiveSupportLogger
+        # Mark @skip_instrumenting on any broadcasted loggers to instrument Rails.logger only
+        def broadcast_with_tracing(logger)
+          NewRelic::Agent::Instrumentation::Logger.mark_skip_instrumenting(logger)
+          yield
+        rescue => error
+          NewRelic::Agent.notice_error(error)
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/active_support_logger/prepend.rb

@@ -0,0 +1,12 @@
+# 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.
+
+module NewRelic::Agent::Instrumentation
+  module ActiveSupportLogger::Prepend
+    include NewRelic::Agent::Instrumentation::ActiveSupportLogger
+    def broadcast(logger)
+      broadcast_with_tracing(logger) { super }
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/active_support_logger.rb

@@ -0,0 +1,24 @@
+# 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.
+
+require_relative 'active_support_logger/instrumentation'
+require_relative 'active_support_logger/chain'
+require_relative 'active_support_logger/prepend'
+
+DependencyDetection.defer do
+  named :active_support_logger
+
+  depends_on { defined?(::ActiveSupport::Logger) }
+
+  executes do
+    ::NewRelic::Agent.logger.info 'Installing ActiveSupport::Logger instrumentation'
+
+    if use_prepend?
+      # the only method currently instrumented is a class method
+      prepend_instrument ::ActiveSupport::Logger.singleton_class, NewRelic::Agent::Instrumentation::ActiveSupportLogger::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::ActiveSupportLogger::Chain
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/curb/chain.rb

@@ -51,7 +51,7 @@ module NewRelic::Agent::Instrumentation
 
           # Record the HTTP verb for future #perform calls
           def method_with_newrelic verb
-            method_with_tracing { method_without_newrelic(verb) }
+            method_with_tracing(verb) { method_without_newrelic(verb) }
           end
 
           alias_method :method_without_newrelic, :method

data/lib/new_relic/agent/instrumentation/curb/prepend.rb

@@ -34,7 +34,7 @@ module NewRelic
             end
 
             def method verb
-              method_with_tracing { super }
+              method_with_tracing(verb) { super }
             end
 
             def header_str

data/lib/new_relic/agent/instrumentation/logger/instrumentation.rb

@@ -10,6 +10,17 @@ module NewRelic
           defined?(@skip_instrumenting) && @skip_instrumenting
         end
 
+        # We support setting this on loggers which might not have
+        # instrumentation installed yet. This lets us disable in AgentLogger
+        # and AuditLogger without them having to know the inner details.
+        def self.mark_skip_instrumenting(logger)
+          logger.instance_variable_set(:@skip_instrumenting, true)
+        end
+
+        def self.clear_skip_instrumenting(logger)
+          logger.instance_variable_set(:@skip_instrumenting, false)
+        end
+
         def mark_skip_instrumenting
           @skip_instrumenting = true
         end
@@ -18,17 +29,8 @@ module NewRelic
           @skip_instrumenting = false
         end
 
-        LINES = "Logging/lines".freeze
-        SIZE = "Logging/size".freeze
-
-        def line_metric_name_by_severity(severity)
-          @line_metrics ||= {}
-          @line_metrics[severity] ||= "Logging/lines/#{severity}".freeze
-        end
-
-        def size_metric_name_by_severity(severity)
-          @size_metrics ||= {}
-          @size_metrics[severity] ||= "Logging/size/#{severity}".freeze
+        def self.enabled?
+          NewRelic::Agent.config[:'instrumentation.logger'] != 'disabled'
         end
 
         def format_message_with_tracing(severity, datetime, progname, msg)
@@ -40,14 +42,12 @@ module NewRelic
             # methods within NewRelic::Agent, or we'll stack overflow!!
             mark_skip_instrumenting
 
-            NewRelic::Agent.increment_metric(LINES)
-            NewRelic::Agent.increment_metric(line_metric_name_by_severity(severity))
-
-            size = formatted_message.nil? ? 0 : formatted_message.bytesize
-            NewRelic::Agent.record_metric(SIZE, size)
-            NewRelic::Agent.record_metric(size_metric_name_by_severity(severity), size)
+            unless ::NewRelic::Agent.agent.nil?
+              ::NewRelic::Agent.agent.log_event_aggregator.record(formatted_message, severity)
+              formatted_message = LocalLogDecorator.decorate(formatted_message)
+            end
 
-            return formatted_message
+            formatted_message
           ensure
             clear_skip_instrumenting
           end

data/lib/new_relic/agent/instrumentation/logger.rb

@@ -9,13 +9,14 @@ require_relative 'logger/prepend'
 DependencyDetection.defer do
   named :logger
 
-  depends_on { defined?(::Logger) }
+  depends_on do
+    defined?(::Logger) &&
+      NewRelic::Agent.config[:'application_logging.enabled']
+  end
 
   executes do
     ::NewRelic::Agent.logger.info "Installing Logger instrumentation"
-  end
 
-  executes do
     if use_prepend?
       prepend_instrument ::Logger, NewRelic::Agent::Instrumentation::Logger::Prepend
     else

data/lib/new_relic/agent/linking_metadata.rb

@@ -0,0 +1,45 @@
+# 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
+  module Agent
+    #
+    # This module contains helper methods related to gathering linking
+    # metadata for use with logs in context.
+    module LinkingMetadata
+      extend self
+
+      def append_service_linking_metadata metadata
+        raise ArgumentError, "Missing argument `metadata`" if metadata.nil?
+
+        config = ::NewRelic::Agent.config
+
+        metadata[ENTITY_NAME_KEY] = config[:app_name][0]
+        metadata[ENTITY_TYPE_KEY] = ENTITY_TYPE
+        metadata[HOSTNAME_KEY] = Hostname.get
+
+        if entity_guid = config[:entity_guid]
+          metadata[ENTITY_GUID_KEY] = entity_guid
+        end
+
+        metadata
+      end
+
+      def append_trace_linking_metadata metadata
+        raise ArgumentError, "Missing argument `metadata`" if metadata.nil?
+
+        if trace_id = Tracer.current_trace_id
+          metadata[TRACE_ID_KEY] = trace_id
+        end
+
+        if span_id = Tracer.current_span_id
+          metadata[SPAN_ID_KEY] = span_id
+        end
+
+        metadata
+      end
+    end
+  end
+end

data/lib/new_relic/agent/local_log_decorator.rb

@@ -0,0 +1,37 @@
+# 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
+  module Agent
+    # This module contains helper methods related to decorating log messages
+    module LocalLogDecorator
+      extend self
+
+      def decorate(message)
+        return message unless decorating_enabled?
+
+        metadata = NewRelic::Agent.linking_metadata
+        formatted_metadata = " NR-LINKING|#{metadata[ENTITY_GUID_KEY]}|#{metadata[HOSTNAME_KEY]}|" \
+                             "#{metadata[TRACE_ID_KEY]}|#{metadata[SPAN_ID_KEY]}|" \
+                             "#{escape_entity_name(metadata[ENTITY_NAME_KEY])}|"
+
+        message.partition("\n").insert(1, formatted_metadata).join
+      end
+
+      private
+
+      def decorating_enabled?
+        NewRelic::Agent.config[:'application_logging.enabled'] &&
+          NewRelic::Agent::Instrumentation::Logger.enabled? &&
+          NewRelic::Agent.config[:'application_logging.local_decorating.enabled']
+      end
+
+      def escape_entity_name(entity_name)
+        return unless entity_name
+        URI::DEFAULT_PARSER.escape(entity_name)
+      end
+    end
+  end
+end