Package com.opencloud.monitoring

Interface ParameterSet

  • public interface ParameterSet

    The client view of a ParameterSet. Most instances of ParameterSet also implement one or more type-specific interfaces that allow collection of specific statistics.

    • Method Detail

      • getNamespace

        String getNamespace()

        Get the namespace this parameter set exists in.

        Returns:
        the namespace. May be null if the parameter set resides in the global environment.

      • getTypeName

        String getTypeName()

        Get the name of this parameter set’s type.

        Returns:
        the type name.

      • getName

        String getName()

        Get the name of this parameter set

        The name of a parameter set corresponds to the last part of the parameter sets fully qualified key.

      • getKey

        String getKey()

        Get the fully qualified key of the parameter set

        A parameter sets fully qualified key begins with the parameter set type name, followed by the names of any parameter parameter sets (oldest first) and finally the name of the parameter set itself.

      • createChild

        ParameterSet createChild​(String name)

        Create a new child parameter set with the given name, and return it.

      • getParent

        ParameterSet getParent()

        Return the parent parameter set, or null if this is the root

      • getStatisticNames

        String[] getStatisticNames()

        Return the names of all statistics, ordered by ID.

      • getCounters

        long[] getCounters​(int[] ids)
            throws UnrecognizedStatisticException

        Returns an array of counter values corresponding to the array of statistic IDs specified as the argument.

        Parameters:
        ids - an array of statistic IDs to retrieve
        Returns:
        an array of counter values, ordered in the same order as the input array
        Throws:
        UnrecognizedStatisticException - if one or more ids does not corresponding to a valid statistic ID.

      • getCounter

        long getCounter​(int id)
         throws UnrecognizedStatisticException

        Returns a single counter value corresponding to the specified statistic ID.

        Parameters:
        id - the statistic ID to retrive
        Returns:
        the current counter value
        Throws:
        UnrecognizedStatisticException - if id is not a valid statistic ID