Google Cloud Native v0.28.0, Feb 2 23

google-native.monitoring/v3.MetricDescriptor

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.

Create MetricDescriptor Resource

new MetricDescriptor(name: string, args?: MetricDescriptorArgs, opts?: CustomResourceOptions);

@overload
def MetricDescriptor(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     display_name: Optional[str] = None,
                     labels: Optional[Sequence[LabelDescriptorArgs]] = None,
                     launch_stage: Optional[MetricDescriptorLaunchStage] = None,
                     metadata: Optional[MetricDescriptorMetadataArgs] = None,
                     metric_kind: Optional[MetricDescriptorMetricKind] = None,
                     monitored_resource_types: Optional[Sequence[str]] = None,
                     name: Optional[str] = None,
                     project: Optional[str] = None,
                     type: Optional[str] = None,
                     unit: Optional[str] = None,
                     value_type: Optional[MetricDescriptorValueType] = None)
@overload
def MetricDescriptor(resource_name: str,
                     args: Optional[MetricDescriptorArgs] = None,
                     opts: Optional[ResourceOptions] = None)

func NewMetricDescriptor(ctx *Context, name string, args *MetricDescriptorArgs, opts ...ResourceOption) (*MetricDescriptor, error)

public MetricDescriptor(string name, MetricDescriptorArgs? args = null, CustomResourceOptions? opts = null)

public MetricDescriptor(String name, MetricDescriptorArgs args)
public MetricDescriptor(String name, MetricDescriptorArgs args, CustomResourceOptions options)

type: google-native:monitoring/v3:MetricDescriptor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MetricDescriptorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args MetricDescriptorArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MetricDescriptorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MetricDescriptorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MetricDescriptorArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

MetricDescriptor Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The MetricDescriptor resource accepts the following input properties:

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 List<Pulumi.GoogleNative.Monitoring.V3.Inputs.LabelDescriptorArgs>: 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 Pulumi.GoogleNative.Monitoring.V3.MetricDescriptorLaunchStage: Optional. The launch stage of the metric definition.
Metadata Pulumi.GoogleNative.Monitoring.V3.Inputs.MetricDescriptorMetadataArgs: Optional. Metadata which can be used to guide usage of the metric.
MetricKind Pulumi.GoogleNative.Monitoring.V3.MetricDescriptorMetricKind: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
MonitoredResourceTypes List<string>: 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.
Name string: The resource name of the metric descriptor.
Project string
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 | "%" ) [ 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").
ValueType Pulumi.GoogleNative.Monitoring.V3.MetricDescriptorValueType: Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

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 []LabelDescriptorArgs: 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 MetricDescriptorLaunchStage: Optional. The launch stage of the metric definition.
Metadata MetricDescriptorMetadataArgs: Optional. Metadata which can be used to guide usage of the metric.
MetricKind MetricDescriptorMetricKind: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
MonitoredResourceTypes []string: 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.
Name string: The resource name of the metric descriptor.
Project string
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 | "%" ) [ 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").
ValueType MetricDescriptorValueType: Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

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 List<LabelDescriptorArgs>: 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 MetricDescriptorLaunchStage: Optional. The launch stage of the metric definition.
metadata MetricDescriptorMetadataArgs: Optional. Metadata which can be used to guide usage of the metric.
metricKind MetricDescriptorMetricKind: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes List<String>: 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.
name String: The resource name of the metric descriptor.
project String
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 | "%" ) [ 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").
valueType MetricDescriptorValueType: Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

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 LabelDescriptorArgs[]: 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 MetricDescriptorLaunchStage: Optional. The launch stage of the metric definition.
metadata MetricDescriptorMetadataArgs: Optional. Metadata which can be used to guide usage of the metric.
metricKind MetricDescriptorMetricKind: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes string[]: 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.
name string: The resource name of the metric descriptor.
project string
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 | "%" ) [ 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").
valueType MetricDescriptorValueType: Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description str: A detailed description of the metric, which can be used in documentation.
display_name str: 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 Sequence[LabelDescriptorArgs]: 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.
launch_stage MetricDescriptorLaunchStage: Optional. The launch stage of the metric definition.
metadata MetricDescriptorMetadataArgs: Optional. Metadata which can be used to guide usage of the metric.
metric_kind MetricDescriptorMetricKind: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitored_resource_types Sequence[str]: 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.
name str: The resource name of the metric descriptor.
project str
type str: 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 str: 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 | "%" ) [ 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").
value_type MetricDescriptorValueType: Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

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 List<Property Map>: 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 "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED": Optional. The launch stage of the metric definition.
metadata Property Map: Optional. Metadata which can be used to guide usage of the metric.
metricKind "METRIC_KIND_UNSPECIFIED" | "GAUGE" | "DELTA" | "CUMULATIVE": Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes List<String>: 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.
name String: The resource name of the metric descriptor.
project String
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 | "%" ) [ 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").
valueType "VALUE_TYPE_UNSPECIFIED" | "BOOL" | "INT64" | "DOUBLE" | "STRING" | "DISTRIBUTION" | "MONEY": Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

Outputs

All input properties are implicitly available as output properties. Additionally, the MetricDescriptor resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Supporting Types

LabelDescriptor

Description string: A human-readable description for the label.
Key string: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
ValueType Pulumi.GoogleNative.Monitoring.V3.LabelDescriptorValueType: The type of data that can be assigned to the label.

Description string: A human-readable description for the label.
Key string: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
ValueType LabelDescriptorValueType: The type of data that can be assigned to the label.

description String: A human-readable description for the label.
key String: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
valueType LabelDescriptorValueType: The type of data that can be assigned to the label.

description string: A human-readable description for the label.
key string: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
valueType LabelDescriptorValueType: The type of data that can be assigned to the label.

description str: A human-readable description for the label.
key str: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
value_type LabelDescriptorValueType: The type of data that can be assigned to the label.

description String: A human-readable description for the label.
key String: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
valueType "STRING" | "BOOL" | "INT64": The type of data that can be assigned to the label.

LabelDescriptorResponse

Description string: A human-readable description for the label.
Key string: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
ValueType string: The type of data that can be assigned to the label.

Description string: A human-readable description for the label.
Key string: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
ValueType string: The type of data that can be assigned to the label.

description String: A human-readable description for the label.
key String: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
valueType String: The type of data that can be assigned to the label.

description string: A human-readable description for the label.
key string: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
valueType string: The type of data that can be assigned to the label.

description str: A human-readable description for the label.
key str: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
value_type str: The type of data that can be assigned to the label.

description String: A human-readable description for the label.
key String: The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
valueType String: The type of data that can be assigned to the label.

LabelDescriptorValueType

String: STRING
A variable-length string, not to exceed 1,024 characters. This is the default value type.
Bool: BOOL
Boolean; true or false.
Int64: INT64
A 64-bit signed integer.

LabelDescriptorValueTypeString: STRING
A variable-length string, not to exceed 1,024 characters. This is the default value type.
LabelDescriptorValueTypeBool: BOOL
Boolean; true or false.
LabelDescriptorValueTypeInt64: INT64
A 64-bit signed integer.

String: STRING
A variable-length string, not to exceed 1,024 characters. This is the default value type.
Bool: BOOL
Boolean; true or false.
Int64: INT64
A 64-bit signed integer.

String: STRING
A variable-length string, not to exceed 1,024 characters. This is the default value type.
Bool: BOOL
Boolean; true or false.
Int64: INT64
A 64-bit signed integer.

STRING: STRING
A variable-length string, not to exceed 1,024 characters. This is the default value type.
BOOL: BOOL
Boolean; true or false.
INT64: INT64
A 64-bit signed integer.

"STRING": STRING
A variable-length string, not to exceed 1,024 characters. This is the default value type.
"BOOL": BOOL
Boolean; true or false.
"INT64": INT64
A 64-bit signed integer.

MetricDescriptorLaunchStage

LaunchStageUnspecified: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
Unimplemented: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
Prelaunch: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
EarlyAccess: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
Alpha: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
Beta: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
Ga: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
Deprecated: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

MetricDescriptorLaunchStageLaunchStageUnspecified: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
MetricDescriptorLaunchStageUnimplemented: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
MetricDescriptorLaunchStagePrelaunch: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
MetricDescriptorLaunchStageEarlyAccess: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
MetricDescriptorLaunchStageAlpha: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
MetricDescriptorLaunchStageBeta: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
MetricDescriptorLaunchStageGa: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
MetricDescriptorLaunchStageDeprecated: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

LaunchStageUnspecified: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
Unimplemented: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
Prelaunch: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
EarlyAccess: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
Alpha: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
Beta: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
Ga: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
Deprecated: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

LaunchStageUnspecified: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
Unimplemented: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
Prelaunch: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
EarlyAccess: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
Alpha: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
Beta: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
Ga: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
Deprecated: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

LAUNCH_STAGE_UNSPECIFIED: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
UNIMPLEMENTED: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
PRELAUNCH: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
EARLY_ACCESS: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
ALPHA: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
BETA: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
GA: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
DEPRECATED: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

"LAUNCH_STAGE_UNSPECIFIED": LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
"UNIMPLEMENTED": UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
"PRELAUNCH": PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
"EARLY_ACCESS": EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
"ALPHA": ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
"BETA": BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
"GA": GA
GA features are open to all developers and are considered stable and fully qualified for production use.
"DEPRECATED": DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

MetricDescriptorMetadata

IngestDelay string

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.

LaunchStage Pulumi.GoogleNative.Monitoring.V3.MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string

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.

IngestDelay string

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.

LaunchStage MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string

ingestDelay String

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.

launchStage MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String

ingestDelay string

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.

launchStage MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod string

ingest_delay str

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.

launch_stage MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

sample_period str

ingestDelay String

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.

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String

MetricDescriptorMetadataLaunchStage

LaunchStageUnspecified: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
Unimplemented: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
Prelaunch: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
EarlyAccess: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
Alpha: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
Beta: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
Ga: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
Deprecated: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

MetricDescriptorMetadataLaunchStageLaunchStageUnspecified: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
MetricDescriptorMetadataLaunchStageUnimplemented: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
MetricDescriptorMetadataLaunchStagePrelaunch: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
MetricDescriptorMetadataLaunchStageEarlyAccess: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
MetricDescriptorMetadataLaunchStageAlpha: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
MetricDescriptorMetadataLaunchStageBeta: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
MetricDescriptorMetadataLaunchStageGa: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
MetricDescriptorMetadataLaunchStageDeprecated: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

LaunchStageUnspecified: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
Unimplemented: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
Prelaunch: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
EarlyAccess: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
Alpha: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
Beta: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
Ga: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
Deprecated: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

LaunchStageUnspecified: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
Unimplemented: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
Prelaunch: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
EarlyAccess: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
Alpha: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
Beta: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
Ga: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
Deprecated: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

LAUNCH_STAGE_UNSPECIFIED: LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
UNIMPLEMENTED: UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
PRELAUNCH: PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
EARLY_ACCESS: EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
ALPHA: ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
BETA: BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
GA: GA
GA features are open to all developers and are considered stable and fully qualified for production use.
DEPRECATED: DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

"LAUNCH_STAGE_UNSPECIFIED": LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
"UNIMPLEMENTED": UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
"PRELAUNCH": PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
"EARLY_ACCESS": EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
"ALPHA": ALPHA
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
"BETA": BETA
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
"GA": GA
GA features are open to all developers and are considered stable and fully qualified for production use.
"DEPRECATED": DEPRECATED
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.

MetricDescriptorMetadataResponse

IngestDelay string

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.

LaunchStage string

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string

IngestDelay string

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.

LaunchStage string

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string

ingestDelay String

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.

launchStage String

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String

ingestDelay string

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.

launchStage string

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod string

ingest_delay str

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.

launch_stage str

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

sample_period str

ingestDelay String

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.

launchStage String

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String

MetricDescriptorMetricKind

MetricKindUnspecified: METRIC_KIND_UNSPECIFIED
Do not use this default value.
Gauge: GAUGE
An instantaneous measurement of a value.
Delta: DELTA
The change in a value during a time interval.
Cumulative: 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.

MetricDescriptorMetricKindMetricKindUnspecified: METRIC_KIND_UNSPECIFIED
Do not use this default value.
MetricDescriptorMetricKindGauge: GAUGE
An instantaneous measurement of a value.
MetricDescriptorMetricKindDelta: DELTA
The change in a value during a time interval.
MetricDescriptorMetricKindCumulative: 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.

MetricKindUnspecified: METRIC_KIND_UNSPECIFIED
Do not use this default value.
Gauge: GAUGE
An instantaneous measurement of a value.
Delta: DELTA
The change in a value during a time interval.
Cumulative: 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.

MetricKindUnspecified: METRIC_KIND_UNSPECIFIED
Do not use this default value.
Gauge: GAUGE
An instantaneous measurement of a value.
Delta: DELTA
The change in a value during a time interval.
Cumulative: 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.

METRIC_KIND_UNSPECIFIED: METRIC_KIND_UNSPECIFIED
Do not use this default value.
GAUGE: GAUGE
An instantaneous measurement of a value.
DELTA: DELTA
The change in a value during a time interval.
CUMULATIVE: 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.

"METRIC_KIND_UNSPECIFIED": METRIC_KIND_UNSPECIFIED
Do not use this default value.
"GAUGE": GAUGE
An instantaneous measurement of a value.
"DELTA": DELTA
The change in a value during a time interval.
"CUMULATIVE": 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.

MetricDescriptorValueType

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

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

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

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

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

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

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

google-native.monitoring/v3.MetricDescriptor

Create MetricDescriptor Resource

MetricDescriptor Resource Properties

Inputs

Outputs

Supporting Types

LabelDescriptor

LabelDescriptorResponse

LabelDescriptorValueType

MetricDescriptorLaunchStage

MetricDescriptorMetadata

MetricDescriptorMetadataLaunchStage

MetricDescriptorMetadataResponse

MetricDescriptorMetricKind

MetricDescriptorValueType

Package Details

Contents