Move Global Log-Level (#2508)

## Why make this change?

Solves #2452

## What is this change?

Moves the log-level property from `/runtime` to `/runtime/telemetry`
where it was decided it should live. It also changes the files so that
the log-level property is under `TelemetryOptions` instead of
`RuntimeOptions` and fix any tests related to the changes.

## How was this tested?

- [X] Integration Tests
- [ ] Unit Tests

---------

Co-authored-by: Ruben Cerna <rcernaserna@microsoft.com>
Co-authored-by: Abhishek  Kumar <102276754+abhishekkumams@users.noreply.github.com>

Author: 3 people

schemas/dab.draft.schema.json

@@ -297,28 +297,6 @@
             }
           }
         },
-        "log-level": {
-          "type": "object",
-          "description": "Global configuration of log level",
-          "additionalProperties": false,
-          "properties": {
-            "level": {
-              "description": "Defines logging severity levels, when in default value it will set logging level based on 'host: mode' property",
-              "type": "string",
-              "default": null,
-              "enum": [
-                "trace",
-                "debug",
-                "information",
-                "warning",
-                "error",
-                "critical",
-                "none",
-                null
-              ]
-            }
-          }
-        },
         "cache": {
           "type": "object",
           "additionalProperties": false,
@@ -393,6 +371,28 @@
               "required": [
                 "endpoint"
               ]
+            },
+            "log-level": {
+              "type": "object",
+              "description": "Global configuration of log level",
+              "additionalProperties": false,
+              "properties": {
+                "level": {
+                  "description": "Defines logging severity levels, when in default value it will set logging level based on 'host: mode' property",
+                  "type": "string",
+                  "default": null,
+                  "enum": [
+                    "trace",
+                    "debug",
+                    "information",
+                    "warning",
+                    "error",
+                    "critical",
+                    "none",
+                    null
+                  ]
+                }
+              }
             }
           }
         }

src/Config/ObjectModel/RuntimeConfig.cs

@@ -549,8 +549,9 @@ public uint GetPaginationLimit(int? first)
     /// </summary>
     public bool IsLogLevelNull() =>
         Runtime is null ||
-        Runtime.LoggerLevel is null ||
-        Runtime.LoggerLevel.Value is null;
+        Runtime.Telemetry is null ||
+        Runtime.Telemetry.LoggerLevel is null ||
+        Runtime.Telemetry.LoggerLevel.Value is null;
 
     /// <summary>
     /// Takes in the RuntimeConfig object and checks the LogLevel.
