package binarylog
- Alphabetic
- Public
- Protected
Type Members
- final case class Address(type: Type = io.grpc.binarylog.v1.binarylog.Address.Type.TYPE_UNKNOWN, address: String = "", ipPort: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Address] with Product with Serializable
Address information
Address information
- ipPort
only for TYPE_IPV4 and TYPE_IPV6
- Annotations
- @SerialVersionUID()
- final case class ClientHeader(metadata: Option[Metadata] = _root_.scala.None, methodName: String = "", authority: String = "", timeout: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ClientHeader] with Product with Serializable
- metadata
This contains only the metadata from the application.
- methodName
The name of the RPC method, which looks something like: /<service>/<method> Note the leading "/" character.
- authority
A single process may be used to run multiple virtual servers with different identities. The authority is the name of such a server identitiy. It is typically a portion of the URI in the form of <host> or <host>:<port> .
- timeout
the RPC timeout
- Annotations
- @SerialVersionUID()
- final case class GrpcLogEntry(timestamp: Option[Timestamp] = _root_.scala.None, callId: Long = 0L, sequenceIdWithinCall: Long = 0L, type: EventType = io.grpc.binarylog.v1.binarylog.GrpcLogEntry.EventType.EVENT_TYPE_UNKNOWN, logger: Logger = io.grpc.binarylog.v1.binarylog.GrpcLogEntry.Logger.LOGGER_UNKNOWN, payload: Payload = io.grpc.binarylog.v1.binarylog.GrpcLogEntry.Payload.Empty, payloadTruncated: Boolean = false, peer: Option[Address] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GrpcLogEntry] with Product with Serializable
Log entry we store in binary logs
Log entry we store in binary logs
- timestamp
The timestamp of the binary log message
- callId
Uniquely identifies a call. The value must not be 0 in order to disambiguate from an unset value. Each call may have several log entries, they will all have the same call_id. Nothing is guaranteed about their value other than they are unique across different RPCs in the same gRPC process.
- sequenceIdWithinCall
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.
- logger
One of the above Logger enum
- payloadTruncated
true if payload does not represent the full message or metadata.
- peer
Peer address information, will only be recorded on the first incoming event. On client side, peer is logged on EVENT_TYPE_SERVER_HEADER normally or EVENT_TYPE_SERVER_TRAILER in the case of trailers-only. On server side, peer is always logged on EVENT_TYPE_CLIENT_HEADER.
- Annotations
- @SerialVersionUID()
- final case class Message(length: Int = 0, data: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Message] with Product with Serializable
Message payload, used by CLIENT_MESSAGE and SERVER_MESSAGE
Message payload, used by CLIENT_MESSAGE and SERVER_MESSAGE
- length
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.
- data
May be truncated or omitted.
- Annotations
- @SerialVersionUID()
- final case class Metadata(entry: Seq[MetadataEntry] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Metadata] with Product with Serializable
A list of metadata pairs, used in the payload of client header, server header, and server trailer.
A list of metadata pairs, used in the payload of client header, server header, and server trailer. Implementations may omit some entries to honor the header limits of GRPC_BINARY_LOG_CONFIG.
Header keys added by gRPC are omitted. To be more specific, 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-' (with exception of grpc-trace-bin) 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
Implementations must always log grpc-trace-bin if it is present. Practically speaking it will only be visible on server side because grpc-trace-bin is managed by low level client side mechanisms inaccessible from the application level. On server side, the header is just a normal metadata key. The pair will not count towards the size limit.
- Annotations
- @SerialVersionUID()
- final case class MetadataEntry(key: String = "", value: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MetadataEntry] with Product with Serializable
A metadata key value pair
A metadata key value pair
- Annotations
- @SerialVersionUID()
- final case class ServerHeader(metadata: Option[Metadata] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ServerHeader] with Product with Serializable
- metadata
This contains only the metadata from the application.
- Annotations
- @SerialVersionUID()
- final case class Trailer(metadata: Option[Metadata] = _root_.scala.None, statusCode: Int = 0, statusMessage: String = "", statusDetails: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Trailer] with Product with Serializable
- metadata
This contains only the metadata from the application.
- statusCode
The gRPC status code.
- statusMessage
An original status message before any transport specific encoding.
- statusDetails
The value of the 'grpc-status-details-bin' metadata key. If present, this is always an encoded 'google.rpc.Status' message.
- Annotations
- @SerialVersionUID()
Value Members
- object Address extends GeneratedMessageCompanion[Address]
- object BinarylogProto extends GeneratedFileObject
- object ClientHeader extends GeneratedMessageCompanion[ClientHeader]
- object GrpcLogEntry extends GeneratedMessageCompanion[GrpcLogEntry]
- object Message extends GeneratedMessageCompanion[Message]
- object Metadata extends GeneratedMessageCompanion[Metadata]
- object MetadataEntry extends GeneratedMessageCompanion[MetadataEntry]
- object ServerHeader extends GeneratedMessageCompanion[ServerHeader]
- object Trailer extends GeneratedMessageCompanion[Trailer]