OpenMetadata/docs/open-source-community/developer/backend/debugging.md

# Debugging

We primarily rely on IntelliJ for debugging backend codebase. 

The following steps will help you get up and running with IntelliJ. 
For learning advanced debugging skills with IntellJ, please refer IntelliJ's official [documentation](https://www.jetbrains.com/help/idea/debugging-code.html).

## Set up Breakpoints

Identify the statements of interest in the codebase and set up breakpoints, by clicking on the left margin (red dot indicates a break point).

![Setting breakpoints](../../../../.gitbook/assets/breakpoint.png)

You may add more breakpoints while the debugger is running.

## Run the App in Debug mode

Start the OpenMetadata CatalogApplication in Debug mode from the Run menu.

![Run in Debug Mode](../../../../.gitbook/assets/run-debug.png)

Check the bottom panel to ensure that the Debugger started successfully.

![Check Debugger](../../../../.gitbook/assets/check-debugger.png)

## Inspect the Codebase

Invoke the statement of interest through a preferable methodology (running unit test or through actual API call).

![Running Test in Debug Mode](../../../../.gitbook/assets/test-debug.png)

![Make API Call](../../../../.gitbook/assets/make-api-call.png)

The debugger will pause execution as it encounters a breakpoint.
Use the Step actions as needed to step through the codebase.
Inspect variables in the variables tab to see if they have the expected values.

![Using Debugger](../../../../.gitbook/assets/use-debugger.png)