From b998890b4594a3123a71774c20ce7b12ab3a300d Mon Sep 17 00:00:00 2001 From: sinkingpoint Date: Mon, 20 May 2024 11:45:11 +1000 Subject: [PATCH 1/3] Add in `Day` converter This adds a `Day` converter that extracts the int day component from a `time.Time` Signed-off-by: sinkingpoint --- pkg/ottl/ottlfuncs/README.md | 15 ++++++++ pkg/ottl/ottlfuncs/func_day.go | 39 +++++++++++++++++++++ pkg/ottl/ottlfuncs/func_day_test.go | 54 +++++++++++++++++++++++++++++ pkg/ottl/ottlfuncs/functions.go | 1 + 4 files changed, 109 insertions(+) create mode 100644 pkg/ottl/ottlfuncs/func_day.go create mode 100644 pkg/ottl/ottlfuncs/func_day_test.go diff --git a/pkg/ottl/ottlfuncs/README.md b/pkg/ottl/ottlfuncs/README.md index 4abbb3ea9508..f6aaf61169b5 100644 --- a/pkg/ottl/ottlfuncs/README.md +++ b/pkg/ottl/ottlfuncs/README.md @@ -380,6 +380,7 @@ Available Converters: - [Base64Decode](#base64decode) - [Concat](#concat) - [ConvertCase](#convertcase) +- [Day](#day) - [ExtractPatterns](#extractpatterns) - [FNV](#fnv) - [Hour](#hour) @@ -480,6 +481,20 @@ Examples: - `ConvertCase(metric.name, "snake")` +### Day + +`Day(value)` + +The `Day` Converter returns the day component from the specified time using the Go stdlib [time.Day` function](https://pkg.go.dev/time#Time.Day). + +`value` is a `time.Time`. If `value` is another type, an error is returned. + +The returned type is `int64`. + +Examples: + +- `Day(Now())` + ### Double The `Double` Converter converts an inputted `value` into a double. diff --git a/pkg/ottl/ottlfuncs/func_day.go b/pkg/ottl/ottlfuncs/func_day.go new file mode 100644 index 000000000000..ecdd0ceb2d48 --- /dev/null +++ b/pkg/ottl/ottlfuncs/func_day.go @@ -0,0 +1,39 @@ +// 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/open-telemetry/opentelemetry-collector-contrib/pkg/ottl" +) + +type DayArguments[K any] struct { + Time ottl.TimeGetter[K] +} + +func NewDayFactory[K any]() ottl.Factory[K] { + return ottl.NewFactory("Day", &DayArguments[K]{}, createDayFunction[K]) +} + +func createDayFunction[K any](_ ottl.FunctionContext, oArgs ottl.Arguments) (ottl.ExprFunc[K], error) { + args, ok := oArgs.(*DayArguments[K]) + + if !ok { + return nil, fmt.Errorf("DayFactory args must be of type *DayArguments[K]") + } + + return Day(args.Time) +} + +func Day[K any](time ottl.TimeGetter[K]) (ottl.ExprFunc[K], error) { + return func(ctx context.Context, tCtx K) (any, error) { + t, err := time.Get(ctx, tCtx) + if err != nil { + return nil, err + } + return int64(t.Day()), nil + }, nil +} diff --git a/pkg/ottl/ottlfuncs/func_day_test.go b/pkg/ottl/ottlfuncs/func_day_test.go new file mode 100644 index 000000000000..378b8d30e967 --- /dev/null +++ b/pkg/ottl/ottlfuncs/func_day_test.go @@ -0,0 +1,54 @@ +// Copyright The OpenTelemetry Authors +// SPDX-License-Identifier: Apache-2.0 + +package ottlfuncs + +import ( + "context" + "testing" + "time" + + "github.com/stretchr/testify/assert" + + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl" +) + +func Test_Day(t *testing.T) { + tests := []struct { + name string + time ottl.TimeGetter[any] + expected int64 + }{ + { + name: "some time", + time: &ottl.StandardTimeGetter[any]{ + Getter: func(_ context.Context, _ any) (any, error) { + return time.Date(2006, time.January, 2, 15, 4, 5, 0, time.UTC), nil + }, + }, + expected: 2, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + exprFunc, err := Day(tt.time) + assert.NoError(t, err) + result, err := exprFunc(nil, nil) + assert.NoError(t, err) + assert.Equal(t, tt.expected, result) + }) + } +} + +func Test_Day_Error(t *testing.T) { + var getter ottl.TimeGetter[any] = &ottl.StandardTimeGetter[any]{ + Getter: func(_ context.Context, _ any) (any, error) { + return "not a time", nil + }, + } + exprFunc, err := Day(getter) + assert.NoError(t, err) + result, err := exprFunc(context.Background(), nil) + assert.Nil(t, result) + assert.Error(t, err) +} diff --git a/pkg/ottl/ottlfuncs/functions.go b/pkg/ottl/ottlfuncs/functions.go index 23522e9a11fc..10c9f61c9b72 100644 --- a/pkg/ottl/ottlfuncs/functions.go +++ b/pkg/ottl/ottlfuncs/functions.go @@ -38,6 +38,7 @@ func converters[K any]() []ottl.Factory[K] { NewBase64DecodeFactory[K](), NewConcatFactory[K](), NewConvertCaseFactory[K](), + NewDayFactory[K](), NewDoubleFactory[K](), NewDurationFactory[K](), NewExtractPatternsFactory[K](), From 3823c421c3bd0c4afbdf3bac8c5796c84b6f111f Mon Sep 17 00:00:00 2001 From: sinkingpoint Date: Mon, 20 May 2024 12:03:13 +1000 Subject: [PATCH 2/3] Add changelog entry for Day converter Signed-off-by: sinkingpoint --- .chloggen/add-day-converter.yaml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .chloggen/add-day-converter.yaml diff --git a/.chloggen/add-day-converter.yaml b/.chloggen/add-day-converter.yaml new file mode 100644 index 000000000000..1551c82589c2 --- /dev/null +++ b/.chloggen/add-day-converter.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: Add the `Day` Converter to extract the int Day component from a time.Time + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [33106] + +# (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: [] From 2664b751db36a9a838d0790e95a9f9b2bf726582 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Wed, 22 May 2024 09:56:08 -0600 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com> --- pkg/ottl/ottlfuncs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/ottl/ottlfuncs/README.md b/pkg/ottl/ottlfuncs/README.md index f6aaf61169b5..f50d457a6aec 100644 --- a/pkg/ottl/ottlfuncs/README.md +++ b/pkg/ottl/ottlfuncs/README.md @@ -485,7 +485,7 @@ Examples: `Day(value)` -The `Day` Converter returns the day component from the specified time using the Go stdlib [time.Day` function](https://pkg.go.dev/time#Time.Day). +The `Day` Converter returns the day component from the specified time using the Go stdlib [`time.Day` function](https://pkg.go.dev/time#Time.Day). `value` is a `time.Time`. If `value` is another type, an error is returned.