DiagnosticMonitorTraceListener Class

Article
08/18/2015

Represents the trace listener used for basic Azure logs.

Namespace: Microsoft.WindowsAzure.Diagnostics
Assembly: Microsoft.WindowsAzure.Diagnostics (in Microsoft.WindowsAzure.Diagnostics.dll)

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.Diagnostics.TraceListener
      Microsoft.WindowsAzure.Diagnostics.DiagnosticMonitorTraceListener

Syntax

public class DiagnosticMonitorTraceListener : TraceListener

public ref class DiagnosticMonitorTraceListener : TraceListener

type DiagnosticMonitorTraceListener = 
    class
        inherit TraceListener
    end

Public Class DiagnosticMonitorTraceListener
    Inherits TraceListener

Constructors

	Name	Description
	DiagnosticMonitorTraceListener()	Constructor for the DiagnosticMonitorTraceListener class.

Properties

	Name	Description
	Attributes	(Inherited from TraceListener.)
	Filter	(Inherited from TraceListener.)
	IndentLevel	(Inherited from TraceListener.)
	IndentSize	(Inherited from TraceListener.)
	IsThreadSafe	Indicates whether the diagnostic monitor trace listener is thread-safe.(Overrides TraceListener.IsThreadSafe.)
	Name	(Inherited from TraceListener.)
	NeedIndent	(Inherited from TraceListener.)
	TraceOutputOptions	(Inherited from TraceListener.)

Methods

	Name	Description
	Close()	(Inherited from TraceListener.)
	CreateObjRef(Type)	(Inherited from MarshalByRefObject.)
	Dispose()	(Inherited from TraceListener.)
	Dispose(Boolean)	Releases the unmanaged resources used by the TraceListener and optionally releases the managed resources.(Overrides TraceListener.Dispose(Boolean).)
	Equals(Object)	(Inherited from Object.)
	Fail(String)	(Inherited from TraceListener.)
	Fail(String, String)	(Inherited from TraceListener.)
	Finalize()	(Inherited from Object.)
	Flush()	(Inherited from TraceListener.)
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetSupportedAttributes()	(Inherited from TraceListener.)
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	ToString()	(Inherited from Object.)
	TraceData(TraceEventCache, String, TraceEventType, Int32, Object)	Writes trace information, a data object and event information to the listener-specific output.(Overrides TraceListener.TraceData(TraceEventCache, String, TraceEventType, Int32, Object).)
	TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])	Writes trace information, an array of data objects and event information to the listener-specific output.(Overrides TraceListener.TraceData(TraceEventCache, String, TraceEventType, Int32, Object[]).)
	TraceEvent(TraceEventCache, String, TraceEventType, Int32)	Writes trace and event information to the listener-specific output.(Overrides TraceListener.TraceEvent(TraceEventCache, String, TraceEventType, Int32).)
	TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)	Writes trace information, a message, and event information to the listener-specific output.(Overrides TraceListener.TraceEvent(TraceEventCache, String, TraceEventType, Int32, String).)
	TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])	Writes trace information, a formatted array of objects and event information to the listener-specific output.(Overrides TraceListener.TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[]).)
	TraceTransfer(TraceEventCache, String, Int32, String, Guid)	(Inherited from TraceListener.)
	Write(Object)	(Inherited from TraceListener.)
	Write(Object, String)	(Inherited from TraceListener.)
	Write(String)	When overridden in a derived class, writes the specified message to the listener you create in the derived class.(Overrides TraceListener.Write(String).)
	Write(String, String)	(Inherited from TraceListener.)
	WriteIndent()	(Inherited from TraceListener.)
	WriteLine(Object)	(Inherited from TraceListener.)
	WriteLine(Object, String)	(Inherited from TraceListener.)
	WriteLine(String)	When overridden in a derived class, writes a message to the listener you create in the derived class, followed by a line terminator.(Overrides TraceListener.WriteLine(String).)
	WriteLine(String, String)	(Inherited from TraceListener.)

Remarks

The DiagnosticMonitorTraceListener class is used to log trace data for hosted services. All tracing data is stored as a part of Azure logs, and does not transfer to persistent storage by default. To enable transfers to persistent storage, you must configure the Logs property and set your desired options for scheduled transfers. Additionally, you must have a storage account configured in the ServiceConfiguration.cscfg file. Transferred trace data is located in the WADLogsTable of the storage account.

There are two ways to enable tracing for your web or worker role: modifying app.config or web.config, or programmatically calling the System.Diagnostics.Trace.Listeners.Add method.

To enable tracing using web.config or app.config

Add the following code to the web.config or app.config configuration file:

<system.diagnostics>
   <trace>
      <listeners>
         <add type="Microsoft.WindowsAzure.Diagnostics.DiagnosticMonitorTraceListener, 
            Microsoft.WindowsAzure.Diagnostics, 
            Version=1.0.0.0, 
            Culture=neutral, 
            PublicKeyToken=31bf3856ad364e35"
            name="AzureDiagnostics">
            <filter type="" />
         </add>
      </listeners>
   </trace>
</system.diagnostics>

To enable tracing programmatically

Add the following line of code:

System.Diagnostics.Trace.Listeners.Add(new Microsoft.WindowsAzure.Diagnostics.DiagnosticMonitorTraceListener());

Warning

This API is not supported in Azure SDK versions 2.5 and higher. Instead, use the diagnostics.wadcfg XML configuration file. For more information, see Collect Logging Data by Using Azure Diagnostics.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.