Sedge - Automatische Anwendung zur Fehlerberichterstattung

    Ein leichter lyrischer Exkurs


    Zufällig habe ich in letzter Zeit Programme entwickelt, die mit verschiedenen Geräten zusammenarbeiten. Bei den bisherigen Arbeiten handelte es sich um Roboter und Prüfstationen für die Halbleiterindustrie, beim heutigen Massenspektrometer für Chemie und Medizin. Es scheint, dass es völlig unterschiedliche Branchen und den Zweck der Programme gibt, aber aus Sicht des Entwicklers gibt es viele Gemeinsamkeiten.

    Die typische Konfiguration, mit der wir arbeiten, kann wie folgt beschrieben werden: Die Station, an die der Client-Computer angeschlossen ist. Auf dem Computer ist eine Basisanwendung installiert, die mit dem Gerät interagiert und Schnittstellen zum Sammeln von Daten bereitstellt. Diese Schnittstellen werden von einem Dutzend vertikaler Anwendungen verwendet, die zur Lösung spezifischer Benutzerprobleme benötigt werden. Um ein Problem zu lösen, müssen normalerweise zwei oder drei Anwendungen zusammenarbeiten. Diese gesamte Reihe von Anwendungen hängt von zahlreichen Konfigurationsdateien ab und generiert eine große Menge an Berichten und Daten.

    Diese lange Einführung war notwendig, um zu erklären, warum es für die Lokalisierung eines Fehlers im System wichtig ist, den Zustand des Systems so genau wie möglich zu kennen. Der Fehlerbericht kann mehrere Dutzend Dateien enthalten - Protokolle, Konfigurationsdateien, Datendateien und Projekte. Es ist keine angenehme Erfahrung, dem Benutzer telefonisch zu erklären, wie man alles zusammensetzt.

    Wenn Sie sich in einer ähnlichen Situation befinden, benötigen Sie möglicherweise ein Programm zur Automatisierung der Erstellung von Fehlerberichten - Sedge . Mit seiner Hilfe können Sie den Benutzer über den aufgetretenen Fehler befragen, automatisch einen Bericht erstellen, der Benutzerinformationen, Systemdaten, alle erforderlichen Dateien enthält, packen und senden.


    Wie funktioniert das?


    Um zu verstehen, wie Sedge funktioniert, sind zwei Konzepte wichtig: Suite (eine Reihe von Anwendungen) und Anwendung (eine Anwendung). Eine Reihe von Anwendungen kann in einer oder mehreren .sedge-Dateien beschrieben werden und definiert allgemeine Eigenschaften für eine Reihe verwandter Programme, z. B. Benutzeroberfläche, freigegebene Dateien und Berichtsübertragungsmethode.

    Beispielsweise verfügt Ihr Unternehmen möglicherweise über einen Basisdienst für den Zugriff auf Daten und zwei Programme für die Verarbeitung und Anzeige dieser Daten. Das Set besteht dann aus drei Anwendungen und kann in drei Konfigurationsdateien unterteilt werden: main.sedge, mit der festgelegt wird, was im Falle eines Fehlers in einer der Anwendungen app1.sedge und app2.sedge im Bericht enthalten sein soll, in denen zusätzliche spezifische Berichtsparameter angegeben werden für die entsprechende Anwendung. Die Dateien app1.sedge und app2.sedge können während der Installation oder Deinstallation von Programmen hinzugefügt oder entfernt werden.

    Die Konfigurationsdatei bestimmt das Verhalten des Programms vollständig. Es legt die Schritte des Assistenten fest, welche Dateien zum Bericht hinzugefügt werden sollen, welche Informationen und wie sie im HTML-Bericht dargestellt werden.

    Einfaches Beispiel für eine Konfigurationsdatei



      
        
          
          
          
          
        


        
          


        
          
            
              
            

            
              
              
              
            

          

          
            
              
            

            
              
            

          

        


        
          
            
            

          

        


      



    * This source code was highlighted with Source Code Highlighter.


    Der erste Schritt des Assistenten

    Bild

    Eine der Seiten des Berichts, die gemäß dieser Konfiguration erstellt wurden

    Bericht

    Informationsquellen für den Bericht: Screenshots, Registrierung, automatisch gesammelte Dateien, Informationen über das System, Speicher, Prozessor, Liste der ausgeführten Prozesse, vom Benutzer bereitgestellte Informationen (Beschreibung des Problems, Datendateien usw.).

    Da die Berichtsszenarien je nach Anwendung stark variieren können, bietet das Programm zahlreiche Möglichkeiten zur Anpassung und Erweiterung. Sie können ganz einfach eigene Assistentenschritte oder Informationsquellen erstellen, wenn Sie beispielsweise Daten aus einer Datenbank abrufen möchten, die vom Programm standardmäßig nicht unterstützt wird. Beispiele zum Erstellen von Erweiterungen sind zusammen mit dem Quellcode des Programms verfügbar.

    Das Erscheinungsbild des Berichts kann auch geändert werden, da die Vorlage mit HTML und CSS angegeben wird. Beliebiger Text (Schnittstelle, Nachrichten) kann ersetzt oder lokalisiert werden. Standardmäßig werden englische und russische Benutzeroberflächen unterstützt.

    Programminformationen

    Plattform: .NET Framework 2.0 / C # 3.0
    Lizenz: MIT
    Status: Beta
    Website: sedge.codeplex.com

    Jetzt auch beliebt: