Stackdriver Trace Client - Class TraceClient (1.9.1)

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

Google Stackdriver Trace allows you to collect latency data from your applications and display it in the Google Cloud Platform Console.

Find more information at Stackdriver Trace API docs.

Example:

use Google\Cloud\Trace\TraceClient;

$trace = new TraceClient();

Namespace

Google \ Cloud \ Trace

Methods

__construct

Create a Trace client.

Parameters
Name	Description
`config`	`array` Configuration options.
`↳ apiEndpoint`	`string` A hostname with optional port to use in place of the service's default endpoint.
`↳ projectId`	`string` The project ID from the Google Developer's Console.
`↳ authCache`	`CacheItemPoolInterface` A cache used storing access tokens. Defaults to a simple in memory implementation.
`↳ authCacheOptions`	`array` Cache configuration options.
`↳ authHttpHandler`	`callable` A handler used to deliver Psr7 requests specifically for authentication.
`↳ credentialsFetcher`	`FetchAuthTokenInterface` A credentials fetcher instance.
`↳ keyFile`	`array` [DEPRECATED] @deprecated This option is being deprecated because of a potential security risk. This option does not validate the credential configuration. The security risk occurs when a credential configuration is accepted from a source that is not under your control and used without validation on your side. If you know that you will be loading credential configurations of a specific type, it is recommended to create the credentials directly and configure them using the `credentialsFetcher` option instead. `use Google\Auth\Credentials\ServiceAccountCredentials; $credentialsFetcher = new ServiceAccountCredentials($scopes, $json); $creds = new TraceClient(['credentialsFetcher' => $creds]);` This will ensure that an unexpected credential type with potential for malicious intent is not loaded unintentionally. You might still have to do validation for certain credential types. If you are loading your credential configuration from an untrusted source and have not mitigated the risks (e.g. by validating the configuration yourself), make these changes as soon as possible to prevent security risks to your environment. Regardless of the method used, it is always your responsibility to validate configurations received from external sources. @see https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
`↳ keyFilePath`	`string` [DEPRECATED] @deprecated This option is being deprecated because of a potential security risk. This option does not validate the credential configuration. The security risk occurs when a credential configuration is accepted from a source that is not under your control and used without validation on your side. If you know that you will be loading credential configurations of a specific type, it is recommended to create the credentials directly and configure them using the `credentialsFetcher` option instead. `use Google\Auth\Credentials\ServiceAccountCredentials; $credentialsFetcher = new ServiceAccountCredentials($scopes, $json); $creds = new TraceClient(['credentialsFetcher' => $creds]);` This will ensure that an unexpected credential type with potential for malicious intent is not loaded unintentionally. You might still have to do validation for certain credential types. If you are loading your credential configuration from an untrusted source and have not mitigated the risks (e.g. by validating the configuration yourself), make these changes as soon as possible to prevent security risks to your environment. Regardless of the method used, it is always your responsibility to validate configurations received from external sources. @see https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
`↳ requestTimeout`	`float` Seconds to wait before timing out the request. Defaults to `0` with REST and `60` with gRPC.
`↳ retries`	`int` Number of retries for a failed request. Defaults to `3`.
`↳ scopes`	`array` Scopes to be used for the request.
`↳ quotaProject`	`string` Specifies a user project to bill for access charges associated with the request.

insert

insertBatch

trace

Lazily find or instantiates a trace. There are no network requests made at this point. To see the operations that can be performed on a trace please see Trace. If no traceId is provided, one will be generated for you.