Class Metrics

java.lang.Object
com.zeroc.Ice.Value
com.zeroc.IceMX.Metrics
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
ChildInvocationMetrics, ConnectionMetrics, DispatchMetrics, InvocationMetrics, SessionMetrics, SubscriberMetrics, ThreadMetrics, TopicMetrics

public class Metrics extends Value
The base class for metrics. A metrics object represents a collection of measurements associated to a given a system.
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    The number of objects currently observed by this metrics.
    int
    The number of failures observed.
    The metrics identifier.
    long
    The total number of objects observed by this metrics.
    long
    The sum of the lifetime of each observed objects.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructs a Metrics.
    Metrics(String id, long total, int current, long totalLifetime, int failures)
    Constructs a Metrics with values for all its fields.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a copy of the object.
    Returns the Slice type ID of the most-derived interface supported by this object.
    static String
    Gets the type ID of the associated Slice interface.

    Methods inherited from class com.zeroc.Ice.Value

    ice_getSlicedData, ice_postUnmarshal, ice_preMarshal

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • id

      public String id
      The metrics identifier.
    • total

      public long total
      The total number of objects observed by this metrics. This includes the number of currently observed objects and the number of objects observed in the past.
    • current

      public int current
      The number of objects currently observed by this metrics.
    • totalLifetime

      public long totalLifetime
      The sum of the lifetime of each observed objects. This does not include the lifetime of objects which are currently observed, only the objects observed in the past.
    • failures

      public int failures
      The number of failures observed.
  • Constructor Details

    • Metrics

      public Metrics()
      Constructs a Metrics.
    • Metrics

      public Metrics(String id, long total, int current, long totalLifetime, int failures)
      Constructs a Metrics with values for all its fields.
      Parameters:
      id - The metrics identifier.
      total - The total number of objects observed by this metrics.
      current - The number of objects currently observed by this metrics.
      totalLifetime - The sum of the lifetime of each observed objects.
      failures - The number of failures observed.
  • Method Details

    • clone

      public Metrics clone()
      Description copied from class: Value
      Returns a copy of the object. The cloned object contains field-for-field copies of the state.
      Overrides:
      clone in class Value
      Returns:
      The cloned object.
    • ice_staticId

      public static String ice_staticId()
      Gets the type ID of the associated Slice interface.
      Returns:
      the string "::IceMX::Metrics"
    • ice_id

      public String ice_id()
      Returns the Slice type ID of the most-derived interface supported by this object.
      Overrides:
      ice_id in class Value
      Returns:
      The return value is always ::Ice::Object.