DiagnosticMonitorConfiguration.WindowsEventLog Property

 

Gets or sets the buffer configuration for Windows event logs.

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

Syntax

public WindowsEventLogsBufferConfiguration WindowsEventLog { get; set; }

public:
property WindowsEventLogsBufferConfiguration^ WindowsEventLog {
    WindowsEventLogsBufferConfiguration^ get();
    void set(WindowsEventLogsBufferConfiguration^ value);
}

member WindowsEventLog : WindowsEventLogsBufferConfiguration with get, set

Public Property WindowsEventLog As WindowsEventLogsBufferConfiguration

Property Value

Type: Microsoft.WindowsAzure.Diagnostics.WindowsEventLogsBufferConfiguration

Type: Microsoft.WindowsAzure.Diagnostics.WindowsEventLogsBufferConfiguration

Returns WindowsEventLogsBufferConfiguration.

Remarks

The diagnostics.wadcfg file is used to configure diagnostics in your application. For more information on how to configure your diagnostics.wadcfg file, see Enabling Diagnostics in Windows Azure. Once your application is running in Windows Azure, you can use the DiagnosticMonitorConfiguration class along with the RoleInstanceDiagnosticManager class to remotely change your application’s diagnostics configuration.

The WindowsEventLog property is used to specify the WindowsEventLogsBufferConfiguration data buffer that is used for logging Windows events. This property enables you to add event log sources to the DataSources collection for each event type you want to capture. You can also specify the ScheduledTransferLogLevelFilter LogLevel enumeration for setting the severity level of each log to transfer to persistent storage, and the default data buffer properties: DiagnosticDataBufferConfiguration and ScheduledTransferPeriod.

Example

The following code snippet gets the diagnostic monitor configuration for each instance in a role, specifies the configuration for Windows events, then sets the new configuration.

// Get the connection string. It's recommended that you store the connection string in your web.config or app.config file.
// Use the ConfigurationManager type to retrieve your storage connection string.  You can find the account name and key in
// the Windows Azure Management Portal (https://manage.windowsazure.com).
//string connectionString = "DefaultEndpointsProtocol=https;AccountName=<AccountName>;AccountKey=<AccountKey>";
string connectionString = System.Configuration.ConfigurationManager.ConnectionStrings["StorageConnectionString"].ConnectionString;

// The deployment ID and role name for your application can be obtained from the 
// Windows Azure Management Portal (https://manage.windowsazure.com). See your 
// application dashboard under Cloud Services.
string deploymentID = "e2ab8b6667644666ba627bdf6f5e4daa";
string roleName = "WebRole1";

// Get the DeploymentDiagnosticManager object for your deployment.
DeploymentDiagnosticManager diagManager = new DeploymentDiagnosticManager(connectionString, deploymentID);

// Get the RoleInstanceDiagnosticManager objects for each instance of your role.
IEnumerable<RoleInstanceDiagnosticManager> instanceManagers = diagManager.GetRoleInstanceDiagnosticManagersForRole(roleName);

// Iterate through the role instances and update the configuration.
foreach (RoleInstanceDiagnosticManager roleInstance in instanceManagers)
{
   DiagnosticMonitorConfiguration diagnosticConfiguration = roleInstance.GetCurrentConfiguration();

   // Add Application logs to the configuration.
   diagnosticConfiguration.WindowsEventLog.DataSources.Add("Application!*");

   // Filter the logs so that only error-level logs are transferred to persistent storage.
   diagnosticConfiguration.WindowsEventLog.ScheduledTransferLogLevelFilter = LogLevel.Error;

   // Schedule a transfer period of 30 minutes.
   diagnosticConfiguration.WindowsEventLog.ScheduledTransferPeriod = TimeSpan.FromMinutes(30.0);

   // Set the configuration.
   roleInstance.SetCurrentConfiguration(diagnosticConfiguration);
}

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.

See Also

DiagnosticMonitorConfiguration Class
Microsoft.WindowsAzure.Diagnostics Namespace

Return to top