kb(common): fiddler everywhere reporter for capturing logs closes tel…

…erik/telerik.web.ui#2235

knowledge-base/common-fiddler-everywhere-reporter.md

@@ -0,0 +1,166 @@
+---
+title: Fiddler Everywhere Reporter
+description: Fiddler Everywhere Reporter is an extension tool of Fiddler Everywhere that aims to capture web traffic on the end user's machine and share the log with a user holding an active license for Fiddler Everywhere.
+type: how-to
+page_title: Fiddler Everywhere Reporter
+slug: common-fiddler-everywhere-reporter
+tags: capture, web, traffic, fiddler, everywhere, reporter
+res_type: kb
+category: knowledge-base
+---
+
+## Environment
+
+| Supported Browsers | 
+| --- |
+| Google Chrome |
+| Microsoft Edge (Chromium) |
+
+## Description
+
+**Fiddler Everywhere Reporter** is an extension tool of [Fiddler Everywhere](https://docs.telerik.com/fiddler-everywhere/introduction) that aims to capture web traffic on the end user's machine and share the log with a user holding an active license for Fiddler Everywhere. 
+
+The captured logs can be analyzed to learn about error messages, malformed requests, currently loaded web resources (e.g. JavaScript, CSS Stylesheets) and more. This can greatly help in troubleshooting certain issues related to the UI.
+
+![](images/common-fiddler-everywhere-reporter-overview.png)
+
+## Solution
+
+The Fiddler Everywhere Reporter is a free, portable tool requiring NO login or licenses and no installation. 
+
+### Download
+
+Download the tool from one of the following links:
+
+- **Windows**: https://api.getfiddler.com/reporter/win/latest
+- **Intel Mac**: https://api.getfiddler.com/reporter/mac/latest-mac
+- **ARM Mac**: https://api.getfiddler.com/reporter/mac-arm64/latest-mac
+
+The Reporter tool has a 3-step usage flow, **Start Capture**, **Stop Capture** and **Save Capture**.
+
+To reset the flow at any point, use the [Start Over](#start-over) button which will delete all captured requests and enable a new capture process.
+
+### Short Instructions
+
+You can follow the short instructions in this section below, or visit the [Start Capture](#start-capture), [Stop Capture](#stop-capture) and [Save Capture](#save-capture) dedicated sections for more details.
+
+**1.** Download the Tool from the [Download](#download) section and run it. Does not require installation, login or license.
+
+**2.** Start the capture using the default option. This will open a Google Chrome or Microsoft Edge (Chromium) instance.
+
+!["Start Capture"](images/common-fiddler-everywhere-reporter-start-capture.png "Start Capture")
+
+**3.** Within this browser instance, navigate to the web page in question and interact with the page to replicate the issue.
+
+!["Browser Instance"](images/common-fiddler-everywhere-reporter-browser-instance.png "Browser Instance")
+
+**4.** When done, click on Stop Capture.
+
+!["Stop Capture"](images/common-fiddler-everywhere-reporter-stop-capture.png "Stop Capture")
+
+**5.** Finally, click on Save Capture then share this with us. At this point you can password protect the captured logs if you wish and share the password along with the logs.
+
+!["Save Capture"](images/common-fiddler-everywhere-reporter-save-capture.png "Save Capture")
+
+!["Password Protect the Logs"](images/common-fiddler-everywhere-reporter-password-protect.png "Password Protect the Logs")
+
+Detailed sections:
+
+ 1. [Start Capture](#start-capture)
+ 2. [Stop Capture](#stop-capture)
+ 3. [Save Capture](#save-capture)
+ 4. [Notes](#notes)
+
+### Start Capture
+
+There are 4 ways for capturing traffic that can be triggered from the button or the dropdown options:
+
+- [Start Capturing Browser (Default action)](#start-capturing-browser-default-action)
+- [Start Capturing Everything](#start-capturing-everything)
+- [Start Capturing Terminal](#start-capturing-terminal)
+- [Manual Setup (Advanced)](#manual-setup-advanced)
+
+**Start Capturing Browser (Default action)**
+
+The Capture Browser option allows capturing of traffic from a `sandboxed` browser instance. As a result, Fiddler Everywhere Reporter starts a pre-configured independent browser instance to respect the Fiddler proxy and to trust its Root Certificate Authority (CA). The `HTTPS` traffic generated will appear in Fiddler Everywhere Reporter. Currently, the tool supports independent browser capturing only for **Chrome** and **Edge** browsers. If both exist on the machine, Chrome will be opened by default. Currently, there is no way to configure the launching of Edge if both exist on the machine. If the user does not have neither Chrome nor Edge installed, the tool will display an error message that the browser option can't be started.
+
+>important users on Mac need to manually quit the browser instance from the dock even after the Fiddler Everywhere reporter tool is closed.
+
+This option is available (enabled) if:
+- There aren't active capturing processes.
+- There aren't any captured requests.
+
+**Start Capturing Everything**
+
+The Capture Everything option will log all HTTP, HTTPS, WebSocket, SSE, and gRPC traffic between the computer and the Internet. It works by setting the system proxy and will capture all incoming and outgoing traffic from any application that supports a proxy - browsers, desktop applications, CLI tools, and others. This option requires installing and trusting the Fiddler Root Certificate Authority (CA) in the operating system.
+
+Upon first trigger of this capturing mode, a dialog will prompt the user to install and trust the Fiddler CA in order to configure the option and enable capturing of HTTPS traffic. After providing credentials, traffic will start generating in Fiddler Everywhere Reporter. Closing the Reporter will not clean up the certificate configuration, and the next time you open the tool the settings will be persisted. You can reset this option from the Tools menu -> Remove Root Certificate.
+
+>important If using a VPN, the Fiddler Everywhere Reporter will not be able to capture any traffic. Try using one of the other approaches for capturing traffic.
+
+This option is available (enabled) if:
+- There are no currently active capturing processes.
+- There are not any captured requests.
+
+**Start Capturing Terminal**
+
+The Capture Terminal option will launch a new, clean terminal instance, and route traffic only from this instance through Fiddler Everywhere Reporter. It will open PowerShell on Windows and the default Terminal on Mac. The option currently supports capturing traffic from cURL, Node.js and Python out of the box. If you need to capture traffic from .NET applications, it is required to manually install and trust the Fiddler Root Certificate Authority (these options can be found in the Tools menu). The terminal capturing mode allows using the proxy in a sandboxed environment without changing the global OS proxy settings.
+
+>important Users on Mac need to manually quit the terminal instance from the dock even after the Fiddler Everywhere Reporter tool is closed.
+
+This option is available (enabled) if:
+- There are no currently active capturing processes.
+- There are not any captured requests.
+
+**Manual Setup (Advanced)**
+
+When this mode is selected, Fiddler Everywhere Reporter will start listening on the port printed next to the “Details” label. The address can be copied and used to specify the proxy registry setting of your application and manually configure it to send incoming and outgoing traffic to Fiddler Everywhere Reporter. In addition, the Fiddler Root Certificate needs to be trusted from the Tools menu or manually exported and trusted.
+
+This option is available (enabled) if:
+- There are no currently active capturing processes.
+- There are not any captured requests.
+
+### Stop Capture
+
+After reproducing the problem, the capturing can be terminated with the Stop Capture button on Step 2.
+This will close the open port, remove the system proxy (if set) and stop capturing new requests.
+
+This option is available (enabled) if:
+- If there is an active capturing process.
+
+### Save Capture
+
+To save the generated requests, use the button on Step 3 - Save Capture. The button will open a save dialog, where users can enter file name and path.
+A password encryption is required in order to save the file successfully. The end-user must provide the password to the team that will be reviewing the file later in order to open it successfully with Fiddler Everywhere.
+Password must be at least 8 symbols.
+
+This option is available (enabled) if:
+- There are no currently active capturing processes.
+- There is at least one captured session.
+
+### Start Over
+
+To restart the capture, use the Start Over button which will delete all captured requests and enable a new capture process.
+
+This will stop the active capturing process and clear the captured requests.
+
+This option is available (enabled) if:
+- There is at least one captured session.
+
+### Details (Advanced)
+
+Details toggle button shows a grid with currently captured requests. In the grid, users can select one or more requests and delete them.
+
+## Notes
+
+- In the Tools menu find additional options to manually Trust Root Certificate, Export Root Certificate and Remove Root Certificate
+- When there is no capturing happening, the UI will display a "Not Capturing" indication.
+- While capturing is taking place, the label will change to "Capturing."
+- To see the list with all captured requests, the end-user can switch on the "Details" toggle.
+- To remove one or more of the captured requests before save, select the respective requests and right-click to remove.
+- To check the current version, go to
+  - File -> About (Windows)
+  - Fiddler Everywhere Reporter -> About Fiddler Everywhere Reporter (Mac)
+- To turn off anonymous analytics tracking, go to
+  - File -> Privacy -> Automatically send data to help us improve the product (Windows)
+  - Fiddler Everywhere Reporter -> Privacy -> Automatically send data to help us improve the product