Skip to content
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.

Sign up for GitHub

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

Jump to bottom

qlog: rename DefaultTracer to DefaultConnectionTracer #4556

Merged
merged 1 commit into from
Jun 5, 2024
Merged

qlog: rename DefaultTracer to DefaultConnectionTracer #4556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
qlog: rename DefaultTracer to DefaultConnectionTracer
  • Loading branch information
@marten-seemann
marten-seemann committed Jun 5, 2024
commit 746c9f76b1fb211940f9acaf036ffc19eef33287
2 changes: 1 addition & 1 deletion example/client/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func main() {
KeyLogWriter: keyLog,
},
QUICConfig: &quic.Config{
Tracer: qlog.DefaultTracer,
Tracer: qlog.DefaultConnectionTracer,
},
}
defer roundTripper.Close()
Expand Down
2 changes: 1 addition & 1 deletion example/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ func main() {
Handler: handler,
Addr: bCap,
QUICConfig: &quic.Config{
Tracer: qlog.DefaultTracer,
Tracer: qlog.DefaultConnectionTracer,
},
}
err = server.ListenAndServeTLS(certFile, keyFile)
Expand Down
4 changes: 2 additions & 2 deletions integrationtests/self/qlog_dir_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ var _ = Describe("qlog dir tests", Serial, func() {
"localhost:0",
getTLSConfig(),
&quic.Config{
Tracer: qlog.DefaultTracer,
Tracer: qlog.DefaultConnectionTracer,
},
)
Expect(err).ToNot(HaveOccurred())
Expand All @@ -56,7 +56,7 @@ var _ = Describe("qlog dir tests", Serial, func() {
server.Addr().String(),
getTLSClientConfig(),
&quic.Config{
Tracer: qlog.DefaultTracer,
Tracer: qlog.DefaultConnectionTracer,
},
)
Expect(err).ToNot(HaveOccurred())
Expand Down
8 changes: 7 additions & 1 deletion qlog/qlog_dir.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,15 @@ import (
)

// DefaultTracer creates a qlog file in the qlog directory specified by the QLOGDIR environment variable.
// Deprecated: use DefaultConnectionTracer instead.
func DefaultTracer(ctx context.Context, p logging.Perspective, connID logging.ConnectionID) *logging.ConnectionTracer {
return DefaultConnectionTracer(ctx, p, connID)
}

// DefaultConnectionTracer 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.
func DefaultTracer(_ context.Context, p logging.Perspective, connID logging.ConnectionID) *logging.ConnectionTracer {
func DefaultConnectionTracer(_ context.Context, p logging.Perspective, connID logging.ConnectionID) *logging.ConnectionTracer {
var label string
switch p {
case logging.PerspectiveClient:
Expand Down
4 changes: 2 additions & 2 deletions qlog/qlog_dir_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ var _ = Describe("qlog dir tests", Serial, func() {
qlogDir := path.Join(tempTestDirPath, "qlogs")
err := os.Setenv("QLOGDIR", qlogDir)
Expect(err).ToNot(HaveOccurred())
tracer := DefaultTracer(ctx, perspective, connID)
tracer := DefaultConnectionTracer(ctx, perspective, connID)
Expect(tracer).ToNot(BeNil())
tracer.Close()
_, err = os.Stat(qlogDir)
Expand All @@ -50,7 +50,7 @@ var _ = Describe("qlog dir tests", Serial, func() {
It("environment variable is not set", func() {
err := os.Setenv("QLOGDIR", "")
Expect(err).ToNot(HaveOccurred())
tracer := DefaultTracer(ctx, perspective, connID)
tracer := DefaultConnectionTracer(ctx, perspective, connID)
Expect(tracer).To(BeNil())
})
})
Loading