App Insights - WIP

Author: carldebilly

Dockerfile

@@ -2,13 +2,13 @@
 # msbuild /r /p:Configuration=Release /p:OutputPath=app /t:Publish
 
 # You should run this file with the following parameters:
-# docker build . --build-args DOTNETTAG=<dotnettag> --build-arg OSTAG=<ostag> -t <image-tag>
+# docker build . --build-arg DOTNETTAG=<dotnettag> --build-arg OSTAG=<ostag> -t <image-tag>
 # where:
 #  <dotnettag> is the tag of the dotnet aspnet runtime image
 #  <ostag> is the tag of the runtime for hass.io
 
-ARG DOTNETTAG
-ARG OSTAG
+ARG DOTNETTAG=3.0-alpine-arm64v8
+ARG OSTAG=
 
 FROM mcr.microsoft.com/dotnet/core/aspnet:$DOTNETTAG
 EXPOSE 80

TELEMETRY.md

@@ -29,3 +29,4 @@ The telemetry feature collects the following data:
 * OS & processor type (Windows/Linux) (amd64/arm)
 * Installation type (Docker or HASS.IO)
 * Versions: HASS.IO, Zigbee2Mqtt
+* Crash reports with anonymized details

Zigbee2MqttAssistant.sln

@@ -12,6 +12,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		azure-pipelines.yaml = azure-pipelines.yaml
 		Dockerfile = Dockerfile
 		README.md = README.md
+		TELEMETRY.md = TELEMETRY.md
 	EndProjectSection
 EndProject
 Global

Zigbee2MqttAssistant/Dockerfile

@@ -0,0 +1,23 @@
+# This dockerfile is only for development in VisualStudio!
+# It's not used for build in CI.
+
+FROM mcr.microsoft.com/dotnet/core/aspnet:3.0 AS base
+WORKDIR /app
+EXPOSE 80
+EXPOSE 443
+
+FROM mcr.microsoft.com/dotnet/core/sdk:3.0 AS build
+WORKDIR /src
+COPY ["Zigbee2MqttAssistant/Zigbee2MqttAssistant.csproj", "Zigbee2MqttAssistant/"]
+RUN dotnet restore "Zigbee2MqttAssistant/Zigbee2MqttAssistant.csproj"
+COPY . .
+WORKDIR "/src/Zigbee2MqttAssistant"
+RUN dotnet build "Zigbee2MqttAssistant.csproj" -c Release -o /app
+
+FROM build AS publish
+RUN dotnet publish "Zigbee2MqttAssistant.csproj" -c Release -o /app
+
+FROM base AS final
+WORKDIR /app
+COPY --from=publish /app .
+ENTRYPOINT ["dotnet", "Zigbee2MqttAssistant.dll"]

Zigbee2MqttAssistant/Models/Settings.cs

@@ -64,10 +64,5 @@ public partial class Settings
 		/// https://github.com/yllibed/Zigbee2MqttAssistant/blob/master/TELEMETRY.md
 		/// </remarks>
 		public bool TelemetryOptOut { get; } = false;
-
-		/// <summary>
-		/// Instrumentation Key for Azure AppInsights
-		/// </summary>
-		public string TelemetryInstrumentationKey { get; } = "a07cd338-3c1d-417a-890b-67e56efa2ae9";
 	}
 }

Zigbee2MqttAssistant/Program.cs

@@ -6,6 +6,7 @@
 using Microsoft.AspNetCore;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
 namespace Zigbee2MqttAssistant
@@ -14,7 +15,9 @@ public class Program
 	{
 		public static void Main(string[] args)
 		{
-			CreateWebHostBuilder(args).Build().Run();
+			CreateWebHostBuilder(args)
+				.Build()
+				.Run();
 		}
 
 		public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>

Zigbee2MqttAssistant/Services/AppTelemetry.cs

@@ -0,0 +1,59 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.ApplicationInsights;
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.Extensibility;
+using Microsoft.Extensions.Hosting;
+using Zigbee2MqttAssistant.Models;
+
+namespace Zigbee2MqttAssistant.Services
+{
+	public class AppTelemetry : IAppTelemetry, ITelemetryInitializer, IDisposable
+	{
+		private readonly TelemetryClient _client;
+
+		private readonly CancellationTokenSource _cts = new CancellationTokenSource();
+
+		public AppTelemetry(ISettingsService settings, ISystemInformation systemInformation)
+		{
+			TelemetryConfiguration.Active.TelemetryInitializers.Add(this);
+
+			_client = new TelemetryClient(SettingsToTelemetryConfig(settings.CurrentSettings));
+		}
+
+		private static TelemetryConfiguration SettingsToTelemetryConfig(Settings settings)
+		{
+			return null;
+			//return new TelemetryConfiguration(settings.TelemetryInstrumentationKey);
+		}
+
+		public async void ReportStart()
+		{
+			while (!_cts.IsCancellationRequested)
+			{
+				_client.TrackEvent("test");
+
+
+				await Task.Delay(TimeSpan.FromMinutes(15), _cts.Token);
+			}
+		}
+
+		public void ReportStop()
+		{
+		}
+
+		public void ReportError(string message, Exception exception)
+		{
+		}
+
+		void ITelemetryInitializer.Initialize(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry)
+		{
+		}
+
+		public void Dispose()
+		{
+			_cts.Dispose();
+		}
+	}
+}

Zigbee2MqttAssistant/Services/IAppTelemetry.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace Zigbee2MqttAssistant.Services
+{
+	public interface IAppTelemetry
+	{
+		void ReportStart();
+		void ReportStop();
+
+		void ReportError(string message, Exception exception);
+	}
+}

Zigbee2MqttAssistant/Services/ISystemInformation.cs

@@ -1,4 +1,6 @@
-namespace Zigbee2MqttAssistant.Services
+using System;
+
+namespace Zigbee2MqttAssistant.Services
 {
 	public interface ISystemInformation
 	{
@@ -20,5 +22,6 @@ public interface ISystemInformation
 		bool MqttBrokerConnected { get; }
 		int NumberOfDevices { get; }
 		bool Telemetry { get; }
+		DateTimeOffset StartTime { get; }
 	}
 }

Zigbee2MqttAssistant/Services/SettingsService.cs

@@ -7,21 +7,32 @@ namespace Zigbee2MqttAssistant.Services
 	public class SettingsService : ISettingsService
 	{
 		public SettingsService(IConfiguration configuration, ILogger<SettingsService> logger)
+		{
+			var settings = GetFromConfiguration(configuration);
+			if(settings == null)
+			{
+				logger.LogWarning(
+					"Section 'settings' in configuration does not exists. Will use default settings instead.");
+				CurrentSettings = Settings.Default;
+			}
+			else
+			{
+				CurrentSettings = settings;
+			}
+		}
+
+		internal static Settings GetFromConfiguration(IConfiguration configuration)
 		{
 			var section = configuration.GetSection("settings");
 
 			if (section.Exists())
 			{
 				var settingsBuilder = new Settings.Builder();
 				section.Bind(settingsBuilder);
-				CurrentSettings = settingsBuilder;
-			}
-			else
-			{
-				logger.LogWarning(
-					"Section 'settings' in configuration does not exists. Will use default settings instead.");
-				CurrentSettings = Settings.Default;
+				return settingsBuilder;
 			}
+
+			return null;
 		}
 
 		public Settings CurrentSettings { get; }