[pkg/ottl] Improve OTTL parser error reporting #23840
Merged
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
|
We can improve message formatting in follow-up PRs by having components using OTTL attempt to parse all statements and print a formatted message using the multierr error. |
evan-bradley
force-pushed
the
ottl-improve-parsing-errors
branch
from
4fbabfb to
3e62895
Compare
github-actions
bot
added
processor/filter
evan-bradley
commented
Jun 30, 2023
evan-bradley
commented
Jun 30, 2023
TylerHelmuth
approved these changes
Jun 30, 2023
codeboten
reviewed
Jul 6, 2023
evan-bradley
force-pushed
the
ottl-improve-parsing-errors
branch
from
b813d6b to
e7ae2d3
Compare
evan-bradley
force-pushed
the
ottl-improve-parsing-errors
branch
from
b7c5eed to
67920ca
Compare
TylerHelmuth
approved these changes
Jul 11, 2023
evan-bradley
added a commit
that referenced
this pull request
Jul 14, 2023
**Description:** Follow up from #23840 to report all errors that occur during parsing. The error isn't pretty, but this way users know all syntax errors in their OTTL statements up front. I played around with trying to format this to make it more readable, but wasn't able to come up with anything that was satisfactory. Example config and resulting error: ```yaml processors: transform: trace_statements: - context: span statements: - ParseJSON("...") - false - set[[]] metric_statements: - context: datapoint statements: - set(attributes, attributes) - true - set( ``` ``` Error: invalid configuration: processors::transform: unable to parse OTTL statement "ParseJSON(\"...\")": editor names must start with a lowercase letter but got 'ParseJSON'; unable to parse OTTL statement "0": statement has invalid syntax: 1:1: unexpected token "0"; unable to parse OTTL statement "set[[]]": statement has invalid syntax: 1:4: unexpected token "[" (expected "(" (Value ("," Value)*)? ")" Key*); unable to parse OTTL statement "1": statement has invalid syntax: 1:1: unexpected token "1"; unable to parse OTTL statement "set(": statement has invalid syntax: 1:5: unexpected token "<EOF>" (expected ")" Key*) ``` I aggregated the errors both in the `Config` struct and on processor startup, but realistically are highly unlikely to get an error from the parser on startup because we've already validated the statements. I updated it just so we're consistent between validating the config and reporting errors from the OTTL parser. --------- Co-authored-by: Evan Bradley <evan-bradley@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:
I was playing with an erroneous config like the following and noticed that the error reporting was confusing:
This PR updates the error messages to print the statements next to the error so it's clear which statement caused the error. To speed up feedback cycles when changing multiple statements, I've also configured the parser to attempt to parse each statement so users can see all errors at once.
Errors now look like this:
Testing: Unit test