google/cloud-trace

Stackdriver Trace Client for PHP

v1.8.7 2024-11-06 21:50 UTC

Requires

• php: ^8.0
• google/cloud-core: ^1.52.7
• google/gax: ^1.34.0
• ramsey/uuid: ^3.0|^4.0

Requires (Dev)

• erusev/parsedown: ^1.6
• phpdocumentor/reflection: ^5.3.3
• phpdocumentor/reflection-docblock: ^5.3
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.0
• squizlabs/php_codesniffer: 2.*

Suggests

• ext-grpc: The gRPC extension enables use of the performant gRPC transport
• ext-protobuf: Provides a significant increase in throughput over the pure PHP protobuf implementation. See https://cloud.google.com/php/grpc for installation instructions.
• opencensus/opencensus: Provides application tracing integrations.

Apache-2.0

README

Idiomatic PHP client for Stackdriver Trace.

• API documentation

NOTE: This repository is part of Google Cloud PHP. Any support requests, bug reports, or development contributions should be directed to that project.

A distributed tracing system for Google Cloud Platform that collects latency data from App Engine applications and displays it in near real time in the Google Cloud Platform Console.

Installation

To begin, install the preferred dependency manager for PHP, Composer.

Now install this component:

$ composer require google/cloud-trace

This component supports both REST over HTTP/1.1 and gRPC. In order to take advantage of the benefits offered by gRPC (such as streaming methods) please see our gRPC installation guide.

Authentication

Please see our Authentication guide for more information on authenticating your client. Once authenticated, you'll be ready to start making requests.

Sample

require 'vendor/autoload.php';

use Google\Cloud\Trace\TraceClient;

$traceClient = new TraceClient();

// Create a Trace
$trace = $traceClient->trace();
$span = $trace->span([
    'name' => 'main'
]);
$span->setStartTime();
// some expensive operation
$span->setEndTime();

$trace->setSpans([$span]);
$traceClient->insert($trace);

// List recent Traces
foreach($traceClient->traces() as $trace) {
    var_dump($trace->traceId());
}

Creating a Trace

use Google\Cloud\Trace\TraceClient;

$client = new TraceClient();
$trace = $client->trace();
$span = $trace->span(['name' => 'main']);
$trace->setSpans([$span]);

$client->insert($trace);

Using OpenCensus

We highly recommend using the OpenCensus project to instrument your application. OpenCensus is an open source, distributed tracing framework that maintains integrations with popular frameworks and tools. OpenCensus provides a data exporter for Stackdriver Trace which uses this library. If you were using google/cloud-trace <= v0.3.3 or google/cloud <= 0.46.0, then check out the migration guide to OpenCensus.

Install with composer or add to your composer.json.

$ composer require opencensus/opencensus opencensus/opencensus-exporter-stackdriver

opencensus/opencensus provides a service-agnostic implementation. Be sure to also require opencensus/opencensus-exporter-stackdriver to enable exporting of traces to Stackdriver Trace.

use OpenCensus\Trace\Exporter\StackdriverExporter;
use OpenCensus\Trace\Tracer;

Tracer::start(new StackdriverExporter());

See the OpenCensus documentation for more configuration options and features.

Version

This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in any minor or patch releases. We will address issues and requests with the highest priority.

Next Steps

1. Understand the official documentation.
2. Take a look at in-depth usage samples.