Package com.hashicorp.cdktf.providers.google.logging_metric

Interface LoggingMetricConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    LoggingMetricConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.847Z")
@Stability(Stable)
public interface LoggingMetricConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getFilter

        @Stability(Stable)
@NotNull
String getFilter()
        An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-filters) which is used to match log entries.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#filter LoggingMetric#filter}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#name LoggingMetric#name}

      • getBucketName

        @Stability(Stable)
@Nullable
default String getBucketName()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#bucket_name LoggingMetric#bucket_name}

      • getBucketOptions

        @Stability(Stable)
@Nullable
default LoggingMetricBucketOptions getBucketOptions()
        bucket_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#bucket_options LoggingMetric#bucket_options}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#description LoggingMetric#description}

      • getDisabled

        @Stability(Stable)
@Nullable
default Object getDisabled()
        If set to True, then this metric is disabled and it does not generate any points.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#disabled LoggingMetric#disabled}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#id LoggingMetric#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getLabelExtractors

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabelExtractors()
        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 valueExtractor field. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#label_extractors LoggingMetric#label_extractors}

      • getMetricDescriptor

        @Stability(Stable)
@Nullable
default LoggingMetricMetricDescriptor getMetricDescriptor()
        metric_descriptor block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#metric_descriptor LoggingMetric#metric_descriptor}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#project LoggingMetric#project}.

      • getTimeouts

        @Stability(Stable)
@Nullable
default LoggingMetricTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#timeouts LoggingMetric#timeouts}

      • getValueExtractor

        @Stability(Stable)
@Nullable
default String getValueExtractor()
        A valueExtractor 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 argument are 1. field - The name of the log entry field from which the value is to be extracted. 2. 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#value_extractor LoggingMetric#value_extractor}