[tailscale] net: add SockTrace API #45
Merged
Conversation
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
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 3, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. Signed-off-by: Mihai Parparita <mihai@tailscale.com>
bradfitz
reviewed
Feb 3, 2023
src/net/sock_posix.go
Outdated
Comment on lines
16
to
25
| type SockTrace struct { | ||
| DidRead func(int) | ||
| DidWrite func(int) | ||
| } | ||
|
|
||
| func WithSockTrace(ctx context.Context, trace *SockTrace) context.Context { | ||
| return context.WithValue(ctx, sockTraceKey{}, trace) | ||
| } | ||
|
|
||
| type sockTraceKey struct{} |
There was a problem hiding this comment.
so if you wanted to be lazy and bend the context.Context rules a bit, you can just use a string as the context.Value key, like:
"[tailscale.com]didread-func" and "[tailscale.com]didwrite-func" and then ditch these three symbols.
Then you could use it safely from the tailscaled side without build tags. Either way.
There was a problem hiding this comment.
Was thinking that it should be something more type safe so that
- we get an error if you build it with the wrong toolchain (as opposed to stats silently breaking)
- it's a nicer API, and in theory could be upstreamed
But if you think there's ~0 chance that this could/should be upstreamed, happy to change it.
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 24, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 24, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
force-pushed
the
mihaip/sock-trace
branch
from
c473f4b
to
4ab6a1b
Compare
mihaip
force-pushed
the
mihaip/sock-trace
branch
from
4ab6a1b
to
ec544e5
Compare
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 27, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
force-pushed
the
mihaip/sock-trace
branch
from
ec544e5
to
6234152
Compare
bradfitz
approved these changes
Feb 28, 2023
Loosely inspired by nettrace/httptrace, allows functions to be called when sockets are read from or written to. The hooks are specified via the context (with a WithSockTrace function). Only implemented for network sockets on POSIX systems. Updates tailscale/corp#9230 Updates #58
mihaip
force-pushed
the
mihaip/sock-trace
branch
from
6234152
to
b2969cb
Compare
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 28, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 28, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 28, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 28, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Feb 28, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Mar 1, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Mar 1, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. Enabled on iOS, macOS and Android only, since mobile platforms are the ones we're most interested in, and we are less sensitive to any throughput degradation due to the per-I/O callback overhead (macOS is also enabled for ease of testing during development). For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
to tailscale/tailscale
that referenced
this pull request
Mar 1, 2023
Uses the hooks added by tailscale/go#45 to instrument the reads and writes on the major code paths that do network I/O in the client. The convention is to use "<package>.<type>:<label>" as the annotation for the responsible code path. Enabled on iOS, macOS and Android only, since mobile platforms are the ones we're most interested in, and we are less sensitive to any throughput degradation due to the per-I/O callback overhead (macOS is also enabled for ease of testing during development). For now just exposed as counters on a /v0/sockstats PeerAPI endpoint. We also keep track of the current interface so that we can break out the stats by interface. Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
mihaip
added a commit
that referenced
this pull request
Mar 8, 2023
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58
mihaip
added a commit
that referenced
this pull request
Mar 8, 2023
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58
mihaip
added a commit
that referenced
this pull request
Mar 8, 2023
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58
mihaip
added a commit
that referenced
this pull request
Mar 8, 2023
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58
phirework
added a commit
that referenced
this pull request
Jun 21, 2023
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58 Signed-off-by: Jenny Zhang <jz@tailscale.com> (Cherry-picked from db4dc90)
phirework
added a commit
that referenced
this pull request
Jun 21, 2023
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58 Signed-off-by: Jenny Zhang <jz@tailscale.com> (Cherry-picked from db4dc90)
phirework
added a commit
that referenced
this pull request
Jun 22, 2023
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58 Signed-off-by: Jenny Zhang <jz@tailscale.com> (Cherry-picked from db4dc90)
awly
pushed a commit
that referenced
this pull request
Feb 7, 2024
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58 Signed-off-by: Jenny Zhang <jz@tailscale.com> (Cherry-picked from db4dc90)
awly
pushed a commit
that referenced
this pull request
Feb 7, 2024
Extends the hooks added by #45 to also expose when TCP sockets are created or closed (meant to allow TCP stats to be read from them). We don't do this for all socket types since stats are not available for UDP sockets, and they tend to be short-lived, thus invoking the hooks would be useless overhead. Also fixes read/write hooks to not count out-of-band data, since that's usually not sent over the wire. Updates tailscale/corp#9230 Updates #58 Signed-off-by: Jenny Zhang <jz@tailscale.com> (Cherry-picked from db4dc90)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Loosely inspired by
nettrace/httptrace, allows functions to be called when sockets are read from or written to. The hooks are specified via the context (with aWithSockTracefunction).Only implemented for network sockets on POSIX systems.
Updates tailscale/corp#9230
Updates #58