Anzeige
Anzeige
Anzeige
Anzeige
Anzeige
Anzeige
Lesedauer 6 Min.

Logic Analyzer für .NET-Objekte

Grafische Aufwertung von Konsolen- und Logausgaben hilft insbesondere bei der Überwachung von komplexen Objekten – damit ist die Lebensaufgabe des NuGet-Pakets Dumpify auch schon beschrieben.
GrafikAufMonitor.jpg
© KI-generiert, Gemini

Systeme wie das unter Linux weit verbreitete dialog ermöglichen die Nutzung von Semigrafik, um Informationen quadratisch strukturiert auf den Bildschirm zu bringen. Dumpify bietet .NET-Entwicklern eine ähnliche Möglichkeit an.

Schon hier in der Einleitung sei darauf hingewiesen, dass diese Funktion nicht nur beim Debugging hilfreich ist. Sofern die Speicherkosten für Logdaten gering sind, kann es sinnvoll sein, die Logs mit Dumpify grafisch aufzubereiten. Auf diese Art und Weise lassen diese sich sowohl am Bildschirm als auch im Print einfacher analysieren, was im Ernstfall wertvolle Reaktionszeit einsparen hilft.

Erste Schritte mit Dumpify

Wie die meisten Utility-NuGet-Pakete ist auch Dumpify in Bezug auf seine Ausführungsumgebung nur mäßig anspruchsvoll. Die Vorlage Konsolen-App erzeugt uns ein auf .NET 8.0 basierendes Beispielprojekt. Nach dem erfolgreichen Durchlaufen des Projektgenerators wechseln wir in die NuGet-Konsole, wo wir nach dem String Dumpify suchen. Die offizielle Variante stammt von Moaid Hathot und liegt zum Zeitpunkt der Abfassung dieses Artikels in Version 0.7.0 vor.

Nach der Resolvierung der Abhängigkeiten – man denke vor allem an Spectre.Console – ist das Programm im Prinzip einsatzbereit. Als erste Demo führen wir dann folgendes Programm aus:

 

static void Main(string[] args) {
    Console.WriteLine("Hello, World!");
    AppDomain.CurrentDomain.Dump();
}

 

Als Ergebnis erhalten wir die in Bild 1 gezeigte Darstellung. Gut zu erkennen ist die wesentlich klarere Visualisierung.

Dank Dumpify sieht man klarer (Bild 1)

Dank Dumpify sieht man klarer (Bild 1)

© Autor

Dumpify ist intern als eine Extension realisiert, die den diversen unterstützten Objekten die Methode Dump() einschreibt. Bei unparametriertem Aufruf versucht sie ihr Glück an der bestmöglichen Präsentation des jeweiligen Objekts.

Verarbeitung und Einschränkung der Ausgabe von Datenfeldern

Arrays sind ein häufig zu analysierender Datentyp. Als nächste Aufgabe wollen wir daher unter Nutzung einer for-Schleife ein Feld generieren, das eine Serie von aufsteigenden Zahlen generiert. Bild 2 zeigt uns, dass die Ausgabe schnell „terminalfüllend“ wird.

 

Console.WriteLine("Hello, World!");
    int[] tamsField = new int[25];
    for(int i = 0; i < tamsField.Length; i++) {
        tamsField[i] = i;
    }
    tamsField.Dump();

 

Der Inhalt des Arrays erscheint am Bildschirm (Bild 2)

Der Inhalt des Arrays erscheint am Bildschirm (Bild 2)

© Autor

Interessant ist die Möglichkeit, die „Mächtigkeit“ der im Dump ausgegebenen Messwerte zu reduzieren. Hierzu muss ein TruncationConfig-Objekt angeliefert werden. Für einen ersten Rauchtest bietet sich die folgende Konfiguration an:

 

tamsField.Dump(truncationConfig: new TruncationConfig { MaxCollectionCount = 4, Mode = TruncationMode.HeadAndTail });

 

Durch das Übergeben des Attributs Mode = TruncationMode.HeadAndTail legen wir fest, dass sowohl die ersten als auch die letzten Felder des Arrays relevant sind. Als Ergebnis erhalten wir die in Bild 3 gezeigte Ausgabe.

Zwei Elemente von oben und zwei Elemente von unten (Bild 3)

Zwei Elemente von oben und zwei Elemente von unten (Bild 3)

© Autor

Analog zu den diversen Linux-Kommandozeilen-Utilities gibt es in der Enumeration TruncationMode insgesamt drei Werte, die sich in der Reflection folgendermaßen – und selbsterklärend – präsentieren:

 

public enum TruncationMode {
    Head,
    Tail,
    HeadAndTail
}

 

Wer beispielsweise die einleitenden und flankierenden Spalten entfernen möchte, kann dies ebenfalls tun – hierzu reicht es aus, nach folgendem Schema ein TableConfig-Objekt über einen weiteren benannten Parameter in die Dump-Methode einzuschreiben:

 

tamsField.Dump(tableConfig: new TableConfig { ShowTableHeaders = false , ShowArrayIndices=false}, truncationConfig: ...

 

Ab einer gewissen Komplexität der Parametrisierung ist es wünschenswert, die für die Generierung der Dumps verwendeten Einstellungen global zu beeinflussen. Dies lässt sich durch Nutzung von DumpConfig.Default bewerkstelligen – die einfachste Implementierung setzt die notwendigen Parameter einfach am Beginn der Main-Methode:

 

static void Main(string[] args) {
    DumpConfig.Default.TableConfig.ShowTableHeaders = false;
    Console.WriteLine("Hello, World!");

 

Zu beachten ist, dass Dumpify mit DumpConfig.Default nur ein Standard-Objekt mitbringt. Möchte man mehrere Objekt-Konfigurations-Instanzen anlegen, so kann man beispielsweise TableConfig-Objekte als Membervariablen vorhalten und diese an Dump übergeben – dies führt doch zu einer gewissen Reduktion des Codeumfangs.

Automatisierte Umleitung der Dump-Daten in gewünschte Kanäle

Direktes Aufrufen von Dump wirft die Ergebnisse des Programms – wie bisher gezeigt – einfach in die gerade aktive Konsole. In der Praxis ist dies nicht immer wünschenswert – manchmal ist es bequemer, wenn die von Dumpify grafisch aufgearbeiteten Informationen in einen String zurückgeschrieben werden.

Dies lässt sich durch Umleitung der Ausgabe in einen StringWriter bewerkstelligen. Die hier platzierte tautologische Anweisung erlaubt dann das Abernten der Ergebnisse, die sich wie in Bild 4 gezeigt präsentieren:

 

using var writer = new StringWriter();
tamsField.Dump(output: new DumpOutput(writer));
var x = writer.ToString();
Console.WriteLine(writer.ToString());

 

Der Ausgabestring enthält verschiedenste Formatierungszeichen (Bild 4)

Der Ausgabestring enthält verschiedenste Formatierungszeichen (Bild 4)

© Autor

Zur Behebung des Problems reicht es aus, nach folgendem Schema über die ColorConfig-Variable das komplette Weglassen der Farbinformationen zu avisieren:

 

using var writer = new StringWriter();
tamsField.Dump(output: new DumpOutput(writer), colors: ColorConfig.NoColors);

 

Dumpify integriert sich auch sonst ins Visual-Studio-Ökosystem. Die Variante DumpDebug() befiehlt die Ausgabe in den Debug-Datenstrom der IDE, während die Variante DumpTrace() eine Ausgabe in den Trace-Datenstrom durchführt. Zu guter Letzt gibt es noch eine Sondervariante, die nach folgendem Schema einen textuellen Dump befiehlt:

 

var text = package.DumpText();

Visualisierung komplexer Objekte mit Dumpify

Die weiter oben durchgeführte Ausgabe der Reflection zeigt, dass das Paket auch zur Verarbeitung von Objekten befähigt ist. Als Nächstes wollen wir unser TamsFeld nach folgendem Schema in eine Klasse verpacken, die sowohl öffentliche als auch private Member mitbringt:

 

internal class TamsTestClass
{
    public String erstesFeld;
    private String secretFeld;
    public int[] zeiger;
    public TamsTestClass(String sec) {
        secretFeld = sec;
    }
}

 

Für die Ausgabe verwenden wir dann folgenden Code:

 

TamsTestClass aClass = new TamsTestClass("Geheim");
aClass.zeiger = tamsField;
aClass.Dump();

 

Vorerst erhalten wir daraufhin die in Bild 5 gezeigte und nur wenig aussagekräftige Anzeige.

Die Member werden hier nicht automatisch reflektiert (Bild 5)

Die Member werden hier nicht automatisch reflektiert (Bild 5)

© Autor

Zur Behebung des Problems ist eine Instanz von MembersConfig erforderlich – das Feld legt fest, welche Felder für die Ausgabe relevant sind. In Reflection präsentiert es sich folgendermaßen:

 

MembersConfig : ConfigBase<MembersConfig> {
    public TrackableProperty<bool> IncludePublicMembers
    public TrackableProperty<bool> IncludeNonPublicMembers
    public TrackableProperty<bool> IncludeVirtualMembers
    public TrackableProperty<bool> IncludeProperties
    public TrackableProperty<bool> IncludeFields
    public Func<MemberFilterContext, bool>? MemberFilter { get; set; }

 

Eine sinnvolle Parametrierung – wir verwenden in der Testklasse ja Felder – sieht dann folgendermaßen aus:

 

aClass.Dump(members: new MembersConfig { IncludeFields = true , IncludeNonPublicMembers=true});

 

Ergebnis ist die in Bild 6 gezeigte Anzeige.

Alle im Objekt enthaltenen Felder erscheinen nun am Bildschirm (Bild 6)

Alle im Objekt enthaltenen Felder erscheinen nun am Bildschirm (Bild 6)

© Autor

Möchte man zusätzlich Informationen über die Typen der individuellen Felder erhalten, so ist ein weiterer Parameter erforderlich. Am bequemsten kommt er in den soeben besprochenen globalen Einstellungen unter:

 

DumpConfig.Default.TableConfig.ShowMemberTypes = true;
aClass.Dump(members: new MembersConfig { IncludeFields = true , IncludeNonPublicMembers=true});

 

Nun enthält die Ausgabetabelle – wie gezeigt – eine zusätzliche Spalte (Bild 7).

Mehr Informationen stehen zur Verfügung (Bild 7)

Mehr Informationen stehen zur Verfügung (Bild 7)

© Autor

Bei der Verarbeitung von Methoden ist es außerdem erlaubt, hauseigene Filterlogik anzuliefern. Hierzu ist es erforderlich, über MemberFilter einen Funktionspointer (oder ein Lambda) anzuliefern:

 

aClass.Dump(members: new MembersConfig { MemberFilter=myMemberF, IncludeFields = true , IncludeNonPublicMembers=true});

 

Als Ergebnis erhalten wir Aufrufe des Filters pro Member; im Kontextobjekt informiert das Framework über den gerade in Analyse befindlichen Member. Eine Beispielimplementierung, die die Elemente anhand des Namens aufbricht, präsentiert sich folgendermaßen:

 

private static bool myMemberF(MemberFilterContext context)
{
    if (context.Member.Name == "zeiger") return false;
    return true;
}

 

Daraus resultiert schließlich das in Bild 8 gezeigte Systemverhalten.

Der Zeiger wurde erfolgreich ausgeschlossen (Bild 8)

Der Zeiger wurde erfolgreich ausgeschlossen (Bild 8)

© Autor

Fazit

Je übersichtlicher Logging- oder Debug-Informationen ausfallen, desto einfacher wird die Arbeit. Mit Dumpify steht ein kompaktes und doch leistungsfähiges Werkzeug zur Verfügung, das das Leben des Entwicklers versüßen kann.

Neueste Beiträge

Funktionen – Wiederkehrende Logik kapseln - Infrastructure as Code mit Azure Bicep, Teil 4
Dieser Beitrag zeigt, wie benutzerdefinierte Funktionen aufgebaut sind, wie sie sich von den eingebauten Bicep-Funktionen unterscheiden und wie sich das Ergebnis einer Funktion vor dem eigentlichen Deployment überprüfen lässt.
5 Minuten
Enums mit Komfortfunktion - Best of NuGet, Teil 11
Enums sind in Zeiten von unbegrenztem Speicher und außerhalb des AI-Bereichs so gut wie kostenloser Rechenleistung in den Hintergrund getreten. Mit dem NuGet-Paket Enums.NET steht eine Bibliothek zur Verfügung, die dem vernachlässigten Sprachfeature verschiedenste Komfortfunktionen verleiht.
6 Minuten
16. Nov 2026
Vom Garagenprojekt zum Milliardengeschäft – der Aufstieg von Open Source
Im September 1991 wurde Linux 0.01 veröffentlicht. 35 Jahre später ist aus dem Projekt eines finnischen Studenten eine der Grundlagen der digitalen Welt geworden.
7 Minuten
18. Nov 2026

Das könnte Dich auch interessieren

.NET-Anbindung für die Llama-KI - LLamaSharp
Open-Source-KI auf dem lokalen Gerät nutzen – mit handhabbarem Speicherbedarf und optionalem Zugriff auf externe Datenquellen.
8 Minuten
13. Jan 2025
Python in .NET – Integration mit Python.NET - .NET, Python und KI, Teil 1
Python-Code lässt sich in .NET-Anwendungen mit dem Open-Source-Projekt Python.NET einbinden. Wir erklären die Installation und grundlegende Interop-Szenarien. Ein einfaches Beispiel veranschaulicht die Praxis.
6 Minuten
Frühjahrsputz für .NET - Alte .NET-Versionen entfernen
Immer mehr .NET-Versionen sammeln sich auf der Festplatte an. Höchste Zeit, wieder Platz zu schaffen.
14 Minuten
Anzeige
Anzeige
Anzeige
Anzeige
Anzeige