Guide Diagnostics in Checkbot - idea-statica/ideastatica-public GitHub Wiki

Within the checkbot framework, we provide the ability to log events within diagnostics files associated with your projects. It should provide users with information about limitations and restrictions to the plug-in.

It is important to enable this feature to give users the ability to drill down into problems they may be facing when importing or running a third-party plug-in.

Accessing Diagnostics Files

The log file is located in the users's temp folder:

 _C:\Users\USER NAME\AppData\Local\Temp\IdeaStatiCa\Logs\IdeaStatiCaCodeCheckManager.log_. 

Our diagnostics uses a rolling file sink. If the size of a log file exceeds a limit a new log file is added e.g. IdeaStatiCaCodeCheckManager_001.log.

The diagnostics log files can also be opened directly from our example application - see the button Show CCM Log.

Setting of the severity of messages in the log file

The severity level of messages which are written into a log file can be configured in the file IdeaDiagnostics.config which can be found in the IdeaStatiCa temp folder:

C:\Users\USER NAME\AppData\Local\IDEA_RS\IdeaDiagnostics.config

<IdeaDiagnosticsSettings>
	<DefaultLogLevel loglevel="Debug"/>
	<!-- <LoggerLogLevel loggername="app.program" loglevel="Debug"/> -->
	<!-- <DebugView active="false"/> -->
</IdeaDiagnosticsSettings>

The default value of Severity is Information. If it is changed to Debug or Trace more details are written to the log file.