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.

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

Document logging #4436

Merged
merged 16 commits into from
Jul 10, 2024
Merged

Document logging #4436

merged 16 commits into from
Jul 10, 2024

Conversation

AlekSi
Copy link
Member

@AlekSi AlekSi commented Jul 9, 2024 •
edited
Loading

Description

Update public and internal documentation about our logs.

Readiness checklist

  • I added/updated unit tests (and they pass).
  • I added/updated integration/compatibility tests (and they pass).
  • I added/updated comments and checked rendering.
  • I made spot refactorings.
  • I updated user documentation.
  • I ran task all, and it passed.
  • I ensured that PR title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Milestone (Next), Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@AlekSi AlekSi added the not ready Issues that are not ready to be worked on; PRs that should skip CI label Jul 9, 2024
@mergify mergify bot assigned AlekSi Jul 9, 2024
@AlekSi AlekSi added do not merge PRs that should not be merged and removed not ready Issues that are not ready to be worked on; PRs that should skip CI labels Jul 9, 2024
@AlekSi AlekSi added this to the Next milestone Jul 9, 2024
@codecov Codecov
Copy link

codecov bot commented Jul 9, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 95.23810% with 1 line in your changes missing coverage. Please review.

Project coverage is 73.94%. Comparing base (8b4ec3d) to head (f7162bd).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4436      +/-   ##
==========================================
- Coverage   73.97%   73.94%   -0.04%     
==========================================
  Files         327      327              
  Lines       22674    22676       +2     
==========================================
- Hits        16773    16767       -6     
- Misses       4671     4676       +5     
- Partials     1230     1233       +3
Files Coverage Δ
internal/clientconn/conn.go 50.33% <100.00%> (ø)
internal/clientconn/listener.go 77.85% <100.00%> (ø)
internal/util/debug/debug.go 81.81% <100.00%> (ø)
internal/util/logging/buffer.go 83.33% <100.00%> (-5.56%) ⬇️
internal/util/logging/console_handler.go 92.85% <ø> (ø)
internal/util/logging/zap.go 84.31% <100.00%> (ø)
internal/util/observability/observability.go 68.57% <100.00%> (ø)
internal/handler/msg_getlog.go 83.50% <83.33%> (+0.34%) ⬆️

... and 3 files with indirect coverage changes

Flag Coverage Δ
filter-true 66.81% <85.71%> (-0.03%) ⬇️
hana-1 ?
integration 66.81% <85.71%> (-0.03%) ⬇️
mongodb-1 5.30% <23.80%> (-0.01%) ⬇️
postgresql-1 42.39% <33.33%> (+<0.01%) ⬆️
postgresql-2 42.31% <85.71%> (-0.02%) ⬇️
postgresql-3 42.11% <33.33%> (-0.01%) ⬇️
postgresql-4 43.77% <33.33%> (+0.07%) ⬆️
postgresql-5 45.08% <33.33%> (-0.02%) ⬇️
sqlite-1 41.55% <33.33%> (-0.01%) ⬇️
sqlite-2 41.62% <85.71%> (+0.05%) ⬆️
sqlite-3 41.35% <33.33%> (-0.01%) ⬇️
sqlite-4 42.80% <33.33%> (-0.08%) ⬇️
sqlite-5 44.33% <33.33%> (-0.04%) ⬇️
unit 33.70% <57.14%> (-0.02%) ⬇️

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

@AlekSi AlekSi added the documentation Something user-visible is badly or not documented label Jul 9, 2024
@AlekSi AlekSi marked this pull request as ready for review July 9, 2024 18:02
@AlekSi AlekSi requested review from ptrfarkas and a team as code owners July 9, 2024 18:02
@AlekSi AlekSi requested review from rumyantseva and chilagrow July 9, 2024 18:02
@AlekSi AlekSi enabled auto-merge (squash) July 9, 2024 18:02
@AlekSi AlekSi requested review from a team, noisersup and Fashander July 9, 2024 18:03
AlekSi
AlekSi commented Jul 9, 2024
View reviewed changes
CONTRIBUTING.md Show resolved Hide resolved
chilagrow
chilagrow previously approved these changes Jul 10, 2024
View reviewed changes
@AlekSi AlekSi requested a review from chilagrow July 10, 2024 06:02
chilagrow
chilagrow approved these changes Jul 10, 2024
View reviewed changes
Copy link
Member

@chilagrow chilagrow left a comment

Choose a reason for hiding this comment

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

Great!

rumyantseva
rumyantseva approved these changes Jul 10, 2024
View reviewed changes
Copy link
Contributor

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

🚀

@AlekSi AlekSi removed the do not merge PRs that should not be merged label Jul 10, 2024
@AlekSi AlekSi merged commit 85590b9 into FerretDB:main Jul 10, 2024
30 of 31 checks passed
@AlekSi AlekSi deleted the logs branch July 10, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ptrfarkas ptrfarkas ptrfarkas approved these changes

@noisersup noisersup noisersup approved these changes

@chilagrow chilagrow chilagrow approved these changes

@rumyantseva rumyantseva rumyantseva approved these changes

@Fashander Fashander Awaiting requested review from Fashander Fashander was automatically assigned from FerretDB/docs

Assignees

@AlekSi AlekSi

Labels
documentation Something user-visible is badly or not documented
Projects
Current Engineering
Archived in project
Milestone
v1.23.0
Development

Successfully merging this pull request may close these issues.
5 participants
@AlekSi @rumyantseva @chilagrow @noisersup @ptrfarkas