Skip to content

chore(vpn): send info, debug logs over tunnel #18240

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

Merged
merged 2 commits into from
Jun 6, 2025

Conversation

ethanndickson
Copy link
Member

@ethanndickson ethanndickson commented Jun 5, 2025

Copy link
Member Author

ethanndickson commented Jun 5, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@@ -65,7 +65,6 @@ func (r *RootCmd) vpnDaemonRun() *serpent.Command {
logger.Info(ctx, "starting tunnel")
tunnel, err := vpn.NewTunnel(ctx, logger, pipe, vpn.NewClient(),
vpn.UseOSNetworkingStack(),
vpn.UseAsLogger(),
Copy link
Member Author

@ethanndickson ethanndickson Jun 5, 2025

Choose a reason for hiding this comment

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

The Windows app drops logs received over the tunnel, so this can be removed. It adds it's own sink to stderr.

Comment on lines +305 to +310
select {
case <-t.updater.ctx.Done():
return
case <-t.ctx.Done():
return
case t.sendCh <- msg:
Copy link
Member Author

Choose a reason for hiding this comment

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

We deliberately never cancel the tunnel ctx, due to the somewhat precarious teardown procedure. We do however cancel the updater ctx to ensure we don't tick network updates after shutdown, so we'll check for that here too.

Comment on lines -49 to -50
logMu sync.Mutex
logs []*TunnelMessage
Copy link
Member Author

@ethanndickson ethanndickson Jun 5, 2025

Choose a reason for hiding this comment

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

I'm not seeing any value in this buffer, as we don't do any disk I/O - the pipe is entirely in-memory. With pings every 5 seconds and debug logs on, we produce around 150~ logs a minute, or about 35 kilobytes. The in-memory pipe can handle gigabytes a second. I think buffering would make sense were we relaying the logs to a terminal or a file, but that's not the case here.

Since only Error and above logs are flushed immediately, the alternative is adding the complexity of flushing the logs from the buffer periodically. One downside of this is that the macOS timestamps on the logs once they reach the Swift code aren't actually representative of the time the log was produced.

@ethanndickson ethanndickson marked this pull request as ready for review June 5, 2025 04:13
@ethanndickson ethanndickson force-pushed the ethan/send-more-logs-over-tunnel branch from c65ebb2 to 8d8937d Compare June 5, 2025 04:41
Copy link
Member Author

ethanndickson commented Jun 6, 2025

Merge activity

  • Jun 6, 4:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jun 6, 4:20 AM UTC: Graphite rebased this pull request as part of a merge.
  • Jun 6, 4:31 AM UTC: @ethanndickson merged this pull request with Graphite.

@ethanndickson ethanndickson changed the base branch from ethan/send-ping-results to graphite-base/18240 June 6, 2025 04:18
@ethanndickson ethanndickson changed the base branch from graphite-base/18240 to main June 6, 2025 04:19
@ethanndickson ethanndickson force-pushed the ethan/send-more-logs-over-tunnel branch from c5c1ab5 to 8535d64 Compare June 6, 2025 04:19
@ethanndickson
Copy link
Member Author

ethanndickson commented Jun 6, 2025

Review request can be ignored - graphite touched proto files for a moment doing it's branch switching + rebase (why?).

@ethanndickson ethanndickson merged commit 628b81c into main Jun 6, 2025
35 checks passed
@ethanndickson ethanndickson deleted the ethan/send-more-logs-over-tunnel branch June 6, 2025 04:31
@github-actions github-actions bot locked and limited conversation to collaborators Jun 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CoderVPN: Surface logs of Info level and lower
2 participants