Syntax
newrelic_accept_distributed_trace_payload (string $payload)Accepts a distributed trace payload.
Requirements
Requires PHP agent version 8.4 or higher.
Description
Distributed tracing allows you to see the path that a request takes as it travels through a distributed system.
Important
With PHP agent version 9.10 or higher, the following JSON functions are now considered deprecated and will be removed in a future release:
newrelic_create_distributed_trace_payload()newrelic_accept_distributed_trace_payload($payload)newrelic_accept_distributed_trace_payload_httpsafe($payload)Instead, use the API that is compatible with W3C Trace Context support, added in agent version 9.8. With this, the API for manually instrumenting applications has changed from the JSON payload related functions to the following header array forms:
newrelic_insert_distributed_trace_headers($outbound_headers)newrelic_accept_distributed_trace_headers($inbound_headers)Parameters
Parameter | Description |
|---|---|
data type | Required: a JSON formatted string created by using |
Examples
For examples of how and when to use this API method, see the documentation to manually instrument applications and services.
For more help
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's and and documentation.