# 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 # A singleton responsible for determining if the agent should start # monitoring. # # If the agent is in a monitored environment (e.g. production) it will # attempt to avoid starting at "inappropriate" times, for example in an IRB # session. On Heroku, logs typically go to STDOUT so agent logs can spam # the console during interactive sessions. # # It should be possible to override Autostart logic with an explicit # configuration, for example the NEW_RELIC_AGENT_ENABLED environment variable or # agent_enabled key in newrelic.yml module Autostart extend self # The constants, executables (i.e. $0) and rake tasks used can be # configured with the config keys 'autostart.denylisted_constants', # 'autostart.denylisted_executables' and # 'autostart.denylisted_rake_tasks' def agent_should_start? !denylisted_constants? && !denylisted_executables? && !in_denylisted_rake_task? end COMMA = ",".freeze def denylisted_constants? denylisted?(NewRelic::Agent.config[:'autostart.denylisted_constants']) do |name| if RUBY_PLATFORM.eql?('java') # As of JRuby 9.3.4.0, Object.const_defined? will still cross # namespaces to find constants, which is not what we want. This # behavior is similar to CRuby's Object.const_get prior to v2.6. # # Example: # irb> class MyClass; end; module MyModule; end # irb> Object.const_defined?('MyModule::MyClass') # => true !!::NewRelic::LanguageSupport.constantize(name) else Object.const_defined?(name) end end end def denylisted_executables? denylisted?(NewRelic::Agent.config[:'autostart.denylisted_executables']) do |bin| File.basename($0) == bin end end def denylisted?(value, &block) value.split(/\s*,\s*/).any?(&block) end def in_denylisted_rake_task? tasks = begin ::Rake.application.top_level_tasks rescue => e ::NewRelic::Agent.logger.debug("Not in Rake environment so skipping denylisted_rake_tasks check: #{e}") NewRelic::EMPTY_ARRAY end !(tasks & ::NewRelic::Agent.config[:'autostart.denylisted_rake_tasks'].split(/\s*,\s*/)).empty? end end end end