Skip to content

Commit

Permalink
Update syntax to avoid compile errors
Browse files Browse the repository at this point in the history
  • Loading branch information
kaylareopelle committed Sep 23, 2021
1 parent 8304886 commit 833b0d5
Showing 1 changed file with 26 additions and 10 deletions.
Expand Up @@ -99,7 +99,7 @@ These settings are available for agent configuration. Some settings depend on yo
</tbody>
</table>

Your New Relic [license key](/docs/accounts-partnerships/accounts/account-setup/license-key).
Your New Relic [license key](/docs/apis/intro-apis/new-relic-api-keys/#ingest-license-key).
</Collapser>

<Collapser id="agent_enabled" title="agent_enabled">
Expand Down Expand Up @@ -231,10 +231,10 @@ These settings are available for agent configuration. Some settings depend on yo
</tbody>
</table>

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)
<div class="callout-warning">
When using the `capture_params` setting, the Ruby agent will not attempt to filter secret information. <b>Recommendation:</b> 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 <a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">Ruby attribute examples</a>.
</div>
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).
<Callout variant="caution">
When using the `capture_params` setting, the Ruby agent will not attempt to filter secret information. <b>Recommendation:</b> 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 <a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">Ruby attribute examples</a>.
</Callout>
</Collapser>

<Collapser id="config_path" title="config_path">
Expand Down Expand Up @@ -621,6 +621,7 @@ The [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces)
The agent collects and reports all uncaught exceptions by default. These configuration options allow you to customize the error collection.

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/).

<CollapserGroup>

<Collapser id="error_collector-enabled" title="error_collector.enabled">
Expand Down Expand Up @@ -656,11 +657,11 @@ For information on ignored and expected errors, [see this page on Error Analytic
</tbody>
</table>

<b>DEPRECATED</b> Use `error_collector.ignore_classes` instead. Specify a comma-delimited list of error classes that the agent should ignore.
<b>DEPRECATED</b> Use `error_collector.ignore_classes` instead. Specify a comma-delimited list of error classes that the agent should ignore.

<Callout variant="caution">
Server side configuration takes precedence for this setting over all environment configurations. This differs from all other configuration settings where environment variable take precedence over server side configuration.
</Callout>
<Callout variant="caution">
Server side configuration takes precedence for this setting over all environment configurations. This differs from all other configuration settings where environment variable take precedence over server side configuration.
</Callout>
</Collapser>

<Collapser id="error_collector-ignore_classes" title="error_collector.ignore_classes">
Expand Down Expand Up @@ -1222,7 +1223,7 @@ The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-l

<b>DEPRECATED</b> Please see: [distributed_tracing-enabled](docs/agents/ruby-agent/configuration/ruby-agent-configuration#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`.
</Collapser>

</CollapserGroup>
Expand Down Expand Up @@ -1375,6 +1376,21 @@ If `true` , disables [Sinatra instrumentation](/docs/agents/ruby-agent/framework
</table>

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).

<Callout variant="important">
Cross application tracing is deprecated in favor of [distributed tracing](https://docs.newrelic.com/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.

To continue using cross application tracing, update the following options in your `newrelic.yml` configuration file:

```
# newrelic.yml
cross_application_tracer:
enabled: true
distributed_tracing:
enabled: false
```
</Callout>
</Collapser>

<Collapser id="disable_view_instrumentation" title="disable_view_instrumentation">
Expand Down

0 comments on commit 833b0d5

Please sign in to comment.