soulfire.plugin_stats_connect.PluginStatsServiceClientSync

class soulfire.plugin_stats_connect.PluginStatsServiceClientSync(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.InterceptorSync] = (), http_client: pyqwest.SyncClient | None = None)[source]

Bases: connectrpc.client.ConnectClientSync

Service for retrieving plugin runtime statistics. Stats are collected server-side from plugins via the plugin metrics API. All operations require appropriate permissions.

get_instance_plugin_stats(request: soulfire.plugin_stats_pb2.GetInstancePluginStatsRequest, *, headers: connectrpc.request.Headers | collections.abc.Mapping[str, str] | None = None, timeout_ms: int | None = None) → soulfire.plugin_stats_pb2.GetInstancePluginStatsResponse[source]

Returns runtime stats for every plugin that has reported in the instance. Requires: READ_BOT_INFO permission on the instance Errors: NOT_FOUND if instance does not exist