newrelic_create_distributed_trace_payload (PHP agent API)

Syntax

newrelic_create_distributed_trace_payload()

Creates 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.

newrelic_create_distributed_trace_payload()newrelic_accept_distributed_trace_payload($payload)newrelic_accept_distributed_trace_payload_httpsafe($payload)

newrelic_insert_distributed_trace_headers($outbound_headers)newrelic_accept_distributed_trace_headers($inbound_headers)

Return values

This method returns an object of type newrelic\DistributedTracePayload.This object has two methods that will render a distributed trace payload as text.

$payload = newrelic_create_distributed_trace_payload();// renders the payload as a JSON string$jsonText = $payload->text();// renders the payload as an string suitable for transport via HTTP (query string, POST param, HTTP headers, etc.)$httpSafeString = $payload->httpSafe();

Examples

For examples of how and when to use this API method, see the documentation to manually instrument applications and services.