Cloud Logging V2 API - Class Google::Cloud::Logging::V2::LogMetric (v0.13.0)

Reference documentation and code samples for the Cloud Logging V2 API class Google::Cloud::Logging::V2::LogMetric.

Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.

Logs-based metrics can also be used to extract values from logs and create a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bucket_name

def bucket_name() -> ::String
Returns
  • (::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-bucket

    If empty, then the Log Metric is considered a non-Bucket Log Metric.

#bucket_name=

def bucket_name=(value) -> ::String
Parameter
  • value (::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-bucket

    If empty, then the Log Metric is considered a non-Bucket Log Metric.

Returns
  • (::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-bucket

    If empty, then the Log Metric is considered a non-Bucket Log Metric.

#bucket_options

def bucket_options() -> ::Google::Api::Distribution::BucketOptions
Returns
  • (::Google::Api::Distribution::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.

#bucket_options=

def bucket_options=(value) -> ::Google::Api::Distribution::BucketOptions
Parameter
  • value (::Google::Api::Distribution::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.
Returns
  • (::Google::Api::Distribution::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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
Returns
  • (::String) — Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.

#disabled

def disabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to True, then this metric is disabled and it does not generate any points.

#disabled=

def disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to True, then this metric is disabled and it does not generate any points.
Returns
  • (::Boolean) — Optional. If set to True, then this metric is disabled and it does not generate any points.

#filter

def filter() -> ::String
Returns
  • (::String) — Required. An advanced logs filter which is used to match log entries. Example:

    "resource.type=gae_app AND severity>=ERROR"

    The maximum length of the filter is 20000 characters.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Required. An advanced logs filter which is used to match log entries. Example:

    "resource.type=gae_app AND severity>=ERROR"

    The maximum length of the filter is 20000 characters.

Returns
  • (::String) — Required. An advanced logs filter which is used to match log entries. Example:

    "resource.type=gae_app AND severity>=ERROR"

    The maximum length of the filter is 20000 characters.

#label_extractors

def label_extractors() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::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.

#label_extractors=

def label_extractors=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::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.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.

    The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.

    Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.

#metric_descriptor

def metric_descriptor() -> ::Google::Api::MetricDescriptor
Returns
  • (::Google::Api::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.

#metric_descriptor=

def metric_descriptor=(value) -> ::Google::Api::MetricDescriptor
Parameter
  • value (::Google::Api::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.

Returns
  • (::Google::Api::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

def name() -> ::String
Returns
  • (::String) — 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".

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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".

Returns
  • (::String) — 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".

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#value_extractor

def value_extractor() -> ::String
Returns
  • (::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:

    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.

    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+).*")

#value_extractor=

def value_extractor=(value) -> ::String
Parameter
  • value (::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:

    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.

    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+).*")

Returns
  • (::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:

    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.

    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

def version() -> ::Google::Cloud::Logging::V2::LogMetric::ApiVersion
Returns

#version=

def version=(value) -> ::Google::Cloud::Logging::V2::LogMetric::ApiVersion
Parameter
Returns