Stackdriver Logging V2 Client - Class MetricsServiceV2Client (1.25.5)

 use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\LogMetric;
use Google\Cloud\Logging\V2\MetricsServiceV2Client;

/**
 * @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 any non-scalar elements to be passed along with the request.
    $metric = (new LogMetric())
        ->setName($metricName)
        ->setFilter($metricFilter);

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

/**
 * 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);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\MetricsServiceV2Client;

/**
 * @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();

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

/**
 * 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);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\LogMetric;
use Google\Cloud\Logging\V2\MetricsServiceV2Client;

/**
 * @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();

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

/**
 * 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);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\LogMetric;
use Google\Cloud\Logging\V2\MetricsServiceV2Client;

/**
 * @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();

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

        /** @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());
    }
}

/**
 * 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);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\LogMetric;
use Google\Cloud\Logging\V2\MetricsServiceV2Client;

/**
 * @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 any non-scalar elements to be passed along with the request.
    $metric = (new LogMetric())
        ->setName($metricName)
        ->setFilter($metricFilter);

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

/**
 * 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);
}