Add MetricsInterval to queues to control how often queue metrics are …

…retrieved
FoundatioFx · Dec 18, 2024 · 6c77408 · 6c77408
1 parent 38efe12
commit 6c77408
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 5 deletions.
diff --git a/src/Foundatio.TestHarness/Queue/QueueTestBase.cs b/src/Foundatio.TestHarness/Queue/QueueTestBase.cs
@@ -1063,7 +1063,7 @@ public virtual async Task CanRunWorkItemWithMetricsAsync()
     {
         int completedCount = 0;
 
-        using var queue = new InMemoryQueue<WorkItemData>(o => o.LoggerFactory(Log));
+        using var queue = new InMemoryQueue<WorkItemData>(o => o.LoggerFactory(Log).MetricsInterval(TimeSpan.Zero));
 
         Task Handler(object sender, CompletedEventArgs<WorkItemData> e)
         {

diff --git a/src/Foundatio/Queues/QueueBase.cs b/src/Foundatio/Queues/QueueBase.cs
@@ -36,6 +36,8 @@ public abstract class QueueBase<T, TOptions> : MaintenanceBase, IQueue<T>, IHave
     private readonly List<IQueueBehavior<T>> _behaviors = new();
     protected readonly CancellationTokenSource _queueDisposedCancellationTokenSource;
     private bool _isDisposed;
+    private QueueStats _queueStats;
+    private DateTime _nextQueueStatsUpdate = DateTime.MinValue;
 
     protected QueueBase(TOptions options) : base(options?.TimeProvider, options?.LoggerFactory)
     {
@@ -62,11 +64,15 @@ protected QueueBase(TOptions options) : base(options?.TimeProvider, options?.Log
 
         var queueMetricValues = new InstrumentsValues<long, long, long>(() =>
         {
+            if (options.MetricsInterval > TimeSpan.Zero && _nextQueueStatsUpdate >= _timeProvider.GetUtcNow())
+                return (_queueStats.Queued, _queueStats.Working, _queueStats.Deadletter);
+
+            _nextQueueStatsUpdate = _timeProvider.GetUtcNow().UtcDateTime.Add(_options.MetricsInterval);
             try
             {
                 using var _ = FoundatioDiagnostics.ActivitySource.StartActivity("Queue Stats: " + _options.Name);
-                var stats = GetMetricsQueueStats();
-                return (stats.Queued, stats.Working, stats.Deadletter);
+                _queueStats = GetMetricsQueueStats();
+                return (_queueStats.Queued, _queueStats.Working, _queueStats.Deadletter);
             }
             catch
             {
@@ -138,9 +144,10 @@ public async Task<IEnumerable<T>> GetDeadletterItemsAsync(CancellationToken canc
 
     protected abstract Task<QueueStats> GetQueueStatsImplAsync();
 
-    public Task<QueueStats> GetQueueStatsAsync()
+    public async Task<QueueStats> GetQueueStatsAsync()
     {
-        return GetQueueStatsImplAsync();
+        _queueStats = await GetQueueStatsImplAsync();
+        return _queueStats;
     }
 
     protected virtual QueueStats GetMetricsQueueStats()

diff --git a/src/Foundatio/Queues/SharedQueueOptions.cs b/src/Foundatio/Queues/SharedQueueOptions.cs
@@ -14,6 +14,11 @@ public class SharedQueueOptions<T> : SharedOptions where T : class
     /// Allows you to set a prefix on queue metrics. This allows you to have unique metrics for keyed queues (e.g., priority queues).
     /// </summary>
     public string MetricsPrefix { get; set; }
+
+    /// <summary>
+    /// How often to update queue metrics. Defaults to 30 seconds.
+    /// </summary>
+    public TimeSpan MetricsInterval { get; set; } = TimeSpan.FromSeconds(30);
 }
 
 public class SharedQueueOptionsBuilder<T, TOptions, TBuilder> : SharedOptionsBuilder<TOptions, TBuilder>
@@ -77,4 +82,16 @@ public TBuilder MetricsPrefix(string prefix)
             Target.MetricsPrefix = prefix.Trim();
         return (TBuilder)this;
     }
+
+    /// <summary>
+    /// How often to update queue metrics. Defaults to 30 seconds.
+    /// </summary>
+    public TBuilder MetricsInterval(TimeSpan interval)
+    {
+        if (interval < TimeSpan.Zero)
+            throw new ArgumentOutOfRangeException(nameof(interval));
+
+        Target.MetricsInterval = interval;
+        return (TBuilder)this;
+    }
 }
diff --git a/tests/Foundatio.Tests/Queue/InMemoryQueueTests.cs b/tests/Foundatio.Tests/Queue/InMemoryQueueTests.cs
@@ -25,6 +25,7 @@ protected override IQueue<SimpleWorkItem> GetQueue(int retries = 1, TimeSpan? wo
                 .RetryMultipliers(retryMultipliers ?? new[] { 1, 3, 5, 10 })
                 .WorkItemTimeout(workItemTimeout.GetValueOrDefault(TimeSpan.FromMinutes(5)))
                 .TimeProvider(timeProvider)
+                .MetricsInterval(TimeSpan.Zero)
                 .LoggerFactory(Log));
         if (_logger.IsEnabled(LogLevel.Debug))
             _logger.LogDebug("Queue Id: {QueueId}", _queue.QueueId);