Configuring Trace Listeners

  • Article

Trace listeners receive log entries and write them to the appropriate destinations. The following procedure describes how to configure the trace listeners supplied with Enterprise Library and custom trace listeners that you create. There is also a specific procedure for configuring the two trace listeners that are required for integration with WCF. For more details of this procedure, see Configuring WCF Integration Trace Listeners.

Note

Trace listener logs have vulnerabilities and should be protected as appropriate, depending on whether the trace listener writes log entries to a file, database or MSMQ message queue.

For trace listeners that write log entries to files you should protect the logs by using access control lists. This includes Flat File, Rolling flat file, WMI and XML trace listener logs.

For trace listeners that write log entries to databases you should protect access to logs by using usernames and passwords. This includes the database trace listener.

For trace listeners that write log entries to MSMQ message queues you should allow only authorized users to read information from MSMQ. Protect the queue with relevant access control lists and follow any security considerations specific to MSMQ. This includes the message queuing trace listener.

Configuring the Built-in Trace Listeners

To configure trace listeners included with Enterprise Library

  1. Add a trace listener as described in Configuration Overview.

  2. Click the property expander arrow in the trace listener****item you want to configure. Each trace listener has an associated set of properties. For information about these properties, see the tables in the topic Trace Listener Properties.

    Note

    If you are going to use the MSMQ distributor service, you must select the Message Queuing Trace Listener when adding a trace listener. For information about how to use the distributor service, see Using the Distributor Service.

  3. Set the Formatter Name property by clicking the formatter you want to use (if any) in the drop-down list. If you are configuring the message queuing trace listener to use it with the Message Queuing distributor service, you must select the Binary Log Message Formatter.

  4. If necessary, change the values of other properties. To do this, either type a new value or select an option in the drop-down list.

  5. Repeat the procedure for each trace listener you add.

Note

When you add a System Diagnostics Trace Listener and set the Type Name attribute, the type selector displays trace listener types that derive from the System.Diagnostics.TraceListener class. This means that the type selector displays the trace listener types that are a part of the EnterpriseLibrary.Logging.TraceListeners assembly as well as the trace listener types that are a part of the System.Diagnostics assembly. Only select types that belong to the System.Diagnostics assembly. You can use the Enterprise Library trace listeners that require either no parameters or one parameter. These trace listeners are the Event Log Trace Listener, the Flat File Trace Listener, and the WMI Trace Listener.

Configuring Custom Trace Listeners

To configure a custom trace listener

  1. Select Add Custom Trace Listener as described in Configuration Overview.

    Note

    The type selector will be empty and display no assemblies if no custom trace listeners are available. The CustomTraceListenerData attribute is required for custom trace listeners.

  2. Click the property expander arrow for the trace listener item to display its properties pane.

  3. Property values for custom listeners are configured as key/value pairs. To set these values, type the key and the value in the Attributes row of the property pane. As you add a key/value pair, a new empty row appears automatically. Click the cross icon next to a key/value pair to delete it.

  4. (Optional) Change the Name property. The default name is Custom Trace Listener.