Dev/saars/split service collection (#151)

* Refactor service collection builder * Update version number and build scripts * Build basic services * Add logging for user configurations * Clean up the APIs to enable AI.K8S * Add unit tests for configurations * Update readme * Fix a mistake in the readme
microsoft · Nov 19, 2018 · 68922e6 · 68922e6
1 parent de1b629
commit 68922e6
Show file tree

Hide file tree

Showing 14 changed files with 607 additions and 151 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -2,16 +2,44 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "build",
-            "command": "dotnet",
-            "type": "process",
+            "label": "Build Debug",
+            "command": "${workspaceFolder}/build/Build.cmd",
+            "type": "shell",
+            "group": "build",
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "Build Release",
+            "command": "${workspaceFolder}/build/Build.cmd",
+            "type": "shell",
+            "group": "build",
+            "args": [
+                "Release",
+            ],
+            "problemMatcher": "$msCompile",
+        },
+        {
+            "label": "ReBuild Debug",
+            "command": "${workspaceFolder}/build/Build.cmd",
+            "type": "shell",
             "group": "build",
             "args": [
-                "build",
-                "${workspaceFolder}/ApplicationInsights.Kubernetes.sln"
+                "Debug",
+                "True",
             ],
             "problemMatcher": "$msCompile"
         },
+        {
+            "label": "ReBuild Release",
+            "command": "${workspaceFolder}/build/Build.cmd",
+            "type": "shell",
+            "group": "build",
+            "args": [
+                "Release",
+                "True",
+            ],
+            "problemMatcher": "$msCompile",
+        },
         {
             "label": "Run Unit Tests",
             "command": "dotnet",

diff --git a/README.md b/README.md
@@ -24,6 +24,42 @@ We support **ASP.NET Core** application as well as **.NET Core** application.
 
 * Follow [this example](examples/BasicUsage_clr21_RBAC) for Role-based access control (RBAC) enabled Kubernetes clusters.
 
+### Configuration Details
+
+Customize configurations are supported for `v1.0.2+`. There are several ways to customize the settings. For example:
+
+1. By the code:
+    ```csharp
+    services.AddApplicationInsightsKubernetesEnricher(option=> {
+        option.InitializationTimeout = TimeSpan.FromSeconds(15);
+    });
+    ```
+
+2. By `appsettings.json`:
+    ```jsonc
+    {
+        "Logging": {
+            // ...
+        },
+        // Adding the following section to set the timeout to 15 seconds
+        "AppInsightsForKubernetes": {
+            "InitializationTimeout": "00:00:15"
+        }
+    }
+    ```
+3. By environment varialbe:
+    ```
+    AppInsightsForKubernetes__InitializationTimeout=3.1:12:15.34
+    ```
+
+    All the related configurations have to be put in a section named `AppInsightsForKubernetes`. The supported keys/values are listed below:
+
+    | Key                   | Value/Types | Default Value | Description                                                                                            |
+    |-----------------------|-------------|---------------|--------------------------------------------------------------------------------------------------------|
+    | InitializationTimeout | TimeSpan    | 00:02:00      |  Maximum time to wait for spinning up the container. Accepted format: [d.]hh:mm:ss[.fffffff]. |
+
+The configuration uses with the conventions in ASP.NET Core. Refer [Configuration in ASP.NET Core](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-2.1) for more information.
+
 ### Verify the cluster configuration
 Use the [troubleshooting image](https://github.com/Microsoft/ApplicationInsights-Kubernetes/tree/develop/troubleshooting) to verify the cluster is properly configured.
 

diff --git a/build/Build.cmd b/build/Build.cmd
@@ -3,6 +3,9 @@ SETLOCAL
 SET CONFIG=%1
 SET REBUILD=%2
 IF '%CONFIG%' == '' SET CONFIG=Debug
+SET REBUILD_PARAM=--no-incremental
+IF '%REBUILD%' == '' SET REBUILD_PARAM=
+
 
 ECHO Target Configuration: %CONFIG%.
 FOR /F "TOKENS=1* DELIMS= " %%A IN ('DATE/T') DO SET CDATE=%%B
@@ -13,7 +16,7 @@ FOR /F "TOKENS=1-2 delims=/:" %%a in ("%TIME%") DO SET mytime=%%a%%b
 SET CURRENT_DATE_TIME=%yyyy%%mm%%dd%%mytime%
 ECHO Version:%CURRENT_DATE_TIME%
 
-dotnet build %~dp0\..\ApplicationInsights.Kubernetes.sln
+dotnet build -c %CONFIG% %REBUILD_PARAM% %~dp0\..\ApplicationInsights.Kubernetes.sln
 
 :HELP
 GOTO :EXIT

diff --git a/src/ApplicationInsights.Kubernetes/ApplicationInsights.Kubernetes.csproj b/src/ApplicationInsights.Kubernetes/ApplicationInsights.Kubernetes.csproj
@@ -27,17 +27,23 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)'=='netstandard1.3'">
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="1.1.2" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="1.1.2" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="1.1.2" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="1.1.2" />
   </ItemGroup>
   <ItemGroup Condition="'$(TargetFramework)'=='netstandard1.6'">
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="1.1.2" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="1.1.1" />
     <PackageReference Include="Microsoft.ApplicationInsights.DependencyCollector" Version="2.4.1" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="1.1.2" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="1.1.2" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="1.1.2" />
   </ItemGroup>
   <ItemGroup Condition="'$(TargetFramework)'=='netstandard2.0'">
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="2.0.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="2.0.0" />
     <PackageReference Include="Microsoft.ApplicationInsights.DependencyCollector" Version="2.4.1" />
   </ItemGroup>
 </Project>
diff --git a/src/ApplicationInsights.Kubernetes/Extensions/AppInsightsForKubernetesOptions.cs b/src/ApplicationInsights.Kubernetes/Extensions/AppInsightsForKubernetesOptions.cs
@@ -0,0 +1,19 @@
+using System;
+using Newtonsoft.Json;
+
+namespace Microsoft.Extensions.DependencyInjection
+{
+    /// <summary>
+    /// Object model of configuration for Application Insights for Kubernetes.
+    /// </summary>
+    [JsonObject(MemberSerialization = MemberSerialization.OptIn)]
+    public class AppInsightsForKubernetesOptions
+    {
+        /// <summary>
+        /// Maximum time to wait for spinning up the container.
+        /// </summary>
+        /// <value></value>
+        [JsonProperty("InitializationTimeout")]
+        public TimeSpan InitializationTimeout { get; set; } = TimeSpan.FromMinutes(2);
+    }
+}