Update monitoring docs #5903
Merged
Update monitoring docs #5903
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 #5903 +/- ##
==========================================
+ Coverage 36.71% 36.82% +0.10%
==========================================
Files 1304 1309 +5
Lines 130081 130938 +857
==========================================
+ Hits 47764 48217 +453
- Misses 78147 78537 +390
- Partials 4170 4184 +14
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]>
neverett
previously approved these changes
Oct 24, 2024
| @@ -87,53 +87,81 @@ Flyte Backend is written in Golang and exposes stats using Prometheus. The stats | |||
|
|
|||
| Both ``flyteadmin`` and ``flytepropeller`` are instrumented to expose metrics. To visualize these metrics, Flyte provides three Grafana dashboards, each with a different focus: | |||
|
|
|||
| - **User-facing dashboards**: Dashboards that can be used to triage/investigate/observe performance and characteristics of workflows and tasks. | |||
| The user-facing dashboard is published under ID `13980 <https://grafana.com/grafana/dashboards/13980>`__ in the Grafana marketplace. | |||
| - **User-facing dashboard**: it can be used to investigate performance and characteristics of workflows and tasks executions. It's published under ID `22146 <https://grafana.com/grafana/dashboards/22146-flyte-user-dashboard-via-prometheus/>`__ in the Grafana marketplace. | |||
There was a problem hiding this comment.
Suggested change
| - **User-facing dashboard**: it can be used to investigate performance and characteristics of workflows and tasks executions. It's published under ID `22146 <https://grafana.com/grafana/dashboards/22146-flyte-user-dashboard-via-prometheus/>`__ in the Grafana marketplace. | |
| - **User-facing dashboard**: it can be used to investigate performance and characteristics of workflow and task executions. It's published under ID `22146 <https://grafana.com/grafana/dashboards/22146-flyte-user-dashboard-via-prometheus/>`__ in the Grafana marketplace. |
Signed-off-by: davidmirror-ops <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Tracking issue
Why are the changes needed?
The Grafana dashboards hadn't been updated in a long time and we lost access to the original Grafana marketplace account where those were hosted. Also, the user dashboard required several updates completed in #5703 but also required additional instructions and documented dependencies to make it work.
What changes were proposed in this pull request?
This PR updates references to the Grafana dashboards under an updated marketplace account. It also adds instructions to prepare the Flyte cluster so Prometheus can scrap metrics to feed the dashboards, including mentions to the dependencies of the user dashboard.
How was this patch tested?
Setup process
Screenshots
Check all the applicable boxes
Related PRs
Docs link