Scaleout Edge gRPC protocol

Table of Contents

• scaleoututil/grpc/scaleout.proto

  • ActivityReport

  • AttributeElem

  • AttributeMessage

  • AttributeRecord

  • BacklogReport

  • ClientAnnounceRequest

  • ClientAvailableMessage

  • ClientReport

  • CombinerDirective

  • FileChunk

  • Heartbeat

  • InferenceResult

  • MetricElem

  • ModelMetric

  • ModelRequest

  • ModelResponse

  • ModelUpdate

  • ModelValidation

  • RecordAck

  • Response

  • Status

  • TaskRequest

  • TelemetryElem

  • TelemetryMessage

  • TelemetryRecord

  • LogLevel

  • ModelStatus

  • CombinerClient

  • ModelService

• Scalar Value Types

scaleoututil/grpc/scaleout.proto

ActivityReport

Field	Type	Label	Description
node_id	string		If sent from a client
correlation_id	string
status	string
done	bool
response	string		json
command_type	string	optional	set only until the server acks the self-registration
parameters	string	optional	json, same lifetime as command_type
started_at	Timestamp		client’s own wall-clock task-start time
completed_at	Timestamp		client’s own wall-clock task-end time

AttributeElem

Field	Type	Label	Description
key	string
value	string

AttributeMessage

Field	Type	Label	Description
client_id	string
attributes	AttributeElem	repeated
timestamp	Timestamp

AttributeRecord

Field	Type	Label	Description
attribute_id	string
client_id	string
timestamp	Timestamp
key	string
payload	string

BacklogReport

Field	Type	Label	Description
client_id	string
backlog_total	uint32
backlog_dropped_total	uint32
backlog_oldest_age_ms	float	optional

ClientAnnounceRequest

Field	Type	Label	Description
client_id	string
type	string
parameters	string

ClientAvailableMessage

Field	Type	Label	Description
client_id	string
data	string
timestamp	string

ClientReport

Field	Type	Label	Description
client_id	string
reports	ActivityReport	repeated
poll_interval_ms	uint32	optional
skip_polling_tasks	bool

CombinerDirective

Field	Type	Label	Description
tasks	TaskRequest	repeated

FileChunk

Field	Type	Label	Description
data	bytes

Heartbeat

Field	Type	Label	Description
client_id	string
heartbeat_interval_ms	uint32	optional

InferenceResult

Field	Type	Label	Description
inference_result_id	string
node_id	string
timestamp	Timestamp
key	string
payload	string
inference_id	string
model_id	string

MetricElem

Field	Type	Label	Description
key	string
value	float

ModelMetric

Field	Type	Label	Description
client_id	string
metrics	MetricElem	repeated
timestamp	Timestamp
step	UInt32Value	optional
model_id	string
round_id	string
session_id	string

ModelRequest

Field	Type	Label	Description
model_id	string

ModelResponse

Field	Type	Label	Description
status	ModelStatus
message	string

ModelUpdate

Field	Type	Label	Description
client_id	string
model_id	string
model_update_id	string
correlation_id	string
timestamp	Timestamp
meta	string
config	string
round_id	string
session_id	string

ModelValidation

Field	Type	Label	Description
client_id	string
model_id	string
data	string
correlation_id	string
timestamp	Timestamp
session_id	string

RecordAck

Field	Type	Label	Description
record_ids	string	repeated

Response

Field	Type	Label	Description
response	string
parameters	string

Status

Field	Type	Label	Description
client_id	string
status	string
log_level	LogLevel
timestamp	Timestamp
type	string

TaskRequest

Field	Type	Label	Description
model_id	string
data	string
correlation_id	string
timestamp	string
session_id	string
round_id	string
type	string
status	string
client_id	string

TelemetryElem

Field	Type	Label	Description
key	string
value	float

TelemetryMessage

Field	Type	Label	Description
client_id	string
telemetries	TelemetryElem	repeated
timestamp	Timestamp
record_id	string

TelemetryRecord

Field	Type	Label	Description
telemetry_id	string
client_id	string
timestamp	Timestamp
key	string
payload	string

LogLevel

Name	Number	Description
NONE	0
INFO	1
DEBUG	2
WARNING	3
ERROR	4
AUDIT	5

ModelStatus

Name	Number	Description
UNKNOWN	0
IN_PROGRESS	1
OK	2
FAILED	3

CombinerClient

Method Name	Request Type	Response Type	Description
SendModelUpdate	ModelUpdate	Response
SendModelValidation	ModelValidation	Response
SendModelMetric	ModelMetric	Response
SendAttributeMessage	AttributeMessage	Response
SendTelemetryMessage	TelemetryMessage	Response
StreamTelemetryRecord	TelemetryRecord stream	RecordAck stream
StreamAttributeRecord	AttributeRecord stream	RecordAck stream
StreamInferenceResult	InferenceResult stream	RecordAck stream
Announce	ClientAnnounceRequest	Response
SendBacklogReport	BacklogReport	Response
PollAndReportAsync	ClientReport	CombinerDirective
SendStatus	Status	Response	Status endpoint
SendHeartbeat	Heartbeat	Response	Client messaging to stay engaged.
TaskStream	ClientAvailableMessage	TaskRequest stream	Stream endpoints for training/validation pub/sub

ModelService

Method Name	Request Type	Response Type	Description
Upload	FileChunk stream	ModelResponse
Download	ModelRequest	FileChunk stream

Scalar Value Types

.proto Type	Notes	Python	Go
double		float	float64
float		float	float32
int32	Uses variable-length encoding	int	int32
int64	Uses variable-length encoding	int	int64
uint32	Uses variable-length encoding	int	uint32
uint64	Uses variable-length encoding	int	uint64
sint32	Uses var-length encoding. Signed int value.	int	int32
sint64	Uses var-length encoding. Signed int value.	int	int64
fixed32	Always four bytes	int	uint32
fixed64	Always eight bytes	int	uint64
sfixed32	Always four bytes	int	int32
sfixed64	Always eight bytes	int	int64
bool		bool	bool
string	UTF-8 or 7-bit ASCII text.	str	string
bytes	Any arbitrary sequence of bytes.	bytes	[]byte