refactor(iroh): gate net_report API behind unstable-net-report feature#4338
Merged
Conversation
11 tasks
Frando
commented
Jun 12, 2026
| // exported primarily for use in documentation | ||
| defaults::timeouts::TIMEOUT, | ||
| metrics::Metrics, | ||
| probes::Probe, |
Member
Author
There was a problem hiding this comment.
Probe and RelayLatencies are accessible via Report::relay_latencies (only under unstable-custom-transports)
Frando
commented
Jun 12, 2026
| //! etc and reachability to the configured relays. | ||
| // Based on <https://github.com/tailscale/tailscale/blob/main/net/netcheck/netcheck.go> | ||
|
|
||
| #![cfg_attr(iroh_docsrs, feature(doc_cfg))] |
Member
Author
There was a problem hiding this comment.
unrelated to the PR, but we declare these at the root level already, I think these are oversights from when we moved net_report back into iroh
Frando
force-pushed
the
Frando/gate-net-report
branch
from
7855bd6 to
d8e3b40
Compare
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/4338/docs/iroh/ Last updated: 2026-06-15T07:54:35Z |
1 task
dignifiedquire
approved these changes
Jun 15, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
We have a
doc_hiddenfunctionsEndpoint::net_reportandEndpoint::last_net_report. This PR putiroh::Endpoint::net_reportbehind a new featureunstable-net-reportinstead, together with the items exposed via these functions (i.e.NetReportand contained items).Also marked the
NetReportandProbeitems asnon_exhaustive, and removesiroh::Endpoint::last_net_reportto keep the unstable API surface small (you can just callEndpoint::net_report().get()to get the latest net report).Breaking Changes
None, because we don't consider the previous
doc(hidden)API as public API.Listing the changes nevertheless here (but not marking the PR as breaking):
iroh::Endpoint::net_reportis now gated behindunstable-net-reportfeatureiroh::Endpoint::last_net_report. Useiroh::Endpoint::net_report().get()instead.iroh::NetReport. it is now available only with theunstable-net-reportfeature underiroh::unstable_net_report::NetReportNotes & open questions
Change checklist