gcloud 0.0.4 → 0.0.6

data/packages/gsutil/boto/boto/ec2/cloudwatch/alarm.py

@@ -0,0 +1,316 @@
+# Copyright (c) 2010 Reza Lotun http://reza.lotun.name
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish, dis-
+# tribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the fol-
+# lowing conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
+# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#
+
+from datetime import datetime
+from boto.resultset import ResultSet
+from boto.ec2.cloudwatch.listelement import ListElement
+from boto.ec2.cloudwatch.dimension import Dimension
+from boto.compat import json
+
+
+class MetricAlarms(list):
+    def __init__(self, connection=None):
+        """
+        Parses a list of MetricAlarms.
+        """
+        list.__init__(self)
+        self.connection = connection
+
+    def startElement(self, name, attrs, connection):
+        if name == 'member':
+            metric_alarm = MetricAlarm(connection)
+            self.append(metric_alarm)
+            return metric_alarm
+
+    def endElement(self, name, value, connection):
+        pass
+
+
+class MetricAlarm(object):
+
+    OK = 'OK'
+    ALARM = 'ALARM'
+    INSUFFICIENT_DATA = 'INSUFFICIENT_DATA'
+
+    _cmp_map = {
+                    '>=': 'GreaterThanOrEqualToThreshold',
+                    '>':  'GreaterThanThreshold',
+                    '<':  'LessThanThreshold',
+                    '<=': 'LessThanOrEqualToThreshold',
+               }
+    _rev_cmp_map = dict((v, k) for (k, v) in _cmp_map.iteritems())
+
+    def __init__(self, connection=None, name=None, metric=None,
+                 namespace=None, statistic=None, comparison=None,
+                 threshold=None, period=None, evaluation_periods=None,
+                 unit=None, description='', dimensions=None,
+                 alarm_actions=None, insufficient_data_actions=None,
+                 ok_actions=None):
+        """
+        Creates a new Alarm.
+
+        :type name: str
+        :param name: Name of alarm.
+
+        :type metric: str
+        :param metric: Name of alarm's associated metric.
+
+        :type namespace: str
+        :param namespace: The namespace for the alarm's metric.
+
+        :type statistic: str
+        :param statistic: The statistic to apply to the alarm's associated
+                          metric.
+                          Valid values: SampleCount|Average|Sum|Minimum|Maximum
+
+        :type comparison: str
+        :param comparison: Comparison used to compare statistic with threshold.
+                           Valid values: >= | > | < | <=
+
+        :type threshold: float
+        :param threshold: The value against which the specified statistic
+                          is compared.
+
+        :type period: int
+        :param period: The period in seconds over which teh specified
+                       statistic is applied.
+
+        :type evaluation_periods: int
+        :param evaluation_period: The number of periods over which data is
+                                  compared to the specified threshold.
+
+        :type unit: str
+        :param unit: Allowed Values are:
+                     Seconds|Microseconds|Milliseconds,
+                     Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes,
+                     Bits|Kilobits|Megabits|Gigabits|Terabits,
+                     Percent|Count|
+                     Bytes/Second|Kilobytes/Second|Megabytes/Second|
+                     Gigabytes/Second|Terabytes/Second,
+                     Bits/Second|Kilobits/Second|Megabits/Second,
+                     Gigabits/Second|Terabits/Second|Count/Second|None
+
+        :type description: str
+        :param description: Description of MetricAlarm
+
+        :type dimensions: list of dicts
+        :param description: Dimensions of alarm, such as:
+                            [{'InstanceId':['i-0123456,i-0123457']}]
+        
+        :type alarm_actions: list of strs
+        :param alarm_actions: A list of the ARNs of the actions to take in
+                              ALARM state
+        
+        :type insufficient_data_actions: list of strs
+        :param insufficient_data_actions: A list of the ARNs of the actions to
+                                          take in INSUFFICIENT_DATA state
+        
+        :type ok_actions: list of strs
+        :param ok_actions: A list of the ARNs of the actions to take in OK state
+        """
+        self.name = name
+        self.connection = connection
+        self.metric = metric
+        self.namespace = namespace
+        self.statistic = statistic
+        if threshold is not None:
+            self.threshold = float(threshold)
+        else:
+            self.threshold = None
+        self.comparison = self._cmp_map.get(comparison)
+        if period is not None:
+            self.period = int(period)
+        else:
+            self.period = None
+        if evaluation_periods is not None:
+            self.evaluation_periods = int(evaluation_periods)
+        else:
+            self.evaluation_periods = None
+        self.actions_enabled = None
+        self.alarm_arn = None
+        self.last_updated = None
+        self.description = description
+        self.dimensions = dimensions
+        self.state_reason = None
+        self.state_value = None
+        self.unit = unit
+        self.alarm_actions = alarm_actions
+        self.insufficient_data_actions = insufficient_data_actions
+        self.ok_actions = ok_actions
+
+    def __repr__(self):
+        return 'MetricAlarm:%s[%s(%s) %s %s]' % (self.name, self.metric,
+                                                 self.statistic,
+                                                 self.comparison,
+                                                 self.threshold)
+
+    def startElement(self, name, attrs, connection):
+        if name == 'AlarmActions':
+            self.alarm_actions = ListElement()
+            return self.alarm_actions
+        elif name == 'InsufficientDataActions':
+            self.insufficient_data_actions = ListElement()
+            return self.insufficient_data_actions
+        elif name == 'OKActions':
+            self.ok_actions = ListElement()
+            return self.ok_actions
+        elif name == 'Dimensions':
+            self.dimensions = Dimension()
+            return self.dimensions
+        else:
+            pass
+
+    def endElement(self, name, value, connection):
+        if name == 'ActionsEnabled':
+            self.actions_enabled = value
+        elif name == 'AlarmArn':
+            self.alarm_arn = value
+        elif name == 'AlarmConfigurationUpdatedTimestamp':
+            self.last_updated = value
+        elif name == 'AlarmDescription':
+            self.description = value
+        elif name == 'AlarmName':
+            self.name = value
+        elif name == 'ComparisonOperator':
+            setattr(self, 'comparison', self._rev_cmp_map[value])
+        elif name == 'EvaluationPeriods':
+            self.evaluation_periods = int(value)
+        elif name == 'MetricName':
+            self.metric = value
+        elif name == 'Namespace':
+            self.namespace = value
+        elif name == 'Period':
+            self.period = int(value)
+        elif name == 'StateReason':
+            self.state_reason = value
+        elif name == 'StateValue':
+            self.state_value = value
+        elif name == 'Statistic':
+            self.statistic = value
+        elif name == 'Threshold':
+            self.threshold = float(value)
+        elif name == 'Unit':
+            self.unit = value
+        else:
+            setattr(self, name, value)
+
+    def set_state(self, value, reason, data=None):
+        """ Temporarily sets the state of an alarm.
+
+        :type value: str
+        :param value: OK | ALARM | INSUFFICIENT_DATA
+
+        :type reason: str
+        :param reason: Reason alarm set (human readable).
+
+        :type data: str
+        :param data: Reason data (will be jsonified).
+        """
+        return self.connection.set_alarm_state(self.name, reason, value, data)
+
+    def update(self):
+        return self.connection.update_alarm(self)
+
+    def enable_actions(self):
+        return self.connection.enable_alarm_actions([self.name])
+
+    def disable_actions(self):
+        return self.connection.disable_alarm_actions([self.name])
+
+    def describe_history(self, start_date=None, end_date=None, max_records=None,
+                         history_item_type=None, next_token=None):
+        return self.connection.describe_alarm_history(self.name, start_date,
+                                                      end_date, max_records,
+                                                      history_item_type,
+                                                      next_token)
+
+    def add_alarm_action(self, action_arn=None):
+        """
+        Adds an alarm action, represented as an SNS topic, to this alarm. 
+        What do do when alarm is triggered.
+
+        :type action_arn: str
+        :param action_arn: SNS topics to which notification should be 
+                           sent if the alarm goes to state ALARM.
+        """
+        if not action_arn:
+            return # Raise exception instead?
+        self.actions_enabled = 'true'
+        self.alarm_actions.append(action_arn)
+
+    def add_insufficient_data_action(self, action_arn=None):
+        """
+        Adds an insufficient_data action, represented as an SNS topic, to
+        this alarm. What to do when the insufficient_data state is reached.
+
+        :type action_arn: str
+        :param action_arn: SNS topics to which notification should be 
+                           sent if the alarm goes to state INSUFFICIENT_DATA.
+        """
+        if not action_arn:
+            return
+        self.actions_enabled = 'true'
+        self.insufficient_data_actions.append(action_arn)
+    
+    def add_ok_action(self, action_arn=None):
+        """
+        Adds an ok action, represented as an SNS topic, to this alarm. What
+        to do when the ok state is reached.
+
+        :type action_arn: str
+        :param action_arn: SNS topics to which notification should be 
+                           sent if the alarm goes to state INSUFFICIENT_DATA.
+        """
+        if not action_arn:
+            return
+        self.actions_enabled = 'true'
+        self.ok_actions.append(action_arn)
+
+    def delete(self):
+        self.connection.delete_alarms([self.name])
+
+class AlarmHistoryItem(object):
+    def __init__(self, connection=None):
+        self.connection = connection
+
+    def __repr__(self):
+        return 'AlarmHistory:%s[%s at %s]' % (self.name, self.summary, self.timestamp)
+
+    def startElement(self, name, attrs, connection):
+        pass
+
+    def endElement(self, name, value, connection):
+        if name == 'AlarmName':
+            self.name = value
+        elif name == 'HistoryData':
+            self.data = json.loads(value)
+        elif name == 'HistoryItemType':
+            self.tem_type = value
+        elif name == 'HistorySummary':
+            self.summary = value
+        elif name == 'Timestamp':
+            try:
+                self.timestamp = datetime.strptime(value,
+                                                   '%Y-%m-%dT%H:%M:%S.%fZ')
+            except ValueError:
+                self.timestamp = datetime.strptime(value, '%Y-%m-%dT%H:%M:%SZ')
+

