Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #952 from moisesvega/buffered-write-syncer
Add buffered write syncer
- Loading branch information
Showing
6 changed files
with
367 additions
and
4 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,147 @@ | ||
| // Copyright (c) 2021 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package zapcore | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "go.uber.org/multierr" | ||
| ) | ||
|
|
||
| // A BufferedWriteSyncer is a WriteSyncer that can also flush any buffered data | ||
| // with the ability to change the buffer size, flush interval and Clock. | ||
| // BufferedWriteSyncer is safe for concurrent use. You don't need to use | ||
| // zapcore.Lock for WriteSyncers with BufferedWriteSyncer. | ||
| type BufferedWriteSyncer struct { | ||
| WriteSyncer | ||
|
|
||
| // Size specifies the maximum amount of data the writer will buffer before | ||
| // flushing. Defaults to 256 kB. | ||
| Size int | ||
| // FlushInterval specifies how often the writer should flush data if there | ||
| // have been no writes. Defaults to 30 seconds. | ||
| FlushInterval time.Duration | ||
| // Clock, if specified, provides control of the source of time for the | ||
| // writer. Uses the system clock by default. | ||
| Clock Clock | ||
|
|
||
| // unexported fields for state | ||
| ws WriteSyncer | ||
| mu sync.Mutex | ||
| writer *bufio.Writer | ||
| ticker *time.Ticker | ||
| stop chan struct{} | ||
| initialized bool | ||
| } | ||
|
|
||
| const ( | ||
| // _defaultBufferSize specifies the default size used by Buffer. | ||
| _defaultBufferSize = 256 * 1024 // 256 kB | ||
|
|
||
| // _defaultFlushInterval specifies the default flush interval for | ||
| // Buffer. | ||
| _defaultFlushInterval = 30 * time.Second | ||
| ) | ||
|
|
||
| func (s *BufferedWriteSyncer) initialize() { | ||
| s.ws = s.WriteSyncer | ||
|
|
||
| size := s.Size | ||
| if size == 0 { | ||
| size = _defaultBufferSize | ||
| } | ||
|
|
||
| flushInterval := s.FlushInterval | ||
| if flushInterval == 0 { | ||
| flushInterval = _defaultFlushInterval | ||
| } | ||
|
|
||
| if s.Clock == nil { | ||
| s.Clock = DefaultClock | ||
| } | ||
| s.ticker = s.Clock.NewTicker(flushInterval) | ||
|
|
||
| writer := s.WriteSyncer | ||
| if w, ok := writer.(*lockedWriteSyncer); ok { | ||
| writer = w.ws | ||
| } // don't double lock | ||
| s.writer = bufio.NewWriterSize(writer, size) | ||
|
|
||
| s.stop = make(chan struct{}) | ||
| s.initialized = true | ||
| go s.flushLoop() | ||
| } | ||
|
|
||
| // Write writes log data into buffer syncer directly, multiple Write calls will be batched, | ||
| // and log data will be flushed to disk when the buffer is full or periodically. | ||
| func (s *BufferedWriteSyncer) Write(bs []byte) (int, error) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| if !s.initialized { | ||
| s.initialize() | ||
| } | ||
|
|
||
| // To avoid partial writes from being flushed, we manually flush the existing buffer if: | ||
| // * The current write doesn't fit into the buffer fully, and | ||
| // * The buffer is not empty (since bufio will not split large writes when the buffer is empty) | ||
| if len(bs) > s.writer.Available() && s.writer.Buffered() > 0 { | ||
| if err := s.writer.Flush(); err != nil { | ||
| return 0, err | ||
| } | ||
| } | ||
|
|
||
| return s.writer.Write(bs) | ||
| } | ||
|
|
||
| // Sync flushes buffered log data into disk directly. | ||
| func (s *BufferedWriteSyncer) Sync() error { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| return multierr.Append(s.writer.Flush(), s.ws.Sync()) | ||
| } | ||
|
|
||
| // flushLoop flushes the buffer at the configured interval until Close is | ||
| // called. | ||
| func (s *BufferedWriteSyncer) flushLoop() { | ||
| for { | ||
| select { | ||
| case <-s.ticker.C: | ||
| // we just simply ignore error here | ||
| // because the underlying bufio writer stores any errors | ||
| // and we return any error from Sync() as part of the close | ||
| _ = s.Sync() | ||
| case <-s.stop: | ||
| return | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Close closes the buffer, cleans up background goroutines, and flushes | ||
| // remaining, unwritten data. This will not close the underlying WriteSyncer. | ||
| func (s *BufferedWriteSyncer) Close() error { | ||
| s.ticker.Stop() | ||
| close(s.stop) | ||
| return s.Sync() | ||
| } |
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,53 @@ | ||
| // Copyright (c) 2021 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package zapcore | ||
|
|
||
| import ( | ||
| "io/ioutil" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func BenchmarkBufferedWriteSyncer(b *testing.B) { | ||
| b.Run("write file with buffer", func(b *testing.B) { | ||
| file, err := ioutil.TempFile("", "log") | ||
| require.NoError(b, err) | ||
|
|
||
| defer func() { | ||
| assert.NoError(b, file.Close()) | ||
| assert.NoError(b, os.Remove(file.Name())) | ||
| }() | ||
|
|
||
| w := &BufferedWriteSyncer{ | ||
| WriteSyncer: AddSync(file), | ||
| } | ||
| defer w.Close() | ||
| b.ResetTimer() | ||
| b.RunParallel(func(pb *testing.PB) { | ||
| for pb.Next() { | ||
| w.Write([]byte("foobarbazbabble")) | ||
| } | ||
| }) | ||
| }) | ||
| } |
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,119 @@ | ||
| // Copyright (c) 2021 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package zapcore | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/zap/internal/ztest" | ||
| ) | ||
|
|
||
| func TestBufferWriter(t *testing.T) { | ||
| // If we pass a plain io.Writer, make sure that we still get a WriteSyncer | ||
| // with a no-op Sync. | ||
| t.Run("sync", func(t *testing.T) { | ||
| buf := &bytes.Buffer{} | ||
| ws := &BufferedWriteSyncer{WriteSyncer: AddSync(buf)} | ||
|
|
||
| requireWriteWorks(t, ws) | ||
| assert.Empty(t, buf.String(), "Unexpected log calling a no-op Write method.") | ||
| assert.NoError(t, ws.Sync(), "Unexpected error calling a no-op Sync method.") | ||
| assert.Equal(t, "foo", buf.String(), "Unexpected log string") | ||
| assert.NoError(t, ws.Close()) | ||
| }) | ||
|
|
||
| t.Run("close", func(t *testing.T) { | ||
| buf := &bytes.Buffer{} | ||
| ws := &BufferedWriteSyncer{WriteSyncer: AddSync(buf)} | ||
| requireWriteWorks(t, ws) | ||
| assert.Empty(t, buf.String(), "Unexpected log calling a no-op Write method.") | ||
| assert.NoError(t, ws.Close()) | ||
| assert.Equal(t, "foo", buf.String(), "Unexpected log string") | ||
| }) | ||
|
|
||
| t.Run("wrap twice", func(t *testing.T) { | ||
| buf := &bytes.Buffer{} | ||
| bufsync := &BufferedWriteSyncer{WriteSyncer: AddSync(buf)} | ||
| ws := &BufferedWriteSyncer{WriteSyncer: bufsync} | ||
| requireWriteWorks(t, ws) | ||
| assert.Empty(t, buf.String(), "Unexpected log calling a no-op Write method.") | ||
| require.NoError(t, ws.Sync()) | ||
| assert.Equal(t, "foo", buf.String()) | ||
| assert.NoError(t, ws.Close()) | ||
| assert.NoError(t, bufsync.Close()) | ||
| assert.Equal(t, "foo", buf.String(), "Unexpected log string") | ||
| }) | ||
|
|
||
| t.Run("small buffer", func(t *testing.T) { | ||
| buf := &bytes.Buffer{} | ||
| ws := &BufferedWriteSyncer{WriteSyncer: AddSync(buf), Size: 5} | ||
|
|
||
| requireWriteWorks(t, ws) | ||
| assert.Equal(t, "", buf.String(), "Unexpected log calling a no-op Write method.") | ||
| requireWriteWorks(t, ws) | ||
| assert.Equal(t, "foo", buf.String(), "Unexpected log string") | ||
| assert.NoError(t, ws.Close()) | ||
| }) | ||
|
|
||
| t.Run("with lockedWriteSyncer", func(t *testing.T) { | ||
| buf := &bytes.Buffer{} | ||
| ws := &BufferedWriteSyncer{WriteSyncer: Lock(AddSync(buf)), Size: 5} | ||
|
|
||
| requireWriteWorks(t, ws) | ||
| assert.Equal(t, "", buf.String(), "Unexpected log calling a no-op Write method.") | ||
| requireWriteWorks(t, ws) | ||
| assert.Equal(t, "foo", buf.String(), "Unexpected log string") | ||
| assert.NoError(t, ws.Close()) | ||
| }) | ||
|
|
||
| t.Run("flush error", func(t *testing.T) { | ||
| ws := &BufferedWriteSyncer{WriteSyncer: &ztest.FailWriter{}, Size: 4} | ||
| n, err := ws.Write([]byte("foo")) | ||
| require.NoError(t, err, "Unexpected error writing to WriteSyncer.") | ||
| require.Equal(t, 3, n, "Wrote an unexpected number of bytes.") | ||
| ws.Write([]byte("foo")) | ||
| assert.Error(t, ws.Close(), "Expected close to fail.") | ||
| }) | ||
|
|
||
| t.Run("flush timer", func(t *testing.T) { | ||
| buf := &bytes.Buffer{} | ||
| clock := newControlledClock() | ||
| ws := &BufferedWriteSyncer{ | ||
| WriteSyncer: AddSync(buf), | ||
| Size: 6, | ||
| FlushInterval: time.Microsecond, | ||
| Clock: clock, | ||
| } | ||
| requireWriteWorks(t, ws) | ||
| clock.Add(10 * time.Microsecond) | ||
| assert.Equal(t, "foo", buf.String(), "Unexpected log string") | ||
|
|
||
| // flush twice to validate loop logic | ||
| requireWriteWorks(t, ws) | ||
| clock.Add(10 * time.Microsecond) | ||
| assert.Equal(t, "foofoo", buf.String(), "Unexpected log string") | ||
| assert.NoError(t, ws.Close()) | ||
| }) | ||
| } |
Oops, something went wrong.