gcp_logging_log_metric

ancestors

Type: UNORDERED_LIST_STRING

bucket_name

Type: STRING
Provider name: bucketName
Description: 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

Type: STRUCT
Provider name: bucketOptions
Description: 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.

  • explicit_buckets
    Type: STRUCT
    Provider name: explicitBuckets
    Description: The explicit buckets.
    • bounds
      Type: UNORDERED_LIST_DOUBLE
      Provider name: bounds
      Description: The values must be monotonically increasing.
  • exponential_buckets
    Type: STRUCT
    Provider name: exponentialBuckets
    Description: The exponential buckets.
    • growth_factor
      Type: DOUBLE
      Provider name: growthFactor
      Description: Must be greater than 1.
    • num_finite_buckets
      Type: INT32
      Provider name: numFiniteBuckets
      Description: Must be greater than 0.
    • scale
      Type: DOUBLE
      Provider name: scale
      Description: Must be greater than 0.
  • linear_buckets
    Type: STRUCT
    Provider name: linearBuckets
    Description: The linear bucket.
    • num_finite_buckets
      Type: INT32
      Provider name: numFiniteBuckets
      Description: Must be greater than 0.
    • offset
      Type: DOUBLE
      Provider name: offset
      Description: Lower bound of the first bucket.
    • width
      Type: DOUBLE
      Provider name: width
      Description: Must be greater than 0.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The creation timestamp of the metric.This field may not be present for older metrics.

description

Type: STRING
Provider name: description
Description: Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.

disabled

Type: BOOLEAN
Provider name: disabled
Description: Optional. If set to True, then this metric is disabled and it does not generate any points.

filter

Type: STRING
Provider name: filter
Description: Required. 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.

labels

Type: UNORDERED_LIST_STRING

metric_descriptor

Type: STRUCT
Provider name: metricDescriptor
Description: 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.

  • description
    Type: STRING
    Provider name: description
    Description: A detailed description of the metric, which can be used in documentation.
  • gcp_display_name
    Type: STRING
    Provider name: displayName
    Description: 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.
  • launch_stage
    Type: STRING
    Provider name: launchStage
    Description: Optional. The launch stage of the metric definition.
    Possible values:
    • LAUNCH_STAGE_UNSPECIFIED - Do not use this default value.
    • UNIMPLEMENTED - The feature is not yet implemented. Users can not use it.
    • PRELAUNCH - Prelaunch features are hidden from users and are only visible internally.
    • EARLY_ACCESS - Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
    • ALPHA - Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests – just like they would in normal production cases.
    • BETA - Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
    • GA - GA features are open to all developers and are considered stable and fully qualified for production use.
    • DEPRECATED - Deprecated features are scheduled to be shut down and removed. For more information, see the ‘Deprecation Policy’ section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.
  • metadata
    Type: STRUCT
    Provider name: metadata
    Description: Optional. Metadata which can be used to guide usage of the metric.
    • ingest_delay
      Type: STRING
      Provider name: ingestDelay
      Description: 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
      Type: STRING
      Provider name: launchStage
      Description: Deprecated. Must use the MetricDescriptor.launch_stage instead.
      Possible values:
      • LAUNCH_STAGE_UNSPECIFIED - Do not use this default value.
      • UNIMPLEMENTED - The feature is not yet implemented. Users can not use it.
      • PRELAUNCH - Prelaunch features are hidden from users and are only visible internally.
      • EARLY_ACCESS - Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
      • ALPHA - Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests – just like they would in normal production cases.
      • BETA - Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
      • GA - GA features are open to all developers and are considered stable and fully qualified for production use.
      • DEPRECATED - Deprecated features are scheduled to be shut down and removed. For more information, see the ‘Deprecation Policy’ section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation.
    • sample_period
      Type: STRING
      Provider name: samplePeriod
      Description: 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.
  • metric_kind
    Type: STRING
    Provider name: metricKind
    Description: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
    Possible values:
    • METRIC_KIND_UNSPECIFIED - Do not use this default value.
    • GAUGE - An instantaneous measurement of a value.
    • DELTA - The change in a value during a time interval.
    • CUMULATIVE - A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
  • monitored_resource_types
    Type: UNORDERED_LIST_STRING
    Provider name: monitoredResourceTypes
    Description: 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
    Type: STRING
    Provider name: name
    Description: The resource name of the metric descriptor.
  • type
    Type: STRING
    Provider name: type
    Description: 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
    Type: STRING
    Provider name: unit
    Description: 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
    Type: STRING
    Provider name: valueType
    Description: Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
    Possible values:
    • VALUE_TYPE_UNSPECIFIED - Do not use this default value.
    • BOOL - The value is a boolean. This value type can be used only if the metric kind is GAUGE.
    • INT64 - The value is a signed 64-bit integer.
    • DOUBLE - The value is a double precision floating point number.
    • STRING - The value is a text string. This value type can be used only if the metric kind is GAUGE.
    • DISTRIBUTION - The value is a Distribution.
    • MONEY - The value is money.

name

Type: STRING
Provider name: name
Description: Required. 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”.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The last update timestamp of the metric.This field may not be present for older metrics.

value_extractor

Type: STRING
Provider name: valueExtractor
Description: 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

Type: STRING
Provider name: version
Description: Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
Possible values:

  • V2 - Logging API v2.
  • V1 - Logging API v1.