Skip to content

Improve configuration warnings testing and presentation#1663

Merged
joe-elliott merged 3 commits intografana:mainfrom
frzifus:improve_Warnings_testing_and_presentation
Aug 23, 2022
Merged

Improve configuration warnings testing and presentation#1663
joe-elliott merged 3 commits intografana:mainfrom
frzifus:improve_Warnings_testing_and_presentation

Conversation

@frzifus
Copy link
Copy Markdown
Contributor

@frzifus frzifus commented Aug 19, 2022

Hey, would be nice to get some feedback if this roughly looks like what you aimed for. If so, i will continue with persisting the change with some tests. :)

cc @joe-elliott @zalegrala


What this PR does:
This PR changes the behavior of the cmd/tempo/app/config.CheckConfig method. Previously, suspicious values were logged individually. Now a list of warnings and descriptions is returned. The caller can then decide whether and how to use this information. In this PR we decided to reproduce the existing logging behavior.

Which issue(s) this PR fixes:
Fixes #1575

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Aug 19, 2022

CLA assistant check
All committers have signed the CLA.

@frzifus frzifus force-pushed the improve_Warnings_testing_and_presentation branch from 03f04d8 to 2556b09 Compare August 22, 2022 09:45
Copy link
Copy Markdown
Collaborator

@joe-elliott joe-elliott left a comment

Choose a reason for hiding this comment

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

Love the direction you're taking this. I think a basic test that confirms warnings are returned for various configs is all we need.

@frzifus
Copy link
Copy Markdown
Contributor Author

frzifus commented Aug 22, 2022

perfect, then i will continue. Thanks for feedback @joe-elliott !

@frzifus frzifus force-pushed the improve_Warnings_testing_and_presentation branch 2 times, most recently from 870b9fa to 315a411 Compare August 22, 2022 14:20
@frzifus frzifus marked this pull request as ready for review August 22, 2022 14:20
@frzifus frzifus requested a review from joe-elliott August 22, 2022 14:20
@frzifus frzifus force-pushed the improve_Warnings_testing_and_presentation branch from 315a411 to f887e26 Compare August 22, 2022 22:35
@frzifus
Copy link
Copy Markdown
Contributor Author

frzifus commented Aug 22, 2022

mh.. linting should be fixed and hope the other changes did not cause CI / Test integration e2e suite timeout (panic: test timed out after 16m0s).

Signed-off-by: Benedikt Bongartz <bongartz@klimlive.de>
Signed-off-by: Benedikt Bongartz <bongartz@klimlive.de>
Signed-off-by: Benedikt Bongartz <bongartz@klimlive.de>
@frzifus frzifus force-pushed the improve_Warnings_testing_and_presentation branch from f887e26 to 820322b Compare August 23, 2022 07:25
@frzifus
Copy link
Copy Markdown
Contributor Author

frzifus commented Aug 23, 2022

Seems my linter fix actually broke the test. I reversed the change and tested it locally. 👍

Copy link
Copy Markdown
Collaborator

@joe-elliott joe-elliott left a comment

Choose a reason for hiding this comment

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

Very nice improvement. Thanks @frzifus!

@joe-elliott joe-elliott merged commit 5a2eb0e into grafana:main Aug 23, 2022
@frzifus frzifus deleted the improve_Warnings_testing_and_presentation branch August 23, 2022 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Warnings testing and presentation

3 participants