Click here to Skip to main content
15,867,453 members
Articles / Desktop Programming / MFC
Article

LogXML - A XML Logging Class

Rate me:
Please Sign up or sign in to vote.
4.50/5 (13 votes)
11 May 20031 min read 93.5K   3K   39   16
A simple XML style logging class for all purposes.

Introduction

Almost everybody needs sometimes something like a logging class. Me too. That is why I wrote such a class to do my logging although there are already some very convenient logging classes like CProtocol by jazper. But I thought of some general approach: Logging with XML.

Possibilities

The probably most interesting point is the possibility to log into a structure. Now you can log in a fairly natural way: simply go down one level if you call a function and after that go up and you will get a log structure that resembles your program's calling tree. All log entries will automatically get the right place.

Usage

Using LogXML is not very difficult. First of all:

C++
#include "LogXML.h"
Now you can instantiate LogXML by:

C++
LogXML* log = new LogXML("LogFileName.xml", "ApplicationName");
There are several ways to write a Log Entry, some kind of Log Record can be written by:

C++
log->Log("Error: Something is not correct. Please Fix.", // Entry
         __FILE__,               // Filename of Source File<
         "myLoggingFunction()"); // Function Name
Or you can write only one line by:

C++
log->WriteLine("TagName", "This is your Log Entry");

The output (log file) of these examples is:

XML
<?xml-stylesheet href="Log.xsl" type="text/xsl" ?>
<LogFile>
    <AppName>ApplicationName</AppName>
    <Timestamp>1052656519.488</Timestamp>
    <Date>2003-05-11</Date>
    <Time>14:35:19.488</Time>
    <LogItem>
        <Date>2003-05-11</Date>
        <Time>14:35:19.488</Time>
        <Filename>LogXML.cpp</Filename>
        <Entry>Log File opened</Entry>
    </LogItem>
    <LogItem>
        <Date>2003-05-11</Date>
        <Time>14:35:19.488</Time>
        <Filename>C:\Code\LogXML\SampleSourceFile.h</Filename>
        <Function>SampleFunction()</Function>
        <Entry>Error: Something is not correct. Please Fix.</Entry>
    </LogItem>
    <TagName>This is your Log Entry</TagName>
    <LogItem>
        <Date>2003-05-11</Date>
        <Time>14:35:19.488</Time>
        <Filename>LogXML.cpp</Filename>
        <Entry>Log File closed</Entry>
    </LogItem> 
</LogFile>

Annotations

To use such a log file you can use a XML parser like XPath or everything else you want. To convert a file produced by LogXML to something human-readable you can use for example XSL. Since my knowledge of XSL is not the best, I only managed to write a file named Log.XSL that shows Log Records of Level 1, i.e. do not use LogXML::goDown() and use only LogXML::Log() to write entries if you want to use it. And this is our sample Log File shown by Internet Explorer (6.0):

Image 1

History

  • May 12, 2003 - First Release 1.0.0
     

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Web Developer
United Kingdom United Kingdom
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
SuggestionIs it there ? Pin
AmitGajjar15-Sep-12 0:09
professionalAmitGajjar15-Sep-12 0:09 
GeneralMy opinion Pin
ComaWhite8615-Nov-08 21:54
ComaWhite8615-Nov-08 21:54 
GeneralGood idea - wrong tool Pin
Dimka912-May-03 10:15
Dimka912-May-03 10:15 
GeneralRe: Good idea - wrong tool Pin
sirrube12-May-03 14:04
sirrube12-May-03 14:04 
GeneralRe: Good idea - wrong tool Pin
whizer13-May-03 6:50
whizer13-May-03 6:50 
GeneralRe: Good idea - wrong tool Pin
whizer13-May-03 6:44
whizer13-May-03 6:44 
GeneralRe: Good idea - wrong tool Pin
Anonymous20-May-03 23:51
Anonymous20-May-03 23:51 
GeneralRe: Good idea - wrong tool Pin
whizer21-May-03 3:47
whizer21-May-03 3:47 
GeneralRe: Good idea - wrong tool Pin
Hugo Hallman6-Sep-04 2:05
Hugo Hallman6-Sep-04 2:05 
GeneralRe: Good idea - wrong tool Pin
tom.schultz4-Oct-04 23:53
tom.schultz4-Oct-04 23:53 
GeneralRe: Good idea - wrong tool Pin
Andrea8617-Jan-07 0:23
Andrea8617-Jan-07 0:23 
GeneralRe: Good idea - wrong tool Pin
S.C.Wong30-Mar-08 0:41
S.C.Wong30-Mar-08 0:41 
AnswerRe: Good idea - wrong tool Pin
Dimitris Servis30-Jul-08 1:35
Dimitris Servis30-Jul-08 1:35 
Questionquestion: the error can be catched? Pin
liuty200612-May-03 9:17
liuty200612-May-03 9:17 
AnswerRe: question: the error can be catched? Pin
whizer13-May-03 6:41
whizer13-May-03 6:41 
GeneralPlease comment if you vote Pin
whizer12-May-03 5:43
whizer12-May-03 5:43 
Please comment if you vote and write any suggestions you might have to improve LogXML. It is very important for me.

Thank you for reading my article. Smile | :)

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

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