Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. logging
  5. logging/v2
  6. Metric

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.logging/v2.Metric

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

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 This property is required. string
The unique name of the resource.
args This property is required. MetricArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. MetricArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MetricArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
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());
Copy
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")
Copy
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",
});
Copy
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
Copy

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 This property is required. 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.
BucketName 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.
BucketOptions Pulumi.GoogleNative.Logging.V2.Inputs.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 bool
Optional. If set to True, then this metric is disabled and it does not generate any points.
LabelExtractors 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.
MetricDescriptor Pulumi.GoogleNative.Logging.V2.Inputs.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 Changes to this property will trigger replacement. string
ValueExtractor 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.GoogleNative.Logging.V2.MetricVersion
Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

Deprecated: Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

Filter This property is required. 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.
BucketName 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.
BucketOptions BucketOptionsArgs
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.
LabelExtractors 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.
MetricDescriptor MetricDescriptorArgs
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 Changes to this property will trigger replacement. string
ValueExtractor 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 MetricVersion
Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

Deprecated: Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

filter This property is required. 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.
bucketName 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.
bucketOptions 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.
labelExtractors 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.
metricDescriptor 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 Changes to this property will trigger replacement. String
valueExtractor 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 MetricVersion
Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

Deprecated: Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

filter This property is required. 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.
bucketName 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.
bucketOptions 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.
labelExtractors {[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.
metricDescriptor 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 Changes to this property will trigger replacement. string
valueExtractor 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 MetricVersion
Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

Deprecated: Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

filter This property is required. 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 BucketOptionsArgs
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 MetricDescriptorArgs
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 Changes to this property will trigger replacement. 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 MetricVersion
Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

Deprecated: Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

filter This property is required. 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.
bucketName 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.
bucketOptions 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.
labelExtractors 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.
metricDescriptor 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 Changes to this property will trigger replacement. String
valueExtractor 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.

Deprecated: 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:

CreateTime 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.
UpdateTime string
The last update timestamp of the metric.This field may not be present for older metrics.
CreateTime 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.
UpdateTime string
The last update timestamp of the metric.This field may not be present for older metrics.
createTime 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.
updateTime String
The last update timestamp of the metric.This field may not be present for older metrics.
createTime 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.
updateTime 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.
createTime 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.
updateTime String
The last update timestamp of the metric.This field may not be present for older metrics.

Supporting Types

BucketOptions
, BucketOptionsArgs

ExplicitBuckets Explicit
The explicit buckets.
ExponentialBuckets Exponential
The exponential buckets.
LinearBuckets Linear
The linear bucket.
explicitBuckets Explicit
The explicit buckets.
exponentialBuckets Exponential
The exponential buckets.
linearBuckets Linear
The linear bucket.
explicitBuckets Explicit
The explicit buckets.
exponentialBuckets Exponential
The exponential buckets.
linearBuckets Linear
The linear bucket.
explicit_buckets Explicit
The explicit buckets.
exponential_buckets Exponential
The exponential buckets.
linear_buckets Linear
The linear bucket.
explicitBuckets Property Map
The explicit buckets.
exponentialBuckets Property Map
The exponential buckets.
linearBuckets Property Map
The linear bucket.

BucketOptionsResponse
, BucketOptionsResponseArgs

ExplicitBuckets This property is required. Pulumi.GoogleNative.Logging.V2.Inputs.ExplicitResponse
The explicit buckets.
ExponentialBuckets This property is required. Pulumi.GoogleNative.Logging.V2.Inputs.ExponentialResponse
The exponential buckets.
LinearBuckets This property is required. Pulumi.GoogleNative.Logging.V2.Inputs.LinearResponse
The linear bucket.
ExplicitBuckets This property is required. ExplicitResponse
The explicit buckets.
ExponentialBuckets This property is required. ExponentialResponse
The exponential buckets.
LinearBuckets This property is required. LinearResponse
The linear bucket.
explicitBuckets This property is required. ExplicitResponse
The explicit buckets.
exponentialBuckets This property is required. ExponentialResponse
The exponential buckets.
linearBuckets This property is required. LinearResponse
The linear bucket.
explicitBuckets This property is required. ExplicitResponse
The explicit buckets.
exponentialBuckets This property is required. ExponentialResponse
The exponential buckets.
linearBuckets This property is required. LinearResponse
The linear bucket.
explicit_buckets This property is required. ExplicitResponse
The explicit buckets.
exponential_buckets This property is required. ExponentialResponse
The exponential buckets.
linear_buckets This property is required. LinearResponse
The linear bucket.
explicitBuckets This property is required. Property Map
The explicit buckets.
exponentialBuckets This property is required. Property Map
The exponential buckets.
linearBuckets This property is required. 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 This property is required. List<double>
The values must be monotonically increasing.
Bounds This property is required. []float64
The values must be monotonically increasing.
bounds This property is required. List<Double>
The values must be monotonically increasing.
bounds This property is required. number[]
The values must be monotonically increasing.
bounds This property is required. Sequence[float]
The values must be monotonically increasing.
bounds This property is required. List<Number>
The values must be monotonically increasing.

Exponential
, ExponentialArgs

GrowthFactor double
Must be greater than 1.
NumFiniteBuckets int
Must be greater than 0.
Scale double
Must be greater than 0.
GrowthFactor float64
Must be greater than 1.
NumFiniteBuckets int
Must be greater than 0.
Scale float64
Must be greater than 0.
growthFactor Double
Must be greater than 1.
numFiniteBuckets Integer
Must be greater than 0.
scale Double
Must be greater than 0.
growthFactor number
Must be greater than 1.
numFiniteBuckets number
Must be greater than 0.
scale number
Must be greater than 0.
growth_factor float
Must be greater than 1.
num_finite_buckets int
Must be greater than 0.
scale float
Must be greater than 0.
growthFactor Number
Must be greater than 1.
numFiniteBuckets Number
Must be greater than 0.
scale Number
Must be greater than 0.

ExponentialResponse
, ExponentialResponseArgs

GrowthFactor This property is required. double
Must be greater than 1.
NumFiniteBuckets This property is required. int
Must be greater than 0.
Scale This property is required. double
Must be greater than 0.
GrowthFactor This property is required. float64
Must be greater than 1.
NumFiniteBuckets This property is required. int
Must be greater than 0.
Scale This property is required. float64
Must be greater than 0.
growthFactor This property is required. Double
Must be greater than 1.
numFiniteBuckets This property is required. Integer
Must be greater than 0.
scale This property is required. Double
Must be greater than 0.
growthFactor This property is required. number
Must be greater than 1.
numFiniteBuckets This property is required. number
Must be greater than 0.
scale This property is required. number
Must be greater than 0.
growth_factor This property is required. float
Must be greater than 1.
num_finite_buckets This property is required. int
Must be greater than 0.
scale This property is required. float
Must be greater than 0.
growthFactor This property is required. Number
Must be greater than 1.
numFiniteBuckets This property is required. Number
Must be greater than 0.
scale This property is required. Number
Must be greater than 0.

LabelDescriptor
, LabelDescriptorArgs

Description string
A human-readable description for the label.
Key string
The label key.
ValueType Pulumi.GoogleNative.Logging.V2.LabelDescriptorValueType
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.
ValueType LabelDescriptorValueType
The type of data that can be assigned to the label.
description String
A human-readable description for the label.
key String
The label key.
valueType LabelDescriptorValueType
The type of data that can be assigned to the label.
description string
A human-readable description for the label.
key string
The label key.
valueType LabelDescriptorValueType
The type of data that can be assigned to the label.
description str
A human-readable description for the label.
key str
The label key.
value_type LabelDescriptorValueType
The type of data that can be assigned to the label.
description String
A human-readable description for the label.
key String
The label key.
valueType "STRING" | "BOOL" | "INT64"
The type of data that can be assigned to the label.

LabelDescriptorResponse
, LabelDescriptorResponseArgs

Description This property is required. string
A human-readable description for the label.
Key This property is required. string
The label key.
ValueType This property is required. string
The type of data that can be assigned to the label.
Description This property is required. string
A human-readable description for the label.
Key This property is required. string
The label key.
ValueType This property is required. string
The type of data that can be assigned to the label.
description This property is required. String
A human-readable description for the label.
key This property is required. String
The label key.
valueType This property is required. String
The type of data that can be assigned to the label.
description This property is required. string
A human-readable description for the label.
key This property is required. string
The label key.
valueType This property is required. string
The type of data that can be assigned to the label.
description This property is required. str
A human-readable description for the label.
key This property is required. str
The label key.
value_type This property is required. str
The type of data that can be assigned to the label.
description This property is required. String
A human-readable description for the label.
key This property is required. String
The label key.
valueType This property is required. 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.
LabelDescriptorValueTypeString
STRINGA variable-length string. This is the default.
LabelDescriptorValueTypeBool
BOOLBoolean; true or false.
LabelDescriptorValueTypeInt64
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

NumFiniteBuckets int
Must be greater than 0.
Offset double
Lower bound of the first bucket.
Width double
Must be greater than 0.
NumFiniteBuckets int
Must be greater than 0.
Offset float64
Lower bound of the first bucket.
Width float64
Must be greater than 0.
numFiniteBuckets Integer
Must be greater than 0.
offset Double
Lower bound of the first bucket.
width Double
Must be greater than 0.
numFiniteBuckets number
Must be greater than 0.
offset number
Lower bound of the first bucket.
width number
Must be greater than 0.
num_finite_buckets int
Must be greater than 0.
offset float
Lower bound of the first bucket.
width float
Must be greater than 0.
numFiniteBuckets Number
Must be greater than 0.
offset Number
Lower bound of the first bucket.
width Number
Must be greater than 0.

LinearResponse
, LinearResponseArgs

NumFiniteBuckets This property is required. int
Must be greater than 0.
Offset This property is required. double
Lower bound of the first bucket.
Width This property is required. double
Must be greater than 0.
NumFiniteBuckets This property is required. int
Must be greater than 0.
Offset This property is required. float64
Lower bound of the first bucket.
Width This property is required. float64
Must be greater than 0.
numFiniteBuckets This property is required. Integer
Must be greater than 0.
offset This property is required. Double
Lower bound of the first bucket.
width This property is required. Double
Must be greater than 0.
numFiniteBuckets This property is required. number
Must be greater than 0.
offset This property is required. number
Lower bound of the first bucket.
width This property is required. number
Must be greater than 0.
num_finite_buckets This property is required. int
Must be greater than 0.
offset This property is required. float
Lower bound of the first bucket.
width This property is required. float
Must be greater than 0.
numFiniteBuckets This property is required. Number
Must be greater than 0.
offset This property is required. Number
Lower bound of the first bucket.
width This property is required. Number
Must be greater than 0.

MetricDescriptor
, MetricDescriptorArgs

Description string
A detailed description of the metric, which can be used in documentation.
DisplayName string
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
Labels List<Pulumi.GoogleNative.Logging.V2.Inputs.LabelDescriptor>
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
LaunchStage Pulumi.GoogleNative.Logging.V2.MetricDescriptorLaunchStage
Optional. The launch stage of the metric definition.
Metadata Pulumi.GoogleNative.Logging.V2.Inputs.MetricDescriptorMetadata
Optional. Metadata which can be used to guide usage of the metric.
MetricKind Pulumi.GoogleNative.Logging.V2.MetricDescriptorMetricKind
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
MonitoredResourceTypes List<string>
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
Name string
The resource name of the metric descriptor.
Type string
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
Unit string
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
ValueType Pulumi.GoogleNative.Logging.V2.MetricDescriptorValueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
Description string
A detailed description of the metric, which can be used in documentation.
DisplayName string
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
Labels []LabelDescriptor
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
LaunchStage MetricDescriptorLaunchStage
Optional. The launch stage of the metric definition.
Metadata MetricDescriptorMetadata
Optional. Metadata which can be used to guide usage of the metric.
MetricKind MetricDescriptorMetricKind
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
MonitoredResourceTypes []string
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
Name string
The resource name of the metric descriptor.
Type string
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
Unit string
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
ValueType MetricDescriptorValueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
description String
A detailed description of the metric, which can be used in documentation.
displayName String
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
labels List<LabelDescriptor>
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
launchStage MetricDescriptorLaunchStage
Optional. The launch stage of the metric definition.
metadata MetricDescriptorMetadata
Optional. Metadata which can be used to guide usage of the metric.
metricKind MetricDescriptorMetricKind
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes List<String>
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
name String
The resource name of the metric descriptor.
type String
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
unit String
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
valueType MetricDescriptorValueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
description string
A detailed description of the metric, which can be used in documentation.
displayName string
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
labels LabelDescriptor[]
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
launchStage MetricDescriptorLaunchStage
Optional. The launch stage of the metric definition.
metadata MetricDescriptorMetadata
Optional. Metadata which can be used to guide usage of the metric.
metricKind MetricDescriptorMetricKind
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes string[]
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
name string
The resource name of the metric descriptor.
type string
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
unit string
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
valueType MetricDescriptorValueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
description str
A detailed description of the metric, which can be used in documentation.
display_name str
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
labels Sequence[LabelDescriptor]
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
launch_stage MetricDescriptorLaunchStage
Optional. The launch stage of the metric definition.
metadata MetricDescriptorMetadata
Optional. Metadata which can be used to guide usage of the metric.
metric_kind MetricDescriptorMetricKind
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitored_resource_types Sequence[str]
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
name str
The resource name of the metric descriptor.
type str
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
unit str
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
value_type MetricDescriptorValueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
description String
A detailed description of the metric, which can be used in documentation.
displayName String
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
labels List<Property Map>
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
launchStage "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"
Optional. The launch stage of the metric definition.
metadata Property Map
Optional. Metadata which can be used to guide usage of the metric.
metricKind "METRIC_KIND_UNSPECIFIED" | "GAUGE" | "DELTA" | "CUMULATIVE"
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes List<String>
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
name String
The resource name of the metric descriptor.
type String
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
unit String
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
valueType "VALUE_TYPE_UNSPECIFIED" | "BOOL" | "INT64" | "DOUBLE" | "STRING" | "DISTRIBUTION" | "MONEY"
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

MetricDescriptorLaunchStage
, MetricDescriptorLaunchStageArgs

LaunchStageUnspecified
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.
EarlyAccess
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.
MetricDescriptorLaunchStageLaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIEDDo not use this default value.
MetricDescriptorLaunchStageUnimplemented
UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
MetricDescriptorLaunchStagePrelaunch
PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
MetricDescriptorLaunchStageEarlyAccess
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.
MetricDescriptorLaunchStageAlpha
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.
MetricDescriptorLaunchStageBeta
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.
MetricDescriptorLaunchStageGa
GAGA features are open to all developers and are considered stable and fully qualified for production use.
MetricDescriptorLaunchStageDeprecated
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.
LaunchStageUnspecified
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.
EarlyAccess
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.
LaunchStageUnspecified
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.
EarlyAccess
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

IngestDelay string
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
LaunchStage Pulumi.GoogleNative.Logging.V2.MetricDescriptorMetadataLaunchStage
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string
The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
IngestDelay string
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
LaunchStage MetricDescriptorMetadataLaunchStage
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string
The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
ingestDelay String
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
launchStage MetricDescriptorMetadataLaunchStage
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String
The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
ingestDelay string
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
launchStage MetricDescriptorMetadataLaunchStage
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod string
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 MetricDescriptorMetadataLaunchStage
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: 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.
ingestDelay String
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
launchStage "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

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

MetricDescriptorMetadataLaunchStage
, MetricDescriptorMetadataLaunchStageArgs

LaunchStageUnspecified
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.
EarlyAccess
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.
MetricDescriptorMetadataLaunchStageLaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIEDDo not use this default value.
MetricDescriptorMetadataLaunchStageUnimplemented
UNIMPLEMENTEDThe feature is not yet implemented. Users can not use it.
MetricDescriptorMetadataLaunchStagePrelaunch
PRELAUNCHPrelaunch features are hidden from users and are only visible internally.
MetricDescriptorMetadataLaunchStageEarlyAccess
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.
MetricDescriptorMetadataLaunchStageAlpha
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.
MetricDescriptorMetadataLaunchStageBeta
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.
MetricDescriptorMetadataLaunchStageGa
GAGA features are open to all developers and are considered stable and fully qualified for production use.
MetricDescriptorMetadataLaunchStageDeprecated
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.
LaunchStageUnspecified
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.
EarlyAccess
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.
LaunchStageUnspecified
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.
EarlyAccess
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

IngestDelay This property is required. string
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
LaunchStage This property is required. string
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod This property is required. string
The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
IngestDelay This property is required. string
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
LaunchStage This property is required. string
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod This property is required. string
The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
ingestDelay This property is required. String
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
launchStage This property is required. String
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod This property is required. String
The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
ingestDelay This property is required. string
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
launchStage This property is required. string
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod This property is required. 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 This property is required. 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 This property is required. str
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

sample_period This property is required. 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.
ingestDelay This property is required. String
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
launchStage This property is required. String
Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod This property is required. 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

MetricKindUnspecified
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.
MetricDescriptorMetricKindMetricKindUnspecified
METRIC_KIND_UNSPECIFIEDDo not use this default value.
MetricDescriptorMetricKindGauge
GAUGEAn instantaneous measurement of a value.
MetricDescriptorMetricKindDelta
DELTAThe change in a value during a time interval.
MetricDescriptorMetricKindCumulative
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.
MetricKindUnspecified
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.
MetricKindUnspecified
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 This property is required. string
A detailed description of the metric, which can be used in documentation.
DisplayName This property is required. 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 This property is required. List<Pulumi.GoogleNative.Logging.V2.Inputs.LabelDescriptorResponse>
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
LaunchStage This property is required. string
Optional. The launch stage of the metric definition.
Metadata This property is required. Pulumi.GoogleNative.Logging.V2.Inputs.MetricDescriptorMetadataResponse
Optional. Metadata which can be used to guide usage of the metric.
MetricKind This property is required. string
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
MonitoredResourceTypes This property is required. List<string>
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
Name This property is required. string
The resource name of the metric descriptor.
Type This property is required. 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 This property is required. string
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
ValueType This property is required. 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 This property is required. string
A detailed description of the metric, which can be used in documentation.
DisplayName This property is required. 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 This property is required. []LabelDescriptorResponse
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
LaunchStage This property is required. string
Optional. The launch stage of the metric definition.
Metadata This property is required. MetricDescriptorMetadataResponse
Optional. Metadata which can be used to guide usage of the metric.
MetricKind This property is required. string
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
MonitoredResourceTypes This property is required. []string
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
Name This property is required. string
The resource name of the metric descriptor.
Type This property is required. 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 This property is required. string
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
ValueType This property is required. 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 This property is required. String
A detailed description of the metric, which can be used in documentation.
displayName This property is required. 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 This property is required. List<LabelDescriptorResponse>
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
launchStage This property is required. String
Optional. The launch stage of the metric definition.
metadata This property is required. MetricDescriptorMetadataResponse
Optional. Metadata which can be used to guide usage of the metric.
metricKind This property is required. String
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes This property is required. List<String>
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
name This property is required. String
The resource name of the metric descriptor.
type This property is required. 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 This property is required. String
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
valueType This property is required. 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 This property is required. string
A detailed description of the metric, which can be used in documentation.
displayName This property is required. 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 This property is required. LabelDescriptorResponse[]
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
launchStage This property is required. string
Optional. The launch stage of the metric definition.
metadata This property is required. MetricDescriptorMetadataResponse
Optional. Metadata which can be used to guide usage of the metric.
metricKind This property is required. string
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes This property is required. string[]
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
name This property is required. string
The resource name of the metric descriptor.
type This property is required. 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 This property is required. string
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
valueType This property is required. 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 This property is required. str
A detailed description of the metric, which can be used in documentation.
display_name This property is required. 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 This property is required. Sequence[LabelDescriptorResponse]
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 This property is required. str
Optional. The launch stage of the metric definition.
metadata This property is required. MetricDescriptorMetadataResponse
Optional. Metadata which can be used to guide usage of the metric.
metric_kind This property is required. 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_types This property is required. Sequence[str]
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
name This property is required. str
The resource name of the metric descriptor.
type This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
A detailed description of the metric, which can be used in documentation.
displayName This property is required. 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 This property is required. List<Property Map>
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
launchStage This property is required. String
Optional. The launch stage of the metric definition.
metadata This property is required. Property Map
Optional. Metadata which can be used to guide usage of the metric.
metricKind This property is required. String
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
monitoredResourceTypes This property is required. List<String>
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
name This property is required. String
The resource name of the metric descriptor.
type This property is required. 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 This property is required. String
The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
valueType This property is required. 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

ValueTypeUnspecified
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.
MetricDescriptorValueTypeValueTypeUnspecified
VALUE_TYPE_UNSPECIFIEDDo not use this default value.
MetricDescriptorValueTypeBool
BOOLThe value is a boolean. This value type can be used only if the metric kind is GAUGE.
MetricDescriptorValueTypeInt64
INT64The value is a signed 64-bit integer.
MetricDescriptorValueTypeDouble
DOUBLEThe value is a double precision floating point number.
MetricDescriptorValueTypeString
STRINGThe value is a text string. This value type can be used only if the metric kind is GAUGE.
MetricDescriptorValueTypeDistribution
DISTRIBUTIONThe value is a Distribution.
MetricDescriptorValueTypeMoney
MONEYThe value is money.
ValueTypeUnspecified
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.
ValueTypeUnspecified
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.
MetricVersionV2
V2Logging API v2.
MetricVersionV1
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.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native