Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
So the sink can be updated (instead of only being noop)
- Loading branch information
Showing
5 changed files
with
138 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /* | ||
| * | ||
| * Copyright 2018 gRPC authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| // Package binarylog implementation binary logging as defined in | ||
| // https://github.com/grpc/proposal/blob/master/A16-binary-logging.md. | ||
| // | ||
| // Notice: All APIs in this package are experimental. | ||
| package binarylog | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "fmt" | ||
| "io" | ||
| "io/ioutil" | ||
| "sync" | ||
| "time" | ||
|
|
||
| pb "google.golang.org/grpc/binarylog/grpc_binarylog_v1" | ||
| iblog "google.golang.org/grpc/internal/binarylog" | ||
| ) | ||
|
|
||
| // SetDefaultSink sets the sink where binary logs will be written to. | ||
| // | ||
| // Not thread safe. Only set during initialization. | ||
| func SetDefaultSink(s Sink) { | ||
| if iblog.DefaultSink != nil { | ||
| iblog.DefaultSink.Close() | ||
| } | ||
| iblog.DefaultSink = s | ||
| } | ||
|
|
||
| // Sink writes log entry into the binary log sink. | ||
| type Sink interface { | ||
| // Write will be called to write the log entry into the sink. | ||
| // | ||
| // It should be thread-safe so it can be called in parallel. | ||
| Write(*pb.GrpcLogEntry) error | ||
| // Close will be called when the Sink is replaced by a new Sink. | ||
| Close() error | ||
| } | ||
|
|
||
| type bufWriteCloserSink struct { | ||
| mu sync.Mutex | ||
| closer io.Closer | ||
| out Sink // out is built on buf. | ||
| buf *bufio.Writer // buf is kept for flush. | ||
|
|
||
| writeStartOnce sync.Once | ||
| writeTicker *time.Ticker | ||
| } | ||
|
|
||
| func (fs *bufWriteCloserSink) Write(e *pb.GrpcLogEntry) error { | ||
| // Start the write loop when Write is called. | ||
| fs.writeStartOnce.Do(fs.startFlushGoroutine) | ||
| fs.mu.Lock() | ||
| if err := fs.out.Write(e); err != nil { | ||
| fs.mu.Unlock() | ||
| return err | ||
| } | ||
| fs.mu.Unlock() | ||
| return nil | ||
| } | ||
|
|
||
| const ( | ||
| bufFlushDuration = 60 * time.Second | ||
| ) | ||
|
|
||
| func (fs *bufWriteCloserSink) startFlushGoroutine() { | ||
| fs.writeTicker = time.NewTicker(bufFlushDuration) | ||
| go func() { | ||
| for range fs.writeTicker.C { | ||
| fs.mu.Lock() | ||
| fs.buf.Flush() | ||
| fs.mu.Unlock() | ||
| } | ||
| }() | ||
| } | ||
|
|
||
| func (fs *bufWriteCloserSink) Close() error { | ||
| if fs.writeTicker != nil { | ||
| fs.writeTicker.Stop() | ||
| } | ||
| fs.mu.Lock() | ||
| fs.buf.Flush() | ||
| fs.closer.Close() | ||
| fs.out.Close() | ||
| fs.mu.Unlock() | ||
| return nil | ||
| } | ||
|
|
||
| func newBufWriteCloserSink(o io.WriteCloser) Sink { | ||
| bufW := bufio.NewWriter(o) | ||
| return &bufWriteCloserSink{ | ||
| closer: o, | ||
| out: iblog.NewWriterSink(bufW), | ||
| buf: bufW, | ||
| } | ||
| } | ||
|
|
||
| // NewTempFileSink creates a temp file and returns a Sink that writes to this | ||
| // file. | ||
| func NewTempFileSink() (Sink, error) { | ||
| tempFile, err := ioutil.TempFile("/tmp", "grpcgo_binarylog_*.txt") | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create temp file: %v", err) | ||
| } | ||
| return newBufWriteCloserSink(tempFile), nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters