docs: add documentation on metrics/dashboards for apps #1221
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
sgettys
previously approved these changes
Jan 23, 2025
noahpb
pushed a commit
that referenced
this pull request
Jan 28, 2025
🤖 I have created a release *beep* *boop* --- ## [0.35.0](v0.34.1...v0.35.0) (2025-01-27) ### Features * add logic to handle updates to operator config ([#1186](#1186)) ([004e8b4](004e8b4)) * optional istio cni ztunnel component ([#1175](#1175)) ([e003924](e003924)) ### Bug Fixes * add healthz port to neuvector services ([#1223](#1223)) ([ec55729](ec55729)) * checkpoint ci issue ([#1234](#1234)) ([548ff6a](548ff6a)) * denied user permissions policy messaging ([#1227](#1227)) ([1ccf4f7](1ccf4f7)) * istio package no longer assumes pepr deployments exist ([#1232](#1232)) ([ab11592](ab11592)) ### Miscellaneous * **deps:** update authservice to v1.0.4 ([#1211](#1211)) ([da4d043](da4d043)) * **deps:** update pepr ([#1197](#1197)) ([652c925](652c925)) ### Documentation * add documentation on metrics/dashboards for apps ([#1221](#1221)) ([d9062da](d9062da)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
mjnagel
pushed a commit
that referenced
this pull request
Feb 4, 2025
🤖 I have created a release *beep* *boop* --- ## [0.35.0](v0.34.1...v0.35.0) (2025-02-03) ### Features * add logic to handle updates to operator config ([#1186](#1186)) ([004e8b4](004e8b4)) * optional istio cni ztunnel component ([#1175](#1175)) ([e003924](e003924)) ### Bug Fixes * add healthz port to neuvector services ([#1223](#1223)) ([ec55729](ec55729)) * add patch for adding nv enforcer readiness probe ([#1239](#1239)) ([098ef3d](098ef3d)) * address AKS ci flakiness ([#1238](#1238)) ([262ba3e](262ba3e)) * checkpoint ci issue ([#1234](#1234)) ([548ff6a](548ff6a)) * denied user permissions policy messaging ([#1227](#1227)) ([1ccf4f7](1ccf4f7)) * istio package no longer assumes pepr deployments exist ([#1232](#1232)) ([ab11592](ab11592)) ### Miscellaneous * **ci:** disable rds parameter group creation ([#1230](#1230)) ([b4cb499](b4cb499)) * **deps:** update authservice to v1.0.4 ([#1211](#1211)) ([da4d043](da4d043)) * **deps:** update grafana ([#1213](#1213)) ([54ddd23](54ddd23)) * **deps:** update pepr ([#1197](#1197)) ([652c925](652c925)) * **deps:** update prometheus-stack ([#1189](#1189)) ([e02c14c](e02c14c)) * **deps:** update support-deps ([#1204](#1204)) ([d477f6a](d477f6a)) * **deps:** update support-deps ([#1243](#1243)) ([d4179ae](d4179ae)) * **deps:** update support-deps to v1.50.1 ([#1241](#1241)) ([6c14208](6c14208)) * **docs:** cleanup diagrams ([#1246](#1246)) ([f6bffb9](f6bffb9)) * **main:** release 0.35.0 ([#1219](#1219)) ([c31c608](c31c608)) * switch registry1 ztunnel to proper source ([#1249](#1249)) ([defa586](defa586)) * switch unicorn ztunnel to fips image ([#1240](#1240)) ([dd63ac6](dd63ac6)) ### Documentation * add documentation on metrics/dashboards for apps ([#1221](#1221)) ([d9062da](d9062da)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
Description
Adds/modifies a docs page detailing how metrics can be collected for an additional application (outside core) and how to add on additional dashboards.
This doc is partially being added in response to a support thread requesting info on how to group dashboards within uds core when adding new ones on. Related to that grouping setup, I also added support for annotations on the loki dashboard configmap.
I also moved some of the information around our monitoring setup and why we made the choices we did into a new dev doc for this purpose. While it still has valuable information, it's not as important for the end user to know/understand unless they wanted to dig into why we chose our approach (in which case the dev docs are a good place for them to be looking).
Related Issue
N/A
Type of change
Steps to Validate
If you want to test the grouping, that can be done by making a new bundle (or modifying the standard bundle locally) and confirming that all the core dashboards end up grouped together.
Checklist before merging