feat: dogstatsd client sends timestamp

Author: apiarian-datadog

datadog_lambda/dogstatsd.py

@@ -1,11 +1,10 @@
+import errno
 import logging
 import os
-import socket
-import errno
 import re
+import socket
 from threading import Lock
 
-
 MIN_SEND_BUFFER_SIZE = 32 * 1024
 log = logging.getLogger("datadog_lambda.dogstatsd")
 
@@ -55,14 +54,17 @@ def _get_udp_socket(cls, host, port):
 
         return sock
 
-    def distribution(self, metric, value, tags=None):
+    def distribution(self, metric, value, tags=None, timestamp=None):
         """
-        Send a global distribution value, optionally setting tags.
+        Send a global distribution value, optionally setting tags. The optional
+        timestamp should be an integer representing seconds since the epoch
+        (January 1, 1970, 00:00:00 UTC).
 
         >>> statsd.distribution("uploaded.file.size", 1445)
         >>> statsd.distribution("album.photo.count", 26, tags=["gender:female"])
+        >>> statsd.distribution("historic.file.count", 5, timestamp=int(datetime(2020, 2, 14, 12, 0, 0).timestamp()))
         """
-        self._report(metric, "d", value, tags)
+        self._report(metric, "d", value, tags, timestamp)
 
     def close_socket(self):
         """
@@ -84,20 +86,21 @@ def normalize_tags(self, tag_list):
             for tag in tag_list
         ]
 
-    def _serialize_metric(self, metric, metric_type, value, tags):
+    def _serialize_metric(self, metric, metric_type, value, tags, timestamp):
         # Create/format the metric packet
-        return "%s:%s|%s%s" % (
+        return "%s:%s|%s%s%s" % (
             metric,
             value,
             metric_type,
             ("|#" + ",".join(self.normalize_tags(tags))) if tags else "",
+            ("|T" + str(timestamp)) if timestamp is not None else "",
         )
 
-    def _report(self, metric, metric_type, value, tags):
+    def _report(self, metric, metric_type, value, tags, timestamp):
         if value is None:
             return
 
-        payload = self._serialize_metric(metric, metric_type, value, tags)
+        payload = self._serialize_metric(metric, metric_type, value, tags, timestamp)
 
         # Send it
         self._send_to_server(payload)

tests/test_dogstatsd.py

@@ -1,5 +1,5 @@
-from collections import deque
 import unittest
+from collections import deque
 
 from datadog_lambda.dogstatsd import statsd
 
@@ -36,16 +36,20 @@ def test_init(self):
         self.assertEqual(statsd.port, 8125)
         self.assertEqual(statsd.encoding, "utf-8")
 
-    def test_distribution_no_tags(self):
-        statsd.distribution("my.test.metric", 3)
+    def _checkOnlyOneMetric(self, value):
         payload = self.recv()
         metrics = payload.split("\n")
         self.assertEqual(len(metrics), 1)
-        self.assertEqual("my.test.metric:3|d", metrics[0])
+        self.assertEqual(value, metrics[0])
+
+    def test_distribution_no_tags(self):
+        statsd.distribution("my.test.metric", 3)
+        self._checkOnlyOneMetric("my.test.metric:3|d")
 
     def test_distribution_with_tags(self):
         statsd.distribution("my.test.tags.metric", 3, tags=["taga:valuea,tagb:valueb"])
-        payload = self.recv()
-        metrics = payload.split("\n")
-        self.assertEqual(len(metrics), 1)
-        self.assertEqual("my.test.tags.metric:3|d|#taga:valuea_tagb:valueb", metrics[0])
+        self._checkOnlyOneMetric("my.test.tags.metric:3|d|#taga:valuea_tagb:valueb")
+
+    def test_distribution_with_timestamp(self):
+        statsd.distribution("my.test.timestamp.metric", 9, timestamp=123456789)
+        self._checkOnlyOneMetric("my.test.timestamp.metric:9|d|T123456789")