Stackdriver Logging V2 Client - Class LoggingServiceV2Client (1.30.3)

Reference documentation and code samples for the Stackdriver Logging V2 Client class LoggingServiceV2Client.

Service Description: Service for ingesting and querying logs.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

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.

Namespace

Google \ Cloud \ Logging \ V2 \ Client

Methods

__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 Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper 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 Google\ApiCore\CredentialsWrapper::build() .
`↳ 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 Google\ApiCore\Transport\TransportInterface 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 Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() 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.

deleteLog

Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.

The async variant is Google\Cloud\Logging\V2\Client\LoggingServiceV2Client::deleteLogAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\DeleteLogRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\LoggingServiceV2Client;
use Google\Cloud\Logging\V2\DeleteLogRequest;

/**
 * @param string $formattedLogName The resource name of the log to delete:
 *
 *                                 * `projects/[PROJECT_ID]/logs/[LOG_ID]`
 *                                 * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
 *                                 * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
 *                                 * `folders/[FOLDER_ID]/logs/[LOG_ID]`
 *
 *                                 `[LOG_ID]` must be URL-encoded. For example,
 *                                 `"projects/my-project-id/logs/syslog"`,
 *                                 `"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"`.
 *
 *                                 For more information about log names, see
 *                                 [LogEntry][google.logging.v2.LogEntry]. Please see
 *                                 {@see LoggingServiceV2Client::logName()} for help formatting this field.
 */
function delete_log_sample(string $formattedLogName): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare the request message.
    $request = (new DeleteLogRequest())
        ->setLogName($formattedLogName);

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

/**
 * Helper to execute the sample.
 *
 * 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
{
    $formattedLogName = LoggingServiceV2Client::logName('[PROJECT]', '[LOG]');

    delete_log_sample($formattedLogName);
}

listLogEntries

Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.

The async variant is Google\Cloud\Logging\V2\Client\LoggingServiceV2Client::listLogEntriesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\ListLogEntriesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\Client\LoggingServiceV2Client;
use Google\Cloud\Logging\V2\ListLogEntriesRequest;
use Google\Cloud\Logging\V2\LogEntry;

/**
 * @param string $formattedResourceNamesElement Names of one or more parent resources from which to
 *                                              retrieve log entries:
 *
 *                                              *  `projects/[PROJECT_ID]`
 *                                              *  `organizations/[ORGANIZATION_ID]`
 *                                              *  `billingAccounts/[BILLING_ACCOUNT_ID]`
 *                                              *  `folders/[FOLDER_ID]`
 *
 *                                              May alternatively be one or more views:
 *
 *                                              * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                              * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                              * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                              * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *
 *                                              Projects listed in the `project_ids` field are added to this list.
 *                                              A maximum of 100 resources may be specified in a single request. Please see
 *                                              {@see LoggingServiceV2Client::projectName()} for help formatting this field.
 */
function list_log_entries_sample(string $formattedResourceNamesElement): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare the request message.
    $formattedResourceNames = [$formattedResourceNamesElement,];
    $request = (new ListLogEntriesRequest())
        ->setResourceNames($formattedResourceNames);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $loggingServiceV2Client->listLogEntries($request);

        /** @var LogEntry $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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
{
    $formattedResourceNamesElement = LoggingServiceV2Client::projectName('[PROJECT]');

    list_log_entries_sample($formattedResourceNamesElement);
}

listLogs

Lists the logs in projects, organizations, folders, or billing accounts.

Only logs that have entries are listed.

The async variant is Google\Cloud\Logging\V2\Client\LoggingServiceV2Client::listLogsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\ListLogsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\Client\LoggingServiceV2Client;
use Google\Cloud\Logging\V2\ListLogsRequest;

/**
 * @param string $formattedParent The resource name to list logs for:
 *
 *                                *  `projects/[PROJECT_ID]`
 *                                *  `organizations/[ORGANIZATION_ID]`
 *                                *  `billingAccounts/[BILLING_ACCOUNT_ID]`
 *                                *  `folders/[FOLDER_ID]`
 *                                Please see {@see LoggingServiceV2Client::projectName()} for help formatting this field.
 */
function list_logs_sample(string $formattedParent): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare the request message.
    $request = (new ListLogsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $loggingServiceV2Client->listLogs($request);

        /** @var string $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element);
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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
{
    $formattedParent = LoggingServiceV2Client::projectName('[PROJECT]');

    list_logs_sample($formattedParent);
}

listMonitoredResourceDescriptors

Lists the descriptors for monitored resource types used by Logging.

The async variant is Google\Cloud\Logging\V2\Client\LoggingServiceV2Client::listMonitoredResourceDescriptorsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\ListMonitoredResourceDescriptorsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Api\MonitoredResourceDescriptor;
use Google\Cloud\Logging\V2\Client\LoggingServiceV2Client;
use Google\Cloud\Logging\V2\ListMonitoredResourceDescriptorsRequest;

/**
 * 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 list_monitored_resource_descriptors_sample(): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare the request message.
    $request = new ListMonitoredResourceDescriptorsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $loggingServiceV2Client->listMonitoredResourceDescriptors($request);

        /** @var MonitoredResourceDescriptor $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

tailLogEntries

Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.

Parameters
Name	Description
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Logging\V2\Client\LoggingServiceV2Client;
use Google\Cloud\Logging\V2\TailLogEntriesRequest;
use Google\Cloud\Logging\V2\TailLogEntriesResponse;

/**
 * @param string $resourceNamesElement Name of a parent resource from which to retrieve log entries:
 *
 *                                     *  `projects/[PROJECT_ID]`
 *                                     *  `organizations/[ORGANIZATION_ID]`
 *                                     *  `billingAccounts/[BILLING_ACCOUNT_ID]`
 *                                     *  `folders/[FOLDER_ID]`
 *
 *                                     May alternatively be one or more views:
 *
 *                                     * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                     * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                     * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                     * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 */
function tail_log_entries_sample(string $resourceNamesElement): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare the request message.
    $resourceNames = [$resourceNamesElement,];
    $request = (new TailLogEntriesRequest())
        ->setResourceNames($resourceNames);

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $loggingServiceV2Client->tailLogEntries();
        $stream->writeAll([$request,]);

        /** @var TailLogEntriesResponse $element */
        foreach ($stream->closeWriteAndReadAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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
{
    $resourceNamesElement = '[RESOURCE_NAMES]';

    tail_log_entries_sample($resourceNamesElement);
}

writeLogEntries

Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging.

A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)

The async variant is Google\Cloud\Logging\V2\Client\LoggingServiceV2Client::writeLogEntriesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\WriteLogEntriesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Logging\V2\WriteLogEntriesResponse`

