micro/debug/service/proto/debug.proto

66 lines
1.3 KiB
Protocol Buffer
Raw Normal View History

syntax = "proto3";
2019-08-06 19:53:14 +03:00
service Debug {
rpc Health(HealthRequest) returns (HealthResponse) {};
rpc Stats(StatsRequest) returns (StatsResponse) {};
2019-12-05 02:58:29 +03:00
rpc Log(LogRequest) returns (stream Record) {};
2019-08-06 19:53:14 +03:00
}
2019-12-04 15:02:44 +03:00
message HealthRequest {
// optional service name
string service = 1;
}
message HealthResponse {
2016-05-29 00:30:47 +03:00
// default: ok
string status = 1;
}
2016-05-29 00:30:47 +03:00
2019-12-04 15:02:44 +03:00
message StatsRequest {
// optional service name
string service = 1;
}
2016-05-29 00:30:47 +03:00
message StatsResponse {
2019-12-05 02:51:07 +03:00
// timestamp of recording
uint64 timestamp = 1;
2016-05-29 00:30:47 +03:00
// unix timestamp
2019-12-05 02:51:07 +03:00
uint64 started = 2;
2016-05-29 00:30:47 +03:00
// in seconds
2019-12-05 02:51:07 +03:00
uint64 uptime = 3;
2016-05-29 00:30:47 +03:00
// in bytes
2019-12-05 02:51:07 +03:00
uint64 memory = 4;
2016-05-29 00:30:47 +03:00
// num threads
2019-12-05 02:51:07 +03:00
uint64 threads = 5;
2016-05-29 00:30:47 +03:00
// total gc in nanoseconds
2019-12-05 02:51:07 +03:00
uint64 gc = 6;
2019-12-18 21:36:42 +03:00
// total number of requests
uint64 requests = 7;
// total number of errors
uint64 errors = 8;
2016-05-29 00:30:47 +03:00
}
// LogRequest requests service logs
message LogRequest {
2019-12-04 15:02:44 +03:00
// service to request logs for
string service = 1;
2019-12-04 15:28:16 +03:00
// stream records continuously
bool stream = 2;
// count of records to request
int64 count = 3;
// relative time in seconds
// before the current time
// from which to show logs
int64 since = 4;
}
// Record is service log record
message Record {
// timestamp of log record
int64 timestamp = 1;
// record metadata
2019-12-18 19:02:11 +03:00
map<string,string> metadata = 2;
// message
string message = 3;
}