Package: google.golang.org/grpc/internal/binarylog

package binarylog Import Path google.golang.org/grpc/internal/binarylog (on go.dev) Dependency Relation imports 21 packages, and imported by one package Involved Source Files d➜ binarylog.go Package binarylog implementation binary logging as defined in https://github.com/grpc/proposal/blob/master/A16-binary-logging.md. binarylog_testutil.go env_config.go method_logger.go sink.go Package-Level Type Names (total 17, in which 11 are exported) /* sort exporteds by: alphabet | popularity */ type Cancel (struct) Cancel configs the binary log entry to be a Cancel entry. Fields (only one, which is exported) OnClientSide bool Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) toProto() *pb.GrpcLogEntry Implements (at least one exported) *T : LogEntryConfig type ClientHalfClose (struct) ClientHalfClose configs the binary log entry to be a ClientHalfClose entry. Fields (only one, which is exported) OnClientSide bool Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) toProto() *pb.GrpcLogEntry Implements (at least one exported) *T : LogEntryConfig type ClientHeader (struct) ClientHeader configs the binary log entry to be a ClientHeader entry. Fields (total 6, all are exported) Authority string Header metadata.MD MethodName string OnClientSide bool PeerAddr net.Addr PeerAddr is required only when it's on server side. Timeout time.Duration Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) toProto() *pb.GrpcLogEntry Implements (at least one exported) *T : LogEntryConfig type ClientMessage (struct) ClientMessage configs the binary log entry to be a ClientMessage entry. Fields (total 2, both are exported) Message interface{} Message can be a proto.Message or []byte. Other messages formats are not supported. OnClientSide bool Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) toProto() *pb.GrpcLogEntry Implements (at least one exported) *T : LogEntryConfig type LogEntryConfig (interface) LogEntryConfig represents the configuration for binary log entry. Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ ( T) toProto() *pb.GrpcLogEntry Implemented By (at least 7, all are exported) *Cancel *ClientHalfClose *ClientHeader *ClientMessage *ServerHeader *ServerMessage *ServerTrailer As Inputs Of (at least one exported) func (*MethodLogger).Log(c LogEntryConfig) type Logger (interface) Logger is the global binary logger. It can be used to get binary logger for each method. Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ ( T) getMethodLogger(methodName string) *MethodLogger Implemented By (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ *logger As Outputs Of (at least one exported) func NewLoggerFromConfigString(s string) Logger As Inputs Of (at least one exported) func SetLogger(l Logger) As Types Of (total 2, in which 1 are exported) var AllLogger /* one unexported ... *//* one unexported: */ var binLogger type MethodLogger (struct) MethodLogger is the sub-logger for each method. Fields (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */ callID uint64 headerMaxLen uint64 idWithinCallGen *callIDGenerator messageMaxLen uint64 sink Sink // TODO(blog): make this plugable. Methods (total 3, in which 1 are exported) (*T) Log(c LogEntryConfig) Log creates a proto binary log entry, and logs it to the sink. /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) truncateMessage(msgPb *pb.Message) (truncated bool) (*T) truncateMetadata(mdPb *pb.Metadata) (truncated bool) As Outputs Of (at least 2, in which 1 are exported) func GetMethodLogger(methodName string) *MethodLogger /* at least one unexported ... *//* at least one unexported: */ func newMethodLogger(h, m uint64) *MethodLogger type ServerHeader (struct) ServerHeader configs the binary log entry to be a ServerHeader entry. Fields (total 3, all are exported) Header metadata.MD OnClientSide bool PeerAddr net.Addr PeerAddr is required only when it's on client side. Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) toProto() *pb.GrpcLogEntry Implements (at least one exported) *T : LogEntryConfig type ServerMessage (struct) ServerMessage configs the binary log entry to be a ServerMessage entry. Fields (total 2, both are exported) Message interface{} Message can be a proto.Message or []byte. Other messages formats are not supported. OnClientSide bool Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) toProto() *pb.GrpcLogEntry Implements (at least one exported) *T : LogEntryConfig type ServerTrailer (struct) ServerTrailer configs the binary log entry to be a ServerTrailer entry. Fields (total 4, all are exported) Err error Err is the status error. OnClientSide bool PeerAddr net.Addr PeerAddr is required only when it's on client side and the RPC is trailer only. Trailer metadata.MD Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) toProto() *pb.GrpcLogEntry Implements (at least one exported) *T : LogEntryConfig type Sink (interface) Sink writes log entry into the binary log sink. Methods (total 2, both are exported) ( T) Close() error Close will be called when the Sink is replaced by a new Sink. ( T) Write(*pb.GrpcLogEntry) error Write will be called to write the log entry into the sink. It should be thread-safe so it can be called in parallel. Implemented By (at least 3, none are exported) /* 3+ unexporteds ... *//* 3+ unexporteds: */ *bufWriteCloserSink *noopSink *writerSink Implements (at least one exported) T : io.Closer As Outputs Of (at least 2, in which 1 are exported) func NewTempFileSink() (Sink, error) /* at least one unexported ... *//* at least one unexported: */ func newBufWriteCloserSink(o io.WriteCloser) Sink As Inputs Of (at least one exported) func SetDefaultSink(s Sink) As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var defaultSink /* 6 unexporteds ... *//* 6 unexporteds: */ type bufWriteCloserSink (struct) Fields (total 6, none are exported) /* 6 unexporteds ... *//* 6 unexporteds: */ buf *bufio.Writer // buf is kept for flush. closer io.Closer mu sync.Mutex out *writerSink // out is built on buf. writeStartOnce sync.Once writeTicker *time.Ticker Methods (total 3, in which 2 are exported) (*T) Close() error (*T) Write(e *pb.GrpcLogEntry) error /* one unexported ... *//* one unexported: */ (*T) startFlushGoroutine() Implements (at least 2, both are exported) *T : Sink *T : io.Closer type callIDGenerator (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ id uint64 Methods (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) next() uint64 (*T) reset() reset is for testing only, and doesn't need to be thread safe. As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var idGen type logger (struct) Fields (total 4, none are exported) /* 4 unexporteds ... *//* 4 unexporteds: */ all *methodLoggerConfig blacklist map[string]struct{} methods map[string]*methodLoggerConfig services map[string]*methodLoggerConfig Methods (total 6, none are exported) /* 6 unexporteds ... *//* 6 unexporteds: */ (*T) fillMethodLoggerWithConfigString(config string) error fillMethodLoggerWithConfigString parses config, creates methodLogger and adds it to the right map in the logger. (*T) getMethodLogger(methodName string) *MethodLogger getMethodLogger returns the methodLogger for the given methodName. methodName should be in the format of "/service/method". Each methodLogger returned by this method is a new instance. This is to generate sequence id within the call. (*T) setBlacklist(method string) error Set blacklist method for "-service/method". (*T) setDefaultMethodLogger(ml *methodLoggerConfig) error Set method logger for "*". (*T) setMethodMethodLogger(method string, ml *methodLoggerConfig) error Set method logger for "service/method". New methodLogger with same method overrides the old one. (*T) setServiceMethodLogger(service string, ml *methodLoggerConfig) error Set method logger for "service/*". New methodLogger with same service overrides the old one. Implements (at least one exported) *T : Logger As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func newEmptyLogger() *logger type methodLoggerConfig (struct) Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ hdr uint64 Max length of header and message. msg uint64 Max length of header and message. type noopSink (struct) Methods (total 2, both are exported) (*T) Close() error (*T) Write(*pb.GrpcLogEntry) error Implements (at least 2, both are exported) *T : Sink *T : io.Closer type writerSink (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ out io.Writer Methods (total 2, both are exported) (*T) Close() error (*T) Write(e *pb.GrpcLogEntry) error Implements (at least 2, both are exported) *T : Sink *T : io.Closer As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func newWriterSink(w io.Writer) *writerSink Package-Level Functions (total 15, in which 5 are exported) func GetMethodLogger(methodName string) *MethodLogger GetMethodLogger returns the methodLogger for the given methodName. methodName should be in the format of "/service/method". Each methodLogger returned by this method is a new instance. This is to generate sequence id within the call. func NewLoggerFromConfigString(s string) Logger NewLoggerFromConfigString reads the string and build a logger. It can be used to build a new logger and assign it to binarylog.Logger. Example filter config strings: - "" Nothing will be logged - "*" All headers and messages will be fully logged. - "*{h}" Only headers will be logged. - "*{m:256}" Only the first 256 bytes of each message will be logged. - "Foo/*" Logs every method in service Foo - "Foo/*,-Foo/Bar" Logs every method in service Foo except method /Foo/Bar - "Foo/*,Foo/Bar{m:256}" Logs the first 256 bytes of each message in method /Foo/Bar, logs all headers and messages in every other method in service Foo. If two configs exist for one certain method or service, the one specified later overrides the previous config. func NewTempFileSink() (Sink, error) NewTempFileSink creates a temp file and returns a Sink that writes to this file. func SetDefaultSink(s Sink) SetDefaultSink sets the sink where binary logs will be written to. Not thread safe. Only set during initialization. func SetLogger(l Logger) SetLogger sets the binarg logger. Only call this at init time. /* 10 unexporteds ... *//* 10 unexporteds: */ func addrToProto(addr net.Addr) *pb.Address func init() func mdToMetadataProto(md metadata.MD) *pb.Metadata func metadataKeyOmit(key string) bool metadataKeyOmit returns whether the metadata entry with this key should be omitted. func newBufWriteCloserSink(o io.WriteCloser) Sink func newEmptyLogger() *logger newEmptyLogger creates an empty logger. The map fields need to be filled in using the set* functions. func newMethodLogger(h, m uint64) *MethodLogger func newWriterSink(w io.Writer) *writerSink newWriterSink creates a binary log sink with the given writer. Write() marshals the proto message and writes it to the given writer. Each message is prefixed with a 4 byte big endian unsigned integer as the length. No buffer is done, Close() doesn't try to close the writer. func parseHeaderMessageLengthConfig(c string) (hdrLenStr, msgLenStr uint64, err error) Turn "{h:123;m:345}" into 123, 345. Return maxUInt if length is unspecified. func parseMethodConfigAndSuffix(c string) (service, method, suffix string, _ error) Turn "service/method{h;m}" into "service", "method", "{h;m}". Package-Level Variables (total 11, in which 3 are exported) var AddrToProto func(addr net.Addr) *grpc_binarylog_v1.Address AddrToProto converts an address to a binary logging proto message. It's for testing only. var AllLogger Logger AllLogger is a logger that logs all headers/messages for all RPCs. It's for testing only. var MdToMetadataProto func(md metadata.MD) *grpc_binarylog_v1.Metadata MdToMetadataProto converts metadata to a binary logging proto message. It's for testing only. /* 8 unexporteds ... *//* 8 unexporteds: */ var binLogger Logger binLogger is the global binary logger for the binary. One of this should be built at init time from the configuration (environment variable or flags). It is used to get a methodLogger for each individual method. var defaultSink Sink // TODO(blog): change this default (file in /tmp). var grpclogLogger grpclog.DepthLoggerV2 var headerConfigRegexp *regexp.Regexp var headerMessageConfigRegexp *regexp.Regexp var idGen callIDGenerator var longMethodConfigRegexp *regexp.Regexp var messageConfigRegexp *regexp.Regexp Package-Level Constants (total 7, none are exported) /* 7 unexporteds ... *//* 7 unexporteds: */ const bufFlushDuration time.Duration = 60000000000 const headerConfigRegexpStr = "^{h(?::(\\d+))?}$" const headerMessageConfigRegexpStr = "^{h(?::(\\d+))?;m(?::(\\d+))?}$" const longMethodConfigRegexpStr = "^([\\w./]+)/((?:\\w+)|[*])(.+)?$" For "p.s/m" plus any suffix. Suffix will be parsed again. See test for expected output. const maxUInt uint64 = 18446744073709551615 TODO: this const is only used by env_config now. But could be useful for other config. Move to binarylog.go if necessary. const messageConfigRegexpStr = "^{m(?::(\\d+))?}$" const optionalLengthRegexpStr = "(?::(\\d+))?" // Optional ":123". For suffix from above, "{h:123,m:123}". See test for expected output.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.