Logging Best Practices
When you configure logging for custom validators, Event Handlers, and System Jobs on your Service Board tenant, be sure to implement appropriate log types for the relevant use cases.
 |
You can access logs via the Application Logs menu option on the System Management (  ) launchpad menu in Max Admin. Log types appear in the Name column. |
Logging Types
• User Activity: Use this log type to track user activity in Application Log records. User activity is recorded in separate Application Log records to support visualization and troubleshooting. The default log level is set to ERROR in Application Log Type records with a Name field value of User. Logging levels are configured in Application Log Level fields in User Parameter records. To use this log type, get the logger in custom source code by using the iop_application_logger parameter configured for the related Operation.
• System Job: Use this log type to track specific activities of scheduled System Jobs. The default log level is set to ERROR in Application Log Type records that are named System Job. Logging levels are configured in Log Level fields in System Job records. Get the logger in custom source code by using the iop_application_logger parameter specified for the Operation related to a specific System Job.
Logging Best Practices
• Change Application Log Levels in User Parameter records only when necessary.
Typically, changes to user activity logging levels is necessary during development or troubleshooting. When these processes are completed, restore the default logging level of ERROR to prevent the system from writing excessive logs, which can impact performance and absorb excessive disk space.
• Write meaningful log messages.
Be sure that log messages are clear and descriptive to help users understand system behavior. To best support users, keep log message volume to a moderate level.
• Avoid logging sensitive information.
Sensitive information such as passwords, private keys, authorization tokens, and credit-related PII (Personally Identifiable Information) should not be logged.
For more information: