-
Notifications
You must be signed in to change notification settings - Fork 671
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
Update Monitoring documentation #5206
Update Monitoring documentation #5206
Conversation
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5206 +/- ##
==========================================
+ Coverage 58.99% 59.92% +0.93%
==========================================
Files 645 81 -564
Lines 55542 5101 -50441
==========================================
- Hits 32769 3057 -29712
+ Misses 20182 1851 -18331
+ Partials 2591 193 -2398
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Signed-off-by: davidmirror-ops <[email protected]>
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.
Two small suggestions, otherwise LGTM!
|
||
.. note:: | ||
|
||
The above mentioned are basic dashboards and do no include all the metrics exposed by Flyte. |
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.
The above mentioned are basic dashboards and do no include all the metrics exposed by Flyte. | |
The dashboards mentioned are basic dashboards and do not include all the metrics exposed by Flyte. |
The above mentioned are basic dashboards and do no include all the metrics exposed by Flyte. | ||
Feel free to use the scripts provided `here <https://github.com/flyteorg/flyte/tree/master/stats>`__ to improve and -hopefully- contribute the improved dashboards. | ||
|
||
To consume the dashboards, it's recommended to install and configure the Prometheus operator as described in `their docs <https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md>`__. |
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 consume the dashboards, it's recommended to install and configure the Prometheus operator as described in `their docs <https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md>`__. | |
To consume the dashboards, we recommend installing and configuring the Prometheus operator as described in `their docs <https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md>`__. |
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
@neverett I fixed some errors and proposed a slightly better format for the instructions. Thank you! |
Why are the changes needed?
Similar to what's requested on #5205 and while this PR doesn't close that Issue, it adds recommendations on how to make use of the Grafana dashboards, connecting a Prometheus instance, the Service Monitors and the necessary Grafana config.
What changes were proposed in this pull request?
How was this patch tested?
Setup process
Screenshots
Check all the applicable boxes
Related PRs
Docs link