Package com.inductiveautomation.ignition.gateway.metrics

Interface CriticalHealthCheck

public interface CriticalHealthCheck
Use to add context to a HealthCheck and include it on the Ignition Gateway's Diagnostic Overview page.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 Optional<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.
    String
    getTitle()
    A 1-3 word title of the issue, like "Deadlock Detected" or "Memory Full"

  • Method Details

    • getTitle

      String getTitle()
      A 1-3 word title of the issue, like "Deadlock Detected" or "Memory Full"

    • getResolutionText

      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 Optional<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.