SALES: 1-800-867-1380

DiagnosticMonitor Class

Updated: December 6, 2013

Represents the diagnostic monitor for a role instance in Windows Azure.

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

public class DiagnosticMonitor

The DiagnosticMonitor class provides methods and properties that enable collection of diagnostic data for a role instance in Windows Azure. DiagnosticMonitor is a singleton, so each role instance has only one instantiated DiagnosticMonitor.

The default configuration of DiagnosticMonitor collects Windows Azure logs and Windows Azure Diagnostic Infrastructure logs for web and worker roles. The default configuration will also collect IIS logs for web roles only. These settings are included in the DiagnosticMonitorConfiguration object returned by the GetDefaultInitialConfiguration method. You can configure additional logging options by creating a DiagnosticMonitorConfiguration object, specifying the diagnostics data you want by setting the properties of that object, and passing the object as a parameter to the Start(String,DiagnosticMonitorConfiguration) method.

You can specify a Windows Azure Storage account for the DiagnosticMonitor by including a connection string as an input parameter when calling the Start(String) or StartWithConnectionString method.

If you call the Start(String) method using a misconfigured connection string, the DiagnosticMonitor will not start with your role instance.

To use DiagnosticMonitor, you must perform the following steps:

  1. Import the Diagnostics module into your application by modifying the ServiceDefinition.csdef file to include the following lines:

        <Import moduleName=”Diagnostics” />
  2. Specify a storage location where the diagnostics data will be transferred, either a Windows Azure storage account or the local storage emulator. For example, modify your ServiceConfiguration.cscfg file to include the following lines if you want to store diagnostics data in the storage emulator:

         <Setting name="Microsoft.WindowsAzure.Plugins.Diagnostics.ConnectionString" value="UseDevelopmentStorage=true" />
  3. Make sure that your project includes a reference to Microsoft.WindowsAzure.Diagnostics.dll, and optionally includes a using Microsoft.WindowsAzure.Diagnostics; directive in each code file that uses the DiagnosticMonitor.

After the DiagnosticMonitor has been configured, if you want to start collecting the default logs, you do not need to call the Start(String) method. Roles that have imported the Diagnostics module, specified a data storage location, and referenced the .dll will automatically start the DiagnosticMonitor using the default configuration when the role initializes.

However, if you want to specify a custom logging configuration, you must call the Start method and supply the storage account and your custom DiagnosticMonitorConfiguration object as parameters to the method. This call is shown in the following example where dmConfig is a custom DiagnosticMonitorConfiguration object:

DiagnosticMonitor.Start(“Microsoft.WindowsAzure.Plugins.Diagnostics.ConnectionString”, dmConfig)


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

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft