Home > Articles > Programming > Windows Programming

  • Print
  • + Share This
This chapter is from the book

Trace Listeners

Trace listeners are thread-safe classes that derive from an abstract class called, appropriately enough, System.Diagnostics.TraceListener. This class contains the necessary methods to be able to control trace output. There are three out-of-the-box trace listeners included with .NET. The first is called DefaultTraceListener and, by default, is automatically added to a trace listener collection shared by the application. Using the Trace.Listeners static property, you can access this collection at any time during execution. Using the collection, you can then add or remove any trace listener. Controlling the listeners in the collection will, therefore, control your trace output. When Trace.Write or Trace.WriteLine is called, these methods will emit the message to whatever trace listeners have been added to the system. The DefaultTraceListener will receive these calls and send the output to the its designated target. For the DefaultTraceListener, that target is both the OutputDebugString API and the .NET log method. You should already be familiar with the OutputDebugString API; if not, please reference the Platform SDK documentation. The log method will post the message to any attached debugger in .NET.

The second trace listener is called EventLogTraceListener. This listeners send all output to the Windows event log. Using its EventLog property, you can control which event log receives the output. The third out-of-the-box listener is called TextWriterListener. This sends all output to any TextWriter or Stream object. This can be the console's standard output stream or any file.

To add or remove a listener to or from the collection, you can either use a configuration file, such as web.config, or do it in code. The following is an example of adding or removing a listener using a configuration file:

Listing 2.11 Adding a listener using web.config.

<configuration>
  <system.diagnostics>
    . . .
    <trace autoflush="true" indentsize="4">
      <listeners>
        <add name="LogFileListener"
   type="System.Diagnostics.TextWriterTraceListener,System"
          initializeData="c:\LogFileListener.log" />
          <remove
    type="System.Diagnostics.DefaultTraceListener,System"/>
      </listeners>
    </trace>
  </system.diagnostics>
</configuration>

You can also control the listener collection in code such as the following InitTraceListeners method I use in the upcoming implementation pattern.

IMPORTANT

In the following method, I show how you can add an event log listener to the collection. However, I do not recommend you use the event log during most tracing scenarios. I typically use the event log only during error handling or more determined forms of tracing, such as message coming from Windows Services (e.g., “service starting…”, “service stopping…”, etc.). Otherwise, you will quickly fill it up if you're not careful.

Listing 2.12 Sample for adding an event log listener to a global collection.

/// <summary>
/// Adds all default trace listeners, for event log
/// tracing it first checks
/// to see if the trace level has not been set to verbose or
/// information since we
/// don't want to fill up the event viewer with verbose
/// information.
/// </summary>
public static void InitTraceListeners()
{
      FileStream oTextWriter = null;

      // We do not want to dump to the if tracing is set to
      // information or verbose
      if (!Config.TraceLevel.TraceInfo)
      {
            if (Trace.Listeners[TRACE_EVENTLOG_KEY] == null)
            {
                  EventLogTraceListener oEvtLogListener = new
                    EventLogTraceListener(EVENTLOG_SOURCE);
                  oEvtLogListener.Name = TRACE_EVENTLOG_KEY;
                  Trace.Listeners.Add(oEvtLogListener);
            }
      }
      else // travel level is set to warning or error
      {
            if (Trace.Listeners[TRACE_EVENTLOG_KEY] != null)
                  Trace Listeners.Remove(TRACE_EVENTLOG_KEY);
      }
      if (Trace.Listeners[TRACE_TEXTWRITER_KEY] == null)
      {
            oTextWriter = File.Exists(TRACE_LOG_FILE)) ?
                          File.OpenWrite(TRACE_LOG_FILE) :
                          File.Create(TRACE_LOG_FILE);
            Trace.Listeners.Add(new
                    TextWriterTraceListener(oTextWriter,
                              TRACE_TEXTWRITER_KEY));
      }

      // This is a custom trace listener (see PMRemoteTrace.cs)
      // for remote tracing
      if (Trace.Listeners[TRACE_REMOTE_KEY] == null)
            Trace.Listeners.Add(new
                        RemoteTrace(TRACE_REMOTE_KEY));
}

