Node.js agent other settings

The AWS account ID for the AWS account associated with this app.

When enabled, the agent logs the payloads it sends to the collector. This data is included in the main log file even when logging level is set to the lowest level.

The agent sends several different types of data to the collector in separate payloads. By default, all of them are included in the log file. This option makes it possible to limit logging only to specific types of data.

Valid values include:

• agent_settings
• analytic_event_data
• connect
• custom_event_data
• error_data
• error_event_data
• metric_data
• preconnect
• shutdown
• span_event_data
• sql_trace_data
• transaction_sample_data

This option enables newrelic.addCustomAttribute and newrelic.addCustomAttributes.

This option enables recordCustomEvent.

This option enables newrelic.noticeError.

A comma-delimited list of rules to match incoming request URLs and name the associated New Relic transaction. Uses the format:

name: [
  { pattern: 'STRING_OR_REGEX', name: 'NAME' },
  { pattern: 'STRING_OR_REGEX', name: 'NAME' }
]

Both parameters are required. For strings, you must escape control characters. You do not need to escape control characters in regular expressions. Additional attributes are ignored.

Regular expressions support JavaScript-style capture groups, and names use $1-style replacement strings. Regular expressions only find the first matching result; subsequent matches are ignored. For more information, see Node.js transaction naming API.

For the NEW_RELIC_NAMING_RULES environment variable, pass the rules as comma-delimited JSON object literals:

NEW_RELIC_NAMING_RULES='{"pattern":"^t","name":"u"},{"pattern":"^u","name":"t"}'

Define a list of request URLs you want the agent to ignore. Specify the list as patterns, which can be strings or regular expressions. The default value is a regular expression to match socket.io long-polling requests

