Skip to content

Commit

Permalink
feat(ottl): Add a new ottl trim function that trims leading and trail…
Browse files Browse the repository at this point in the history
…ing whitespace from a string
  • Loading branch information
rnishtala-sumo committed Nov 16, 2024
1 parent 4711a64 commit c73ca02
Show file tree
Hide file tree
Showing 4 changed files with 116 additions and 0 deletions.
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: []
40 changes: 40 additions & 0 deletions pkg/ottl/ottlfuncs/func_trim.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// 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]
}

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), nil
}

func trim[K any](target ottl.StringGetter[K]) 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, " "), nil
}
}
48 changes: 48 additions & 0 deletions pkg/ottl/ottlfuncs/func_trim_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// 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]
expected any
}{
{
name: "trim string",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return " this is a test ", nil
},
},
expected: "this is a test",
},
{
name: "trim empty string",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return "", nil
},
},
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
exprFunc := trim(tt.target)
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

0 comments on commit c73ca02

Please sign in to comment.