-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
drop lighthouse-reth-integration (#425)
* split project proposal * nit * nit * drop lighthouse-reth-integration * nit
- Loading branch information
1 parent
7bd4509
commit 2e08be0
Showing
2 changed files
with
43 additions
and
64 deletions.
There are no files selected for viewing
64 changes: 0 additions & 64 deletions
64
.../direct-integration-of-lighthouse-reth-and-tracing-integration-in-lighthouse.md
This file was deleted.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Tracing integration in Lighthouse | ||
## Motivation | ||
|
||
[Tracing framework](https://slog.rs/) is good at providing additional context to logs,especially in multi threaded async software like Lighthouse. It makes interpreting logs much easier and will help devs identify and fix bugs faster. | ||
## Project description | ||
Currently lighthouse mostly uses [`slog`](https://slog.rs/) for logging (although in some parts it uses `tracing` in network stack).My project will be to migrate it all to [`tracing`](https://docs.rs/tracing/latest/tracing/) | ||
|
||
## Specification | ||
- We'll replace `slog` and `log` with `tracing` through-out their codebase | ||
- Handle SSE logging with a tracing subscriber | ||
- Replace [`sloggers`](https://github.com/sile/sloggers)(which is currently being used to emit logs into logfile) | ||
|
||
## Roadmap | ||
- phase 1 : Migrate all crates which are currently using `slog` & `log` to `tracing` | ||
- phase 2 : Replace sloggers | ||
- phase 3 : Convert the custom formatter to make it compatible with tracing | ||
- phase 4 : Handle SSE logging | ||
|
||
|
||
|
||
## Possible challenges | ||
|
||
For last ~1.5 years I've been working in the smart-contract security research/auditing space & aside from doing some small contributions here and there I was mostly out of touch from coding anything major for a while,so it can be a bit challenging for me to work at a fast pace initially as I got very rusty. | ||
|
||
## Goal of the project | ||
By the end of fellowship,the goal is to | ||
- Get the [PR](https://github.com/sigp/lighthouse/pull/6339) for tracing integration merged in to Lighthouse | ||
|
||
|
||
## Collaborators | ||
|
||
### Fellows | ||
|
||
[Sayan](https://github.com/ThreeHrSleep/) | ||
|
||
### Mentors | ||
- [Age Manning](https://github.com/agemanning) | ||
- [Eitan Seri-Levi](https://github.com/eserilev) | ||
- [Mac Ladson](https://github.com/macladson) | ||
|
||
## Resources | ||
|
||
[list of resources that I am & will be using](https://hackmd.io/@threehrsleep/list-of-resources-for-my-epf-project) |