Class: Google::Logging::V2::LogMetric

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb

Overview

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 metric can also be used to extract values from logs and create a 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.

Defined Under Namespace

Modules: ApiVersion

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_options ⇒ Google::Api::Distribution::BucketOptions

Returns 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.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb', line 138

class LogMetric
  # Stackdriver Logging API version.
  module ApiVersion
    # Stackdriver Logging API v2.
    V2 = 0

    # Stackdriver Logging API v1.
    V1 = 1
  end
end

#description ⇒ String

Returns Optional. A description of this metric, which is used in documentation.

Returns:

  • (String) —

    Optional. A description of this metric, which is used in documentation.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb', line 138

class LogMetric
  # Stackdriver Logging API version.
  module ApiVersion
    # Stackdriver Logging API v2.
    V2 = 0

    # Stackdriver Logging API v1.
    V1 = 1
  end
end

#filter ⇒ String

Returns 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.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb', line 138

class LogMetric
  # Stackdriver Logging API version.
  module ApiVersion
    # Stackdriver Logging API v2.
    V2 = 0

    # Stackdriver Logging API v1.
    V1 = 1
  end
end

#label_extractors ⇒ Hash{String => String}

Returns 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 the 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:

  • (Hash{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 the 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.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb', line 138

class LogMetric
  # Stackdriver Logging API version.
  module ApiVersion
    # Stackdriver Logging API v2.
    V2 = 0

    # Stackdriver Logging API v1.
    V1 = 1
  end
end

#metric_descriptor ⇒ Google::Api::MetricDescriptor

Returns 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.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb', line 138

class LogMetric
  # Stackdriver Logging API version.
  module ApiVersion
    # Stackdriver Logging API v2.
    V2 = 0

    # Stackdriver Logging API v1.
    V1 = 1
  end
end

#name ⇒ String

Returns 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.

The metric identifier in this field must not be URL-encoded. However, when the metric identifier appears as the +[METRIC_ID]+ part of a +metric_name+ API parameter, then the metric identifier must be URL-encoded. Example: +"projects/my-project/metrics/nginx%2Frequests"+.

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.

    The metric identifier in this field must not be URL-encoded. However, when the metric identifier appears as the +[METRIC_ID]+ part of a +metric_name+ API parameter, then the metric identifier must be URL-encoded. Example: +"projects/my-project/metrics/nginx%2Frequests"+.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb', line 138

class LogMetric
  # Stackdriver Logging API version.
  module ApiVersion
    # Stackdriver Logging API v2.
    V2 = 0

    # Stackdriver Logging API v1.
    V1 = 1
  end
end

#value_extractor ⇒ String

Returns 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 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.

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 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.

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



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb', line 138

class LogMetric
  # Stackdriver Logging API version.
  module ApiVersion
    # Stackdriver Logging API v2.
    V2 = 0

    # Stackdriver Logging API v1.
    V1 = 1
  end
end

#version ⇒ Google::Logging::V2::LogMetric::ApiVersion

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

Returns:



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb', line 138

class LogMetric
  # Stackdriver Logging API version.
  module ApiVersion
    # Stackdriver Logging API v2.
    V2 = 0

    # Stackdriver Logging API v1.
    V1 = 1
  end
end