Reference documentation and code samples for the Stackdriver Monitoring V3 Client class MetricServiceClient.
Service Description: Manages metric descriptors, monitored resource descriptors, and time series data.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Monitoring \ V3 \ 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.
createMetricDescriptor
Creates a new metric descriptor.
The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom metrics .
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::createMetricDescriptorAsync() .
request
Google\Cloud\Monitoring\V3\CreateMetricDescriptorRequest
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.
createServiceTimeSeries
Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This endpoint rejects writes to user-defined metrics.
This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::createServiceTimeSeriesAsync() .
request
Google\Cloud\Monitoring\V3\CreateTimeSeriesRequest
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.
createTimeSeries
Creates or adds data to one or more time series.
The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::createTimeSeriesAsync() .
request
Google\Cloud\Monitoring\V3\CreateTimeSeriesRequest
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.
deleteMetricDescriptor
Deletes a metric descriptor. Only user-created custom metrics can be deleted.
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::deleteMetricDescriptorAsync() .
request
Google\Cloud\Monitoring\V3\DeleteMetricDescriptorRequest
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.
getMetricDescriptor
Gets a single metric descriptor. This method does not require a Workspace.
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::getMetricDescriptorAsync() .
request
Google\Cloud\Monitoring\V3\GetMetricDescriptorRequest
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.
getMonitoredResourceDescriptor
Gets a single monitored resource descriptor. This method does not require a Workspace.
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::getMonitoredResourceDescriptorAsync() .
request
Google\Cloud\Monitoring\V3\GetMonitoredResourceDescriptorRequest
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.
listMetricDescriptors
Lists metric descriptors that match a filter. This method does not require a Workspace.
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::listMetricDescriptorsAsync() .
request
Google\Cloud\Monitoring\V3\ListMetricDescriptorsRequest
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.
listMonitoredResourceDescriptors
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::listMonitoredResourceDescriptorsAsync() .
request
Google\Cloud\Monitoring\V3\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.
listTimeSeries
Lists time series that match a filter. This method does not require a Workspace.
The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::listTimeSeriesAsync() .
request
Google\Cloud\Monitoring\V3\ListTimeSeriesRequest
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.
createMetricDescriptorAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createServiceTimeSeriesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createTimeSeriesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteMetricDescriptorAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getMetricDescriptorAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getMonitoredResourceDescriptorAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listMetricDescriptorsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listMonitoredResourceDescriptorsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listTimeSeriesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::folderName
Formats a string containing the fully-qualified path to represent a folder resource.
folder
string
string
static::folderMetricDescriptorName
Formats a string containing the fully-qualified path to represent a folder_metric_descriptor resource.
folder
string
metricDescriptor
string
string
static::folderMonitoredResourceDescriptorName
Formats a string containing the fully-qualified path to represent a folder_monitored_resource_descriptor resource.
folder
string
monitoredResourceDescriptor
string
string
static::metricDescriptorName
Formats a string containing the fully-qualified path to represent a metric_descriptor resource.
project
string
metricDescriptor
string
string
static::monitoredResourceDescriptorName
Formats a string containing the fully-qualified path to represent a monitored_resource_descriptor resource.
project
string
monitoredResourceDescriptor
string
string
static::organizationName
Formats a string containing the fully-qualified path to represent a organization resource.
organization
string
string
static::organizationMetricDescriptorName
Formats a string containing the fully-qualified path to represent a organization_metric_descriptor resource.
organization
string
metricDescriptor
string
string
static::organizationMonitoredResourceDescriptorName
Formats a string containing the fully-qualified path to represent a organization_monitored_resource_descriptor resource.
organization
string
monitoredResourceDescriptor
string
string
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
project
string
string
static::projectMetricDescriptorName
Formats a string containing the fully-qualified path to represent a project_metric_descriptor resource.
project
string
metricDescriptor
string
string
static::projectMonitoredResourceDescriptorName
Formats a string containing the fully-qualified path to represent a project_monitored_resource_descriptor resource.
project
string
monitoredResourceDescriptor
string
string
static::workspaceName
Formats a string containing the fully-qualified path to represent a workspace 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
- folder: folders/{folder}
- folderMetricDescriptor: folders/{folder}/metricDescriptors/{metric_descriptor=**}
- folderMonitoredResourceDescriptor: folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}
- metricDescriptor: projects/{project}/metricDescriptors/{metric_descriptor=**}
- monitoredResourceDescriptor: projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}
- organization: organizations/{organization}
- organizationMetricDescriptor: organizations/{organization}/metricDescriptors/{metric_descriptor=**}
- organizationMonitoredResourceDescriptor: organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}
- project: projects/{project}
- projectMetricDescriptor: projects/{project}/metricDescriptors/{metric_descriptor=**}
- projectMonitoredResourceDescriptor: projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}
- workspace: 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
