From f1e745dc647bfa51da560e61e4a215bae4762115 Mon Sep 17 00:00:00 2001 From: newrelic-ruby-agent-bot Date: Thu, 31 Oct 2024 20:03:16 +0000 Subject: [PATCH] chore(ruby agent): Update config docs --- .../ruby-agent-configuration.mdx | 32 +++++++++++++++---- 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/src/content/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration.mdx b/src/content/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration.mdx index 394359bbfda..552e616926e 100644 --- a/src/content/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration.mdx +++ b/src/content/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration.mdx @@ -495,13 +495,13 @@ These settings are available for agent configuration. Some settings depend on yo -An array of `CLASS#METHOD` (for instance methods) and/or `CLASS.METHOD` (for class methods) strings representing Ruby methods for which the agent will try to add a tracer. This doesn't require any code modifications of the classes that define 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. Here is some Ruby source code that defines a `render_png` instance method for an `Image` class and a `notify` class method for a `User` class, both within a `MyCompany` module namespace: -```ruby +``` module MyCompany class Image def render_png @@ -519,7 +519,7 @@ end Given that source code, the `newrelic.yml` config file might request instrumentation for both of these methods like so: -```yml +``` automatic_custom_instrumentation_method_list: - MyCompany::Image#render_png - MyCompany::User.notify @@ -527,13 +527,13 @@ automatic_custom_instrumentation_method_list: That configuration example uses YAML array syntax to specify both methods. Alternatively, you can use a comma-delimited string: -```yml +``` 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, use this comma-delimited string format: -```sh +``` export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify' ``` @@ -1380,6 +1380,26 @@ This section includes Ruby agent configurations for setting up AI monitoring. +## Cloud [#cloud] + + + + + + + + + + + + +
TypeString
Default`nil`
Environ variable`NEW_RELIC_CLOUD_AWS_ACCOUNT_ID`
+ + The AWS account ID for the AWS account associated with this app +
+ +
+ ## Code Level Metrics [#code-level-metrics] @@ -3103,4 +3123,4 @@ the `stripe.user_data.include` option is being used. If `true`, the agent automatically detects that it is running in a Pivotal Cloud Foundry environment. - + \ No newline at end of file