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

Interface EntityServerMetricsMXBean

public interface EntityServerMetricsMXBean
Exposes the server-wide Codion metrics as a JMX MXBean, registered as is.codion:type=EntityServer on the platform MBean server when EntityServerConfiguration.JMX is enabled. The JVM thread, garbage collection, CPU and memory metrics are already available as platform MXBeans, so only the Codion-specific metrics are exposed here.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getConnectionCount()
     
    int
    getConnectionLimit()
     
    long
    getRequestCount()
    The cumulative request count, a monotonically increasing counter suitable for deriving a request rate at the consumer (for example with the Prometheus rate() function).

  • Method Details

    • getRequestCount

      long getRequestCount()
      The cumulative request count, a monotonically increasing counter suitable for deriving a request rate at the consumer (for example with the Prometheus rate() function).
      Returns:
      the number of requests served since server startup

    • getConnectionCount

      int getConnectionCount()
      Returns:
      the current number of connected clients

    • getConnectionLimit

      int getConnectionLimit()
      Returns:
      the maximum number of concurrent connections, -1 if no limit is set