-
Notifications
You must be signed in to change notification settings - Fork 34
DOCSP-47056: Monitoring #260
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
DOCSP-47056: Monitoring #260
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.
LGTM with a tiny nit!
:dedent: | ||
|
||
When you start the application and run an insert command, your subscribers | ||
record the events and output messages such as the following: |
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.
[n] I think this fits the nonrestrictive clause guidance from the terminology guidelines:
record the events and output messages such as the following: | |
record the events and output messages, such as the following: |
.. _php-monitoring: | ||
|
||
========== | ||
Monitoring |
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 almost forgot, I think this title might be too short per the latest title guidelines? In Node CC we updated to Monitor Application Events.
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.
Ah thank you! fixed
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.
Approved with a small comment/question (but nothing blocking :))
private $stream; | ||
|
||
public function __construct($stream) | ||
{ | ||
$this->stream = $stream; | ||
} |
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.
These days you can declare and assign this property through constructor property promotion. Might improve cleanliness a little in this example :)
private $stream; | |
public function __construct($stream) | |
{ | |
$this->stream = $stream; | |
} | |
public function __construct(private readonly $stream) {} |
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.
Hm I get an error about $stream not having a type:
PHP Fatal error: Readonly property MyCommandSubscriber::$stream must have type
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.
But if I remove readonly it works!
events that provide application information. You can listen for these events to | ||
monitor your application. | ||
|
||
.. TODO: This page explains how to monitor your application in code. To learn how to |
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.
Just for my information, what does this .. TODO
tag do? How is that formatted in the compiled docs?
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.
It doesn't render on the page at all, it's just a comment for the writers that reminds us to address something later! In this case, once the logging page is merged (which I have a PR open for now), I'll uncomment it and add the Logging link
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.
Thanks for explaining!
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47056
Staging Links
Self-Review Checklist
Suggested redirects for moved, renamed, and deleted files:
Replace <v> with the earliest backport target version