Skip to content

Commit

Permalink
[pkg/ottl] Add minute converter (open-telemetry#33200)
Browse files Browse the repository at this point in the history
**Description:**

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

**Link to tracking Issue:**
open-telemetry#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 <[email protected]>
Co-authored-by: Tyler Helmuth <[email protected]>
  • Loading branch information
sinkingpoint and TylerHelmuth authored May 28, 2024
1 parent 0c7802c commit ffe0c27
Show file tree
Hide file tree
Showing 5 changed files with 136 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .chloggen/sinkingpoint_add-minute-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: Adds a `Minute` converter for extracting the int minute 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 @@ -399,6 +399,7 @@ Available Converters:
- [Log](#log)
- [Microseconds](#microseconds)
- [Milliseconds](#milliseconds)
- [Minute](#minute)
- [Minutes](#minutes)
- [Month](#month)
- [Nanoseconds](#nanoseconds)
Expand Down Expand Up @@ -826,6 +827,20 @@ Examples:

- `Milliseconds(Duration("1h"))`

### Minute

`Minute(value)`

The `Minute` Converter returns the minute component from the specified time using the Go stdlib [`time.Minute` function](https://pkg.go.dev/time#Time.Minute).

`value` is a `time.Time`. If `value` is another type, an error is returned.

The returned type is `int64`.

Examples:

- `Minute(Now())`

### Minutes

`Minutes(value)`
Expand Down
39 changes: 39 additions & 0 deletions pkg/ottl/ottlfuncs/func_minute.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 MinuteArguments[K any] struct {
Time ottl.TimeGetter[K]
}

func NewMinuteFactory[K any]() ottl.Factory[K] {
return ottl.NewFactory("Minute", &MinuteArguments[K]{}, createMinuteFunction[K])
}

func createMinuteFunction[K any](_ ottl.FunctionContext, oArgs ottl.Arguments) (ottl.ExprFunc[K], error) {
args, ok := oArgs.(*MinuteArguments[K])

if !ok {
return nil, fmt.Errorf("MinuteFactory args must be of type *MinuteArguments[K]")
}

return Minute(args.Time)
}

func Minute[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.Minute()), nil
}, nil
}
54 changes: 54 additions & 0 deletions pkg/ottl/ottlfuncs/func_minute_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_Minute(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: 4,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
exprFunc, err := Minute(tt.time)
assert.NoError(t, err)
result, err := exprFunc(nil, nil)
assert.NoError(t, err)
assert.Equal(t, tt.expected, result)
})
}
}

func Test_Minute_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 := Minute(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 @@ -57,6 +57,7 @@ func converters[K any]() []ottl.Factory[K] {
NewLogFactory[K](),
NewMicrosecondsFactory[K](),
NewMillisecondsFactory[K](),
NewMinuteFactory[K](),
NewMinutesFactory[K](),
NewMonthFactory[K](),
NewNanosecondsFactory[K](),
Expand Down

0 comments on commit ffe0c27

Please sign in to comment.