1EUWATCH-PUT-DATA(1) BSD General Commands Manual EUWATCH-PUT-DATA(1)
2
4 euwatch-put-data — add data points to a CloudWatch metric
5
7 euwatch-put-data -n NAMESPACE [-v FLOAT] ...
8 euwatch-put-data -n NAMESPACE [-s KEY1=VALUE1,KEY2-VALUE2,...] ...
9
11 The euwatch-put-data utility adds data to a CloudWatch metric. A metric
12 datum consists of a metric name, any of several attributes, and either a
13 simple, numeric value (-v) or a set of statistical values (-s).
14 All of the data in a given invocation of euwatch-put-data must belong to
16 one namespace, whose name is specified with -n.
17 Metric data consist of one or more of the attributes below. These
19 attributes may be specified using dedicated options that apply to all
20 data in a given invocation of euwatch-put-data, or for individual data as
21 part of an input to -s. A metric name is required for all metric data.
22 Name Option Aliases
24 MetricName -m metric
25 Dimensions -d dim
26 Timestamp -t ts
27 Unit -u unit
28 Simple metric data have one additional attribute for their values.
30 Name Option Aliases
32 Value -v val
33 Statistical metric data have four additional attributes. These
35 attributes cannot be specified using separate command line options.
36 Name Aliases
38 Maximum max
39 Minimum min
40 SampleCount count
41 Sum sum
42 Optional arguments:
44 -n NAMESPACE, --namespace NAMESPACE
45 The namespace for all the data points in the current invocation
46 of euwatch-put-data. This option is required.
47 -v FLOAT, --value FLOAT
49 Each use of the -v option specifies a new simple metric datum. A
50 value for a simple metric datum. To specify other attributes for
51 simple data points specifed using this option, use the corre‐
52 sponding options for those attributes from the tables above. In
53 particular, -m is required when -v is used.
54 -s KEY=VALUE,..., --metric-datum KEY=VALUE,...
56 The -s option allows for full control of the attributes of each
57 metric datum. This mode of entry is required for specifying sta‐
58 tistical data points. To specify a datum using this option, join
59 each attribute's name or alias from the tables above with its
60 value using the “=” character, and join each of those pairs with
61 “,” characters. If a value contains a “,” character, surround
62 the entire attribute with double-quotes, as in the following
63 example.
64 "Dimensions=ImageId=ami-98765432,InstanceId:i-12345678"
66 Note that most shell environments require double-quotes to be
68 escaped.
69 “Dimensions” attributes are specified as a comma-separated list
71 of dimension names and values that are themselves separated by
72 “:” characters.
73 Attributes specified via -s take precedence over those specified
75 with attribute-specific options, such as -d.
76 See the EXAMPLES section for some illustrative examples.
78 -m METRIC, --metric-name METRIC
80 The name of the metric to add data to. This is required unless
81 all metric data specify metric names themselves.
82 -d KEY=VALUE,..., --dimensions KEY=VALUE,...
84 A list of dimensions to associate with the new metric data.
85 -t YYYY-MM-DDThh:mm:ssZ, --timestamp YYYY-MM-DDThh:mm:ssZ
87 A timestamp for the new metric data, in a format specified by ISO
88 8601. Note that the CloudWatch service does not accept data with
89 timestamps more than two weeks in the past.
90 -u UNIT, --unit UNIT
92 The unit, such as “Bytes”, in which to report the new metric
93 data. Examples of valid units include the following:
94 Seconds
96 Microseconds
97 Milliseconds
98 Bytes
99 Kilobytes
100 Megabytes
101 Gigabytes
102 Terabytes
103 Bits
104 Kilobits
105 Megabits
106 Gigabits
107 Terabits
108 Percent
109 Count
110 Bytes/Second
111 Kilobytes/Second
112 Megabytes/Second
113 Gigabytes/Second
114 Terabytes/Second
115 Bits/Second
116 Kilobits/Second
117 Megabits/Second
118 Gigabits/Second
119 Terabits/Second
120 Count/Second
121 None
122 -h, --help
124 Show a help message and exit without doing anything.
125 -U URL, --url URL
127 The URL of the service to contact.
128 -I KEY_ID, --access-key-id KEY_ID
130 The access key ID to use to authenticate requests.
131 -S KEY. --secret-key KEY
133 The secret key to use to authenticate requests.
134 --security-token TOKEN
136 The STS security token to use to authenticate requests.
137 --region USER@REGION
139 The user and/or region name to use when looking up configuration
140 file data.
141 --debug
143 Show debugging output when running.
144 --debugger
146 Launch an interactive epdb or pdb debugger after encountering an
147 error.
148 --version
150 Show the program's version and exit.
151
153 Report that instance i-12345678 is using 747 megabytes of memory using
154 metric “MemoryUtilization” in namespace “MyNamespace”.
155 euwatch-put-data -n MyNamespace -m MemoryUtilization -u Megabytes
157 -d InstanceId=i-12345678 -v 747
158 Same as above, but using the -s option.
160 euwatch-put-data -n MyNamespace -m MemoryUtilization -u Megabytes
162 -d InstanceId=i-12345678 -s Value=747
163 Same as above, but specifying as much as possible using the -s option.
165 euwatch-put-data -n MyNamespace -s
167 MetricName=MemoryUtilization,Unit=Megabytes,Dimensions=InstanceId:i-12345678,Value=747
168 Report statistics for 50 samples from instance i-12345678 that have a
170 minimum value of 20, a maximum value of 80, and a sum of 2500 using met‐
171 ric “QueriesPerSecond”, in namespace “MyNamespace”.
172 euwatch-put-data -n MyNamespace -m QueriesPerSecond -u Count/Second
174 -d InstanceId=i-12345678 -s
175 Minimum=20,Maximum=80,Sum=2500,SampleCount=50
176 Same as above, but using aliases for attribute names.
178 euwatch-put-data -n MyNamespace -m QueriesPerSecond -u Count/Second
180 -d InstanceId=i-12345678 -s min=20,max=80,sum=2500,count=50
181 Report both of the metric data above at once. The second datum uses -s
183 to override the metric name and unit attributes specified by -m and -u,
184 but not the dimension specified by -d.
185 euwatch-put-data -n MyNamespace -m MemoryUtilization -u Megabytes
187 -d InstanceId=i-12345678 -v 747 -s
188 metric=QueriesPerSecond,unit=Count/Second,min=20,max=80,sum=2500,count=50
189
191 AWS_ACCESS_KEY_ID
192 The access key ID to use when authenticating web service
193 requests. This takes precedence over --region and
194 euca2ools.ini(5), but not -I.
195 AWS_SECRET_ACCESS_KEY
197 The secret key to use when authenticating web service requests.
198 This takes precedence over --region and euca2ools.ini(5), but not
199 -S.
200 AWS_CLOUDWATCH_URL
202 The URL of the service to contact. This takes precedence over
203 --region and euca2ools.ini(5), but not -U.
204
206 euca2ools.ini(5), euca2ools(7)
207
209 The euwatch-put-data command first appeared in euca2ools 3.0.
210 The ability to report multiple metric data in a single request and the
212 generic -s syntax that allows one to specify all attributes of a metric
213 datum first appeared in euca2ools 3.4.
214
216 euwatch-put-data requires access keys and knowledge of where to locate
217 the web services it needs to contact. It can obtain these from several
218 locations. See euca2ools(7) for more information.
219Euca2ools 3.4 December 8, 2016 Euca2ools 3.4