Skip to content
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

Merged

Conversation

davidmirror-ops
Copy link
Contributor

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

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

@davidmirror-ops davidmirror-ops changed the title Update Monitoring documentation [WIP] Update Monitoring documentation Apr 9, 2024
Copy link

codecov bot commented Apr 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.92%. Comparing base (fd42f65) to head (4140a30).
Report is 106 commits behind head on master.

❗ Current head 4140a30 differs from pull request most recent head 5d0b566. Consider uploading reports for the commit 5d0b566 to get more accurate results

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     
Flag Coverage Δ
unittests 59.92% <ø> (+0.93%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: davidmirror-ops <[email protected]>
@davidmirror-ops davidmirror-ops marked this pull request as ready for review April 9, 2024 19:22
@davidmirror-ops davidmirror-ops changed the title [WIP] Update Monitoring documentation Update Monitoring documentation Apr 9, 2024
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 9, 2024
neverett
neverett previously approved these changes Apr 9, 2024
Copy link
Contributor

@neverett neverett left a 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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>`__.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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>`__.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 9, 2024
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
@davidmirror-ops
Copy link
Contributor Author

@neverett I fixed some errors and proposed a slightly better format for the instructions. Thank you!

@davidmirror-ops davidmirror-ops merged commit 8ef5ea9 into flyteorg:master Apr 10, 2024
46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants