[pkg/ottl] Added support for timezone in Time converter

.chloggen/ottl-time-timezone.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: Added support for timezone in Time converter
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [32140]
+
+# (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: [user]

pkg/ottl/ottlfuncs/README.md

@@ -1131,11 +1131,11 @@ Examples:
 
 ### Time
 
-`Time(target, format)`
+`Time(target, format, Optional[location])`
 
 The `Time` Converter takes a string representation of a time and converts it to a Golang `time.Time`.
 
-`target` is a string. `format` is a string.
+`target` is a string. `format` is a string, `location` is an optional string.
 
 If either `target` or `format` are nil, an error is returned. The parser used is the parser at [internal/coreinternal/parser](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/internal/coreinternal/timeutils). If the `target` and `format` do not follow the parsing rules used by this parser, an error is returned.
 
@@ -1176,13 +1176,24 @@ If either `target` or `format` are nil, an error is returned. The parser used is
 |`%%` | A % sign | |
 |`%c` | Date and time representation | Mon Jan 02 15:04:05 2006 |
 
+`location` specifies a default time zone canonical ID to be used for date parsing in case it is not part of `format`.
+
+When loading `location`, this function will look for the IANA Time Zone database in the following locations in order:
+- a directory or uncompressed zip file named by the ZONEINFO environment variable
+- on a Unix system, the system standard installation location
+- $GOROOT/lib/time/zoneinfo.zip
+- the `time/tzdata` package, if it was imported. 
+
+When building a Collector binary, importing `time/tzdata` in any Go source file will bundle the database into the binary, which guarantees the lookups will work regardless of the setup on the host setup. Note this will add roughly 500kB to binary size.
+
 Examples:
 
 - `Time("02/04/2023", "%m/%d/%Y")`
 - `Time("Feb 15, 2023", "%b %d, %Y")`
 - `Time("2023-05-26 12:34:56 HST", "%Y-%m-%d %H:%M:%S %Z")`
 - `Time("1986-10-01T00:17:33 MST", "%Y-%m-%dT%H:%M:%S %Z")`
 - `Time("2012-11-01T22:08:41+0000 EST", "%Y-%m-%dT%H:%M:%S%z %Z")`
+- `Time("2023-05-26 12:34:56", "%Y-%m-%d %H:%M:%S", "America/New_York")`
 
 ### TraceID
 

pkg/ottl/ottlfuncs/func_time.go

@@ -12,8 +12,9 @@ import (
 )
 
 type TimeArguments[K any] struct {
-	Time   ottl.StringGetter[K]
-	Format string
+	Time     ottl.StringGetter[K]
+	Format   string
+	Location ottl.Optional[string]
 }
 
 func NewTimeFactory[K any]() ottl.Factory[K] {
@@ -26,14 +27,20 @@ func createTimeFunction[K any](_ ottl.FunctionContext, oArgs ottl.Arguments) (ot
 		return nil, fmt.Errorf("TimeFactory args must be of type *TimeArguments[K]")
 	}
 
-	return Time(args.Time, args.Format)
+	return Time(args.Time, args.Format, args.Location)
 }
 
-func Time[K any](inputTime ottl.StringGetter[K], format string) (ottl.ExprFunc[K], error) {
+func Time[K any](inputTime ottl.StringGetter[K], format string, location ottl.Optional[string]) (ottl.ExprFunc[K], error) {
 	if format == "" {
 		return nil, fmt.Errorf("format cannot be nil")
 	}
-	loc, err := timeutils.GetLocation(nil, &format)
+	var defaultLocation *string
+	if !location.IsEmpty() {
+		l := location.Get()
+		defaultLocation = &l
+	}
+
+	loc, err := timeutils.GetLocation(defaultLocation, &format)
 	if err != nil {
 		return nil, err
 	}

pkg/ottl/ottlfuncs/func_time_test.go

@@ -15,11 +15,15 @@ import (
 )
 
 func Test_Time(t *testing.T) {
+	locationAmericaNewYork, _ := time.LoadLocation("America/New_York")
+	locationAsiaShanghai, _ := time.LoadLocation("Asia/Shanghai")
+
 	tests := []struct {
 		name     string
 		time     ottl.StringGetter[any]
 		format   string
 		expected time.Time
+		location string
 	}{
 		{
 			name: "simple short form",
@@ -151,10 +155,47 @@ func Test_Time(t *testing.T) {
 			format:   "%Y/%m/%d",
 			expected: time.Date(2022, 01, 01, 0, 0, 0, 0, time.Local),
 		},
+		{
+			name: "with location - America",
+			time: &ottl.StandardStringGetter[any]{
+				Getter: func(_ context.Context, _ any) (any, error) {
+					return "2023-05-26 12:34:56", nil
+				},
+			},
+			format:   "%Y-%m-%d %H:%M:%S",
+			location: "America/New_York",
+			expected: time.Date(2023, 5, 26, 12, 34, 56, 0, locationAmericaNewYork),
+		},
+		{
+			name: "with location - Asia",
+			time: &ottl.StandardStringGetter[any]{
+				Getter: func(_ context.Context, _ any) (any, error) {
+					return "2023-05-26 12:34:56", nil
+				},
+			},
+			format:   "%Y-%m-%d %H:%M:%S",
+			location: "Asia/Shanghai",
+			expected: time.Date(2023, 5, 26, 12, 34, 56, 0, locationAsiaShanghai),
+		},
+		{
+			name: "RFC 3339 in custom format before 2000, ignore default location",
+			time: &ottl.StandardStringGetter[any]{
+				Getter: func(_ context.Context, _ any) (any, error) {
+					return "1986-10-01T00:17:33 MST", nil
+				},
+			},
+			location: "Asia/Shanghai",
+			format:   "%Y-%m-%dT%H:%M:%S %Z",
+			expected: time.Date(1986, 10, 01, 00, 17, 33, 00, time.FixedZone("MST", -7*60*60)),
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			exprFunc, err := Time(tt.time, tt.format)
+			var locOptional ottl.Optional[string]
+			if tt.location != "" {
+				locOptional = ottl.NewTestingOptional(tt.location)
+			}
+			exprFunc, err := Time(tt.time, tt.format, locOptional)
 			assert.NoError(t, err)
 			result, err := exprFunc(nil, nil)
 			assert.NoError(t, err)
@@ -193,7 +234,8 @@ func Test_TimeError(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			exprFunc, err := Time[any](tt.time, tt.format)
+			var locOptional ottl.Optional[string]
+			exprFunc, err := Time[any](tt.time, tt.format, locOptional)
 			require.NoError(t, err)
 			_, err = exprFunc(context.Background(), nil)
 			assert.ErrorContains(t, err, tt.expectedError)
@@ -207,6 +249,7 @@ func Test_TimeFormatError(t *testing.T) {
 		time          ottl.StringGetter[any]
 		format        string
 		expectedError string
+		location      string
 	}{
 		{
 			name: "invalid short with no format",
@@ -218,10 +261,25 @@ func Test_TimeFormatError(t *testing.T) {
 			format:        "",
 			expectedError: "format cannot be nil",
 		},
+		{
+			name: "with unknown location",
+			time: &ottl.StandardStringGetter[any]{
+				Getter: func(_ context.Context, _ any) (any, error) {
+					return "2023-05-26 12:34:56", nil
+				},
+			},
+			format:        "%Y-%m-%d %H:%M:%S",
+			location:      "Jupiter/Ganymede",
+			expectedError: "unknown time zone Jupiter/Ganymede",
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			_, err := Time[any](tt.time, tt.format)
+			var locOptional ottl.Optional[string]
+			if tt.location != "" {
+				locOptional = ottl.NewTestingOptional(tt.location)
+			}
+			_, err := Time[any](tt.time, tt.format, locOptional)
 			assert.ErrorContains(t, err, tt.expectedError)
 		})
 	}