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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
# Copyright 2011-2013 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_name, metric_name],
[:dimensions, dimensions],
]
end
def get_resource attr_name = nil
client.list_metrics(resource_options)
end
end
end
end
|
