Class: AWS::CloudWatch

Inherits:
Object
  • Object
show all
Includes:
AWS::Core::ServiceInterface
Defined in:
lib/aws/cloud_watch.rb,
lib/aws/cloud_watch/alarm.rb,
lib/aws/cloud_watch/client.rb,
lib/aws/cloud_watch/errors.rb,
lib/aws/cloud_watch/metric.rb,
lib/aws/cloud_watch/request.rb,
lib/aws/cloud_watch/alarm_collection.rb,
lib/aws/cloud_watch/metric_collection.rb,
lib/aws/cloud_watch/metric_statistics.rb,
lib/aws/cloud_watch/alarm_history_item.rb,
lib/aws/cloud_watch/metric_alarm_collection.rb,
lib/aws/cloud_watch/alarm_history_item_collection.rb

Overview

This class is the starting point for working with Amazon CloudWatch.

To use Amazon CloudWatch you must first sign up here.

For more information about Amazon CloudWatch:

Credentials

You can setup default credentials for all AWS services via AWS.config:

AWS.config(
  :access_key_id => 'YOUR_ACCESS_KEY_ID',
  :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')

Or you can set them directly on the AWS::Route53 interface:

cw = AWS::CloudWatch.new(
  :access_key_id => 'YOUR_ACCESS_KEY_ID',
  :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')

Using the Client

AWS::CloudWatch does not provide higher level abstractions for CloudWatch at this time. You can still access all of the API methods using Client. Here is how you access the client and make a simple request:

cw = AWS::CloudWatch.new

resp = cw.client.describe_alarms
resp[:metric_alarms].each do |alarm|
  puts alarm[:alarm_name]
end

See Client for documentation on all of the supported operations.

Defined Under Namespace

Modules: Errors Classes: Alarm, AlarmCollection, AlarmHistoryItem, AlarmHistoryItemCollection, Client, Metric, MetricAlarmCollection, MetricCollection, MetricStatistics

Instance Method Summary collapse

Methods included from AWS::Core::ServiceInterface

#initialize, #inspect

Instance Method Details

#alarm_history_items ⇒ AlarmHistoryItemCollection

Returns:



107
108
109
 
# File 'lib/aws/cloud_watch.rb', line 107

def alarm_history_items
  AlarmHistoryItemCollection.new(:config => config)
end

#alarms ⇒ AlarmCollection

Returns:



102
103
104
 
# File 'lib/aws/cloud_watch.rb', line 102

def alarms
  AlarmCollection.new(:config => config)
end

#metrics(options = {}) ⇒ MetricCollection

Returns:



112
113
114
 
# File 'lib/aws/cloud_watch.rb', line 112

def metrics options = {}
  MetricCollection.new(options.merge(:config => config))
end

#put_metric_data(options = {}) ⇒ nil

Puts data for a metric. The metric is created if it does not already exist.

cw.put_metric_data(
  :namespace => 'test/cli',
  :metric_data => [
    { :metric_name => 'sample', :value => 1 },
    { :metric_name => 'sample', :value => 2 },
    { :metric_name => 'sample', :value => 3 },
    { :metric_name => 'sample', :value => 4 },
    { :metric_name => 'sample', :value => 5 },
  ]
)

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (nil)

See Also:



96
97
98
99
 
# File 'lib/aws/cloud_watch.rb', line 96

def put_metric_data options = {}
  client.put_metric_data(options)
  nil
end