Example

use Google\ApiCore\ApiException;
use Google\Api\MonitoredResource;
use Google\Cloud\Logging\V2\Client\LoggingServiceV2Client;
use Google\Cloud\Logging\V2\LogEntry;
use Google\Cloud\Logging\V2\WriteLogEntriesRequest;
use Google\Cloud\Logging\V2\WriteLogEntriesResponse;

/**
 * @param string $entriesLogName The resource name of the log to which this log entry belongs:
 *
 *                               "projects/[PROJECT_ID]/logs/[LOG_ID]"
 *                               "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
 *                               "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
 *                               "folders/[FOLDER_ID]/logs/[LOG_ID]"
 *
 *                               A project number may be used in place of PROJECT_ID. The project number is
 *                               translated to its corresponding PROJECT_ID internally and the `log_name`
 *                               field will contain PROJECT_ID in queries and exports.
 *
 *                               `[LOG_ID]` must be URL-encoded within `log_name`. Example:
 *                               `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
 *
 *                               `[LOG_ID]` must be less than 512 characters long and can only include the
 *                               following characters: upper and lower case alphanumeric characters,
 *                               forward-slash, underscore, hyphen, and period.
 *
 *                               For backward compatibility, if `log_name` begins with a forward-slash, such
 *                               as `/projects/...`, then the log entry is ingested as usual, but the
 *                               forward-slash is removed. Listing the log entry will not show the leading
 *                               slash and filtering for a log name with a leading slash will never return
 *                               any results.
 */
function write_log_entries_sample(string $entriesLogName): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare the request message.
    $entriesResource = new MonitoredResource();
    $logEntry = (new LogEntry())
        ->setLogName($entriesLogName)
        ->setResource($entriesResource);
    $entries = [$logEntry,];
    $request = (new WriteLogEntriesRequest())
        ->setEntries($entries);

    // Call the API and handle any network failures.
    try {
        /** @var WriteLogEntriesResponse $response */
        $response = $loggingServiceV2Client->writeLogEntries($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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
{
    $entriesLogName = '[LOG_NAME]';

    write_log_entries_sample($entriesLogName);
}

deleteLogAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\DeleteLogRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLogEntriesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\ListLogEntriesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLogsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\ListLogsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listMonitoredResourceDescriptorsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\ListMonitoredResourceDescriptorsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

writeLogEntriesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\WriteLogEntriesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::billingAccountName

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

Parameter
Name	Description
`billingAccount`	`string`

Returns
Type	Description
`string`	The formatted billing_account resource.

static::billingAccountLogName

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

Parameters
Name	Description
`billingAccount`	`string`
`log`	`string`

Returns
Type	Description
`string`	The formatted billing_account_log resource.

static::folderName

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

Parameter
Name	Description
`folder`	`string`

Returns
Type	Description
`string`	The formatted folder resource.

static::folderLogName

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

Parameters
Name	Description
`folder`	`string`
`log`	`string`

Returns
Type	Description
`string`	The formatted folder_log resource.

static::logName

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

Parameters
Name	Description
`project`	`string`
`log`	`string`

Returns
Type	Description
`string`	The formatted log resource.

static::organizationName

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

Parameter
Name	Description
`organization`	`string`

Returns
Type	Description
`string`	The formatted organization resource.

static::organizationLogName

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

Parameters
Name	Description
`organization`	`string`
`log`	`string`

Returns
Type	Description
`string`	The formatted organization_log resource.

static::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.

static::projectLogName

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

Parameters
Name	Description
`project`	`string`
`log`	`string`

Returns
Type	Description
`string`	The formatted project_log resource.

static::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

billingAccount: billingAccounts/{billing_account}
billingAccountLog: billingAccounts/{billing_account}/logs/{log}
folder: folders/{folder}
folderLog: folders/{folder}/logs/{log}
log: projects/{project}/logs/{log}
organization: organizations/{organization}
organizationLog: organizations/{organization}/logs/{log}
project: projects/{project}
projectLog: projects/{project}/logs/{log}

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.