Module org.elasticsearch.server
Package org.elasticsearch.http

Record Class HttpRouteStats

java.lang.Object
java.lang.Record
org.elasticsearch.http.HttpRouteStats
Record Components:
requestCount - the number of request handled by the HTTP route
totalRequestSize - the total body size (bytes) of requests handled by the HTTP route
requestSizeHistogram - an array of frequencies of request size (bytes) in buckets with upper bounds as returned by HttpRouteStatsTracker.getBucketUpperBounds(), plus an extra bucket for handling size larger than the largest upper bound (currently 64MB).
responseCount - the number of responses produced by the HTTP route
totalResponseSize - the total body size (bytes) of responses produced by the HTTP route
responseSizeHistogram - similar to requestSizeHistogram but for response size
responseTimeHistogram - an array of frequencies of response time (millis) in buckets with upper bounds as returned by HandlingTimeTracker.getBucketUpperBounds(), plus an extra bucket for handling response time larger than the longest upper bound (currently 65536ms).
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject
public record HttpRouteStats(long requestCount, long totalRequestSize, long[] requestSizeHistogram, long responseCount, long totalResponseSize, long[] responseSizeHistogram, long[] responseTimeHistogram) extends Record implements Writeable, ToXContentObject
This class encapsulates the stats for a single HTTP route MethodHandlers

  • Constructor Details

    • HttpRouteStats

      public HttpRouteStats(StreamInput in) throws IOException
      Throws:
      IOException

    • HttpRouteStats

      public HttpRouteStats(long requestCount, long totalRequestSize, long[] requestSizeHistogram, long responseCount, long totalResponseSize, long[] responseSizeHistogram, long[] responseTimeHistogram)
      Creates an instance of a HttpRouteStats record class.
      Parameters:
      requestCount - the value for the requestCount record component
      totalRequestSize - the value for the totalRequestSize record component
      requestSizeHistogram - the value for the requestSizeHistogram record component
      responseCount - the value for the responseCount record component
      totalResponseSize - the value for the totalResponseSize record component
      responseSizeHistogram - the value for the responseSizeHistogram record component
      responseTimeHistogram - the value for the responseTimeHistogram record component

  • Method Details

    • toXContent

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

    • merge

      public static HttpRouteStats merge(HttpRouteStats first, HttpRouteStats second)

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • equals

      public boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • hashCode

      public int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • requestCount

      public long requestCount()
      Returns the value of the requestCount record component.
      Returns:
      the value of the requestCount record component

    • totalRequestSize

      public long totalRequestSize()
      Returns the value of the totalRequestSize record component.
      Returns:
      the value of the totalRequestSize record component

    • requestSizeHistogram

      public long[] requestSizeHistogram()
      Returns the value of the requestSizeHistogram record component.
      Returns:
      the value of the requestSizeHistogram record component

    • responseCount

      public long responseCount()
      Returns the value of the responseCount record component.
      Returns:
      the value of the responseCount record component

    • totalResponseSize

      public long totalResponseSize()
      Returns the value of the totalResponseSize record component.
      Returns:
      the value of the totalResponseSize record component

    • responseSizeHistogram

      public long[] responseSizeHistogram()
      Returns the value of the responseSizeHistogram record component.
      Returns:
      the value of the responseSizeHistogram record component

    • responseTimeHistogram

      public long[] responseTimeHistogram()
      Returns the value of the responseTimeHistogram record component.
      Returns:
      the value of the responseTimeHistogram record component