Logging Settings
  • 18 May 2022
  • 3 Minutes to read
  • Dark
    Light

Logging Settings

  • Dark
    Light

Advanced Content - Use Caution!
Contact a System Administrator to configure/adjust settings within this article to avoid platform errors and risk of downtime.

Additionally, Settings.xml should be backed up before making any changes to the Logging Settings.

Overview

Through various methods, Administrators are provided options that allow the configuration of various logging parameters parameters such as Log File Size, API Call Timeouts, and Database Timeouts that are recorded in the Decisions Logs.

These settings affect Logs that are recorded in the Logging Tool (System > Administration > System Tools). The following article covers the respective function and configuration of  each Logging Setting.


Available Logging Settings

Logging Setting NameDefault ValueDescription
LogAPICallsTaking
MoreThanSeconds
5Prompts for a time threshold (seconds) that if an API call exceeds will then be recorded in the log.

LogCheckFieldTypes
False
When set to True, verifies the types of fields used in WHERE clauses. Logs under CheckTypesLogger category at Debug, Warn, and Error if it finds mismatch levels
LogDebug/LogInfo
False
When set to True, records event types of this level in the log. Since these levels of event types occur frequently, users may experience performance and/or log size issues as the system continuously records them.
LogError/LogFatal/
LogWarn
True
Records these event types in the log by default as indicated by their True value. Setting this to False stops recording these events in the log.
It is recommended to keep these as True to aid any future troubleshooting. Errors and Fatal Errors are also logged as Windows Events for monitoring by external tools.
LogFileMaxSize
10,485,760
Prompts for the max file size (bytes) of a log.
The default 10,485,760 bytes equates to a maximum limit of about 10.49 MB.
The maximum configurable limit is maxInt32 aka 2,147,483,647 bytes aka 2.14 GB.
LogFlowStepsTaking
MoreThanMilliseconds
1000
Prompts for a time threshold (milliseconds) that if a Flow step exceeds will then be recorded in the log.
The default 1,000 value equates to one second, so any steps taking longer than this will be in the log.
LogMaxBackups
10
Prompts for the maximum amount of backups a Log file can create of itself.
For example, the Decisions Logs folder may contain some log files with the same name but with a number after the name. These numbered logs are backups made before a new log is created.
LogsDirectoryC:\Users\[Name]\Downloads\Logs
Prompts for the file path Installer Logs will reside. This is usually located at the same place as the Installer. This cannot be changed.
LogSqlStatementsTaking
MoreThanSeconds
5Prompts for a time threshold (seconds) that if an SQL statement exceeds will then be recorded in the log.
CaptureAspNetLogsFalseEnables Kestrel Access Logging and generates Asp.net core Logs (file typically contains "Microsoft.AspNetCore" in the Logs/webserverlogs.
CaptureW3CLogsFalseEnables Kestrel Access Logging and generates W3C Logs in Logs/webserverlogs folder. If setting is not present in Settings.xml, the following may be added to enable it:
<CaptureW3CLogs>true</CaptureW3CLogs> 
AspNetLogsFileCountLimit30The number of files retained for AspNet Log; this is used by both CaptureW3CLogs as well as CaptureAspNetLogs. 
AspNetLogsFileSizeLimit104857600
The max size (bytes) of each individual AspNetLog file; this is used by both CaptureW3Logs as well as CaptureAspNetLogs. 

Accessing and Editing Settings

Logging Settings can be accessed through one of the following methods:

Though many Settings can be accessed throughout each method, some Settings, such as ""LogSQLStatementsTakingMoreThanSeconds", require additional configuration or adjustment via Settings.xml or DecisionsServerInstaller.exe.

Decisions Installer 

  1. From DecisionsServerInstaller.exe, click EDIT SETTINGS.
  2. Navigate to Settings containing the word "Log". Adjust the Settings as desired in the column to the right of the Setting's name.

    Once Settings have been established as desired, click Save.
  3. After the Settings have been applied, click RESTART SERVICE. 

Settings.xml File

  1. From C:\Program Files\Decisions\Decisions Server, open Settings.xml in a text editor (ex: Notepad).  
  2. Change the value(s) between the respective Logging open/close tags.

    For example, <LogMaxBackups>10</LogMaxBackups> may be changed to <LogMaxBackups>15</LogMaxBackups>.

  3. Save and close the text editor.
  4. Restart Decisions. 

System Settings 

  1. From the Studio, navigate to the Settings Folder
  2. Open Logging Settings
  3. From the Logging Settings list, select the desired level (in this case File System). 
  4. From the resulting window, Logs can be configured by enabling the desired general Levels via the checkboxes beside each one. 
  5. Logs Categories previously created via the Log step in the Flow Designer, as well as other Log Categories can be added and logged by selecting the ADD link under Log Categories, selecting the Category Name, then enabling each desired Level via the Levels Booleans.

    Additionally, enabling Log To Own File can be used to create separate custom Log files in the Local File System.

  6. If desired, expand the ADVANCED category to control the Log File Max Size (Bytes) and Log File Backup Limit.
  7. Click OK once desired configurations have been made.

LogSettings.json

The LogSettings.json file can be found in the C:\Program Files\Decisions\Decisions Server folder in the File System

This file is used to control the behavior of Logging events at the Local level within the File System. Log Category Settings like Category Name or Level can be adjusted in this file.


After using the Log step, a new Category is automatically created in the LogCategorySettings. The given name for this Category is the name that was previously defined in the Properties tab of the Log step within the Flow



Enabling Web Server Logs in Self Hosted Environments

  1. Navigate to C:\\Program Files\Decisions\Decisions Server
  2. As an Administrator, Open Settings.XML using a text editor (ex: Notepad). 
  3. Change the <CaptureAspNetLogs>...</CaptureAspNetLogs> value from false to true
  4. Save and close Settings.xml.
  5. Restart Decisions.

For further information on Settings, visit the Decisions Forum.

Was this article helpful?

What's Next