Merge pull request #1047 from Particular/john/queue-names-only

Adding support to run only in queue mode collection

Author: johnsimons

src/AppCommon/Commands/AzureServiceBusCommand.cs

@@ -53,6 +53,7 @@ public static Command CreateCommand()
 
     readonly AzureClient azure;
 
+    string[] queueNames;
 
     public AzureServiceBusCommand(SharedOptions shared, string resourceId, string serviceBusDomain)
     : base(shared)
@@ -65,14 +66,8 @@ protected override async Task<QueueDetails> GetData(CancellationToken cancellati
     {
         try
         {
-            Out.WriteLine($"Getting data from {azure.FullyQualifiedNamespace}...");
             var endTime = DateTime.UtcNow.Date.AddDays(1);
             var startTime = endTime.AddDays(-30);
-
-            var queueNames = await azure.GetQueueNames(cancellationToken);
-
-            Out.WriteLine($"Found {queueNames.Length} queues");
-
             var results = new List<QueueThroughput>();
 
             azure.ResetConnectionQueue();
@@ -116,13 +111,20 @@ protected override async Task<QueueDetails> GetData(CancellationToken cancellati
         }
     }
 
-    protected override Task<EnvironmentDetails> GetEnvironment(CancellationToken cancellationToken = default)
+    protected override async Task<EnvironmentDetails> GetEnvironment(CancellationToken cancellationToken = default)
     {
-        return Task.FromResult(new EnvironmentDetails
+        Out.WriteLine($"Getting data from {azure.FullyQualifiedNamespace}...");
+
+        queueNames = await azure.GetQueueNames(cancellationToken);
+
+        Out.WriteLine($"Found {queueNames.Length} queues");
+
+        return new EnvironmentDetails
         {
             MessageTransport = "AzureServiceBus",
             ReportMethod = $"AzureServiceBus Metrics: {azure.FullyQualifiedNamespace}",
+            QueueNames = queueNames,
             SkipEndpointListCheck = true
-        });
+        };
     }
 }

src/AppCommon/Commands/BaseCommand.cs

@@ -198,34 +198,61 @@ async Task RunInternal(CancellationToken cancellationToken)
         }
         Out.WriteLine();
 
-        var data = await GetData(cancellationToken);
+        Report reportData;
 
-        foreach (var q in data.Queues)
+        if (!shared.SkipThroughputCollection)
         {
-            q.QueueName = shared.Mask(q.QueueName);
-            if (q.Throughput.HasValue)
+            var data = await GetData(cancellationToken);
+
+            foreach (var q in data.Queues)
             {
-                q.Throughput = Math.Abs(q.Throughput.Value);
+                q.QueueName = shared.Mask(q.QueueName);
+                if (q.Throughput.HasValue)
+                {
+                    q.Throughput = Math.Abs(q.Throughput.Value);
+                }
             }
-        }
 
-        var reportData = new Report
-        {
-            CustomerName = shared.CustomerName,
-            MessageTransport = metadata.MessageTransport,
-            ReportMethod = shared.Mask(metadata.ReportMethod),
-            ToolType = "Throughput Tool",
-            ToolVersion = Versioning.NuGetVersion,
-            Prefix = metadata.Prefix,
-            ScopeType = data.ScopeType,
-            StartTime = data.StartTime,
-            EndTime = data.EndTime,
-            ReportDuration = data.TimeOfObservation ?? data.EndTime - data.StartTime,
-            Queues = data.Queues,
-            TotalThroughput = data.Queues.Sum(q => q.Throughput ?? 0),
-            TotalQueues = data.Queues.Length,
-            IgnoredQueues = metadata.IgnoredQueues?.Select(q => shared.Mask(q)).ToArray()
-        };
+            reportData = new Report
+            {
+                CustomerName = shared.CustomerName,
+                MessageTransport = metadata.MessageTransport,
+                ReportMethod = shared.Mask(metadata.ReportMethod),
+                ToolType = "Throughput Tool",
+                ToolVersion = Versioning.NuGetVersion,
+                Prefix = metadata.Prefix,
+                ScopeType = data.ScopeType,
+                StartTime = data.StartTime,
+                EndTime = data.EndTime,
+                ReportDuration = data.TimeOfObservation ?? data.EndTime - data.StartTime,
+                Queues = data.Queues,
+                TotalThroughput = data.Queues.Sum(q => q.Throughput ?? 0),
+                TotalQueues = data.Queues.Length,
+                IgnoredQueues = metadata.IgnoredQueues?.Select(q => shared.Mask(q)).ToArray()
+            };
+        }
+        else
+        {
+            var mappedQueueNames = metadata.QueueNames
+                .Select(name => new { Name = name, Masked = shared.Mask(name) })
+                .ToArray();
+            reportData = new Report
+            {
+                CustomerName = shared.CustomerName,
+                MessageTransport = metadata.MessageTransport,
+                ReportMethod = shared.Mask(metadata.ReportMethod),
+                ToolType = "Throughput Tool",
+                ToolVersion = Versioning.NuGetVersion,
+                Prefix = metadata.Prefix,
+                StartTime = new DateTimeOffset(DateTime.UtcNow.Date, TimeSpan.Zero),
+                EndTime = new DateTimeOffset(DateTime.UtcNow.Date.AddDays(1), TimeSpan.Zero),
+                ReportDuration = TimeSpan.FromDays(1),
+                Queues = mappedQueueNames.Select(map => new QueueThroughput { QueueName = map.Masked, Throughput = 0 }).ToArray(),
+                TotalThroughput = 0,
+                TotalQueues = mappedQueueNames.Length,
+                IgnoredQueues = metadata.IgnoredQueues?.Select(q => shared.Mask(q)).ToArray()
+            };
+        }
 
         var report = new SignedReport
         {

src/AppCommon/Infra/SharedOptions.cs

@@ -27,12 +27,20 @@ class SharedOptions
         Arity = ArgumentArity.ZeroOrOne
     };
 
+    public static readonly Option<bool> skipThroughputCollection =
+        new("--skipThroughputCollection")
+        {
+            Description = "It returns only the queue names with zero throughput.",
+            Arity = ArgumentArity.ZeroOrOne
+        };
+
     public static readonly Option<int> runtimeInHours =
         new(name: "--runtime", getDefaultValue: () => 24) { IsHidden = true };
 
     public string CustomerName { get; set; }
     public bool RunUnattended { get; private set; }
     public bool SkipVersionCheck { get; private set; }
+    public bool SkipThroughputCollection { get; private set; }
     public int RuntimeInHours { get; private set; }
 
     (string Mask, string Replacement)[] masks;
@@ -53,6 +61,7 @@ public static void Register(Command command)
         command.AddGlobalOption(customerName);
         command.AddGlobalOption(runUnattended);
         command.AddGlobalOption(skipVersionCheck);
+        command.AddGlobalOption(skipThroughputCollection);
         command.AddGlobalOption(runtimeInHours);
     }
 
@@ -61,6 +70,7 @@ public static void Register(Command command)
         CustomerName = parse.GetValueForOption(customerName);
         RunUnattended = parse.GetValueForOption(runUnattended);
         SkipVersionCheck = parse.GetValueForOption(skipVersionCheck);
+        SkipThroughputCollection = parse.GetValueForOption(skipThroughputCollection);
         RuntimeInHours = parse.GetValueForOption(runtimeInHours);
 
         int number = 0;