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
136
137
138
139
140
141
142
143
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.service.amazon.ec2.cloudwatch">
<title>Zend_Service_Amazon_Ec2: CloudWatch Monitoring</title>
<para>
Amazon CloudWatch is an easy-to-use web service that provides
comprehensive monitoring for Amazon Elastic Compute Cloud (Amazon
<acronym>EC2</acronym>) and Elastic Load Balancing. For more details information
check out the <ulink
url="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/Welcome.html">
Amazon CloudWatch Developers Guide</ulink>
</para>
<sect2 id="zend.service.amazon.ec2.cloudwatch.usage">
<title>CloudWatch Usage</title>
<example id="zend.service.amazon.ec2.cloudwatch.usage.list">
<title>Listing Aviable Metrics</title>
<para>
<methodname>listMetrics()</methodname> returns a list of up to 500 valid metrics for
which there is recorded data available to a you and a NextToken string
that can be used to query for the next set of results.
</para>
<programlisting language="php"><![CDATA[
$ec2_ebs = new Zend_Service_Amazon_Ec2_CloudWatch('aws_key','aws_secret_key');
$return = $ec2_ebs->listMetrics();
]]></programlisting>
</example>
<example id="zend.service.amazon.ec2.cloudwatch.usage.getmetricstatistics">
<title>Return Statistics for a given metric</title>
<para>
<methodname>getMetricStatistics()</methodname> Returns data for one or more
statistics of given a metric.
</para>
<para>
<note>
<para>
The maximum number of datapoints that the Amazon CloudWatch service will
return in a single GetMetricStatistics request is 1,440. If a request is
made that would generate more datapoints than this amount, Amazon CloudWatch
will return an error. You can alter your request by narrowing the time range
(StartTime, EndTime) or increasing the Period in your single request. You
may also get all of the data at the granularity you originally asked for
by making multiple requests with adjacent time ranges.
</para>
</note>
</para>
<para>
<methodname>getMetricStatistics()</methodname> only requires two parameters but it
also has four additional parameters that are optional.
</para>
<itemizedlist>
<listitem>
<para><emphasis>Required:</emphasis></para>
</listitem>
<listitem>
<para>
<emphasis>MeasureName</emphasis> The measure name that corresponds to
the measure for the gathered metric. Valid <acronym>EC2</acronym> Values are
<acronym>CPU</acronym>Utilization, NetworkIn, NetworkOut, DiskWriteOps
DiskReadBytes, DiskReadOps, DiskWriteBytes. Valid Elastic
Load Balancing Metrics are Latency, RequestCount, HealthyHostCount
UnHealthyHostCount. <ulink
url="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html#ec2-metricscollected">For
more information click here</ulink>
</para>
</listitem>
<listitem>
<para>
<emphasis>Statistics</emphasis> The statistics to be returned for the given
metric. Valid values are Average, Maximum, Minimum, Samples, Sum. You can
specify this as a string or as an array of values. If you don't specify one
it will default to Average instead of failing out. If you specify an
incorrect option it will just skip it. <ulink
url="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/US_GetStatistics.html">For
more information click here</ulink>
</para>
</listitem>
<listitem>
<para><emphasis>Optional:</emphasis></para>
</listitem>
<listitem>
<para>
<emphasis>Dimensions</emphasis> Amazon CloudWatch allows you to specify one
Dimension to further filter metric data on. If you don't specify a
dimension, the service returns the aggregate of all the measures with the
given measure name and time range.
</para>
</listitem>
<listitem>
<para>
<emphasis>Unit</emphasis> The standard unit of Measurement for a given
Measure. Valid Values: Seconds, Percent, Bytes, Bits, Count, Bytes/Second,
Bits/Second, Count/Second, and None. Constraints: When using count/second
as the unit, you should use Sum as the statistic instead of Average.
Otherwise, the sample returns as equal to the number of requests
instead of the number of 60-second intervals. This will cause the Average
to always equals one when the unit is count/second.
</para>
</listitem>
<listitem>
<para>
<emphasis>StartTime</emphasis> The timestamp of the first datapoint to
return, inclusive. For example, 2008-02-26T19:00:00+00:00. We round your
value down to the nearest minute. You can set your start time for more than
two weeks in the past. However, you will only get data for the past two
weeks. (in <acronym>ISO</acronym> 8601 format). Constraints: Must be before
EndTime.
</para>
</listitem>
<listitem>
<para>
<emphasis>EndTime</emphasis> The timestamp to use for determining the last
datapoint to return. This is the last datapoint to fetch, exclusive. For
example, 2008-02-26T20:00:00+00:00 (in <acronym>ISO</acronym> 8601 format).
</para>
</listitem>
</itemizedlist>
<programlisting language="php"><![CDATA[
$ec2_ebs = new Zend_Service_Amazon_Ec2_CloudWatch('aws_key','aws_secret_key');
$return = $ec2_ebs->getMetricStatistics(
array('MeasureName' => 'NetworkIn',
'Statistics' => array('Average')));
]]></programlisting>
</example>
</sect2>
</sect1>
|
