Interface CriticalProblemDetector
-
public interface CriticalProblemDetector
A critical problem detector is used to detect when an important issue is currently present that must be communicated to the user. These will appear at the top of the status / systems / overview page. To be used judiciously!
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.String
getDescription()
A brief description of what the issue means, like "Two threads are stuck waiting for each other's locks" or "The system is using more than 90% of available memory"java.lang.String
getResolutionText()
A brief explanation of what can be done to resolve this issue, like "Please send the current thread dump to technical support and restart your gateway." or "Edit ignition.conf to allocate more memory or split the tasks of this gateway between multiple gateways."default java.util.Optional<java.lang.String>
getResolutionUrl()
If present, the resolution text will become a URL to navigate the user to an appropriate place where an action to resolve the issue can be performed.java.lang.String
getTitle()
A 1-3 word title of the issue, like "Deadlock Detected" or "Memory Full"boolean
isActive(GatewayContext context)
Called to check if this problem is currently active.
-
-
-
Method Detail
-
isActive
boolean isActive(GatewayContext context)
Called to check if this problem is currently active. Should be a fast, computationally inexpensive call.
-
getTitle
java.lang.String getTitle()
A 1-3 word title of the issue, like "Deadlock Detected" or "Memory Full"
-
getDescription
java.lang.String getDescription()
A brief description of what the issue means, like "Two threads are stuck waiting for each other's locks" or "The system is using more than 90% of available memory"
-
getResolutionText
java.lang.String getResolutionText()
A brief explanation of what can be done to resolve this issue, like "Please send the current thread dump to technical support and restart your gateway." or "Edit ignition.conf to allocate more memory or split the tasks of this gateway between multiple gateways."
-
getResolutionUrl
default java.util.Optional<java.lang.String> getResolutionUrl()
If present, the resolution text will become a URL to navigate the user to an appropriate place where an action to resolve the issue can be performed.
-
-