[processor/transform] Create WithAdditional*Funcs factory options and Validate*Statements to provide additional OTTL funcs programatically.
#39966
+443
−91
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
…cessor and *Functions methods.
…itional*Functions` factory options.
… for validation of custom transform processor distributions.
quentinmit
reviewed
May 9, 2025
Comment on lines
+37
to
+50
| // defaultAdditionalMetricFunctions returns an empty slice of ottl function factories. | ||
| func defaultAdditionalMetricFunctions() []ottl.Factory[ottlmetric.TransformContext] { | ||
| return []ottl.Factory[ottlmetric.TransformContext]{} | ||
| } | ||
|
|
||
| // defaultAdditionalLogFunctions returns an empty slice of ottl function factories. | ||
| func defaultAdditionalLogFunctions() []ottl.Factory[ottllog.TransformContext] { | ||
| return []ottl.Factory[ottllog.TransformContext]{} | ||
| } | ||
|
|
||
| // defaultAdditionalSpanFunctions returns an empty slice of ottl function factories. | ||
| func defaultAdditionalSpanFunctions() []ottl.Factory[ottlspan.TransformContext] { | ||
| return []ottl.Factory[ottlspan.TransformContext]{} | ||
| } |
There was a problem hiding this comment.
This is equivalent to the zero value for these fields, so there's no need for these functions to exist.
| @@ -726,6 +726,9 @@ transform: | |||
|
|
|||
| The configuration can be used also with `delete_matching_keys()` to copy the attributes that do not match the regular expression. | |||
|
|
|||
| ## Additional OTTL Functions | |||
| The Factory Options `WithAdditionalMetricFunctions`, `WithAdditionalSpanFunctions` and `WithAdditionalLogFunctions` can be set in the transform processor `NewFactory` to add additional OTTL functions to the resulting processor. The `Config` methods `ValidateMetricStatements`, `ValidateSpanStatements` and `ValidateLogStatements` to receive the additional OTTL functions to validate the context statements. By setting a custom `NewFactory` and a custom `Config`, the user can create custom `transform` processor with any additional OTTL functions. | |||
There was a problem hiding this comment.
s/set in/set when calling/
I don't think there's any need to document the change to the Validate* methods in the README.
What is the "custom Config" you're referring to?
| func (c *Config) Validate() error { | ||
| var errors error | ||
|
|
||
| if len(c.TraceStatements) > 0 { | ||
| pc, err := common.NewTraceParserCollection(component.TelemetrySettings{Logger: zap.NewNop()}, common.WithSpanParser(traces.SpanFunctions()), common.WithSpanEventParser(traces.SpanEventFunctions())) | ||
| err := c.ValidateTraceStatements() |
There was a problem hiding this comment.
Don't you need to pass the new functions as arguments to the new methods you've defined here?
| @@ -129,45 +132,72 @@ func (c *Config) Unmarshal(conf *confmap.Conf) error { | |||
|
|
|||
| var _ component.Config = (*Config)(nil) | |||
|
|
|||
| func (c *Config) ValidateTraceStatements(additionalSpanFuncs ...ottl.Factory[ottlspan.TransformContext]) error { | |||
| var errors error | |||
| pc, err := common.NewTraceParserCollection(component.TelemetrySettings{Logger: zap.NewNop()}, common.WithSpanParser(traces.SpanFunctions(additionalSpanFuncs)), common.WithSpanEventParser(traces.SpanEventFunctions())) | |||
There was a problem hiding this comment.
Aside from the first line, these functions are all iterating over a common.ContextStatements object and doing the same thing. You can refactor this into a single shared helper function.
Comment on lines
+52
to
+71
| // WithAdditionalMetricFunctions adds ottl metric functions to resulting processor | ||
| func WithAdditionalMetricFunctions(metricFunctions []ottl.Factory[ottlmetric.TransformContext]) FactoryOption { | ||
| return func(factory *transformProcessorFactory) { | ||
| factory.additionalMetricFunctions = metricFunctions | ||
| } | ||
| } | ||
|
|
||
| // WithAdditionalLogFunctions adds ottl log functions to resulting processor | ||
| func WithAdditionalLogFunctions(logFunctions []ottl.Factory[ottllog.TransformContext]) FactoryOption { | ||
| return func(factory *transformProcessorFactory) { | ||
| factory.additionalLogFunctions = logFunctions | ||
| } | ||
| } | ||
|
|
||
| // WithAdditionalSpanFunctions adds ottl span functions to resulting processor | ||
| func WithAdditionalSpanFunctions(spanFunctions []ottl.Factory[ottlspan.TransformContext]) FactoryOption { | ||
| return func(factory *transformProcessorFactory) { | ||
| factory.additionalSpanFunctions = spanFunctions | ||
| } | ||
| } |
There was a problem hiding this comment.
These options should probably live in pkg/ottl so they can be shared by multiple processors, instead of having to be duplicated in each processor that uses OTTL.
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
Create
WithAdditionalMetricFunctions,WithAdditionalSpanFunctionsandWithAdditionalLogFunctionsfactory options to add custom OTTL functions for logs, metrics or traces to the resulting processor. Also created theConfigmethodsValidateMetricStatements,ValidateLogStatementsandValidateSpanStatementsto enable users to validate configs with the additional OTTL functions.Some details about the solution :
transformprocessor the user needs to create aNewFactoryandConfig.Validatefunctions providing the additional OTTL functions.Configto access processorFactory, theConfig.Validatemethod can't access the additional OTTL functions from theFactory. I circumvented this issue by creating theValidate*Statementshelper functions which can be used to create a customConfig.Validatemethod to validate with the additional ottl functions.Additional*Funcsconfig properties to provide additional OTTL funcs programatically. #39641 (comment)Link to tracking issue
Note : There is a similar followup proposed update for the
processor/filter.Testing
Documentation
Additional OTTL Functionssection to README.