Reference documentation and code samples for the Stackdriver Logging V2 Client class MetricsServiceV2Client.
Service Description: Service for configuring logs-based metrics.
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 \ ClientMethods
__construct
Constructor.
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.
↳ logger
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
createLogMetric
Creates a logs-based metric.
The async variant is MetricsServiceV2Client::createLogMetricAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\MetricsServiceV2Client;
use Google\Cloud\Logging\V2\CreateLogMetricRequest;
use Google\Cloud\Logging\V2\LogMetric;
/**
* @param string $formattedParent The resource name of the project in which to create the metric:
*
* "projects/[PROJECT_ID]"
*
* The new metric must be provided in the request. Please see
* {@see MetricsServiceV2Client::projectName()} for help formatting this field.
* @param string $metricName The client-assigned metric identifier.
* Examples: `"error_count"`, `"nginx/requests"`.
*
* Metric identifiers are limited to 100 characters and can include only the
* following characters: `A-Z`, `a-z`, `0-9`, and the special characters
* `_-.,+!*',()%/`. The forward-slash character (`/`) denotes a hierarchy of
* name pieces, and it cannot be the first character of the name.
*
* This field is the `[METRIC_ID]` part of a metric resource name in the
* format "projects/[PROJECT_ID]/metrics/[METRIC_ID]". Example: If the
* resource name of a metric is
* `"projects/my-project/metrics/nginx%2Frequests"`, this field's value is
* `"nginx/requests"`.
* @param string $metricFilter An [advanced logs
* filter](https://cloud.google.com/logging/docs/view/advanced_filters) which
* is used to match log entries. Example:
*
* "resource.type=gae_app AND severity>=ERROR"
*
* The maximum length of the filter is 20000 characters.
*/
function create_log_metric_sample(
string $formattedParent,
string $metricName,
string $metricFilter
): void {
// Create a client.
$metricsServiceV2Client = new MetricsServiceV2Client();
// Prepare the request message.
$metric = (new LogMetric())
->setName($metricName)
->setFilter($metricFilter);
$request = (new CreateLogMetricRequest())
->setParent($formattedParent)
->setMetric($metric);
// Call the API and handle any network failures.
try {
/** @var LogMetric $response */
$response = $metricsServiceV2Client->createLogMetric($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
{
$formattedParent = MetricsServiceV2Client::projectName('[PROJECT]');
$metricName = '[NAME]';
$metricFilter = '[FILTER]';
create_log_metric_sample($formattedParent, $metricName, $metricFilter);
}
deleteLogMetric
Deletes a logs-based metric.
The async variant is MetricsServiceV2Client::deleteLogMetricAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\MetricsServiceV2Client;
use Google\Cloud\Logging\V2\DeleteLogMetricRequest;
/**
* @param string $formattedMetricName The resource name of the metric to delete:
*
* "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
* Please see {@see MetricsServiceV2Client::logMetricName()} for help formatting this field.
*/
function delete_log_metric_sample(string $formattedMetricName): void
{
// Create a client.
$metricsServiceV2Client = new MetricsServiceV2Client();
// Prepare the request message.
$request = (new DeleteLogMetricRequest())
->setMetricName($formattedMetricName);
// Call the API and handle any network failures.
try {
$metricsServiceV2Client->deleteLogMetric($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
{
$formattedMetricName = MetricsServiceV2Client::logMetricName('[PROJECT]', '[METRIC]');
delete_log_metric_sample($formattedMetricName);
}
getLogMetric
Gets a logs-based metric.
The async variant is MetricsServiceV2Client::getLogMetricAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\MetricsServiceV2Client;
use Google\Cloud\Logging\V2\GetLogMetricRequest;
use Google\Cloud\Logging\V2\LogMetric;
/**
* @param string $formattedMetricName The resource name of the desired metric:
*
* "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
* Please see {@see MetricsServiceV2Client::logMetricName()} for help formatting this field.
*/
function get_log_metric_sample(string $formattedMetricName): void
{
// Create a client.
$metricsServiceV2Client = new MetricsServiceV2Client();
// Prepare the request message.
$request = (new GetLogMetricRequest())
->setMetricName($formattedMetricName);
// Call the API and handle any network failures.
try {
/** @var LogMetric $response */
$response = $metricsServiceV2Client->getLogMetric($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
{
$formattedMetricName = MetricsServiceV2Client::logMetricName('[PROJECT]', '[METRIC]');
get_log_metric_sample($formattedMetricName);
}
listLogMetrics
Lists logs-based metrics.
The async variant is MetricsServiceV2Client::listLogMetricsAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\Client\MetricsServiceV2Client;
use Google\Cloud\Logging\V2\ListLogMetricsRequest;
use Google\Cloud\Logging\V2\LogMetric;
/**
* @param string $formattedParent The name of the project containing the metrics:
*
* "projects/[PROJECT_ID]"
* Please see {@see MetricsServiceV2Client::projectName()} for help formatting this field.
*/
function list_log_metrics_sample(string $formattedParent): void
{
// Create a client.
$metricsServiceV2Client = new MetricsServiceV2Client();
// Prepare the request message.
$request = (new ListLogMetricsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $metricsServiceV2Client->listLogMetrics($request);
/** @var LogMetric $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
{
$formattedParent = MetricsServiceV2Client::projectName('[PROJECT]');
list_log_metrics_sample($formattedParent);
}
updateLogMetric
Creates or updates a logs-based metric.
The async variant is MetricsServiceV2Client::updateLogMetricAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\MetricsServiceV2Client;
use Google\Cloud\Logging\V2\LogMetric;
use Google\Cloud\Logging\V2\UpdateLogMetricRequest;
/**
* @param string $formattedMetricName The resource name of the metric to update:
*
* "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
*
* The updated metric must be provided in the request and it's
* `name` field must be the same as `[METRIC_ID]` If the metric
* does not exist in `[PROJECT_ID]`, then a new metric is created. Please see
* {@see MetricsServiceV2Client::logMetricName()} for help formatting this field.
* @param string $metricName The client-assigned metric identifier.
* Examples: `"error_count"`, `"nginx/requests"`.
*
* Metric identifiers are limited to 100 characters and can include only the
* following characters: `A-Z`, `a-z`, `0-9`, and the special characters
* `_-.,+!*',()%/`. The forward-slash character (`/`) denotes a hierarchy of
* name pieces, and it cannot be the first character of the name.
*
* This field is the `[METRIC_ID]` part of a metric resource name in the
* format "projects/[PROJECT_ID]/metrics/[METRIC_ID]". Example: If the
* resource name of a metric is
* `"projects/my-project/metrics/nginx%2Frequests"`, this field's value is
* `"nginx/requests"`.
* @param string $metricFilter An [advanced logs
* filter](https://cloud.google.com/logging/docs/view/advanced_filters) which
* is used to match log entries. Example:
*
* "resource.type=gae_app AND severity>=ERROR"
*
* The maximum length of the filter is 20000 characters.
*/
function update_log_metric_sample(
string $formattedMetricName,
string $metricName,
string $metricFilter
): void {
// Create a client.
$metricsServiceV2Client = new MetricsServiceV2Client();
// Prepare the request message.
$metric = (new LogMetric())
->setName($metricName)
->setFilter($metricFilter);
$request = (new UpdateLogMetricRequest())
->setMetricName($formattedMetricName)
->setMetric($metric);
// Call the API and handle any network failures.
try {
/** @var LogMetric $response */
$response = $metricsServiceV2Client->updateLogMetric($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
{
$formattedMetricName = MetricsServiceV2Client::logMetricName('[PROJECT]', '[METRIC]');
$metricName = '[NAME]';
$metricFilter = '[FILTER]';
update_log_metric_sample($formattedMetricName, $metricName, $metricFilter);
}
createLogMetricAsync
optionalArgs
array
deleteLogMetricAsync
optionalArgs
array
getLogMetricAsync
listLogMetricsAsync
optionalArgs
array
updateLogMetricAsync
optionalArgs
array
static::logMetricName
Formats a string containing the fully-qualified path to represent a log_metric resource.
project
string
metric
string
string
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
project
string
string
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
- logMetric: projects/{project}/metrics/{metric}
- 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.
formattedName
string
The formatted name string
template
?string
Optional name of template to match
array
