Module is.codion.framework.server
Package is.codion.framework.server

Interface OperationLatencyMXBean

public interface OperationLatencyMXBean
Exposes the server-side latency of a single operation type as a JMX MXBean, registered as is.codion:type=OperationLatency,operation=<operation> on the platform MBean server when EntityServerConfiguration.JMX is enabled. One MBean is registered per operation as it is first encountered. This is the always-on duration histogram folded per operation type, distinct from the per-client method traces which remain an on-demand RMI debugging tool.

The values are cumulative and map directly onto a Prometheus histogram: getCount() is the +Inf bucket, getBuckets() provides the finite buckets and getSum() the sum.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Long>
    getBuckets()
    The cumulative observation counts keyed by the bucket upper bound in seconds, in other words the number of observations at or below each bound, in Prometheus histogram layout.
    long
    getCount()
     
    double
    getSum()
     

  • Method Details

    • getCount

      long getCount()
      Returns:
      the total number of times the operation has been served since server startup

    • getSum

      double getSum()
      Returns:
      the sum of all observed durations, in seconds

    • getBuckets

      Map<String,Long> getBuckets()
      The cumulative observation counts keyed by the bucket upper bound in seconds, in other words the number of observations at or below each bound, in Prometheus histogram layout. The final +Inf bucket equals getCount().
      Returns:
      the histogram buckets, keyed by upper bound in seconds (and +Inf)