Configure Tracing

  • Article

This topic describes how you can use AppFabric cmdlets to configure tracing for an application or a service. The cmdlets that you can use for configuring tracing are Get-ASAppAnalyticTracing, Set-ASAppAnalyticTracing, Clear-ASAppAnalyticTracing, Disable-ASAppDebugTracing, Enable-ASAppDebugTracing, Set-ASAppDebugTracing, and Get-ASAppDebugTracing.

To execute an AppFabric cmdlet interactively, open the Windows PowerShell console for AppFabric, enter the appropriate cmdlet, and then press ENTER. For more information about executing cmdlets, see Running Windows Server AppFabric Cmdlets.

To obtain analytic tracing information for an application

In the Windows PowerShell console, execute the Get-ASAppAnalyticTracing cmdlet to get the analytic tracing information for the Web application at the specified scope in a DebugTracingInfo class.

Syntax options for Get-ASAppAnalyticTracing:

Syntax 1

Get-ASAppAnalyticTracing [-SiteName] <String> [[-VirtualPath] <String>]

Syntax 2

Get-ASAppAnalyticTracing [-Uri] <Uri>

Syntax 3

Get-ASAppAnalyticTracing -ApplicationObject <ApplicationInfo>

Syntax 4

Get-ASAppAnalyticTracing -Root
Parameter Description

[-SiteName] <String> [[-VirtualPath], [-Uri] <Uri>, -ApplicationObject <ApplicationInfo>, or -Root

Operational scope of cmdlet

To set analytic tracing for an application

In the Windows PowerShell console, execute the Set-ASAppAnalyticTracing cmdlet to set the analytic tracing configuration for the Web application at the specified scope.

Syntax options for Set-ASAppAnalyticTracing:

Syntax 1

Set-ASAppAnalyticTracing [-SiteName] <String> [[-VirtualPath] <String>] [-MessageFlowTracing <Boolean>] [-PropagateActivity <Boolean>] [-ProviderId <Guid>]

Syntax 2

Set-ASAppAnalyticTracing [-Uri] <Uri> [-MessageFlowTracing <Boolean>] [-PropagateActivity <Boolean>] [-ProviderId <Guid>]

Syntax 3

Set-ASAppAnalyticTracing -ApplicationObject <ApplicationInfo> [-MessageFlowTracing <Boolean>] [-PropagateActivity <Boolean>] [-ProviderId <Guid>] [Set-ASAppAnalyticTracing [-MessageFlowTracing <Boolean>] [-PropagateActivity <Boolean>] [-ProviderId <Guid>]

Syntax 4

Set-ASAppAnalyticTracing [-MessageFlowTracing <Boolean>] [-PropagateActivity <Boolean>] [-ProviderId <Guid>] -Root
Parameter Description

[-SiteName] <String> [[-VirtualPath], [-Uri] <Uri>, -ApplicationObject <ApplicationInfo>, or -Root

Operational scope of cmdlet

-MessageFlowTracing <Boolean>

Boolean value to enable message flow tracing

-PropagateActivity <Boolean>

Boolean value to enable an activity to propagate across calls

-ProviderId <Guid>

GUID of the configured tracking provider

To disable analytic tracing for an application

In the Windows PowerShell console, execute the Clear-ASAppAnalyticTracing cmdlet to disable the analytic tracing configuration for the Web application at the specified scope.

Syntax options for Clear-ASAppAnalyticTracing:

Syntax 1

Clear-ASAppAnalyticTracing [-SiteName] <String> [[-VirtualPath] <String>] [-Confirm] [-WhatIf] [<CommonParameters>]

Syntax 2

Clear-ASAppAnalyticTracing [-Uri] <Uri> [-Confirm] [-WhatIf] [<CommonParameters>]

Syntax 3

Clear-ASAppAnalyticTracing -ApplicationObject <ApplicationInfo> [-Confirm] [-WhatIf] [<CommonParameters>]

Syntax 4

Clear-ASAppAnalyticTracing [-Confirm] [-Root] [-WhatIf] [<CommonParameters>]
Parameter Description

[-SiteName] <String> [[-VirtualPath], [-Uri] <Uri>, -ApplicationObject <ApplicationInfo>, or -Root

Operational scope of cmdlet

To enable debug tracing for an application

In the Windows PowerShell console, execute the Enable-ASAppDebugTracing cmdlet to start collecting high-volume diagnostic trace information.

Syntax options for Enable -ASAppDebugTracing:

Syntax 1

Enable-ASAppDebugTracing [-SiteName] <String> [[-VirtualPath] <String>] [-FilePath] <String> [-ActivitiesLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}] [-ServiceModelLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}]

Syntax 2

Enable-ASAppDebugTracing [-Uri] <Uri> [-FilePath] <String> [-ActivitiesLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}] [-ServiceModelLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}]

Syntax 3

Enable-ASAppDebugTracing [-FilePath] <String> -ApplicationObject <ApplicationInfo> [-ActivitiesLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}] [-ServiceModelLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}]

Syntax 4

Enable-ASAppDebugTracing [-FilePath] <String> [-ActivitiesLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}] -Root [-ServiceModelLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}]
Parameter Description

[-SiteName] <String> [[-VirtualPath] <String>], [-Uri] <Uri>, -ApplicationObject <ApplicationInfo>, or -Root

Operational scope of cmdlet

-FilePath <String>

Required. Where the logs should be stored.

-ActivitiesLevel

Optional. {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}. The level at which the System. Activities source will log.

[-ServiceModelLevel]

Optional. {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}. The level at which the System.ServiceModel source will log.

To disable debug tracing for an application

In the Windows PowerShell console, execute the Disable-ASAppDebugTracing cmdlet to stop collecting diagnostic trace information.

Syntax options for Disable-ASAppDebugTracing:

Syntax 1

Disable-ASAppDebugTracing [-SiteName] <String> [[-VirtualPath] <String>]

Syntax 2

Disable-ASAppDebugTracing [-Uri] <Uri>

Syntax 3

Disable-ASAppDebugTracing -ApplicationObject <ApplicationInfo>

Syntax 4

Disable-ASAppDebugTracing -Root
Parameter Description

[-SiteName] <String> [[-VirtualPath] <String>, [-Uri] <Uri>, -ApplicationObject <ApplicationInfo>, or -Root

Operational scope of cmdlet

To set debug tracing for an application

In the Windows PowerShell console, execute the Set-ASAppDebugTracing cmdlet to change parameters on the debug tracing enabled by Enable-ASAppDebugTracing.

Syntax options for Set-ASAppDebugTracing:

Syntax 1

Set-ASAppDebugTracing [-SiteName] <String> [[-VirtualPath] <String>] [-ActivitiesLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}] [-FilePath <String>] [-ServiceModelLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}]

Syntax 2

Set-ASAppDebugTracing [-Uri] <Uri> [-ActivitiesLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}] [-FilePath <String>] [-ServiceModelLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}]

Syntax 3

Set-ASAppDebugTracing -ApplicationObject <ApplicationInfo> [-ActivitiesLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}] [-FilePath <String>] [-ServiceModelLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}]

Syntax 4

Set-ASAppDebugTracing [-ActivitiesLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}] [-FilePath <String>] -Root [-ServiceModelLevel {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}]
Parameter Description

[-SiteName] <String> [[-VirtualPath], [-Uri] <Uri>, -ApplicationObject <ApplicationInfo>, or -Root

Operational scope of cmdlet

-FilePath <String>

Optional. Where the logs should be stored.

-ActivitiesLevel

Optional. {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}. The level at which the System. Activities source will log.

[-ServiceModelLevel]

Optional. {<Critical> | <Error> | <Information> | <Off> | <Verbose> | <Warning>}. The level at which the System.ServiceModel source will log.

To obtain debug tracing information for an application

In the Windows PowerShell console, execute the Get-ASAppDebugTracing cmdlet to retrieve the current debug tracing settings in a DebugTracingInfo class.

Syntax options for Get-ASAppDebugTracing:

Syntax 1

Get-ASAppDebugTracing [-SiteName] <String> [[-VirtualPath] <String>]

Syntax 2

Get-ASAppDebugTracing [-Uri] <Uri>

Syntax 3

Get-ASAppDebugTracing -ApplicationObject <ApplicationInfo>

Syntax 4

Get-ASAppDebugTracing -Root
Parameter Description

[-SiteName] <String> [[-VirtualPath], [-Uri] <Uri>, -ApplicationObject <ApplicationInfo>, or -Root

Operational scope of cmdlet