Class: Google::Apis::LoggingV2::LogMetric

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/logging_v2/classes.rb,
lib/google/apis/logging_v2/representations.rb,
lib/google/apis/logging_v2/representations.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 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LogMetric

Returns a new instance of LogMetric.



1517
1518
1519
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1517

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bucket_options ⇒ Google::Apis::LoggingV2::BucketOptions

BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is - infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. Corresponds to the JSON property bucketOptions

Returns:



1425
1426
1427
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1425

def bucket_options
  @bucket_options
end

#create_time ⇒ String

Output only. The creation timestamp of the metric.This field may not be present for older metrics. Corresponds to the JSON property createTime

Returns:

  • (String) 


1431
1432
1433
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1431

def create_time
  @create_time
end

#description ⇒ String

Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1437
1438
1439
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1437

def description
  @description
end

#disabled ⇒ Boolean Also known as: disabled?

Optional. If set to True, then this metric is disabled and it does not generate any points. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


1443
1444
1445
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1443

def disabled
  @disabled
end

#filter ⇒ String

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. Corresponds to the JSON property filter

Returns:

  • (String) 


1452
1453
1454
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1452

def filter
  @filter
end

#label_extractors ⇒ 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. Corresponds to the JSON property labelExtractors

Returns:

  • (Hash<String,String>) 


1466
1467
1468
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1466

def label_extractors
  @label_extractors
end

#metric_descriptor ⇒ Google::Apis::LoggingV2::MetricDescriptor

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. Corresponds to the JSON property metricDescriptor

Returns:



1473
1474
1475
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1473

def metric_descriptor
  @metric_descriptor
end

#name ⇒ 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 (https://en.wikipedia.org/ wiki/Percent-encoding). 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". Corresponds to the JSON property name

Returns:

  • (String) 


1486
1487
1488
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1486

def name
  @name
end

#update_time ⇒ String

Output only. The last update timestamp of the metric.This field may not be present for older metrics. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1492
1493
1494
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1492

def update_time
  @update_time
end

#value_extractor ⇒ 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+).") Corresponds to the JSON property valueExtractor

Returns:

  • (String) 


1509
1510
1511
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1509

def value_extractor
  @value_extractor
end

#version ⇒ String

Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. Corresponds to the JSON property version

Returns:

  • (String) 


1515
1516
1517
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1515

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1522

def update!(**args)
  @bucket_options = args[:bucket_options] if args.key?(:bucket_options)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @disabled = args[:disabled] if args.key?(:disabled)
  @filter = args[:filter] if args.key?(:filter)
  @label_extractors = args[:label_extractors] if args.key?(:label_extractors)
  @metric_descriptor = args[:metric_descriptor] if args.key?(:metric_descriptor)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
  @value_extractor = args[:value_extractor] if args.key?(:value_extractor)
  @version = args[:version] if args.key?(:version)
end