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

drop lighthouse-reth-integration #425

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

This file was deleted.

43 changes: 43 additions & 0 deletions projects/tracing-integration-lighthouse.md
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)