KB0061 - Enabling Debug System Logs

KB0061 - Enabling Debug System Logs

Purpose

The purpose of this document is to outline how to enable debug system logs. System logs provide details into the internals of PowerShell Universal and default to Information. 

Applicable Versions

- PowerShell Universal v4 and later

Process

Open the PowerShell Universal appsettings.json file. If install via the MSI, it will be installed into the %ProgramData%\PowerShellUniversal folder. This file will contain a subset of the PowerShell Universal settings and will not be removed during upgrades. 
Add the following to the appsettings.json file. 
  1. "SystemLogLevel": "Debug",
The resulting appsettings.json file should be valid JSON. For example: 
  2. {
  3.   "SystemLogLevel": "Debug",
  4.   "Kestrel": {
  5.     "Endpoints": {
  6.       "HTTP": {
  7.         "Url": "http://*:5000"
  8.       }
  9.     }
  10.   },
  11.   "Plugins": [
  12.     "SQLite"
  13.   ],
  14.   "Data": {
  15.     "RepositoryPath": "%ProgramData%\\UniversalAutomation\\Repository",
  16.     "ConnectionString": "Data Source=%ProgramData%\\UniversalAutomation\\database.db",
  17.   }
  18. }
Once the setting has been changed, restart the PowerShell Universal service. We do not recommend keeping Debug logging enabled for production environments unless debugging a problem with the system.

    • Related Articles

    • KB0034 - How to collect logs

      Purpose The purpose of this article is to provide clear ordered steps for users of PowerShell Universal and to submit them to Ironman Software (typically for a support case). Background Having logs from PowerShell Universal is typically needed to ...

    • KB - 1008 Tax/VAT Exempt at checkout

      Scope In this article you will learn how to make a tax-free purchase at checkout. Problem How do you remove the Tax/VAT on an order? Impact Orders will then need to be refunded for tax if processed without the tax deducted. Resolution Follow the ...

    • KB0052 - Collecting IIS Application Pool Recycle Events

      Purpose The purpose of this document is to provide information on how to collect IIS Application Pool recycle events. Application Pool recycling can be problematic for PowerShell Universal servers. Walk Through By default, only three of the eight ...

    • KB0038 - Privilege is not help by client

      Applicability This article applies to users running PowerShell Universal 3.x and 4.x who are attempting to run scripts are alternate users. The issue presents itself as an error while attempting to run scripts that states: Error running script. A ...

    • KB0003 - Slow Endpoints and TLS Settings

      Be advised that if the TLS settings on a Windows Server are modified, this can result in a severe performance degradation Symptom #1 In the Event Viewer (System Log) there are errors with source Schannel indicating that a "fatal error that occurred ...