[ServiceBus] Replacing scaling logs to WebJobs extension methods

Author: alrod

NuGet.Config

@@ -4,6 +4,7 @@
     <clear />
     <!-- Do not add any additional feeds if new packages are needed they need to come from our azure-sdk-for-net DevOps feed which has an upstream set to nuget.org -->
     <add key="azure-sdk-for-net" value="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" />
+    <add key="local" value="Q:\nuget" />
   </packageSources>
   <disabledPackageSources>
     <clear />

eng/Packages.Data.props

@@ -249,8 +249,8 @@
     <PackageReference Update="Microsoft.Azure.SignalR.Management" Version="1.29.0" />
     <PackageReference Update="Microsoft.Azure.SignalR.Protocols" Version="1.29.0" />
     <PackageReference Update="Microsoft.Azure.SignalR.Serverless.Protocols" Version="1.10.0" />
-    <PackageReference Update="Microsoft.Azure.WebJobs" Version="3.0.41" />
-    <PackageReference Update="Microsoft.Azure.WebJobs.Sources" Version="3.0.41" PrivateAssets="All"/>
+    <PackageReference Update="Microsoft.Azure.WebJobs" Version="3.0.42-dev" />
+    <PackageReference Update="Microsoft.Azure.WebJobs.Sources" Version="3.0.42-dev" PrivateAssets="All"/>
     <PackageReference Update="Microsoft.Azure.WebJobs.Extensions.Rpc" Version="3.0.41" />
     <PackageReference Update="Microsoft.Azure.WebJobs.Host.Storage" Version="5.0.1" />
     <PackageReference Update="Microsoft.Spatial" Version="7.5.3" />

sdk/storage/Microsoft.Azure.WebJobs.Extensions.Storage.Common/src/Shared/Queues/QueueMetricsProvider.cs

@@ -6,6 +6,7 @@
 using Azure;
 using Azure.Storage.Queues;
 using Azure.Storage.Queues.Models;
+using Microsoft.Azure.WebJobs.Host.Scale;
 using Microsoft.Extensions.Logging;
 
 namespace Microsoft.Azure.WebJobs.Extensions.Storage.Common.Listeners
@@ -15,16 +16,19 @@ namespace Microsoft.Azure.WebJobs.Extensions.Storage.Common.Listeners
     /// </summary>
     internal class QueueMetricsProvider
     {
+        private readonly string _functionId;
         private readonly QueueClient _queue;
         private readonly ILogger _logger;
 
         /// <summary>
         /// Instantiates a QueueMetricsProvider.
         /// </summary>
+        /// <param name="functionId">The function id to make scale decisions for.</param>
         /// <param name="queue">The QueueClient to use for metrics polling.</param>
         /// <param name="loggerFactory">Used to create an ILogger instance.</param>
-        public QueueMetricsProvider(QueueClient queue, ILoggerFactory loggerFactory)
+        public QueueMetricsProvider(string functionId, QueueClient queue, ILoggerFactory loggerFactory)
         {
+            _functionId = functionId;
             _queue = queue;
             _logger = loggerFactory.CreateLogger<QueueMetricsProvider>();
         }
@@ -49,12 +53,12 @@ public async Task<int> GetQueueLengthAsync()
                     // ignore transient errors, and return default metrics
                     // E.g. if the queue doesn't exist, we'll return a zero queue length
                     // and scale in
-                    _logger.LogWarning($"Error querying for queue scale status: {ex.ToString()}");
+                    _logger.LogFunctionScaleWarning("Error querying for queue scale status", _functionId, ex);
                 }
             }
             catch (Exception ex)
             {
-                _logger.LogWarning($"Fatal error querying for queue scale status: {ex.ToString()}");
+                _logger.LogFunctionScaleWarning("Fatal error querying for queue scale status", _functionId, ex);
             }
 
             return 0;
@@ -101,12 +105,13 @@ public async Task<QueueTriggerMetrics> GetMetricsAsync()
                     // ignore transient errors, and return default metrics
                     // E.g. if the queue doesn't exist, we'll return a zero queue length
                     // and scale in
