Syntax
newrelic_accept_distributed_trace_payload_httpsafe(string $httpsafe_payload, string $transport_type)Accepts a distributed trace payload that includes an HTTPSafe (Base64 encoded) JSON string.
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. This is useful, for example, when individual transactions occur in multiple services, and you want to examine them as a complete transaction trace.
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 |
|---|---|
string | Required. An HTTPSafe (Base64 encoded) JSON string representation of the payload. |
string | Optional. A string overriding the default transport type. Default values:
|
Return values
Returns true to indicate success, or false if an error occurs.
Examples
For examples of how and when to use this API method, see the documentation to manually instrument applications and services.