data/packages/gsutil/boto/boto/ec2/cloudwatch/datapoint.py

@@ -0,0 +1,40 @@
+# Copyright (c) 2006-2009 Mitch Garnaat http://garnaat.org/
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish, dis-
+# tribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the fol-
+# lowing conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
+# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#
+from datetime import datetime
+
+class Datapoint(dict):
+
+    def __init__(self, connection=None):
+        dict.__init__(self)
+        self.connection = connection
+
+    def startElement(self, name, attrs, connection):
+        pass
+
+    def endElement(self, name, value, connection):
+        if name in ['Average', 'Maximum', 'Minimum', 'Sum', 'SampleCount']:
+            self[name] = float(value)
+        elif name == 'Timestamp':
+            self[name] = datetime.strptime(value, '%Y-%m-%dT%H:%M:%SZ')
+        elif name != 'member':
+            self[name] = value
+

data/packages/gsutil/boto/boto/ec2/cloudwatch/dimension.py

@@ -0,0 +1,38 @@
+# Copyright (c) 2006-2012 Mitch Garnaat http://garnaat.org/
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish, dis-
+# tribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the fol-
+# lowing conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
+# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#
+
+class Dimension(dict):
+
+    def startElement(self, name, attrs, connection):
+        pass
+
+    def endElement(self, name, value, connection):
+        if name == 'Name':
+            self._name = value
+        elif name == 'Value':
+            if self._name in self:
+                self[self._name].append(value)
+            else:
+                self[self._name] = [value]
+        else:
+            setattr(self, name, value)
+

data/packages/gsutil/boto/boto/ec2/cloudwatch/listelement.py

@@ -0,0 +1,31 @@
+# Copyright (c) 2006-2009 Mitch Garnaat http://garnaat.org/
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish, dis-
+# tribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the fol-
+# lowing conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
+# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+class ListElement(list):
+
+    def startElement(self, name, attrs, connection):
+        pass
+
+    def endElement(self, name, value, connection):
+        if name == 'member':
+            self.append(value)
+    
+    

data/packages/gsutil/boto/boto/ec2/cloudwatch/metric.py

@@ -0,0 +1,175 @@
+# Copyright (c) 2006-2012 Mitch Garnaat http://garnaat.org/
+# Copyright (c) 2012 Amazon.com, Inc. or its affiliates.
+# All Rights Reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish, dis-
+# tribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the fol-
+# lowing conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
+# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#
+
+from boto.ec2.cloudwatch.alarm import MetricAlarm
+from boto.ec2.cloudwatch.dimension import Dimension
+
+
+class Metric(object):
+
+    Statistics = ['Minimum', 'Maximum', 'Sum', 'Average', 'SampleCount']
+    Units = ['Seconds', 'Microseconds', 'Milliseconds', 'Bytes', 'Kilobytes',
+             'Megabytes', 'Gigabytes', 'Terabytes', 'Bits', 'Kilobits',
+             'Megabits', 'Gigabits', 'Terabits', 'Percent', 'Count',
+             'Bytes/Second', 'Kilobytes/Second', 'Megabytes/Second',
+             'Gigabytes/Second', 'Terabytes/Second', 'Bits/Second',
+             'Kilobits/Second', 'Megabits/Second', 'Gigabits/Second',
+             'Terabits/Second', 'Count/Second', None]
+
+    def __init__(self, connection=None):
+        self.connection = connection
+        self.name = None
+        self.namespace = None
+        self.dimensions = None
+
+    def __repr__(self):
+        return 'Metric:%s' % self.name
+
+    def startElement(self, name, attrs, connection):
+        if name == 'Dimensions':
+            self.dimensions = Dimension()
+            return self.dimensions
+
+    def endElement(self, name, value, connection):
+        if name == 'MetricName':
+            self.name = value
+        elif name == 'Namespace':
+            self.namespace = value
+        else:
+            setattr(self, name, value)
+
+    def query(self, start_time, end_time, statistics, unit=None, period=60):
+        """
+        :type start_time: datetime
+        :param start_time: The time stamp to use for determining the
+            first datapoint to return. The value specified is
+            inclusive; results include datapoints with the time stamp
+            specified.
+
+        :type end_time: datetime
+        :param end_time: The time stamp to use for determining the
+            last datapoint to return. The value specified is
+            exclusive; results will include datapoints up to the time
+            stamp specified.
+
+        :type statistics: list
+        :param statistics: A list of statistics names Valid values:
+            Average | Sum | SampleCount | Maximum | Minimum
+
+        :type dimensions: dict
+        :param dimensions: A dictionary of dimension key/values where
+                           the key is the dimension name and the value
+                           is either a scalar value or an iterator
+                           of values to be associated with that
+                           dimension.
+
+        :type unit: string
+        :param unit: The unit for the metric.  Value values are:
+            Seconds | Microseconds | Milliseconds | Bytes | Kilobytes |
+            Megabytes | Gigabytes | Terabytes | Bits | Kilobits |
+            Megabits | Gigabits | Terabits | Percent | Count |
+            Bytes/Second | Kilobytes/Second | Megabytes/Second |
+            Gigabytes/Second | Terabytes/Second | Bits/Second |
+            Kilobits/Second | Megabits/Second | Gigabits/Second |
+            Terabits/Second | Count/Second | None
+
+        :type period: integer
+        :param period: The granularity, in seconds, of the returned datapoints.
+            Period must be at least 60 seconds and must be a multiple
+            of 60. The default value is 60.
+
+        """
+        if not isinstance(statistics, list):
+            statistics = [statistics]
+        return self.connection.get_metric_statistics(period,
+                                                     start_time,
+                                                     end_time,
+                                                     self.name,
+                                                     self.namespace,
+                                                     statistics,
+                                                     self.dimensions,
+                                                     unit)
+
+    def create_alarm(self, name, comparison, threshold,
+                     period, evaluation_periods,
+                     statistic, enabled=True, description=None,
+                     dimensions=None, alarm_actions=None, ok_actions=None,
+                     insufficient_data_actions=None, unit=None):
+        """
+        Creates or updates an alarm and associates it with this metric.
+        Optionally, this operation can associate one or more
+        Amazon Simple Notification Service resources with the alarm.
+
+        When this operation creates an alarm, the alarm state is immediately
+        set to INSUFFICIENT_DATA. The alarm is evaluated and its StateValue is
+        set appropriately. Any actions associated with the StateValue is then
+        executed.
+
+        When updating an existing alarm, its StateValue is left unchanged.
+
+        :type alarm: boto.ec2.cloudwatch.alarm.MetricAlarm
+        :param alarm: MetricAlarm object.
+        """
+        if not dimensions:
+            dimensions = self.dimensions
+        alarm = MetricAlarm(self.connection, name, self.name,
+                            self.namespace, statistic, comparison,
+                            threshold, period, evaluation_periods,
+                            unit, description, dimensions,
+                            alarm_actions, insufficient_data_actions,
+                            ok_actions)
+        if self.connection.put_metric_alarm(alarm):
+            return alarm
+
+    def describe_alarms(self, period=None, statistic=None,
+                        dimensions=None, unit=None):
+        """
+        Retrieves all alarms for this metric. Specify a statistic, period,
+        or unit to filter the set of alarms further.
+
+        :type period: int
+        :param period: The period in seconds over which the statistic
+            is applied.
+
+        :type statistic: string
+        :param statistic: The statistic for the metric.
+
+        :param dimension_filters: A dictionary containing name/value
+            pairs that will be used to filter the results.  The key in
+            the dictionary is the name of a Dimension.  The value in
+            the dictionary is either a scalar value of that Dimension
+            name that you want to filter on, a list of values to
+            filter on or None if you want all metrics with that
+            Dimension name.
+
+        :type unit: string
+
+        :rtype list
+        """
+        return self.connection.describe_alarms_for_metric(self.name,
+                                                          self.namespace,
+                                                          period,
+                                                          statistic,
+                                                          dimensions,
+                                                          unit)