Class MetricsServiceGrpc.MetricsServiceFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<MetricsServiceGrpc.MetricsServiceFutureStub>
io.grpc.stub.AbstractFutureStub<MetricsServiceGrpc.MetricsServiceFutureStub>
com.soulfiremc.grpc.generated.MetricsServiceGrpc.MetricsServiceFutureStub
Enclosing class:
MetricsServiceGrpc
public static final class MetricsServiceGrpc.MetricsServiceFutureStub extends io.grpc.stub.AbstractFutureStub<MetricsServiceGrpc.MetricsServiceFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service MetricsService. 
Service for retrieving instance metrics and monitoring data.
Metrics are collected server-side and stored in a ring buffer.
All operations require appropriate permissions.

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

    io.grpc.stub.AbstractStub.StubFactory<T>

  • Method Summary

    Modifier and Type
    Method
    Description
    protected MetricsServiceGrpc.MetricsServiceFutureStub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    com.google.common.util.concurrent.ListenableFuture<GetInstanceMetricsResponse>
    getInstanceMetrics(GetInstanceMetricsRequest request)
    Returns time-series metrics and current distributions for an instance.
    com.google.common.util.concurrent.ListenableFuture<GetServerMetricsResponse>
    getServerMetrics(GetServerMetricsRequest request)
    Returns server-level system metrics (CPU, memory, threads, GC, aggregate bots).

    Methods inherited from class io.grpc.stub.AbstractFutureStub

    newStub, newStub

    Methods inherited from class io.grpc.stub.AbstractStub

    getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

    Methods inherited from class Object

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

  • Method Details

    • build

      protected MetricsServiceGrpc.MetricsServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<MetricsServiceGrpc.MetricsServiceFutureStub>

    • getInstanceMetrics

      public com.google.common.util.concurrent.ListenableFuture<GetInstanceMetricsResponse> getInstanceMetrics(GetInstanceMetricsRequest request)
      Returns time-series metrics and current distributions for an instance.
Supports incremental fetching via the "since" parameter.
Requires: READ_BOT_INFO permission on the instance
Errors: NOT_FOUND if instance does not exist

    • getServerMetrics

      public com.google.common.util.concurrent.ListenableFuture<GetServerMetricsResponse> getServerMetrics(GetServerMetricsRequest request)
      Returns server-level system metrics (CPU, memory, threads, GC, aggregate bots).
Supports incremental fetching via the "since" parameter.
Requires: READ_SERVER_CONFIG global permission