Turn on Diagnostic Logging

If applications are experiencing issues, it is helpful to turn on diagnostic logging. This can be turned on in both Solution Center and in the ArcFM Connectivity Evaluator (ACE) tool.

IMPORTANT: You can use a third-party application such as Fiddler to help debug an issue. Fiddler is a free, web debugging proxy. A helpful starting point to understand its capabilities is Fiddler: A Web Debugging Proxy for any Browser. However, because your company’s IT department might not allow an application like Fiddler to be used, the local diagnostic logging discussed in this topic is easily deployed and helpful to troubleshoot issues. The key difference is that the diagnostic logging only logs traffic from Schneider Electric SDKs, whereas Fiddler logs traffic regardless of origin. Further, the contents flag only affects the local files, and content bodies are never shipped remotely.

Both Solution Center and the ACE tool have application configuration files in the following directories:

Solution Center: C:\Users\username\AppData\Local\ArcFMSolutionCenter\app-version #
The ACE tool: C:\Users\username\AppData\Local\ArcFMConnectivityEvaluator\app-version #

IMPORTANT: Always update the configuration file in the folder with the most recent (highest) app-version number.

In those configuration files, there are two diagnostic logging settings. The following code block shows the default settings:

<appSettings>
   <add key="LogRequestsLocally" value="false" />
   <add key="LogRequestsContents" value="false" />
</appSettings>

You can change the “false” to “true” to turn on the diagnostic logging.

If LogRequestsLocally is “true,” the log captures only simple request information. This includes the request method, the request URL, and the response status code.
If both LogRequestsLocally and LogRequestContents are “true,” in addition to the method, URL, and response status code, the log captures the request headers, the response headers, and the response body.

IMPORTANT: Regardless of settings, the log redacts the JSON Web Token (JWT) for security reasons.

When enabled, the log files are saved in a logs subfolder of the same location as the application executable.