MetricDescriptors

For a list of methods for this resource, see the end of this page.

Resource representations

A metricDescriptor defines the name, label keys, and data type of a particular metric.

{
  "name": string,
  "project": string,
  "labels": [
    {
      "key": string,
      "description": string
    }
  ],
  "typeDescriptor": {
    "metricType": string,
    "valueType": string
  },
  "description": string
}
Property name Value Description Notes
description string Description of this metric.
labels[] list Labels defined for this metric.
labels[].description string Label description.
labels[].key string Label key.
name string The name of this metric.
project string The project ID to which the metric belongs.
typeDescriptor nested object Type description for this metric.
typeDescriptor.metricType string The method of collecting data for the metric. See Metric kinds.

Acceptable values are:
  • "cumulative"
  • "delta"
  • "gauge"
typeDescriptor.valueType string The data type of individual points in the metric's time series. See Value types.

Acceptable values are:
  • "bool"
  • "distribution"
  • "double"
  • "int64"
  • "string"

Methods

create
Create a new metric. See custom metrics for details of the use of this API.
delete
Delete an existing metric.
list
List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

Send feedback about...

Stackdriver Monitoring