Skip to content

Standardize logs in common, signer, and persistence #2010

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Oct 15, 2024
Merged

Standardize logs in common, signer, and persistence #2010

merged 7 commits into from
Oct 15, 2024

Conversation

@Alenar
Copy link
Collaborator

@Alenar Alenar commented Oct 15, 2024 •
edited
Loading

Content

Following the light rules we decided to applies for logs when working on the aggregator (see #2009), this PR applies those rules on mithril-signer, mithril-common and mithril-persistence:

  • Harmonize all "function enter" logs message to be in the form of >> function_name.
  • Capitalize the first letters of all "functional" logs.

It also:

  • For signer runner function enter logs: add the value of some of the function parameters to the log to provide more context.
  • rework where the function entries logs are done when using signable builders: instead of be sent by the child buiders they are sent by the parent (avoiding repetition and making sure that no builders are left out ... as before).

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • CHANGELOG file is updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested

Issue(s)

Relates to #1981

@Alenar Alenar self-assigned this Oct 15, 2024
@Alenar Alenar force-pushed the djo/1981/standardize_logs_in_common_signer_persitence branch from 7587cc5 to b4c80be Compare October 15, 2024 13:13
@github-actions
Copy link

github-actions bot commented Oct 15, 2024 •
edited
Loading

Test Results

    4 files  ±0     54 suites  ±0   9m 38s ⏱️ +3s
1 358 tests ±0  1 358 ✅ ±0  0 💤 ±0  0 ❌ ±0 
1 566 runs  ±0  1 566 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 9c21f44. ± Comparison against base commit 6a859e5.

♻️ This comment has been updated with latest results.

@Alenar Alenar temporarily deployed to testing-preview October 15, 2024 13:25 — with GitHub Actions Inactive
@Alenar Alenar temporarily deployed to testing-sanchonet October 15, 2024 13:25 — with GitHub Actions Inactive
dlachaume
dlachaume approved these changes Oct 15, 2024
View reviewed changes
Copy link
Collaborator

@dlachaume dlachaume left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

jpraynaud
jpraynaud approved these changes Oct 15, 2024
View reviewed changes
Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Alenar added 7 commits October 15, 2024 17:35
@Alenar
refactor(common): move signable builder call log from child builder t…
bd45b92 
…o parent
@Alenar
style(common): standardize logs based on aggregator rules
482b3ca 
* Capitalize first letter of functionnal logs
* Make function enter logs start with a `>>` followed by the function
  name.
* Move away from main logs messages huge structures to keep them lean.
@Alenar
style(persistence): standardize logs based on aggregator rules
0dd19f9 
* Capitalize first letter of functionnal logs
@Alenar
style(signer): standardize logs based on aggregator rules
2f5652f 
* Capitalize first letter of functionnal logs
* Make function enter logs start with a `>>` followed by the function
name.
* Add a little more data on runner function entries logs
@Alenar
fix(common): logger source for component that have generic where inco…
b922244 
…rrect

ie: for a `MithrilProverService::<MKTreeStoreInMemory>` the source name
generated was `MKTreeStoreInMemory>` instead of `MithrilProverService`.
@Alenar
style(common): adjustement following PR reviews
57a317d 
* Moved a "function enter" log as close to the function start as
  possible.
@Alenar
chore: upgrade crate versions
9c21f44 
* mithril-persistence from `0.2.29` to `0.2.30`
* mithril-aggregator from `0.5.83` to `0.5.84`
* mithril-common from `0.4.69` to `0.4.70`
* mithril-signer from `0.2.200` to `0.2.201`
@Alenar Alenar force-pushed the djo/1981/standardize_logs_in_common_signer_persitence branch from 60e1b7d to 9c21f44 Compare October 15, 2024 15:41
@Alenar Alenar temporarily deployed to testing-preview October 15, 2024 15:52 — with GitHub Actions Inactive
@Alenar Alenar temporarily deployed to testing-sanchonet October 15, 2024 15:52 — with GitHub Actions Inactive
@Alenar Alenar merged commit c50f79b into main Oct 15, 2024
48 checks passed
@Alenar Alenar deleted the djo/1981/standardize_logs_in_common_signer_persitence branch October 15, 2024 15:53
@jpraynaud jpraynaud mentioned this pull request Oct 24, 2024
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jpraynaud jpraynaud jpraynaud approved these changes

@sfauvel sfauvel Awaiting requested review from sfauvel

+1 more reviewer

@dlachaume dlachaume dlachaume approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Alenar Alenar

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Alenar @jpraynaud @dlachaume