feat: add canonicalization latency metric

[cjeva10]

Closes #3815

[Rjected]

Logic wise this looks great! I wonder if we can do something like the following though:

        let start = Instant::now();
        let make_canonical_result = self.blockchain.make_canonical(&state.head_block_hash);
        self.record_make_canonical_latency(start, make_canonical_result);
        let status = match make_canonical_result {
        // ... rest

where record_make_canonical_latency does a match:

let elapsed = start.elapsed();
self.metrics.make_canonical_latency.record(elapsed);
match outcome {
    Ok(MakeCanonicalOutcome::AlreadyCanonical) => self.metrics.make_canonical_already_canonical_latency.record(elapsed),
    // the AlreadyCommitted case
    Err(_) => // the err case
}

does that make sense? I think then, we don't have to intersperse the metrics record calls in the match for other logic.

[Rjected]

this also needs to be rebased / merged with the latest main since we made some fixes to CI

[cjeva10]

Perfect, yes makes sense - I wasn't sure if I should restructure the flow on the main match statement but what you have there makes sense. Will push shortly

[cjeva10]

@Rjected I put in the changes you asked for - please let me know if the branch looks ok.

[codecov]

Codecov Report

Merging #3865 (5d7c03c) into main (9b9ae82) will decrease coverage by 0.02%.
The diff coverage is 93.75%.

❗ Current head 5d7c03c differs from pull request most recent head 6a70991. Consider uploading reports for the commit 6a70991 to get more accurate results

Files Changed	Coverage Δ
crates/consensus/beacon/src/engine/metrics.rs	100.00% <ø> (ø)
crates/consensus/beacon/src/engine/mod.rs	75.48% <93.75%> (+0.20%)	⬆️

... and 9 files with indirect coverage changes

Flag	Coverage Δ
integration-tests	15.54% <0.00%> (-0.02%)	⬇️
unit-tests	64.41% <93.75%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
reth binary	26.44% <ø> (ø)
blockchain tree	83.01% <ø> (ø)
pipeline	89.66% <ø> (ø)
storage (db)	74.19% <ø> (ø)
trie	94.65% <ø> (ø)
txpool	46.00% <ø> (ø)
networking	77.64% <ø> (-0.05%)	⬇️
rpc	58.25% <ø> (-0.03%)	⬇️
consensus	64.46% <93.75%> (+0.13%)	⬆️
revm	33.68% <ø> (ø)
payload builder	6.61% <ø> (ø)
primitives	87.99% <ø> (-0.02%)	⬇️

[Rjected]

cool - just going to clean up the merge a little bit

[Rjected]

great work - thank you!