Click here to Skip to main content
Click here to Skip to main content

Tagged as

Simple File Tracer

, 19 May 2009 CPOL
Rate this:
Please Sign up or sign in to vote.
Custom component responsible for logging into a file

Introduction

During software development, testing and even when it is in the production environment, error reporting and tracing are considered to be the most valuable requirement, since it eases the process of troubleshooting and bug fixing.
There are multiple repositories where you can log, event log, database, file, etc.
In my article, I will be introducing a custom component responsible for logging into a file.

Background

Before starting with this article, you should be familiar with the .NET Framework, C# and IO processing in C#.

Using the Code

In this article, you will find three main classes:

  1. FileTracer
  2. FileTracerHelper
  3. TraceEnterExit

FileTracer is where the actual logging takes place. The class is responsible for creating the logging directory if it does not exist. The class logs into the log file according to the trace level supplied, and keeps track to the file size. If it exceeds the maximum file size, it will archive the file and create a new one.

FileTracerHelper can be described as the Facade for the client, which will expose all tracer functionality.

TraceEnterExit is a disposable class responsible for reporting entering and exiting functions.
Logging Format will be ([|] Thread | Date Time | Level | Location | Data [-]) where:

  • Thread is the execution thread
  • Date Time is execution time
  • Level is (Information, Warning or error)
  • Location is function name
  • Data is user logged data

FileTracerHelper

public static void Information(string location, string message)
{
   FileTracer.Write(TraceLevel.Info, location, message);
}

Like the above, there is a public function for logging warnings and errors, and can be used as follows:

private void CalculateNumbers()
{
using (TraceEnterExit tee = new TraceEnterExit("CalculateNumbers"))
{
  try
   {
      int counter = 0;
      int userCounter = Convert.ToInt32(txtSucessfullLogging.Text);
      for (int i = 0; i < 5; i++)
      {
         FileTracerHelper.Information
	    ( "CalculateNumbers", "Counter after processing = " + counter.ToString());
         counter++;
      }
    }
    catch(Exception ex)
    {
      FileTracerHelper.Error(ex);
    }
}

Using the TraceEnterExit, you will keep track of whether the function was called and finished or not, logging information if needed and logging errors for troubleshooting.

Points of Interest

You can change the logging format by changing in the FileTracer class -> Write function by redefining the string builder.

History

  • v1.0

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Wael Al Wirr
Program Manager INVESTBANK
Jordan Jordan
Wael Al Wirr’s Specialties:
•Microsoft BizTalk Server 2004, 2006, 2010
•ASP.Net, C#, ADO.Net and .Net Framework (1.1, 2.0, 3.0, 3.5, 4.0)
•Windows Communication Foundation
•Windows Workflow Foundation
•Windows AppFabric
•ADO.NET Entity Framework
•Microsoft Line Of Business Adapter Framework
•SQL Server 2000, 2005
•Web development
•HTML, XML, XSD, XSLT
•JavaScript
•Database design
•Web Services
•Build, deployment script
•Microsoft Source Safe, Microsoft Team Foundation Server
Follow on   Twitter

Comments and Discussions

 
Generalanother logger PinmemberDonsw13-Jun-09 8:02 
GeneralRe: another logger PinmemberWael Al Wirr13-Jun-09 19:42 
QuestionWhy another logger? PinmemberRobert Taylor19-May-09 22:27 
AnswerRe: Why another logger? PinmemberWael Al Wirr19-May-09 23:43 
GeneralRe: Why another logger? PinmemberRobert Taylor20-May-09 2:00 
GeneralRe: Why another logger? PinmemberWael Al Wirr20-May-09 2:21 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.141022.1 | Last Updated 20 May 2009
Article Copyright 2009 by Wael Al Wirr
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid