File: get_metric_statistics.rb

package info (click to toggle)
ruby-fog-aws 3.3.0-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 7,816 kB
  • sloc: ruby: 68,587; makefile: 6
file content (46 lines) | stat: -rw-r--r-- 2,239 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
module Fog
  module AWS
    class CloudWatch
      class Real
        require 'fog/aws/parsers/cloud_watch/get_metric_statistics'

        # Fetch datapoints for a metric. At most 1440 datapoints will be returned, the most datapoints that can be queried is 50850
        # StartTime is capped to 2 weeks ago
        # ==== Options
        # * Namespace<~String>: the namespace of the metric
        # * MetricName<~String>: the name of the metric
        # * StartTime<~Datetime>: when to start fetching datapoints from (inclusive)
        # * EndTime<~Datetime>: used to determine the last datapoint to fetch (exclusive)
        # * Period<~Integer>: Granularity, in seconds of the returned datapoints. Must be a multiple of 60, and at least 60
        # * Statistics<~Array>: An array of up to 5 strings, which name the statistics to return
        # * Unit<~String>: The unit for the metric
        # * Dimensions<~Array>: a list of dimensions to filter against (optional)
        #     Name : The name of the dimension
        #     Value : The value to filter against
        # ==== Returns
        # * response<~Excon::Response>:
        #
        # ==== See Also
        # http://docs.amazonwebservices.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html
        #
        def get_metric_statistics(options={})
          %w{Statistics StartTime EndTime Period MetricName Namespace}.each do |required_parameter|
            raise ArgumentError, "Must provide #{required_parameter}" unless options.key?(required_parameter)
          end
          statistics = options.delete 'Statistics'
          options.merge!(AWS.indexed_param('Statistics.member.%d', [*statistics]))

          if dimensions = options.delete('Dimensions')
            options.merge!(AWS.indexed_param('Dimensions.member.%d.Name', dimensions.map {|dimension| dimension['Name']}))
            options.merge!(AWS.indexed_param('Dimensions.member.%d.Value', dimensions.map {|dimension| dimension['Value']}))
          end

          request({
              'Action'    => 'GetMetricStatistics',
              :parser     => Fog::Parsers::AWS::CloudWatch::GetMetricStatistics.new
            }.merge(options))
        end
      end
    end
  end
end