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 fa1ec85129b..40ac596085a 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 @@ -16,7 +16,7 @@ freshnessValidatedDate: never This file is automatically generated from values defined in `lib/new_relic/agent/configuration/default_source.rb`. Make all changes directly to `default_source.rb.` - Submit PRs or raise issues at: [https://github.com/newrelic/newrelic-ruby-agent](https://github.com/newrelic/newrelic-ruby-agent) + Submit PRs or raise issues at: https://github.com/newrelic/newrelic-ruby-agent You can configure the New Relic Ruby agent with settings in a configuration file, environment variables, or programmatically with server-side configuration. This document summarizes the configuration options available for the Ruby agent. @@ -92,763 +92,417 @@ To update `newrelic.yml` file after a new release, use the template in the base Updating the gem does not automatically update `config/newrelic.yml`. + ## General [#general] These settings are available for agent configuration. Some settings depend on your New Relic subscription level. - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_AGENT_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_AGENT_ENABLED`
- If `true`, allows the Ruby agent to run. + If `true`, allows the Ruby agent to run. - + - - - - - - - - - - - + + +
TypeString
Default`(Dynamic)`
Environ variable`NEW_RELIC_APP_NAME`
TypeString
Default`(Dynamic)`
Environ variable`NEW_RELIC_APP_NAME`
- Specify the [application name](/docs/apm/new-relic-apm/installation-configuration/name-your-application) used to aggregate data in the New Relic UI. To report data to [multiple apps at the same time](/docs/apm/new-relic-apm/installation-configuration/using-multiple-names-app), specify a list of names separated by a semicolon `;`. For example, `MyApp` or `MyStagingApp;Instance1`. + Specify the [application name](/docs/apm/new-relic-apm/installation-configuration/name-your-application) used to aggregate data in the New Relic UI. To report data to [multiple apps at the same time](/docs/apm/new-relic-apm/installation-configuration/using-multiple-names-app), specify a list of names separated by a semicolon `;`. For example, `MyApp` or `MyStagingApp;Instance1`. - + - - - - - - - - - - - + + +
TypeString
Default`""`
Environ variable`NEW_RELIC_LICENSE_KEY`
TypeString
Default`""`
Environ variable`NEW_RELIC_LICENSE_KEY`
- Your New Relic . + Your New Relic . - + - - - - - - - - - - - + + +
TypeString
Default`"info"`
Environ variable`NEW_RELIC_LOG_LEVEL`
TypeString
Default`"info"`
Environ variable`NEW_RELIC_LOG_LEVEL`
- Sets the level of detail of log messages. Possible log levels, in increasing verbosity, are: `error`, `warn`, `info` or `debug`. + Sets the level of detail of log messages. Possible log levels, in increasing verbosity, are: `error`, `warn`, `info` or `debug`. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ACTIVE_SUPPORT_CUSTOM_EVENTS_NAMES`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ACTIVE_SUPPORT_CUSTOM_EVENTS_NAMES`
- An array of ActiveSupport custom event names to subscribe to and instrument. For example, + An array of ActiveSupport custom event names to subscribe to and instrument. For example, + - one.custom.event + - another.event + - a.third.event - * one.custom.event - * another.event - * a.third.event - + - - - - - - - - - - - + + +
TypeString
Default`""`
Environ variable`NEW_RELIC_API_KEY`
TypeString
Default`""`
Environ variable`NEW_RELIC_API_KEY`
- Your New Relic . Required when using the New Relic REST API v2 to record deployments using the `newrelic deployments` command. + Your New Relic . Required when using the New Relic REST API v2 to record deployments using the `newrelic deployments` command. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_BACKPORT_FAST_ACTIVE_RECORD_CONNECTION_LOOKUP`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_BACKPORT_FAST_ACTIVE_RECORD_CONNECTION_LOOKUP`
- 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. + 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. - + - - - - - - - - - - - + + +
TypeString
Default`nil`
Environ variable`NEW_RELIC_CA_BUNDLE_PATH`
TypeString
Default`nil`
Environ variable`NEW_RELIC_CA_BUNDLE_PATH`
- Manual override for the path to your local CA bundle. This CA bundle will be used to validate the SSL certificate presented by New Relic's data collection service. + Manual override for the path to your local CA bundle. This CA bundle will be used to validate the SSL certificate presented by New Relic's data collection service. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_CAPTURE_MEMCACHE_KEYS`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_CAPTURE_MEMCACHE_KEYS`
- Enable or disable the capture of memcache keys from transaction traces. + Enable or disable the capture of memcache keys from transaction traces. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_CAPTURE_PARAMS`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_CAPTURE_PARAMS`
- When `true`, the agent captures HTTP request parameters and attaches them to transaction traces, traced errors, and [`TransactionError` events](/attribute-dictionary?attribute_name=&events_tids%5B%5D=8241). + When `true`, the agent captures HTTP request parameters and attaches them to transaction traces, traced errors, and [`TransactionError` events](/attribute-dictionary?attribute_name=&events_tids%5B%5D=8241). When using the `capture_params` setting, the Ruby agent will not attempt to filter secret information. `Recommendation:` To filter secret information from request parameters, use the [`attributes.include` setting](/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby) instead. For more information, see the Ruby attribute examples. + - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_CLEAR_TRANSACTION_STATE_AFTER_FORK`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_CLEAR_TRANSACTION_STATE_AFTER_FORK`
- If `true`, the agent will clear `Tracer::State` in `Agent.drop_buffered_data`. + If `true`, the agent will clear `Tracer::State` in `Agent.drop_buffered_data`. - + - - - - - - - - - - - + + +
TypeString
Default`(Dynamic)`
Environ variable`NEW_RELIC_CONFIG_PATH`
TypeString
Default`(Dynamic)`
Environ variable`NEW_RELIC_CONFIG_PATH`
- Path to `newrelic.yml`. If undefined, the agent checks the following directories (in order): - + 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` + - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_EXCLUDE_NEWRELIC_HEADER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_EXCLUDE_NEWRELIC_HEADER`
- Allows newrelic distributed tracing headers to be suppressed on outbound requests. + Allows newrelic distributed tracing headers to be suppressed on outbound requests. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_FORCE_INSTALL_EXIT_HANDLER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_FORCE_INSTALL_EXIT_HANDLER`
- The exit handler that sends all cached data to the collector before shutting down is forcibly installed. This is true even when it detects scenarios where it generally should not be. The known use case for this option is when Sinatra runs as an embedded service within another framework. The agent detects the Sinatra app and skips the `at_exit` handler as a result. Sinatra classically runs the entire application in an `at_exit` block and would otherwise misbehave if the agent's `at_exit` handler was also installed in those circumstances. Note: `send_data_on_exit` should also be set to `true` in tandem with this setting. + The exit handler that sends all cached data to the collector before shutting down is forcibly installed. This is true even when it detects scenarios where it generally should not be. The known use case for this option is when Sinatra runs as an embedded service within another framework. The agent detects the Sinatra app and skips the `at_exit` handler as a result. Sinatra classically runs the entire application in an `at_exit` block and would otherwise misbehave if the agent's `at_exit` handler was also installed in those circumstances. Note: `send_data_on_exit` should also be set to `true` in tandem with this setting. + - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_HIGH_SECURITY`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_HIGH_SECURITY`
- If `true`, enables [high security mode](/docs/accounts-partnerships/accounts/security/high-security). Ensure you understand the implications of high security mode before enabling this setting. + If `true`, enables [high security mode](/docs/accounts-partnerships/accounts/security/high-security). Ensure you understand the implications of high security mode before enabling this setting. - + - - - - - - - - - - - + + +
TypeString
Default`""`
Environ variable`NEW_RELIC_LABELS`
TypeString
Default`""`
Environ variable`NEW_RELIC_LABELS`
- 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, `Server:One;Data Center:Primary`. + 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, `Server:One;Data Center:Primary`. - + - - - - - - - - - - - + + +
TypeString
Default`"newrelic_agent.log"`
Environ variable`NEW_RELIC_LOG_FILE_NAME`
TypeString
Default`"newrelic_agent.log"`
Environ variable`NEW_RELIC_LOG_FILE_NAME`
- Defines a name for the log file. + Defines a name for the log file. - + - - - - - - - - - - - + + +
TypeString
Default`"log/"`
Environ variable`NEW_RELIC_LOG_FILE_PATH`
TypeString
Default`"log/"`
Environ variable`NEW_RELIC_LOG_FILE_PATH`
- Defines a path to the agent log file, excluding the filename. + Defines a path to the agent log file, excluding the filename. - + - - - - - - - - - - - + + +
TypeString
Default`"json"`
Environ variable`NEW_RELIC_MARSHALLER`
TypeString
Default`"json"`
Environ variable`NEW_RELIC_MARSHALLER`
- Specifies a marshaller for transmitting data to the New Relic [collector](/docs/apm/new-relic-apm/getting-started/glossary#collector). Currently `json` is the only valid value for this setting. + Specifies a marshaller for transmitting data to the New Relic [collector](/docs/apm/new-relic-apm/getting-started/glossary#collector). Currently `json` is the only valid value for this setting. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_MONITOR_MODE`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_MONITOR_MODE`
- 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). + 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). - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_PREPEND_ACTIVE_RECORD_INSTRUMENTATION`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_PREPEND_ACTIVE_RECORD_INSTRUMENTATION`
- If `true`, uses `Module#prepend` rather than `alias_method` for ActiveRecord instrumentation. + If `true`, uses `Module#prepend` rather than `alias_method` for ActiveRecord instrumentation. - + - - - - - - - - - - - + + +
TypeString
Default`nil`
Environ variable`NEW_RELIC_PROXY_HOST`
TypeString
Default`nil`
Environ variable`NEW_RELIC_PROXY_HOST`
- Defines a host for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server. + Defines a host for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server. - + - - - - - - - - - - - + + +
TypeString
Default`nil`
Environ variable`NEW_RELIC_PROXY_PASS`
TypeString
Default`nil`
Environ variable`NEW_RELIC_PROXY_PASS`
- Defines a password for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server. + Defines a password for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server. - + - - - - - - - - - - - + + +
TypeInteger
Default`8080`
Environ variable`NEW_RELIC_PROXY_PORT`
TypeInteger
Default`8080`
Environ variable`NEW_RELIC_PROXY_PORT`
- Defines a port for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server. + Defines a port for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server. - + - - - - - - - - - - - + + +
TypeString
Default`nil`
Environ variable`NEW_RELIC_PROXY_USER`
TypeString
Default`nil`
Environ variable`NEW_RELIC_PROXY_USER`
- Defines a user for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server. + Defines a user for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server. - + - - - - - - - - - - - + + +
TypeString
Default`""`
Environ variable`NEW_RELIC_SECURITY_POLICIES_TOKEN`
TypeString
Default`""`
Environ variable`NEW_RELIC_SECURITY_POLICIES_TOKEN`
- Applies Language Agent Security Policy settings. + Applies Language Agent Security Policy settings. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SEND_DATA_ON_EXIT`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SEND_DATA_ON_EXIT`
- If `true`, enables the exit handler that sends data to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) before shutting down. + If `true`, enables the exit handler that sends data to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) before shutting down. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SYNC_STARTUP`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SYNC_STARTUP`
- When set to `true`, forces a synchronous connection to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) during application startup. For very short-lived processes, this helps ensure the New Relic agent has time to report. + When set to `true`, forces a synchronous connection to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) during application startup. For very short-lived processes, this helps ensure the New Relic agent has time to report. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_THREAD_LOCAL_TRACER_STATE`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_THREAD_LOCAL_TRACER_STATE`
- If `true`, tracer state storage is thread-local, otherwise, fiber-local + If `true`, tracer state storage is thread-local, otherwise, fiber-local - + - - - - - - - - - - - + + +
TypeInteger
Default`120`
Environ variable`NEW_RELIC_TIMEOUT`
TypeInteger
Default`120`
Environ variable`NEW_RELIC_TIMEOUT`
- Defines the maximum number of seconds the agent should spend attempting to connect to the collector. + Defines the maximum number of seconds the agent should spend attempting to connect to the collector. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_ALLOW_ALL_HEADERS`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_ALLOW_ALL_HEADERS`
- If `true`, enables capture of all HTTP request headers for all destinations. + If `true`, enables capture of all HTTP request headers for all destinations. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DEFER_RAILS_INITIALIZATION`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DEFER_RAILS_INITIALIZATION`
- If `true`, when the agent is in an application using Ruby on Rails, it will start after `config/initializers` run. + If `true`, when the agent is in an application using Ruby on Rails, it will start after `config/initializers` run. + + + This option may only be set by environment variable. + - - This option may only be set by environment variable. - + ## Transaction Tracer [#transaction-tracer] @@ -856,195 +510,109 @@ These settings are available for agent configuration. Some settings depend on yo The [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces) feature collects detailed information from a selection of transactions, including a summary of the calling sequence, a breakdown of time spent, and a list of SQL queries and their query plans (on mysql and postgresql). Available features depend on your New Relic subscription level. - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_ENABLED`
- If `true`, enables collection of [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces). + If `true`, enables collection of [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces). - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_EXPLAIN_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_EXPLAIN_ENABLED`
- If `true`, enables the collection of explain plans in transaction traces. This setting will also apply to explain plans in slow SQL traces if [`slow_sql.explain_enabled`](#slow_sql-explain_enabled) is not set separately. + If `true`, enables the collection of explain plans in transaction traces. This setting will also apply to explain plans in slow SQL traces if [`slow_sql.explain_enabled`](#slow_sql-explain_enabled) is not set separately. - + - - - - - - - - - - - + + +
TypeFloat
Default`0.5`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_EXPLAIN_THRESHOLD`
TypeFloat
Default`0.5`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_EXPLAIN_THRESHOLD`
- Threshold (in seconds) above which the agent will collect explain plans. Relevant only when [`explain_enabled`](#transaction_tracer.explain_enabled) is true. + Threshold (in seconds) above which the agent will collect explain plans. Relevant only when [`explain_enabled`](#transaction_tracer.explain_enabled) is true. - + - - - - - - - - - - - + + +
TypeInteger
Default`4000`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_LIMIT_SEGMENTS`
TypeInteger
Default`4000`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_LIMIT_SEGMENTS`
- Maximum number of transaction trace nodes to record in a single transaction trace. + Maximum number of transaction trace nodes to record in a single transaction trace. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_RECORD_REDIS_ARGUMENTS`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_RECORD_REDIS_ARGUMENTS`
- If `true`, the agent records Redis command arguments in transaction traces. + If `true`, the agent records Redis command arguments in transaction traces. - + - - - - - - - - - - - + + +
TypeString
Default`"obfuscated"`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_RECORD_SQL`
TypeString
Default`"obfuscated"`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_RECORD_SQL`
- Obfuscation level for SQL queries reported in transaction trace nodes. + Obfuscation level for SQL queries reported in transaction trace nodes. - By default, this is set to `obfuscated`, which strips out the numeric and string literals. + By default, this is set to `obfuscated`, which strips out the numeric and string literals. - * If you do not want the agent to capture query information, set this to `none`. - * If you want the agent to capture all query information in its original form, set this to `raw`. - * When you enable [high security mode](/docs/agents/manage-apm-agents/configuration/high-security-mode), this is automatically set to `obfuscated`. + - If you do not want the agent to capture query information, set this to `none`. + - If you want the agent to capture all query information in its original form, set this to `raw`. + - When you enable [high security mode](/docs/agents/manage-apm-agents/configuration/high-security-mode), this is automatically set to `obfuscated`. - + - - - - - - - - - - - + + +
TypeFloat
Default`0.5`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_STACK_TRACE_THRESHOLD`
TypeFloat
Default`0.5`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_STACK_TRACE_THRESHOLD`
- Specify a threshold in seconds. The agent includes stack traces in transaction trace nodes when the stack trace duration exceeds this threshold. + Specify a threshold in seconds. The agent includes stack traces in transaction trace nodes when the stack trace duration exceeds this threshold. - + - - - - - - - - - - - + + +
TypeFloat
Default`(Dynamic)`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_TRANSACTION_THRESHOLD`
TypeFloat
Default`(Dynamic)`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_TRANSACTION_THRESHOLD`
- Specify a threshold in seconds. Transactions with a duration longer than this threshold are eligible for transaction traces. Specify a float value or the string `apdex_f`. + Specify a threshold in seconds. Transactions with a duration longer than this threshold are eligible for transaction traces. Specify a float value or the string `apdex_f`. + ## Error Collector [#error-collector] @@ -1054,353 +622,211 @@ The agent collects and reports all uncaught exceptions by default. These configu For information on ignored and expected errors, [see this page on Error Analytics in APM](/docs/agents/manage-apm-agents/agent-data/manage-errors-apm-collect-ignore-or-mark-expected/). To set expected errors via the `NewRelic::Agent.notice_error` Ruby method, [consult the Ruby agent API](/docs/agents/ruby-agent/api-guides/sending-handled-errors-new-relic/). - + + - - - - - - - - - - - + + +
TypeArray
Default`["ActionController::RoutingError", "Sinatra::NotFound"]`
Environ variable`None`
TypeArray
Default`["ActionController::RoutingError", "Sinatra::NotFound"]`
Environ variable`None`
- A list of error classes that the agent should ignore. + A list of error classes that the agent should ignore. + + + This option can't be set via environment variable. + - - This option can't be set via environment variable. - - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_CAPTURE_EVENTS`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_CAPTURE_EVENTS`
- If `true`, the agent collects [`TransactionError` events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights). + If `true`, the agent collects [`TransactionError` events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights). - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_ENABLED`
- If `true`, the agent captures traced errors and error count metrics. + If `true`, the agent captures traced errors and error count metrics. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`None`
TypeArray
Default`[]`
Environ variable`None`
- A list of error classes that the agent should treat as expected. + A list of error classes that the agent should treat as expected. + + + This option can't be set via environment variable. + - - This option can't be set via environment variable. - - + - - - - - - - - - - - + + +
TypeHash
Default`{}`
Environ variable`None`
TypeHash
Default`{}`
Environ variable`None`
- A map of error classes to a list of messages. When an error of one of the classes specified here occurs, if its error message contains one of the strings corresponding to it here, that error will be treated as expected. + A map of error classes to a list of messages. When an error of one of the classes specified here occurs, if its error message contains one of the strings corresponding to it here, that error will be treated as expected. + + + This option can't be set via environment variable. + - - This option can't be set via environment variable. - - + - - - - - - - - - - - + + +
TypeString
Default`""`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_EXPECTED_STATUS_CODES`
TypeString
Default`""`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_EXPECTED_STATUS_CODES`
- A comma separated list of status codes, possibly including ranges. Errors associated with these status codes, where applicable, will be treated as expected. + A comma separated list of status codes, possibly including ranges. Errors associated with these status codes, where applicable, will be treated as expected. - + - - - - - - - - - - - + + +
TypeHash
Default`{}`
Environ variable`None`
TypeHash
Default`{}`
Environ variable`None`
- A map of error classes to a list of messages. When an error of one of the classes specified here occurs, if its error message contains one of the strings corresponding to it here, that error will be ignored. + A map of error classes to a list of messages. When an error of one of the classes specified here occurs, if its error message contains one of the strings corresponding to it here, that error will be ignored. + + + This option can't be set via environment variable. + - - This option can't be set via environment variable. - - + - - - - - - - - - - - + + +
TypeString
Default`""`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_IGNORE_STATUS_CODES`
TypeString
Default`""`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_IGNORE_STATUS_CODES`
- A comma separated list of status codes, possibly including ranges. Errors associated with these status codes, where applicable, will be ignored. + A comma separated list of status codes, possibly including ranges. Errors associated with these status codes, where applicable, will be ignored. - + - - - - - - - - - - - + + +
TypeInteger
Default`50`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_MAX_BACKTRACE_FRAMES`
TypeInteger
Default`50`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_MAX_BACKTRACE_FRAMES`
- Defines the maximum number of frames in an error backtrace. Backtraces over this amount are truncated in the middle, preserving the beginning and the end of the stack trace. + Defines the maximum number of frames in an error backtrace. Backtraces over this amount are truncated in the middle, preserving the beginning and the end of the stack trace. - + - - - - - - - - - - - + + +
TypeInteger
Default`100`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_MAX_EVENT_SAMPLES_STORED`
TypeInteger
Default`100`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_MAX_EVENT_SAMPLES_STORED`
- Defines the maximum number of [`TransactionError` events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights) reported per harvest cycle. + Defines the maximum number of [`TransactionError` events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights) reported per harvest cycle. + ## Browser Monitoring [#browser-monitoring] -The [page load timing](/docs/browser/new-relic-browser/page-load-timing/page-load-timing-process) feature (sometimes referred to as real user monitoring or RUM) gives you insight into the performance real users are experiencing with your website. This is accomplished by measuring the time it takes for your users' browsers to download and render your web pages by injecting a small amount of JavaScript code into the header and footer of each page. +The [page load timing](/docs/browser/new-relic-browser/page-load-timing/page-load-timing-process) feature (sometimes referred to as real user monitoring or RUM) gives you insight into the performance real users are experiencing with your website. This is accomplished by measuring the time it takes for your users' browsers to download and render your web pages by injecting a small amount of JavaScript code into the header and footer of each page. - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_BROWSER_MONITORING_AUTO_INSTRUMENT`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_BROWSER_MONITORING_AUTO_INSTRUMENT`
- If `true`, enables [auto-injection](/docs/browser/new-relic-browser/installation-configuration/adding-apps-new-relic-browser#select-apm-app) of the JavaScript header for page load timing (sometimes referred to as real user monitoring or RUM). + If `true`, enables [auto-injection](/docs/browser/new-relic-browser/installation-configuration/adding-apps-new-relic-browser#select-apm-app) of the JavaScript header for page load timing (sometimes referred to as real user monitoring or RUM). - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_BROWSER_MONITORING_CONTENT_SECURITY_POLICY_NONCE`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_BROWSER_MONITORING_CONTENT_SECURITY_POLICY_NONCE`
- If `true`, enables auto-injection of [Content Security Policy Nonce](https://content-security-policy.com/nonce/) in browser monitoring scripts. For now, auto-injection only works with Rails 5.2+. + If `true`, enables auto-injection of [Content Security Policy Nonce](https://content-security-policy.com/nonce/) in browser monitoring scripts. For now, auto-injection only works with Rails 5.2+. + ## Transaction Events [#transaction-events] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_ENABLED`
- If `true`, enables transaction event sampling. + If `true`, enables transaction event sampling. - + - - - - - - - - - - - + + +
TypeInteger
Default`1200`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_MAX_SAMPLES_STORED`
TypeInteger
Default`1200`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_MAX_SAMPLES_STORED`
- Defines the maximum number of transaction events reported from a single harvest. + Defines the maximum number of transaction events reported from a single harvest. + ## Application Logging [#application-logging] @@ -1410,244 +836,147 @@ The Ruby agent supports [APM logs in context](/docs/apm/new-relic-apm/getting-st Available logging-related config options include: - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_ENABLED`
- If `true`, enables log decoration and the collection of log events and metrics. + If `true`, enables log decoration and the collection of log events and metrics. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED`
- If `true`, the agent captures log records emitted by your application. + If `true`, the agent captures log records emitted by your application. - + - - - - - - - - - - - + + +
TypeString
Default`"debug"`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_LOG_LEVEL`
TypeString
Default`"debug"`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_LOG_LEVEL`
- Sets the minimum level a log event must have to be forwarded to New Relic. + Sets the minimum level a log event must have to be forwarded to New Relic. - This is based on the integer values of Ruby's `Logger::Severity` constants: [https://github.com/ruby/ruby/blob/master/lib/logger/severity.rb](https://github.com/ruby/ruby/blob/master/lib/logger/severity.rb) +This is based on the integer values of Ruby's `Logger::Severity` constants: https://github.com/ruby/ruby/blob/master/lib/logger/severity.rb - The intention is to forward logs with the level given to the configuration, as well as any logs with a higher level of severity. +The intention is to forward logs with the level given to the configuration, as well as any logs with a higher level of severity. - For example, setting this value to "debug" will forward all log events to New Relic. Setting this value to "error" will only forward log events with the levels "error", "fatal", and "unknown". +For example, setting this value to "debug" will forward all log events to New Relic. Setting this value to "error" will only forward log events with the levels "error", "fatal", and "unknown". - Valid values (ordered lowest to highest): +Valid values (ordered lowest to highest): + * "debug" + * "info" + * "warn" + * "error" + * "fatal" + * "unknown" - * "debug" - * "info" - * "warn" - * "error" - * "fatal" - * "unknown" - + - - - - - - - - - - - + + +
TypeHash
Default`{}`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_CUSTOM_ATTRIBUTES`
TypeHash
Default`{}`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_CUSTOM_ATTRIBUTES`
- A hash with key/value pairs to add as custom attributes to all log events forwarded to New Relic. If sending using an environment variable, the value must be formatted like: "key1=value1,key2=value2" + A hash with key/value pairs to add as custom attributes to all log events forwarded to New Relic. If sending using an environment variable, the value must be formatted like: "key1=value1,key2=value2" - + - - - - - - - - - - - + + +
TypeInteger
Default`10000`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED`
TypeInteger
Default`10000`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED`
- Defines the maximum number of log records to buffer in memory at a time. + Defines the maximum number of log records to buffer in memory at a time. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED`
- If `true`, the agent decorates logs with metadata to link to entities, hosts, traces, and spans. + If `true`, the agent decorates logs with metadata to link to entities, hosts, traces, and spans. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_METRICS_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_APPLICATION_LOGGING_METRICS_ENABLED`
- If `true`, the agent captures metrics related to logging for your application. + If `true`, the agent captures metrics related to logging for your application. + ## AI Monitoring [#ai-monitoring] This section includes Ruby agent configurations for setting up AI monitoring. - - You need to enable distributed tracing to capture trace and feedback data. It is turned on by default in Ruby agents 8.0.0 and higher. - +You need to enable distributed tracing to capture trace and feedback data. It is turned on by default in Ruby agents 8.0.0 and higher. - + + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_AI_MONITORING_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_AI_MONITORING_ENABLED`
- If `false`, all LLM instrumentation (OpenAI only for now) will be disabled and no metrics, events, or spans will be sent. AI Monitoring is automatically disabled if `high_security` mode is enabled. + If `false`, all LLM instrumentation (OpenAI only for now) will be disabled and no metrics, events, or spans will be sent. AI Monitoring is automatically disabled if `high_security` mode is enabled. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_AI_MONITORING_RECORD_CONTENT_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_AI_MONITORING_RECORD_CONTENT_ENABLED`
- If `false`, LLM instrumentation (OpenAI only for now) will not capture input and output content on specific LLM events. - - The excluded attributes include: + If `false`, LLM instrumentation (OpenAI only for now) will not capture input and output content on specific LLM events. + The excluded attributes include: * `content` from LlmChatCompletionMessage events * `input` from LlmEmbedding events - This is an optional security setting to prevent recording sensitive data sent to and received from your LLMs. + This is an optional security setting to prevent recording sensitive data sent to and received from your LLMs. + + ## Attributes [#attributes] @@ -1655,819 +984,476 @@ This section includes Ruby agent configurations for setting up AI monitoring. [Attributes](/docs/features/agent-attributes) are key-value pairs containing information that determines the properties of an event or transaction. These key-value pairs can be viewed within transaction traces in APM, traced errors in APM, transaction events in dashboards, and page views in dashboards. You can customize exactly which attributes will be sent to each of these destinations - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ATTRIBUTES_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ATTRIBUTES_ENABLED`
- If `true`, enables capture of attributes for all destinations. + If `true`, enables capture of attributes for all destinations. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ATTRIBUTES_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ATTRIBUTES_EXCLUDE`
- Prefix of attributes to exclude from all destinations. Allows `*` as wildcard at end. + Prefix of attributes to exclude from all destinations. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ATTRIBUTES_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ATTRIBUTES_INCLUDE`
- Prefix of attributes to include in all destinations. Allows `*` as wildcard at end. + Prefix of attributes to include in all destinations. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_ENABLED`
- If `true`, the agent captures attributes from browser monitoring. + If `true`, the agent captures attributes from browser monitoring. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_EXCLUDE`
- Prefix of attributes to exclude from browser monitoring. Allows `*` as wildcard at end. + Prefix of attributes to exclude from browser monitoring. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_INCLUDE`
- Prefix of attributes to include in browser monitoring. Allows `*` as wildcard at end. + Prefix of attributes to include in browser monitoring. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_ENABLED`
- If `true`, the agent captures attributes from error collection. + If `true`, the agent captures attributes from error collection. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_EXCLUDE`
- Prefix of attributes to exclude from error collection. Allows `*` as wildcard at end. + Prefix of attributes to exclude from error collection. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_INCLUDE`
- Prefix of attributes to include in error collection. Allows `*` as wildcard at end. + Prefix of attributes to include in error collection. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_ENABLED`
- If `true`, the agent captures attributes on span events. + If `true`, the agent captures attributes on span events. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_EXCLUDE`
- Prefix of attributes to exclude from span events. Allows `*` as wildcard at end. + Prefix of attributes to exclude from span events. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_INCLUDE`
- Prefix of attributes to include on span events. Allows `*` as wildcard at end. + Prefix of attributes to include on span events. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_ENABLED`
- If `true`, the agent captures attributes from transaction events. + If `true`, the agent captures attributes from transaction events. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE`
- Prefix of attributes to exclude from transaction events. Allows `*` as wildcard at end. + Prefix of attributes to exclude from transaction events. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE`
- Prefix of attributes to include in transaction events. Allows `*` as wildcard at end. + Prefix of attributes to include in transaction events. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_ENABLED`
- If `true`, the agent captures attributes on transaction segments. + If `true`, the agent captures attributes on transaction segments. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_EXCLUDE`
- Prefix of attributes to exclude from transaction segments. Allows `*` as wildcard at end. + Prefix of attributes to exclude from transaction segments. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_INCLUDE`
- Prefix of attributes to include on transaction segments. Allows `*` as wildcard at end. + Prefix of attributes to include on transaction segments. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_ENABLED`
- If `true`, the agent captures attributes from transaction traces. + If `true`, the agent captures attributes from transaction traces. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_EXCLUDE`
- Prefix of attributes to exclude from transaction traces. Allows `*` as wildcard at end. + Prefix of attributes to exclude from transaction traces. Allows `*` as wildcard at end. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_INCLUDE`
- Prefix of attributes to include in transaction traces. Allows `*` as wildcard at end. + Prefix of attributes to include in transaction traces. Allows `*` as wildcard at end. + ## Audit Log [#audit-log] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_AUDIT_LOG_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_AUDIT_LOG_ENABLED`
- If `true`, enables an audit log which logs communications with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector). + If `true`, enables an audit log which logs communications with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector). - + - - - - - - - - - - - + + +
TypeArray
Default`[".*"]`
Environ variable`NEW_RELIC_AUDIT_LOG_ENDPOINTS`
TypeArray
Default`[".*"]`
Environ variable`NEW_RELIC_AUDIT_LOG_ENDPOINTS`
- List of allowed endpoints to include in audit log. + List of allowed endpoints to include in audit log. - + - - - - - - - - - - - + + +
TypeString
Default`log/newrelic_audit.log`
Environ variable`NEW_RELIC_AUDIT_LOG_PATH`
TypeString
Default`log/newrelic_audit.log`
Environ variable`NEW_RELIC_AUDIT_LOG_PATH`
- Specifies a path to the audit log file (including the filename). + Specifies a path to the audit log file (including the filename). + ## Autostart [#autostart] + + - + + - - - - - - - - - - - + + +
TypeString
Default`"Rails::Command::ConsoleCommand,Rails::Command::CredentialsCommand,Rails::Command::Db::System::ChangeCommand,Rails::Command::DbConsoleCommand,Rails::Command::DestroyCommand,Rails::Command::DevCommand,Rails::Command::EncryptedCommand,Rails::Command::GenerateCommand,Rails::Command::InitializersCommand,Rails::Command::NotesCommand,Rails::Command::RoutesCommand,Rails::Command::RunnerCommand,Rails::Command::SecretsCommand,Rails::Console,Rails::DBConsole"`
Environ variable`NEW_RELIC_AUTOSTART_DENYLISTED_CONSTANTS`
TypeString
Default`"Rails::Command::ConsoleCommand,Rails::Command::CredentialsCommand,Rails::Command::Db::System::ChangeCommand,Rails::Command::DbConsoleCommand,Rails::Command::DestroyCommand,Rails::Command::DevCommand,Rails::Command::EncryptedCommand,Rails::Command::GenerateCommand,Rails::Command::InitializersCommand,Rails::Command::NotesCommand,Rails::Command::RoutesCommand,Rails::Command::RunnerCommand,Rails::Command::SecretsCommand,Rails::Console,Rails::DBConsole"`
Environ variable`NEW_RELIC_AUTOSTART_DENYLISTED_CONSTANTS`
- Specify a list of constants that should prevent the agent from starting automatically. Separate individual constants with a comma `,`. For example, `"Rails::Console,UninstrumentedBackgroundJob"`. + Specify a list of constants that should prevent the agent from starting automatically. Separate individual constants with a comma `,`. For example, `"Rails::Console,UninstrumentedBackgroundJob"`. - + - - - - - - - - - - - + + +
TypeString
Default`"irb,rspec"`
Environ variable`NEW_RELIC_AUTOSTART_DENYLISTED_EXECUTABLES`
TypeString
Default`"irb,rspec"`
Environ variable`NEW_RELIC_AUTOSTART_DENYLISTED_EXECUTABLES`
- Defines a comma-delimited list of executables that the agent should not instrument. For example, `"rake,my_ruby_script.rb"`. + Defines a comma-delimited list of executables that the agent should not instrument. For example, `"rake,my_ruby_script.rb"`. - + - - - - - - - - - - - + + +
TypeString
Default`"about,assets:clean,assets:clobber,assets:environment,assets:precompile,assets:precompile:all,db:create,db:drop,db:fixtures:load,db:migrate,db:migrate:status,db:rollback,db:schema:cache:clear,db:schema:cache:dump,db:schema:dump,db:schema:load,db:seed,db:setup,db:structure:dump,db:version,doc:app,log:clear,middleware,notes,notes:custom,rails:template,rails:update,routes,secret,spec,spec:features,spec:requests,spec:controllers,spec:helpers,spec:models,spec:views,spec:routing,spec:rcov,stats,test,test:all,test:all:db,test:recent,test:single,test:uncommitted,time:zones:all,tmp:clear,tmp:create,webpacker:compile"`
Environ variable`NEW_RELIC_AUTOSTART_DENYLISTED_RAKE_TASKS`
TypeString
Default`"about,assets:clean,assets:clobber,assets:environment,assets:precompile,assets:precompile:all,db:create,db:drop,db:fixtures:load,db:migrate,db:migrate:status,db:rollback,db:schema:cache:clear,db:schema:cache:dump,db:schema:dump,db:schema:load,db:seed,db:setup,db:structure:dump,db:version,doc:app,log:clear,middleware,notes,notes:custom,rails:template,rails:update,routes,secret,spec,spec:features,spec:requests,spec:controllers,spec:helpers,spec:models,spec:views,spec:routing,spec:rcov,stats,test,test:all,test:all:db,test:recent,test:single,test:uncommitted,time:zones:all,tmp:clear,tmp:create,webpacker:compile"`
Environ variable`NEW_RELIC_AUTOSTART_DENYLISTED_RAKE_TASKS`
- Defines a comma-delimited list of Rake tasks that the agent should not instrument. For example, `"assets:precompile,db:migrate"`. + Defines a comma-delimited list of Rake tasks that the agent should not instrument. For example, `"assets:precompile,db:migrate"`. + ## Code Level Metrics [#code-level-metrics] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_CODE_LEVEL_METRICS_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_CODE_LEVEL_METRICS_ENABLED`
- If `true`, the agent will report source code level metrics for traced methods. - See: [https://docs.newrelic.com/docs/apm/agents/ruby-agent/features/ruby-codestream-integration/](https://docs.newrelic.com/docs/apm/agents/ruby-agent/features/ruby-codestream-integration/) + If `true`, the agent will report source code level metrics for traced methods. +See: https://docs.newrelic.com/docs/apm/agents/ruby-agent/features/ruby-codestream-integration/ + ## Cross Application Tracer [#cross-application-tracer] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_CROSS_APPLICATION_TRACER_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_CROSS_APPLICATION_TRACER_ENABLED`
- **DEPRECATED** Please see: [distributed_tracing.enabled](#distributed_tracing-enabled). + **DEPRECATED** Please see: [distributed_tracing.enabled](#distributed_tracing-enabled). - If `true`, enables [cross-application tracing](/docs/agents/ruby-agent/features/cross-application-tracing-ruby/) when `distributed_tracing.enabled` is set to `false`. +If `true`, enables [cross-application tracing](/docs/agents/ruby-agent/features/cross-application-tracing-ruby/) when `distributed_tracing.enabled` is set to `false`. + ## Custom Attributes [#custom-attributes] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_CUSTOM_ATTRIBUTES_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_CUSTOM_ATTRIBUTES_ENABLED`
- If `false`, custom attributes will not be sent on events. + If `false`, custom attributes will not be sent on events. + ## Custom Events [#custom-events] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_CUSTOM_INSIGHTS_EVENTS_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_CUSTOM_INSIGHTS_EVENTS_ENABLED`
- If `true`, the agent captures [custom events](/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents). + If `true`, the agent captures [custom events](/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents). - + - - - - - - - - - - - + + +
TypeInteger
Default`3000`
Environ variable`NEW_RELIC_CUSTOM_INSIGHTS_EVENTS_MAX_SAMPLES_STORED`
TypeInteger
Default`3000`
Environ variable`NEW_RELIC_CUSTOM_INSIGHTS_EVENTS_MAX_SAMPLES_STORED`
- * Specify a maximum number of custom events to buffer in memory at a time. - * When configuring the agent for [AI monitoring](/docs/ai-monitoring/intro-to-ai-monitoring), set to max value `100000`. This ensures the agent captures the maximum amount of LLM events. + * Specify a maximum number of custom events to buffer in memory at a time. + * When configuring the agent for [AI monitoring](/docs/ai-monitoring/intro-to-ai-monitoring), set to max value `100000`. This ensures the agent captures the maximum amount of LLM events. + + ## Datastore Tracer [#datastore-tracer] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_DATASTORE_TRACER_DATABASE_NAME_REPORTING_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_DATASTORE_TRACER_DATABASE_NAME_REPORTING_ENABLED`
- If `false`, the agent will not add `database_name` parameter to transaction or slow sql traces. + If `false`, the agent will not add `database_name` parameter to transaction or slow sql traces. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_DATASTORE_TRACER_INSTANCE_REPORTING_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_DATASTORE_TRACER_INSTANCE_REPORTING_ENABLED`
- If `false`, the agent will not report datastore instance metrics, nor add `host` or `port_path_or_id` parameters to transaction or slow SQL traces. + If `false`, the agent will not report datastore instance metrics, nor add `host` or `port_path_or_id` parameters to transaction or slow SQL traces. + ## Disabling [#disabling] @@ -2475,445 +1461,238 @@ This section includes Ruby agent configurations for setting up AI monitoring. Use these settings to toggle instrumentation types during agent startup. - + + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTION_CABLE_INSTRUMENTATION`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTION_CABLE_INSTRUMENTATION`
- If `true`, disables Action Cable instrumentation. + If `true`, disables Action Cable instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTION_CONTROLLER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTION_CONTROLLER`
- If `true`, disables Action Controller instrumentation. + If `true`, disables Action Controller instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTION_MAILBOX`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTION_MAILBOX`
- If `true`, disables Action Mailbox instrumentation. + If `true`, disables Action Mailbox instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTION_MAILER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTION_MAILER`
- If `true`, disables Action Mailer instrumentation. + If `true`, disables Action Mailer instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVEJOB`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVEJOB`
- If `true`, disables Active Job instrumentation. + If `true`, disables Active Job instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVE_STORAGE`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVE_STORAGE`
- If `true`, disables Active Storage instrumentation. + If `true`, disables Active Storage instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVE_SUPPORT`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVE_SUPPORT`
- If `true`, disables Active Support instrumentation. + If `true`, disables Active Support instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVE_RECORD_INSTRUMENTATION`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVE_RECORD_INSTRUMENTATION`
- If `true`, disables Active Record instrumentation. + If `true`, disables Active Record instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVE_RECORD_NOTIFICATIONS`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_ACTIVE_RECORD_NOTIFICATIONS`
- If `true`, disables instrumentation for Active Record 4+ + If `true`, disables instrumentation for Active Record 4+ - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_CPU_SAMPLER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_CPU_SAMPLER`
- If `true`, the agent won't sample the CPU usage of the host process. + If `true`, the agent won't sample the CPU usage of the host process. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_DELAYED_JOB_SAMPLER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_DELAYED_JOB_SAMPLER`
- If `true`, the agent won't measure the depth of Delayed Job queues. + If `true`, the agent won't measure the depth of Delayed Job queues. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_GC_PROFILER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_GC_PROFILER`
- If `true`, disables the use of `GC::Profiler` to measure time spent in garbage collection + If `true`, disables the use of `GC::Profiler` to measure time spent in garbage collection - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_MEMORY_SAMPLER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_MEMORY_SAMPLER`
- If `true`, the agent won't sample the memory usage of the host process. + If `true`, the agent won't sample the memory usage of the host process. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_MIDDLEWARE_INSTRUMENTATION`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_MIDDLEWARE_INSTRUMENTATION`
- If `true`, the agent won't wrap third-party middlewares in instrumentation (regardless of whether they are installed via `Rack::Builder` or Rails). + If `true`, the agent won't wrap third-party middlewares in instrumentation (regardless of whether they are installed via `Rack::Builder` or Rails). + + + When middleware instrumentation is disabled, if an application is using middleware that could alter the response code, the HTTP status code reported on the transaction may not reflect the altered value. + - - When middleware instrumentation is disabled, if an application is using middleware that could alter the response code, the HTTP status code reported on the transaction may not reflect the altered value. - - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_SAMPLERS`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_SAMPLERS`
- If `true`, disables the collection of sampler metrics. Sampler metrics are metrics that are not event-based (such as CPU time or memory usage). + If `true`, disables the collection of sampler metrics. Sampler metrics are metrics that are not event-based (such as CPU time or memory usage). - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_SEQUEL_INSTRUMENTATION`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_SEQUEL_INSTRUMENTATION`
- If `true`, disables [Sequel instrumentation](/docs/agents/ruby-agent/frameworks/sequel-instrumentation). + If `true`, disables [Sequel instrumentation](/docs/agents/ruby-agent/frameworks/sequel-instrumentation). - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_SIDEKIQ`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_SIDEKIQ`
- If `true`, disables [Sidekiq instrumentation](/docs/agents/ruby-agent/background-jobs/sidekiq-instrumentation). + If `true`, disables [Sidekiq instrumentation](/docs/agents/ruby-agent/background-jobs/sidekiq-instrumentation). - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_RODA_AUTO_MIDDLEWARE`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_RODA_AUTO_MIDDLEWARE`
- If `true`, disables agent middleware for Roda. This middleware is responsible for advanced feature support such as [page load timing](/docs/browser/new-relic-browser/getting-started/new-relic-browser) and [error collection](/docs/apm/applications-menu/events/view-apm-error-analytics). + If `true`, disables agent middleware for Roda. This middleware is responsible for advanced feature support such as [page load timing](/docs/browser/new-relic-browser/getting-started/new-relic-browser) and [error collection](/docs/apm/applications-menu/events/view-apm-error-analytics). - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_SINATRA_AUTO_MIDDLEWARE`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_SINATRA_AUTO_MIDDLEWARE`
- If `true`, disables agent middleware for Sinatra. This middleware is responsible for advanced feature support such as [cross application tracing](/docs/apm/transactions/cross-application-traces/cross-application-tracing), [page load timing](/docs/browser/new-relic-browser/getting-started/new-relic-browser), and [error collection](/docs/apm/applications-menu/events/view-apm-error-analytics). + If `true`, disables agent middleware for Sinatra. This middleware is responsible for advanced feature support such as [cross application tracing](/docs/apm/transactions/cross-application-traces/cross-application-tracing), [page load timing](/docs/browser/new-relic-browser/getting-started/new-relic-browser), and [error collection](/docs/apm/applications-menu/events/view-apm-error-analytics). Cross application tracing is deprecated in favor of [distributed tracing](/docs/apm/distributed-tracing/getting-started/introduction-distributed-tracing). Distributed tracing is on by default for Ruby agent versions 8.0.0 and above. Middlewares are not required to support distributed tracing. @@ -2929,2208 +1708,1322 @@ Use these settings to toggle instrumentation types during agent startup. enabled: false ``` + - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_VIEW_INSTRUMENTATION`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_VIEW_INSTRUMENTATION`
- If `true`, disables view instrumentation. + If `true`, disables view instrumentation. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_VM_SAMPLER`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_DISABLE_VM_SAMPLER`
- If `true`, the agent won't [sample performance measurements from the Ruby VM](/docs/agents/ruby-agent/features/ruby-vm-measurements). + If `true`, the agent won't [sample performance measurements from the Ruby VM](/docs/agents/ruby-agent/features/ruby-vm-measurements). + ## Distributed Tracing [#distributed-tracing] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_DISTRIBUTED_TRACING_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_DISTRIBUTED_TRACING_ENABLED`
- Distributed tracing lets you see the path that a request takes through your distributed system. Enabling distributed tracing changes the behavior of some New Relic features, so carefully consult the [transition guide](/docs/transition-guide-distributed-tracing) before you enable this feature. + Distributed tracing lets you see the path that a request takes through your distributed system. Enabling distributed tracing changes the behavior of some New Relic features, so carefully consult the [transition guide](/docs/transition-guide-distributed-tracing) before you enable this feature. + ## Elasticsearch [#elasticsearch] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ELASTICSEARCH_CAPTURE_QUERIES`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ELASTICSEARCH_CAPTURE_QUERIES`
- If `true`, the agent captures Elasticsearch queries in transaction traces. + If `true`, the agent captures Elasticsearch queries in transaction traces. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ELASTICSEARCH_OBFUSCATE_QUERIES`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_ELASTICSEARCH_OBFUSCATE_QUERIES`
- If `true`, the agent obfuscates Elasticsearch queries in transaction traces. + If `true`, the agent obfuscates Elasticsearch queries in transaction traces. + ## Heroku [#heroku] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_HEROKU_USE_DYNO_NAMES`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_HEROKU_USE_DYNO_NAMES`
- If `true`, the agent uses Heroku dyno names as the hostname. + If `true`, the agent uses Heroku dyno names as the hostname. - + - - - - - - - - - - - + + +
TypeArray
Default`["scheduler", "run"]`
Environ variable`NEW_RELIC_HEROKU_DYNO_NAME_PREFIXES_TO_SHORTEN`
TypeArray
Default`["scheduler", "run"]`
Environ variable`NEW_RELIC_HEROKU_DYNO_NAME_PREFIXES_TO_SHORTEN`
- Ordinarily the agent reports dyno names with a trailing dot and process ID (for example, `worker.3`). You can remove this trailing data by specifying the prefixes you want to report without trailing data (for example, `worker`). + Ordinarily the agent reports dyno names with a trailing dot and process ID (for example, `worker.3`). You can remove this trailing data by specifying the prefixes you want to report without trailing data (for example, `worker`). + ## Infinite Tracing [#infinite-tracing] + + - + + - - - - - - - - - - - + + +
TypeString
Default`""`
Environ variable`NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST`
TypeString
Default`""`
Environ variable`NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST`
- Configures the hostname for the trace observer Host. When configured, enables tail-based sampling by sending all recorded spans to a trace observer for further sampling decisions, irrespective of any usual agent sampling decision. + Configures the hostname for the trace observer Host. When configured, enables tail-based sampling by sending all recorded spans to a trace observer for further sampling decisions, irrespective of any usual agent sampling decision. - + - - - - - - - - - - - + + +
TypeInteger
Default`443`
Environ variable`NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_PORT`
TypeInteger
Default`443`
Environ variable`NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_PORT`
- Configures the TCP/IP port for the trace observer Host + Configures the TCP/IP port for the trace observer Host - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_INFINITE_TRACING_BATCHING`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_INFINITE_TRACING_BATCHING`
- If `true` (the default), data sent to the trace observer is batched instead of sending each span individually. + If `true` (the default), data sent to the trace observer is batched instead of sending each span individually. - + - - - - - - - - - - - + + +
TypeSymbol
Default`:high`
Environ variable`NEW_RELIC_INFINITE_TRACING_COMPRESSION_LEVEL`
TypeSymbol
Default`:high`
Environ variable`NEW_RELIC_INFINITE_TRACING_COMPRESSION_LEVEL`
- Configure the compression level for data sent to the trace observer. + Configure the compression level for data sent to the trace observer. - May be one of: `:none`, `:low`, `:medium`, `:high`. + May be one of: `:none`, `:low`, `:medium`, `:high`. + + Set the level to `:none` to disable compression. - Set the level to `:none` to disable compression. + ## Instrumentation [#instrumentation] + + - + + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ACTIVE_SUPPORT_BROADCAST_LOGGER`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ACTIVE_SUPPORT_BROADCAST_LOGGER`
- Controls auto-instrumentation of `ActiveSupport::BroadcastLogger` at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`. Used in Rails versions >= 7.1. + Controls auto-instrumentation of `ActiveSupport::BroadcastLogger` at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`. Used in Rails versions >= 7.1. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ACTIVE_SUPPORT_LOGGER`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ACTIVE_SUPPORT_LOGGER`
- Controls auto-instrumentation of `ActiveSupport::Logger` at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`. Used in Rails versions below 7.1. + Controls auto-instrumentation of `ActiveSupport::Logger` at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`. Used in Rails versions below 7.1. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ASYNC_HTTP`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ASYNC_HTTP`
- Controls auto-instrumentation of Async::HTTP at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Async::HTTP at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_BUNNY`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_BUNNY`
- Controls auto-instrumentation of bunny at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of bunny at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`"auto"`
Environ variable`NEW_RELIC_INSTRUMENTATION_AWS_SQS`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_OPENSEARCH`
- Controls auto-instrumentation of the aws-sdk-sqs library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of the opensearch-ruby library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_DYNAMODB`
TypeString
Default`"auto"`
Environ variable`NEW_RELIC_INSTRUMENTATION_AWS_SQS`
- Controls auto-instrumentation of the aws-sdk-dynamodb library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of the aws-sdk-sqs library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_FIBER`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_DYNAMODB`
- Controls auto-instrumentation of the Fiber class at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of the aws-sdk-dynamodb library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_CONCURRENT_RUBY`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_FIBER`
- Controls auto-instrumentation of the concurrent-ruby library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of the Fiber class at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_CURB`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_CONCURRENT_RUBY`
- Controls auto-instrumentation of Curb at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of the concurrent-ruby library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_DELAYED_JOB`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_CURB`
- Controls auto-instrumentation of Delayed Job at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Curb at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ELASTICSEARCH`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_DELAYED_JOB`
- Controls auto-instrumentation of the elasticsearch library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Delayed Job at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ETHON`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ELASTICSEARCH`
- Controls auto-instrumentation of ethon at start up. May be one of `auto`, `prepend`, `chain`, `disabled` + Controls auto-instrumentation of the elasticsearch library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`enabled`
Environ variable`NEW_RELIC_INSTRUMENTATION_EXCON`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_ETHON`
- Controls auto-instrumentation of Excon at start-up. May be one of: `enabled`, `disabled`. + Controls auto-instrumentation of ethon at start up. May be one of `auto`, `prepend`, `chain`, `disabled` - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_GRAPE`
TypeString
Default`enabled`
Environ variable`NEW_RELIC_INSTRUMENTATION_EXCON`
- Controls auto-instrumentation of Grape at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Excon at start-up. May be one of: `enabled`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_GRPC_CLIENT`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_GRAPE`
- Controls auto-instrumentation of gRPC clients at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Grape at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_INSTRUMENTATION_GRPC_HOST_DENYLIST`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_GRPC_CLIENT`
- Specifies a list of hostname patterns separated by commas that will match gRPC hostnames that traffic is to be ignored by New Relic for. New Relic's gRPC client instrumentation will ignore traffic streamed to a host matching any of these patterns, and New Relic's gRPC server instrumentation will ignore traffic for a server running on a host whose hostname matches any of these patterns. By default, no traffic is ignored when gRPC instrumentation is itself enabled. For example, `"private.com$,exception.*"` + Controls auto-instrumentation of gRPC clients at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_GRPC_SERVER`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_INSTRUMENTATION_GRPC_HOST_DENYLIST`
- Controls auto-instrumentation of gRPC servers at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Specifies a list of hostname patterns separated by commas that will match gRPC hostnames that traffic is to be ignored by New Relic for. New Relic's gRPC client instrumentation will ignore traffic streamed to a host matching any of these patterns, and New Relic's gRPC server instrumentation will ignore traffic for a server running on a host whose hostname matches any of these patterns. By default, no traffic is ignored when gRPC instrumentation is itself enabled. For example, `"private.com$,exception.*"` - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_HTTPCLIENT`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_GRPC_SERVER`
- Controls auto-instrumentation of HTTPClient at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of gRPC servers at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_HTTPRB`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_HTTPCLIENT`
- Controls auto-instrumentation of http.rb gem at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of HTTPClient at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_HTTPX`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_HTTPRB`
- Controls auto-instrumentation of httpx at start up. May be one of `auto`, `prepend`, `chain`, `disabled` + Controls auto-instrumentation of http.rb gem at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_LOGGER`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_HTTPX`
- Controls auto-instrumentation of Ruby standard library Logger at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of httpx at start up. May be one of `auto`, `prepend`, `chain`, `disabled` - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_LOGSTASHER`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_LOGGER`
- Controls auto-instrumentation of the LogStasher library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Ruby standard library Logger at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_MEMCACHE`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_LOGSTASHER`
- Controls auto-instrumentation of dalli gem for Memcache at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of the LogStasher library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_MEMCACHED`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_MEMCACHE`
- Controls auto-instrumentation of memcached gem for Memcache at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of dalli gem for Memcache at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_MEMCACHE_CLIENT`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_MEMCACHED`
- Controls auto-instrumentation of memcache-client gem for Memcache at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of memcached gem for Memcache at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`enabled`
Environ variable`NEW_RELIC_INSTRUMENTATION_MONGO`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_MEMCACHE_CLIENT`
- Controls auto-instrumentation of Mongo at start-up. May be one of: `enabled`, `disabled`. + Controls auto-instrumentation of memcache-client gem for Memcache at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_NET_HTTP`
TypeString
Default`enabled`
Environ variable`NEW_RELIC_INSTRUMENTATION_MONGO`
- Controls auto-instrumentation of `Net::HTTP` at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Mongo at start-up. May be one of: `enabled`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RUBY_OPENAI`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_NET_HTTP`
- Controls auto-instrumentation of the ruby-openai gem at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. Defaults to `disabled` in high security mode. + Controls auto-instrumentation of `Net::HTTP` at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_PUMA_RACK`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RUBY_OPENAI`
- Controls auto-instrumentation of `Puma::Rack`. When enabled, the agent hooks into the `to_app` method in `Puma::Rack::Builder` to find gems to instrument during application startup. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of the ruby-openai gem at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. Defaults to `disabled` in high security mode. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_PUMA_RACK_URLMAP`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_PUMA_RACK`
- Controls auto-instrumentation of `Puma::Rack::URLMap` at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of `Puma::Rack`. When enabled, the agent hooks into the `to_app` method in `Puma::Rack::Builder` to find gems to instrument during application startup. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RACK`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_PUMA_RACK_URLMAP`
- Controls auto-instrumentation of Rack. When enabled, the agent hooks into the `to_app` method in `Rack::Builder` to find gems to instrument during application startup. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of `Puma::Rack::URLMap` at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RACK_URLMAP`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RACK`
- Controls auto-instrumentation of `Rack::URLMap` at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Rack. When enabled, the agent hooks into the `to_app` method in `Rack::Builder` to find gems to instrument during application startup. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RAKE`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RACK_URLMAP`
- Controls auto-instrumentation of rake at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of `Rack::URLMap` at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_REDIS`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RAKE`
- Controls auto-instrumentation of Redis at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of rake at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RESQUE`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_REDIS`
- Controls auto-instrumentation of resque at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Redis at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RODA`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RESQUE`
- Controls auto-instrumentation of Roda at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of resque at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_SINATRA`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_RODA`
- Controls auto-instrumentation of Sinatra at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Roda at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`"enabled"`
Environ variable`NEW_RELIC_INSTRUMENTATION_STRIPE`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_SINATRA`
- Controls auto-instrumentation of Stripe at startup. May be one of: `enabled`, `disabled`. + Controls auto-instrumentation of Sinatra at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_VIEW_COMPONENT`
TypeString
Default`"enabled"`
Environ variable`NEW_RELIC_INSTRUMENTATION_STRIPE`
- Controls auto-instrumentation of ViewComponent at startup. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Stripe at startup. May be one of: `enabled`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_THREAD`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_VIEW_COMPONENT`
- Controls auto-instrumentation of the Thread class at start-up to allow the agent to correctly nest spans inside of an asynchronous transaction. This does not enable the agent to automatically trace all threads created (see `instrumentation.thread.tracing`). May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of ViewComponent at startup. May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_INSTRUMENTATION_THREAD_TRACING`
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_THREAD`
- Controls auto-instrumentation of the Thread class at start-up to automatically add tracing to all Threads created in the application. + Controls auto-instrumentation of the Thread class at start-up to allow the agent to correctly nest spans inside of an asynchronous transaction. This does not enable the agent to automatically trace all threads created (see `instrumentation.thread.tracing`). May be one of: `auto`, `prepend`, `chain`, `disabled`. - + - - - - - - - - - - - + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_TILT`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_INSTRUMENTATION_THREAD_TRACING`
- Controls auto-instrumentation of the Tilt template rendering library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of the Thread class at start-up to automatically add tracing to all Threads created in the application. - + - - - + + + + +
TypeString
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_TILT`
- - Default`auto` - + Controls auto-instrumentation of the Tilt template rendering library at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + - - Environ variable`NEW_RELIC_INSTRUMENTATION_TYPHOEUS` - + + + + + +
TypeString
Default`auto`
Environ variable`NEW_RELIC_INSTRUMENTATION_TYPHOEUS`
- Controls auto-instrumentation of Typhoeus at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + Controls auto-instrumentation of Typhoeus at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`. + ## Message Tracer [#message-tracer] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_MESSAGE_TRACER_SEGMENT_PARAMETERS_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_MESSAGE_TRACER_SEGMENT_PARAMETERS_ENABLED`
- If `true`, the agent will collect metadata about messages and attach them as segment parameters. + If `true`, the agent will collect metadata about messages and attach them as segment parameters. + ## Mongo [#mongo] + + - + + - - - + + + + +
TypeBoolean
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_MONGO_CAPTURE_QUERIES`
- - Default`true` - + If `true`, the agent captures Mongo queries in transaction traces. + - - Environ variable`NEW_RELIC_MONGO_CAPTURE_QUERIES` - + + + + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_MONGO_OBFUSCATE_QUERIES`
- If `true`, the agent captures Mongo queries in transaction traces. + If `true`, the agent obfuscates Mongo queries in transaction traces. - + + +## Opensearch [#opensearch] + + + + + + - - - + + + + +
TypeBoolean
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_OPENSEARCH_CAPTURE_QUERIES`
- - Default`true` - + If `true`, the agent captures OpenSearch queries in transaction traces. + - - Environ variable`NEW_RELIC_MONGO_OBFUSCATE_QUERIES` - + + + + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_OPENSEARCH_OBFUSCATE_QUERIES`
- If `true`, the agent obfuscates Mongo queries in transaction traces. + If `true`, the agent obfuscates OpenSearch queries in transaction traces. + ## Process Host [#process-host] + + - + + - - - - - - - - - - - + + +
TypeString
Default`(Dynamic)`
Environ variable`NEW_RELIC_PROCESS_HOST_DISPLAY_NAME`
TypeString
Default`(Dynamic)`
Environ variable`NEW_RELIC_PROCESS_HOST_DISPLAY_NAME`
- Specify a custom host name for [display in the New Relic UI](/docs/apm/new-relic-apm/maintenance/add-rename-remove-hosts#display_name). + Specify a custom host name for [display in the New Relic UI](/docs/apm/new-relic-apm/maintenance/add-rename-remove-hosts#display_name). + ## Rake [#rake] + + - + + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_RAKE_TASKS`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_RAKE_TASKS`
- Specify an Array of Rake tasks to automatically instrument. This configuration option converts the Array to a RegEx list. If you'd like to allow all tasks by default, use `rake.tasks: [.+]`. No rake tasks will be instrumented unless they're added to this list. For more information, visit the [New Relic Rake Instrumentation docs](/docs/apm/agents/ruby-agent/background-jobs/rake-instrumentation). + Specify an Array of Rake tasks to automatically instrument. This configuration option converts the Array to a RegEx list. If you'd like to allow all tasks by default, use `rake.tasks: [.+]`. No rake tasks will be instrumented unless they're added to this list. For more information, visit the [New Relic Rake Instrumentation docs](/docs/apm/agents/ruby-agent/background-jobs/rake-instrumentation). - + - - - - - - - - - - - + + +
TypeInteger
Default`10`
Environ variable`NEW_RELIC_RAKE_CONNECT_TIMEOUT`
TypeInteger
Default`10`
Environ variable`NEW_RELIC_RAKE_CONNECT_TIMEOUT`
- Timeout for waiting on connect to complete before a rake task + Timeout for waiting on connect to complete before a rake task + ## Rules [#rules] + + - + + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_RULES_IGNORE_URL_REGEXES`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_RULES_IGNORE_URL_REGEXES`
- Define transactions you want the agent to ignore, by specifying a list of patterns matching the URI you want to ignore. For more detail, see [the docs on ignoring specific transactions](/docs/agents/ruby-agent/api-guides/ignoring-specific-transactions/#config-ignoring). + Define transactions you want the agent to ignore, by specifying a list of patterns matching the URI you want to ignore. For more detail, see [the docs on ignoring specific transactions](/docs/agents/ruby-agent/api-guides/ignoring-specific-transactions/#config-ignoring). + ## Security [#security] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SECURITY_AGENT_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SECURITY_AGENT_ENABLED`
- If `true`, the security agent is loaded (a Ruby 'require' is performed) + If `true`, the security agent is loaded (a Ruby 'require' is performed) - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SECURITY_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SECURITY_ENABLED`
- If `true`, the security agent is started (the agent runs in its event loop) + If `true`, the security agent is started (the agent runs in its event loop) - + - - - - - - - - - - - + + +
TypeString
Default`"IAST"`
Environ variable`NEW_RELIC_SECURITY_MODE`
TypeString
Default`"IAST"`
Environ variable`NEW_RELIC_SECURITY_MODE`
- Defines the mode for the security agent to operate in. Currently only `IAST` is supported + Defines the mode for the security agent to operate in. Currently only `IAST` is supported - + - - - - - - - - - - - + + +
TypeString
Default`"wss://csec.nr-data.net"`
Environ variable`NEW_RELIC_SECURITY_VALIDATOR_SERVICE_URL`
TypeString
Default`"wss://csec.nr-data.net"`
Environ variable`NEW_RELIC_SECURITY_VALIDATOR_SERVICE_URL`
- Defines the endpoint URL for posting security-related data + Defines the endpoint URL for posting security-related data - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SECURITY_DETECTION_RCI_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SECURITY_DETECTION_RCI_ENABLED`
- If `true`, enables RCI (remote code injection) detection + If `true`, enables RCI (remote code injection) detection - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SECURITY_DETECTION_RXSS_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SECURITY_DETECTION_RXSS_ENABLED`
- If `true`, enables RXSS (reflected cross-site scripting) detection + If `true`, enables RXSS (reflected cross-site scripting) detection - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SECURITY_DETECTION_DESERIALIZATION_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SECURITY_DETECTION_DESERIALIZATION_ENABLED`
- If `true`, enables deserialization detection + If `true`, enables deserialization detection - + - - - - - - - - - - - + + +
TypeInteger
Default`nil`
Environ variable`NEW_RELIC_SECURITY_APPLICATION_INFO_PORT`
TypeInteger
Default`nil`
Environ variable`NEW_RELIC_SECURITY_APPLICATION_INFO_PORT`
- The port the application is listening on. This setting is mandatory for Passenger servers. Other servers should be detected by default. + The port the application is listening on. This setting is mandatory for Passenger servers. Other servers should be detected by default. - + - - - - - - - - - - - + + +
TypeInteger
Default`300`
Environ variable`NEW_RELIC_SECURITY_REQUEST_BODY_LIMIT`
TypeInteger
Default`300`
Environ variable`NEW_RELIC_SECURITY_REQUEST_BODY_LIMIT`
- Defines the request body limit to process in security events (in KB). The default value is 300, for 300KB. + Defines the request body limit to process in security events (in KB). The default value is 300, for 300KB. + ## Serverless Mode [#serverless-mode] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SERVERLESS_MODE_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SERVERLESS_MODE_ENABLED`
- If `true`, the agent will operate in a streamlined mode suitable for use with short-lived serverless functions. NOTE: Only AWS Lambda functions are supported currently and this option is not intended for use without [New Relic's Ruby Lambda layer](https://docs.newrelic.com/docs/serverless-function-monitoring/aws-lambda-monitoring/get-started/monitoring-aws-lambda-serverless-monitoring/) offering. + If `true`, the agent will operate in a streamlined mode suitable for use with short-lived serverless functions. NOTE: Only AWS Lambda functions are supported currently and this option is not intended for use without [New Relic's Ruby Lambda layer](https://docs.newrelic.com/docs/serverless-function-monitoring/aws-lambda-monitoring/get-started/monitoring-aws-lambda-serverless-monitoring/) offering. + ## Sidekiq [#sidekiq] + + - + + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_SIDEKIQ_ARGS_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_SIDEKIQ_ARGS_INCLUDE`
- An array of strings that will collectively serve as an allowlist for filtering which Sidekiq job arguments get reported to New Relic. To capture any Sidekiq arguments, 'job.sidekiq.args.\*' must be added to the separate `:'attributes.include'` configuration option. Each string in this array will be turned into a regular expression via `Regexp.new` to permit advanced matching. For job argument hashes, if either a key or value matches the pair will be included. All matching job argument array elements and job argument scalars will be included. + An array of strings that will collectively serve as an allowlist for filtering which Sidekiq job arguments get reported to New Relic. To capture any Sidekiq arguments, 'job.sidekiq.args.*' must be added to the separate `:'attributes.include'` configuration option. Each string in this array will be turned into a regular expression via `Regexp.new` to permit advanced matching. For job argument hashes, if either a key or value matches the pair will be included. All matching job argument array elements and job argument scalars will be included. - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_SIDEKIQ_ARGS_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_SIDEKIQ_ARGS_EXCLUDE`
- An array of strings that will collectively serve as a denylist for filtering which Sidekiq job arguments get reported to New Relic. To capture any Sidekiq arguments, 'job.sidekiq.args.\*' must be added to the separate `:'attributes.include'` configuration option. Each string in this array will be turned into a regular expression via `Regexp.new` to permit advanced matching. For job argument hashes, if either a key or value matches the pair will be excluded. All matching job argument array elements and job argument scalars will be excluded. + An array of strings that will collectively serve as a denylist for filtering which Sidekiq job arguments get reported to New Relic. To capture any Sidekiq arguments, 'job.sidekiq.args.*' must be added to the separate `:'attributes.include'` configuration option. Each string in this array will be turned into a regular expression via `Regexp.new` to permit advanced matching. For job argument hashes, if either a key or value matches the pair will be excluded. All matching job argument array elements and job argument scalars will be excluded. + ## Slow SQL [#slow-sql] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SLOW_SQL_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SLOW_SQL_ENABLED`
- If `true`, the agent collects [slow SQL queries](/docs/apm/applications-menu/monitoring/viewing-slow-query-details). + If `true`, the agent collects [slow SQL queries](/docs/apm/applications-menu/monitoring/viewing-slow-query-details). - + - - - - - - - - - - - + + +
TypeFloat
Default`0.5`
Environ variable`NEW_RELIC_SLOW_SQL_EXPLAIN_THRESHOLD`
TypeFloat
Default`0.5`
Environ variable`NEW_RELIC_SLOW_SQL_EXPLAIN_THRESHOLD`
- Specify a threshold in seconds. The agent collects [slow SQL queries](/docs/apm/applications-menu/monitoring/viewing-slow-query-details) and explain plans that exceed this threshold. + Specify a threshold in seconds. The agent collects [slow SQL queries](/docs/apm/applications-menu/monitoring/viewing-slow-query-details) and explain plans that exceed this threshold. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SLOW_SQL_EXPLAIN_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SLOW_SQL_EXPLAIN_ENABLED`
- If `true`, the agent collects explain plans in slow SQL queries. If this setting is omitted, the [`transaction_tracer.explain_enabled`](#transaction_tracer-explain_enabled) setting will be applied as the default setting for explain plans in slow SQL as well. + If `true`, the agent collects explain plans in slow SQL queries. If this setting is omitted, the [`transaction_tracer.explain_enabled`](#transaction_tracer-explain_enabled) setting will be applied as the default setting for explain plans in slow SQL as well. - + - - - - - - - - - - - + + +
TypeString
Default`obfuscated`
Environ variable`NEW_RELIC_SLOW_SQL_RECORD_SQL`
TypeString
Default`obfuscated`
Environ variable`NEW_RELIC_SLOW_SQL_RECORD_SQL`
- Defines an obfuscation level for slow SQL queries. Valid options are `obfuscated`, `raw`, or `none`. + Defines an obfuscation level for slow SQL queries. Valid options are `obfuscated`, `raw`, or `none`. - + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SLOW_SQL_USE_LONGER_SQL_ID`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_SLOW_SQL_USE_LONGER_SQL_ID`
- Generate a longer `sql_id` for slow SQL traces. `sql_id` is used for aggregation of similar queries. + Generate a longer `sql_id` for slow SQL traces. `sql_id` is used for aggregation of similar queries. + ## Span Events [#span-events] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SPAN_EVENTS_ENABLED`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_SPAN_EVENTS_ENABLED`
- If `true`, enables span event sampling. + If `true`, enables span event sampling. - + - - - - - - - - - - - + + +
TypeInteger
Default`10000`
Environ variable`NEW_RELIC_SPAN_EVENTS_QUEUE_SIZE`
TypeInteger
Default`10000`
Environ variable`NEW_RELIC_SPAN_EVENTS_QUEUE_SIZE`
- Sets the maximum number of span events to buffer when streaming to the trace observer. + Sets the maximum number of span events to buffer when streaming to the trace observer. - + - - - - - - - - - - - + + +
TypeInteger
Default`2000`
Environ variable`NEW_RELIC_SPAN_EVENTS_MAX_SAMPLES_STORED`
TypeInteger
Default`2000`
Environ variable`NEW_RELIC_SPAN_EVENTS_MAX_SAMPLES_STORED`
- * Defines the maximum number of span events reported from a single harvest. Any Integer between `1` and `10000` is valid.' - * When configuring the agent for [AI monitoring](/docs/ai-monitoring/intro-to-ai-monitoring), set to max value `10000`.This ensures the agent captures the maximum amount of distributed traces. + * Defines the maximum number of span events reported from a single harvest. Any Integer between `1` and `10000` is valid.' + * When configuring the agent for [AI monitoring](/docs/ai-monitoring/intro-to-ai-monitoring), set to max value `10000`.This ensures the agent captures the maximum amount of distributed traces. + + ## Strip Exception Messages [#strip-exception-messages] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_STRIP_EXCEPTION_MESSAGES_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_STRIP_EXCEPTION_MESSAGES_ENABLED`
- If true, the agent strips messages from all exceptions except those in the [allowlist](#strip_exception_messages-allowlist). Enabled automatically in [high security mode](/docs/accounts-partnerships/accounts/security/high-security). + If true, the agent strips messages from all exceptions except those in the [allowlist](#strip_exception_messages-allowlist). Enabled automatically in [high security mode](/docs/accounts-partnerships/accounts/security/high-security). - + - - - - - - - - - - - + + +
TypeString
Default`""`
Environ variable`NEW_RELIC_STRIP_EXCEPTION_MESSAGES_ALLOWED_CLASSES`
TypeString
Default`""`
Environ variable`NEW_RELIC_STRIP_EXCEPTION_MESSAGES_ALLOWED_CLASSES`
- Specify a list of exceptions you do not want the agent to strip when [strip_exception_messages](#strip_exception_messages-enabled) is `true`. Separate exceptions with a comma. For example, `"ImportantException,PreserveMessageException"`. + Specify a list of exceptions you do not want the agent to strip when [strip_exception_messages](#strip_exception_messages-enabled) is `true`. Separate exceptions with a comma. For example, `"ImportantException,PreserveMessageException"`. + ## Stripe [#stripe] + + - + + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_STRIPE_USER_DATA_INCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_STRIPE_USER_DATA_INCLUDE`
- An array of strings to specify which keys inside a Stripe event's `user_data` hash should be reported - to New Relic. Each string in this array will be turned into a regular expression via `Regexp.new` to - permit advanced matching. Setting the value to `["."]` will report all `user_data`. + An array of strings to specify which keys inside a Stripe event's `user_data` hash should be reported +to New Relic. Each string in this array will be turned into a regular expression via `Regexp.new` to +permit advanced matching. Setting the value to `["."]` will report all `user_data`. + - + - - - - - - - - - - - + + +
TypeArray
Default`[]`
Environ variable`NEW_RELIC_STRIPE_USER_DATA_EXCLUDE`
TypeArray
Default`[]`
Environ variable`NEW_RELIC_STRIPE_USER_DATA_EXCLUDE`
- An array of strings to specify which keys and/or values inside a Stripe event's `user_data` hash should - not be reported to New Relic. Each string in this array will be turned into a regular expression via - `Regexp.new` to permit advanced matching. For each hash pair, if either the key or value is matched the - pair will not be reported. By default, no `user_data` is reported, so this option should only be used if - the `stripe.user_data.include` option is being used. + An array of strings to specify which keys and/or values inside a Stripe event's `user_data` hash should +not be reported to New Relic. Each string in this array will be turned into a regular expression via +`Regexp.new` to permit advanced matching. For each hash pair, if either the key or value is matched the +pair will not be reported. By default, no `user_data` is reported, so this option should only be used if +the `stripe.user_data.include` option is being used. + + ## Thread Profiler [#thread-profiler] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_THREAD_PROFILER_ENABLED`
TypeBoolean
Default`false`
Environ variable`NEW_RELIC_THREAD_PROFILER_ENABLED`
- If `true`, enables use of the [thread profiler](/docs/apm/applications-menu/events/thread-profiler-tool). + If `true`, enables use of the [thread profiler](/docs/apm/applications-menu/events/thread-profiler-tool). + ## Utilization [#utilization] + + - + + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_AWS`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_AWS`
- If `true`, the agent automatically detects that it is running in an AWS environment. + If `true`, the agent automatically detects that it is running in an AWS environment. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_AZURE`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_AZURE`
- If `true`, the agent automatically detects that it is running in an Azure environment. + If `true`, the agent automatically detects that it is running in an Azure environment. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_DOCKER`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_DOCKER`
- If `true`, the agent automatically detects that it is running in Docker. + If `true`, the agent automatically detects that it is running in Docker. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_GCP`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_GCP`
- If `true`, the agent automatically detects that it is running in an Google Cloud Platform environment. + If `true`, the agent automatically detects that it is running in an Google Cloud Platform environment. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_KUBERNETES`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_KUBERNETES`
- If `true`, the agent automatically detects that it is running in Kubernetes. + If `true`, the agent automatically detects that it is running in Kubernetes. - + - - - - - - - - - - - + + +
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_PCF`
TypeBoolean
Default`true`
Environ variable`NEW_RELIC_UTILIZATION_DETECT_PCF`
- If `true`, the agent automatically detects that it is running in a Pivotal Cloud Foundry environment. + If `true`, the agent automatically detects that it is running in a Pivotal Cloud Foundry environment. - + + \ No newline at end of file