Class MetricsServiceGrpc.MetricsServiceBlockingV2Stub

java.lang.Object

io.grpc.stub.AbstractStub<MetricsServiceGrpc.MetricsServiceBlockingV2Stub>

io.grpc.stub.AbstractBlockingStub<MetricsServiceGrpc.MetricsServiceBlockingV2Stub>

com.soulfiremc.grpc.generated.MetricsServiceGrpc.MetricsServiceBlockingV2Stub

Enclosing class:

MetricsServiceGrpc

public static final class MetricsServiceGrpc.MetricsServiceBlockingV2Stub
extends io.grpc.stub.AbstractBlockingStub<MetricsServiceGrpc.MetricsServiceBlockingV2Stub>

A stub to allow clients to do synchronous 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.MetricsServiceBlockingV2Stub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
GetInstanceMetricsResponse	getInstanceMetrics(GetInstanceMetricsRequest request)	Returns time-series metrics and current distributions for an instance.
GetServerMetricsResponse	getServerMetrics(GetServerMetricsRequest request)	Returns server-level system metrics (CPU, memory, threads, GC, aggregate bots).

Methods inherited from class io.grpc.stub.AbstractBlockingStub

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.MetricsServiceBlockingV2Stub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<MetricsServiceGrpc.MetricsServiceBlockingV2Stub>

getInstanceMetrics

public GetInstanceMetricsResponse getInstanceMetrics(GetInstanceMetricsRequest request)
                                              throws io.grpc.StatusException

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

Throws:

io.grpc.StatusException

getServerMetrics

public GetServerMetricsResponse getServerMetrics(GetServerMetricsRequest request)
                                          throws io.grpc.StatusException

Returns server-level system metrics (CPU, memory, threads, GC, aggregate bots).
Supports incremental fetching via the "since" parameter.
Requires: READ_SERVER_CONFIG global permission

Throws:

io.grpc.StatusException