aws-sdk 1.5.6 → 1.5.7

data/lib/aws/cloud_watch/config.rb

@@ -0,0 +1,18 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'CloudWatch', 'cloud_watch', 'monitoring.us-east-1.amazonaws.com'
+
+end

data/lib/aws/cloud_watch/errors.rb

@@ -0,0 +1,22 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/cloud_watch/metric.rb

@@ -0,0 +1,135 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'date'
+require 'time'
+
+module AWS
+  class CloudWatch
+
+    # = Metric
+    #
+    # Represents a single metric.
+    #
+    class Metric < Core::Resource
+
+      # @param [String] namespace The metric namespace.
+      # @param [String] metric_name The metric name.
+      # @param [Hash] options
+      # @option options [Array<Hash>] :dimensions An array of dimensions.  
+      #   Each hash must have a +:name+ and a +value+ key (with string values).
+      def initialize namespace, metric_name, options = {}
+        @namespace = namespace
+        @metric_name = metric_name
+        @dimensions = options[:dimensions] || []
+        super
+      end
+
+      # @return [String]
+      attr_reader :namespace
+
+      # @return [String]
+      attr_reader :metric_name
+
+      alias_method :name, :metric_name
+
+      # @return [Array<Hash>]
+      attr_reader :dimensions
+
+      # @return [MetricAlarmCollection]
+      def alarms
+        MetricAlarmCollection.new(self, :config => config)
+      end
+
+      # Publishes metric data points to Amazon CloudWatch.
+      # @param [Array<Hash>] metric_data An array of hashes.  Each hash
+      #   must pass +:value+ (number) or +:statistic_values+ (hash).
+      # @return [nil]
+      def put_data *metric_data
+        
+        metric_opts = {}
+        metric_opts[:metric_name] = metric_name
+        metric_opts[:dimensions] = dimensions unless dimensions.empty?
+
+        options = {}
+        options[:namespace] = namespace
+        options[:metric_data] = metric_data.flatten.map do |data|
+          data.merge(metric_opts)
+        end
+
+        client.put_metric_data(options)
+        nil
+
+      end
+
+      # Gets statistics for this metric.
+      #
+      #   metric = CloudWatch::Metric.new('my/namepace', 'metric-name')
+      #
+      #   stats = metric.statistics(
+      #     :start_time => Time.now - 3600,
+      #     :end_time => Time.now,
+      #     :statistics => ['Average'])
+      #
+      #   stats.label #=> 'some-label'
+      #   stats.each do |datapoint|
+      #     # datapoint is a hash
+      #   end
+      #
+      # @param [Hash] options
+      # @option options [Time,required] :start_time
+      # @option options [Time,required] :end_time
+      # @option options [Array<String>,required] :statistics
+      # @option options [String] :unit
+      # @option options [Integer] :period (60)
+      # @return [MetricStatistics]
+      def statistics options = {}
+
+        start = options.delete(:start_time)
+        stop = options.delete(:end_time)
+
+        options[:namespace] = namespace
+        options[:metric_name] = metric_name
+        options[:dimensions] = dimensions unless dimensions.empty?
+        options[:start_time] = start.respond_to?(:iso8601) ? start.iso8601 : start
+        options[:end_time] = stop.respond_to?(:iso8601) ? stop.iso8601 : stop
+        options[:period] ||= 60
+
+        resp = client.get_metric_statistics(options)
+        
+        MetricStatistics.new(self, resp[:label], resp[:datapoints])
+
+      end
+
+      # @return [Boolean] Returns +true+ if this metric exists.
+      def exists?
+        !get_resource.data[:metrics].empty?
+      end
+
+      protected
+
+      def resource_identifiers
+        [
+          [:namespace, namespace], 
+          [:metric_item, metric_name], 
+          [:dimensions, dimensions],
+        ]
+      end
+
+      def get_resource attr_name = nil
+        client.list_metrics(resource_options)
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_watch/metric_alarm_collection.rb

