Stackdriver Debugger Client - Class DebuggerClient (1.8.8)

Reference documentation and code samples for the Stackdriver Debugger Client class DebuggerClient.

Google Stackdriver Debugger allows you to collect variable data from a live application and display it in the Google Cloud Platform Console. Find more information at Stackdriver Debugger API docs.

Example:

use Google\Cloud\Debugger\DebuggerClient; $debugger = new DebuggerClient();

Namespace

Google \ Cloud \ Debugger

Methods

__construct

Create a Debugger 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.
↳ httpHandler callable

A handler used to deliver Psr7 requests. Only valid for requests sent over REST.
↳ keyFile array

The contents of the service account credentials .json file retrieved from the Google Developer's Console. Ex: json_decode(file_get_contents($path), true).
↳ keyFilePath string

The full path to your service account credentials .json file retrieved from the Google Developers Console.
↳ 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.

debuggee

Lazily instantiate a debuggee. There are no network requests made at this point. To see the operations that can be performed on a debuggee, please see Google\Cloud\Debugger\Debuggee.

Example:

$debuggee = $client->debuggee(); $debuggee->register(); 
$debuggee = $client->debuggee('debuggee-id');
Parameters
Name Description
id string

The debuggee identifier
options array

Configuration options.
↳ uniquifier string

Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended.
↳ description string

Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
↳ isInactive string

If set to true, indicates that the debuggee is considered as inactive by the Controller service.
↳ status string

Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.
↳ extSourceContexts ExtendedSourceContext[]

References to the locations and revisions of the source code used in the deployed application.
Returns
Type Description
Google\Cloud\Debugger\Debuggee

debuggees

See also:

Parameters
Name Description
options array

Configuration options.
↳ includeInactive bool

When set to true, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.
↳ clientVersion string

The client version making the call. Schema: domain/type/version (e.g., google.com/intellij/v1).
Returns
Type Description
array<Google\Cloud\Debugger\Debuggee>

static::getDefaultAgentVersion

Returns the default Agent version string

Returns
Type Description
string

Constants

VERSION

Value: '1.8.8'

FULL_CONTROL_SCOPE

Value: 'https://www.googleapis.com/auth/cloud-platform'

READ_ONLY_SCOPE

Value: 'https://www.googleapis.com/auth/debugger.readonly'