[pkg/ottl] Introduce ToSnakeCase() converter function (open-telemetry…

…#37429)

<!-- 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]>

.chloggen/convert-case-snake.yaml

@@ -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 ToSnakeCase 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: []

pkg/ottl/e2e/e2e_test.go

@@ -447,6 +447,12 @@ func Test_e2e_converters(t *testing.T) {
 				tCtx.GetLogRecord().Attributes().PutStr("test", "FooBar")
 			},
 		},
+		{
+			statement: `set(attributes["test"], ToSnakeCase("fooBar"))`,
+			want: func(tCtx ottllog.TransformContext) {
+				tCtx.GetLogRecord().Attributes().PutStr("test", "foo_bar")
+			},
+		},
 		{
 			statement: `set(attributes["test"], ConvertAttributesToElementsXML("<Log id=\"1\"><Message>This is a log message!</Message></Log>"))`,
 			want: func(tCtx ottllog.TransformContext) {

pkg/ottl/ottlfuncs/README.md

@@ -467,6 +467,7 @@ Available Converters:
 - [Substring](#substring)
 - [Time](#time)
 - [ToKeyValueString](#tokeyvaluestring)
+- [ToSnakeCase](#tosnakecase)
 - [TraceID](#traceid)
 - [TruncateTime](#truncatetime)
 - [Unix](#unix)
@@ -2056,6 +2057,18 @@ Examples:
 - `ToKeyValueString(body)`
 - `ToKeyValueString(body, ":", ",", true)`
 
+### ToSnakeCase
+
+`ToSnakeCase(target)`
+
+The `ToSnakeCase` Converter converts the `target` string into snake case (e.g. `MyMetricName` to `my_metric_name`).
+
+`target` is a string.
+
+Examples:
+
+- `ToSnakeCase(metric.name)`
+
 ### TraceID
 
 `TraceID(bytes)`

pkg/ottl/ottlfuncs/func_to_snake_case.go

@@ -0,0 +1,46 @@
+// 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"
+
+	"github.com/iancoleman/strcase"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
+)
+
+type ToSnakeCaseArguments[K any] struct {
+	Target ottl.StringGetter[K]
+}
+
+func NewToSnakeCaseFactory[K any]() ottl.Factory[K] {
+	return ottl.NewFactory("ToSnakeCase", &ToSnakeCaseArguments[K]{}, createToSnakeCaseFunction[K])
+}
+
+func createToSnakeCaseFunction[K any](_ ottl.FunctionContext, oArgs ottl.Arguments) (ottl.ExprFunc[K], error) {
+	args, ok := oArgs.(*ToSnakeCaseArguments[K])
+
+	if !ok {
+		return nil, fmt.Errorf("ToSnakeCaseFactory args must be of type *ToSnakeCaseArguments[K]")
+	}
+
+	return toSnakeCase(args.Target), nil
+}
+
+func toSnakeCase[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 strcase.ToSnake(val), nil
+	}
+}

pkg/ottl/ottlfuncs/func_to_snake_case_test.go

@@ -0,0 +1,109 @@
+// 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_toSnakeCase(t *testing.T) {
+	tests := []struct {
+		name     string
+		target   ottl.StringGetter[any]
+		expected any
+	}{
+		{
+			name: "simple toSnake",
+			target: &ottl.StandardStringGetter[any]{
+				Getter: func(_ context.Context, _ any) (any, error) {
+					return "simpleString", nil
+				},
+			},
+			expected: "simple_string",
+		},
+		{
+			name: "noop already snake case",
+			target: &ottl.StandardStringGetter[any]{
+				Getter: func(_ context.Context, _ any) (any, error) {
+					return "simple_string", nil
+				},
+			},
+			expected: "simple_string",
+		},
+		{
+			name: "multiple uppercase",
+			target: &ottl.StandardStringGetter[any]{
+				Getter: func(_ context.Context, _ any) (any, error) {
+					return "CPUUtilizationMetric", nil
+				},
+			},
+			expected: "cpu_utilization_metric",
+		},
+		{
+			name: "hyphens",
+			target: &ottl.StandardStringGetter[any]{
+				Getter: func(_ context.Context, _ any) (any, error) {
+					return "simple-string", nil
+				},
+			},
+			expected: "simple_string",
+		},
+		{
+			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 := toSnakeCase(tt.target)
+			result, err := exprFunc(nil, nil)
+			assert.NoError(t, err)
+			assert.Equal(t, tt.expected, result)
+		})
+	}
+}
+
+func Test_toSnakeCaseRuntimeError(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 := toSnakeCase[any](tt.target)
+			_, err := exprFunc(context.Background(), nil)
+			assert.ErrorContains(t, err, tt.expectedError)
+		})
+	}
+}

pkg/ottl/ottlfuncs/functions.go

@@ -92,6 +92,7 @@ func converters[K any]() []ottl.Factory[K] {
 		NewFormatTimeFactory[K](),
 		NewTrimFactory[K](),
 		NewToKeyValueStringFactory[K](),
+		NewToSnakeCaseFactory[K](),
 		NewTruncateTimeFactory[K](),
 		NewTraceIDFactory[K](),
 		NewUnixFactory[K](),