Distributed tracing allows you to see the entire journey of your requests throughout a distributed system. For the Node.js agent, we offer two types of distributed tracing (for more details, see How span sampling works):
Standard (head-based sampling): Before any traces arrive, we determine a set percentage of traces to accept and analyze. This gives you a solid starting point to see how tracing can help you. It is turned on by default in Node.js agents 8.3.0 and higher.
Infinite Tracing (tail-based sampling): Our cloud-based service accepts all your traces and then sorts through them to find the most important. After you set up standard tracing, we recommend you add this option because it analyzes all of your traces and gives you configuration options to sample the traces that matter most to you.
All the steps you need to get started with distributed tracing are right here:
- New Node.js agents: Steps for head- and tail-based sampling for new agent installations
- Older Node.js agents: Tracing options if you have older Node.js agents
- Manual instrumentation: Tips if automatic instrumentation doesn't work
New Node.js agents
Whether you just want to try out standard distributed tracing (head-based sampling) or also want to set up Infinite Tracing (tail-based sampling), you need to start by setting up standard tracing. We'll get you through the APM agent installation to get head-based sampling going. After that, you can set up Infinite Tracing, which is optional but recommended.
Install an agent to get standard distributed tracing
This is the best approach to set up standard distributed tracing if you haven't installed any APM agents for your services yet, or if you want to instrument additional services.
If you already have some services instrumented with this APM agent, and you want to include them in distributed tracing, you'll need to manually enable distributed tracing for each service. See Options for older Node.js agents.
You'll need a New Relic account to set up distributed tracing. If you don't already have one, you can quickly create a free account.
Step 1. Identify services
Figure out which services you want to instrument so they each send trace data to New Relic.
Step 2. Instrument each service with an APM agent
You'll repeat the agent installation routine for each service involved in your transactions. If some of your services use other languages, simply repeat the installation steps for those languages.
To start the installation routine, click the tile below. When you are finished installing each agent, return here to see tips for viewing your traces.
Step 3. View traces
After you instrument each of your services with APM agents, generate some traffic in your application so we can capture some traces. Here are two ways to view your traces in the UI:
For more help finding your traces in the UI:
Set up Infinite Tracing (recommended)
Standard distributed tracing for APM agents (above) captures up to 10% of your traces, but if you want us to analyze all your data and find the most relevant traces, you can set up Infinite Tracing.
To learn more about this feature, see Infinite Tracing.
Before beginning, first ensure you meet the requirements.
Step 1. Complete the new agent installation
The Infinite Tracing setup builds on the instrumentation step from the new agent installation for standard distributed tracing. After you finish installing the agents, continue with the trace observer setup.
Step 2. Set up the trace observer
The trace observer is a New Relic AWS-based service that collects and analyzes all your traces. Follow the instructions in Set up trace observer. When you're done, return here with your trace observer information and continue with the next step to configure the agent.
Step 3: Configure the agent for Infinite Tracing
Infinite Tracing configuration settings include the standard distributed tracing plus information about the trace observer. Find the settings for your language agent below:
Step 4. (Optional) Customize Infinite Tracing
After you add the agent configuration settings, you should start seeing data in the New Relic UI. After you spend some time analyzing your data, you may want to adjust some of the features of Infinite Tracing:
- Configure trace observer monitoring
- Configure span attribute trace filter
- Configure random trace filter
Options for older Node.js agents
If you have older Node.js agents, confirm the distributed tracing features you want are supported before enabling it.
Find your language agents below to confirm if you can use your existing agents with distributed tracing:
Configure your older Node.js agents
See the settings below to enable distributed tracing.
If you've been using an older agent without distributed tracing, before turning on distributed tracing, check out Impacts to APM.
If you need help with proxy configuration, see Proxy support.
Manual instrumentation (If automatic instrumentation doesn't work)
Recommendation: Before performing any custom instrumentation, read:
If a service is not passing the trace header to other services, you can use the distributed tracing payload APIs to instrument the calling service and the called service. The calling service uses an API call to generate a payload, which is accepted by the called service.