-                    _logger.LogWarning($"Error querying for queue scale status: {ex.ToString()}");
+
+                    _logger.LogFunctionScaleWarning("Error querying for queue scale status", _functionId, ex);
                 }
             }
             catch (Exception ex)
             {
-                _logger.LogWarning($"Fatal error querying for queue scale status: {ex.ToString()}");
+                _logger.LogFunctionScaleWarning("Fatal error querying for queue scale status", _functionId, ex);
             }
 
             return new QueueTriggerMetrics

sdk/storage/Microsoft.Azure.WebJobs.Extensions.Storage.Common/src/Shared/Queues/QueueScaleMonitor.cs

@@ -41,7 +41,7 @@ public QueueScaleMonitor(string functionId, QueueClient queue, ILoggerFactory lo
             _queue = queue;
             _logger = loggerFactory.CreateLogger<QueueListener>();
             _scaleMonitorDescriptor = new ScaleMonitorDescriptor($"{functionId}-QueueTrigger-{_queue.Name}".ToLower(CultureInfo.InvariantCulture), functionId);
-            _queueMetricsProvider = new QueueMetricsProvider(queue, loggerFactory);
+            _queueMetricsProvider = new QueueMetricsProvider(functionId, queue, loggerFactory);
         }
 
         /// <summary>

sdk/storage/Microsoft.Azure.WebJobs.Extensions.Storage.Common/src/Shared/Queues/QueueTargetScaler.cs

@@ -36,7 +36,7 @@ internal QueueTargetScaler(string functionId, QueueClient queueClient, QueuesOpt
         {
             _functionId = functionId;
             _queueName = queueClient.Name;
-            _queueMetricsProvider = new QueueMetricsProvider(queueClient, loggerFactory);
+            _queueMetricsProvider = new QueueMetricsProvider(_functionId, queueClient, loggerFactory);
             _targetScalerDescriptor = new TargetScalerDescriptor(functionId);
             _options = options;
             _logger = loggerFactory.CreateLogger<QueueTargetScaler>();
@@ -64,7 +64,8 @@ internal TargetScalerResult GetScaleResultInternal(TargetScalerContext context,
 
             int targetWorkerCount = (int)Math.Ceiling(queueLength / (decimal)concurrency);
 
-            _logger.LogInformation($"Target worker count for function '{_functionId}' is '{targetWorkerCount}' (QueueName='{_queueName}', QueueLength ='{queueLength}', Concurrency='{concurrency}').");
+            string details = $"Target worker count for function '{_functionId}' is '{targetWorkerCount}' (QueueName='{_queueName}', QueueLength ='{queueLength}', Concurrency='{concurrency}').";
+            _logger.LogFunctionScaleVote(_functionId, targetWorkerCount, queueLength, concurrency, details);
             return new TargetScalerResult
             {
                 TargetWorkerCount = targetWorkerCount

sdk/storage/Microsoft.Azure.WebJobs.Extensions.Storage.Queues/tests/QueueMetricsProviderTests.cs

@@ -34,7 +34,7 @@ public void SetUp()
             _loggerFactory.AddProvider(_loggerProvider);
             _mockQueue = new Mock<QueueClient>(new Uri("https://test.queue.core.windows.net/testqueue"), new QueueClientOptions());
             _mockQueue.Setup(x => x.Name).Returns("testqueue");
-            _metricsProvider = new QueueMetricsProvider(_mockQueue.Object, _loggerFactory);
+            _metricsProvider = new QueueMetricsProvider("testfunction", _mockQueue.Object, _loggerFactory);
         }
 
         [OneTimeSetUp]
@@ -54,7 +54,7 @@ public void OneTimeTearDown()
         [Test]
         public async Task GetMetrics_ReturnsExpectedResult()
         {
-            QueueMetricsProvider _provider = new QueueMetricsProvider(Fixture.Queue, _loggerFactory);
+            QueueMetricsProvider _provider = new QueueMetricsProvider("testfunction", Fixture.Queue, _loggerFactory);
             var metrics = await _provider.GetMetricsAsync();
 
             Assert.AreEqual(0, metrics.QueueLength);