Class: Aws::CloudWatch::Metric
- Inherits:
-
Object
- Object
- Aws::CloudWatch::Metric
- Defined in:
- gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#dimensions ⇒ Array<Types::Dimension>
The dimensions for the metric.
-
#name ⇒ String
(also: #metric_name)
-
#namespace ⇒ String
Actions collapse
-
#get_statistics(options = {}) ⇒ Types::GetMetricStatisticsOutput
-
#put_alarm(options = {}) ⇒ Alarm
-
#put_data(options = {}) ⇒ EmptyStructure
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::Metric
Returns the data for this Metric.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ Metric
constructor
A new instance of Metric.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::CloudWatch::Client] #wait_until instead
Constructor Details
#initialize(namespace, name, options = {}) ⇒ Metric #initialize(options = {}) ⇒ Metric
Returns a new instance of Metric.
24 25 26 27 28 29 30 31 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 24 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @namespace = extract_namespace(args, ) @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#alarms(options = {}) ⇒ Alarm::Collection
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 692 def alarms( = {}) batches = Enumerator.new do |y| batch = [] = .merge( namespace: @namespace, metric_name: @name ) resp = @client.describe_alarms_for_metric() resp.data.metric_alarms.each do |m| batch << Alarm.new( name: m.alarm_name, data: m, client: @client ) end y.yield(batch) end Alarm::Collection.new(batches) end |
#client ⇒ Client
55 56 57 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 55 def client @client end |
#data ⇒ Types::Metric
Returns the data for this Aws::CloudWatch::Metric. Calls
Client#list_metrics if #data_loaded? is false
.
78 79 80 81 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 78 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
86 87 88 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 86 def data_loaded? !!@data end |
#dimensions ⇒ Array<Types::Dimension>
The dimensions for the metric.
48 49 50 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 48 def dimensions data[:dimensions] end |
#get_statistics(options = {}) ⇒ Types::GetMetricStatisticsOutput
298 299 300 301 302 303 304 305 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 298 def get_statistics( = {}) = .merge( namespace: @namespace, metric_name: @name ) resp = @client.get_metric_statistics() resp.data end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::CloudWatch::Metric.
Returns self
making it possible to chain methods.
metric.reload.data
65 66 67 68 69 70 71 72 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 65 def load resp = @client.list_metrics( metric_name: @name, namespace: @namespace ) @data = resp.metrics[0] self end |
#name ⇒ String Also known as: metric_name
41 42 43 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 41 def name @name end |
#namespace ⇒ String
36 37 38 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 36 def namespace @namespace end |
#put_alarm(options = {}) ⇒ Alarm
607 608 609 610 611 612 613 614 615 616 617 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 607 def put_alarm( = {}) = .merge( namespace: @namespace, metric_name: @name ) @client.put_metric_alarm() Alarm.new( name: [:alarm_name], client: @client ) end |
#put_data(options = {}) ⇒ EmptyStructure
651 652 653 654 655 656 657 658 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 651 def put_data( = {}) = Aws::Util.deep_merge(, namespace: @namespace, metric_data: [{ metric_name: @name }] ) resp = @client.put_metric_data() resp.data end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::CloudWatch::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged.
Waiter polls an API operation until a resource enters a desired state.
Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb', line 170 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |