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

chore: add formatted logs for mls observability (WPB-6335) #2446

Merged
merged 10 commits into from
Feb 5, 2024

Conversation

yamilmedina
Copy link
Contributor


PR Submission Checklist for internal contributors

  • The PR Title

    • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
    • contains a reference JIRA issue number like SQPIT-764
    • answers the question: If merged, this PR will: ... ³
  • The PR Description

    • is free of optional paragraphs and you have filled the relevant parts to the best of your ability

What's new in this PR?

Issues

MLS was missing some logs format so we can monitor and create dashboards for observability

Causes (Optional)

Difficult to track issues when this happens.

Solutions

  • Create an ext function to reuse and format logs in json format.
  • Add logs to message sending and join via external commit.

Testing

Test Coverage (Optional)

  • I have added automated test to this contribution

How to Test

On AR using this branch if you use the app, you should see logs there formatted.


PR Post Submission Checklist for internal contributors (Optional)

  • Wire's Github Workflow has automatically linked the PR to a JIRA issue

PR Post Merge Checklist for internal contributors

  • If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

References
  1. https://sparkbox.com/foundry/semantic_commit_messages
  2. https://github.com/wireapp/.github#usage
  3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

@yamilmedina yamilmedina self-assigned this Feb 2, 2024
Copy link
Member

@MohamadJaara MohamadJaara left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

github-actions bot commented Feb 2, 2024

Test Results

2 771 tests   2 643 ✔️  35s ⏱️
   481 suites     128 💤
   481 files           0

Results for commit 7c3cbcb.

♻️ This comment has been updated with latest results.

@codecov-commenter
Copy link

codecov-commenter commented Feb 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (release/candidate@8d49d90). Click here to learn what that means.

Additional details and impacted files
@@                 Coverage Diff                  @@
##             release/candidate    #2446   +/-   ##
====================================================
  Coverage                     ?   58.37%           
  Complexity                   ?       21           
====================================================
  Files                        ?     1166           
  Lines                        ?    45146           
  Branches                     ?     4236           
====================================================
  Hits                         ?    26353           
  Misses                       ?    16906           
  Partials                     ?     1887           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8d49d90...7c3cbcb. Read the comment docs.

@datadog-wireapp
Copy link

datadog-wireapp bot commented Feb 2, 2024

Datadog Report

Branch report: chore/logging-mls-health
Commit report: d0ace87
Test service: kalium-jvm

✅ 0 Failed, 2767 Passed, 122 Skipped, 8m 47.05s Wall Time

@yamilmedina yamilmedina requested review from a team, alexandreferris, vitorhugods, mchenani, ohassine and saleniuk and removed request for a team February 5, 2024 13:46
@yamilmedina yamilmedina enabled auto-merge (squash) February 5, 2024 14:07
@yamilmedina yamilmedina merged commit 84d6cec into release/candidate Feb 5, 2024
17 checks passed
@yamilmedina yamilmedina deleted the chore/logging-mls-health branch February 5, 2024 14:19
github-actions bot pushed a commit that referenced this pull request Feb 5, 2024
* chore: extract to common logger ext function for json logs

* chore: adjust logs to format and add data for mls like epoch and protocol details

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust mapping

* chore: adjust mapping

* chore: add log to unpacker with delayed info
github-merge-queue bot pushed a commit that referenced this pull request Feb 6, 2024
* chore: add formatted logs for mls observability (WPB-6335) (#2446)

* chore: extract to common logger ext function for json logs

* chore: adjust logs to format and add data for mls like epoch and protocol details

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust mapping

* chore: adjust mapping

* chore: add log to unpacker with delayed info

* Empty-Commit

---------

Co-authored-by: Yamil Medina <[email protected]>
augustocdias pushed a commit that referenced this pull request Feb 13, 2024
* chore: add formatted logs for mls observability (WPB-6335) (#2446)

* chore: extract to common logger ext function for json logs

* chore: adjust logs to format and add data for mls like epoch and protocol details

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust logs to format for joining via commit and when stale epoch

* chore: adjust mapping

* chore: adjust mapping

* chore: add log to unpacker with delayed info

* Empty-Commit

---------

Co-authored-by: Yamil Medina <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants