Ruby agent general settings

If true, allows the Ruby agent to run.

Specify the application name used to aggregate data in the New Relic UI. To report data to multiple apps at the same time, specify a list of names separated by a semicolon ;. For example, MyApp or MyStagingApp;Instance1.

Your New Relic license key.

Sets the level of detail of log messages. Possible log levels, in increasing verbosity, are: fatal, error, warn, info or debug.

An array of ActiveSupport custom event names to subscribe to and instrument. For example: [one.custom.event, another.event, a.third.event]

If true, the agent will use the ActiveRecord model's table name instead of the class name when naming ActiveRecord metrics, spans, and transaction trace segments. This can reduce cardinality when multiple models share a database table. Defaults to false.

Backports the faster ActiveRecord connection lookup introduced in Rails 6, which improves agent performance when instrumenting ActiveRecord. Note that this setting may not be compatible with other gems that patch ActiveRecord.

Manual override for the path to your local CA bundle. This CA bundle validates the SSL certificate presented by New Relic's data collection service.

If true, the agent captures memcache keys in transaction traces.

When true, the agent captures HTTP request parameters and attaches them to transaction traces, traced errors, and TransactionError events.

If true, the agent will clear Tracer::State in Agent.drop_buffered_data.

Path to newrelic.yml. If undefined, the agent checks the following directories (in order): config/newrelic.yml -> newrelic.yml -> $HOME/.newrelic/newrelic.yml -> $HOME/newrelic.yml

If true, suppresses the newrelic distributed tracing header on outbound requests.

If true, forces the agent to install its exit handler (which sends all cached data to the collector before shutting down), even in cases where the agent would normally skip it, such as when it detects Sinatra running as an embedded service within another framework. Sinatra runs the entire application inside its own at_exit block, so the agent skips its own at_exit handler by default to avoid conflicts. This setting overrides that. Note: send_data_on_exit must also be true for this setting to have any effect.

If true, enables high security mode. Ensure you understand the implications of high security mode before enabling this setting.

A dictionary of label names 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, Server:One;Data Center:Primary.

Defines a name for the log file.

Defines a path to the agent log file, excluding the filename. If you want to send your agent logs to standard out, set this to STDOUT.

Specifies a marshaller for transmitting data to the New Relic collector. Currently json is the only valid value for this setting.

When true, the agent transmits data about your app to the New Relic collector.

If true, uses Module#prepend rather than alias_method for ActiveRecord instrumentation.

Defines a host for communicating with the New Relic collector via a proxy server.

Defines a password for communicating with the New Relic collector via a proxy server.

Defines a port for communicating with the New Relic collector via a proxy server.

Defines a user for communicating with the New Relic collector via a proxy server.

If true, enables the exit handler that sends data to the New Relic collector before shutting down.

When set to true, forces a synchronous connection to the New Relic collector during application startup. For very short-lived processes, this helps ensure the New Relic agent has time to report.

If true, tracer state storage is thread-local, otherwise, fiber-local.

Defines the maximum number of seconds the agent should spend attempting to connect to the collector.

If true, enables capture of all HTTP request headers for all destinations.

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:

module MyCompany
            class Image
                def render_png
                    # code to render a PNG
                end
            end

            class User
                def self.notify
                    # code to notify users
                end
            end
        end

Given that source code, the newrelic.yml config file might request instrumentation for both of these methods like so:

automatic_custom_instrumentation_method_list:
            - MyCompany::Image#render_png
            - MyCompany::User.notify

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, use this comma-delimited string format:

$
export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify'

If true, metrics for Action Cable broadcast calls will not include the broadcasting value for a given broadcast. Defaults to false. The default may change in a future major version release.

A list of middleware class or module names the agent should ignore. Example: ["Rack::Cors", "ActionDispatch::Reloader"]

If true, when the agent is in an application using Ruby on Rails, it will start after config/initializers run.