package grpc.lb.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc BalanceLoad (stream LoadBalanceRequest, stream LoadBalanceResponse)

  load_balancer.proto:49

  Bidirectional rpc to get a list of servers.

  message LoadBalanceRequest

  load_balancer.proto:53

  • oneof load_balance_request_type

    • InitialLoadBalanceRequest initial_request = 1

      This message should be sent on the first request to the load balancer.

    • ClientStats client_stats = 2

      The client stats should be periodically reported to the load balancer based on the duration defined in the InitialLoadBalanceResponse.

  message LoadBalanceResponse

  load_balancer.proto:104

  • oneof load_balance_response_type

    • InitialLoadBalanceResponse initial_response = 1

      This message should be sent on the first response to the client.

    • ServerList server_list = 2

      Contains the list of servers selected by the load balancer. The client should send requests to these servers in the specified order.

Contains client level statistics that are useful to load balancing. Each count except the timestamp should be reset to zero after reporting the stats.

Used in: LoadBalanceRequest

• optional Timestamp timestamp = 1

  The timestamp of generating the report.

• int64 num_calls_started = 2

  The total number of RPCs that started.

• int64 num_calls_finished = 3

  The total number of RPCs that finished.

• int64 num_calls_finished_with_client_failed_to_send = 6

  The total number of RPCs that failed to reach a server except dropped RPCs.

• int64 num_calls_finished_known_received = 7

  The total number of RPCs that finished and are known to have been received by a server.

• repeated ClientStatsPerToken calls_finished_with_drop = 8

  The list of dropped calls.

Contains the number of calls finished for a particular load balance token.

Used in: ClientStats

• string load_balance_token = 1

  See Server.load_balance_token.

• int64 num_calls = 2

  The total number of RPCs that finished associated with the token.

Used in: InitialLoadBalanceResponse

• int64 seconds = 1

  Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.

• int32 nanos = 2

  Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.

Used in: LoadBalanceRequest

• string name = 1

  Name of load balanced service (IE, balancer.service.com) length should be less than 256 bytes.

Used in: LoadBalanceResponse

• string load_balancer_delegate = 1

  This is an application layer redirect that indicates the client should use the specified server for load balancing. When this field is non-empty in the response, the client should open a separate connection to the load_balancer_delegate and call the BalanceLoad method. Its length should be less than 64 bytes.

• optional Duration client_stats_report_interval = 2

  This interval defines how often the client should send the client stats to the load balancer. Stats should only be reported when the duration is positive.

Contains server information. When the drop field is not true, use the other fields.

Used in: ServerList

• bytes ip_address = 1

  A resolved address for the server, serialized in network-byte-order. It may either be an IPv4 or IPv6 address.

• int32 port = 2

  A resolved port number for the server.

• string load_balance_token = 3

  An opaque but printable token given to the frontend for each pick. All frontend requests for that pick must include the token in its initial metadata. The token is used by the backend to verify the request and to allow the backend to report load to the gRPC LB system. The token is also used in client stats for reporting dropped calls. Its length is variable but less than 50 bytes.

• bool drop = 4

  Indicates whether this particular request should be dropped by the client. If the request is dropped, there will be a corresponding entry in ClientStats.calls_finished_with_drop.

Used in: LoadBalanceResponse

• repeated Server servers = 1

  Contains a list of servers selected by the load balancer. The list will be updated when server resolutions change or as needed to balance load across more servers. The client should consume the server list in order unless instructed otherwise via the client_config.

Used in: ClientStats

• int64 seconds = 1

  Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

• int32 nanos = 2

  Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.