rename to FormatTime

Signed-off-by: odubajDT <[email protected]>

Author: odubajDT

.chloggen/ottl-timestamp.yaml

@@ -7,7 +7,7 @@ change_type: enhancement
 component: pkg/ottl
 
 # A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
-note: "Introduce new Timestamp() converter function."
+note: "Introduce new FormatTime() converter function."
 
 # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
 issues: [36870]

pkg/ottl/e2e/e2e_test.go

@@ -938,7 +938,7 @@ func Test_e2e_converters(t *testing.T) {
 			},
 		},
 		{
-			statement: `set(attributes["time"],Timestamp(time, "%Y-%m-%d"))`,
+			statement: `set(attributes["time"], FormatTime(time, "%Y-%m-%d"))`,
 			want: func(tCtx ottllog.TransformContext) {
 				tCtx.GetLogRecord().Attributes().PutStr("time", "2020-02-11")
 			},

pkg/ottl/ottlfuncs/README.md

@@ -465,7 +465,7 @@ Available Converters:
 - [String](#string)
 - [Substring](#substring)
 - [Time](#time)
-- [Timestamp](#timestamp)
+- [FormatTime](#formattime)
 - [ToKeyValueString](#tokeyvaluestring)
 - [TraceID](#traceid)
 - [TruncateTime](#truncatetime)
@@ -1962,11 +1962,11 @@ Examples:
 - `Time("mercoledì set 4 2024", "%A %h %e %Y", "", "it")`
 - `Time("Febrero 25 lunes, 2002, 02:03:04 p.m.", "%B %d %A, %Y, %r", "America/New_York", "es-ES")`
 
-### Timestamp
+### FormatTime
 
-`Timestamp(time, format)`
+`FormatTime(time, format)`
 
-The `Timestamp` Converter takes a `time.Time` and converts it to a human readable string representations of the time according to the specidied format.
+The `FormatTime` Converter takes a `time.Time` and converts it to a human readable string representations of the time according to the specidied format.
 
 `time` is `time.Time`. If `time` is another type an error is returned. `format` is a string.
 
@@ -2015,7 +2015,7 @@ If `format` is nil, an error is returned. The parser used is the parser at [inte
 
 Examples:
 
-- `Timestamp(Time("02/04/2023", "%m/%d/%Y"), "%A %h %e %Y")`
+- `FormatTime(Time("02/04/2023", "%m/%d/%Y"), "%A %h %e %Y")`
 
 ### ToKeyValueString
 

pkg/ottl/ottlfuncs/func_timestamp.go renamed to pkg/ottl/ottlfuncs/func_formattime.go

@@ -11,26 +11,26 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
 )
 
-type TimestampArguments[K any] struct {
+type FormatTimeArguments[K any] struct {
 	Time   ottl.TimeGetter[K]
 	Format string
 }
 
-func NewTimestampFactory[K any]() ottl.Factory[K] {
-	return ottl.NewFactory("Timestamp", &TimestampArguments[K]{}, createTimestampFunction[K])
+func NewFormatTimeFactory[K any]() ottl.Factory[K] {
+	return ottl.NewFactory("FormatTime", &FormatTimeArguments[K]{}, createFormatTimeFunction[K])
 }
 
-func createTimestampFunction[K any](_ ottl.FunctionContext, oArgs ottl.Arguments) (ottl.ExprFunc[K], error) {
-	args, ok := oArgs.(*TimestampArguments[K])
+func createFormatTimeFunction[K any](_ ottl.FunctionContext, oArgs ottl.Arguments) (ottl.ExprFunc[K], error) {
+	args, ok := oArgs.(*FormatTimeArguments[K])
 
 	if !ok {
-		return nil, fmt.Errorf("TimestampFactory args must be of type *TimestampArguments[K]")
+		return nil, fmt.Errorf("FormatTimeFactory args must be of type *FormatTimeArguments[K]")
 	}
 
-	return Timestamp(args.Time, args.Format)
+	return FormatTime(args.Time, args.Format)
 }
 
-func Timestamp[K any](timeValue ottl.TimeGetter[K], format string) (ottl.ExprFunc[K], error) {
+func FormatTime[K any](timeValue ottl.TimeGetter[K], format string) (ottl.ExprFunc[K], error) {
 	if format == "" {
 		return nil, fmt.Errorf("format cannot be nil")
 	}

pkg/ottl/ottlfuncs/func_timestamp_test.go renamed to pkg/ottl/ottlfuncs/func_formattime_test.go

@@ -13,7 +13,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
 )
 
-func Test_Timestamp(t *testing.T) {
+func Test_FormatTime(t *testing.T) {
 	tests := []struct {
 		name         string
 		time         ottl.TimeGetter[any]
@@ -79,7 +79,7 @@ func Test_Timestamp(t *testing.T) {
 			expected: "July 31, 1993",
 		},
 		{
-			name: "date with timestamp",
+			name: "date with FormatTime",
 			time: &ottl.StandardTimeGetter[any]{
 				Getter: func(_ context.Context, _ any) (any, error) {
 					return time.Date(2023, 3, 14, 17, 0o2, 59, 0, time.Local), nil
@@ -151,7 +151,7 @@ func Test_Timestamp(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			exprFunc, err := Timestamp(tt.time, tt.format)
+			exprFunc, err := FormatTime(tt.time, tt.format)
 			if tt.errorMsg != "" {
 				assert.Contains(t, err.Error(), tt.errorMsg)
 			} else {

pkg/ottl/ottlfuncs/functions.go

@@ -89,7 +89,7 @@ func converters[K any]() []ottl.Factory[K] {
 		NewStringFactory[K](),
 		NewSubstringFactory[K](),
 		NewTimeFactory[K](),
-		NewTimestampFactory[K](),
+		NewFormatTimeFactory[K](),
 		NewTrimFactory[K](),
 		NewToKeyValueStringFactory[K](),
 		NewTruncateTimeFactory[K](),