-
Notifications
You must be signed in to change notification settings - Fork 145
Added new documentation page to show users how to export a HAR file #998
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
3a45453
Added new documentation page to show users how to export a HAR file
ProgrammerAL f901a49
Fix doc spelling in: src/content/docs/identityserver/troubleshooting/…
ProgrammerAL 7c87eec
Fix doc spelling in: src/content/docs/identityserver/troubleshooting/…
ProgrammerAL 459f5db
Update src/content/docs/identityserver/troubleshooting/export-har-fil…
ProgrammerAL eaaf9f1
Update src/content/docs/identityserver/troubleshooting/export-har-fil…
ProgrammerAL c47861f
Update src/content/docs/identityserver/troubleshooting/export-har-fil…
ProgrammerAL d900b57
Update src/content/docs/identityserver/troubleshooting/export-har-fil…
ProgrammerAL 805b371
Re-ordered sections/headers
ProgrammerAL e44e750
Fixed some capitalizations of headers
ProgrammerAL 56acb9c
Added some formatting suggestions. Reworded the caution tip at the to…
ProgrammerAL File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
69 changes: 69 additions & 0 deletions
69
src/content/docs/identityserver/troubleshooting/export-har-files.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| title: "Export HAR Files for Analysis" | ||
| description: Documentation for creating HAR files and why they are used for disgnostics | ||
| date: 2026-01-28T08:03:00+02:00 | ||
| sidebar: | ||
| label: "Export HAR Files" | ||
| order: 16 | ||
| --- | ||
|
|
||
| [HTTP Archive (HAR)](<https://en.wikipedia.org/wiki/HAR_(file_format)>) files are logs of network interactions made by a web browser. They contain headers, request bodies, response payloads, and even sentitive information like cookie values sent and received for each interaction. | ||
|
ProgrammerAL marked this conversation as resolved.
Outdated
|
||
|
|
||
| :::caution[Do not share sensitive information] | ||
| Before sharing any HAR files that contain sensitive values for diagnosing, you can sanitize that data by following the [steps below](#sanitize-a-har-file). | ||
| ::: | ||
|
|
||
| ## Generating a HAR file | ||
|
|
||
| Generating a HAR file involves steps using your web browser and its associated developer tools. The browser-specific steps outlined below are all similar to each other. Other browsers will have similar steps. | ||
|
|
||
| ### HAR File Considerations | ||
|
|
||
| * Consider using an incognito window of your browser. If you do, close all browser incognito instances you may have open and open a new one before creating the HAR file to ensure the cache is cleared. | ||
|
ProgrammerAL marked this conversation as resolved.
Outdated
|
||
| * Preserve the log across page navigations | ||
| * If you are navigating to different pages (ex: logging in to a site with OAuth redirects), then any network calls made before the last redirect will be lost. Preserving the logs across page navigations aids in diagnosing issues. The below steps include instructions to preserve network logs while navigating across multiple pages. | ||
| * Generate HAR files with sensitive data | ||
| * It is helpful to know that certain fields are have been set, but not necessarily the actual value. Some browsers will exclude sensitive data in HAR file exports by default. The below steps include instructions to enable sensitive data in HAR file exports for browsers that do not include it by default. | ||
|
|
||
| ### Google Chrome | ||
|
|
||
| 1. Open the browser dev tools <https://developer.chrome.com/docs/devtools/open>. | ||
| 1. In the dev tools, click on the Settings icon. Under the Network category, enable "Allow to generate HAR with sensitive data". | ||
| 1. In the dev tools, navigate to the Network tab and enable the "Preserve log" checkbox. | ||
| 1. In the browser, visit the page(s) and perform the steps that trigger the issue. | ||
| 1. In the Network tab of the dev tools, click the down arrow and select the "Export HAR (with sensitive data)..." option to export the HAR file and save it locally. | ||
|
|
||
| ### Safari | ||
|
|
||
| 1. Enable the Web Inspector, and open it <https://developer.apple.com/documentation/safari-developer-tools/enabling-developer-features>. | ||
| 1. In the Web Inspector in the Developer menu, navigate to the Network tab. Click the "Filter" button and enable "Preserve Log". | ||
| 1. In the browser, visit the page(s) and perform the steps that trigger the issue. | ||
| 1. In the Web Inspector, click "Export" to export the HAR file and save it locally. | ||
|
|
||
| ### Firefox | ||
|
|
||
| 1. Open the browser dev tools <https://firefox-source-docs.mozilla.org/devtools-user>. | ||
| 1. In the dev tools, navigate to the Network tab, click the Network Settings icon, and enable "Persist Logs". | ||
| 1. In the browser, visit the page(s) and perform the steps that trigger the issue. | ||
| 1. In the Network tab of the dev tools, click the Network Settings icon, and select "Save All As Har" to save it locally. | ||
|
|
||
| ### Microsoft Edge | ||
|
|
||
| 1. Open the browser dev tools <https://learn.microsoft.com/en-us/microsoft-edge/devtools/overview>. | ||
| 1. In the dev tools, click on the ellipsis icon, then select "Settings". Under the Network category, enable "Allow to generate HAR with sensitive data". | ||
| 1. In the dev tools, navigate to the Network tab and enable the "Preserve log" checkbox. | ||
| 1. In the browser, visit the page(s) and perform the steps that trigger the issue. | ||
| 1. In the Network tab of the dev tools, click the down arrow and select the "Export HAR (with sensitive data)..." option to export the HAR file and save it locally. | ||
|
|
||
| ### Sanitize a HAR file | ||
|
|
||
| Before sharing your HAR file with anyone you should remove any sensitive data. You can do this manually by opening the HAR file with any JSON text editor and removing the sensitive data. We recommend replacing data with a placeholder instead of deleting the entry. When diagnosing issues, it's helpful to know if a field was set or not. | ||
|
ProgrammerAL marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Practice | ||
|
|
||
| If you would like to practice with a small sample, you can login to the Duende Demo Server and generate a HAR file from those interactions. | ||
|
|
||
| 1. In your browser, navigate to <https://demo.duendesoftware.com/Account/Login>. | ||
| 1. With your browser and dev tools open, the log being preserved, and the ability to export a HAR file with sensitive data, login to the site using one of the built-in users. | ||
| 1. Export the HAR file with sensitive data. | ||
| 1. Explore the HAR file JSON with a text editor. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.