Add packet capture and max size support to Trace-PlayFabParty helper script (#47)

Author: tomcoMSFT

TraceScripts/Trace-PlayFabParty.ps1

@@ -21,7 +21,23 @@ param(
 
     # Whether to include verbose transport entries in the trace file.
     # Defaults to false if not specified.
-    [switch]$IncludeTransport
+    [switch]$IncludeTransport,
+
+    # Whether to include a raw packet capture and Windows OS networking stack
+    # entries in the trace file.
+    # NOTE: Using this switch may record networking activity on the device
+    # beyond that which directly involves PlayFab Party, and is not recommended
+    # unless specifically requested for additional support.
+    # Defaults to false if not specified.
+    [switch]$IncludePackets,
+
+    # Sets a maximum output file size, in megabytes, for long-running traces of
+    # scenarios that can't be narrowed another way. A circular buffer is used,
+    # where only the most recent entries are kept if the output file would
+    # exceed the maximum.
+    # If not specified, this parameter defaults to 0, which does not constrain
+    # trace output file size.
+    [int]$MaxSizeInMB
     )
 
 if (($OutputFile -ne $null) -and ($OutputFile -ne ""))
@@ -70,7 +86,39 @@ else
 {
     $xrnWppProvider = ""
 }
-$providersString = @($playfabPartyWppProvider, $xnupWppProvider, $xrnWppProvider) -Join " "
+if ($IncludePackets)
+{
+    Write-Warning "A packet capture was requested with this trace. The resulting output file may therefore record Internet/networking activity on this device beyond just PlayFab Party communication, such as potentially sensitive web browser or private local network connections."
+    Write-Host ""
+    Write-Host "Please close all unneeded background applications, and never store the resulting output file in an insecure location."
+    Write-Host ""
+    Write-Host "Be aware that providing the output file to Microsoft support agents may allow them visibility of such networking activities. However only the minimum information required for PlayFab Party support will be used, and no parts will ever be shared with anyone for any reason. All records will be deleted once the support issue has been resolved."
+    Write-Host ""
+    Read-Host "To abort, press Control-C. Otherwise, press 'Enter'"
+    $captureString = "capture=yes"
+    # TCP/IP
+    $osNetworkingProviders = "provider={2F07E2EE-15DB-40F1-90EF-9D7BA282188A} keywords=0xFFFFFFFFFFFFFFFF level=5"
+    # AFD
+    $osNetworkingProviders += " provider={E53C6823-7BB8-44BB-90DC-3F86090D48A6} keywords=0xFFFFFFFFFFFFFFFF level=5"
+    # BFE
+    $osNetworkingProviders += " provider={106B464A-8043-46B1-8CB8-E92A0CD7A560} keywords=0xFFFFFFFFFFFFFFFF level=5"
+    # fwpkclnt
+    $osNetworkingProviders += " provider={AD33fA19-F2D2-46D1-8F4C-E3C3087E45AD} keywords=0xFFFFFFFFFFFFFFFF level=5"
+    # fwpuclnt
+    $osNetworkingProviders += " provider={5A1600D2-68E5-4DE7-BCF4-1C2D215FE0FE} keywords=0xFFFFFFFFFFFFFFFF level=5"
+    # WFP
+    $osNetworkingProviders += " provider={0C478C5B-0351-41B1-8C58-4A6737DA32E3} keywords=0xFFFFFFFFFFFFFFFF level=5"
+    # DNS
+    $osNetworkingProviders += " provider={1C95126E-7EEA-49A9-A3FE-A378B03DDB4D} keywords=0xFFFFFFFFFFFFFFFF level=5"
+    # WS NR
+    $osNetworkingProviders += " provider={B923F87A-B069-42B5-BD32-35623ABA1C48} keywords=0xFFFFFFFFFFFFFFFF level=5"
+}
+else
+{
+    $captureString = "capture=no"
+    $osNetworkingProviders = ""
+}
+$providersString = @($playfabPartyWppProvider, $xnupWppProvider, $xrnWppProvider, $osNetworkingProviders) -Join " "
 
 # Attempt to determine if the netsh trace start command supports the
 # 'bufferSize' parameter on this system by looking for the "bufferSize=" string
@@ -85,7 +133,17 @@ else
     $bufferSizeString = ""
 }
 
-$netshStartCmd = "netsh trace start $bufferSizeString overwrite=no tracefile=`"$traceFileName`" report=disable $providersString"
+# Configure the appropriate output file size limit and mode.
+if (($MaxSizeInMB -ne $null) -and ($MaxSizeInMB -gt 0))
+{
+    $maxSizeString = "maxSize=$MaxSizeInMB fileMode=circular"
+}
+else
+{
+    $maxSizeString = "maxSize=0 fileMode=single"
+}
+
+$netshStartCmd = "netsh trace start $bufferSizeString overwrite=no tracefile=`"$traceFileName`" $captureString report=disable $maxSizeString $providersString"
 
 Write-Host $netshStartCmd
 cmd /c $netshStartCmd