You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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/metric.rb,
lib/aws/cloud_watch/errors.rb,
lib/aws/cloud_watch/client.rb,
lib/aws/cloud_watch/alarm_collection.rb,
lib/aws/cloud_watch/metric_statistics.rb,
lib/aws/cloud_watch/metric_collection.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::CloudWatch 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 Attribute Summary collapse

Instance Method Summary collapse

Methods included from AWS::Core::ServiceInterface

included, #initialize, #inspect

Instance Attribute Details

#clientClient (readonly)

Returns the low-level CloudWatch client object

Returns:

  • (Client)

    the low-level CloudWatch client object



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/aws/cloud_watch.rb', line 62

class CloudWatch

  autoload :Alarm, 'aws/cloud_watch/alarm'
  autoload :AlarmCollection, 'aws/cloud_watch/alarm_collection'
  autoload :AlarmHistoryItem, 'aws/cloud_watch/alarm_history_item'
  autoload :AlarmHistoryItemCollection, 'aws/cloud_watch/alarm_history_item_collection'
  autoload :Client, 'aws/cloud_watch/client'
  autoload :Errors, 'aws/cloud_watch/errors'
  autoload :Metric, 'aws/cloud_watch/metric'
  autoload :MetricCollection, 'aws/cloud_watch/metric_collection'
  autoload :MetricAlarmCollection, 'aws/cloud_watch/metric_alarm_collection'
  autoload :MetricStatistics, 'aws/cloud_watch/metric_statistics'

  include Core::ServiceInterface

  endpoint_prefix 'monitoring'

  # 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 },
  #       ]
  #     )
  #
  # @param [Hash] options
  # @see Client#put_metric_data
  # @return [nil]
  #
  def put_metric_data options = {}
    client.put_metric_data(options)
    nil
  end

  # @return [AlarmCollection]
  def alarms
    AlarmCollection.new(:config => config)
  end

  # @return [AlarmHistoryItemCollection]
  def alarm_history_items
    AlarmHistoryItemCollection.new(:config => config)
  end

  # @return [MetricCollection]
  def metrics options = {}
    MetricCollection.new(options.merge(:config => config))
  end

end

Instance Method Details

#alarm_history_itemsAlarmHistoryItemCollection



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

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

#alarmsAlarmCollection

Returns:



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

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

#metrics(options = {}) ⇒ MetricCollection

Returns:



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

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:



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

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