Add default OTEL telemetry settings to dab init config generation

src/Cli.Tests/ConfigGeneratorTests.cs

@@ -176,6 +176,14 @@ public void TestSpecialCharactersInConnectionString()
                     ""provider"": ""AppService""
                         },
                   ""mode"": ""production""
+                                    },
+                                ""telemetry"": {
+                                    ""open-telemetry"": {
+                                        ""enabled"": true,
+                                        ""endpoint"": ""@env('OTEL_EXPORTER_OTLP_ENDPOINT')"",
+                                        ""headers"": ""@env('OTEL_EXPORTER_OTLP_HEADERS')"",
+                                        ""service-name"": ""@env('OTEL_SERVICE_NAME')""
+                                    }
                   }
               },
               ""autoentities"": {},

src/Cli.Tests/EndToEndTests.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using Azure.DataApiBuilder.Config.Converters;
 using Azure.DataApiBuilder.Product;
 using Cli.Constants;
 using Microsoft.Data.SqlClient;
@@ -116,7 +117,7 @@ public void TestInitializingRestAndGraphQLGlobalSettings()
         string[] args = { "init", "-c", TEST_RUNTIME_CONFIG_FILE, "--connection-string", SAMPLE_TEST_CONN_STRING, "--database-type", "mssql", "--rest.path", "/rest-api", "--rest.enabled", "false", "--graphql.path", "/graphql-api" };
         Program.Execute(args, _cliLogger!, _fileSystem!, _runtimeConfigLoader!);
 
