IntelliJ Platform Plugin SDK Help

IDE Infrastructure

Logging

The IntelliJ platform uses Logger abstraction class to shield from underlying logging implementation and configuration.

Plugins should obtain a dedicated instance:

import com.intellij.openapi.diagnostic.Logger; public class MyPluginFunctionality { private static final Logger LOG = Logger.getInstance(MyPluginFunctionality.class); public void someMethod() { LOG.info("someMethod() was called"); } }
private val LOG = logger<MyPluginFunctionality>() class MyPluginFunctionality { fun someMethod() { LOG.info("someMethod() was called") } }

If logging is used only to report exceptions, use convenience method thisLogger():

try { // some code } catch (e: Throwable) { thisLogger().error("some code failed", e) }

By default, all messages with level INFO and higher are written to log output file idea.log. To enable DEBUG/ TRACE logging for specific categories, use Help | Diagnostic Tools | Debug Log Settings.

To locate the log file, choose the Help | Show Log in Finder/Explorer action. When internal mode is enabled, the currently running IDE log file can be opened using Help | Open Log in Editor.

To locate it for a specific installation, see this Knowledge Base article. See Development Instance Sandbox Directory on how to find it for development instances.

See Testing FAQ on how to enable DEBUG/ TRACE level logging during tests, and obtain separate logs for failing tests.

To provide additional context for reporting fatal errors, use Logger.error() methods taking additional Attachment (see AttachmentFactory).

Error Reporting

Fatal errors and logging messages with ERROR level will be shown in the IDE Fatal Errors dialog for EAP releases or when running in internal mode. For errors caused by third-party plugins, reporting is disabled by default - instead, there's an option to disable the plugin causing the exception.

To let users report such errors to the vendor, plugins can implement custom ErrorReportSubmitter registered in extension point com.intellij.errorHandler. See IntelliJ Platform Explorer for existing implementations - ranging from pre-filling web-based issue tracker forms to fully automated submission to log monitoring systems.

Runtime Information

ApplicationInfo provides information on the IDE version and vendor. NOTE: to restrict compatibility, declare IDEs and versions via plugin.xml.

To obtain information about OS and Java VM, use SystemInfo.

To access relevant configuration directories, see PathManager.

Context Help

To show custom context web-based help for your plugin's functionality (e.g., for dialogs), provide WebHelpProvider registered in com.intellij.webHelpProvider extension point.

Last modified: 15 September 2021