IBM Support

How to use diagnostic trace tools for troubleshooting ADFS or Web Application Proxy Server issues

How To


Summary

Instructional guide for data collection to assist Support troubleshoot issues you may experience with Active Directory Federation Services or Web Application Proxy Server.

Objective

Providing the ability to provide Support with comprehensive data on initial engagement.  This assists Support in providing faster resolutions

Environment

Windows 2012 R2, 2016, 2019, 2022

Steps

Simultaneous traces from both server and client during reproduction of the issue.

From ADFS server:

  1. Download the ADFS tracing script (ADFS-tracing.ps1) available on Github
  2. Save to any location on the ADFS servers.
  3. Open PowerShell as admin, switch into the directory where the scripts are.
  4. Execute ADFS-tracing.ps1
  5. In the prompt select the following and choose a location to save the trace.
    • Runtime Tracing
    • include Network Traces
  6. Click ok to proceed. (Start the trace on the other servers if applicable)
  7. Ctrl + Y to start the trace, wait until prompted to reproduce the issue.
  8. Reproduce the issue.
  9. Ctrl + Y to stop the trace.
  10. Upload data to the link provided by Support

Also, from an elevated PowerShell:

  • Install-Module -Name ADFSToolbox -Force
  • Import-Module ADFSToolbox -Force
  • Export-AdfsDiagnosticsFile

From client:

To capture the Fiddler logs, please follow these steps:

  1. Download and install Fiddler from Telerik.
  2. Close all unnecessary application while collection the Fiddler trace.
  3. Open Fiddler, In Tools->Fiddler Options->HTTPS, check “Decrypt HTTPS traffic”.
  4. Click “Yes” on the prompt for trust Fiddler Root Certificate.
  5. Click “Yes” to install the certificate.
  6. Click “Yes” to confirm.
  7. Click “OK” and “OK” to back.
  8. Start Capturing: File->Capture Traffic
  9. Reproduce the issue, log down the time when the issue happens again.
  10. Stop Fiddler Trace: File->Capture Traffic F12, save trace: File->Save>All Sessions. Save the trace out as .saz file.

 Note: You can also capture a browser network trace and save it as a .HAR file using the browser developer tools.

Additional Information

Requirements for ADFS-tracing.ps1:

  • the Script supports ADFS on Windows 2012 R2, 2016, 2019, 2022
  • Local administrator privileges are required to run the script
  • Strongly suggest the account is also a Domain User
  • Minimum of 5GB of free disk space on the volume for the target folder when running the tracing for a longer period
  • For Server 2012 R2 it is recommended (not mandatory) to have the Windows Management Framework 5.1 (WMF) aka PowerShell 5.0 installed 

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB66","label":"Technology Lifecycle Services"},"Business Unit":{"code":"BU070","label":"IBM Infrastructure"},"Product":{"code":"SSTIPK","label":"Microsoft Windows"},"ARM Category":[{"code":"a8mKe000000004NIAQ","label":"Windows"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
27 September 2024

UID

ibm17171573