Skip to content

Commit

Permalink
[pkg/ottl] Introduce ToUpperCase() converter function (open-telemetry…
Browse files Browse the repository at this point in the history
…#37427)

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#32942

---------

Signed-off-by: odubajDT <[email protected]>
Co-authored-by: Edmo Vamerlatti Costa <[email protected]>
Co-authored-by: Evan Bradley <[email protected]>
  • Loading branch information
3 people authored Feb 12, 2025
1 parent 33ed43b commit 1bba85e
Show file tree
Hide file tree
Showing 6 changed files with 192 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .chloggen/convert-case-upper.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: pkg/ottl

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Introduce ToUpperCase converter function"

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

# (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: []
6 changes: 6 additions & 0 deletions pkg/ottl/e2e/e2e_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,12 @@ func Test_e2e_converters(t *testing.T) {
tCtx.GetLogRecord().Attributes().PutStr("test", "foo_bar")
},
},
{
statement: `set(attributes["test"], ToUpperCase(attributes["http.method"]))`,
want: func(tCtx ottllog.TransformContext) {
tCtx.GetLogRecord().Attributes().PutStr("test", http.MethodGet)
},
},
{
statement: `set(attributes["test"], ConvertAttributesToElementsXML("<Log id=\"1\"><Message>This is a log message!</Message></Log>"))`,
want: func(tCtx ottllog.TransformContext) {
Expand Down
13 changes: 13 additions & 0 deletions pkg/ottl/ottlfuncs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,7 @@ Available Converters:
- [Time](#time)
- [ToKeyValueString](#tokeyvaluestring)
- [ToSnakeCase](#tosnakecase)
- [ToUpperCase](#touppercase)
- [TraceID](#traceid)
- [TruncateTime](#truncatetime)
- [Unix](#unix)
Expand Down Expand Up @@ -2069,6 +2070,18 @@ Examples:

- `ToSnakeCase(metric.name)`

### ToUpperCase

`ToUpperCase(target)`

The `ToUpperCase` Converter converts the `target` string into upper case (e.g. `MyMetricName` to `MYMETRICNAME`).

`target` is a string.

Examples:

- `ToUpperCase(metric.name)`

### TraceID

`TraceID(bytes)`
Expand Down
45 changes: 45 additions & 0 deletions pkg/ottl/ottlfuncs/func_to_upper_case.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// 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 ToUpperCaseArguments[K any] struct {
Target ottl.StringGetter[K]
}

func NewToUpperCaseFactory[K any]() ottl.Factory[K] {
return ottl.NewFactory("ToUpperCase", &ToUpperCaseArguments[K]{}, createToUpperCaseFunction[K])
}

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

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

return toUpperCase(args.Target), nil
}

func toUpperCase[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
}

if val == "" {
return val, nil
}

return strings.ToUpper(val), nil
}
}
100 changes: 100 additions & 0 deletions pkg/ottl/ottlfuncs/func_to_upper_case_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// 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_toUpperCase(t *testing.T) {
tests := []struct {
name string
target ottl.StringGetter[any]
expected any
}{
{
name: "simple",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return "simple", nil
},
},
expected: "SIMPLE",
},
{
name: "already upper",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return "SIMPLE", nil
},
},
expected: "SIMPLE",
},
{
name: "complex",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return "complex_SET-of.WORDS1234", nil
},
},
expected: "COMPLEX_SET-OF.WORDS1234",
},
{
name: "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 := toUpperCase(tt.target)
result, err := exprFunc(nil, nil)
assert.NoError(t, err)
assert.Equal(t, tt.expected, result)
})
}
}

func Test_toUpperCaseRuntimeError(t *testing.T) {
tests := []struct {
name string
target ottl.StringGetter[any]
expectedError string
}{
{
name: "non-string",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return 10, nil
},
},
expectedError: "expected string but got int",
},
{
name: "nil",
target: &ottl.StandardStringGetter[any]{
Getter: func(_ context.Context, _ any) (any, error) {
return nil, nil
},
},
expectedError: "expected string but got nil",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
exprFunc := toUpperCase[any](tt.target)
_, err := exprFunc(context.Background(), nil)
assert.ErrorContains(t, err, tt.expectedError)
})
}
}
1 change: 1 addition & 0 deletions pkg/ottl/ottlfuncs/functions.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ func converters[K any]() []ottl.Factory[K] {
NewTrimFactory[K](),
NewToKeyValueStringFactory[K](),
NewToSnakeCaseFactory[K](),
NewToUpperCaseFactory[K](),
NewTruncateTimeFactory[K](),
NewTraceIDFactory[K](),
NewUnixFactory[K](),
Expand Down

0 comments on commit 1bba85e

Please sign in to comment.