When enabled, the agent renames transactions that are not affected by other naming logic (such as the API, rules, or metric normalization rules) to NormalizedUri/*. If you set this to false, the agent sets transaction names to Uri/path/to/resource.

When enabled, the agent sends transaction events to New Relic. This event data includes transaction timing, transaction name, and any custom attributes. If this is disabled, the agent does not collect this data or send it to New Relic.

Defines the maximum number of events the agent collects per minute. If there are more than this number, the agent collects a statistical sampling.

We don't recommend configuring past 10,000. The server will cap data at 10,000 per-minute.

Defines the maximum number of events the agent stores if it is unable to communicate with the New Relic collector. The values from the previous harvest cycle will be merged into the next one, with this option limiting the maximum number. Make sure this number is greater than max_samples_per_minute; for example, set it to twice as much. Consider your memory overhead before increasing this value.

Defines the maximum number of events the agent collects per minute. If there are more than this number, the agent collects a statistical sampling.

If true, the agent captures attributes from transaction events.

Prefix of attributes to exclude from transaction events. Allows * as wildcard at end.

Prefix of attributes to include in transaction events. Allows * as wildcard at end.

When enabled, the agent sends custom events recorded with recordCustomEvent() to New Relic. If this is disabled, the agent does not collect this data or send it to New Relic.

• Defines the maximum number of custom events the agent collects per minute. If the number of custom events exceeds this limit, the agent collects a statistical sampling.

• When configuring the agent for AI monitoring, set to max value 100000. Ensures that the maximum amount of LLM events are captured.

  Importante

  Increasing this limit may increase memory usage.

Specify a custom hostname for display in New Relic. If you do not set this field, New Relic will continue to use the default hostname found by calling os.hostname().

• If you use the default hostname settings, New Relic finds the hostname through os.hostname().
• If this call fails, New Relic uses the host's IP as the name.
• If you set ipv_preference: 4 or ipv_preference: 6, you can select the type of IP address (IPv4 or IPv6) that appears in the New Relic UI.

When true, the agent will redact the messages of captured errors.

Toggles whether to capture additional attributes on middleware spans for all Node.js web frameworks that help drive Code level metrics. The additional attributes are: code.filepath, code.function, code.lineno, and code.column.

Enables regex based node agent url obfuscation.

Specifies the regex pattern to use for url obfuscation. If this is not set, no url obfuscation will be performed.

Specifies the regex flags to use for url obfuscation pattern matching e.g. g for global matching, i for case insensitive matching, etc. Multiple flags can be specified as a string e.g. gi. If this is not set, no flags will be used.

Specifies the replacement string to use for url obfuscation. Can contain refferences to capture groups in the pattern e.g. $1. If this is not set, everything will be replaced with a single empty string.

Toggles whether the New Relic Security agent data is sent to New Relic or not. When this is disabled and security.agent.enabled is true, the security agent be registered but data will not be sent.

Toggles whether the New Relic Security agent is loaded. This property is read only once at application start.

New Relic Security provided mode: IAST. Default is IAST. Due to the invasive nature of IAST scanning, DO NOT enable this mode in either a production environment or an environment where production data is processed.

New Relic Security connection URL. This is the endpoint that the security agent sends data to, it should match that environment that you have set for the Node.js agent.

Enable RCI security event detection.

Enable RXSS security event detection.

Enable deserialization security event detection.

If true, the agent uses Heroku dyno names as the hostname.

If true, the agent will load when in a worker thread if specified.

Whether the agent attempts to reach out to AWS to get info about the VM the process is running on.

Whether the agent attempts to detect if the process is running on Pivotal Cloud Foundry.

Whether the agent attempts to reach out to Azure to get info about the VM the process is running on.

Whether the agent attempts to read environment variables and invocation context to get info about the Azure Function it's running in.

Whether the agent attempts to read files to get info about the container the process is running in.

Whether the agent attempts to reach out to GCP to get info about the VM the process is running on.

Whether the agent attempts to reach out to Kubernetes to get info about the container the process is running on.

Overrides the number of logical processors the agent reports for the host.

Overrides the hostname the agent reports for billing/utilization purposes.

Overrides the amount of total RAM (in MiB) the agent reports for the host.

When enabled, it will use the GCP metadata id to set the hostname of the running application (Services, Worker Pools, and Jobs).

If true, the agent prepends the Cloud Run revision name to the GCP instance id to form the hostname ({revision}-{instance id}) on Google Cloud Run. The revision name comes from K_REVISION on a Cloud Run Service, CLOUD_RUN_REVISION on a Cloud Run Worker Pool, and CLOUD_RUN_EXECUTION on a Cloud Run Job. Has no effect unless utilization.gcp_cloud_run.use_instance_as_host is also true.

When enabled, it will use the GCP metadata id to set the hostname of the running application (Services, Worker Pools, and Jobs).

Global switch for the whole OpenTelemetry feature. If set to false, no other OpenTelemetry sub-feature (such as traces, logs, or metrics) will be enabled, regardless of that sub-feature's own setting.

Enables bridging OpenTelemetry instrumentations (for example, @fastify/otel) into the New Relic agent.

When true, the agent automatically configures the OpenTelemetry logs API to send logs emitted through the OTel-specific API to New Relic.

When true, the agent automatically configures the OpenTelemetry metrics API to send metrics to New Relic, attached to the application entity instrumented by the agent.

The number of milliseconds between each attempt to ship OpenTelemetry metrics to New Relic. Must be greater than or equal to opentelemetry.metrics.export_timeout.

The number of milliseconds an OpenTelemetry metrics export operation is allowed before it must successfully complete. If the timeout is exceeded, it's reported via the OpenTelemetry diagnostics API.

Enables capture of timing for fields resolved with the GraphQLScalarType return type. This may be desired when performing time-intensive calculations to return a scalar value. Not recommended for queries that return a large number of pre-calculated scalar fields.

Enables capture of timings for an IntrospectionQuery.

Enables capture of timings for a service definition query received from an Apollo Federated Gateway Server.

Enables capture of timings for a health check query received from an Apollo Federated Gateway Server.

Enables capture of metrics for every field and resolver argument seen for an Apollo query. Intended for identifying unused fields in your GraphQL schema.

Path to the directory containing newrelic.js. This is available only as an environment variable. You cannot set it in your config file.

Used to set a different config file name than the default newrelic.js. This is available only as an environment variable. You cannot set it in your config file.

If used, this prevents the agent from reading configuration settings from newrelic.js. Default values and values from environment variables will still be set.

This is available only as an environment variable. You cannot set it in your config file.

Array types are defined as comma-delimited strings.

NEW_RELIC_ERROR_COLLECTOR_IGNORE_ERROR_CODES=404,500,429

Object types are defined as a json string.

NEW_RELIC_ERROR_COLLECTOR_EXPECTED_MESSAGES='{"Error":["Undefined", "No soup for you!"]}'