Click here to Skip to main content
14,641,662 members
Articles » Platforms, Frameworks & Libraries » Windows Communication Foundation » Utilities
Article
Posted 13 Nov 2008

Stats

102K views
3.9K downloads
24 bookmarked

A Rolling XmlWriterTraceListener

Rate this:
4.30 (14 votes)
Please Sign up or sign in to vote.
4.30 (14 votes)
15 Nov 2008LGPL3
A derivation of XmlWriterTraceListener that manages the size of your trace files automatically

Introduction

Ever had the problem of growing svclog files after configuring tracing in a productive WCF environment? Did not want to restart the application just for deleting or moving the trace files?

Then, you will like the RollingXmlWriterTraceListener, which is a specialized XmlWriterTraceListener, and is completely compatible with the WCF tracing facility.

Background

When tracing is enabled in a WCF application, and the default XmlWriterTraceListener is used (the listener that produces Microsoft's XML trace format, which is understood by svctraceviewer.exe), it won't allow you to delete a trace file while the application is running. And so it may happen that you see your productive server filling up its hard drive, and you are not allowed to stop it. You can spend your time in calculating when the whole system will be hanging. (Don't ask, our customer did not agree to a short downtime... even under such circumstances.)

That's why I wrote this derivate: it will start a new trace file (with a numeric, four character suffix) after a specified file size is reached.

Using the Code

Using the special trace listener is quite easy. Put the class into one of your basic libraries, adjust the namespace, and then use it instead of the default XmlWriterTraceListener in the app.config file:

<?xml version="1.0"?>
<configuration>
    <system.diagnostics>

        <sources>
            <source name="System.ServiceModel" switchValue="All">
                <listeners>
                    <add name="System.ServiceModel.XmlTrace.Listener" />
                </listeners>
            </source>

            <source name="System.Runtime.Serialization" switchValue="All">
                <listeners>
                    <add name="System.Runtime.Serialization.XmlTrace.Listener" />
                </listeners>
            </source>
        </sources>

        <sharedListeners>
            <add

                type="MarcW.Tools.Diagnostics.RollingXmlWriterTraceListener, MarcW.Tools"

                name="System.ServiceModel.XmlTrace.Listener"

                traceOutputOptions="None"

                initializeData=".Logs\System.ServiceModel.svclog"

                MaxTraceFileSize="134217728" />
            <add

                type="MarcW.Tools.Diagnostics.RollingXmlWriterTraceListener, MarcW.Tools"

                name="System.Runtime.Serialization.XmlTrace.Listener"

                traceOutputOptions="None"

                initializeData=".Logs\System.Runtime.Serialization.svclog"

                MaxTraceFileSize="134217728" />
        </sharedListeners>

    </system.diagnostics>
</configuration>

Make sure you choose the correct type and specify the assembly in which the tracer can find the type. In addition, you need to set the maximum size of a trace file before a new one is started, with the MaxTraceFileSize attribute. This is optional, the default value is 128 MB.

History

  • 2008-11-13
    • First issue
  • 2008-11-14
    • Updated the source code to conform to StyleCop and completed the XMLDoc in some places
    • No functional changes applied

License

This article, along with any associated source code and files, is licensed under The GNU Lesser General Public License (LGPLv3)

Share

About the Author

marc_anic
Software Developer OPUS GmbH
Germany Germany
C# Developer for KLUSA

Comments and Discussions

 
QuestionmaxMessagesToLog stops logging Pin
Alexandros Pappas12-Jun-19 22:48
professionalAlexandros Pappas12-Jun-19 22:48 
QuestionNuGet Package Pin
divyesh143223-Oct-18 16:20
Memberdivyesh143223-Oct-18 16:20 
QuestionRollingXmlWriterTraceListener in another dll outside the project causing windows service to crash Pin
Tom Hanson12-Nov-17 18:15
MemberTom Hanson12-Nov-17 18:15 
AnswerRe: RollingXmlWriterTraceListener in another dll outside the project causing windows service to crash Pin
Member 1188808924-Jul-20 5:47
MemberMember 1188808924-Jul-20 5:47 
QuestionAdded System.ServiceModel.MessageLogging Pin
Member 1107155716-Nov-14 23:30
MemberMember 1107155716-Nov-14 23:30 
AnswerRe: Added System.ServiceModel.MessageLogging Pin
Member 1107155717-Nov-14 1:10
MemberMember 1107155717-Nov-14 1:10 
QuestionUpdated Version? Pin
rleonard5525-Sep-14 3:18
Memberrleonard5525-Sep-14 3:18 
AnswerRe: Updated Version? Pin
Member 1107155713-Nov-14 1:17
MemberMember 1107155713-Nov-14 1:17 
QuestionFlush doesn't flush data imediatly to file Pin
ToolMaker200719-Sep-13 4:17
MemberToolMaker200719-Sep-13 4:17 
QuestionFails if directory does not exist Pin
DarkWalkerRzn29-Apr-13 22:47
MemberDarkWalkerRzn29-Apr-13 22:47 
QuestionProduction environment Pin
Member 99630573-Apr-13 7:55
MemberMember 99630573-Apr-13 7:55 
AnswerRe: Production environment Pin
Johnson.Net15-Nov-13 1:19
MemberJohnson.Net15-Nov-13 1:19 
QuestionAttributes are empty Pin
User 269896713-Nov-12 19:52
MemberUser 269896713-Nov-12 19:52 
BugRe: Attributes are empty Pin
Member 854221628-Jan-13 0:44
MemberMember 854221628-Jan-13 0:44 
GeneralRe: Attributes are empty Pin
Johnson.Net15-Nov-13 1:11
MemberJohnson.Net15-Nov-13 1:11 
QuestionLog is getting cleared everytime the service gets cycled. Pin
Archie collins10-Jul-12 9:02
MemberArchie collins10-Jul-12 9:02 
SuggestionFix for improper termination of XML tags in trace files Pin
Ullas Chacko Antony8-Jul-12 15:19
MemberUllas Chacko Antony8-Jul-12 15:19 
GeneralRe: Fix for improper termination of XML tags in trace files Pin
Member 1250607117-Aug-16 0:11
MemberMember 1250607117-Aug-16 0:11 
QuestionNot working :( Pin
appxdev3-Jul-12 20:56
Memberappxdev3-Jul-12 20:56 
AnswerRe: Not working :( Pin
marc_anic3-Jul-12 21:06
Membermarc_anic3-Jul-12 21:06 
GeneralRe: Not working :( Pin
appxdev6-Jul-12 0:05
Memberappxdev6-Jul-12 0:05 
GeneralRe: Not working :( Pin
oren.shnitzer9-Oct-12 21:59
Memberoren.shnitzer9-Oct-12 21:59 
GeneralMy vote of 5 Pin
Geekian_senate3-Oct-11 4:17
MemberGeekian_senate3-Oct-11 4:17 
QuestionWhy the second constructor does not set the current prefix? Pin
PhilGood19-Jul-11 4:37
MemberPhilGood19-Jul-11 4:37 
AnswerRe: Why the second constructor does not set the current prefix? Pin
pkkalra197830-Jan-12 15:08
Memberpkkalra197830-Jan-12 15:08 

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.