Significance of log level in server log

 Hi @TatRajatM,

Log levels and types will be used to write the logs for each operation in the FSM application.

Example -

TR - Tracing

DB - Database

EX - Exception, etc.

As you have mentioned in the question, log levels are 0-9 which is defined in the baseline source code. If you set the EX log level 6 means, it will extract all the Exception type logs less than or equal to 6.

Hi ​​​@TatRajatM ,

Logging is enabled through the FSM Smart Client and is written by the FSM Server. Logs can be viewed and saved from the FSM Smart Client’s Studio.

a. Business Rules (BR) – Tracks business rules and their operations.

b. Communication (CM) – Covers information sent to and from FSM.

c. Database (DB) – Shows database interaction and usage.

d. Exception (EX) – Details unexpected results from the application.

e. Information (IN) – Explains how the system is currently functioning.

f. Tracing (TR) – Tracks processes in the system.

g. User Interface(UI Designer/ UI) – Covers UI interaction with users.

h. Custom Information (CI) – Can be used by customizations.

i. Custom Exception (CE)  – Can be used by customizations.

Each category has a level between 0 – 10. For most categories, 0 means that nothing will be logged. Each level contains the logging from all of the lower levels as well.

Facts to concern about when changing the server log levels

•  Logging effects performance. Be selective when enabling it, and turn it off once you are done. Do not set all logging on and at level 9. This will result in a huge log file, too verbose to be useful.
• Log files are periodically “rolled”. The log file will be compressed. It will be renamed, with a time stamp. A new log file will be started.

ENABLING AND DISABLING LOGGING

• Settings are adjusted from the Server Log screen (Studio/Tools/Server Log).
• To change a level, click the level field for the category to change and select the new level. Hit Save.  Before changing levels, click the Get Server Log button. This will “roll” the log and will give you a new log file to start with.
• After changing levels, perform the action you want to log. Then click the Get Server Log button to get the resulting log file.

Few examples of server log types and functionality of their log levels

1. Type - BUSINESS RULES

• 0 for → Disables logging of this type.
• 1 for → Logs business rule operations.
• 3 for → Logs XML business rule run details.
• 9 for →  Logs service monitor engine run details. For example, Batch Sync in mobile or time commitment processing.

2. Type - COMMUNICATION 

• 0 for → Disables logging of this type.
• 1 for → Logs SMTP (email) listener communications.
• 3 for → Logs communication with the dynamic scheduling engine.

3. Type - DataBase

( we have to be extra careful when it comes to changing the log levels of database type, since this might cause of high impact on FSM-application performance. Always make sure to, turn on for specific test, then reset to 0 after use)

• 0 for →Disables logging of this type.
• 3 for →Logs the establishment of the database connection pool.
• 6 for →Logs SQL statements including the SQL before parameter substitution is applied.
• 7 for →Logs transaction id generation.
• 8 for →Logs all connection and reader operations.
• 9 for →Logs miscellaneous connection details.

4. Type - Exception

• 0 for →Disables logging of this type
• 1 for →Logs exceptions that are normally unexpected. Some exceptions may be normal depending on the implementation.
• 2 for →Logs system exceptions.
• 5 for →Logs geocoding and tenancy exceptions.
• 7 for →Logs query helper exceptions.
• 8 for →Logs message queue exceptions.
• 9 for →Logs all exceptions except tenant and constraint exceptions. Includes a stack trace of the exception which can be used by IFS Support.
• 10 for →Logs all exceptions

5. Type - Information

• 0 for →Logs server startup information.
• 1 for →Logs server resource information such as thread pool settings.
• 7 for →Logs token process details.
• 8 for →Logs miscellaneous information including retry operations.
• 9 for →Logs miscellaneous information including extract details.
• 10 for →Logs miscellaneous information including metadata and tenant information.

5. Type - Information

• 0 for →Logs server startup information.
• 1 for →Logs server resource information such as thread pool settings.
• 7 for →Logs token process details.
• 8 for →Logs miscellaneous information including retry operations.
• 9 for →Logs miscellaneous information including extract details.
• 10 for →Logs miscellaneous information including metadata and tenant information

6. Type - Tracing

• 0 for →Disables logging of this type.
• 2 for →Logs service request entry and exit.
• 4 for →Logs failed perform message details.
• 5 for →Logs incoming XML messages.
• 6 for →Logs outgoing XML responses with the elapsed processing time.
• 9 for →Logs internal thread startup and miscellaneous web service calls.

7. Type - UI Designer

• 0 for →Disables logging of this type.
• 1 for →Logs loading of custom client assemblies.

Best Regards, 

Induwari