{"id":6771,"date":"2020-05-16T19:16:46","date_gmt":"2020-05-16T17:16:46","guid":{"rendered":"https:\/\/u-labs.de\/portal\/?p=6771"},"modified":"2020-05-16T22:17:04","modified_gmt":"2020-05-16T20:17:04","slug":"zeitstempel-in-asp-net-core-anwendungen-auf-der-konsole-anzeigen","status":"publish","type":"post","link":"https:\/\/u-labs.de\/portal\/zeitstempel-in-asp-net-core-anwendungen-auf-der-konsole-anzeigen\/","title":{"rendered":"Zeitstempel in (ASP) .NET Core Anwendungen auf der Konsole anzeigen"},"content":{"rendered":"

Die ILogger Schnittstelle erm\u00f6glicht das einfache Injizieren eines Loggers in jegliche Klasse. Durch das Protokollieren des Namespace ist stets klar, von welcher Komponente die Informationen stammen. In der appsettings.json k\u00f6nnen wir f\u00fcr jeden Namespace den Detailgrad einstellen. Dies geht bis hin zu Debug- und Tracelogs, die uns z.B. beim EntityFramework die SQL-Abfragen protokollieren. <\/p>\n

Das standardm\u00e4\u00dfig verf\u00fcgbare Logging-Komponente ist also recht m\u00e4chtig. Drittanbieter-Alternativen wie Log4j (die auch nach .NET portiert wurden) m\u00fcssen daher nicht zwingend eingebunden werden. Doch leider fehlt zumindest bisher noch eine entscheidende Funktion: Zeitstempel. S\u00e4mtliche Logeintr\u00e4ge erhalten keinerlei Datums- oder Zeitangaben. Gerade bei l\u00e4ngeren Protokollen ist daher nicht mehr nachvollziehbar, wann ein bestimmtes Ereignis geschehen ist. Zur L\u00f6sung dieses Problemes gibt es leider auch noch keine Konfigurationseinstellung<\/p>\n

Auf den ersten Blick bleibt daher nur der manuelle Weg: Den aktuellen Zeitstempel h\u00e4ndisch in den zu protokollierenden Text einf\u00fcgen<\/p>\n

logger.LogInformation($"{DateTime.Now.ToString()} Index-Action aufgerufen");<\/code><\/pre>\n
Automatisierte Zeistempel durch Vererbung<\/h2>\n
Der h\u00e4ndische Weg ist aber umst\u00e4ndlich, wenig flexibel und fehleranf\u00e4llig. Au\u00dferdem verschlechtert sich die Lesbarkeit des Codes. Das Problem l\u00e4sst sich recht einfach, aber nachhaltig durch Vererbung l\u00f6sen. Wir erstellen eine Klasse TimedLogger<T><\/strong>, die von ILogger<T><\/strong> erbt. Hier f\u00fcgen wir in der generischsten Log-Methode den Zeitstempel ein. Alles andere wird an eine Instanz der Basisklasse weitergegeben.<\/p>\n
using System;\nusing Microsoft.Extensions.Logging;\n\npublic class TimedLogger<T> : ILogger<T> {\n    private readonly ILogger logger;\n\n    public TimedLogger(ILogger logger) => this.logger = logger;\n\n    public TimedLogger(ILoggerFactory loggerFactory) : this(new Logger<T>(loggerFactory)) { }\n\n    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter) =>\n        logger.Log(logLevel, eventId, state, exception, (s, ex) => $"[{DateTime.UtcNow:HH:mm:ss.fff}] {formatter(s, ex)}");\n\n    public bool IsEnabled(LogLevel logLevel) => logger.IsEnabled(logLevel);\n\n    public IDisposable BeginScope<TState>(TState state) => logger.BeginScope(state);\n}<\/code><\/pre>\n
Das Format kann man nat\u00fcrlich frei anpassen<\/a> und auf Wunsch auch die Zeitzone des Zielsystemes statt UTC verwenden. M\u00f6chte man beispielsweise das Datum im Format 16.05.20 vor der Uhrzeit sehen und die lokale Zeitzone nutzen, kann folgende Formatierung genutzt werden:<\/p>\n
DateTime.Now:dd.MM.y, HH:mm:ss.fff<\/code><\/pre>\n
Unsere modifizierte TimedLogger<T><\/strong> ist nun Einsatzbereit. Allerdings wird sie noch nicht geladen. Wie injizieren wir TimedLogger<T><\/strong> per Dependency Injection, statt des standardm\u00e4\u00dfigen Logger<T><\/strong>? Hierf\u00fcr gibt es die praktische IServiceCollection <\/strong>Erweiterungsmethode Replace<\/strong>: Sie ersetzt eine bereits registrierte Dienstklasse anhand des Types und erlaubt diese zu Ersetzen.<\/p>\n
In Startup.ConfigureServices<\/strong> f\u00fchren wir damit die Ersetzung durch:<\/p>\n
services.Replace(ServiceDescriptor.Singleton(typeof(ILogger<>), typeof(TimedLogger<>)));<\/code><\/pre>\n
Die Erweiterungsmethode befindet sich im Namensraum Microsoft.Extensions.DependencyInjection.Extensions.<\/strong> Nun erhalten alle<\/strong> Klassen, die ILogger<T><\/strong> referenzieren, unsere eigene Klasse mit den Zeitangaben. Ein weiterer Vorteil dieser L\u00f6sung gegen\u00fcber anderen Frameworks wie Log4 ist: Bestehender Code muss nicht ge\u00e4ndert werden. Haben wir den integrierten Ilogger<T><\/strong> zuvor bereits genutzt, beispielsweise in einem Controller<\/p>\n
public class HomeController : Controller {\n    readonly ILogger<HomeController> logger;\n    public HomeController(ILogger<HomeController> logger) {\n        this.logger = logger;\n    }\n\t\n    public IActionResult Index() {\n        logger.LogInformation("Index-Action aufgerufen");\n        return View();\n    }\n}<\/code><\/pre>\n
Funktioniert dies aufgrund der Vererbung weiterhin. Nun allerdings mit Zeitstempel.<\/p>\n
\"\"<\/figure>\n","protected":false},"excerpt":{"rendered":"
Die ILogger Schnittstelle erm\u00f6glicht das einfache Injizieren eines Loggers in jegliche Klasse. Durch das Protokollieren des Namespace ist stets klar, von welcher Komponente die Informationen stammen. In der appsettings.json k\u00f6nnen wir f\u00fcr jeden Namespace den Detailgrad einstellen. Dies geht bis hin zu Debug- und Tracelogs, die uns z.B. beim EntityFramework die SQL-Abfragen protokollieren. Das standardm\u00e4\u00dfig …<\/p>\n","protected":false},"author":5,"featured_media":6777,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[61,1],"tags":[590,805,330],"class_list":["post-6771","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-softwareentwicklung","category-technik-news","tag-net-core","tag-asp-net-core-2-1","tag-c"],"_links":{"self":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/6771","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/comments?post=6771"}],"version-history":[{"count":7,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/6771\/revisions"}],"predecessor-version":[{"id":6779,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/6771\/revisions\/6779"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/media\/6777"}],"wp:attachment":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/media?parent=6771"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/categories?post=6771"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/tags?post=6771"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}