@@ -0,0 +1,160 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+
+    # = MetricAlarmCollection
+    #
+    # Represents all alarms for a single metric.
+    #
+    # == Getting an alarm by name
+    #
+    # If you know the name of the alarm, you can get a reference using
+    # the {#[]} method.
+    #
+    #   metric.alarms['alarm-name']
+    #
+    # == Enumerating Alarms
+    #
+    # You can enumerate all alarms for a metric using each (or any of the
+    # methods defined in {Core::Collection}).
+    #
+    #   metric.alarms.each do |alarm|
+    #     puts alarm.name
+    #   end
+    #
+    # == Filtering Alarms
+    #
+    # Use one of the filtering methods to reduce the number of alarms
+    # returned.
+    #
+    #   metric.alarms.with_unit('Seconds').each {|alarm| ... }
+    #
+    class MetricAlarmCollection < AlarmCollection
+
+      include Core::Collection::Simple
+
+      # @private
+      def initialize metric, options = {}
+        @metric = metric
+        super(options.merge(:config => metric.config))
+      end
+
+      # @return [Metric]
+      attr_reader :metric
+
+      # @param [String] alarm_name
+      # @return [Alarm]
+      def [] alarm_name
+        options = {}
+        options[:namespace] = metric.namespace
+        options[:metric_name] = metric.name
+        options[:dimensions] = metric.dimensions unless metric.dimensions.empty?
+        options[:config] = config
+        Alarm.new(alarm_name, options)
+      end
+
+      # Creates an alarm for this metric.
+      # @param (see AlarmCollection#create)
+      # @option (see MetricAlarm#update)
+      # @return (see AlarmCollection#create)
+      def create alarm_name, options = {}
+        options[:namespace] = metric.namespace
+        options[:metric_name] = metric.metric_name
+        options[:dimensions] = metric.dimensions unless metric.dimensions.empty?
+        super(alarm_name, options)
+      end
+
+      # Returns a new collection that will filter results when enumerated.
+      #
+      # @example Filtering by a 1 hour period
+      #
+      #   metric.alarms.filter('period', 3600)
+      #
+      # @example Filtering by statistic 
+      #
+      #   my_metric = metrics.filter('statistic', 'maximum')
+      #
+      # @example Filtering by a unit
+      #
+      #   metrics = metrics.filter('unit', 'Megabits')
+      #
+      # @param [String,Symbol] name
+      # @param [String,Integer] value
+      # @return [MetricAlarmCollection]
+      def filter name, value
+        filters = @filters.merge(name.to_s.to_sym => value)
+        MetricAlarmCollection.new(metric, :filters => filters)
+      end
+
+      # Returns a new collection that filters alarms by a period.
+      #
+      #   metric.alarms.with_period(3600).each {|alarm| ... }
+      #
+      # @param [Integer] period
+      # @return [MetricAlarmCollection]
+      def with_period period
+        filter(:period, period)
+      end
+
+      # Returns a new collection that filters alarms by a statistic.
+      #
+      #   metric.alarms.with_statistic('Average').each {|alarm| ... }
+      #
+      # @param [String] statistic
+      # @return [MetricAlarmCollection]
+      def with_statistic statistic
+        filter(:statistic, statistic)
+      end
+
+      # Returns a new collection that filters alarms by a unit.
+      #
+      #   metric.alarms.with_unit('Percent').each {|alarm| ... }
+      #
+      # @param [String] unit
+      # @return [MetricAlarmCollection]
+      def with_unit unit
+        filter(:unit, unit)
+      end
+
+      protected
+
+      def _each_item options = {}, &block
+
+        options = @filters.merge(options)
+
+        options[:namespace] = metric.namespace
+        options[:metric_name] = metric.metric_name
+        options[:dimensions] = metric.dimensions unless metric.dimensions.empty?
+
+        resp = client.describe_alarms_for_metric(options)
+        resp.data[:metric_alarms].each do |details|
+
+          alarm = Alarm.new_from(
+            :describe_alarms_for_metric,
+            details, 
+            details[:alarm_name],
+            :config => config)
+
+          yield(alarm)
+
+        end
+
+        resp.data[:next_token]
+
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_watch/metric_collection.rb

@@ -0,0 +1,131 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+    class MetricCollection
+
+      include Core::Collection::WithNextToken
+
+      # @private
+      def initialize options = {}
+        @filters = options[:filters] || {}
+        super
+      end
+
+      # Returns a new collection that will filter results when enumerated.
+      #
+      # @example Filtering by a namespace
+      #
+      #   trafic_metrics = metrics.filter('namespace', 'traffic')
+      #
+      # @example Filtering by a metric name
+      #
+      #   my_metric = metrics.filter('metric_name', 'my-metric').first
+      #
+      # @example Filtering by one or more dimensions
+      #
+      #   metrics = metrics.filter('dimensions', [
+      #     { :name => 'n1', :value => 'v1' },
+      #     { :name => 'n2', :value => 'v2' },
+      #     { :name => 'n3', :value => 'v3' },
+      #   ])
+      #
+      # @param [String,Symbol] name
+      # @param [String,Array<String>] value
+      # @return [MetricCollection]
+      def filter name, value
+        filters = @filters.merge(name.to_s.to_sym => value)
+        MetricCollection.new(:filters => filters, :config => config)
+      end
+
+      # @param [String] namespace
+      # @return [MetricCollection]
+      def with_namespace namespace
+        filter(:namespace, namespace)
+      end
+
+      # @param [String] name
+      # @return [MetricCollection]
+      def with_metric_name name
+        filter(:metric_name, name)
+      end
+
+      # Returns a collection filtered by the given dimension:
+      #
+      #   metric = metrics.with_dimension('name', 'value').first
+      #
+      # You can chain calls to #with_dimension.  Additional dimensions are
+      # added.
+      #
+      #   metrics = metrics.
+      #     with_dimension('d1', 'v1').
+      #     with_dimension('d2', 'v2').
+      #     with_dimension('d3', 'v3')
+      #
+      #   metrics.each{|metric|} # filtered by all three dimensions
+      #
+      # @param [String] name
+      # @param [String] value
+      # @return [MetricCollection]
+      def with_dimension name, value
+        with_dimensions([{ :name => name, :value => value }])
+      end
+
+      # Returns a collection filtered by the given dimensions.
+      #
+      #   metrics.with_dimensions([
+      #     { :name => 'd1', :value => 'v1' },
+      #     { :name => 'd2', :value => 'v2' },
+      #     { :name => 'd3', :value => 'v3' },
+      #   ]).each do |metric|
+      #     # ...
+      #   end
+      #
+      # Multiple calls to #with_dimensions will add to previous dimensions.
+      # @param [Array<Hash>] dimensions An array of dimensions.  Each dimension
+      #   should be a Hash with a +:name+ and +:value+.
+      # @return [MetricCollection]
+      def with_dimensions *dimensions
+        dimensions = @filters[:dimensions] || []
+        dimensions += dimensions.flatten
+        filter(:dimensions, dimensions)
+      end
+      
+      protected
+
+      def _each_item next_token, options = {}, &block
+
+        options = @filters.merge(options)
+        options[:next_token] = next_token if next_token
+
+        resp = client.list_metrics(options)
+        resp.data[:metrics].each do |details|
+
+          metric = Metric.new_from(
+            :list_metrics, details, 
+            details[:namespace],
+            details[:metric_name],
+            details.merge(:config => config))
+
+          yield(metric)
+
+        end
+
+        resp.data[:next_token]
+
+      end
+
+    end
+  end
+end