ref(iroh-net): Do not add the NodeId in the magicsock span field

[flub]

Description

Since we have made MagicSock private it should always be created via the Endpoint, unless we are internally messing around with tests or so. Because of this we can make sure that the Endpoint always attaches the correct "me" field to the span. Reducing the amount of noise in the default log output.

Breaking Changes

None

Notes & open questions

Please do not merge before #2595 is merged. I'm trying to not add any further changes to that PR.

Change checklist

• Self-review.
• [ ] Documentation updates following the style guide, if relevant.
• [ ] Tests if relevant.
• [ ] All breaking changes documented.

[github-actions]

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2679/docs/iroh/

Last updated: 2024-08-29T10:40:51Z

[matheus23]

Small comparison for people wondering:
main:

$ RUST_LOG=iroh_net=trace cargo test -p iroh-net --lib -- endpoint_connect_close --nocapture | grep re_stun
   Compiling iroh-net v0.23.0 (/home/philipp/program/work/iroh/iroh-net)
    Finished `test` profile [unoptimized + debuginfo] target(s) in 26.56s
     Running unittests src/lib.rs (target/debug/deps/iroh_net-6c4d4b2dbab2ace8)
2024-08-29T09:59:51.769798Z DEBUG test-client:connect{me=4bgr2mpvame67knd remote=rzd5j76x5cgsvttn alpn="n0/iroh/test"}:try_send:re_stun{me=4bgr2mpvame67knd}: iroh_net::magicsock: 1249: re_stun: refresh-for-peering
2024-08-29T09:59:51.771685Z TRACE test-server:ep{me=rzd5j76x5cgsvttn}:magicsock{me=rzd5j76x5cgsvttn}:actor: iroh_net::magicsock: 1843: tick: re_stun Instant { tv_sec: 253792, tv_nsec: 894112852 }
2024-08-29T09:59:51.771733Z DEBUG test-server:ep{me=rzd5j76x5cgsvttn}:magicsock{me=rzd5j76x5cgsvttn}:actor:re_stun{me=rzd5j76x5cgsvttn}: iroh_net::magicsock: 1249: re_stun: periodic
2024-08-29T09:59:51.771943Z TRACE test-client:ep{me=4bgr2mpvame67knd}:magicsock{me=4bgr2mpvame67knd}:actor: iroh_net::magicsock: 1843: tick: re_stun Instant { tv_sec: 253792, tv_nsec: 896262050 }
2024-08-29T09:59:51.771974Z DEBUG test-client:ep{me=4bgr2mpvame67knd}:magicsock{me=4bgr2mpvame67knd}:actor:re_stun{me=4bgr2mpvame67knd}: iroh_net::magicsock: 1249: re_stun: periodic

This branch:

$ RUST_LOG=iroh_net=trace cargo test -p iroh-net --lib -- endpoint_connect_close --nocapture | grep re_stun
    Finished `test` profile [unoptimized + debuginfo] target(s) in 0.25s
     Running unittests src/lib.rs (target/debug/deps/iroh_net-6c4d4b2dbab2ace8)
2024-08-29T09:59:13.451701Z DEBUG test-client:connect{me=k5iwgxt73rr6hewa remote=65jc2o5fib5sqxv7 alpn="n0/iroh/test"}:try_send:re_stun: iroh_net::magicsock: 1249: re_stun: refresh-for-peering
2024-08-29T09:59:13.453721Z TRACE test-server:ep{me=65jc2o5fib5sqxv7}:magicsock:actor: iroh_net::magicsock: 1843: tick: re_stun Instant { tv_sec: 253754, tv_nsec: 575697553 }
2024-08-29T09:59:13.453760Z DEBUG test-server:ep{me=65jc2o5fib5sqxv7}:magicsock:actor:re_stun: iroh_net::magicsock: 1249: re_stun: periodic
2024-08-29T09:59:13.454010Z TRACE test-client:ep{me=k5iwgxt73rr6hewa}:magicsock:actor: iroh_net::magicsock: 1843: tick: re_stun Instant { tv_sec: 253754, tv_nsec: 578197257 }
2024-08-29T09:59:13.454051Z DEBUG test-client:ep{me=k5iwgxt73rr6hewa}:magicsock:actor:re_stun: iroh_net::magicsock: 1249: re_stun: periodic

So much better.