benchmark/grpc_testing/test.proto

// An integration test service that covers all the method signature permutations
// of unary/streaming requests/responses.
syntax = "proto3";

package grpc.testing;

enum PayloadType {
    // Compressable text format.
    COMPRESSABLE = 0;

    // Uncompressable binary format.
    UNCOMPRESSABLE = 1;

    // Randomly chosen from all other formats defined in this enum.
    RANDOM = 2;
}

message StatsRequest {
    // run number
    optional int32 test_num = 1;
}

message ServerStats {
    // wall clock time
    double time_elapsed = 1;

    // user time used by the server process and threads
    double time_user = 2;

    // server time used by the server process and all threads
    double time_system = 3;
}

message Payload {
    // The type of data in body.
    PayloadType type = 1;
    // Primary contents of payload.
    bytes body = 2;
}

message HistogramData {
    repeated uint32 bucket = 1;
    double min_seen = 2;
    double max_seen = 3;
    double sum = 4;
    double sum_of_squares = 5;
    double count = 6;
}

enum ClientType {
    SYNCHRONOUS_CLIENT = 0;
    ASYNC_CLIENT = 1;
}

enum ServerType {
    SYNCHRONOUS_SERVER = 0;
    ASYNC_SERVER = 1;
}

enum RpcType {
    UNARY = 0;
    STREAMING = 1;
}

message ClientConfig {
    repeated string server_targets = 1;
    ClientType client_type = 2;
    bool enable_ssl = 3;
    int32 outstanding_rpcs_per_channel = 4;
    int32 client_channels = 5;
    int32 payload_size = 6;
    // only for async client:
    int32 async_client_threads = 7;
    RpcType rpc_type = 8;
}

// Request current stats
message Mark {}

message ClientArgs {
    oneof argtype {
        ClientConfig setup = 1;
        Mark mark = 2;
    }
}

message ClientStats {
    HistogramData latencies = 1;
    double time_elapsed = 3;
    double time_user = 4;
    double time_system = 5;
}

message ClientStatus {
    ClientStats stats = 1;
}

message ServerConfig {
    ServerType server_type = 1;
    int32 threads = 2;
    bool enable_ssl = 3;
}

message ServerArgs {
    oneof argtype {
        ServerConfig setup = 1;
        Mark mark = 2;
    }
}

message ServerStatus {
    ServerStats stats = 1;
    int32 port = 2;
}

message SimpleRequest {
    // Desired payload type in the response from the server.
    // If response_type is RANDOM, server randomly chooses one from other formats.
    PayloadType response_type = 1;

    // Desired payload size in the response from the server.
    // If response_type is COMPRESSABLE, this denotes the size before compression.
    int32 response_size = 2;

    // Optional input payload sent along with the request.
    Payload payload = 3;
}

message SimpleResponse {
    Payload payload = 1;
}

service TestService {
    // One request followed by one response.
    // The server returns the client payload as-is.
    rpc UnaryCall(SimpleRequest) returns (SimpleResponse);

    // One request followed by one response.
    // The server returns the client payload as-is.
    rpc StreamingCall(stream SimpleRequest) returns (stream SimpleResponse);
}

service Worker {
    // Start test with specified workload
    rpc RunTest(stream ClientArgs) returns (stream ClientStatus);
    // Start test with specified workload
    rpc RunServer(stream ServerArgs) returns (stream ServerStatus);
}