K2 logging configuration
Logging features of K2 are separated into installation logging and runtime logging. Installation logging starts automatically when the K2 Setup Manager begins installing K2. Runtime logging occurs when the K2 environment is operational, is configurable and (except for K2 host server logging) can be enabled or disabled.
Use this topic to see the available system logging options in K2, and use the links to learn more about configuring these logging outputs. You may need to enable and/or configure logging to obtain the necessary log output for your requirement; the linked topics contain more information about the configuration and output of these logging features.
Log Type | Automatically Enabled? | Configurable? | Notes |
---|---|---|---|
Installer | Yes | No | The installation trace log starts when you run the Setup Manager. Use the installation log for error reporting and to troubleshoot an installation. |
Host Server Console Mode | No | Yes | Run K2 Host Server in console mode to see real-time activity in K2 Host Server. This is useful when troubleshooting performance issues, authentication issues and issues when K2 service fails to start |
Host Server | Yes | Yes | Enable and configure logging on the K2 application server to output different levels of logging information to different target locations. Levels of logging detail and output locations are determined by the configuration of this logging feature. |
SmartObject Server | No | Yes | Outputs logging information about runtime execution of SmartObjects. Typically used to investigate or troubleshoot SmartObject execution and. |
Active Directory User Manager | No | Yes | Outputs logging information specific to the Active Directory User Manager. Typically used to investigate or troubleshoot issues with Active Directory. |
Workflow REST API and OData API | No | Yes | Outputs logging information for the Workflow REST API and the SmartObjects OData API. Typically used to investigate or troubleshoot issues with these APIs, such as when custom code attempts to use these services. |
SmartForms Runtime Website | No | Yes | Outputs logging information regarding the runtime use of SmartForms. Typically used to debug Forms and Views. |
Error handling, logging and new rendering configuration settings for the PDF Converter Service | No | No | Outputs information specific to the K2 PDF Converter SmartObjects. |
K2 Workspace (Mobile) | Yes | No |
Event logs for the K2 Workspace (Mobile) app for iOS and Android are available in each app. Logging starts when the mobile application launches. |
It's recommended that you restart the IIS server using the iisreset command, and restart the K2 Server service after you have made changes to config files.