Stackdriver Logging Client - Class Metric (1.31.1)

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

A metric counts the number of log entries that match a given filter. You can use these metrics to create charts and alerting policies in Stackdriver Monitoring.

Example:

use Google\Cloud\Logging\LoggingClient;

$logging = new LoggingClient();

$metric = $logging->metric('my-metric');

Namespace

Google \ Cloud \ Logging

Methods

__construct

Parameters
Name Description
connection Google\Cloud\Logging\Connection\ConnectionInterface

Represents a connection to Cloud Logging. This object is created by LoggingClient, and should not be instantiated outside of this client.
name string

The metric's name.
projectId string

The project's ID.
info array

[optional] The metric's metadata.

exists

Check whether or not the metric exists.

Example:

if ($metric->exists()) {
    echo 'Metric exists!';
}
Parameter
Name Description
options array

[optional] Configuration Options
Returns
Type Description
bool

delete

See also:

Parameter
Name Description
options array

[optional] Configuration Options.

update

See also:

Parameters
Name Description
metadata array

The data to update.
↳ description string

A description of the metric.
↳ filter string

An advanced logs filter.
options array

[optional] Configuration Options.
Returns
Type Description
array

info

See also:

Parameter
Name Description
options array

[optional] Configuration Options.
Returns
Type Description
array

reload

See also:

Parameter
Name Description
options array

[optional] Configuration Options.
Returns
Type Description
array

name

Returns the metric's name.

Example:

echo $metric->name();
Returns
Type Description
string