feat: Add Metrics to SharpHound to be collected - BED-7080

src/CommonLib/AdaptiveTimeout.cs

@@ -62,14 +62,15 @@ public void ClearSamples() {
     /// <typeparam name="T"></typeparam>
     /// <param name="func"></param>
     /// <param name="parentToken"></param>
+    /// <param name="latencyObservation">A method that is used to observe the latency of the request.</param>
     /// <returns>Returns a Fail result if a task runs longer than its budgeted time.</returns>
-    public async Task<Result<T>> ExecuteWithTimeout<T>(Func<CancellationToken, T> func, CancellationToken parentToken = default) {
+    public async Task<Result<T>> ExecuteWithTimeout<T>(Func<CancellationToken, T> func, CancellationToken parentToken = default, Action<double> latencyObservation = null) {
         DateTime startTime = default;
         var result = await Timeout.ExecuteWithTimeout(GetAdaptiveTimeout(), (timeoutToken) =>
             _sampler.SampleExecutionTime(() => {
                 startTime = DateTime.Now; // for ordinal tracking; see use in TimeSpikeSafetyValve
                 return func(timeoutToken);
-            }), parentToken);
+            }, latencyObservation), parentToken);
         TimeSpikeSafetyValve(result.IsSuccess, startTime);
         return result;
     }
@@ -84,14 +85,15 @@ public async Task<Result<T>> ExecuteWithTimeout<T>(Func<CancellationToken, T> fu
     /// </summary>
     /// <param name="func"></param>
     /// <param name="parentToken"></param>
+    /// <param name="latencyObservation">A method that is used to observe the latency of the request.</param>
     /// <returns>Returns a Fail result if a task runs longer than its budgeted time.</returns>
-    public async Task<Result> ExecuteWithTimeout(Action<CancellationToken> func, CancellationToken parentToken = default) {
+    public async Task<Result> ExecuteWithTimeout(Action<CancellationToken> func, CancellationToken parentToken = default, Action<double> latencyObservation = null) {
         DateTime startTime = default;
         var result = await Timeout.ExecuteWithTimeout(GetAdaptiveTimeout(), (timeoutToken) =>
             _sampler.SampleExecutionTime(() => {
                 startTime = DateTime.Now; // for ordinal tracking; see use in TimeSpikeSafetyValve
                 func(timeoutToken);
-            }), parentToken);
+            }, latencyObservation), parentToken);
         TimeSpikeSafetyValve(result.IsSuccess, startTime);
         return result;
     }
@@ -107,14 +109,15 @@ public async Task<Result> ExecuteWithTimeout(Action<CancellationToken> func, Can
     /// <typeparam name="T"></typeparam>
     /// <param name="func"></param>
     /// <param name="parentToken"></param>
+    /// <param name="latencyObservation">A method that is used to observe the latency of the request.</param>
     /// <returns>Returns a Fail result if a task runs longer than its budgeted time.</returns>
-    public async Task<Result<T>> ExecuteWithTimeout<T>(Func<CancellationToken, Task<T>> func, CancellationToken parentToken = default) {
+    public async Task<Result<T>> ExecuteWithTimeout<T>(Func<CancellationToken, Task<T>> func, CancellationToken parentToken = default, Action<double> latencyObservation = null) {
         DateTime startTime = default;
         var result = await Timeout.ExecuteWithTimeout(GetAdaptiveTimeout(), (timeoutToken) =>
             _sampler.SampleExecutionTime(() => {
                 startTime = DateTime.Now; // for ordinal tracking; see use in TimeSpikeSafetyValve
                 return func(timeoutToken);
-            }), parentToken);
+            }, latencyObservation), parentToken);
         TimeSpikeSafetyValve(result.IsSuccess, startTime);
         return result;
     }
@@ -129,14 +132,15 @@ public async Task<Result<T>> ExecuteWithTimeout<T>(Func<CancellationToken, Task<
     /// </summary>
     /// <param name="func"></param>
     /// <param name="parentToken"></param>
+    /// <param name="latencyObservation">A method that is used to observe the latency of the request.</param>
     /// <returns>Returns a Fail result if a task runs longer than its budgeted time.</returns>
-    public async Task<Result> ExecuteWithTimeout(Func<CancellationToken, Task> func, CancellationToken parentToken = default) {
+    public async Task<Result> ExecuteWithTimeout(Func<CancellationToken, Task> func, CancellationToken parentToken = default, Action<double> latencyObservation = null) {
         DateTime startTime = default;
         var result = await Timeout.ExecuteWithTimeout(GetAdaptiveTimeout(), (timeoutToken) =>
             _sampler.SampleExecutionTime(() => {
                 startTime = DateTime.Now; // for ordinal tracking; see use in TimeSpikeSafetyValve
                 return func(timeoutToken);
-            }), parentToken);
+            }, latencyObservation), parentToken);
         TimeSpikeSafetyValve(result.IsSuccess, startTime);
         return result;
     }

