From 833b0d503d517c07fa38dc674112e93d911a074d Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Thu, 23 Sep 2021 14:53:34 -0700 Subject: [PATCH] Update syntax to avoid compile errors --- .../ruby-agent-configuration.mdx | 36 +++++++++++++------ 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/src/content/docs/agents/ruby-agent/configuration/ruby-agent-configuration.mdx b/src/content/docs/agents/ruby-agent/configuration/ruby-agent-configuration.mdx index 784d368bcb3..29d6e9fc287 100644 --- a/src/content/docs/agents/ruby-agent/configuration/ruby-agent-configuration.mdx +++ b/src/content/docs/agents/ruby-agent/configuration/ruby-agent-configuration.mdx @@ -99,7 +99,7 @@ These settings are available for agent configuration. Some settings depend on yo - 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). @@ -231,10 +231,10 @@ These settings are available for agent configuration. Some settings depend on yo - 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. -
+ 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. + @@ -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/). + @@ -656,11 +657,11 @@ For information on ignored and expected errors, [see this page on Error Analytic - DEPRECATED Use `error_collector.ignore_classes` instead. Specify a comma-delimited list of error classes that the agent should ignore. + DEPRECATED Use `error_collector.ignore_classes` instead. Specify a comma-delimited list of error classes that the agent should ignore. - - 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. - + + 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. + @@ -1222,7 +1223,7 @@ The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-l DEPRECATED 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`. @@ -1375,6 +1376,21 @@ If `true` , disables [Sinatra instrumentation](/docs/agents/ruby-agent/framework 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](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 + ``` +