Skip to main content

metric_descriptors

Creates, updates, deletes, gets or lists a metric_descriptors resource.

Overview​

Namemetric_descriptors
TypeResource
Idgoogle.monitoring.metric_descriptors

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringThe resource name of the metric descriptor.
descriptionstringA detailed description of the metric, which can be used in documentation.
displayNamestringA 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.
labelsarrayThe set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies 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.
launchStagestringOptional. The launch stage of the metric definition.
metadataobjectOptional. Metadata which can be used to guide usage of the metric. (id: MetricDescriptorMetadata)
metricKindstringWhether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypesarrayRead-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
typestringThe 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"
unitstringThe units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (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) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.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. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
valueTypestringWhether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_metric_descriptors_getselectprojectsId, metricDescriptorsIdGets a single metric descriptor.
projects_metric_descriptors_listselectprojectsIdfilter, pageSize, pageToken, activeOnlyLists metric descriptors that match a filter.
projects_metric_descriptors_createinsertprojectsIdCreates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics). The metric descriptor is updated if it already exists, except that metric labels are never removed.
projects_metric_descriptors_deletedeleteprojectsId, metricDescriptorsIdDeletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
metricDescriptorsIdstring
projectsIdstring
activeOnlyboolean
filterstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples​

Gets a single metric descriptor.

SELECT
name,
description,
displayName,
labels,
launchStage,
metadata,
metricKind,
monitoredResourceTypes,
type,
unit,
valueType
FROM google.monitoring.metric_descriptors
WHERE projectsId = '{{ projectsId }}' -- required
AND metricDescriptorsId = '{{ metricDescriptorsId }}' -- required;

INSERT examples​

Creates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics). The metric descriptor is updated if it already exists, except that metric labels are never removed.

INSERT INTO google.monitoring.metric_descriptors (
data__name,
data__type,
data__labels,
data__metricKind,
data__valueType,
data__unit,
data__description,
data__displayName,
data__metadata,
data__launchStage,
data__monitoredResourceTypes,
projectsId
)
SELECT 
'{{ name }}',
'{{ type }}',
'{{ labels }}',
'{{ metricKind }}',
'{{ valueType }}',
'{{ unit }}',
'{{ description }}',
'{{ displayName }}',
'{{ metadata }}',
'{{ launchStage }}',
'{{ monitoredResourceTypes }}',
'{{ projectsId }}'
RETURNING
name,
description,
displayName,
labels,
launchStage,
metadata,
metricKind,
monitoredResourceTypes,
type,
unit,
valueType
;

DELETE examples​

Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted.

DELETE FROM google.monitoring.metric_descriptors
WHERE projectsId = '{{ projectsId }}' --required
AND metricDescriptorsId = '{{ metricDescriptorsId }}' --required;