[pkg/ottl] Add OTTL context inferrer utility #35721
Merged
Conversation
This file contains hidden or 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
edmocosta
requested review from
TylerHelmuth,
bogdandrutu,
evan-bradley and
a team
as code owners
6 tasks
|
Hi @TylerHelmuth! I've addressed your suggestions to under expose the context inferrer impl (c0a8b67). In addition to that, I've also removed the |
TylerHelmuth
approved these changes
Oct 22, 2024
…y' into ottl-add-context-inferrer-utility
TylerHelmuth
approved these changes
Oct 22, 2024
TylerHelmuth
added
the
Skip Changelog
evan-bradley
approved these changes
Oct 22, 2024
sbylica-splunk
pushed a commit
to sbylica-splunk/opentelemetry-collector-contrib
that referenced
this pull request
Dec 17, 2024
This was referenced Jan 16, 2025
Merged
TylerHelmuth
pushed a commit
that referenced
this pull request
Feb 10, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Added debug logs for the [context inferrer utility](#35721), it will be useful for troubleshooting possibly issues after officially releasing the new `transformprocessor` configuration syntaxes. Example successfully inferred: ``` 2025-02-10T11:58:42.735+0100 DEBUG Inferring context from statements {"candidates": ["resource", "scope", "metric", "datapoint"], "priority": {"datapoint":1,"instrumentation_scope":7,"log":0,"metric":2,"resource":5,"scope":6,"span":4,"spanevent":3}, "statements": ["replace_pattern(metric.name, \"my.(.+)\", \"metrics.$1\")"]} 2025-02-10T11:58:42.736+0100 DEBUG Validating selected context candidate: "metric" 2025-02-10T11:58:42.736+0100 DEBUG Inferred context: "metric" ``` Example unable to infer: ``` 2025-02-10T12:05:00.863+0100 DEBUG Inferring context from statements {"candidates": ["metric", "datapoint", "resource", "scope"], "priority": {"datapoint":1,"instrumentation_scope":7,"log":0,"metric":2,"resource":5,"scope":6,"span":4,"spanevent":3}, "statements": ["convert_sum_to_gauge() where metric.name == \"system.processes.count\"", "limit(datapoint.attributes, 100, [\"host.name\"])"]} 2025-02-10T12:05:00.867+0100 DEBUG Validating selected context candidate: "datapoint" 2025-02-10T12:05:00.867+0100 DEBUG Context "datapoint" does not meet the function requirement: "convert_sum_to_gauge" 2025-02-10T12:05:00.867+0100 DEBUG Trying to infer context using "datapoint" lower contexts 2025-02-10T12:05:00.867+0100 DEBUG Unable to infer context from statements ``` <!-- Issue number (e.g. #1234) or full URL to issue, if applicable. --> #### Link to tracking issue #29017 <!--Please delete paragraphs that you did not use before submitting.-->
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
This PR is part of #29017, and adds the context inferrer utility into the
ottlpackage. This utility will be used by components to infer the context it should use to parse some statements, based only on itsottl.path's context prefixes.This PR delivers a priority-based
ottl.ContextInferrerimplementation, which chooses the context based on a priority list passed on theottl.NewPriorityContextInferrerfunction. It also exposes theottl.DefaultPriorityContextInferrerfunction, which creates the same context inferrer type, but using a pre-defined context priorities.For example, given the context priority
["spanevent", "span", "resource"], and inferring the context from the statementset(span.foo, resource.value) where spanevent.bar == true, would result in thespaneventcontext, as it has the highest priority.For more details on how it will be used, please have a look at the complete draft implementation.
To discuss
Do we really need to support the NewPriorityContextInferrer
ignoreUnknownContextargument?I would say yes, considering the inferrer could be used for any purpose, having the capability of ignoring unknown/non-prioritised contexts would be helpful and wouldn't require users to check if the
Infer(..)function returned an unexpected value.Link to tracking issue
#29017
Testing
Unit tests
Documentation
No changes