Interface SystemHealthIndicator


  • public interface SystemHealthIndicator
    System health indicator.
    • Method Detail

      • getId

        String getId()
        Returns:
        a unique id
      • getCategory

        String getCategory()
        Get the category of this indicator. There are 3 default categories: (see above), but a new category may be returned.
        Returns:
        the category of this indicator
      • getType

        String getType()
        Get the type of this indicator. There are two valid types: TYPE_SYSTEM and TYPE_CUSTOM. WCB developers should use the latter.
        Returns:
        the type of this indicator
      • getName

        String getName​(Locale locale)
        Get name of this performance indicator in the given language.
        Parameters:
        locale - the locale
        Returns:
        the indicators name
      • getValue

        Object getValue()
        Returns:
        the value of this indicator
      • getMessage

        String getMessage​(Locale locale)
        Get an explanatory message in the given language.
        Parameters:
        locale - the current locale
        Returns:
        explanation of what this indicator monitors
      • reset

        void reset()
        Resets the indicator.