Export (0) Print
Expand All

Azure Diagnostics 1.0 Configuration Schema

Updated: November 13, 2013

The Azure Diagnostics configuration file defines values that are used to initialize the Diagnostics Monitor. This file is used to initialize diagnostic configuration settings when the diagnostics monitor starts.

By default, the Azure Diagnostics configuration schema file is installed to the C:\Program Files\Microsoft SDKs\Azure\.NET SDK\<version>\schemas directory. Replace <version> with the installed version of the Azure SDK.

noteNote
The diagnostics configuration file is typically used with startup tasks that require diagnostic data to be collected earlier in the startup process. For more information about using Azure Diagnostics, see Collect Logging Data by Using Azure Diagnostics.

The following example shows a typical diagnostics configuration file:


<DiagnosticMonitorConfiguration xmlns="http://schemas.microsoft.com/ServiceHosting/2010/10/DiagnosticsConfiguration"
      configurationChangePollInterval="PT1M"
      overallQuotaInMB="4096">
   <DiagnosticInfrastructureLogs bufferQuotaInMB="1024"
      scheduledTransferLogLevelFilter="Verbose"
      scheduledTransferPeriod="PT1M" />
   <Logs bufferQuotaInMB="1024"
      scheduledTransferLogLevelFilter="Verbose"
      scheduledTransferPeriod="PT1M" />
   <Directories bufferQuotaInMB="1024" 
      scheduledTransferPeriod="PT1M">
   
      <!-- These three elements specify the special directories 
           that are set up for the log types -->
      <CrashDumps container="wad-crash-dumps" directoryQuotaInMB="256" />
      <FailedRequestLogs container="wad-frq" directoryQuotaInMB="256" />
      <IISLogs container="wad-iis" directoryQuotaInMB="256" />
      
      <!-- For regular directories the DataSources element is used -->
      <DataSources>
         <DirectoryConfiguration container="wad-panther" directoryQuotaInMB="128">
            <!-- Absolute specifies an absolute path with optional environment expansion -->
            <Absolute expandEnvironment="true" path="%SystemRoot%\system32\sysprep\Panther" />
         </DirectoryConfiguration>
         <DirectoryConfiguration container="wad-custom" directoryQuotaInMB="128">
            <!-- LocalResource specifies a path relative to a local 
                 resource defined in the service definition -->
            <LocalResource name="MyLoggingLocalResource" relativePath="logs" />
         </DirectoryConfiguration>
      </DataSources>
   </Directories>
   <PerformanceCounters bufferQuotaInMB="512" scheduledTransferPeriod="PT1M">
      <!-- The counter specifier is in the same format as the imperative 
           diagnostics configuration API -->
      <PerformanceCounterConfiguration 
         counterSpecifier="\Processor(_Total)\% Processor Time" sampleRate="PT5S" />
   </PerformanceCounters>
   <WindowsEventLog bufferQuotaInMB="512"
      scheduledTransferLogLevelFilter="Verbose"
      scheduledTransferPeriod="PT1M">
      <!-- The event log name is in the same format as the imperative 
           diagnostics configuration API -->
      <DataSource name="System!*" />
   </WindowsEventLog>
</DiagnosticMonitorConfiguration>

The XML namespace for the diagnostics configuration file is:

http://schemas.microsoft.com/ServiceHosting/2010/10/DiagnosticsConfiguration

The DiagnosticMonitorConfiguration element is the top-level element of the diagnostics configuration file.

The following table describes the attributes of the DiagnosticMonitorConfiguration element.

 

Attribute Type Description

configurationChangePollInterval

duration

Optional. Specifies the interval at which the diagnostic monitor polls for diagnostic configuration changes.

The default is PT1M.

overallQuotaInMB

unsignedInt

Optional. The total amount of file system storage allocated for all logging buffers.

The default is 4000 MB and if you provide a value for this attribute, it must not exceed this amount.

The DiagnosticInfrastructureLogs element defines the buffer configuration for the logs that are generated by the underlying diagnostics infrastructure. The parent of this element is the DiagnosticMonitorConfiguration Element.

The following table describes the attributes of the DiagnosticInfrastructureLogs element.

 

Attribute Type Description

bufferQuotaInMB

unsignedInt

Optional. Specifies the maximum amount of file system storage that is available for the specified data.

The default is 0.

scheduledTransferLogLevelFilter

string

Optional. Specifies the minimum severity level for log entries that are transferred. The default value is Undefined. Other possible values are Verbose, Information, Warning, Error, and Critical.

scheduledTransferPeriod

duration

Optional. Specifies the interval between scheduled transfers of data, rounded up to the nearest minute.

The default is PT0S.

The Logs element defines the buffer configuration for basic Azure logs. The parent of this element is the DiagnosticMonitorConfiguration Element.

The following table describes the attributes of the Logs element.

 

Attribute Type Description

bufferQuotaInMB

unsignedInt

Optional. Specifies the maximum amount of file system storage that is available for the specified data.

The default is 0.

scheduledTransferLogLevelFilter

string

