Information about Trace API data requirements, including:
- Data specifications and max limits
- Required metadata (headers, query parameters)
- Response validation details
This document applies to the Trace API overall. For rules regarding specific data formats, see:
Endpoints
All trace data is sent via HTTPS POST to a Trace API endpoint. We have a few endpoints, depending on your setup:
- Default Trace API endpoint:
https://trace-api.newrelic.com/trace/v1 - EU data centers:
https://trace-api.eu.newrelic.com/trace/v1(see other EU endpoints). - Infinite Tracing: When you complete the Trace observer setup, you get a custom YOUR_TRACE_OBSERVER_URL value to use as an endpoint. If you're using an integration that uses the Trace API (for example, the Kamon reporter), you must configure that integration with that endpoint. You will also want to adjust the sampling of your tracing service to send us 100% of spans.
- FedRAMP: See FedRAMP endpoints.
Data formats
Currently, the Trace API accepts two types of data formats:
zipkin: For reporting Zipkin trace data. Zipkin data must be Zipkin JSON v2.newrelic: For reporting all other trace data.
Restricted attributes
The attributes in the table below are restricted in the newrelic-format JSON (in the attributes block) and in the zipkin-format JSON (in the tags block). Any values with these keys will be omitted:
Restricted attribute | Description |
|---|---|
string | Unique identifier for the entity that created this span. Generated from |
string | Used for backwards compatibility with data from agents. |
The attributes in the table below are used internally to identify entities. Any values submitted with these keys in the attributes section of a metric data point may cause undefined behavior such as missing entities in the UI or telemetry not associating with the expected entities. For more information please refer to Entity synthesis:
Restricted attribute | description |
|---|---|
string | Unique identifier for the entity associated with this span. |
string | Human-readable name of an entity, often used to identify an entity in the UI. |
string | Used to differentiate between different types of entities, like hosts, applications, etc. |
Request metadata (headers and query parameters)
The following table shows the required request metadata for all trace data formats. This metadata can be sent as HTTP headers on an ingest request or, in some cases, provided as query parameters, which may be required for tracing frameworks that don't allow header modification.
Important
Security note: We suggest using headers because query parameters are present in the URL and may be logged before being encrypted and received by New Relic. All data sent as query parameters must be URL-safe.
Header | Query param? | Details |
|---|---|---|
| No | Required. Must be |
| No | Required. The length of the request body in octets (8-bit bytes) unless sent with chunked encoding. This header is generally set by default by the underlying HTTP client sending the data and in most cases should not require any additional effort by the end user. |
| Yes (case-sensitive) | Required. The Trace API requires a . If this is provided as both a header and a query parameter, the values must match. |
| No | Required if compressed payload. The value must be |
| Yes | Required for If present, |
| Yes | Required for If present, There are only two possible pairings for these values:
|
| No | Optional - Reserved for future use. The value must be a valid |
Response validation
A response for successfully sending trace data will include a requestId. For example:
{ "requestId": "c1bb62fc-001a-b000-0000-016bb152e1bb" }There are two ways success/errors are signaled:
HTTP status code (synchronous). Authentication and request errors will be signaled via HTTP status code.
NrIntegrationErrorevents (asynchronous). Errors with the JSON payload or other semantic errors are asynchronously signaled viaNrIntegrationErrorevents that are stored in the account whose is associated with the request. For all errors of this type, the attributenewRelicFeaturewill beDistributed TracingandrequestIdwill be therequestIdfrom the endpoint response.
If you receive a 202 response and don't see an NrIntegrationError event, your data should be visible in our global distributed tracing UI in about a minute. You should be able to find the trace using a standard trace search like:
traceId = TRACE_ID_SENTData limits
For trace-related limits, see How distributed tracing works.