@@ -561,7 +562,7 @@ Runtime.LoggerLevel is null ||
     /// </summary>
     public static LogLevel GetConfiguredLogLevel(RuntimeConfig runtimeConfig)
     {
-        LogLevel? value = runtimeConfig.Runtime?.LoggerLevel?.Value;
+        LogLevel? value = runtimeConfig.Runtime?.Telemetry?.LoggerLevel?.Value;
         if (value is not null)
         {
             return (LogLevel)value;

src/Config/ObjectModel/RuntimeOptions.cs

@@ -16,9 +16,6 @@ public record RuntimeOptions
     public EntityCacheOptions? Cache { get; init; }
     public PaginationOptions? Pagination { get; init; }
 
-    [JsonPropertyName("log-level")]
-    public LogLevelOptions? LoggerLevel { get; init; }
-
     [JsonConstructor]
     public RuntimeOptions(
         RestRuntimeOptions? Rest,
@@ -27,8 +24,7 @@ public RuntimeOptions(
         string? BaseRoute = null,
         TelemetryOptions? Telemetry = null,
         EntityCacheOptions? Cache = null,
-        PaginationOptions? Pagination = null,
-        LogLevelOptions? LoggerLevel = null)
+        PaginationOptions? Pagination = null)
     {
         this.Rest = Rest;
         this.GraphQL = GraphQL;
@@ -37,7 +33,6 @@ public RuntimeOptions(
         this.Telemetry = Telemetry;
         this.Cache = Cache;
         this.Pagination = Pagination;
-        this.LoggerLevel = LoggerLevel;
     }
 
     /// <summary>

src/Config/ObjectModel/TelemetryOptions.cs

@@ -1,10 +1,15 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System.Text.Json.Serialization;
+
 namespace Azure.DataApiBuilder.Config.ObjectModel;
 
 /// <summary>
 /// Represents the options for telemetry.
 /// </summary>
-public record TelemetryOptions(ApplicationInsightsOptions? ApplicationInsights = null, OpenTelemetryOptions? OpenTelemetry = null)
-{ }
+public record TelemetryOptions(ApplicationInsightsOptions? ApplicationInsights = null, OpenTelemetryOptions? OpenTelemetry = null, LogLevelOptions? LoggerLevel = null)
+{
+    [JsonPropertyName("log-level")]
+    public LogLevelOptions? LoggerLevel { get; init; } = LoggerLevel;
+}

src/Service.Tests/Configuration/ConfigurationTests.cs

@@ -3480,7 +3480,7 @@ public void TestExistingLogLevels(LogLevel expectedLevel)
             string configWithCustomLogLevelJson = configWithCustomLogLevel.ToJson();
             Assert.IsTrue(RuntimeConfigLoader.TryParseConfig(configWithCustomLogLevelJson, out RuntimeConfig deserializedRuntimeConfig));
 
-            Assert.AreEqual(expectedLevel, deserializedRuntimeConfig.Runtime.LoggerLevel.Value);
+            Assert.AreEqual(expectedLevel, deserializedRuntimeConfig.Runtime.Telemetry.LoggerLevel.Value);
         }
 
         /// <summary>
@@ -3528,10 +3528,11 @@ public void LogLevelSerialization(LogLevel expectedLevel)
             using (JsonDocument parsedDocument = JsonDocument.Parse(serializedConfig))
             {
                 JsonElement root = parsedDocument.RootElement;
+                JsonElement runtimeElement = root.GetProperty("runtime");
 
                 //Validate log-level property exists in runtime
-                JsonElement runtimeElement = root.GetProperty("runtime");
-                bool logLevelPropertyExists = runtimeElement.TryGetProperty("log-level", out JsonElement logLevelElement);
+                JsonElement telemetryElement = runtimeElement.GetProperty("telemetry");
+                bool logLevelPropertyExists = telemetryElement.TryGetProperty("log-level", out JsonElement logLevelElement);
                 Assert.AreEqual(expected: true, actual: logLevelPropertyExists);
 
                 //Validate level property inside log-level is of expected value
@@ -3559,7 +3560,7 @@ private static RuntimeConfig InitializeRuntimeWithLogLevel(LogLevel? expectedLev
                     Rest: new(),
                     GraphQL: new(),
                     Host: new(null, null),
-                    LoggerLevel: logLevelOptions
+                    Telemetry: new(LoggerLevel: logLevelOptions)
                 ),
                 Entities: baseConfig.Entities
             );

src/Service.Tests/Unittests/RuntimeConfigLoaderJsonDeserializerTests.cs

@@ -260,7 +260,7 @@ public void TestNullableOptionalProps()
 
             // Test with empty sub properties of runtime
             minJson.Append(@"{ ""rest"": { }, ""graphql"": { },
-                            ""base-route"" : """", ""log-level"" : { },");
+                            ""base-route"" : """",");
             StringBuilder minJsonWithHostSubProps = new(minJson + @"""telemetry"" : { }, ""host"" : ");
             StringBuilder minJsonWithTelemetrySubProps = new(minJson + @"""host"" : { }, ""telemetry"" : ");
 
@@ -273,7 +273,7 @@ public void TestNullableOptionalProps()
             TryParseAndAssertOnDefaults("{" + emptyHostSubProps, out _);
 
             // Test with empty telemetry sub-properties
-            minJsonWithTelemetrySubProps.Append(@"{ ""application-insights"": { } } }");
+            minJsonWithTelemetrySubProps.Append(@"{ ""application-insights"": { }, ""log-level"": { } } }");
 
             string emptyTelemetrySubProps = minJsonWithTelemetrySubProps + "}";
             TryParseAndAssertOnDefaults("{" + emptyTelemetrySubProps, out _);