Skip to content

DOCSP-43125 - Remove SDAM Logging method #231

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

Merged
merged 3 commits into from
Sep 19, 2024

Conversation

mongoKart
Copy link
Collaborator

@mongoKart mongoKart commented Sep 17, 2024

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

  • upgrade
  • 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?

    Copy link

    netlify bot commented Sep 17, 2024

    Deploy Preview for mongodb-docs-csharp ready!

    Name Link
    🔨 Latest commit e56e2dc
    🔍 Latest deploy log https://app.netlify.com/sites/mongodb-docs-csharp/deploys/66ec6136ae418400086cbf88
    😎 Deploy Preview https://deploy-preview-231--mongodb-docs-csharp.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 site configuration.

    Copy link
    Collaborator

    @jordan-smith721 jordan-smith721 left a comment

    Choose a reason for hiding this comment

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

    LGTM!

    @mongoKart mongoKart requested review from a team September 18, 2024 17:00
    @@ -66,6 +66,11 @@ Version 3.0 Potential Breaking Change
    configuring authentication in the {+driver-short+}, see
    :ref:`Authentication Mechanisms. <csharp-authentication-mechanisms>`

    - This version removes the ``ClusterBuilder.ConfigureSdamLogging()`` method.
    To configure SDAM logging,
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    It might sound that the new configuration is specific for SDAM.
    Maybe it should be "SDAM or any other component" and point to our logging page https://www.mongodb.com/docs/drivers/csharp/current/fundamentals/logging/?

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    When would you use MongoClientSettings.LoggingSettings vs. ClusterBuilder.ConfigureLoggingSettings? It looks like they both take an instance of LoggingSettings.

    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    ClusterBuilder is an internal component. Users shouldn't be using it.

    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Exactly, some more context:
    Unfortunately it is still a public API, and we've been recommending configuring SDAM logging before we had a proper logging mechanism.
    So we still need to mention this potentially breaking change and point to our regular logging.

    @@ -66,6 +66,11 @@ Version 3.0 Potential Breaking Change
    configuring authentication in the {+driver-short+}, see
    :ref:`Authentication Mechanisms. <csharp-authentication-mechanisms>`

    - This version removes the ``ClusterBuilder.ConfigureSdamLogging()`` method.
    To configure SDAM logging,
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    ClusterBuilder is an internal component. Users shouldn't be using it.

    @mongoKart mongoKart requested a review from rstam September 19, 2024 17:21
    Copy link
    Collaborator

    @BorisDog BorisDog left a comment

    Choose a reason for hiding this comment

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

    LGTM

    @mongoKart mongoKart merged commit bc8824f into mongodb:v3.0 Sep 19, 2024
    2 checks passed
    @mongoKart mongoKart deleted the docsp-43125-remove-logging branch September 19, 2024 17:37
    mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request May 16, 2025
    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.

    4 participants