From 7264efa09c28719a635d4734179b53f9c11cb8e5 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Mon, 30 Sep 2024 16:03:39 -0700 Subject: [PATCH] Update verbiage to match docs website Tweaks for automatic_custom_instrumentation_method_list --- lib/new_relic/agent/configuration/default_source.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/new_relic/agent/configuration/default_source.rb b/lib/new_relic/agent/configuration/default_source.rb index 246af67829..e091c8ecf3 100644 --- a/lib/new_relic/agent/configuration/default_source.rb +++ b/lib/new_relic/agent/configuration/default_source.rb @@ -1159,7 +1159,7 @@ def self.enforce_fallback(allowed_values: nil, fallback: nil) :allowed_from_server => false, :transform => proc { |arr| NewRelic::Agent.add_automatic_method_tracers(arr) }, :description => <<~DESCRIPTION - An array of `CLASS#METHOD` (for instance methods) and/or `CLASS.METHOD` (for class methods) strings representing Ruby methods for the agent to automatically add custom instrumentation to without the need for altering any of the source code that defines the methods. + An array of `CLASS#METHOD` (for instance methods) and/or `CLASS.METHOD` (for class methods) strings representing Ruby methods that the agent can automatically add custom instrumentation to. This doesn't require any modifications of the source code that defines the methods. Use fully qualified class names (using the `::` delimiter) that include any module or class namespacing. @@ -1189,13 +1189,13 @@ def self.notify - MyCompany::User.notify ``` - That configuration example uses YAML array syntax to specify both methods. Alternatively, a comma-delimited string can be used instead: + That configuration example uses YAML array syntax to specify both methods. Alternatively, you can use a comma-delimited string: ``` automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png, MyCompany::User.notify' ``` - Whitespace around the comma(s) in the list is optional. When configuring the agent with a list of methods via the `NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST` environment variable, this comma-delimited string format should be used: + Whitespace around the comma(s) in the list is optional. When configuring the agent with a list of methods via the `NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST` environment variable, use this comma-delimited string format: ``` export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify'