Skip to content

Commit

Permalink
[pkg/ottl] Add Day converter (#33121)
Browse files Browse the repository at this point in the history
**Description:**

This adds in a `Day` converter that takes a `time.Time` and returns the
int day component. Analogous to what we already have with `Hour`

**Link to tracking Issue:** #33106

**Testing:** Added two unit tests based on the existing `Hour` ones

**Documentation:** Added the new converter to the ottlfuncs README.md

---------

Signed-off-by: sinkingpoint <colin@quirl.co.nz>
Co-authored-by: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com>
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
  • Loading branch information
3 people authored May 22, 2024
1 parent 2d1b15d commit 6df00e3
Show file tree
Hide file tree
Showing 5 changed files with 136 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .chloggen/add-day-converter.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: 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: []
15 changes: 15 additions & 0 deletions pkg/ottl/ottlfuncs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,7 @@ Available Converters:
- [Base64Decode](#base64decode)
- [Concat](#concat)
- [ConvertCase](#convertcase)
- [Day](#day)
- [ExtractPatterns](#extractpatterns)
- [FNV](#fnv)
- [Hour](#hour)
Expand Down Expand Up @@ -482,6 +483,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.
Expand Down
39 changes: 39 additions & 0 deletions pkg/ottl/ottlfuncs/func_day.go
Original file line number Diff line number Diff line change
@@ -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
}
54 changes: 54 additions & 0 deletions pkg/ottl/ottlfuncs/func_day_test.go
Original file line number Diff line number Diff line change
@@ -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)
}
1 change: 1 addition & 0 deletions pkg/ottl/ottlfuncs/functions.go
Original file line number Diff line number Diff line change
Expand Up @@ -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](),
Expand Down

0 comments on commit 6df00e3

Please sign in to comment.