-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
qlog: defer creation of the qlog file in QLOGDIR until the first write #4310
Open
marten-seemann
wants to merge
1
commit into
master
Choose a base branch
from
qlogdir-deferred-file-creation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -4,14 +4,55 @@ import ( | |||||
"bufio" | ||||||
"context" | ||||||
"fmt" | ||||||
"log" | ||||||
"io" | ||||||
"os" | ||||||
"strings" | ||||||
|
||||||
"github.com/quic-go/quic-go/internal/utils" | ||||||
"github.com/quic-go/quic-go/logging" | ||||||
) | ||||||
|
||||||
// lazyWriteCloser creates the qlog file when the first log line is written. | ||||||
// This means that creating the qlog (there's no guarantee how long the syscalls will take) | ||||||
// won't block the connection, since qlogs are serialized from a separate Go routine, | ||||||
// that takes events from a buffered channel (size: eventChanSize). | ||||||
type lazyWriteCloser struct { | ||||||
createFile func() (*os.File, error) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
createFileErr error | ||||||
io.WriteCloser | ||||||
} | ||||||
|
||||||
func (w *lazyWriteCloser) init() error { | ||||||
if w.createFileErr != nil { | ||||||
return w.createFileErr | ||||||
} | ||||||
if w.createFile == nil { | ||||||
return nil | ||||||
} | ||||||
f, err := w.createFile() | ||||||
if err != nil { | ||||||
w.createFileErr = err | ||||||
return err | ||||||
} | ||||||
w.createFile = nil | ||||||
w.WriteCloser = utils.NewBufferedWriteCloser(bufio.NewWriter(f), f) | ||||||
return nil | ||||||
} | ||||||
|
||||||
func (w *lazyWriteCloser) Write(b []byte) (int, error) { | ||||||
if err := w.init(); err != nil { | ||||||
return 0, err | ||||||
} | ||||||
return w.WriteCloser.Write(b) | ||||||
} | ||||||
|
||||||
func (w *lazyWriteCloser) Close() error { | ||||||
if err := w.init(); err != nil { | ||||||
return err | ||||||
} | ||||||
return w.WriteCloser.Close() | ||||||
} | ||||||
|
||||||
// DefaultTracer creates a qlog file in the qlog directory specified by the QLOGDIR environment variable. | ||||||
// File names are <odcid>_<perspective>.qlog. | ||||||
// Returns nil if QLOGDIR is not set. | ||||||
|
@@ -34,16 +75,17 @@ func qlogDirTracer(p logging.Perspective, connID logging.ConnectionID, label str | |||||
if qlogDir == "" { | ||||||
return nil | ||||||
} | ||||||
if _, err := os.Stat(qlogDir); os.IsNotExist(err) { | ||||||
if err := os.MkdirAll(qlogDir, 0o755); err != nil { | ||||||
log.Fatalf("failed to create qlog dir %s: %v", qlogDir, err) | ||||||
return NewConnectionTracer(&lazyWriteCloser{createFile: func() (*os.File, error) { | ||||||
if _, err := os.Stat(qlogDir); os.IsNotExist(err) { | ||||||
if err := os.MkdirAll(qlogDir, 0o755); err != nil { | ||||||
return nil, fmt.Errorf("failed to create qlog dir %s: %v", qlogDir, err) | ||||||
} | ||||||
} | ||||||
} | ||||||
path := fmt.Sprintf("%s/%s_%s.qlog", strings.TrimRight(qlogDir, "/"), connID, label) | ||||||
f, err := os.Create(path) | ||||||
if err != nil { | ||||||
log.Printf("Failed to create qlog file %s: %s", path, err.Error()) | ||||||
return nil | ||||||
} | ||||||
return NewConnectionTracer(utils.NewBufferedWriteCloser(bufio.NewWriter(f), f), p, connID) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. have you intentionally removed the buffered writer? |
||||||
path := fmt.Sprintf("%s/%s_%s.qlog", strings.TrimRight(qlogDir, "/"), connID, label) | ||||||
f, err := os.Create(path) | ||||||
if err != nil { | ||||||
return nil, fmt.Errorf("failed to create qlog file %s: %s", path, err.Error()) | ||||||
} | ||||||
return f, nil | ||||||
}}, p, connID) | ||||||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should this util be exported just like utils.NewBufferedWriteCloser