-        DeserializationVariableReplacementSettings replacementSettings = new(azureKeyVaultOptions: null, doReplaceEnvVar: true, doReplaceAkvVar: true);
+        DeserializationVariableReplacementSettings replacementSettings = new(azureKeyVaultOptions: null, doReplaceEnvVar: true, doReplaceAkvVar: true, envFailureMode: EnvironmentVariableReplacementFailureMode.Ignore);
         Assert.IsTrue(_runtimeConfigLoader!.TryLoadConfig(
             TEST_RUNTIME_CONFIG_FILE,
             out RuntimeConfig? runtimeConfig,
@@ -196,7 +197,7 @@ public void TestEnablingMultipleCreateOperation(CliBool isMultipleCreateEnabled,
 
         Program.Execute(args.ToArray(), _cliLogger!, _fileSystem!, _runtimeConfigLoader!);
 
-        DeserializationVariableReplacementSettings replacementSettings = new(azureKeyVaultOptions: null, doReplaceEnvVar: true, doReplaceAkvVar: true);
+        DeserializationVariableReplacementSettings replacementSettings = new(azureKeyVaultOptions: null, doReplaceEnvVar: true, doReplaceAkvVar: true, envFailureMode: EnvironmentVariableReplacementFailureMode.Ignore);
         Assert.IsTrue(_runtimeConfigLoader!.TryLoadConfig(
             TEST_RUNTIME_CONFIG_FILE,
             out RuntimeConfig? runtimeConfig,
@@ -273,7 +274,7 @@ public void TestAddTelemetry(string? appInsightsEnabled, string appInsightsConnS
         // Perform assertions on various properties.
         Assert.IsNotNull(runtimeConfig);
         Assert.IsNotNull(runtimeConfig.Runtime);
-        Assert.IsNull(runtimeConfig.Runtime.Telemetry);
+        Assert.IsNotNull(runtimeConfig.Runtime.Telemetry);
 
         string[] addTelemetryArgs;
         if (appInsightsEnabled is null)

src/Cli.Tests/EnvironmentTests.cs

@@ -165,8 +165,7 @@ public async Task FailureToStartEngineWhenEnvVarNamedWrong()
         string? output = await process.StandardError.ReadLineAsync();
         Assert.AreEqual("Deserialization of the configuration file failed during a post-processing step.", output);
         output = await process.StandardError.ReadToEndAsync();
-        StringAssert.Contains(output, "Environmental Variable, "
-            + expectedEnvVarName + ", not found.", StringComparison.Ordinal);
+        StringAssert.Contains(output, "A valid Connection String should be provided.", StringComparison.Ordinal);
         process.Kill();
     }
 

src/Cli.Tests/Snapshots/EndToEndTests.TestAddingStoredProcedureWithRestMethodsAndGraphQLOperations.verified.txt

@@ -47,6 +47,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: [

src/Cli.Tests/Snapshots/EndToEndTests.TestConfigGeneratedAfterAddingEntityWithSourceAsStoredProcedure.verified.txt

@@ -47,6 +47,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: [

src/Cli.Tests/Snapshots/EndToEndTests.TestConfigGeneratedAfterAddingEntityWithSourceWithDefaultType.verified.txt

@@ -47,6 +47,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: [

src/Cli.Tests/Snapshots/EndToEndTests.TestConfigGeneratedAfterAddingEntityWithoutIEnumerables.verified.txt

@@ -48,6 +48,14 @@
         Provider: AppService
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: [

src/Cli.Tests/Snapshots/EndToEndTests.TestInitForCosmosDBNoSql.verified.txt

@@ -53,6 +53,14 @@
         Provider: AppService
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/EndToEndTests.TestUpdatingStoredProcedureWithRestMethods.verified.txt

@@ -47,6 +47,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: [

src/Cli.Tests/Snapshots/EndToEndTests.TestUpdatingStoredProcedureWithRestMethodsAndGraphQLOperations.verified.txt

@@ -47,6 +47,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: [

src/Cli.Tests/Snapshots/InitTests.CosmosDbNoSqlDatabase.verified.txt

@@ -49,6 +49,14 @@
         Provider: AppService
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.CosmosDbPostgreSqlDatabase.verified.txt

@@ -48,6 +48,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.EnsureCorrectConfigGenerationWithDifferentAuthenticationProviders_171ea8114ff71814.verified.txt

@@ -52,6 +52,14 @@
         }
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.EnsureCorrectConfigGenerationWithDifferentAuthenticationProviders_2df7a1794712f154.verified.txt

@@ -48,6 +48,14 @@
         Provider: Simulator
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.EnsureCorrectConfigGenerationWithDifferentAuthenticationProviders_59fe1a10aa78899d.verified.txt

@@ -48,6 +48,14 @@
         Provider: StaticWebApps
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.EnsureCorrectConfigGenerationWithDifferentAuthenticationProviders_b95b637ea87f16a7.verified.txt

@@ -48,6 +48,14 @@
         Provider: AppService
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.EnsureCorrectConfigGenerationWithDifferentAuthenticationProviders_daacbd948b7ef72f.verified.txt

@@ -52,6 +52,14 @@
         }
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.GraphQLPathWithoutStartingSlashWillHaveItAdded.verified.txt

@@ -48,6 +48,14 @@
         Provider: AppService
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.MsSQLDatabase.verified.txt

@@ -51,6 +51,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.RestPathWithoutStartingSlashWillHaveItAdded.verified.txt

@@ -48,6 +48,14 @@
         Provider: AppService
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.TestInitializingConfigWithoutConnectionString.verified.txt

@@ -51,6 +51,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.TestSpecialCharactersInConnectionString.verified.txt

@@ -48,6 +48,14 @@
         Provider: AppService
       },
       Mode: Production
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.VerifyCorrectConfigGenerationWithMultipleMutationOptions_0546bef37027a950.verified.txt

@@ -51,6 +51,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.VerifyCorrectConfigGenerationWithMultipleMutationOptions_0ac567dd32a2e8f5.verified.txt

@@ -51,6 +51,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []

src/Cli.Tests/Snapshots/InitTests.VerifyCorrectConfigGenerationWithMultipleMutationOptions_0c06949221514e77.verified.txt

@@ -56,6 +56,14 @@
       Authentication: {
         Provider: AppService
       }
+    },
+    Telemetry: {
+      OpenTelemetry: {
+        Enabled: true,
+        Endpoint: @env('OTEL_EXPORTER_OTLP_ENDPOINT'),
+        Headers: @env('OTEL_EXPORTER_OTLP_HEADERS'),
+        ServiceName: @env('OTEL_SERVICE_NAME')
+      }
     }
   },
   Entities: []