[pkg/ottl] Add Contains function #40193

francois07 · 2025-05-21T08:52:50Z

Description

I've reused most of @lkwronski's work in #35482 to add a new Contains function that checks if an item is in a slice. The only difference is that I've used reflect.DeepEqual() for item comparison. This makes it possible to check if a slice is present in a slice, for example Contain([[1, 2], [3, 4]], [1,2]) and also returns false if there is a type mismatch. This is slower than basic equality check though, so let me know if you want a different implementation, I already have a few other ideas actually.

Link to tracking issue

Fixes #30420

Testing

Added tests at 3 locations

pkg/ottl/funcs/func_contains_test.go
pkg/ottl/functions_test.go
pkg/ottl/e2e/e2e_test.go

Documentation

Documentation was added to pkg/ottl/funcs/README.md

…/opentelemetry-collector-contrib into ottl_func_contains

…t incompatible type comparison returns false

pkg/ottl/ottlfuncs/README.md

pkg/ottl/expression.go

…ction to convert to pcommon.Slice

pkg/ottl/ottlfuncs/func_slice_contains.go

…comparison (#40370)  #### Description This PR introduces two related changes and contains 2 change logs because of that. **1 - Comparator API** Exposes the internal OTTL comparators logic as a new API (`ottl.ValueComparator`), which can be used by API consumers to compare raw values following the same OTTL [comparison rules ](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/LANGUAGE.md#comparison-rules). **Why?** Existing and new functions that needs to compare values can be leveraging this new API to compare them, and keep it consistent with the OTTL comparison logic. For example, the new [`Contains`](#40193) function for slices, can be using this API to determine whether an slice contains a particular value, following the same comparison logic the grammar does. ```go // Exported interface: type ValueComparator interface { // Equal compares two values for equality, returning true if they are equals // according to the OTTL comparison rules. Equal(a any, b any) bool // NotEqual compares two values for equality, returning true if they are different // according to the OTTL comparison rules. NotEqual(a any, b any) bool // Less compares two values, returning true if the first value is less than the second // value, using the OTTL comparison rules. Less(a any, b any) bool // LessEqual compares two values, returning true if the first value is less or equal // to the second value, using the OTTL comparison rules. LessEqual(a any, b any) bool // Greater compares two values, returning true if the first value is greater than the // second value, using the OTTL comparison rules. Greater(a any, b any) bool // GreaterEqual compares two values, returning true if the first value is greater or // equal to the second value, using the OTTL comparison rules. GreaterEqual(a any, b any) bool } // Usage: comp := ottl.NewValueComparator() ``` **2 - Add ability to compare slices** We currently don't have the ability to compare slices, which means conditions like `attributes["slice"] == attributes["slice"]` returns false. This PR also adds the ability to compare slices/pcommon.Slices, similar to the maps support (#38611).  #### Testing Manual and unit tests  #### Documentation Updated LANGUAGE.md

…epEqual()

francois07 · 2025-06-05T14:51:11Z

I've updated the function to use the new ottl.ValueComparator API from #40370

pkg/ottl/ottlfuncs/README.md

pkg/ottl/ottlfuncs/func_contains_value.go

pkg/ottl/expression.go

.chloggen/ottl_func_contains.yaml

pkg/ottl/ottlfuncs/README.md

…comparison (open-telemetry#40370)  #### Description This PR introduces two related changes and contains 2 change logs because of that. **1 - Comparator API** Exposes the internal OTTL comparators logic as a new API (`ottl.ValueComparator`), which can be used by API consumers to compare raw values following the same OTTL [comparison rules ](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/LANGUAGE.md#comparison-rules). **Why?** Existing and new functions that needs to compare values can be leveraging this new API to compare them, and keep it consistent with the OTTL comparison logic. For example, the new [`Contains`](open-telemetry#40193) function for slices, can be using this API to determine whether an slice contains a particular value, following the same comparison logic the grammar does. ```go // Exported interface: type ValueComparator interface { // Equal compares two values for equality, returning true if they are equals // according to the OTTL comparison rules. Equal(a any, b any) bool // NotEqual compares two values for equality, returning true if they are different // according to the OTTL comparison rules. NotEqual(a any, b any) bool // Less compares two values, returning true if the first value is less than the second // value, using the OTTL comparison rules. Less(a any, b any) bool // LessEqual compares two values, returning true if the first value is less or equal // to the second value, using the OTTL comparison rules. LessEqual(a any, b any) bool // Greater compares two values, returning true if the first value is greater than the // second value, using the OTTL comparison rules. Greater(a any, b any) bool // GreaterEqual compares two values, returning true if the first value is greater or // equal to the second value, using the OTTL comparison rules. GreaterEqual(a any, b any) bool } // Usage: comp := ottl.NewValueComparator() ``` **2 - Add ability to compare slices** We currently don't have the ability to compare slices, which means conditions like `attributes["slice"] == attributes["slice"]` returns false. This PR also adds the ability to compare slices/pcommon.Slices, similar to the maps support (open-telemetry#38611).  #### Testing Manual and unit tests  #### Documentation Updated LANGUAGE.md

… reflection

Co-authored-by: Edmo Vamerlatti Costa <[email protected]>

edmocosta

It looks good to me, thank you for working on that. I've left a few final suggestions.

pkg/ottl/ottlfuncs/func_contains_value.go

pkg/ottl/expression.go

Co-authored-by: Edmo Vamerlatti Costa <[email protected]>

…t_StandardPSliceGetter and Test_StandardPSliceGetter_WrappedError

…try-collector-contrib into ottl_func_contains

francois07 · 2025-06-17T08:07:57Z

Hello @edmocosta, any thoughts on my recent changes ? I've implemented all your suggestions 👍

edmocosta

Thanks again for working on this @francois07, I've added a comment here.

I know it's not related to your PR, but it seems there's a few lint issues on the expression_test test. If you don't mind fixing that on this PR as well, that would be great, so we can get the CI green.

Error: pkg/ottl/expression_test.go:2245:11: type assertion on error will fail on wrapped errors. Use errors.As to check for specific errors (errorlint)
level=warning msg="[runner/exclusion_rules] Skipped 0 issues by rules: [Path: \"third_party\", Linters: \"gci, gofumpt\"]"
	_, ok := err.(TypeError)

Fix:

var typeError TypeError
assert.ErrorAs(t, err, &typeError)

We should also drop the //nolint:errorlint on that failing test.
Thanks!

… check for specific errors

…try-collector-contrib into ottl_func_contains

francois07 · 2025-06-19T09:20:21Z

Thanks again for working on this @francois07, I've added a comment here.

I know it's not related to your PR, but it seems there's a few lint issues on the expression_test test. If you don't mind fixing that on this PR as well, that would be great, so we can get the CI green.
Error: pkg/ottl/expression_test.go:2245:11: type assertion on error will fail on wrapped errors. Use errors.As to check for specific errors (errorlint)
level=warning msg="[runner/exclusion_rules] Skipped 0 issues by rules: [Path: \"third_party\", Linters: \"gci, gofumpt\"]"
	_, ok := err.(TypeError)
Fix:
var typeError TypeError
assert.ErrorAs(t, err, &typeError)
We should also drop the //nolint:errorlint on that failing test. Thanks!

Done ! Many thanks for you feedbacks too @edmocosta

I did kind of copy the existing tests stupidly so I didn't think about adding the tests for all possible types, sorry about that ! I fixed the linting error following your reply also👍

evan-bradley

Thanks @francois07!

…comparison (open-telemetry#40370)  #### Description This PR introduces two related changes and contains 2 change logs because of that. **1 - Comparator API** Exposes the internal OTTL comparators logic as a new API (`ottl.ValueComparator`), which can be used by API consumers to compare raw values following the same OTTL [comparison rules ](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/LANGUAGE.md#comparison-rules). **Why?** Existing and new functions that needs to compare values can be leveraging this new API to compare them, and keep it consistent with the OTTL comparison logic. For example, the new [`Contains`](open-telemetry#40193) function for slices, can be using this API to determine whether an slice contains a particular value, following the same comparison logic the grammar does. ```go // Exported interface: type ValueComparator interface { // Equal compares two values for equality, returning true if they are equals // according to the OTTL comparison rules. Equal(a any, b any) bool // NotEqual compares two values for equality, returning true if they are different // according to the OTTL comparison rules. NotEqual(a any, b any) bool // Less compares two values, returning true if the first value is less than the second // value, using the OTTL comparison rules. Less(a any, b any) bool // LessEqual compares two values, returning true if the first value is less or equal // to the second value, using the OTTL comparison rules. LessEqual(a any, b any) bool // Greater compares two values, returning true if the first value is greater than the // second value, using the OTTL comparison rules. Greater(a any, b any) bool // GreaterEqual compares two values, returning true if the first value is greater or // equal to the second value, using the OTTL comparison rules. GreaterEqual(a any, b any) bool } // Usage: comp := ottl.NewValueComparator() ``` **2 - Add ability to compare slices** We currently don't have the ability to compare slices, which means conditions like `attributes["slice"] == attributes["slice"]` returns false. This PR also adds the ability to compare slices/pcommon.Slices, similar to the maps support (open-telemetry#38611).  #### Testing Manual and unit tests  #### Documentation Updated LANGUAGE.md

lkwronski and others added 4 commits October 1, 2024 18:05

Add contains function

f928122

Merge branch 'lkwronski.issue-30420-contains' of github.com:lkwronski…

1a684ce

…/opentelemetry-collector-contrib into ottl_func_contains

refactor(ottl,functions,contains): use DeepEqual instead of == so tha…

1e848ff

…t incompatible type comparison returns false

refactor(chlog): merge logs in one changelog

de92a71

francois07 requested review from TylerHelmuth, evan-bradley, edmocosta and a team as code owners May 21, 2025 08:52

github-actions bot assigned fatsheep9146 May 21, 2025

github-actions bot added the pkg/ottl label May 21, 2025

francois07 and others added 3 commits May 21, 2025 10:54

Merge branch 'main' into ottl_func_contains

cb28597

fix(ottl,funcs,contains): remove useless whitespace

5fae8e3

fix(ottl,funcs,contains): use errors.New() instead of fmt.Errorf()

b866c74

TylerHelmuth reviewed May 21, 2025

View reviewed changes

pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved

pkg/ottl/expression.go Show resolved Hide resolved

francois07 added 2 commits May 22, 2025 11:04

refactor(ottl,funcs,contains): rename function to SliceContains

f06582b

refactor(ottl,funcs,slicecontains): if target is raw slice, use refle…

55cde77

…ction to convert to pcommon.Slice

francois07 requested a review from TylerHelmuth May 22, 2025 11:58

This was referenced May 28, 2025

[pkg/ottl] New function: Index #40351

Open

[pkg/ottl] Add new ottl.ValueComparator API and support for slices comparison #40370

Merged

mashhurs reviewed May 30, 2025

View reviewed changes

pkg/ottl/ottlfuncs/func_slice_contains.go Outdated Show resolved Hide resolved

francois07 added 2 commits June 2, 2025 09:54

refactor(ottl,funcs,slicecontains): rename function to ContainsValue

1f1ac1b

refactor(ottl, func, contains_value): rename go files

5d35774

francois07 mentioned this pull request Jun 3, 2025

[pkg/ottl] Accept dynamic lists in keep_keys #40440

Open

francois07 and others added 2 commits June 5, 2025 16:43

Merge branch 'main' into ottl_func_contains

985a23f

refactor(ottl,funcs,contains_value): use comparator API instead of De…

72fcb4f

…epEqual()

TylerHelmuth mentioned this pull request Jun 6, 2025

Contains one element in array #37704

Closed

edmocosta reviewed Jun 9, 2025

View reviewed changes

francois07 and others added 2 commits June 10, 2025 11:10

refactor(ottl, expression, PSlice): use static types instead of using…

cf9f5f5

… reflection

fix(ottl, expression, PSlice): use correct struct name in comment

9abdc70

Co-authored-by: Edmo Vamerlatti Costa <[email protected]>

francois07 requested a review from edmocosta June 10, 2025 11:06

edmocosta mentioned this pull request Jun 10, 2025

OTTL Index function implementation. #40393

Open

edmocosta reviewed Jun 11, 2025

View reviewed changes

pkg/ottl/ottlfuncs/func_contains_value.go Outdated Show resolved Hide resolved

pkg/ottl/expression.go Outdated Show resolved Hide resolved

pkg/ottl/expression.go Show resolved Hide resolved

francois07 and others added 4 commits June 12, 2025 09:52

fix(ottl, funcs, contains_value): use right struct name in error message

8eab7be

Co-authored-by: Edmo Vamerlatti Costa <[email protected]>

chore(ottl, expression): format

8a00303

Co-authored-by: Edmo Vamerlatti Costa <[email protected]>

refactor(ottl, expression, StandardPSliceGetter, test): add tests Tes…

9afff6b

…t_StandardPSliceGetter and Test_StandardPSliceGetter_WrappedError

Merge branch 'ottl_func_contains' of github.com:francois07/openteleme…

7d425fc

…try-collector-contrib into ottl_func_contains

francois07 requested review from edmocosta and mashhurs June 12, 2025 08:32

Merge branch 'main' into ottl_func_contains

d586ffc

edmocosta mentioned this pull request Jun 13, 2025

OTTL Function: Contains #40699

Open

Merge branch 'main' into ottl_func_contains

404f068

edmocosta reviewed Jun 18, 2025

View reviewed changes

francois07 added 3 commits June 19, 2025 10:31

refactor(ottl, expression, test): add test cases for all slice types

d97c7b5

fix(ottl, expression, test): use ErrorAs instead of type assertion to…

394a831

… check for specific errors

Merge branch 'ottl_func_contains' of github.com:francois07/openteleme…

a8f7a1b

…try-collector-contrib into ottl_func_contains

francois07 requested a review from edmocosta June 19, 2025 09:21

Merge branch 'main' into ottl_func_contains

1d12e44

edmocosta approved these changes Jun 19, 2025

View reviewed changes

francois07 and others added 2 commits June 20, 2025 10:32

Merge branch 'main' into ottl_func_contains

75592c6

Merge branch 'main' into ottl_func_contains

a26b936

evan-bradley approved these changes Jun 20, 2025

View reviewed changes

evan-bradley merged commit 00ca416 into open-telemetry:main Jun 20, 2025
177 checks passed

github-actions bot added this to the next release milestone Jun 20, 2025

francois07 deleted the ottl_func_contains branch June 23, 2025 08:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[pkg/ottl] Add Contains function #40193

[pkg/ottl] Add Contains function #40193

Uh oh!

francois07 commented May 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

francois07 commented Jun 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edmocosta left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

francois07 commented Jun 17, 2025

Uh oh!

edmocosta left a comment

Uh oh!

francois07 commented Jun 19, 2025 •

edited

Loading

Uh oh!

evan-bradley left a comment

Uh oh!

Uh oh!

Uh oh!

[pkg/ottl] Add Contains function #40193

[pkg/ottl] Add Contains function #40193

Uh oh!

Conversation

francois07 commented May 21, 2025

Description

Link to tracking issue

Testing

Documentation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

francois07 commented Jun 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edmocosta left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

francois07 commented Jun 17, 2025

Uh oh!

edmocosta left a comment

Choose a reason for hiding this comment

Uh oh!

francois07 commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

evan-bradley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

francois07 commented Jun 19, 2025 •

edited

Loading