Change property name of log-type to dab-identifier for Azure Log Analytics (#2805)

## Why make this change?
- This change closes issue #2804 
The property `log-type` had a change in function, which also means that
there needs to be a change in name.

## What is this change?
Only changes the name of the property from `log-type` to
`dab-identifier` since the changes in logic related to the changes in
function were already implemented beforehand.

## How was this tested?

- [ ] Integration Tests
- [ ] Unit Tests
- [X] Manual Tests
Tested if the new property is serialized and deserialized correctly and
if `configure` command works as expected with new property, while
leaving no traces of the old property.

## Sample Request(s)
--runtime.telemetry.azure-log-analytics.dab-identifier

Author: RubenCerna2079

schemas/dab.draft.schema.json

@@ -437,9 +437,9 @@
                     }
                   }
                 },
-                "log-type": {
+                "dab-identifier": {
                   "type": "string",
-                  "description": "Custom log table name in Log Analytics",
+                  "description": "Identifier passed on to Log Analytics",
                   "default": "DabLogs"
                 },
                 "flush-interval-seconds": {

src/Cli.Tests/ConfigureOptionsTests.cs

@@ -162,7 +162,7 @@ public void TestAddAzureLogAnalyticsOptions()
             // Act: Attempts to add Azure Log Analytics options
             ConfigureOptions options = new(
                 azureLogAnalyticsEnabled: CliBool.True,
-                azureLogAnalyticsLogType: "log-type-test",
+                azureLogAnalyticsDabIdentifier: "dab-identifier-test",
                 azureLogAnalyticsFlushIntervalSeconds: 1,
                 azureLogAnalyticsCustomTableName: "custom-table-name-test",
                 azureLogAnalyticsDcrImmutableId: "dcr-immutable-id-test",
@@ -180,7 +180,7 @@ public void TestAddAzureLogAnalyticsOptions()
             Assert.IsNotNull(config.Runtime.Telemetry);
             Assert.IsNotNull(config.Runtime.Telemetry.AzureLogAnalytics);
             Assert.AreEqual(true, config.Runtime.Telemetry.AzureLogAnalytics.Enabled);
-            Assert.AreEqual("log-type-test", config.Runtime.Telemetry.AzureLogAnalytics.LogType);
+            Assert.AreEqual("dab-identifier-test", config.Runtime.Telemetry.AzureLogAnalytics.DabIdentifier);
             Assert.AreEqual(1, config.Runtime.Telemetry.AzureLogAnalytics.FlushIntervalSeconds);
             Assert.IsNotNull(config.Runtime.Telemetry.AzureLogAnalytics.Auth);
             Assert.AreEqual("custom-table-name-test", config.Runtime.Telemetry.AzureLogAnalytics.Auth.CustomTableName);

src/Cli.Tests/ValidateConfigTests.cs

@@ -332,7 +332,7 @@ public async Task TestValidateAzureLogAnalyticsOptionsWithoutAuthFails()
         // Act: Attempts to add Azure Log Analytics options without Auth options
         ConfigureOptions options = new(
             azureLogAnalyticsEnabled: CliBool.True,
-            azureLogAnalyticsLogType: "log-type-test",
+            azureLogAnalyticsDabIdentifier: "dab-identifier-test",
             azureLogAnalyticsFlushIntervalSeconds: 1,
             config: TEST_RUNTIME_CONFIG_FILE
         );

src/Cli/Commands/ConfigureOptions.cs

@@ -49,7 +49,7 @@ public ConfigureOptions(
             int? azureKeyVaultRetryPolicyMaxDelaySeconds = null,
             int? azureKeyVaultRetryPolicyNetworkTimeoutSeconds = null,
             CliBool? azureLogAnalyticsEnabled = null,
-            string? azureLogAnalyticsLogType = null,
+            string? azureLogAnalyticsDabIdentifier = null,
             int? azureLogAnalyticsFlushIntervalSeconds = null,
             string? azureLogAnalyticsCustomTableName = null,
             string? azureLogAnalyticsDcrImmutableId = null,
@@ -93,7 +93,7 @@ public ConfigureOptions(
             AzureKeyVaultRetryPolicyNetworkTimeoutSeconds = azureKeyVaultRetryPolicyNetworkTimeoutSeconds;
             // Azure Log Analytics
             AzureLogAnalyticsEnabled = azureLogAnalyticsEnabled;
-            AzureLogAnalyticsLogType = azureLogAnalyticsLogType;
+            AzureLogAnalyticsDabIdentifier = azureLogAnalyticsDabIdentifier;
             AzureLogAnalyticsFlushIntervalSeconds = azureLogAnalyticsFlushIntervalSeconds;
             AzureLogAnalyticsCustomTableName = azureLogAnalyticsCustomTableName;
             AzureLogAnalyticsDcrImmutableId = azureLogAnalyticsDcrImmutableId;
@@ -187,8 +187,8 @@ public ConfigureOptions(
         [Option("runtime.telemetry.azure-log-analytics.enabled", Required = false, HelpText = "Enable/Disable Azure Log Analytics. Default: False (boolean)")]
         public CliBool? AzureLogAnalyticsEnabled { get; }
 
-        [Option("runtime.telemetry.azure-log-analytics.log-type", Required = false, HelpText = "Configure Log Type for Azure Log Analytics to find table to send telemetry data. Default: DABLogs")]
-        public string? AzureLogAnalyticsLogType { get; }
+        [Option("runtime.telemetry.azure-log-analytics.dab-identifier", Required = false, HelpText = "Configure DAB Identifier to allow user to differentiate which logs come from DAB in Azure Log Analytics . Default: DABLogs")]
+        public string? AzureLogAnalyticsDabIdentifier { get; }
 
         [Option("runtime.telemetry.azure-log-analytics.flush-interval-seconds", Required = false, HelpText = "Configure Flush Interval in seconds for Azure Log Analytics to specify the time interval to send the telemetry data. Default: 5")]
         public int? AzureLogAnalyticsFlushIntervalSeconds { get; }

src/Cli/ConfigGenerator.cs

@@ -780,7 +780,7 @@ private static bool TryUpdateConfiguredRuntimeOptions(
 
             // Telemetry: Azure Log Analytics
             if (options.AzureLogAnalyticsEnabled is not null ||
-                options.AzureLogAnalyticsLogType is not null ||
+                options.AzureLogAnalyticsDabIdentifier is not null ||
                 options.AzureLogAnalyticsFlushIntervalSeconds is not null ||
                 options.AzureLogAnalyticsCustomTableName is not null ||
                 options.AzureLogAnalyticsDcrImmutableId is not null ||
@@ -1137,11 +1137,11 @@ private static bool TryUpdateConfiguredAzureLogAnalyticsOptions(
                     _logger.LogInformation($"Updated configuration with runtime.telemetry.azure-log-analytics.enabled as '{options.AzureLogAnalyticsEnabled}'");
                 }
 
-                // Runtime.Telemetry.AzureLogAnalytics.LogType
-                if (options.AzureLogAnalyticsLogType is not null)
+                // Runtime.Telemetry.AzureLogAnalytics.DabIdentifier
+                if (options.AzureLogAnalyticsDabIdentifier is not null)
                 {
-                    azureLogAnalyticsOptions = azureLogAnalyticsOptions with { LogType = options.AzureLogAnalyticsLogType, UserProvidedLogType = true };
-                    _logger.LogInformation($"Updated configuration with runtime.telemetry.azure-log-analytics.log-type as '{options.AzureLogAnalyticsLogType}'");
+                    azureLogAnalyticsOptions = azureLogAnalyticsOptions with { DabIdentifier = options.AzureLogAnalyticsDabIdentifier, UserProvidedDabIdentifier = true };
+                    _logger.LogInformation($"Updated configuration with runtime.telemetry.azure-log-analytics.dab-identifier as '{options.AzureLogAnalyticsDabIdentifier}'");
                 }
 
                 // Runtime.Telemetry.AzureLogAnalytics.FlushIntervalSeconds

src/Config/Converters/AzureLogAnalyticsOptionsConverterFactory.cs

@@ -88,7 +88,7 @@ internal AzureLogAnalyticsOptionsConverter(bool replaceEnvVar)
                             auth = authOptionsConverter.Read(ref reader, typeToConvert, options);
                             break;
 
-                        case "log-type":
+                        case "dab-identifier":
                             if (reader.TokenType is not JsonTokenType.Null)
                             {
                                 logType = reader.DeserializeString(_replaceEnvVar);
@@ -150,10 +150,10 @@ public override void Write(Utf8JsonWriter writer, AzureLogAnalyticsOptions value
                 authOptionsConverter.Write(writer, value.Auth, options);
             }
 
-            if (value?.UserProvidedLogType is true)
+            if (value?.UserProvidedDabIdentifier is true)
             {
-                writer.WritePropertyName("log-type");
-                JsonSerializer.Serialize(writer, value.LogType, options);
+                writer.WritePropertyName("dab-identifier");
+                JsonSerializer.Serialize(writer, value.DabIdentifier, options);
             }
 
             if (value?.UserProvidedFlushIntervalSeconds is true)

src/Config/ObjectModel/AzureLogAnalyticsLogs.cs

@@ -12,14 +12,14 @@ public class AzureLogAnalyticsLogs
     public string LogLevel { get; set; }
     public string? Message { get; set; }
     public string? Component { get; set; }
-    public string? LogType { get; set; }
+    public string? Identifier { get; set; }
 
-    public AzureLogAnalyticsLogs(string time, string logLevel, string? message, string? component, string? logType = null)
+    public AzureLogAnalyticsLogs(string time, string logLevel, string? message, string? component, string? identifier = null)
     {
         Time = time;
         LogLevel = logLevel;
         Message = message;
         Component = component;
-        LogType = logType;
+        Identifier = identifier;
     }
 }

src/Config/ObjectModel/AzureLogAnalyticsOptions.cs

@@ -21,7 +21,7 @@ public record AzureLogAnalyticsOptions
     /// <summary>
     /// Default log type for Azure Log Analytics.
     /// </summary>
-    public const string DEFAULT_LOG_TYPE = "DabLogs";
+    public const string DEFAULT_DAB_IDENTIFIER = "DabLogs";
 
     /// <summary>
     /// Default flush interval in seconds.
@@ -39,17 +39,17 @@ public record AzureLogAnalyticsOptions
     public AzureLogAnalyticsAuthOptions? Auth { get; init; }
 
     /// <summary>
-    /// Custom log table name in Log Analytics.
+    /// Custom identifier name to send to Log Analytics.
     /// </summary>
-    public string? LogType { get; init; }
+    public string? DabIdentifier { get; init; }
 
     /// <summary>
     /// Interval between log batch pushes (in seconds).
     /// </summary>
     public int? FlushIntervalSeconds { get; init; }
 
     [JsonConstructor]
-    public AzureLogAnalyticsOptions(bool? enabled = null, AzureLogAnalyticsAuthOptions? auth = null, string? logType = null, int? flushIntervalSeconds = null)
+    public AzureLogAnalyticsOptions(bool? enabled = null, AzureLogAnalyticsAuthOptions? auth = null, string? dabIdentifier = null, int? flushIntervalSeconds = null)
     {
         Auth = auth;
 
@@ -63,14 +63,14 @@ public AzureLogAnalyticsOptions(bool? enabled = null, AzureLogAnalyticsAuthOptio
             Enabled = DEFAULT_ENABLED;
         }
 
-        if (logType is not null)
+        if (dabIdentifier is not null)
         {
-            LogType = logType;
-            UserProvidedLogType = true;
+            DabIdentifier = dabIdentifier;
+            UserProvidedDabIdentifier = true;
         }
         else
         {
-            LogType = DEFAULT_LOG_TYPE;
+            DabIdentifier = DEFAULT_DAB_IDENTIFIER;
         }
 
         if (flushIntervalSeconds is not null)
@@ -95,14 +95,14 @@ public AzureLogAnalyticsOptions(bool? enabled = null, AzureLogAnalyticsAuthOptio
     public bool UserProvidedEnabled { get; init; } = false;
 
     /// <summary>
-    /// Flag which informs CLI and JSON serializer whether to write log-type
+    /// Flag which informs CLI and JSON serializer whether to write dab-identifier
     /// property and value to the runtime config file.
-    /// When user doesn't provide the log-type property/value, which signals DAB to use the default,
+    /// When user doesn't provide the dab-identifier property/value, which signals DAB to use the default,
     /// the DAB CLI should not write the default value to a serialized config.
     /// </summary>
     [JsonIgnore(Condition = JsonIgnoreCondition.Always)]
-    [MemberNotNullWhen(true, nameof(LogType))]
-    public bool UserProvidedLogType { get; init; } = false;
+    [MemberNotNullWhen(true, nameof(DabIdentifier))]
+    public bool UserProvidedDabIdentifier { get; init; } = false;
 
     /// <summary>
     /// Flag which informs CLI and JSON serializer whether to write flush-interval-seconds

src/Service.Tests/Configuration/ConfigurationTests.cs

@@ -4080,22 +4080,22 @@ public void AzureLogAnalyticsSerialization(
             string? customTableName,
             string? dcrImmutableId,
             string? dceEndpoint,
-            string? logType,
+            string? dabIdentifier,
             int? flushIntSec,
             bool expectedEnabled,
-            string expectedLogType,
+            string expectedDabIdentifier,
             int expectedFlushIntSec)
         {
             //Check if auth property and its values are expected to exist
             bool expectedExistEnabled = enabled is not null;
-            bool expectedExistLogType = logType is not null;
+            bool expectedExistDabIdentifier = dabIdentifier is not null;
             bool expectedExistFlushIntSec = flushIntSec is not null;
             bool expectedExistCustomTableName = customTableName is not null;
             bool expectedExistDcrImmutableId = dcrImmutableId is not null;
             bool expectedExistDceEndpoint = dceEndpoint is not null;
 
             AzureLogAnalyticsAuthOptions authOptions = new(customTableName, dcrImmutableId, dceEndpoint);
-            AzureLogAnalyticsOptions azureLogAnalyticsOptions = new(enabled, authOptions, logType, flushIntSec);
+            AzureLogAnalyticsOptions azureLogAnalyticsOptions = new(enabled, authOptions, dabIdentifier, flushIntSec);
             RuntimeConfig configWithCustomLogLevel = InitializeRuntimeWithAzureLogAnalytics(azureLogAnalyticsOptions);
             string configWithCustomLogLevelJson = configWithCustomLogLevel.ToJson();
             Assert.IsTrue(RuntimeConfigLoader.TryParseConfig(configWithCustomLogLevelJson, out RuntimeConfig? deserializedRuntimeConfig));
@@ -4120,11 +4120,11 @@ public void AzureLogAnalyticsSerialization(
                     Assert.AreEqual(expectedEnabled, enabledElement.GetBoolean());
                 }
 
-                bool logTypeExists = azureLogAnalyticsElement.TryGetProperty("log-type", out JsonElement logTypeElement);
-                Assert.AreEqual(expected: expectedExistLogType, actual: logTypeExists);
-                if (logTypeExists)
+                bool dabIdentifierExists = azureLogAnalyticsElement.TryGetProperty("dab-identifier", out JsonElement dabIdentifierElement);
+                Assert.AreEqual(expected: expectedExistDabIdentifier, actual: dabIdentifierExists);
+                if (dabIdentifierExists)
                 {
-                    Assert.AreEqual(expectedLogType, logTypeElement.GetString());
+                    Assert.AreEqual(expectedDabIdentifier, dabIdentifierElement.GetString());
                 }
 
                 bool flushIntSecExists = azureLogAnalyticsElement.TryGetProperty("flush-interval-seconds", out JsonElement flushIntSecElement);

src/Service/Telemetry/AzureLogAnalyticsCustomLogCollector.cs

@@ -17,7 +17,7 @@ namespace Azure.DataApiBuilder.Service.Telemetry;
 public interface ICustomLogCollector
 {
     Task LogAsync(string message, LogLevel loggingLevel, string? source = null);
-    Task<List<AzureLogAnalyticsLogs>> DequeueAllAsync(string logType, int flushIntervalSeconds);
+    Task<List<AzureLogAnalyticsLogs>> DequeueAllAsync(string dabIdentifier, int flushIntervalSeconds);
 }
 
 /// <summary>
@@ -47,10 +47,10 @@ await _logs.Writer.WriteAsync(
     /// <summary>
     /// Creates a list periodically from the logs that are currently saved.
     /// </summary>
-    /// <param name="logType">Custom name to distinguish the logs sent from DAB to Azure Log Analytics.</param>
+    /// <param name="dabIdentifier">Custom name to distinguish the logs sent from DAB to Azure Log Analytics.</param>
     /// <param name="flushIntervalSeconds">Period of time between each list of logs is sent.</param>
     /// <returns>List of logs structured to be sent to Azure Log Analytics.</returns>
-    public async Task<List<AzureLogAnalyticsLogs>> DequeueAllAsync(string logType, int flushIntervalSeconds)
+    public async Task<List<AzureLogAnalyticsLogs>> DequeueAllAsync(string dabIdentifier, int flushIntervalSeconds)
     {
         List<AzureLogAnalyticsLogs> list = new();
         Stopwatch time = Stopwatch.StartNew();
@@ -59,7 +59,7 @@ public async Task<List<AzureLogAnalyticsLogs>> DequeueAllAsync(string logType, i
         {
             while (_logs.Reader.TryRead(out AzureLogAnalyticsLogs? item))
             {
-                item.LogType = logType;
+                item.Identifier = dabIdentifier;
                 list.Add(item);
 
                 if (time.Elapsed >= TimeSpan.FromSeconds(flushIntervalSeconds))