soulfire.metrics_connect.MetricsServiceClient¶
- class soulfire.metrics_connect.MetricsServiceClient(address: str, *, codec: connectrpc.codec.Codec | None = _PROTO_BINARY_CODEC, protocol: connectrpc.protocol.ProtocolType = ProtocolType.CONNECT, accept_compression: collections.abc.Iterable[connectrpc.compression.Compression] | None = None, send_compression: connectrpc.compression.Compression | None = _GZIP_COMPRESSION, timeout_ms: int | None = None, read_max_bytes: int | None = None, interceptors: collections.abc.Iterable[connectrpc.interceptor.Interceptor] = (), http_client: pyqwest.Client | None = None)[source]¶
Bases:
connectrpc.client.ConnectClientService for retrieving instance metrics and monitoring data. Metrics are collected server-side and stored in a ring buffer. All operations require appropriate permissions.
- async get_instance_metrics(request: soulfire.metrics_pb2.GetInstanceMetricsRequest, *, headers: connectrpc.request.Headers | collections.abc.Mapping[str, str] | None = None, timeout_ms: int | None = None) soulfire.metrics_pb2.GetInstanceMetricsResponse[source]¶
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
- async get_server_metrics(request: soulfire.metrics_pb2.GetServerMetricsRequest, *, headers: connectrpc.request.Headers | collections.abc.Mapping[str, str] | None = None, timeout_ms: int | None = None) soulfire.metrics_pb2.GetServerMetricsResponse[source]¶
Returns server-level system metrics (CPU, memory, threads, GC, aggregate bots). Supports incremental fetching via the “since” parameter. Requires: READ_SERVER_CONFIG global permission