List

Lists metric descriptors that match a filter

4 variables
18 variables

Lists metric descriptors that match a filter. This method does not require a Stackdriver account

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and write monitoring data for all of your Google and third-party Cloud and API projects
  • View monitoring data for all of your Google Cloud and third-party projects
  • Publish metric data to your Google Cloud projects

Input

This building block consumes 4 input parameters

  = Parameter name
  = Format

name STRING Required

The project on which to execute the request. The format is "projects/{project_id_or_number}"

filter STRING

If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/")

pageToken STRING

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call

pageSize INTEGER

A positive number that is the maximum number of results to return

Output

This building block provides 18 output parameters

  = Parameter name
  = Format

metricDescriptors[] OBJECT

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

metricDescriptors[].valueType ENUMERATION

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

metricDescriptors[].metricKind ENUMERATION

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

metricDescriptors[].displayName STRING

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

metricDescriptors[].description STRING

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

metricDescriptors[].unit STRING

The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (103) M mega (106) G giga (109) T tera (1012) P peta (1015) E exa (1018) Z zetta (1021) Y yotta (1024) 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 (210) Mi mebi (220) Gi gibi (230) Ti tebi (240)GrammarThe 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 "}" ; Notes: 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 '}'. 1 represents dimensionless value 1, such as in 1/s. % represents dimensionless value 1/100, and annotates values giving a percentage

metricDescriptors[].labels[] OBJECT

A description of a label

metricDescriptors[].labels[].valueType ENUMERATION

The type of data that can be assigned to the label

metricDescriptors[].labels[].key STRING

The label key

metricDescriptors[].labels[].description STRING

A human-readable description for the label

metricDescriptors[].launchStage ENUMERATION

Optional. The launch stage of the metric definition

metricDescriptors[].name STRING

The resource name of the metric descriptor

metricDescriptors[].type STRING

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

metricDescriptors[].metadata OBJECT

Additional annotations that can be used to guide the usage of a metric

metricDescriptors[].metadata.ingestDelay ANY

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors

metricDescriptors[].metadata.launchStage ENUMERATION

Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition

metricDescriptors[].metadata.samplePeriod ANY

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period

nextPageToken STRING

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method