Class: Google::Apis::ComputeBeta::AutoscalingPolicyCustomMetricUtilization

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/representations.rb

Overview

Custom utilization metric policy.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AutoscalingPolicyCustomMetricUtilization

Returns a new instance of AutoscalingPolicyCustomMetricUtilization



2498
2499
2500
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2498

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

Instance Attribute Details

#filter ⇒ String

A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply:

  • You can only use the AND operator for joining selectors.
  • You can only use direct equality comparison operator (=) without any functions for each selector.
  • You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical.
  • The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value. Corresponds to the JSON property filter

Returns:

  • (String) 


2458
2459
2460
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2458

def filter
  @filter
end

#metric ⇒ String

The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. Corresponds to the JSON property metric

Returns:

  • (String) 


2465
2466
2467
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2465

def metric
  @metric
end

#single_instance_assignment ⇒ Float

If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/ subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead. Corresponds to the JSON property singleInstanceAssignment

Returns:

  • (Float) 


2480
2481
2482
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2480

def single_instance_assignment
  @single_instance_assignment
end

#utilization_target ⇒ Float

The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is compute. googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances. Corresponds to the JSON property utilizationTarget

Returns:

  • (Float) 


2490
2491
2492
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2490

def utilization_target
  @utilization_target
end

#utilization_target_type ⇒ String

Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. Corresponds to the JSON property utilizationTargetType

Returns:

  • (String) 


2496
2497
2498
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2496

def utilization_target_type
  @utilization_target_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2503
2504
2505
2506
2507
2508
2509
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2503

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @metric = args[:metric] if args.key?(:metric)
  @single_instance_assignment = args[:single_instance_assignment] if args.key?(:single_instance_assignment)
  @utilization_target = args[:utilization_target] if args.key?(:utilization_target)
  @utilization_target_type = args[:utilization_target_type] if args.key?(:utilization_target_type)
end