Optional. Specifies the minimum severity level for log entries that are transferred. The default value is Undefined. Other possible values are Verbose, Information, Warning, Error, and Critical.

scheduledTransferPeriod

duration

Optional. Specifies the interval between scheduled transfers of data, rounded up to the nearest minute.

The default is PT0S.

The Directories element defines the buffer configuration for file-based logs that you can define. This element is the parent element of the CrashDumps Element, FailedRequestLogs Element, IISLogs Element, and DataSources Element. The parent of this element is the DiagnosticMonitorConfiguration Element.

The following table describes the attributes of the Directories element.

 

Attribute Type Description

bufferQuotaInMB

unsignedInt

Optional. Specifies the maximum amount of file system storage that is available for the specified data.

The default is 0.

scheduledTransferPeriod

duration

Optional. Specifies the interval between scheduled transfers of data, rounded up to the nearest minute.

The default is PT0S.

The CrashDumps element defines the crash dumps directory. The parent of this element is the Directories Element.

The following table describes the attributes of the CrashDumps element.

 

Attribute Type Description

container

string

The name of the container where the contents of the directory is to be transferred.

directoryQuotaInMB

unsignedInt

Optional. Specifies the maximum size of the directory in megabytes.

The default is 0.

The FailedRequestLogs element defines the failed request log directory. The parent of this element is the Directories Element.

The following table describes the attributes of the FailedRequestLogs element.

 

Attribute Type Description

container

string

The name of the container where the contents of the directory is to be transferred.

directoryQuotaInMB

unsignedInt

Optional. Specifies the maximum size of the directory in megabytes.

The default is 0.

The IISLogs element defines the IIS log directory. The parent of this element is the Directories Element.

The following table describes the attributes of the IISLogs element.

 

Attribute Type Description

container

string

The name of the container where the contents of the directory is to be transferred.

directoryQuotaInMB

unsignedInt

Optional. Specifies the maximum size of the directory in megabytes.

The default is 0.

The DataSources element defines zero or more additional log directories. The parent of this element is the Directories Element. This element is the parent element of the DirectoryConfiguration Element.

The DirectoryConfiguration element defines the directory of log files to monitor. The parent of this element is the DataSources Element. This element is the parent element of the Absolute Element and LocalResource Elementt.

The following table describes the attributes of the DirectoryConfiguration element.

 

Attribute Type Description

container

string

The name of the container where the contents of the directory is to be transferred.

directoryQuotaInMB

unsignedInt

Optional. Specifies the maximum size of the directory in megabytes.

The default is 0.

The Absolute element defines an absolute path of the directory to monitor with optional environment expansion. The parent of this element is the DirectoryConfiguration Element.

The following table describes the attributes of the Absolute element.

 

Attribute Type Description

path

string

Required. The absolute path to the directory to monitor.

expandEnvironment

boolean

Required. If set to true, environment variables in the path are expanded.

The LocalResource element defines a path relative to a local resource defined in the service definition. The parent of this element is the DirectoryConfiguration Element.

The following table describes the attributes of the LocalResource element.

 

Attribute Type Description

name

string

Required. The name of the local resource that contains the directory to monitor.

relativePath

string

Required. The path relative to the local resource to monitor.

The PerformanceCounters element defines the path to the performance counter to collect. The parent of this element is the DiagnosticMonitorConfiguration Element. This element is the parent element of the PerformanceCounterConfiguration Element.

The following table describes the attributes of the PerformanceCounters element.

 

Attribute Type Description

bufferQuotaInMB

unsignedInt

Optional. Specifies the maximum amount of file system storage that is available for the specified data.

The default is 0.

scheduledTransferPeriod

duration

Optional. Specifies the interval between scheduled transfers of data, rounded up to the nearest minute.

The default is PT0S.

The PerformanceCounterConfiguration element defines the performance counter to collect. The parent of this element is the PerformanceCounters Element.

The following table describes the attributes of the PerformanceCounterConfiguration element.

 

Attribute Type Description

counterSpecifier

string

Required. The path to the performance counter to collect.

sampleRate

duration

Required. The rate at which the performance counter should be collected.

The WindowsEventLog element defines the event logs to monitor. The parent of this element is the DiagnosticMonitorConfiguration Element. This element is the parent element of the DataSource Element.

The following table describes the attributes of the WindowsEventLog element.

 

Attribute Type Description

bufferQuotaInMB

unsignedInt

Optional. Specifies the maximum amount of file system storage that is available for the specified data.

The default is 0.

scheduledTransferLogLevelFilter

string

Optional. Specifies the minimum severity level for log entries that are transferred. The default value is Undefined. Other possible values are Verbose, Information, Warning, Error, and Critical.

scheduledTransferPeriod

duration

Optional. Specifies the interval between scheduled transfers of data, rounded up to the nearest minute.

The default is PT0S.

The DataSource element defines the event log to monitor. The parent of this element is the WindowsEventLog Element.

The following table describes the attributes of the DataSource element.

 

Attribute Type Description

name

string

Required. An XPath expression specifying the log to collect.

See Also

Concepts

Schema Reference

Show:
© 2014 Microsoft