googleMonitoringMetricDescriptor

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

To get more information about MetricDescriptor, see:

Example Usage - Monitoring Metric Descriptor Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.monitoringMetricDescriptor.MonitoringMetricDescriptor(
  this,
  "basic",
  {
    description: "Daily sales records from all branch stores.",
    display_name: "metric-descriptor",
    labels: [
      {
        description: "The ID of the store.",
        key: "store_id",
        value_type: "STRING",
      },
    ],
    launch_stage: "BETA",
    metadata: [
      {
        ingest_delay: "30s",
        sample_period: "60s",
      },
    ],
    metric_kind: "GAUGE",
    type: "custom.googleapis.com/stores/daily_sales",
    unit: "{USD}",
    value_type: "DOUBLE",
  }
);

Example Usage - Monitoring Metric Descriptor Alert

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleMonitoringMetricDescriptorWithAlert =
  new google.monitoringMetricDescriptor.MonitoringMetricDescriptor(
    this,
    "with_alert",
    {
      description: "Daily sales records from all branch stores.",
      display_name: "metric-descriptor",
      metric_kind: "GAUGE",
      type: "custom.googleapis.com/stores/daily_sales",
      unit: "{USD}",
      value_type: "DOUBLE",
    }
  );
new google.monitoringAlertPolicy.MonitoringAlertPolicy(this, "alert_policy", {
  combiner: "OR",
  conditions: [
    {
      condition_threshold: [
        {
          comparison: "COMPARISON_GT",
          duration: "60s",
          filter: `metric.type="\${${googleMonitoringMetricDescriptorWithAlert.type}}" AND resource.type="gce_instance"`,
        },
      ],
      display_name: "test condition",
    },
  ],
  display_name: "metric-descriptor",
});

Argument Reference

The following arguments are supported:

type - (Required) The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must have only upper and lower-case letters, digits, '/' and underscores '_' are allowed. Additionally, the maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.
metricKind - (Required) Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metricKind and valueType might not be supported. Possible values are metricKindUnspecified, gauge, delta, and cumulative.
valueType - (Required) Whether the measurement is an integer, a floating-point number, etc. Some combinations of metricKind and valueType might not be supported. Possible values are bool, int64, double, string, and distribution.
description - (Required) A detailed description of the metric, which can be used in documentation.
displayName - (Required) A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".

labels - (Optional) The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels. Structure is documented below.
unit - (Optional) The units in which the metric value is reported. It is only applicable if the valueType is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems may 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 may 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 standard. More info can be found in the API documentation (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors).
metadata - (Optional) Metadata which can be used to guide usage of the metric. Structure is documented below.
launchStage - (Optional) The launch stage of the metric definition. Possible values are launchStageUnspecified, unimplemented, prelaunch, earlyAccess, alpha, beta, ga, and deprecated.
project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The labels block supports:

key - (Required) The key for this label. The key must not exceed 100 characters. The first character of the key must be an upper- or lower-case letter, the remaining characters must be letters, digits or underscores, and the key must match the regular expression [a-zA-Z][a-zA-Z0-9_]*
valueType - (Optional) The type of data that can be assigned to the label. Default value is string. Possible values are string, bool, and int64.
description - (Optional) A human-readable description for the label.

The metadata block supports:

samplePeriod - (Optional) 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. In [durationFormat](https://developersGoogleCom/protocolBuffers/docs/reference/googleProtobuf?&Ga=2264881487150787325315934467239350524551591817775#googleProtobufDuration).
ingestDelay - (Optional) 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. In [durationFormat](https://developersGoogleCom/protocolBuffers/docs/reference/googleProtobuf?&Ga=2264881487150787325315934467239350524551591817775#googleProtobufDuration).

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

id - an identifier for the resource with format {{name}}
name - The resource name of the metric descriptor.
monitoredResourceTypes - 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. This field allows time series to be associated with the intersection of this metric type and the monitored resource types in this list.

Timeouts

This resource provides the following Timeouts configuration options:

create - Default is 20 minutes.
update - Default is 20 minutes.
delete - Default is 20 minutes.

Import

MetricDescriptor can be imported using any of these accepted formats:

$ terraform import google_monitoring_metric_descriptor.default {{name}}

User Project Overrides

This resource supports User Project Overrides.