feat(consensus): add tracing instrumentation and logging to consensus

[matan-starkware]

This change is 

[matan-starkware]

• feat(consensus): add Vote message to proto #2131
• feat(consensus): add milestone 2 state machine #2126
• feat(consensus): consensus should only register with the network if it will run #2152
• feat(consensus): add README to help running milestone 1 #2141
• feat(consensus): add sequencing crates to some CI flows #2134
• feat(consensus): add tracing instrumentation and logging to consensus #2138 👈
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @matan-starkware and the rest of your teammates on Graphite

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 65.90%. Comparing base (8f745ec) to head (aff6ab1).
Report is 3 commits behind head on main.

Files	Patch %	Lines
...g/papyrus_consensus/src/single_height_consensus.rs	0.00%	3 Missing ⚠️
crates/papyrus_node/src/main.rs	0.00%	1 Missing ⚠️
crates/sequencing/papyrus_consensus/src/lib.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2138      +/-   ##
==========================================
+ Coverage   65.67%   65.90%   +0.23%     
==========================================
  Files         135      135              
  Lines       17886    17808      -78     
  Branches    17886    17808      -78     
==========================================
- Hits        11747    11737      -10     
+ Misses       4852     4784      -68     
  Partials     1287     1287              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[dan-starkware]

Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status: all files reviewed, 4 unresolved discussions (waiting on @matan-starkware)

---

crates/papyrus_node/src/main.rs line 101 at r1 (raw file):

) -> anyhow::Result<JoinHandle<Result<(), ConsensusError>>> {
    let Ok(validator_id) = env::var("CONSENSUS_VALIDATOR_ID") else {
        debug!("CONSENSUS_VALIDATOR_ID is not set. Not running consensus.");

Can remain info IMO

Code quote:

debug!

---

crates/sequencing/papyrus_consensus/src/lib.rs line 23 at r1 (raw file):

// TODO(dvir): add test for this.
#[instrument(

Consider adding explicit level

Code quote:

#[instrument(

---

crates/sequencing/papyrus_consensus/src/lib.rs line 24 at r1 (raw file):

// TODO(dvir): add test for this.
#[instrument(
    skip(context, start_height, network_receiver),

Why skipping start height?

Code quote:

start_height

---

crates/sequencing/papyrus_consensus/src/single_height_consensus.rs line 40 at r1 (raw file):

    }

    #[instrument(skip(self), fields(height=self.height.0), level = "info")]

Why not debug?

Code quote:

level = "info"

---

crates/sequencing/papyrus_consensus/src/single_height_consensus.rs line 76 at r1 (raw file):

        skip(self, init, content_receiver, fin_receiver),
        fields(height = %self.height),
        level = "info"

Why not debug?

Code quote:

level = "info"

The base branch was changed.

[matan-starkware]

Reviewable status: 0 of 3 files reviewed, 1 unresolved discussion (waiting on @dan-starkware)

---

crates/sequencing/papyrus_consensus/src/lib.rs line 24 at r1 (raw file):

Previously, dan-starkware wrote…

Why skipping start height?

Because these fields are printed out with every single log within this scope. I only want to print the starting height once when I begin.

[dan-starkware]

Reviewed 3 of 3 files at r2, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @matan-starkware)

---

crates/sequencing/papyrus_consensus/src/lib.rs line 24 at r1 (raw file):

Previously, matan-starkware wrote…

Because these fields are printed out with every single log within this scope. I only want to print the starting height once when I begin.

That's not necessarily a bad thing, I'm fine either way