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

refactor(iroh-net): Various logging improvements #2744

Merged
merged 3 commits into from
Sep 23, 2024
Merged

Conversation

flub
Copy link
Contributor

@flub flub commented Sep 23, 2024

Description

  • Attach the spans when spawning the local-swarm-discovery. We should
    always use .instrument() when spawning.

  • Clearly log the start and end of connection establishment.

  • In the events.net.* events always use remote_node when showing the
    NodeId of the remote node. These were introduced before we settled
    on the "remote node" terminology, now it makes more sense to double
    down on this as it makes the logs clearer.

Breaking Changes

None, events.net is not considered part of the public API.

Notes & open questions

Change checklist

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

- Attach the spans when spawning the local-swarm-discovery.  We should
  always use .instrument() when spawning.

- Clearly log the start and end of connection establishment.

- In the events.net.* events always use remote_node when showing the
  NodeId of the remote node.  These were introduced before we settled
  on the "remote node" terminology, now it makes more sense to double
  down on this as it makes the logs clearer.
@flub flub requested a review from ramfox September 23, 2024 15:40
Copy link

github-actions bot commented Sep 23, 2024

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

Last updated: 2024-09-23T21:35:48Z

@flub flub enabled auto-merge September 23, 2024 16:27
Copy link
Contributor

@divagant-martian divagant-martian left a comment

Choose a reason for hiding this comment

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

lgtm. For the sake of getting such a simple change in quickly, I modified this to reduce the large confusing diff. Better to have a clean git history

@flub flub added this pull request to the merge queue Sep 23, 2024
Merged via the queue into main with commit 2262fd5 Sep 23, 2024
27 checks passed
@flub
Copy link
Contributor Author

flub commented Sep 24, 2024

lgtm. For the sake of getting such a simple change in quickly, I modified this to reduce the large confusing diff. Better to have a clean git history

oh yes, clever move.

@flub flub deleted the flub/log-various branch September 24, 2024 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants