Add metric metadata endpoints (#181)

[api] new metadata resource

Author: flapjack103

datadog/api/__init__.py

@@ -22,6 +22,7 @@
 from datadog.api.timeboards import Timeboard
 from datadog.api.events import Event
 from datadog.api.infrastructure import Infrastructure
+from datadog.api.metadata import Metadata
 from datadog.api.metrics import Metric
 from datadog.api.monitors import Monitor
 from datadog.api.screenboards import Screenboard

datadog/api/metadata.py

@@ -0,0 +1,61 @@
+# datadog
+from datadog.api.resources import GetableAPIResource, UpdatableAPIResource
+
+
+class Metadata(GetableAPIResource, UpdatableAPIResource):
+    """
+    A wrapper around Metric Metadata HTTP API
+    """
+    _class_url = '/metrics'
+    _json_name = 'metrics'
+
+    @classmethod
+    def get(cls, metric_name):
+        """
+        Get metadata information on an existing Datadog metric
+
+        param metric_name: metric name (ex. system.cpu.idle)
+
+        :returns: JSON response from HTTP request
+        """
+        if not metric_name:
+            raise KeyError("'metric_name' parameter is required")
+
+        return super(Metadata, cls).get(metric_name)
+
+    @classmethod
+    def update(cls, metric_name, **params):
+        """
+        Update metadata fields for an existing Datadog metric.
+        If the metadata does not exist for the metric it is created by
+        the update.
+
+        :param type: type of metric (ex. "gauge", "rate", etc.)
+                            see http://docs.datadoghq.com/metrictypes/
+        :type type: string
+
+        :param description: description of the metric
+        :type description: string
+
+        :param short_name: short name of the metric
+        :type short_name: string
+
+        :param unit: unit type associated with the metric (ex. "byte", "operation")
+                     see http://docs.datadoghq.com/units/ for full list
+        :type unit: string
+
+        :param per_unit: per unit type (ex. "second" as in "queries per second")
+                         see http://docs.datadoghq.com/units/ for full list
+        :type per_unit: string
+
+        :param statsd_interval: statsd flush interval for metric in seconds (if applicable)
+        :type statsd_interval: integer
+
+        :return: JSON response from HTTP request
+
+        >>> api.Metadata.update(metric_name='api.requests.served', metric_type="counter")
+        """
+        if not metric_name:
+            raise KeyError("'metric_name' parameter is required")
+
+        return super(Metadata, cls).update(id=metric_name, **params)

datadog/dogshell/__init__.py

@@ -68,5 +68,6 @@ def main():
 
     args.func(args)
 
+
 if __name__ == '__main__':
     main()

datadog/dogshell/event.py

@@ -10,6 +10,9 @@
 from datadog.util.compat import json
 
 
+time_pat = re.compile(r'(?P<delta>[0-9]*\.?[0-9]+)(?P<unit>[mhd])')
+
+
 def prettyprint_event(event):
     title = event['title'] or ''
     text = event.get('text', '') or ''
@@ -34,8 +37,6 @@ def prettyprint_event_details(event):
 def print_event_details(event):
     prettyprint_event(event)
 
-time_pat = re.compile(r'(?P<delta>[0-9]*\.?[0-9]+)(?P<unit>[mhd])')
-
 
 def parse_time(timestring):
     now = time.mktime(datetime.datetime.now().timetuple())
@@ -44,7 +45,7 @@ def parse_time(timestring):
     else:
         try:
             t = int(timestring)
-        except:
+        except Exception:
             match = time_pat.match(timestring)
             if match is None:
                 raise Exception

datadog/dogshell/wrap.py

@@ -321,5 +321,6 @@ def main():
 
     sys.exit(returncode)
 
+
 if __name__ == '__main__':
     main()