If you are new to New Relic distributed tracing, we recommend you read the following before you enable distributed tracing.
Impact to New Relic APM features
Our distributed tracing improves on New Relic APM's previous cross application tracing feature. Here are some key benefits:
- See more cross-service activity details and more complete end-to-end traces.
- Filter and query traces, as well as make custom charts.
- See the complete trace even when calls cross account boundaries (for accounts with the same master account or in the same customer partnership).
- See Introduction to distributed tracing for other features.
Enabling distributed tracing may affect some New Relic APM features you currently use. These changes affect only applications monitored by New Relic agents that have distributed tracing enabled—they don't apply on an account-level.
New Relic may provide backward compatibility with some or all of the affected features in future releases. For now, you should understand the following changes before enabling distributed tracing:
- External services page has less detail
When distributed tracing is enabled for an application, external calls on the External services page will not have internal transaction details (see screenshot below). To find that information, you would instead go to the Distributed tracing UI page, find the external call URLs, and see what their child spans are.
- Transaction trace UI displays service URLs, not transaction links
When distributed tracing is enabled for an application, the transaction trace UI will no longer have the transaction name and link for the called service (see screenshot below). This will be replaced with the called service's URL.
If you wanted to get more detail about trace activity, you would go to the Distributed tracing UI page and examine that trace.
- Cross-application tracing will be disabled
Enabling distributed tracing will disable the cross application tracing feature. Distributed tracing is an improved version of cross-application tracing and only one can be enabled at a time.
- Impacts related to New Relic Mobile
New Relic’s distributed tracing is not yet available for New Relic Mobile. APM-related impacts include:
Plan your rollout
If you're enabling distributed tracing for a large, distributed system, here are some tips:
- If you are a current New Relic APM user, see Impact to New Relic APM features.
- Determine the requests that are the most important for your business, or the most likely to require analysis and troubleshooting, and enable distributed tracing for those services. Enable tracing for services at roughly the same time so you can more easily gauge how complete your end-to-end traces are.
- When you look at traces in the distributed tracing UI, you'll see spans in the trace for external calls to other services. Then, you can enable distributed tracing for any of those services you want. If a service is fairly standalone and not often used in context with other services, you may not want to enable distributed tracing for it.
Here's a visual representation of such a phased roll-out:
- If you are using APM for a large, monolithic service, there may be many sub-process spans per trace and APM limits may result in fewer traces than expected. You can solve this by using APM agent instrumentation to disable the reporting of unimportant data.
- New Relic's distributed tracing works by propagating header information from service to service in a request path. Some services may communicate through a proxy or other intermediary service that does not automatically propagate the header. In that case, you will need to configure that proxy so that it allows the
newrelicheader value to be propagated from source to destination.
Enable distributed tracing
If you are aware of the impact to New Relic APM features and have thought about your rollout, you are ready to set up distributed tracing. See Overview: Enable distributed tracing.