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.

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

deprecate the ConnectionTracingKey #4532

Merged
merged 1 commit into from
May 28, 2024

Conversation

marten-seemann
Copy link
Member

Applications can set their own tracing key using Transport.ConnContext.

Applications can set their own tracing key using Transport.ConnContext.
@marten-seemann marten-seemann added this to the v0.45 milestone May 27, 2024
Copy link

codecov bot commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.16%. Comparing base (0d1e27d) to head (9ada8da).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4532      +/-   ##
==========================================
+ Coverage   85.14%   85.16%   +0.02%     
==========================================
  Files         154      154              
  Lines       14803    14803              
==========================================
+ Hits        12603    12606       +3     
+ Misses       1692     1689       -3     
  Partials      508      508              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@marten-seemann
Copy link
Member Author

cc @sukunrt and @MarcoPolo, this will affect your use case of quic-go

@marten-seemann marten-seemann merged commit 21b643e into master May 28, 2024
34 checks passed
var ConnectionTracingKey = connTracingCtxKey{}

// ConnectionTracingID is the type of the context value saved under the ConnectionTracingKey.
// Deprecated: Applications can set their own tracing key using Transport.ConnContext.
type ConnectionTracingID uint64
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the type of the context value now?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now, everything stays as is, it's just deprecated.

In the future, there won't be a quic.ConnectionTracingKey anymore. Instead, you will need to inject your own value on the context using Transport.ConnContext (see quic-go/docs#60).

@MarcoPolo
Copy link
Collaborator

Sounds good. Would help me (and maybe others) if there was a simple migration path call out in the release notes. 🙏

@marten-seemann
Copy link
Member Author

For sure, this will be called out in the release notes, and we'll link to the new section on the documentation page.

@marten-seemann marten-seemann deleted the deprecate-connection-tracing-key branch June 4, 2024 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants