Skip to content

Commit

Permalink
Merge pull request newrelic#19841 from newrelic/ruby-config-updates
Browse files Browse the repository at this point in the history
Update Ruby configuration docs
  • Loading branch information
sujitnewrelic authored Jan 30, 2025
2 parents 3ab6ede + c366911 commit 3b710ae
Showing 1 changed file with 34 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ The [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces)
</tbody>
</table>

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) isn't set separately.
</Collapser>

<Collapser id="transaction_tracer-explain_threshold" title="transaction_tracer.explain_threshold">
Expand Down Expand Up @@ -925,7 +925,7 @@ Available logging-related config options include:

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
This is based on the integer values of [Ruby's `Logger::Severity` constants](https://github.com/ruby/logger/blob/113b82a06b3076b93a71cd467e1605b23afb3088/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.

Expand Down Expand Up @@ -2033,6 +2033,18 @@ Use these settings to toggle instrumentation types during agent startup.
Controls auto-instrumentation of bunny at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`.
</Collapser>

<Collapser id="instrumentation-aws_sdk_firehose" title="instrumentation.aws_sdk_firehose">
<table>
<tbody>
<tr><th>Type</th><td>String</td></tr>
<tr><th>Default</th><td>`auto`</td></tr>
<tr><th>Environ variable</th><td>`NEW_RELIC_INSTRUMENTATION_AWS_SDK_FIREHOSE`</td></tr>
</tbody>
</table>

Controls auto-instrumentation of the aws-sdk-firehose library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`.
</Collapser>

<Collapser id="instrumentation-aws_sdk_lambda" title="instrumentation.aws_sdk_lambda">
<table>
<tbody>
Expand All @@ -2045,6 +2057,18 @@ Use these settings to toggle instrumentation types during agent startup.
Controls auto-instrumentation of the aws_sdk_lambda library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`.
</Collapser>

<Collapser id="instrumentation-aws_sdk_kinesis" title="instrumentation.aws_sdk_kinesis">
<table>
<tbody>
<tr><th>Type</th><td>String</td></tr>
<tr><th>Default</th><td>`auto`</td></tr>
<tr><th>Environ variable</th><td>`NEW_RELIC_INSTRUMENTATION_AWS_SDK_KINESIS`</td></tr>
</tbody>
</table>

Controls auto-instrumentation of the aws-sdk-kinesis library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`.
</Collapser>

<Collapser id="instrumentation-ruby_kafka" title="instrumentation.ruby_kafka">
<table>
<tbody>
Expand Down Expand Up @@ -2722,7 +2746,7 @@ Use these settings to toggle instrumentation types during agent startup.
</tbody>
</table>

If `true`, the security agent is loaded (the agent performs a Ruby 'require')
If `true`, the security agent is loaded (a Ruby 'require' is performed)
</Collapser>

<Collapser id="security-enabled" title="security.enabled">
Expand Down Expand Up @@ -2962,7 +2986,7 @@ Use these settings to toggle instrumentation types during agent startup.
</tbody>
</table>

Specifies the length of time (in minutes) that the IAST scan will run.
Indicates the duration (in minutes) for which the IAST scan will be performed.
</Collapser>

<Collapser id="security-scan_schedule-schedule" title="security.scan_schedule.schedule">
Expand All @@ -2986,7 +3010,7 @@ Use these settings to toggle instrumentation types during agent startup.
</tbody>
</table>

If `true`, allows IAST to continuously gather trace data in the background. Collected data will be used by the security agent to perform an IAST scan at the scheduled time.
If `true`, allows IAST to continuously gather trace data in the background. The security agent uses collected data to perform an IAST scan at the scheduled time.
</Collapser>

<Collapser id="security-scan_controllers-iast_scan_request_rate_limit" title="security.scan_controllers.iast_scan_request_rate_limit">
Expand Down Expand Up @@ -3054,7 +3078,7 @@ Use these settings to toggle instrumentation types during agent startup.
</tbody>
</table>

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 isn't 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.
</Collapser>

</CollapserGroup>
Expand Down Expand Up @@ -3220,7 +3244,7 @@ Use these settings to toggle instrumentation types during agent startup.
</tbody>
</table>

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 [allowed classes list](#strip_exception_messages-allowed_classes). Enabled automatically in [high security mode](/docs/accounts-partnerships/accounts/security/high-security).
</Collapser>

<Collapser id="strip_exception_messages-allowed_classes" title="strip_exception_messages.allowed_classes">
Expand Down Expand Up @@ -3254,7 +3278,7 @@ Use these settings to toggle instrumentation types during agent startup.

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`.
enable advanced matching. Setting the value to `["."]` will report all `user_data`.

</Collapser>

Expand All @@ -3269,7 +3293,8 @@ permit advanced matching. Setting the value to `["."]` will report all `user_dat

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 is not reported. By default, no `user_data` is reported. Use this option only if the
`Regexp.new` to permit advanced matching. For each hash pair, if either the key or value is matched the pair
isn't reported. By default, no `user_data` is reported. Use this option only if the
`stripe.user_data.include` option is also used.

</Collapser>
Expand Down

0 comments on commit 3b710ae

Please sign in to comment.