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

Log verbose progress messages in S/R at debug level #1202

Merged
merged 2 commits into from
Nov 6, 2024

Conversation

rmunn
Copy link
Contributor

@rmunn rmunn commented Nov 1, 2024

Fix #1162.

The stripping out of passwords might be redundant because Chorus is supposed to already do this, but I've seen a few cases of passwords in logs recently, apparently due to a Chorus bug that's not yet completely squashed. Once we're confident that Chorus is no longer logging passwords we can remove the extra sanitization step, but for now let's keep it to be safe.

Tested locally and it works: change LogLevel.Default in backend/FwHeadless/appsettings.Development.json from "Information" to "Debug" and you'll start seeing debug logs showing every step of the Send/Receive process when you do a CRDT sync with FwHeadless.

@rmunn rmunn self-assigned this Nov 1, 2024
Copy link

github-actions bot commented Nov 1, 2024

C# Unit Tests

75 tests  ±0   75 ✅ ±0   5s ⏱️ ±0s
13 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit e790452. ± Comparison against base commit e83930d.

♻️ This comment has been updated with latest results.

Copy link
Collaborator

@hahn-kev hahn-kev left a comment

Choose a reason for hiding this comment

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

looks good to me, in the future we might want to take advantage of log scopes so that each message is annotated with the project it's in reference too, otherwise if 2 syncs are going at once we won't be able to track what's going on.

@rmunn rmunn merged commit e751594 into develop Nov 6, 2024
11 checks passed
@rmunn rmunn deleted the feat/verbose-progress-logging-fw-hedless branch November 6, 2024 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

FwHeadless followup: log verbose progress of S/R, stripping out passwords before logging
2 participants