metric_descriptors

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

Overview

Name	`metric_descriptors`
Type	Resource
Id	`google.monitoring.metric_descriptors`

Fields

Name	Datatype	Description
`name`	`string`	The resource name of the metric descriptor.
`description`	`string`	A detailed description of the metric, which can be used in documentation.
`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.
`labels`	`array`	The 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.
`launchStage`	`string`	Optional. The launch stage of the metric definition.
`metadata`	`object`	Additional annotations that can be used to guide the usage of a metric.
`metricKind`	`string`	Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
`monitoredResourceTypes`	`array`	Read-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.
`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"
`unit`	`string`	The 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
`valueType`	`string`	Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

Methods

Name	Accessible by	Required Params	Description
`projects_metric_descriptors_get`	`SELECT`	`metricDescriptorsId, projectsId`	Gets a single metric descriptor.
`projects_metric_descriptors_list`	`SELECT`	`projectsId`	Lists metric descriptors that match a filter.
`projects_metric_descriptors_create`	`INSERT`	`projectsId`	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.
`projects_metric_descriptors_delete`	`DELETE`	`metricDescriptorsId, projectsId`	Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted.

`SELECT` examples

Lists metric descriptors that match a filter.

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

`INSERT` example

Use the following StackQL query and manifest file to create a new metric_descriptors resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.monitoring.metric_descriptors (
projectsId,
name,
type,
labels,
metricKind,
valueType,
unit,
description,
displayName,
metadata,
launchStage,
monitoredResourceTypes
)
SELECT 
'{{ projectsId }}',
'{{ name }}',
'{{ type }}',
'{{ labels }}',
'{{ metricKind }}',
'{{ valueType }}',
'{{ unit }}',
'{{ description }}',
'{{ displayName }}',
'{{ metadata }}',
'{{ launchStage }}',
'{{ monitoredResourceTypes }}'
;

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: type
      value: string
    - name: labels
      value:
        - - name: key
            value: string
          - name: valueType
            value: string
          - name: description
            value: string
    - name: metricKind
      value: string
    - name: valueType
      value: string
    - name: unit
      value: string
    - name: description
      value: string
    - name: displayName
      value: string
    - name: metadata
      value:
        - name: launchStage
          value: string
        - name: samplePeriod
          value: string
        - name: ingestDelay
          value: string
        - name: timeSeriesResourceHierarchyLevel
          value:
            - string
    - name: launchStage
      value: string
    - name: monitoredResourceTypes
      value:
        - string

`DELETE` example

Deletes the specified metric_descriptors resource.

/*+ delete */
DELETE FROM google.monitoring.metric_descriptors
WHERE metricDescriptorsId = '{{ metricDescriptorsId }}'
AND projectsId = '{{ projectsId }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​