Stackdriver Trace V2 Client - Class TraceServiceClient (1.4.11)

Reference documentation and code samples for the Stackdriver Trace V2 Client class TraceServiceClient.

Service Description: This file describes an API for collecting and viewing traces and spans within a trace. A Trace is a collection of spans corresponding to a single operation or set of operations for an application. A span is an individual timed event which forms a node of the trace tree. A single trace may contain span(s) from multiple services.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$traceServiceClient = new TraceServiceClient();
try {
    $formattedName = $traceServiceClient->projectName('[PROJECT]');
    $spans = [];
    $traceServiceClient->batchWriteSpans($formattedName, $spans);
} finally {
    $traceServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Methods

projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

spanName

Formats a string containing the fully-qualified path to represent a span resource.

Parameters
Name	Description
`project`	`string`
`trace`	`string`
`span`	`string`

Returns
Type	Description
`string`	The formatted span resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

project: projects/{project}
span: projects/{project}/traces/{trace}/spans/{span}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed {@see} object or {@see} object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see {@see} .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated {@see} object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the {@see} and {@see} methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

batchWriteSpans

Sends new spans to new or existing traces. You cannot update existing spans.

Parameters
Name	Description
`name`	`string` Required. The name of the project where the spans belong. The format is `projects/[PROJECT_ID]`.
`spans`	`array<Google\Cloud\Trace\V2\Span>` Required. A list of new spans. The span names must not match existing spans, or the results are undefined.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Trace\V2\Span;
use Google\Cloud\Trace\V2\TraceServiceClient;
use Google\Cloud\Trace\V2\TruncatableString;
use Google\Protobuf\Timestamp;

/**
 * @param string $formattedName The name of the project where the spans belong. The format is
 *                              `projects/[PROJECT_ID]`. Please see
 *                              {@see TraceServiceClient::projectName()} for help formatting this field.
 * @param string $spansName     The resource name of the span in the following format:
 *
 *                              projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
 *
 *                              [TRACE_ID] is a unique identifier for a trace within a project;
 *                              it is a 32-character hexadecimal encoding of a 16-byte array.
 *
 *                              [SPAN_ID] is a unique identifier for a span within a trace; it
 *                              is a 16-character hexadecimal encoding of an 8-byte array.
 * @param string $spansSpanId   The [SPAN_ID] portion of the span's resource name.
 */
function batch_write_spans_sample(
    string $formattedName,
    string $spansName,
    string $spansSpanId
): void {
    // Create a client.
    $traceServiceClient = new TraceServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $spansDisplayName = new TruncatableString();
    $spansStartTime = new Timestamp();
    $spansEndTime = new Timestamp();
    $span = (new Span())
        ->setName($spansName)
        ->setSpanId($spansSpanId)
        ->setDisplayName($spansDisplayName)
        ->setStartTime($spansStartTime)
        ->setEndTime($spansEndTime);
    $spans = [$span,];

    // Call the API and handle any network failures.
    try {
        $traceServiceClient->batchWriteSpans($formattedName, $spans);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = TraceServiceClient::projectName('[PROJECT]');
    $spansName = '[NAME]';
    $spansSpanId = '[SPAN_ID]';

    batch_write_spans_sample($formattedName, $spansName, $spansSpanId);
}

createSpan

Creates a new span.

Parameters
Name	Description
`name`	`string` Required. The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.
`spanId`	`string` Required. The [SPAN_ID] portion of the span's resource name.
`displayName`	`Google\Cloud\Trace\V2\TruncatableString` Required. A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.
`startTime`	`Google\Protobuf\Timestamp` Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
`endTime`	`Google\Protobuf\Timestamp` Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
`optionalArgs`	`array` Optional.
`↳ parentSpanId`	`string` The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.
`↳ attributes`	`Attributes` A set of attributes on the span. You can have up to 32 attributes per span.
`↳ stackTrace`	`StackTrace` Stack trace captured at the start of the span.
`↳ timeEvents`	`TimeEvents` A set of time events. You can have up to 32 annotations and 128 message events per span.
`↳ links`	`Links` Links associated with the span. You can have up to 128 links per Span.
`↳ status`	`Status` Optional. The final status for this span.
`↳ sameProcessAsParentSpan`	`BoolValue` Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information.
`↳ childSpanCount`	`Int32Value` Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
`↳ spanKind`	`int` Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call. For allowed values, use constants defined on {@see}
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Trace\V2\Span`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Trace\V2\Span;
use Google\Cloud\Trace\V2\TraceServiceClient;
use Google\Cloud\Trace\V2\TruncatableString;
use Google\Protobuf\Timestamp;

/**
 * @param string $name   The resource name of the span in the following format:
 *
 *                       projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
 *
 *                       [TRACE_ID] is a unique identifier for a trace within a project;
 *                       it is a 32-character hexadecimal encoding of a 16-byte array.
 *
 *                       [SPAN_ID] is a unique identifier for a span within a trace; it
 *                       is a 16-character hexadecimal encoding of an 8-byte array.
 * @param string $spanId The [SPAN_ID] portion of the span's resource name.
 */
function create_span_sample(string $name, string $spanId): void
{
    // Create a client.
    $traceServiceClient = new TraceServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $displayName = new TruncatableString();
    $startTime = new Timestamp();
    $endTime = new Timestamp();

    // Call the API and handle any network failures.
    try {
        /** @var Span $response */
        $response = $traceServiceClient->createSpan($name, $spanId, $displayName, $startTime, $endTime);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';
    $spanId = '[SPAN_ID]';

    create_span_sample($name, $spanId);
}

Constants

SERVICE_NAME

Value: 'google.devtools.cloudtrace.v2.TraceService'

The name of the service.

SERVICE_ADDRESS

Value: 'cloudtrace.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.