Enabling Web Management Service Tracing

Applies To: Windows Server 2008 R2

Web Management Service Tracing is enabled via the registry and produces a text-based log file that records details of Web Deploy handler operations. This topic describes how to enable the WMSVCTracing registry key, how to configure the levels of information to trace, and how to specify the sources of the information that will be traced.

When to Use

You can use Web Management Service Tracing to troubleshoot WMSvc delegation and deployment issues. Enabling the tracing does not require a restart of the Web Management Service. Unlike failed request tracing, WMSvc tracing is not resource-intensive and can be used in production environments. In addition, WMSvc tracing provides more precise control over the information that can be logged. By configuring two additional registry keys, you can specify the severity levels and sources of information that you want to trace.

Information logged

WMSvc tracing records the details of Web Deploy handler operations. The information logged depends on how you configure the tracing. You can specify one of five severity levels to trace (Off, Error, Warning, Info, Verbose), and you can specify any combination of 11 values to specify the sources of information to trace. The WMSvc tracing log is stored at the file path %WINDIR%\ServiceProfiles\LocalService\AppData\Local\Temp\WMSvc.log.

Example Web Management Service tracing log entry

The following is an example of a WMSvc tracing log entry.

wmsvc.exe Error: 0 : Not authorized.

Details: No rule was found that could authorize user 'WebServer2K8\test', provider 'createApp', operation 'Write', path 'default web site/App1'.

ProcessId=4168

ThreadId=10

DateTime=2010-05-06T18:54:51.0082908Z

Timestamp=12267633997973

Enable tracing of Web Management Service messages by using the WMSVCTracing key

To enable tracing of Web Management Service activity, you will need to modify the registry. You can do this by using the registry editor or by using an elevated command prompt.

Warning

Incorrectly editing the registry might severely damage your system. Before making changes to the registry, you should back up any valued data.

To enable WmSvc tracing by using regedit

  1. Open an elevated command prompt window. Click Start, point to All Programs, click Accessories, right-click Command Prompt, and then click Run as administrator.

  2. Type regedit.

  3. In the registry editor, expand the tree to the node HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\IIS Extensions\MSDeploy\1.

  4. If the WMSVCTracing key does not exist, right-click the right pane, select New, DWORD, and then name the new key WMSVCTracing.

  5. Double-click WMSVCTracing and set the value to 1. This will cause only errors to be traced. To trace other information, see the section "Enabling a specific trace level."

To enable WmSvc tracing by using a command prompt

  1. Open an elevated Command Prompt window. Click Start, point to All Programs, click Accessories, right-click Command Prompt, and then click Run as administrator.

  2. Type cmd.

  3. Type the following at the command prompt.

    reg add "HKLM\SOFTWARE\Microsoft\IIS Extensions\MSDeploy\1" /v WMSVCTracing /t REG_DWORD /d 1 /f

    This will cause only Errors to be traced. To trace other information, see the following section.

Note

When you enable tracing with the WMSVCTracing key, the WMSvc tracing logs are stored in the file %WINDIR%\ServiceProfiles\LocalService\AppData\Local\Temp\WMSvc.log.

Enabling a specific trace level by using the EnabledTraceLevel key

You can specify the kind of WMSvc messages to trace by using regedit or the command prompt to add the EnabledTraceLevel key to HKLM\SOFTWARE\Microsoft\IIS Extensions\MSDeploy\1. Use regedit as described previously, or type the following command at an elevated command prompt.

reg add "HKLM\SOFTWARE\Microsoft\IIS Extensions\MSDeploy\1" /v EnabledTraceLevel /t REG_DWORD /d 2 /f

The setting of 2 will cause Warnings and Errors to be traced. Acceptable values for EnabledTraceLevel and their meanings are listed in the following table. Only one value can be set for this key. Higher values include the output from lower values.

Value Keyword Description

0

Off

No WMSvc information will be traced.

1

Error

Only WMSvc Errors will be traced. This is the default setting.

2

Warning

Both WMSvc Errors and Warnings will be traced.

3

Info

WMSvc Errors, Warnings, and informational messages will be traced.

4

Verbose

All WMSvc messages will be traced.

Specifying sources of trace information by using the EnabledTraceSources key

By default, information from all sources is traced. You can specify filters for the sources of information that you want Web Deploy to trace by using regedit or the command prompt to add the EnabledTraceSources key to HKLM\SOFTWARE\Microsoft\IIS Extensions\MSDeploy\1. Use regedit as described previously, or type the following command at an elevated command prompt.

reg add HKLM\SOFTWARE\Microsoft\IIS Extensions\MSDeploy\1" /v EnabledTraceSources /t REG_DWORD /d 6 /f

The setting of 6 will cause Authorization and Impersonation messages to be traced. Acceptable values for EnabledTraceSources and their meanings are listed in the following table. These values can be combined (added) if you want to specify more than one.

Value Keyword Description

0

None

No information will be traced.

1

Agent

Agent related messages will be traced.

2

Authorization

Authorization related messages will be traced.

4

Impersonation

Impersonation related messages will be traced.

8

Provider

Provider related messages will be traced.

16

Serialization

Serialization related messages will be traced.

32

Sync

Synchronization related messages will be traced.

64

Parameterization

Parameterization related messages will be traced.

128

Rules

Rules related messages will be traced.

256

Framework

.NET Framework related messages will be traced.

-1

All

Messages from all sources will be traced.

   

Note

The changes that you make to the registry take effect immediately. You do not need to restart the Web Management Service.

See Also

Concepts

Configuring Web Management Service Logging and Tracing
Enabling Web Management Service W3C Logging
Enabling Web Management Service Failed Request Tracing