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

Document reth's tracing targets #11990

Open
Rjected opened this issue Oct 22, 2024 · 4 comments · May be fixed by #13253
Open

Document reth's tracing targets #11990

Rjected opened this issue Oct 22, 2024 · 4 comments · May be fixed by #13253
Assignees
Labels
C-docs An addition or correction to our documentation C-enhancement New feature or request

Comments

@Rjected
Copy link
Member

Rjected commented Oct 22, 2024

We have a lot of different trace targets, and we don't have any broad overview of what trace targets someone might want to turn on if they're trying to debug a component or protocol.

We should list all specific log targets, for example some crates have log targets that are different than the crate name or are organized differently than just with crates:

trace!(target: "net", ?peer_id, "Peer added");

error!(target: "engine::tree", "Fatal error");

The document should also contain a list of crates that typically do not use targets like this, for example with reth_eth_wire:

trace!(
status=%resp,
"validating incoming eth status from peer"
);

The docs should try to explain whether or not the log level makes a difference, and what gets logged, for example:

  • reth_eth_wire has trace! and debug! targets. It outputs RLPx session related information with trace targets, and mostly outputs debug logs if an error has occurred somewhere in the session
@Rjected Rjected added C-docs An addition or correction to our documentation C-enhancement New feature or request labels Oct 22, 2024
@nadtech-hub
Copy link
Contributor

🙋‍♂️

@Rjected
Copy link
Member Author

Rjected commented Nov 1, 2024

@nadtech-hub assigned!

@nadtech-hub
Copy link
Contributor

nadtech-hub commented Nov 20, 2024

@Rjected It's been a while since I started and I'm wrapping this up shortly. Will you be fine with such doc structure?
Image

@Rjected
Copy link
Member Author

Rjected commented Nov 20, 2024

@Rjected It's been a while since I started and I'm wrapping this up shortly. Will you be fine with such doc structure? Image

This is great! definitely ping me for review when you have a PR ready, even if draft, so I can give feedback while you finish it up

@nadtech-hub nadtech-hub linked a pull request Dec 9, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-docs An addition or correction to our documentation C-enhancement New feature or request
Projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

2 participants