Breakpoint Status
Breakpoint status is a simple visual indicator designed to give you quick feedback if your Breakpoint is behvaing as expected.
Breakpoint status appears as a lightbulb or a warnning sign next to the Breakpoint on the right pane of the screen.
For more information on a Breakpoint status, you may click it or read more below.
Breakpoint Statuses
To provide quick feedback, Breakpoint statuses are aggregated accross all historic data reported on the Breakpoint.
Whenever you edit the Breakpoint, it's status is reset.
These are the available statuses:
Pending(gray) - the Breakpoint has yet to be applied by any of your applications and no errors have been reported.Active(green) - the Breakpoint has been applied by one or more of your applications has applied the Breakpoint and no errors have been reported.Error(red) - one or more of your applications has reported an error in processing, applying or executing the Breakpoint.Warning(sign) - this state appears in addition to the other states, indicating that one or more of your applications has reported a warning in processing, applying or executing the Breakpoint.
Pending (Gray)
Pending status occurs when none of your applications have yet to apply the Breakpoint and no errors have been reported.
This can be caused by any of the following reasons:
No Application instances
You have no application instances connected to the current project. This is common for Serverless and batch applications which are invoked on demand.
Wrong Source File
The source file you used the set the breakpoint is not loaded in any of the applications in the current project.
(JVM) No Code
You have set the breakpoint on a line that has no executable code associated with it.
(JVM) No Debug Information
You have compiled your classes without debug information.
Gradle and Maven compiles with debug information by default but Ant and javac do not.
Here a few examples on how to configure them:
<javac srcdir="${source-directory}"
destdir="${classes-directory}"
classpath="${lib-directory}"
debug="true"
/>
javac -g MyClass.java
(Node) No Source Maps
You are using a transpiled application without including source maps.
Check out the Rookout source map support section.
(Python/Node) Code is in a Dependency
You are debugging a package deployed as a dependency. This requires setting up your source repository accordingly.
(Python/Node) Different File Layout
File paths are changed between source repository and deployment. This requires setting up your source repository accordingly.
Active Breakpoint (Green)
Active status occurs when one of or more of your applications has applied the Breakpoint and no errors have been reported.
In most cases, once the Breakpoint has transitioned to active, you will see messages collected the next time the line is executed.
If you fail to see any messages arriving, this may be caused by any of the following reasons:
Incorrect Application
You are not invoking the correct line of code in the correct application instance.
Output to Integration
You are using a custom Breakpoint that send the message to another data-sink.
(Python) Preforking
You are using a pre-forking framework. Rookout must only be loaded after forking, check out the documentation.
(Python/JVM) Long Running Function
You have placed a breakpoint on a long running function. In this runtime, breakpoints are only applied for function calls performed after the Breakpoint was created.
Error (Red)
Error status occurs when one of or more of your applications has reported an error in processing, applying or executing the Breakpoint.
Error indicates at least some of your application instances will fail to collect the data requested, but other application instances may be able to collect the data successfully.
Error messages are clearly documented within the IDE, but here are some of the common ones:
Source file has changed
Rookout verifies that the source file you are seeing in our IDE is the file you deploying in your application. If the file version is wrong (detected using an Hash calculation) the Breakpoint will not be set. If you use source commit detection you will see the correct git commit to use on the App instances page.
(Python) Invalid Breakpoint position
The breakpoint has been placed where Rookout cannot set it. This includes empty lines, comments and module-scope code (outside of classes and functions). This may also mean Rookout has been imported too early - in Python it must be imported after all modules has been loaded (read more about it here).
Sending to Rookout is Disabled
The system administrator has disabled sending application data to the Rookout service for security reasons (read more about this configuration here).
Please choose another data sink for your breakpoint.
Breakpoint was Disabled due to Rate-Limiting
Rookout employs a built-in rate-limiting mechanism to prevent breakpoints set in hot code paths from impacting application performance. This error indicates the rate limit has been hit and the breakpoint has been disabled in the offending application instance.
Read more about configuring rate-limiting here.
Invalid JSON Key
The object under the specified JSON key is invalid. Check out the Breakpoint Tasks and the Breakpoint Reference for more information on how to properly configure breakpoints.
Object Name Missing
The specified sub-configuration is missing the key name which specifies the object name. Check out the Breakpoint Tasks and the Breakpoint Reference for more information on how to properly configure breakpoints.
Object Name Unknown
The specified object name is unknown. Check out the Breakpoint Tasks and the Breakpoint Reference for more information on how to properly configure breakpoints.
Object Configuration is Invalid
The specified JSON sub-configuration is invalid. Check out the Breakpoint Tasks and the Breakpoint Reference for more information on how to properly configure breakpoints.
Invalid Path in Breakpoint Configuration
The breakpoint contains a invalid path argument. Check out the Breakpoint Tasks and the Breakpoint Reference for more information on how to properly configure breakpoints.
Note: If Rookout deems the invalid configuration to be non-critical, this might show up as a warning instead.
Warning (Sign)
Warning status occurs when one of or more of your applications has reported a warning in processing, applying or executing the Breakpoint.
Warning indicates some problems have occured with the Breakpoint, and Rookout is trying it's best to deliver the you requested. This may result in the Breakpoint being executed with full success, partial success, or with no success.
Rookout recommends you fix Warning whent they appear.
Warning messages are clearly documented within the IDE, but here are some of the common ones:
(JVM) Source file not found
Rookout relies on source file hashing to ensure you are debugging the correct version of the files you are trying to debug. In most JVM based languages, please include your source within your Jar/War/Ear archives.
Read more about it on our setup page.
(Node) Original Source Files are Missing
Rookout relies on source file hashing to ensure you are debugging the correct version of the files you are trying to debug. For transpiled JS/TS/CS, please deploy your original sources side-by-side with the transpiled ones or include sources within the source map.
Read more about it on our setup page.
Attribute Not Found
The specified attribute does not exist on the given namespace.
Key Not Found
The specified key does not exist on the given namespace.
Method Not Found
The specified method does not exist on the given namespace.
Write Not Supported
The specified namespace does not support writing attributes and may only exist on the right side of Set operations.
Path Read Only
The specified path (usuaully a method call or key lookup) oes not support writing and may only exist on the right side of Set operations.