package grpc.binarylog.v1alpha

Get desktop application:
View/edit binary Protocol Buffers messages

Log entry we store in binary logs

• GrpcLogEntry.Type type = 1

  One of the above Type enum

• GrpcLogEntry.Logger logger = 2

  One of the above Logger enum

• optional Uint128 call_id = 3

  Uniquely identifies a call. Each call may have several log entries, they will share the same call_id. 128 bits split into 2 64-bit parts.

• oneof payload

  The logger uses one of the following fields to record the payload, according to the type of the log entry.

  • Metadata metadata = 4

    Used by {SEND,RECV}_INITIAL_METADATA and {SEND,RECV}_TRAILING_METADATA. This contains only the metadata from the application.

  • Message message = 5

    Used by {SEND,RECV}_MESSAGE

• optional Peer peer = 6

  Peer address information, will only be recorded in SEND_INITIAL_METADATA and RECV_INITIAL_METADATA entries.

• bool truncated = 7

  true if payload does not represent the full message or metadata.

• string method_name = 8

  The method name. Logged for the first entry: RECV_INITIAL_METADATA for server side or SEND_INITIAL_METADATA for client side.

• uint32 status_code = 9

  status_code and status_message: Only present for SEND_TRAILING_METADATA on server side or RECV_TRAILING_METADATA on client side.

• string status_message = 10

  An original status message before any transport specific encoding.

• bytes status_details = 11

  The value of the 'grpc-status-details-bin' metadata key. If present, this is always an encoded 'google.rpc.Status' message.

• optional google.protobuf.Duration timeout = 12

  the RPC timeout

• uint32 sequence_id_within_call = 13

  The entry sequence id for this call. The first GrpcLogEntry has a value of 1, to disambiguate from an unset value. The purpose of this field is to detect missing entries in environments where durability or ordering is not guaranteed.

Enumerates the entity that generates the log entry

Used in: GrpcLogEntry

• UNKNOWN_LOGGER = 0

• CLIENT = 1

• SERVER = 2

Enumerates the type of logs

Used in: GrpcLogEntry

• UNKNOWN_TYPE = 0

• SEND_INITIAL_METADATA = 1

• SEND_TRAILING_METADATA = 2

• SEND_MESSAGE = 3

• RECV_INITIAL_METADATA = 4

• RECV_TRAILING_METADATA = 5

• RECV_MESSAGE = 6

Message payload, used by REQUEST and RESPONSE

Used in: GrpcLogEntry

• uint32 flags = 1

  This flag is currently used to indicate whether the payload is compressed, it may contain other semantics in the future. Value of 1 indicates that the binary octet sequence of Message is compressed using the mechanism declared by the Message-Encoding header. A value of 0 indicates that no encoding of Message bytes has occurred.

  TODO(zpencer): this is changed because there is no uint8

• uint32 length = 2

  Length of the message. It may not be the same as the length of the data field, as the logging payload can be truncated or omitted.

• bytes data = 3

  May be truncated or omitted.

A list of metadata pairs, used in the payload of CLIENT_INIT_METADATA, SERVER_INIT_METADATA and TRAILING_METADATA Implementations may omit some entries to honor the header limits of GRPC_BINARY_LOG_CONFIG. Implementations will not log the following entries, and this is not to be treated as a truncation: - entries handled by grpc that are not user visible, such as those that begin with 'grpc-' or keys like 'lb-token' - transport specific entries, including but not limited to: ':path', ':authority', 'content-encoding', 'user-agent', 'te', etc - entries added for call credentials

Used in: GrpcLogEntry

• repeated MetadataEntry entry = 1

A metadata key value pair

Used in: Metadata

• bytes key = 1

• bytes value = 2

Peer information

Used in: GrpcLogEntry

• Peer.PeerType peer_type = 1

• bytes peer = 2

  will be removed: do not use

• string address = 3

• uint32 ip_port = 4

  only for PEER_IPV4 and PEER_IPV6

Used in: Peer

• UNKNOWN_PEERTYPE = 0

• PEER_IPV4 = 1

  address is the address in 1.2.3.4 form

• PEER_IPV6 = 2

  address the address in canonical form (RFC5952 section 4) The scope is NOT included in the peer string.

• PEER_UNIX = 3

  address is UDS string

Used to record call_id.

Used in: GrpcLogEntry

• fixed64 high = 1

• fixed64 low = 2