Die Bibliothek ist mit folgenden.net-frameworks kompatibel: .NET 4.5

Transkript

1 Die DW-LogLibrary ist eine kleine, einfach zu verwendende Softwarebibliothek, um Entwicklern von.net-programmen das Speichern von Ausgaben und Fehlermeldungen ihrer Programme zu erleichtern. Sie unterstützt folgende Funktionalitäten: Ausgabe nach Text, HTML, XML, Windows Event-Log, Konsolenfenster, und SQL-Server Hierarchische Feinsteuerung der zu loggenden Informationen per Log-Level Ein- und Ausschalten des Logging Die Bibliothek ist mit folgenden.net-frameworks kompatibel:.net 4.5 Für Hinweise, Anregungen und Kritik bin ich jeder Zeit offen, nur so kann ich die Bibliothek verbessern! Bitte schreiben Sie mir eine Mail an LIZENZ: Diese Software ist freie Software und darf unentgeldlich genutzt und verbeitet werden. Der Entwickler haftet nicht für Schäden oder Datenverlust, welche durch die Installation oder die Nutzung des Programms entstehen. Es können keine Garantieansprüche oder Haftungsforderungen gegen Daniel Witt, Softwareentwicklung & IT-Management Hamburg geltend gemacht werden. Copyright(c) by Daniel Witt Eines vorweg: Diese Bibliothek ist ein Kleinwagen, kein Mercedes! Sie ist eher für den täglichen Gebrauch in kleinen und mittleren Software-Projekten gedacht. Ziel war es, den Verwaltungsaufwand klein zu halten und die Benutzung so einfach wie möglich zu gestalten. Weiterhin ist die Bibliothek mit 24KB sehr klein und kein Speicherfresser. Die Bibliothek stellt folgende öffentliche Typen bereit: Logger Klasse LogLevel Enumerator TextEventArgs Klasse Die Klasse Logger ist eine statische Klasse. Einmal initialisiert kann sie überall in Ihrem Programm verwendet werden, ohne dass neue Instanzen gebildet werden müssen. Über den LogLevel Enumerator wird gesteuert, was geloggt werden soll. Die Werte sind: Trace, Debug, Information, Warning und Error. Sie sind hierarchisch angeordnet, was eine Feinsteuerung der zu loggenden Ausgaben ermöglicht. Sie können z.b. in der Auslieferversion das Log-Level Warning setzen um nur noch Warning- und Error-Informationen zu loggen. Anderen Informationen werden dann ignoriert.

2 TextEventArgs dient als Parameterklasse, wenn Sie Log-Ausgaben noch an andere Ziele weiterleiten wollen. Das Loggen kann über die Eigenschaft EnableLogging der Klasse Logger komplett abgeschaltet werden, ohne dass Ihr Code neu kompiliert werden muss, wenn Sie Ihr Programm über eine Konfigurationsdatei steuern. Folgende Log-Ziele werden unterstützt: Text-, bzw. Log-Datei, XML-Datei, HTML- Datei, Windows Event-Log, Konsolen-Fenster, SQL-Server Datenbank und . Einschränkungen: Festgelegtes Ausgabeformat: Lfd Nr Zeitstempel Log-Level Ihre Log- Information Es kann nur ein Log-Ziel zur Zeit geöffnet werden Es gibt keine Größenbeschränkung für Log-Dateien 1. Setzen Sie in Ihrem Projekt einen Verweis auf die DWLogLibrary 2. Setzen Sie die entsprechende using Anweisung in Ihrem Code 3. Setzen Sie in der Main Methode Ihres Programms die Eigenschaften EnableLogging und LogLevel der Klasse Logger 4. Öffnen Sie in der Main Methode Ihres Programms das Log über die Methode OpenLog der Klasse Logger 5. Schreiben Sie die Log-Informationen über die Methode WriteToLog der Klasse Logger in das Log 6. Schliessen Sie in der Main Methode Ihres Programms das Log über die Methode CloseLog der Klasse Logger using DWLogLibrary; static void Main(string[] args) try // Loggen einschalten Logger.EnableLogging = true; // LogLevel=Debug. Loggt Debug, Information, Warning und Error Logger.LogLevel = LogLevel.Debug; // Log mit Text-Datei als Log-Ziel öffnen Logger.OpenLog(@"C:\Temp\log.txt"); // Hier steht Ihr Programm-Code... Logger.WriteToLog("Programm beendet.", LogLevel.Information); catch (Exception e) Logger.WriteToLog(e.ToString(), LogLevel.Error); finally Logger.CloseLog();

