APM agent security: Ruby

The New Relic Ruby agent default security settings automatically provide security for your APM data to ensure data privacy and to limit the kind of information New Relic receives. You may have business reasons to change these settings.

If you want to restrict the information that New Relic receives, you can enable high security mode. If high security mode or the default settings do not work for your business needs, you can apply custom settings.

For more information about New Relic's security measures, see our security and privacy documentation, or visit the New Relic security website.

Default security settings

By default, here is how the New Relic Ruby agent handles the following potentially sensitive data:

  • Request parameters: The agent does not capture HTTP request parameters.
  • HTTPS: The agent communicates with New Relic using HTTPS.
  • SQL: The agent sets SQL recording to obfuscated, which removes the potentially sensitive numeric and string literal values.

High security mode settings

When you enable high security mode, the default settings are locked so that users cannot change them. In addition, the agent does not collect message queue parameters.

Custom security settings

If you customize security settings, it may impact the security of your application.

If you need different security settings than default or high security mode, you can customize these settings:

Setting Effects on data security

audit_log.enabled

boolean

Default: false

By default, the agent does not log all data sent to New Relic in the agent log file.

If you set this to true:

  • The agent logs data sent to the New Relic collector in the agent log file. You can then evaluate the information that the agent sends by reviewing the agent log file to see if it includes sensitive information.
  • All endpoints are included in the agent log file. You can specify that only certain endpoints should be included in the audit log by using audit_log.endpoints.

high_security

boolean

Default: false

To enable high security mode, set this to true and enable high security in New Relic. This restricts the information you can send to New Relic.

proxy_host

string

Default: (none)

Some proxies default to using HTTP, which is a less secure protocol.

attributes.enabled

boolean

Default: true

By default, you are sending attributes to New Relic. If you do not want to send attributes to New Relic, set this to false.

attributes.exclude

array

Default: []

If there are specific attribute keys that you do not want to send to New Relic in transaction traces, identify them using attributes.exclude. This restricts the information sent to New Relic.

Consider if you want to exclude these potentially sensitive attributes using attributes.exclude or if you need this information sent to New Relic:

  • request.headers.*: Removes all request headers.

    (Note that HTTP headers that contain sensitive data such as cookie and authorization are never collected.)

  • response.headers.*: Removes all response headers.

transaction_tracer.record_sql

string

Default: obfuscated

By default, transaction_tracer.record_sql 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, this is automatically set to obfuscated.

strip_exception_messages.enabled

boolean

Default: the value of the high_security configuration option

By default, this is set to false, which means that the agent sends messages from all exceptions to the New Relic collector. If you enable high security mode, this is automatically changed to true, and the agent strips the messages from exceptions.

If you are not using high security mode but still want to strip messages from all exceptions except those in the whitelist, set this to true.

custom_insights_events.enabled

boolean

Default: true

By default, the agent records events sent to the Insights custom events API using record_custom_event(). If you do not want to create custom events, set this to false.

For more help

Recommendations for learning more: