Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.logging/v2.Metric
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a logs-based metric.
Create Metric Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Metric(name: string, args: MetricArgs, opts?: CustomResourceOptions);
@overload
def Metric(resource_name: str,
args: MetricArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Metric(resource_name: str,
opts: Optional[ResourceOptions] = None,
filter: Optional[str] = None,
bucket_name: Optional[str] = None,
bucket_options: Optional[BucketOptionsArgs] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
label_extractors: Optional[Mapping[str, str]] = None,
metric_descriptor: Optional[MetricDescriptorArgs] = None,
name: Optional[str] = None,
project: Optional[str] = None,
value_extractor: Optional[str] = None,
version: Optional[MetricVersion] = None)
func NewMetric(ctx *Context, name string, args MetricArgs, opts ...ResourceOption) (*Metric, error)
public Metric(string name, MetricArgs args, CustomResourceOptions? opts = null)
public Metric(String name, MetricArgs args)
public Metric(String name, MetricArgs args, CustomResourceOptions options)
type: google-native:logging/v2:Metric
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args MetricArgs
- 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 MetricArgs
- 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 MetricArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MetricArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MetricArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var metricResource = new GoogleNative.Logging.V2.Metric("metricResource", new()
{
Filter = "string",
BucketName = "string",
BucketOptions = new GoogleNative.Logging.V2.Inputs.BucketOptionsArgs
{
ExplicitBuckets = new GoogleNative.Logging.V2.Inputs.ExplicitArgs
{
Bounds = new[]
{
0,
},
},
ExponentialBuckets = new GoogleNative.Logging.V2.Inputs.ExponentialArgs
{
GrowthFactor = 0,
NumFiniteBuckets = 0,
Scale = 0,
},
LinearBuckets = new GoogleNative.Logging.V2.Inputs.LinearArgs
{
NumFiniteBuckets = 0,
Offset = 0,
Width = 0,
},
},
Description = "string",
Disabled = false,
LabelExtractors =
{
{ "string", "string" },
},
MetricDescriptor = new GoogleNative.Logging.V2.Inputs.MetricDescriptorArgs
{
Description = "string",
DisplayName = "string",
Labels = new[]
{
new GoogleNative.Logging.V2.Inputs.LabelDescriptorArgs
{
Description = "string",
Key = "string",
ValueType = GoogleNative.Logging.V2.LabelDescriptorValueType.String,
},
},
LaunchStage = GoogleNative.Logging.V2.MetricDescriptorLaunchStage.LaunchStageUnspecified,
Metadata = new GoogleNative.Logging.V2.Inputs.MetricDescriptorMetadataArgs
{
IngestDelay = "string",
SamplePeriod = "string",
},
MetricKind = GoogleNative.Logging.V2.MetricDescriptorMetricKind.MetricKindUnspecified,
MonitoredResourceTypes = new[]
{
"string",
},
Name = "string",
Type = "string",
Unit = "string",
ValueType = GoogleNative.Logging.V2.MetricDescriptorValueType.ValueTypeUnspecified,
},
Name = "string",
Project = "string",
ValueExtractor = "string",
});
example, err := logging.NewMetric(ctx, "metricResource", &logging.MetricArgs{
Filter: pulumi.String("string"),
BucketName: pulumi.String("string"),
BucketOptions: &logging.BucketOptionsArgs{
ExplicitBuckets: &logging.ExplicitArgs{
Bounds: pulumi.Float64Array{
pulumi.Float64(0),
},
},
ExponentialBuckets: &logging.ExponentialArgs{
GrowthFactor: pulumi.Float64(0),
NumFiniteBuckets: pulumi.Int(0),
Scale: pulumi.Float64(0),
},
LinearBuckets: &logging.LinearArgs{
NumFiniteBuckets: pulumi.Int(0),
Offset: pulumi.Float64(0),
Width: pulumi.Float64(0),
},
},
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
LabelExtractors: pulumi.StringMap{
"string": pulumi.String("string"),
},
MetricDescriptor: &logging.MetricDescriptorArgs{
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Labels: logging.LabelDescriptorArray{
&logging.LabelDescriptorArgs{
Description: pulumi.String("string"),
Key: pulumi.String("string"),
ValueType: logging.LabelDescriptorValueTypeString,
},
},
LaunchStage: logging.MetricDescriptorLaunchStageLaunchStageUnspecified,
Metadata: &logging.MetricDescriptorMetadataArgs{
IngestDelay: pulumi.String("string"),
SamplePeriod: pulumi.String("string"),
},
MetricKind: logging.MetricDescriptorMetricKindMetricKindUnspecified,
MonitoredResourceTypes: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Unit: pulumi.String("string"),
ValueType: logging.MetricDescriptorValueTypeValueTypeUnspecified,
},
Name: pulumi.String("string"),
Project: pulumi.String("string"),
ValueExtractor: pulumi.String("string"),
})
var metricResource = new Metric("metricResource", MetricArgs.builder()
.filter("string")
.bucketName("string")
.bucketOptions(BucketOptionsArgs.builder()
.explicitBuckets(ExplicitArgs.builder()
.bounds(0)
.build())
.exponentialBuckets(ExponentialArgs.builder()
.growthFactor(0)
.numFiniteBuckets(0)
.scale(0)
.build())
.linearBuckets(LinearArgs.builder()
.numFiniteBuckets(0)
.offset(0)
.width(0)
.build())
.build())
.description("string")
.disabled(false)
.labelExtractors(Map.of("string", "string"))
.metricDescriptor(MetricDescriptorArgs.builder()
.description("string")
.displayName("string")
.labels(LabelDescriptorArgs.builder()
.description("string")
.key("string")
.valueType("STRING")
.build())
.launchStage("LAUNCH_STAGE_UNSPECIFIED")
.metadata(MetricDescriptorMetadataArgs.builder()
.ingestDelay("string")
.samplePeriod("string")
.build())
.metricKind("METRIC_KIND_UNSPECIFIED")
.monitoredResourceTypes("string")
.name("string")
.type("string")
.unit("string")
.valueType("VALUE_TYPE_UNSPECIFIED")
.build())
.name("string")
.project("string")
.valueExtractor("string")
.build());
metric_resource = google_native.logging.v2.Metric("metricResource",
filter="string",
bucket_name="string",
bucket_options={
"explicit_buckets": {
"bounds": [0],
},
"exponential_buckets": {
"growth_factor": 0,
"num_finite_buckets": 0,
"scale": 0,
},
"linear_buckets": {
"num_finite_buckets": 0,
"offset": 0,
"width": 0,
},
},
description="string",
disabled=False,
label_extractors={
"string": "string",
},
metric_descriptor={
"description": "string",
"display_name": "string",
"labels": [{
"description": "string",
"key": "string",
"value_type": google_native.logging.v2.LabelDescriptorValueType.STRING,
}],
"launch_stage": google_native.logging.v2.MetricDescriptorLaunchStage.LAUNCH_STAGE_UNSPECIFIED,
"metadata": {
"ingest_delay": "string",
"sample_period": "string",
},
"metric_kind": google_native.logging.v2.MetricDescriptorMetricKind.METRIC_KIND_UNSPECIFIED,
"monitored_resource_types": ["string"],
"name": "string",
"type": "string",
"unit": "string",
"value_type": google_native.logging.v2.MetricDescriptorValueType.VALUE_TYPE_UNSPECIFIED,
},
name="string",
project="string",
value_extractor="string")
const metricResource = new google_native.logging.v2.Metric("metricResource", {
filter: "string",
bucketName: "string",
bucketOptions: {
explicitBuckets: {
bounds: [0],
},
exponentialBuckets: {
growthFactor: 0,
numFiniteBuckets: 0,
scale: 0,
},
linearBuckets: {
numFiniteBuckets: 0,
offset: 0,
width: 0,
},
},
description: "string",
disabled: false,
labelExtractors: {
string: "string",
},
metricDescriptor: {
description: "string",
displayName: "string",
labels: [{
description: "string",
key: "string",
valueType: google_native.logging.v2.LabelDescriptorValueType.String,
}],
launchStage: google_native.logging.v2.MetricDescriptorLaunchStage.LaunchStageUnspecified,
metadata: {
ingestDelay: "string",
samplePeriod: "string",
},
metricKind: google_native.logging.v2.MetricDescriptorMetricKind.MetricKindUnspecified,
monitoredResourceTypes: ["string"],
name: "string",
type: "string",
unit: "string",
valueType: google_native.logging.v2.MetricDescriptorValueType.ValueTypeUnspecified,
},
name: "string",
project: "string",
valueExtractor: "string",
});
type: google-native:logging/v2:Metric
properties:
bucketName: string
bucketOptions:
explicitBuckets:
bounds:
- 0
exponentialBuckets:
growthFactor: 0
numFiniteBuckets: 0
scale: 0
linearBuckets:
numFiniteBuckets: 0
offset: 0
width: 0
description: string
disabled: false
filter: string
labelExtractors:
string: string
metricDescriptor:
description: string
displayName: string
labels:
- description: string
key: string
valueType: STRING
launchStage: LAUNCH_STAGE_UNSPECIFIED
metadata:
ingestDelay: string
samplePeriod: string
metricKind: METRIC_KIND_UNSPECIFIED
monitoredResourceTypes:
- string
name: string
type: string
unit: string
valueType: VALUE_TYPE_UNSPECIFIED
name: string
project: string
valueExtractor: string
Metric Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Metric resource accepts the following input properties:
- Filter string
- An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
- Bucket
Name string - Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric.
- Bucket
Options Pulumi.Google Native. Logging. V2. Inputs. Bucket Options - Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.
- Description string
- Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
- Disabled bool
- Optional. If set to True, then this metric is disabled and it does not generate any points.
- Label
Extractors Dictionary<string, string> - Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.
- Metric
Descriptor Pulumi.Google Native. Logging. V2. Inputs. Metric Descriptor - Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.
- Name string
- The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests".
- Project string
- Value
Extractor string - Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
- Version
Pulumi.
Google Native. Logging. V2. Metric Version - Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
- Filter string
- An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
- Bucket
Name string - Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric.
- Bucket
Options BucketOptions Args - Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.
- Description string
- Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
- Disabled bool
- Optional. If set to True, then this metric is disabled and it does not generate any points.
- Label
Extractors map[string]string - Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.
- Metric
Descriptor MetricDescriptor Args - Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.
- Name string
- The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests".
- Project string
- Value
Extractor string - Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
- Version
Metric
Version - Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
- filter String
- An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
- bucket
Name String - Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric.
- bucket
Options BucketOptions - Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.
- description String
- Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
- disabled Boolean
- Optional. If set to True, then this metric is disabled and it does not generate any points.
- label
Extractors Map<String,String> - Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.
- metric
Descriptor MetricDescriptor - Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.
- name String
- The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests".
- project String
- value
Extractor String - Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
- version
Metric
Version - Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
- filter string
- An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
- bucket
Name string - Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric.
- bucket
Options BucketOptions - Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.
- description string
- Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
- disabled boolean
- Optional. If set to True, then this metric is disabled and it does not generate any points.
- label
Extractors {[key: string]: string} - Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.
- metric
Descriptor MetricDescriptor - Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.
- name string
- The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests".
- project string
- value
Extractor string - Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
- version
Metric
Version - Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
- filter str
- An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
- bucket_
name str - Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric.
- bucket_
options BucketOptions Args - Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.
- description str
- Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
- disabled bool
- Optional. If set to True, then this metric is disabled and it does not generate any points.
- label_
extractors Mapping[str, str] - Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.
- metric_
descriptor MetricDescriptor Args - Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.
- name str
- The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests".
- project str
- value_
extractor str - Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
- version
Metric
Version - Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
- filter String
- An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
- bucket
Name String - Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric.
- bucket
Options Property Map - Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.
- description String
- Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
- disabled Boolean
- Optional. If set to True, then this metric is disabled and it does not generate any points.
- label
Extractors Map<String> - Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.
- metric
Descriptor Property Map - Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.
- name String
- The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests".
- project String
- value
Extractor String - Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
- version "V2" | "V1"
- Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
Outputs
All input properties are implicitly available as output properties. Additionally, the Metric resource produces the following output properties:
- Create
Time string - The creation timestamp of the metric.This field may not be present for older metrics.
- Id string
- The provider-assigned unique ID for this managed resource.
- Update
Time string - The last update timestamp of the metric.This field may not be present for older metrics.
- Create
Time string - The creation timestamp of the metric.This field may not be present for older metrics.
- Id string
- The provider-assigned unique ID for this managed resource.
- Update
Time string - The last update timestamp of the metric.This field may not be present for older metrics.
- create
Time String - The creation timestamp of the metric.This field may not be present for older metrics.
- id String
- The provider-assigned unique ID for this managed resource.
- update
Time String - The last update timestamp of the metric.This field may not be present for older metrics.
- create
Time string - The creation timestamp of the metric.This field may not be present for older metrics.
- id string
- The provider-assigned unique ID for this managed resource.
- update
Time string - The last update timestamp of the metric.This field may not be present for older metrics.
- create_
time str - The creation timestamp of the metric.This field may not be present for older metrics.
- id str
- The provider-assigned unique ID for this managed resource.
- update_
time str - The last update timestamp of the metric.This field may not be present for older metrics.
- create
Time String - The creation timestamp of the metric.This field may not be present for older metrics.
- id String
- The provider-assigned unique ID for this managed resource.
- update
Time String - The last update timestamp of the metric.This field may not be present for older metrics.
Supporting Types
BucketOptions, BucketOptionsArgs
- Explicit
Buckets Pulumi.Google Native. Logging. V2. Inputs. Explicit - The explicit buckets.
- Exponential
Buckets Pulumi.Google Native. Logging. V2. Inputs. Exponential - The exponential buckets.
- Linear
Buckets Pulumi.Google Native. Logging. V2. Inputs. Linear - The linear bucket.
- Explicit
Buckets Explicit - The explicit buckets.
- Exponential
Buckets Exponential - The exponential buckets.
- Linear
Buckets Linear - The linear bucket.
- explicit
Buckets Explicit - The explicit buckets.
- exponential
Buckets Exponential - The exponential buckets.
- linear
Buckets Linear - The linear bucket.
- explicit
Buckets Explicit - The explicit buckets.
- exponential
Buckets Exponential - The exponential buckets.
- linear
Buckets Linear - The linear bucket.
- explicit_
buckets Explicit - The explicit buckets.
- exponential_
buckets Exponential - The exponential buckets.
- linear_
buckets Linear - The linear bucket.
- explicit
Buckets Property Map - The explicit buckets.
- exponential
Buckets Property Map - The exponential buckets.
- linear
Buckets Property Map - The linear bucket.
BucketOptionsResponse, BucketOptionsResponseArgs
- Explicit
Buckets Pulumi.Google Native. Logging. V2. Inputs. Explicit Response - The explicit buckets.
- Exponential
Buckets Pulumi.Google Native. Logging. V2. Inputs. Exponential Response - The exponential buckets.
- Linear
Buckets Pulumi.Google Native. Logging. V2. Inputs. Linear Response - The linear bucket.
- Explicit
Buckets ExplicitResponse - The explicit buckets.
- Exponential
Buckets ExponentialResponse - The exponential buckets.
- Linear
Buckets LinearResponse - The linear bucket.
- explicit
Buckets ExplicitResponse - The explicit buckets.
- exponential
Buckets ExponentialResponse - The exponential buckets.
- linear
Buckets LinearResponse - The linear bucket.
- explicit
Buckets ExplicitResponse - The explicit buckets.
- exponential
Buckets ExponentialResponse - The exponential buckets.
- linear
Buckets LinearResponse - The linear bucket.
- explicit_
buckets ExplicitResponse - The explicit buckets.
- exponential_
buckets ExponentialResponse - The exponential buckets.
- linear_
buckets LinearResponse - The linear bucket.
- explicit
Buckets Property Map - The explicit buckets.
- exponential
Buckets Property Map - The exponential buckets.
- linear
Buckets Property Map - The linear bucket.
Explicit, ExplicitArgs
- Bounds List<double>
- The values must be monotonically increasing.
- Bounds []float64
- The values must be monotonically increasing.
- bounds List<Double>
- The values must be monotonically increasing.
- bounds number[]
- The values must be monotonically increasing.
- bounds Sequence[float]
- The values must be monotonically increasing.
- bounds List<Number>
- The values must be monotonically increasing.
ExplicitResponse, ExplicitResponseArgs
- Bounds List<double>
- The values must be monotonically increasing.
- Bounds []float64
- The values must be monotonically increasing.
- bounds List<Double>
- The values must be monotonically increasing.
- bounds number[]
- The values must be monotonically increasing.
- bounds Sequence[float]
- The values must be monotonically increasing.
- bounds List<Number>
- The values must be monotonically increasing.
Exponential, ExponentialArgs
- Growth
Factor double - Must be greater than 1.
- Num
Finite intBuckets - Must be greater than 0.
- Scale double
- Must be greater than 0.
- Growth
Factor float64 - Must be greater than 1.
- Num
Finite intBuckets - Must be greater than 0.
- Scale float64
- Must be greater than 0.
- growth
Factor Double - Must be greater than 1.
- num
Finite IntegerBuckets - Must be greater than 0.
- scale Double
- Must be greater than 0.
- growth
Factor number - Must be greater than 1.
- num
Finite numberBuckets - Must be greater than 0.
- scale number
- Must be greater than 0.
- growth_
factor float - Must be greater than 1.
- num_
finite_ intbuckets - Must be greater than 0.
- scale float
- Must be greater than 0.
- growth
Factor Number - Must be greater than 1.
- num
Finite NumberBuckets - Must be greater than 0.
- scale Number
- Must be greater than 0.
ExponentialResponse, ExponentialResponseArgs
- Growth
Factor double - Must be greater than 1.
- Num
Finite intBuckets - Must be greater than 0.
- Scale double
- Must be greater than 0.
- Growth
Factor float64 - Must be greater than 1.
- Num
Finite intBuckets - Must be greater than 0.
- Scale float64
- Must be greater than 0.
- growth
Factor Double - Must be greater than 1.
- num
Finite IntegerBuckets - Must be greater than 0.
- scale Double
- Must be greater than 0.
- growth
Factor number - Must be greater than 1.
- num
Finite numberBuckets - Must be greater than 0.
- scale number
- Must be greater than 0.
- growth_
factor float - Must be greater than 1.
- num_
finite_ intbuckets - Must be greater than 0.
- scale float
- Must be greater than 0.
- growth
Factor Number - Must be greater than 1.
- num
Finite NumberBuckets - Must be greater than 0.
- scale Number
- Must be greater than 0.
LabelDescriptor, LabelDescriptorArgs
- Description string
- A human-readable description for the label.
- Key string
- The label key.
- Value
Type Pulumi.Google Native. Logging. V2. Label Descriptor Value Type - The type of data that can be assigned to the label.
- Description string
- A human-readable description for the label.
- Key string
- The label key.
- Value
Type LabelDescriptor Value Type - The type of data that can be assigned to the label.
- description String
- A human-readable description for the label.
- key String
- The label key.
- value
Type LabelDescriptor Value Type - The type of data that can be assigned to the label.
- description string
- A human-readable description for the label.
- key string
- The label key.
- value
Type LabelDescriptor Value Type - The type of data that can be assigned to the label.
- description str
- A human-readable description for the label.
- key str
- The label key.
- value_
type LabelDescriptor Value Type - The type of data that can be assigned to the label.
- description String
- A human-readable description for the label.
- key String
- The label key.
- value
Type "STRING" | "BOOL" | "INT64" - The type of data that can be assigned to the label.
LabelDescriptorResponse, LabelDescriptorResponseArgs
- Description string
- A human-readable description for the label.
- Key string
- The label key.
- Value
Type string - The type of data that can be assigned to the label.
- Description string
- A human-readable description for the label.
- Key string
- The label key.
- Value
Type string - The type of data that can be assigned to the label.
- description String
- A human-readable description for the label.
- key String
- The label key.
- value
Type String - The type of data that can be assigned to the label.
- description string
- A human-readable description for the label.
- key string
- The label key.
- value
Type string - The type of data that can be assigned to the label.
- description str
- A human-readable description for the label.
- key str
- The label key.
- 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 label key.
- value
Type String - The type of data that can be assigned to the label.
LabelDescriptorValueType, LabelDescriptorValueTypeArgs
- String
- STRINGA variable-length string. This is the default.
- Bool
- BOOLBoolean; true or false.
- Int64
- INT64A 64-bit signed integer.
- Label
Descriptor Value Type String - STRINGA variable-length string. This is the default.
- Label
Descriptor Value Type Bool - BOOLBoolean; true or false.
- Label
Descriptor Value Type Int64 - INT64A 64-bit signed integer.
- String
- STRINGA variable-length string. This is the default.
- Bool
- BOOLBoolean; true or false.
- Int64
- INT64A 64-bit signed integer.
- String
- STRINGA variable-length string. This is the default.
- Bool
- BOOLBoolean; true or false.
- Int64
- INT64A 64-bit signed integer.
- STRING
- STRINGA variable-length string. This is the default.
- BOOL
- BOOLBoolean; true or false.
- INT64
- INT64A 64-bit signed integer.
- "STRING"
- STRINGA variable-length string. This is the default.
- "BOOL"
- BOOLBoolean; true or false.
- "INT64"
- INT64A 64-bit signed integer.
Linear, LinearArgs
- Num
Finite intBuckets - Must be greater than 0.
- Offset double
- Lower bound of the first bucket.
- Width double
- Must be greater than 0.
- Num
Finite intBuckets - Must be greater than 0.
- Offset float64
- Lower bound of the first bucket.
- Width float64
- Must be greater than 0.
- num
Finite IntegerBuckets - Must be greater than 0.
- offset Double
- Lower bound of the first bucket.
- width Double
- Must be greater than 0.
- num
Finite numberBuckets - Must be greater than 0.
- offset number
- Lower bound of the first bucket.
- width number
- Must be greater than 0.
- num_
finite_ intbuckets - Must be greater than 0.
- offset float
- Lower bound of the first bucket.
- width float
- Must be greater than 0.
- num
Finite NumberBuckets - Must be greater than 0.
- offset Number
- Lower bound of the first bucket.
- width Number
- Must be greater than 0.
LinearResponse, LinearResponseArgs
- Num
Finite intBuckets - Must be greater than 0.
- Offset double
- Lower bound of the first bucket.
- Width double
- Must be greater than 0.
- Num
Finite intBuckets - Must be greater than 0.
- Offset float64
- Lower bound of the first bucket.
- Width float64
- Must be greater than 0.
- num
Finite IntegerBuckets - Must be greater than 0.
- offset Double
- Lower bound of the first bucket.
- width Double
- Must be greater than 0.
- num
Finite numberBuckets - Must be greater than 0.
- offset number
- Lower bound of the first bucket.
- width number
- Must be greater than 0.
- num_
finite_ intbuckets - Must be greater than 0.
- offset float
- Lower bound of the first bucket.
- width float
- Must be greater than 0.
- num
Finite NumberBuckets - Must be greater than 0.
- offset Number
- Lower bound of the first bucket.
- width Number
- Must be greater than 0.
MetricDescriptor, MetricDescriptorArgs
- Description string
- A detailed description of the metric, which can be used in documentation.
- Display
Name 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.
Google Native. Logging. V2. Inputs. Label Descriptor> - 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 Pulumi.Google Native. Logging. V2. Metric Descriptor Launch Stage - Optional. The launch stage of the metric definition.
- Metadata
Pulumi.
Google Native. Logging. V2. Inputs. Metric Descriptor Metadata - Optional. Metadata which can be used to guide usage of the metric.
- Metric
Kind Pulumi.Google Native. Logging. V2. Metric Descriptor Metric Kind - 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 List<string>Types - 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.
- 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").
- Value
Type Pulumi.Google Native. Logging. V2. Metric Descriptor Value Type - 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.
- Display
Name 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
[]Label
Descriptor - 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 MetricDescriptor Launch Stage - Optional. The launch stage of the metric definition.
- Metadata
Metric
Descriptor Metadata - Optional. Metadata which can be used to guide usage of the metric.
- Metric
Kind MetricDescriptor Metric Kind - 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 []stringTypes - 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.
- 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").
- Value
Type MetricDescriptor Value Type - 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.
- display
Name 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<Label
Descriptor> - 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 MetricDescriptor Launch Stage - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata - Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind MetricDescriptor Metric Kind - 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 List<String>Types - 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.
- 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").
- value
Type MetricDescriptor Value Type - 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.
- display
Name 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
Label
Descriptor[] - 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 MetricDescriptor Launch Stage - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata - Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind MetricDescriptor Metric Kind - 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 string[]Types - 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.
- 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").
- value
Type MetricDescriptor Value Type - 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[Label
Descriptor] - 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 MetricDescriptor Launch Stage - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata - Optional. Metadata which can be used to guide usage of the metric.
- metric_
kind MetricDescriptor Metric Kind - 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_ Sequence[str]types - 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.
- 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 MetricDescriptor Value Type - 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.
- display
Name 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.
- launch
Stage "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.
- metric
Kind "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.
- monitored
Resource List<String>Types - 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.
- 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").
- value
Type "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.
MetricDescriptorLaunchStage, MetricDescriptorLaunchStageArgs
- Launch
Stage Unspecified - LAUNCH_STAGE_UNSPECIFIEDDo not use this default value.
- Unimplemented
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- Prelaunch
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- Early
Access - EARLY_ACCESSEarly 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
- ALPHAAlpha 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
- BETABeta 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
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- Deprecated
- DEPRECATEDDeprecated 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.
- Metric
Descriptor Launch Stage Launch Stage Unspecified - LAUNCH_STAGE_UNSPECIFIEDDo not use this default value.
- Metric
Descriptor Launch Stage Unimplemented - UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- Metric
Descriptor Launch Stage Prelaunch - PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- Metric
Descriptor Launch Stage Early Access - EARLY_ACCESSEarly 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.
- Metric
Descriptor Launch Stage Alpha - ALPHAAlpha 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.
- Metric
Descriptor Launch Stage Beta - BETABeta 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.
- Metric
Descriptor Launch Stage Ga - GAGA features are open to all developers and are considered stable and fully qualified for production use.
- Metric
Descriptor Launch Stage Deprecated - DEPRECATEDDeprecated 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_UNSPECIFIEDDo not use this default value.
- Unimplemented
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- Prelaunch
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- Early
Access - EARLY_ACCESSEarly 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
- ALPHAAlpha 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
- BETABeta 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
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- Deprecated
- DEPRECATEDDeprecated 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_UNSPECIFIEDDo not use this default value.
- Unimplemented
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- Prelaunch
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- Early
Access - EARLY_ACCESSEarly 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
- ALPHAAlpha 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
- BETABeta 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
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- Deprecated
- DEPRECATEDDeprecated 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_UNSPECIFIEDDo not use this default value.
- UNIMPLEMENTED
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- PRELAUNCH
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- EARLY_ACCESS
- EARLY_ACCESSEarly 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
- ALPHAAlpha 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
- BETABeta 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
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- DEPRECATED
- DEPRECATEDDeprecated 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_UNSPECIFIEDDo not use this default value.
- "UNIMPLEMENTED"
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- "PRELAUNCH"
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- "EARLY_ACCESS"
- EARLY_ACCESSEarly 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"
- ALPHAAlpha 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"
- BETABeta 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"
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- "DEPRECATED"
- DEPRECATEDDeprecated 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, MetricDescriptorMetadataArgs
- Ingest
Delay 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.
- Launch
Stage Pulumi.Google Native. Logging. V2. Metric Descriptor Metadata Launch Stage - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- Sample
Period 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.
- Ingest
Delay 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.
- Launch
Stage MetricDescriptor Metadata Launch Stage - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- Sample
Period 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.
- ingest
Delay 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.
- launch
Stage MetricDescriptor Metadata Launch Stage - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period 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.
- ingest
Delay 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.
- launch
Stage MetricDescriptor Metadata Launch Stage - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period 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.
- 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 MetricDescriptor Metadata Launch Stage - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample_
period str - 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.
- ingest
Delay 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.
- launch
Stage "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED" - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period 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.
MetricDescriptorMetadataLaunchStage, MetricDescriptorMetadataLaunchStageArgs
- Launch
Stage Unspecified - LAUNCH_STAGE_UNSPECIFIEDDo not use this default value.
- Unimplemented
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- Prelaunch
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- Early
Access - EARLY_ACCESSEarly 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
- ALPHAAlpha 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
- BETABeta 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
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- Deprecated
- DEPRECATEDDeprecated 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.
- Metric
Descriptor Metadata Launch Stage Launch Stage Unspecified - LAUNCH_STAGE_UNSPECIFIEDDo not use this default value.
- Metric
Descriptor Metadata Launch Stage Unimplemented - UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- Metric
Descriptor Metadata Launch Stage Prelaunch - PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- Metric
Descriptor Metadata Launch Stage Early Access - EARLY_ACCESSEarly 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.
- Metric
Descriptor Metadata Launch Stage Alpha - ALPHAAlpha 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.
- Metric
Descriptor Metadata Launch Stage Beta - BETABeta 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.
- Metric
Descriptor Metadata Launch Stage Ga - GAGA features are open to all developers and are considered stable and fully qualified for production use.
- Metric
Descriptor Metadata Launch Stage Deprecated - DEPRECATEDDeprecated 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_UNSPECIFIEDDo not use this default value.
- Unimplemented
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- Prelaunch
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- Early
Access - EARLY_ACCESSEarly 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
- ALPHAAlpha 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
- BETABeta 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
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- Deprecated
- DEPRECATEDDeprecated 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_UNSPECIFIEDDo not use this default value.
- Unimplemented
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- Prelaunch
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- Early
Access - EARLY_ACCESSEarly 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
- ALPHAAlpha 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
- BETABeta 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
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- Deprecated
- DEPRECATEDDeprecated 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_UNSPECIFIEDDo not use this default value.
- UNIMPLEMENTED
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- PRELAUNCH
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- EARLY_ACCESS
- EARLY_ACCESSEarly 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
- ALPHAAlpha 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
- BETABeta 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
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- DEPRECATED
- DEPRECATEDDeprecated 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_UNSPECIFIEDDo not use this default value.
- "UNIMPLEMENTED"
- UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
- "PRELAUNCH"
- PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
- "EARLY_ACCESS"
- EARLY_ACCESSEarly 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"
- ALPHAAlpha 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"
- BETABeta 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"
- GAGA features are open to all developers and are considered stable and fully qualified for production use.
- "DEPRECATED"
- DEPRECATEDDeprecated 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, MetricDescriptorMetadataResponseArgs
- Ingest
Delay 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.
- Launch
Stage string - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- Sample
Period 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.
- Ingest
Delay 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.
- Launch
Stage string - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- Sample
Period 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.
- ingest
Delay 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.
- launch
Stage String - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period 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.
- ingest
Delay 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.
- launch
Stage string - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period 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.
- 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.
- sample_
period str - 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.
- ingest
Delay 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.
- launch
Stage String - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period 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.
MetricDescriptorMetricKind, MetricDescriptorMetricKindArgs
- Metric
Kind Unspecified - METRIC_KIND_UNSPECIFIEDDo not use this default value.
- Gauge
- GAUGEAn instantaneous measurement of a value.
- Delta
- DELTAThe change in a value during a time interval.
- Cumulative
- CUMULATIVEA 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
Descriptor Metric Kind Metric Kind Unspecified - METRIC_KIND_UNSPECIFIEDDo not use this default value.
- Metric
Descriptor Metric Kind Gauge - GAUGEAn instantaneous measurement of a value.
- Metric
Descriptor Metric Kind Delta - DELTAThe change in a value during a time interval.
- Metric
Descriptor Metric Kind Cumulative - CUMULATIVEA 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_UNSPECIFIEDDo not use this default value.
- Gauge
- GAUGEAn instantaneous measurement of a value.
- Delta
- DELTAThe change in a value during a time interval.
- Cumulative
- CUMULATIVEA 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_UNSPECIFIEDDo not use this default value.
- Gauge
- GAUGEAn instantaneous measurement of a value.
- Delta
- DELTAThe change in a value during a time interval.
- Cumulative
- CUMULATIVEA 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_UNSPECIFIEDDo not use this default value.
- GAUGE
- GAUGEAn instantaneous measurement of a value.
- DELTA
- DELTAThe change in a value during a time interval.
- CUMULATIVE
- CUMULATIVEA 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_UNSPECIFIEDDo not use this default value.
- "GAUGE"
- GAUGEAn instantaneous measurement of a value.
- "DELTA"
- DELTAThe change in a value during a time interval.
- "CUMULATIVE"
- CUMULATIVEA 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.
MetricDescriptorResponse, MetricDescriptorResponseArgs
- Description string
- A detailed description of the metric, which can be used in documentation.
- Display
Name 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.
Google Native. Logging. V2. Inputs. Label Descriptor Response> - 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 string - Optional. The launch stage of the metric definition.
- Metadata
Pulumi.
Google Native. Logging. V2. Inputs. Metric Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- Metric
Kind string - 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 List<string>Types - 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.
- 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").
- Value
Type string - 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.
- Display
Name 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
[]Label
Descriptor Response - 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 string - Optional. The launch stage of the metric definition.
- Metadata
Metric
Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- Metric
Kind string - 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 []stringTypes - 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.
- 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").
- Value
Type string - 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.
- display
Name 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<Label
Descriptor Response> - 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 String - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind String - 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 List<String>Types - 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.
- 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").
- value
Type String - 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.
- display
Name 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
Label
Descriptor Response[] - 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 string - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind string - 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 string[]Types - 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.
- 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").
- value
Type string - 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[Label
Descriptor Response] - 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 str - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- metric_
kind str - 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_ Sequence[str]types - 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.
- 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 str - 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.
- display
Name 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.
- launch
Stage String - Optional. The launch stage of the metric definition.
- metadata Property Map
- Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind String - 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 List<String>Types - 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.
- 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").
- value
Type String - Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
MetricDescriptorValueType, MetricDescriptorValueTypeArgs
- Value
Type Unspecified - VALUE_TYPE_UNSPECIFIEDDo not use this default value.
- Bool
- BOOLThe value is a boolean. This value type can be used only if the metric kind is GAUGE.
- Int64
- INT64The value is a signed 64-bit integer.
- Double
- DOUBLEThe value is a double precision floating point number.
- String
- STRINGThe value is a text string. This value type can be used only if the metric kind is GAUGE.
- Distribution
- DISTRIBUTIONThe value is a Distribution.
- Money
- MONEYThe value is money.
- Metric
Descriptor Value Type Value Type Unspecified - VALUE_TYPE_UNSPECIFIEDDo not use this default value.
- Metric
Descriptor Value Type Bool - BOOLThe value is a boolean. This value type can be used only if the metric kind is GAUGE.
- Metric
Descriptor Value Type Int64 - INT64The value is a signed 64-bit integer.
- Metric
Descriptor Value Type Double - DOUBLEThe value is a double precision floating point number.
- Metric
Descriptor Value Type String - STRINGThe value is a text string. This value type can be used only if the metric kind is GAUGE.
- Metric
Descriptor Value Type Distribution - DISTRIBUTIONThe value is a Distribution.
- Metric
Descriptor Value Type Money - MONEYThe value is money.
- Value
Type Unspecified - VALUE_TYPE_UNSPECIFIEDDo not use this default value.
- Bool
- BOOLThe value is a boolean. This value type can be used only if the metric kind is GAUGE.
- Int64
- INT64The value is a signed 64-bit integer.
- Double
- DOUBLEThe value is a double precision floating point number.
- String
- STRINGThe value is a text string. This value type can be used only if the metric kind is GAUGE.
- Distribution
- DISTRIBUTIONThe value is a Distribution.
- Money
- MONEYThe value is money.
- Value
Type Unspecified - VALUE_TYPE_UNSPECIFIEDDo not use this default value.
- Bool
- BOOLThe value is a boolean. This value type can be used only if the metric kind is GAUGE.
- Int64
- INT64The value is a signed 64-bit integer.
- Double
- DOUBLEThe value is a double precision floating point number.
- String
- STRINGThe value is a text string. This value type can be used only if the metric kind is GAUGE.
- Distribution
- DISTRIBUTIONThe value is a Distribution.
- Money
- MONEYThe value is money.
- VALUE_TYPE_UNSPECIFIED
- VALUE_TYPE_UNSPECIFIEDDo not use this default value.
- BOOL
- BOOLThe value is a boolean. This value type can be used only if the metric kind is GAUGE.
- INT64
- INT64The value is a signed 64-bit integer.
- DOUBLE
- DOUBLEThe value is a double precision floating point number.
- STRING
- STRINGThe value is a text string. This value type can be used only if the metric kind is GAUGE.
- DISTRIBUTION
- DISTRIBUTIONThe value is a Distribution.
- MONEY
- MONEYThe value is money.
- "VALUE_TYPE_UNSPECIFIED"
- VALUE_TYPE_UNSPECIFIEDDo not use this default value.
- "BOOL"
- BOOLThe value is a boolean. This value type can be used only if the metric kind is GAUGE.
- "INT64"
- INT64The value is a signed 64-bit integer.
- "DOUBLE"
- DOUBLEThe value is a double precision floating point number.
- "STRING"
- STRINGThe value is a text string. This value type can be used only if the metric kind is GAUGE.
- "DISTRIBUTION"
- DISTRIBUTIONThe value is a Distribution.
- "MONEY"
- MONEYThe value is money.
MetricVersion, MetricVersionArgs
- V2
- V2Logging API v2.
- V1
- V1Logging API v1.
- Metric
Version V2 - V2Logging API v2.
- Metric
Version V1 - V1Logging API v1.
- V2
- V2Logging API v2.
- V1
- V1Logging API v1.
- V2
- V2Logging API v2.
- V1
- V1Logging API v1.
- V2
- V2Logging API v2.
- V1
- V1Logging API v1.
- "V2"
- V2Logging API v2.
- "V1"
- V1Logging API v1.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.