Interface Metric


  • public interface Metric
    Represents one measure of product usage.

    The time interval of a metric is determined by the Usage instance from which the metric was obtained; see ProductExtension.getCurrentUsage().

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String TYPE_CPU_TIME
      The CPU time used by the application server process over the last usage metering interval.
      static java.lang.String TYPE_JAVA_COMMITTED_MEMORY
      The memory currently committed to the application server process.
      static java.lang.String TYPE_JAVA_INIT_MEMORY
      The initial memory requested for the application server process.
      static java.lang.String TYPE_JAVA_MAX_MEMORY
      The maximum memory available to the application server process.
      static java.lang.String TYPE_JAVA_MEMORY_AFTER_GC
      The memory reported as used by the application server process immediately after the last garbage collection.
      static java.lang.String TYPE_JAVA_USED_MEMORY
      The memory currently used by the application server process.
      static java.lang.String TYPE_PROCESSOR_CORES
      The number of physical processors or logical processors (when hyper-threading is present) available to the application server process.
      static java.lang.String TYPE_SERVLET_REQUESTS
      The number of servlet requests that occurred during the last usage metering interval.
      static java.lang.String TYPE_TOTAL_PHYSICAL_MEMORY
      The total physical memory available to the operating system.
    • Field Detail

      • TYPE_PROCESSOR_CORES

        static final java.lang.String TYPE_PROCESSOR_CORES
        The number of physical processors or logical processors (when hyper-threading is present) available to the application server process. The value reported will correspond to the value provided by Runtime.availableProcessors() unless CPU resources have been limited using Linux control groups or the --cpus option for Docker.

        This is a core metric provided by the WebSphere usage metering feature.

        See Also:
        Constant Field Values
      • TYPE_CPU_TIME

        static final java.lang.String TYPE_CPU_TIME
        The CPU time used by the application server process over the last usage metering interval. The value reported corresponds the value provided by OperatingSystemMXBean.getProcessCpuTime(). This is a core metric provided by the WebSphere usage metering feature.
        See Also:
        Constant Field Values
      • TYPE_JAVA_INIT_MEMORY

        static final java.lang.String TYPE_JAVA_INIT_MEMORY
        The initial memory requested for the application server process. The value reported corresponds to java.lang.management.MemoryUsage.getInit. This is a core metric provided by the WebSphere usage metering feature.
        See Also:
        Constant Field Values
      • TYPE_JAVA_USED_MEMORY

        static final java.lang.String TYPE_JAVA_USED_MEMORY
        The memory currently used by the application server process. The value reported corresponds to java.lang.management.MemoryUsage.getUsed. This is a core metric provided by the WebSphere usage metering feature.
        See Also:
        Constant Field Values
      • TYPE_JAVA_COMMITTED_MEMORY

        static final java.lang.String TYPE_JAVA_COMMITTED_MEMORY
        The memory currently committed to the application server process. The value reported corresponds to java.lang.management.MemoryUsage.getCommitted. This is a core metric provided by the WebSphere usage metering feature.
        See Also:
        Constant Field Values
      • TYPE_JAVA_MAX_MEMORY

        static final java.lang.String TYPE_JAVA_MAX_MEMORY
        The maximum memory available to the application server process. The value reported corresponds to java.lang.management.MemoryUsage.getMax. This is a core metric provided by the WebSphere usage metering feature.
        See Also:
        Constant Field Values
      • TYPE_JAVA_MEMORY_AFTER_GC

        static final java.lang.String TYPE_JAVA_MEMORY_AFTER_GC
        The memory reported as used by the application server process immediately after the last garbage collection. This metric is JVM specific and is not available on all JVMs. This is a core metric provided by the WebSphere usage metering feature.
        See Also:
        Constant Field Values
      • TYPE_SERVLET_REQUESTS

        static final java.lang.String TYPE_SERVLET_REQUESTS
        The number of servlet requests that occurred during the last usage metering interval. This metric is only provided when monitoring is enabled. This is a core metric provided by the WebSphere usage metering feature.
        See Also:
        Constant Field Values
      • TYPE_TOTAL_PHYSICAL_MEMORY

        static final java.lang.String TYPE_TOTAL_PHYSICAL_MEMORY
        The total physical memory available to the operating system. The value reported is provided by the OperatingSytem MBean. This is a core metric provided by the WebSphere usage metering feature.
        See Also:
        Constant Field Values
    • Method Detail

      • getMetricType

        java.lang.String getMetricType()
        The type of the metric being provided.
        Returns:
        the type of the metric being provided
      • getMetricValue

        java.lang.Number getMetricValue()
        The value of the metric being measured.
        Returns:
        the value of the metric being measured