REST Resource: projects.metricDescriptors

Resource: MetricDescriptor

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

JSON representation
  "name": string,
  "type": string,
  "labels": [
  "metricKind": enum(MetricKind),
  "valueType": enum(ValueType),
  "unit": string,
  "description": string,
  "displayName": string,


The resource name of the metric descriptor.



The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name Metric types should use a natural hierarchical grouping. For example:




The set of labels that can be used to describe a specific instance of this metric type. For example, the metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.



Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metricKind and valueType might not be supported.



Whether the measurement is an integer, a floating-point number, etc. Some combinations of metricKind and valueType might not be supported.



The unit in which the metric value is reported. It is only applicable if the valueType is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure standard:

Basic units (UNIT)

  • bit bit
  • By byte
  • s second
  • min minute
  • h hour
  • d day

Prefixes (PREFIX)

  • k kilo (10**3)
  • M mega (10**6)
  • G giga (10**9)
  • T tera (10**12)
  • P peta (10**15)
  • E exa (10**18)
  • Z zetta (10**21)
  • Y yotta (10**24)
  • m milli (10**-3)
  • u micro (10**-6)
  • n nano (10**-9)
  • p pico (10**-12)
  • f femto (10**-15)
  • a atto (10**-18)
  • z zepto (10**-21)
  • y yocto (10**-24)
  • Ki kibi (2**10)
  • Mi mebi (2**20)
  • Gi gibi (2**30)
  • Ti tebi (2**40)


The grammar includes the dimensionless unit 1, such as 1/s.

The grammar also includes these connectors:

  • / division (as an infix operator, e.g. 1/s).
  • . multiplication (as an infix operator, e.g. GBy.d)

The grammar for a unit is as follows:

Expression = Component { "." Component } { "/" Component } ;

Component = [ PREFIX ] UNIT [ Annotation ]
          | Annotation
          | "1"

Annotation = "{" NAME "}" ;


  • Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.
  • NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.



A detailed description of the metric, which can be used in documentation.



A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.


The kind of measurement. It describes how the data is reported.

METRIC_KIND_UNSPECIFIED Do not use this default value.
GAUGE An instantaneous measurement of a value.
DELTA The change in a value during a time interval.
CUMULATIVE A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.


The value type of a metric.

VALUE_TYPE_UNSPECIFIED Do not use this default value.
BOOL The value is a boolean. This value type can be used only if the metric kind is GAUGE.
INT64 The value is a signed 64-bit integer.
DOUBLE The value is a double precision floating point number.
STRING The value is a text string. This value type can be used only if the metric kind is GAUGE.
DISTRIBUTION The value is a Distribution.
MONEY The value is money.



Creates a new metric descriptor.


Deletes a metric descriptor.


Gets a single metric descriptor.


Lists metric descriptors that match a filter.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Stackdriver Monitoring