micro/debug/service/proto/debug.proto

94 lines
1.8 KiB
Protocol Buffer
Raw Normal View History

syntax = "proto3";
2019-08-06 17:53:14 +01:00
service Debug {
2020-01-30 23:24:46 +00:00
rpc Log(LogRequest) returns (stream Record) {};
rpc Health(HealthRequest) returns (HealthResponse) {};
rpc Stats(StatsRequest) returns (StatsResponse) {};
2020-01-24 21:29:29 +00:00
rpc Trace(TraceRequest) returns (TraceResponse) {};
2019-08-06 17:53:14 +01:00
}
2019-12-04 12:02:44 +00:00
message HealthRequest {
// optional service name
string service = 1;
}
message HealthResponse {
2016-05-28 22:30:47 +01:00
// default: ok
string status = 1;
}
2016-05-28 22:30:47 +01:00
2019-12-04 12:02:44 +00:00
message StatsRequest {
// optional service name
string service = 1;
}
2016-05-28 22:30:47 +01:00
message StatsResponse {
2019-12-04 23:51:07 +00:00
// timestamp of recording
uint64 timestamp = 1;
2016-05-28 22:30:47 +01:00
// unix timestamp
2019-12-04 23:51:07 +00:00
uint64 started = 2;
2016-05-28 22:30:47 +01:00
// in seconds
2019-12-04 23:51:07 +00:00
uint64 uptime = 3;
2016-05-28 22:30:47 +01:00
// in bytes
2019-12-04 23:51:07 +00:00
uint64 memory = 4;
2016-05-28 22:30:47 +01:00
// num threads
2019-12-04 23:51:07 +00:00
uint64 threads = 5;
2016-05-28 22:30:47 +01:00
// total gc in nanoseconds
2019-12-04 23:51:07 +00:00
uint64 gc = 6;
2019-12-18 18:36:42 +00:00
// total number of requests
uint64 requests = 7;
// total number of errors
uint64 errors = 8;
2016-05-28 22:30:47 +01:00
}
// LogRequest requests service logs
message LogRequest {
2019-12-04 12:02:44 +00:00
// service to request logs for
string service = 1;
2019-12-04 12:28:16 +00: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 16:02:11 +00:00
map<string,string> metadata = 2;
// message
string message = 3;
}
2020-01-24 21:29:29 +00:00
message TraceRequest {
// trace id to retrieve
string id = 1;
}
message TraceResponse {
repeated Span spans = 1;
}
message Span {
// the trace id
string trace = 1;
// id of the span
string id = 2;
// parent span
string parent = 3;
// name of the resource
string name = 4;
// time of start in nanoseconds
uint64 started = 5;
// duration of the execution in nanoseconds
uint64 duration = 6;
// associated metadata
map<string,string> metadata = 7;
}