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

feat(ottl): Add a new ottl trim function that trims leading and trailing whitespace from a string #36400

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .chloggen/ottl-trim-function.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: 'enhancement'

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: ottl

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add a new ottl trim function that trims leading and trailing whitespace from a string.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [34100]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
12 changes: 11 additions & 1 deletion pkg/ottl/ottlfuncs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1780,9 +1780,19 @@ The `Split` Converter separates a string by the delimiter, and returns an array

If the `target` is not a string or does not exist, the `Split` Converter will return an error.

### Trim

```Trim(target, " ")```

The `Trim` Converter removes the leading and trailing whitespace.

If the `target` is not a string or does not exist, the `Trim` Converter will return an error.

`target` is a string.

Examples:

- `Split("A|B|C", "|")`
- `Trim(" this is a test ", " ")`

### String

Expand Down
41 changes: 41 additions & 0 deletions pkg/ottl/ottlfuncs/func_trim.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package ottlfuncs // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/ottlfuncs"

import (
"context"
"fmt"
"strings"

"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
)

type TrimArguments[K any] struct {
Target ottl.StringGetter[K]
Delimiter string
}

func NewTrimFactory[K any]() ottl.Factory[K] {
return ottl.NewFactory("Trim", &TrimArguments[K]{}, createTrimFunction[K])
}

func createTrimFunction[K any](_ ottl.FunctionContext, oArgs ottl.Arguments) (ottl.ExprFunc[K], error) {
args, ok := oArgs.(*TrimArguments[K])

if !ok {
return nil, fmt.Errorf("TrimFactory args must be of type *TrimArguments[K]")
}

return trim(args.Target, args.Delimiter), nil
}

func trim[K any](target ottl.StringGetter[K], delimiter string) ottl.ExprFunc[K] {
return func(ctx context.Context, tCtx K) (any, error) {
val, err := target.Get(ctx, tCtx)
if err != nil {
return nil, err
}
return strings.Trim(val, delimiter), nil
}
}
51 changes: 51 additions & 0 deletions pkg/ottl/ottlfuncs/func_trim_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package ottlfuncs

import (
"context"
"testing"

"github.com/stretchr/testify/assert"

"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
)

func Test_trim(t *testing.T) {
tests := []struct {
name string
target ottl.StringGetter[any]
delimiter string
expected any
}{
{
name: "trim string",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return " this is a test ", nil
},
},
delimiter: " ",
expected: "this is a test",
},
{
name: "trim empty string",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return "", nil
},
},
delimiter: " ",
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
exprFunc := trim(tt.target, tt.delimiter)
result, err := exprFunc(nil, nil)
assert.NoError(t, err)
assert.Equal(t, tt.expected, result)
})
}
}
1 change: 1 addition & 0 deletions pkg/ottl/ottlfuncs/functions.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ func converters[K any]() []ottl.Factory[K] {
NewStringFactory[K](),
NewSubstringFactory[K](),
NewTimeFactory[K](),
NewTrimFactory[K](),
NewToKeyValueStringFactory[K](),
NewTruncateTimeFactory[K](),
NewTraceIDFactory[K](),
Expand Down
Loading