Class: Aws::CloudWatch::Metric
- Inherits:
-
Object
- Object
- Aws::CloudWatch::Metric
- Extended by:
- Deprecations
- Defined in:
- 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
- #alarms(options = {}) ⇒ Alarm::Collection
- #identifiers ⇒ Object deprecated private Deprecated.
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 = {}, &block) ⇒ 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.
21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 21 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() end |
Instance Method Details
#alarms(options = {}) ⇒ Alarm::Collection
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 551 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 |
#data ⇒ Types::Metric
Returns the data for this Aws::CloudWatch::Metric. Calls Client#list_metrics if #data_loaded? is ‘false`.
74 75 76 77 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 74 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
82 83 84 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 82 def data_loaded? !!@data end |
#dimensions ⇒ Array<Types::Dimension>
The dimensions for the metric.
44 45 46 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 44 def dimensions data[:dimensions] end |
#get_statistics(options = {}) ⇒ Types::GetMetricStatisticsOutput
287 288 289 290 291 292 293 294 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 287 def get_statistics( = {}) = .merge( namespace: @namespace, metric_name: @name ) resp = @client.get_metric_statistics() resp.data end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
573 574 575 576 577 578 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 573 def identifiers { namespace: @namespace, name: @name } 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
61 62 63 64 65 66 67 68 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 61 def load resp = @client.list_metrics( metric_name: @name, namespace: @namespace ) @data = resp.metrics[0] self end |
#name ⇒ String Also known as: metric_name
37 38 39 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 37 def name @name end |
#namespace ⇒ String
32 33 34 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 32 def namespace @namespace end |
#put_alarm(options = {}) ⇒ Alarm
469 470 471 472 473 474 475 476 477 478 479 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 469 def put_alarm( = {}) = .merge( namespace: @namespace, metric_name: @name ) resp = @client.put_metric_alarm() Alarm.new( name: [:alarm_name], client: @client ) end |
#put_data(options = {}) ⇒ EmptyStructure
510 511 512 513 514 515 516 517 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 510 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 = {}, &block) ⇒ 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) {|instance| instance.state.name == 'running' }
## 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
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 164 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 |