Stackdriver Error Reporting V1beta1 Client - Class ReportErrorsServiceClient (0.22.8)

Reference documentation and code samples for the Stackdriver Error Reporting V1beta1 Client class ReportErrorsServiceClient.

Service Description: An API for reporting error events.

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:

$reportErrorsServiceClient = new ReportErrorsServiceClient();
try {
    $formattedProjectName = $reportErrorsServiceClient->projectName('[PROJECT]');
    $event = new ReportedErrorEvent();
    $response = $reportErrorsServiceClient->reportErrorEvent($formattedProjectName, $event);
} finally {
    $reportErrorsServiceClient->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.

Namespace

Google \ Cloud \ ErrorReporting \ V1beta1

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.

reportErrorEvent

Report an individual error event and record the event to a log.

This endpoint accepts either an OAuth token, or an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456

Note: Error Reporting is a service built on Cloud Logging and can analyze log entries when all of the following are true:

Customer-managed encryption keys (CMEK) are disabled on the log bucket.
The log bucket satisfies one of the following:
The log bucket is stored in the same project where the logs originated.
The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.

Parameters
Name	Description
`projectName`	`string` Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectId}`, where `{projectId}` is the Google Cloud Platform project ID. Example: // `projects/my-project-123`.
`event`	`Google\Cloud\ErrorReporting\V1beta1\ReportedErrorEvent` Required. The error event to be reported.
`optionalArgs`	`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\ErrorReporting\V1beta1\ReportErrorEventResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ErrorReporting\V1beta1\Client\ReportErrorsServiceClient;
use Google\Cloud\ErrorReporting\V1beta1\ReportErrorEventRequest;
use Google\Cloud\ErrorReporting\V1beta1\ReportErrorEventResponse;
use Google\Cloud\ErrorReporting\V1beta1\ReportedErrorEvent;
use Google\Cloud\ErrorReporting\V1beta1\ServiceContext;

/**
 * @param string $formattedProjectName The resource name of the Google Cloud Platform project. Written
 *                                     as `projects/{projectId}`, where `{projectId}` is the
 *                                     [Google Cloud Platform project
 *                                     ID](https://support.google.com/cloud/answer/6158840).
 *
 *                                     Example: // `projects/my-project-123`. Please see
 *                                     {@see ReportErrorsServiceClient::projectName()} for help formatting this field.
 * @param string $eventMessage         The error message.
 *                                     If no `context.reportLocation` is provided, the message must contain a
 *                                     header (typically consisting of the exception type name and an error
 *                                     message) and an exception stack trace in one of the supported programming
 *                                     languages and formats.
 *                                     Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.
 *                                     Supported stack trace formats are:
 *
 *                                     * **Java**: Must be the return value of
 *                                     [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).
 *                                     * **Python**: Must be the return value of
 *                                     [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).
 *                                     * **JavaScript**: Must be the value of
 *                                     [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned
 *                                     by V8.
 *                                     * **Ruby**: Must contain frames returned by
 *                                     [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).
 *                                     * **C#**: Must be the return value of
 *                                     [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).
 *                                     * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal
 *                                     error|Warning): "` and contain the result of
 *                                     [`(string)$exception`](https://php.net/manual/en/exception.tostring.php).
 *                                     * **Go**: Must be the return value of
 *                                     [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).
 */
function report_error_event_sample(string $formattedProjectName, string $eventMessage): void
{
    // Create a client.
    $reportErrorsServiceClient = new ReportErrorsServiceClient();

    // Prepare the request message.
    $eventServiceContext = new ServiceContext();
    $event = (new ReportedErrorEvent())
        ->setServiceContext($eventServiceContext)
        ->setMessage($eventMessage);
    $request = (new ReportErrorEventRequest())
        ->setProjectName($formattedProjectName)
        ->setEvent($event);

    // Call the API and handle any network failures.
    try {
        /** @var ReportErrorEventResponse $response */
        $response = $reportErrorsServiceClient->reportErrorEvent($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
{
    $formattedProjectName = ReportErrorsServiceClient::projectName('[PROJECT]');
    $eventMessage = '[MESSAGE]';

    report_error_event_sample($formattedProjectName, $eventMessage);
}

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

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.

Constants

SERVICE_NAME

Value: 'google.devtools.clouderrorreporting.v1beta1.ReportErrorsService'

The name of the service.

SERVICE_ADDRESS

Value: 'clouderrorreporting.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.