FuelLabs/fuel-core

Create users friendly logs

Open

#1,662 opened on Feb 12, 2024

View on GitHub
 (5 comments) (1 reaction) (0 assignees)Rust (57,084 stars) (2,861 forks)batch import
good first issue

Description

Deliverables:

  • Add some standards to the Engineering Style Guide
  • Logs for relayer block logs are not clearly from L1. We should also highlight L2 blocks that way.
  • Logs for P2P connections
  • Logs for Gas Price Service/Updater code

Contributor guide

Tech stack
rust
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic RustUnderstanding of logging
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Start by examining the existing logging patterns in the fuel core codebase, particularly in the relayer, P2P, and gas price service modules. Look at how logs are currently structured (e.g., log levels, context fields) and then implement similar logging for the areas mentioned. The Engineering Style Guide should also be updated to document the new standards. Refer to the comments on the issue for any additional guidance from maintainers.