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

Clearer converter diagnostics #5505

Merged
merged 14 commits into from
Oct 19, 2023
Merged

Conversation

erikbaranowski
Copy link
Contributor

@erikbaranowski erikbaranowski commented Oct 16, 2023

PR Description

  • Update errors to make it clearer they are converter errors and not configuration errors
  • Tune some diagnostic messages and levels from various feedback
  • Default promtail log level embedded in the static converter so unnecessary warnings don't show

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@erikbaranowski erikbaranowski marked this pull request as ready for review October 17, 2023 18:12
@@ -17,19 +17,44 @@ func UnsupportedNotDeepEqualsMessage(a any, b any, name string, message string)
var diags diag.Diagnostics
if !reflect.DeepEqual(a, b) {
if message != "" {
diags.Add(diag.SeverityLevelError, fmt.Sprintf("unsupported %s config was provided: %s", name, message))
diags.Add(diag.SeverityLevelError, fmt.Sprintf("The converter does not support converting the provided %s config: %s", name, message))
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@clayton-cornell please check out the wording in these diagnostic messages throughout to let me know what you think. There was some confusion between if something is a Flow error vs a Converter error that I'm trying to alleviate with these updates.

Copy link
Collaborator

@mattdurham mattdurham left a comment

Choose a reason for hiding this comment

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

Mostly verbiage but LGTM

Signed-off-by: erikbaranowski <[email protected]>
@erikbaranowski erikbaranowski merged commit 06c6792 into main Oct 19, 2023
7 checks passed
@erikbaranowski erikbaranowski deleted the converter-diagnostics-wording branch October 19, 2023 15:47
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Oct 19, 2023
tpaschalis pushed a commit to tpaschalis/agent that referenced this pull request Oct 25, 2023
* Update a bunch of converter messages and use standardized functions where possible for validation.

* default promtail log level from static converter so warnings don't show

* update migration doc output to match current behaviour

* refactor validation helper functions

Signed-off-by: erikbaranowski <[email protected]>

---------

Signed-off-by: erikbaranowski <[email protected]>
(cherry picked from commit 06c6792)
tpaschalis added a commit that referenced this pull request Oct 26, 2023
* go get google.golang.org/[email protected] (#5511)

(cherry picked from commit 1d11d37)

* Upgrade Agent to Collector 0.87 (#5529)

* Upgrade Agent to Collector 0.87

* Parametrize the OTel version in docs.

* Document another batch processor metric

* Don't accept routing keys for metrics.

* Add tests for otelcol.receiver.kafka

---------

Co-authored-by: Mischa Thompson <[email protected]>
(cherry picked from commit b307c02)

* prometheus.remote_write: fix missing series ref mapping for native histogram (#5517)

Signed-off-by: György Krajcsovits <[email protected]>
Co-authored-by: Paschalis Tsilias <[email protected]>
(cherry picked from commit 5794224)

* pkg/metrics/wal: drop out-of-order exemplars (#5580)

Signed-off-by: Paschalis Tsilias <[email protected]>
(cherry picked from commit cd9d185)

* remote.vault: respect value of `namespace` argument (#5582)

Unfortunately, this setting can't be easily tested because Vault
namespaces are an enterprise-only feature.

Co-authored-by: Paschalis Tsilias <[email protected]>
(cherry picked from commit c0a52bc)

* reorganize prometheus converter code and limit surface area of dependencies between converters (#5406)

Signed-off-by: erikbaranowski <[email protected]>
(cherry picked from commit 5d39145)

* Clearer converter diagnostics (#5505)

* Update a bunch of converter messages and use standardized functions where possible for validation.

* default promtail log level from static converter so warnings don't show

* update migration doc output to match current behaviour

* refactor validation helper functions

Signed-off-by: erikbaranowski <[email protected]>

---------

Signed-off-by: erikbaranowski <[email protected]>
(cherry picked from commit 06c6792)

* wire up the agent integration for the static converter (#5545)

* wire up the agent integration for the static converter

Signed-off-by: erikbaranowski <[email protected]>

---------

Signed-off-by: erikbaranowski <[email protected]>
(cherry picked from commit f4e6ac4)

* converters: Default with localhost in static targets when none provided (#5546)

* promtail: Default with localhost in static targets in converter

* Add tests and changelog

* prettify

* feedback

(cherry picked from commit 8850660)

---------

Co-authored-by: Mischa Thompson <[email protected]>
Co-authored-by: Paulin Todev <[email protected]>
Co-authored-by: George Krajcsovits <[email protected]>
Co-authored-by: Robert Fratto <[email protected]>
Co-authored-by: Erik Baranowski <[email protected]>
Co-authored-by: Piotr <[email protected]>
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants