Skip to content

DOCSP-47042 Monitoring Edits #633

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 6 commits into from
Feb 28, 2025
Merged

Conversation

lindseymoore
Copy link
Collaborator

@lindseymoore lindseymoore commented Feb 26, 2025

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

  • logging-monitoring/monitoring
  • 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 Feb 26, 2025

    Deploy Preview for docs-java ready!

    Name Link
    🔨 Latest commit abf778b
    🔍 Latest deploy log https://app.netlify.com/sites/docs-java/deploys/67c22be975816300086b9df3
    😎 Deploy Preview https://deploy-preview-633--docs-java.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.

    @lindseymoore lindseymoore marked this pull request as draft February 26, 2025 21:52
    Copy link
    Contributor

    @stephmarie17 stephmarie17 left a comment

    Choose a reason for hiding this comment

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

    LGTM!

    @lindseymoore lindseymoore marked this pull request as ready for review February 27, 2025 16:16
    @lindseymoore lindseymoore requested a review from a team as a code owner February 27, 2025 16:16
    @lindseymoore lindseymoore requested review from stIncMale and removed request for a team February 27, 2025 16:16
    @lindseymoore
    Copy link
    Collaborator Author

    Hi @stIncMale, thanks for reviewing! Can you please let me know the following:

    • Whether any other information on monitoring, or SDAM specifically, needs to be included
    • If any information on this page is out of date
      Thank you!

    @katcharov katcharov requested review from katcharov and removed request for stIncMale February 27, 2025 20:46
    @stIncMale stIncMale requested review from katcharov and removed request for stIncMale February 27, 2025 20:46
    Comment on lines 17 to 19
    Monitoring is the process of getting information about the activities a
    running program performs for use in an application or an application performance
    management library.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    This wording seems awkward. In particular, I am not sure what it means to get "information ... for use in an application".

    Possible reword, which may or may not capture the intended meaning:

    Monitoring involves collecting information about the activities of a running program, which can be used to support application development or in an application performance management library.

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    Thanks for the potential reword! What do you think about this:
    Monitoring involves collecting information about the activities of a running program,
    which you can use in your application or with an application performance management
    library.

    Comment on lines 21 to 23
    Monitoring your application lets you understand the driver's resource usage
    and performance and can help you make informed
    decisions when designing and debugging your application.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    I think the prior focus on the driver seemed clearer. None of the monitoring discussed is app-level, it is all driver level?


    This guide shows how to use information about the activity of the driver in code.
    If you would like to learn how to record events in the driver,
    consider reading our :doc:`guide on logging </logging>`.
    To learn how to record events in the driver, see the {+driver-short+}'s
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Nice word reductions, these help clarity 👍

    @lindseymoore lindseymoore merged commit aa7e5ee into mongodb:master Feb 28, 2025
    6 checks passed
    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.

    3 participants