Merge pull request #188 from DataDog/olivierg/add-missing-timestamp

Add `timestamp` arguments to `Increment` and `Decrement` methods
DataDog · Oct 26, 2022 · 536a9fc · 536a9fc
2 parents a126d7a + e0e53b6
commit 536a9fc
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 16 deletions.
diff --git a/src/StatsdClient/DogStatsdService.cs b/src/StatsdClient/DogStatsdService.cs
@@ -106,9 +106,10 @@ public void Counter(string statName, double value, double sampleRate = 1.0, stri
         /// <param name="value">The amount of increment.</param>
         /// <param name="sampleRate">Percentage of metric to be sent.</param>
         /// <param name="tags">Array of tags to be added to the data.</param>
-        public void Increment(string statName, int value = 1, double sampleRate = 1.0, string[] tags = null)
+        /// <param name="timestamp">BETA - Please contact our support team for more information to use this feature: https://www.datadoghq.com/support/ - Timestamp at which the counter has been seen with the given value. This value is sent without any aggregation.</param>
+        public void Increment(string statName, int value = 1, double sampleRate = 1.0, string[] tags = null, DateTimeOffset? timestamp = null)
         {
-            _metricsSender?.SendMetric(MetricType.Count, statName, value, sampleRate, tags);
+            _metricsSender?.SendMetric(MetricType.Count, statName, value, sampleRate, tags, timestamp);
         }
 
         /// <summary>
@@ -118,9 +119,10 @@ public void Increment(string statName, int value = 1, double sampleRate = 1.0, s
         /// <param name="value">The amount of decrement.</param>
         /// <param name="sampleRate">Percentage of metric to be sent.</param>
         /// <param name="tags">Array of tags to be added to the data.</param>
-        public void Decrement(string statName, int value = 1, double sampleRate = 1.0, string[] tags = null)
+        /// <param name="timestamp">BETA - Please contact our support team for more information to use this feature: https://www.datadoghq.com/support/ - Timestamp at which the counter has been seen with the given value. This value is sent without any aggregation.</param>
+        public void Decrement(string statName, int value = 1, double sampleRate = 1.0, string[] tags = null, DateTimeOffset? timestamp = null)
         {
-            _metricsSender?.SendMetric(MetricType.Count, statName, -value, sampleRate, tags);
+            _metricsSender?.SendMetric(MetricType.Count, statName, -value, sampleRate, tags, timestamp);
         }
 
         /// <summary>
@@ -145,7 +147,7 @@ public void Gauge(string statName, double value, double sampleRate = 1.0, string
         /// <param name="tags">Array of tags to be added to the data.</param>
         public void Histogram(string statName, double value, double sampleRate = 1.0, string[] tags = null)
         {
-            _metricsSender?.SendMetric(MetricType.Histogram, statName, value, sampleRate, tags);
+            _metricsSender?.SendMetric(MetricType.Histogram, statName, value, sampleRate, tags, null);
         }
 
         /// <summary>
@@ -157,7 +159,7 @@ public void Histogram(string statName, double value, double sampleRate = 1.0, st
         /// <param name="tags">Array of tags to be added to the data.</param>
         public void Distribution(string statName, double value, double sampleRate = 1.0, string[] tags = null)
         {
-            _metricsSender?.SendMetric(MetricType.Distribution, statName, value, sampleRate, tags);
+            _metricsSender?.SendMetric(MetricType.Distribution, statName, value, sampleRate, tags, null);
         }
 
         /// <summary>
@@ -195,7 +197,7 @@ public void Set(string statName, string value, double sampleRate = 1.0, string[]
         /// <param name="tags">Array of tags to be added to the data.</param>
         public void Timer(string statName, double value, double sampleRate = 1.0, string[] tags = null)
         {
-            _metricsSender?.SendMetric(MetricType.Timing, statName, value, sampleRate, tags);
+            _metricsSender?.SendMetric(MetricType.Timing, statName, value, sampleRate, tags, null);
         }
 
         /// <summary>

diff --git a/src/StatsdClient/Dogstatsd.cs b/src/StatsdClient/Dogstatsd.cs
@@ -111,8 +111,9 @@ public static void Counter(string statName, double value, double sampleRate = 1.
         /// <param name="value">The amount of increment.</param>
         /// <param name="sampleRate">Percentage of metric to be sent.</param>
         /// <param name="tags">Array of tags to be added to the data.</param>
-        public static void Increment(string statName, int value = 1, double sampleRate = 1.0, string[] tags = null) =>
-            _dogStatsdService.Increment(statName: statName, value: value, sampleRate: sampleRate, tags: tags);
+        /// <param name="timestamp">BETA - Please contact our support team for more information to use this feature: https://www.datadoghq.com/support/ - Timestamp at which the counter has been seen with the given value. This value is sent without any aggregation.</param>
+        public static void Increment(string statName, int value = 1, double sampleRate = 1.0, string[] tags = null, DateTimeOffset? timestamp = null) =>
+            _dogStatsdService.Increment(statName: statName, value: value, sampleRate: sampleRate, tags: tags, timestamp: timestamp);
 
         /// <summary>
         /// Decrements the specified counter.
@@ -121,8 +122,9 @@ public static void Increment(string statName, int value = 1, double sampleRate =
         /// <param name="value">The amount of decrement.</param>
         /// <param name="sampleRate">Percentage of metric to be sent.</param>
         /// <param name="tags">Array of tags to be added to the data.</param>
-        public static void Decrement(string statName, int value = 1, double sampleRate = 1.0, string[] tags = null) =>
-            _dogStatsdService.Decrement(statName: statName, value: value, sampleRate: sampleRate, tags: tags);
+        /// <param name="timestamp">BETA - Please contact our support team for more information to use this feature: https://www.datadoghq.com/support/ - Timestamp at which the counter has been seen with the given value. This value is sent without any aggregation.</param>
+        public static void Decrement(string statName, int value = 1, double sampleRate = 1.0, string[] tags = null, DateTimeOffset? timestamp = null) =>
+            _dogStatsdService.Decrement(statName: statName, value: value, sampleRate: sampleRate, tags: tags, timestamp: timestamp);
 
         /// <summary>
         /// Records the latest fixed value for the specified named gauge.

diff --git a/src/StatsdClient/IDogStatsd.cs b/src/StatsdClient/IDogStatsd.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace StatsdClient
 {
@@ -41,7 +41,8 @@ public interface IDogStatsd : IDisposable
         /// <param name="value">The amount of decrement.</param>
         /// <param name="sampleRate">Percentage of metric to be sent.</param>
         /// <param name="tags">Array of tags to be added to the data.</param>
-        void Decrement(string statName, int value = 1, double sampleRate = 1, params string[] tags);
+        /// <param name="timestamp">BETA - Please contact our support team for more information to use this feature: https://www.datadoghq.com/support/ - Timestamp at which the counter has been seen with the given value. This value is sent without any aggregation.</param>
+        void Decrement(string statName, int value = 1, double sampleRate = 1, string[] tags = null, DateTimeOffset? timestamp = null);
 
         /// <summary>
         /// Records an event.
@@ -101,7 +102,8 @@ void Event(
         /// <param name="value">The amount of increment.</param>
         /// <param name="sampleRate">Percentage of metric to be sent.</param>
         /// <param name="tags">Array of tags to be added to the data.</param>
-        void Increment(string statName, int value = 1, double sampleRate = 1, string[] tags = null);
+        /// <param name="timestamp">BETA - Please contact our support team for more information to use this feature: https://www.datadoghq.com/support/ - Timestamp at which the counter has been seen with the given value. This value is sent without any aggregation.</param>
+        void Increment(string statName, int value = 1, double sampleRate = 1, string[] tags = null, DateTimeOffset? timestamp = null);
 
         /// <summary>
         /// Records a value for the specified set.

diff --git a/src/StatsdClient/MetricsSender.cs b/src/StatsdClient/MetricsSender.cs
@@ -65,7 +65,7 @@ public void SendServiceCheck(string name, int status, int? timestamp = null, str
             }
         }
 
-        public void SendMetric(MetricType metricType, string name, double value, double sampleRate = 1.0, string[] tags = null, DateTimeOffset? timestamp = null)
+        public void SendMetric(MetricType metricType, string name, double value, double sampleRate, string[] tags, DateTimeOffset? timestamp)
         {
             if (metricType == MetricType.Set)
             {
@@ -129,7 +129,7 @@ public void Send(Action actionToTime, string statName, double sampleRate = 1.0,
             finally
             {
                 stopwatch.Stop();
-                SendMetric(MetricType.Timing, statName, stopwatch.ElapsedMilliseconds(), sampleRate, tags);
+                SendMetric(MetricType.Timing, statName, stopwatch.ElapsedMilliseconds(), sampleRate, tags, null);
             }
         }