First, notice that the listener collection is manipulated like any other collection in .NET. Using .NET indexers, I can check to see whether the listener has already been added to the collection. If you look carefully at the InitTraceListeners example, you'll notice a new listener class called RemoteTrace. This is referred to as a custom trace listener and is the focus of the following implementation pattern.

By adding trace listeners to a central collection, you can globally control how and where tracing output is sent. As a developer of the rest of the system, you are required to add Trace.Write or WriteLine methods only to send the appropriate information to that output for any debug or release build. This is a powerful monitoring and logging feature but how do we elegantly control whether we want to trace at all? For that matter, how to we control at what level we would like to trace? We may simply want to trace errors or we may want to provide as much information during runtime execution as possible to help determine our problems. This is where .NET switches come into play.

Boolean and Trace Switches

The first way to turn off any tracing is by disabling the /d:TRACE option, as mentioned above. However, doing so requires the recompilation of your code for it to become effective. What if you are in production and you do not have that option? Fortunately, you can easily control tracing dynamically and without recompilation. To do so, you use what are called System.Diagnostics.Switch objects. The switch objects available in the FCL are BooleanSwitch and TraceSwitch. Both derive from System.Diagnostics.Switch. All switches are configuration objects, of sorts, that read a configuration setting and provide properties with which you can check dynamically to determine whether an option has been enabled and what level. The BooleanSwitch is the simpler of the two and is set to off by default. To turn it on, you edit your application's <xxx>.config file as follows:

<system.diagnostics>
      <switches>
            <add name="MyBooleanSwitch" value="1" />
      </switches>
</system.diagnostics>

The .config file can be your web.config file if your application is a Web service, for example. With this set, you now create the BooleanSwitch object. This can be stored in a static variable and be accessible by any code wishing to use the switch. This BooleanSwitch data member is part of a configuration object used throughout the system to retrieve any application configuration information.

public static BooleanSwitch MyBooleanSwitch = new
TraceSwitch("MyBooleanSwitch",
"This is my boolean switch");

The first parameter of the BooleanSwitch is the name of the switch. This must match the name used in your configuration setting. Setting this to 1 turns on the switch; conversely, setting this to zero turns it off. Once the switch is created, the BooleanSwitch can be used to help determined things such as tracing. Instead of calling Trace.Write or Trace.WriteLine, you now call Trace.WriteLineIf. The first parameter of this method is a Boolean that when set to true will cause tracing to occur. Instead of simply passing true or false directly, you use the BooleanSwitch, as follows:

Trace.WriteLineIf(MyBooleanSwitch.Enabled, "message to trace");

During execution, the code will use the BooleanSwitch to dynamically check the configuration setting. If the setting is set to 1, the BooleanSwitch returns true, and the trace occurs. No longer do you need to recompile your code.

A TraceSwitch works in the same fashion except you also get to control the level at which tracing should be enabled. To set a TraceSwitch in the configuration file, you must specify the name of the switch (same as before) and the level at which to enable tracing. A TraceSwitch has four properties: TraceError, TraceWarning, TraceInfo, and TraceVerbose. Its configuration-level settings are:

0 (off), 1 (error), 2 (warning), 3 (info), OR 4 (verbose)

For example, to create a TraceSwitch to control all system tracing, use the following:

public static TraceSwitch TraceLevel = new
TraceSwitch("TraceLevel", "Tracing Level");

To configure this TraceSwitch to verbose, you would use the following:

<system.diagnostics>
   <switches>
   <add name="TraceLevel" value="4" />
   </switches>
   </system.diagnostics>
   

To trace a message (only if verbose has been set), you would use the following:

Trace.WriteLineIf(TraceLevel.TraceVerbose, "some message");

This line will send a trace message only if the verbose level has been set in the configuration file. In fact, using any other trace level in the WriteIf call would trace the message because setting the configuration to verbose will send all traces. Setting this to verbose causes the TraceSwitch trace level to return true for TraceInfo, TraceWarning, or TraceError. If the configuration setting was 3 (TraceInfo), then all trace levels except TraceVerbose would return true and, thus, the trace would be sent. In this case, TraceInfo, TraceWarning, and TraceError would return true but TraceVerbose would return false. I will discuss the use of tracing, custom trace listeners, and trace switches in the following section.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020