Skip to content

DOCSP-51344: Logging #115

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
Open
wants to merge 7 commits into
base: comp-cov
Choose a base branch
from
Open

DOCSP-51344: Logging #115

wants to merge 7 commits into from

Conversation

mcmorisi
Copy link
Collaborator

@mcmorisi mcmorisi commented Jul 11, 2025 •
edited by github-actions bot
Loading

Mostly adapted from the Java Sync Logging page, made efforts to trim the fat and update the wording.

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-51344

Staging Links

  • logging-and-monitoring
  • logging-and-monitoring/logging

    • Self-Review Checklist

    • Is this free of any warnings or errors in the RST?
    • Did you run a spell-check?
    • Did you run a grammar-check?
    • Are all the links working?
    • Are the facets and meta keywords accurate?
    • Are the page titles greater than 20 characters long and SEO relevant?

    @netlify Netlify
    Copy link

    netlify bot commented Jul 11, 2025 •
    edited
    Loading

    ✅ Deploy Preview for docs-kotlin-sync ready!

    Name Link
    🔨 Latest commit 1d9baa9
    🔍 Latest deploy log https://app.netlify.com/projects/docs-kotlin-sync/deploys/687168d950fec300082c4405
    😎 Deploy Preview https://deploy-preview-115--docs-kotlin-sync.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify project configuration.

    @docs-builder-bot
    Copy link

    docs-builder-bot commented Jul 11, 2025 •
    edited
    Loading

    🔄 Deploy Preview for docs-kotlin-sync processing

    Item Details
    🔨 Latest Commit c343f5e159e3f1f46dbea8c306da7f9f5d4ae027
    😎 Deploy Preview https://deploy-preview-115--docs-kotlin-sync.netlify.app
    🔍 Build Logs View Logs

    mballard-mdb
    mballard-mdb requested changes Jul 11, 2025
    View reviewed changes
    Copy link
    Collaborator

    @mballard-mdb mballard-mdb 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! Left a few changes

    source/logging-and-monitoring/logging.txt

    The following example disables the root logger and sets the log level for the
    ``org.mongodb.driver.connection`` logger to ``DEBUG``. This will cause the driver to log
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    ``org.mongodb.driver.connection`` logger to ``DEBUG``. This will cause the driver to log
    ``org.mongodb.driver.connection`` logger to ``DEBUG``. This will cause the driver to only log

    Copy link
    Collaborator Author

    @mcmorisi mcmorisi Jul 11, 2025 •
    edited
    Loading

    Choose a reason for hiding this comment

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

    Style guide entry on "only" – "Place only preceding the word or group that it modifies". I think I adhered to that in my version ("messages" being the word getting modified).

    Copy link
    Collaborator

    @mballard-mdb mballard-mdb Jul 11, 2025 •
    edited
    Loading

    Choose a reason for hiding this comment

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

    maybe put only after messages? it seems a little clunky but i get how style guide rules can do that sometimes.
    Ex. This will cause the driver to log messages only related to.... or log messages related only to
    But I think what you have is fine, it just displeases me for some reason but its probably personal preference

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    I can shift it around!

    @mcmorisi mcmorisi requested a review from mballard-mdb July 11, 2025 18:15
    mballard-mdb
    mballard-mdb approved these changes Jul 11, 2025
    View reviewed changes
    Copy link
    Collaborator

    @mballard-mdb mballard-mdb left a comment

    Choose a reason for hiding this comment

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

    LGTM with one follow up comment

    @mcmorisi mcmorisi marked this pull request as ready for review July 11, 2025 19:42
    @mcmorisi mcmorisi requested review from a team and vbabanin and removed request for a team July 11, 2025 19:43
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @mballard-mdb mballard-mdb mballard-mdb approved these changes

    @vbabanin vbabanin Awaiting requested review from vbabanin vbabanin was automatically assigned from mongodb/dbx-java

    Assignees
    No one assigned
    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @mcmorisi @docs-builder-bot @mballard-mdb