3 Die statische Klasse Logger ist das zentrale Objekt, über welches der gesamte Log- Prozess abläuft und die Sie in Ihrem Programm benutzen. Einmal initialisiert kann sie überall in Ihrem Programm aufgerufen werden, ohne dass Instanzen von ihr erstellt werden müssen. Die Klasse veröffentlicht folgende Eigenschaften und Methoden: Eigenschaften: EnableLogging EnableInternalLogging ShowMessageBox LogLevel Schaltet das Logging ein oder aus. (true / false) Schaltet das Logging für interne Fehler ein oder aus. (true / false) Zeigt eine MessageBox mit der Log-Ausgabe an oder nicht.(true / false) Siehe unten. Logger.LogLevel ist ein hierarchisch abgestufter Wert der entscheidet, welche Informationen Sie loggen wollen. Der Standardwert ist LogLevel.Trace. Er kann über den Enumerator LogLevel bestimmt werden, welcher folgende Werte in hierarchischer Abstufung bereit stellt: LogLevel.Trace loggt alle Level LogLevel.Debug loggt auch Information, Warning und Error LogLevel.Information loggt auch Warning und Error LogLevel.Warning loggt auch Error LogLevel.Error loggt nur Error Dies ermöglicht eine Feinsteuerung der zu loggenden Ausgaben. Sie können z.b. in der Auslieferversion das Log-Level Warning setzen um, nur noch Warning- und Error-Informationen zu loggen. Anderen Informationen werden dann ignoriert. Methoden: public static void OpenLog(String logtarget) Diese Methode öffnet das Log. Der Parameter logtarget bestimmt den Typ des Logs. Lesen Sie hierzu das Thema Logging-Ziele. public static void WriteToLog(String loginformation, LogLevel level) Diese Methode schreibt Informationen in das Log. Der Parameter loginformation beinhaltet die Informationen, die Sie speichern möchten. Der Parameter level bestimmt den Typ der Informationen (Trace Debug Information Warning Error). public static void CloseLog() WICHTIG: Diese Methode schließt das Log. Sie sollte spätestens am Ende Ihres Programms aufgerufen werden, da sonst eventuell noch geöffnete Datei-Handle oder Datenbankverbindungen nicht geschlossen werden!

4 Ereignisse: LogErrorCallback Diesem Ereignishandler können Sie einen Delegaten an eine Funktion zuweisen, um die Log-Ausgabe zusätzlich an ein anderes Ziel weiterzusenden. Verwenden Sie als Parameter eine Instanz der Klasse TextEventArgs. Folgende Beispiele zeigen die unterstützten Log-Ziele und wie sie mit der Methode OpenLog der Klasse Logger geöffnet werden. HINWEIS: Exceptions innerhalb der Bibliothek werden in einer eigenen Datei im Applikations-Verzeichnis mit dem Namen "DWLogLibrary.log" gespeichert. Sie können das interne Loggen ausschalten, indem Sie die Eigenschaft Logger.EnableInternalLogging = false setzen Für alle Datei-Logger gilt: Der Benutzer, unter welchem Ihr Programm läuft, muss Schreib- und Lese- Rechte am Ausgabeverzeichnis besitzen Es werden Kopf- und Fuß-Informationen am Anfang und Ende des Programmlaufs geloggt Es wird an eine bestehende Datei angehängt oder sie wird neu erstellt, falls noch nicht vorhanden Es können auch UNC-Pfade der Form \\Servername\Freigabename\Dateiname verwendet werden Text- oder Log-Datei: Syntax: [ Pfad\ ] Dateiname.[ txt log ] Logger.OpenLog(@"C:\Temp\Dateiname.txt"); oder Logger.OpenLog(@"C:\Temp\Dateiname.log"); HTML-Datei: Syntax: [ Pfad\ ] Dateiname.[ htm html ] Logger.OpenLog(@"C:\Temp\Dateiname.htm"); oder Logger.OpenLog(@"C:\Temp\Dateiname.html"); XML-Datei: Syntax: [ Pfad\ ] Dateiname.xml Logger.OpenLog(@"C:\Temp\Dateiname.xml"); Windows Event-Log: Syntax: Eventlog Logger.OpenLog("Eventlog"); Ihre Log-Informationen werden in das Anwedungs- bzw. Application-Log geschrieben. Es wird der Computer genutzt, auf dem Ihr Programm läuft. Achten Sie darauf, dass der Benutzer, unter dem Ihr Programm läuft, über Schreib-Rechte am Event-Log verfügt.

5 Mail-System: Syntax: ffix (optional) Passwort, (optional) Port om,mypasswort,25"); Achten Sie darauf, dass es sich bei den Mail-Adressen um echte Konten handelt! SQL-Server: Um in den SQL-Server zu loggen müssen bestimmte Tabellen in einer Datenbank Ihrer Wahl vorhanden sein. Ein SQL-Script zum Erstellen der Tabellen finden Sie unten. Achten Sie darauf, dass Sie über ein gültiges Benutzerkonto zur Verbindung mit dem SQL-Server verfügen. Syntax mit impliziter Anmeldung: Logger.OpenLog("Data Source=Servername;Initial Catalog=Datenbankname;Integrated Security= True ); Syntax mit expliziter Anmeldung: Logger.OpenLog("Data Source=Servername;Initial Catalog= Datenbankname;UserID=Benutzername;Password= Benutzerpasswort"); Die DW-LogLibrary benötigt zum Loggen in eine SQL-Server Datenbank zwei Tabellen, welche relational miteinander verknüpft sind. Kopieren Sie das folgende Script in Ihren SQL-Editor und ersetzen Sie in der USE-Anweisung das Wort Datenbankname durch den Namen Ihrer Datenbank. Führen Sie das Script mit Administrator-Rechten aus. SET ANSI_NULLS ON SET QUOTED_IDENTIFIER ON USE Datenbankname CREATE TABLE [LogRun]( [ID] [bigint] IDENTITY(1,1) NOT NULL, [LoggingComputer] [nvarchar](32) NOT NULL, [LoggingApplication] [nvarchar](512) NOT NULL, [LoggingStartTime] [nvarchar](32) NOT NULL, [LoggingEndTime] [nvarchar](32) NULL, [LoggedItems] [bigint] NULL, CONSTRAINT [PK_ApplicationRun] PRIMARY KEY CLUSTERED ( [ID] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] ) ON [PRIMARY] SET ANSI_NULLS ON SET QUOTED_IDENTIFIER ON CREATE TABLE [LogEntry]( [ID] [bigint] IDENTITY(1,1) NOT NULL, [LogRunID] [bigint] NOT NULL, [LogEntry] [bigint] NOT NULL,

6 [LogTime] [nvarchar](32) NOT NULL, [LogLevel] [nvarchar](16) NOT NULL, [LogMessage] [nvarchar](max) NOT NULL, CONSTRAINT [PK_ApplicationLog] PRIMARY KEY CLUSTERED ( [ID] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] ) ON [PRIMARY] ALTER TABLE [LogEntry] WITH CHECK ADD CONSTRAINT [FK_LogEntry_LogRun] FOREIGN KEY([LogRunID]) REFERENCES [LogRun] ([ID]) ALTER TABLE [LogEntry] CHECK CONSTRAINT [FK_LogEntry_LogRun]