src/CommonLib/ExecutionTimeSampler.cs

@@ -43,35 +43,39 @@ public double StandardDeviation() {
 
     public double Average() => _samples.Average();
 
-    public async Task<T> SampleExecutionTime<T>(Func<Task<T>> func) {
+    public async Task<T> SampleExecutionTime<T>(Func<Task<T>> func, Action<double> latencyObservation = null) {
         var stopwatch = Stopwatch.StartNew();
         var result = await func.Invoke();
         stopwatch.Stop();
+        latencyObservation?.Invoke(stopwatch.ElapsedMilliseconds);
         AddTimeSample(stopwatch.Elapsed);
 
         return result;
     }
 
-    public async Task SampleExecutionTime(Func<Task> func) {
+    public async Task SampleExecutionTime(Func<Task> func, Action<double> latencyObservation = null) {
         var stopwatch = Stopwatch.StartNew();
         await func.Invoke();
         stopwatch.Stop();
+        latencyObservation?.Invoke(stopwatch.ElapsedMilliseconds);
         AddTimeSample(stopwatch.Elapsed);
     }
 
-    public T SampleExecutionTime<T>(Func<T> func) {
+    public T SampleExecutionTime<T>(Func<T> func, Action<double> latencyObservation = null) {
         var stopwatch = Stopwatch.StartNew();
         var result = func.Invoke();
         stopwatch.Stop();
+        latencyObservation?.Invoke(stopwatch.ElapsedMilliseconds);
         AddTimeSample(stopwatch.Elapsed);
 
         return result;
     }
 
-    public void SampleExecutionTime(Action func) {
+    public void SampleExecutionTime(Action func, Action<double> latencyObservation = null) {
         var stopwatch = Stopwatch.StartNew();
         func.Invoke();
         stopwatch.Stop();
+        latencyObservation?.Invoke(stopwatch.ElapsedMilliseconds);
         AddTimeSample(stopwatch.Elapsed);
     }
 

src/CommonLib/Interfaces/ILabelValuesCache.cs

@@ -0,0 +1,5 @@
+namespace SharpHoundCommonLib.Interfaces;
+
+public interface ILabelValuesCache {
+    string[] Intern(string[] values);
+}

src/CommonLib/Interfaces/IMetricFactory.cs

@@ -0,0 +1,5 @@
+namespace SharpHoundCommonLib.Interfaces;
+
+public interface IMetricFactory {
+    IMetricRouter CreateMetricRouter();
+}

src/CommonLib/Interfaces/IMetricRegistry.cs

@@ -0,0 +1,9 @@
+using System.Collections.Generic;
+using SharpHoundCommonLib.Models;
+
+namespace SharpHoundCommonLib.Interfaces;
+
+public interface IMetricRegistry {
+    bool TryRegister(MetricDefinition definition, out int definitionId);
+    IReadOnlyList<MetricDefinition> Definitions { get; }
+}

src/CommonLib/Interfaces/IMetricRouter.cs

@@ -0,0 +1,8 @@
+using SharpHoundCommonLib.Models;
+
+namespace SharpHoundCommonLib.Interfaces;
+
+public interface IMetricRouter {
+    void Observe(int definitionId, double value, LabelValues labelValues);
+    void Flush();
+}

src/CommonLib/Interfaces/IMetricSink.cs

@@ -0,0 +1,8 @@
+using SharpHoundCommonLib.Models;
+
+namespace SharpHoundCommonLib.Interfaces;
+
+public interface IMetricSink {
+    void Observe(in MetricObservation.DoubleMetricObservation observation);
+    void Flush();
+}

src/CommonLib/Interfaces/IMetricWriter.cs

@@ -0,0 +1,17 @@
+using System;
+using System.Text;
+using SharpHoundCommonLib.Models;
+using SharpHoundCommonLib.Services;
+
+namespace SharpHoundCommonLib.Interfaces;
+
+public interface IMetricWriter {
+    void StringBuilderAppendMetric(
+        StringBuilder builder,
+        MetricDefinition definition,
+        LabelValues labelValues,
+        MetricAggregator aggregator,
+        DateTimeOffset timestamp,
+        string timestampOutputString = "yyyy-MM-dd HH:mm:ss.fff"
+    );
+}