-
Notifications
You must be signed in to change notification settings - Fork 34
DOCSP-47063: Logging #267
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
base: comp-cov
Are you sure you want to change the base?
DOCSP-47063: Logging #267
Conversation
✅ Deploy Preview for docs-php-library ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mostly looks good, happy to take another look if needed!
in your cluster configuration | ||
- :ref:`Logging <php-logging>`: Configure logging to receive messages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: theres a missing bullet point here for Change streams (out of scope but you can add)
The {+library-short+} supports `Psr\\Log\\LoggerInterface | ||
<https://www.php-fig.org/psr/psr-3/#3-psrlogloggerinterface>`__, a PSR-3 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: consider linking to the general page instead of an anchor
- Creates a logger called ``MyLogger`` that extends the ``AbstractLogger`` class | ||
and records the log level, description, and domain of each event | ||
- Registers the logger | ||
- Creates a client that connects to a CosmosDB cluster |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: I'm guessing that you are connecting to this cluster because it will generate an info message, but perhaps you should ping Rishabh to ask if we want to demonstrate this as an example
) | ||
|
||
The preceding output includes log messages with a ``debug`` severity level, which | ||
describe normal driver activities. It also includes a message about the CosmosDB |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: to resolve the vale issue you could use a phrase like "These messages provide updates on the state of the connection" as normal is subjective
( | ||
[0] => debug | ||
[1] => Setting driver handshake data: { name: 'ext-mongodb:PHP / PHPLIB ', version: '1.21.0 / 1.21.1 ', platform: 'PHP 8.4.4 ' } | ||
[2] => PHONGO |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Q: What is PHONGO? might be worth describing what types of things users might expect to see here
To learn more about C driver logging behavior, see `Logging | ||
<https://mongoc.org/libmongoc/current/logging.html>`__ in the ``libmongoc`` | ||
API documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To learn more about C driver logging behavior, see `Logging | |
<https://mongoc.org/libmongoc/current/logging.html>`__ in the ``libmongoc`` | |
API documentation. | |
To learn more about how the underlying C driver generates log messages, see `Logging | |
<https://mongoc.org/libmongoc/current/logging.html>`__ in the ``libmongoc`` | |
API documentation. |
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47063
Staging Links
Self-Review Checklist