Class OsStats.Cgroup.CpuStat

java.lang.Object
org.opensearch.monitor.os.OsStats.Cgroup.CpuStat
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
Enclosing class:
OsStats.Cgroup

@PublicApi(since="1.0.0") public static class OsStats.Cgroup.CpuStat extends Object implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentFragment
Encapsulates CPU time statistics.
Opensearch.api:
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>
  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
    CpuStat(long numberOfElapsedPeriods, long numberOfTimesThrottled, long timeThrottledNanos)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    long
    The number of elapsed periods.
    long
    The number of times tasks in the control group have been throttled.
    long
    The total time duration for which tasks in the control group have been throttled.
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment
  • Constructor Details

    • CpuStat

      public CpuStat(long numberOfElapsedPeriods, long numberOfTimesThrottled, long timeThrottledNanos)
  • Method Details

    • getNumberOfElapsedPeriods

      public long getNumberOfElapsedPeriods()
      The number of elapsed periods.
      Returns:
      the number of elapsed periods as measured by cpu.cfs_period_us
    • getNumberOfTimesThrottled

      public long getNumberOfTimesThrottled()
      The number of times tasks in the control group have been throttled.
      Returns:
      the number of times
    • getTimeThrottledNanos

      public long getTimeThrottledNanos()
      The total time duration for which tasks in the control group have been throttled.
      Returns:
      the total time in nanoseconds
    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException
    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException