Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pkg/ottl] Add Second converter #37082

Merged
merged 1 commit into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .chloggen/add-second-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 `Second` converter to return the second component from the specified time.Time

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [37042]

# (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 @@ -452,6 +452,7 @@ Available Converters:
- [ParseSimplifiedXML](#parsesimplifiedxml)
- [ParseXML](#parsexml)
- [RemoveXML](#removexml)
- [Second](#second)
- [Seconds](#seconds)
- [SHA1](#sha1)
- [SHA256](#sha256)
Expand Down Expand Up @@ -1611,6 +1612,20 @@ Delete text from nodes that contain the word "sensitive"

- `RemoveXML(body, "//*[contains(text(), 'sensitive')]")`

### Second

`Second(value)`

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

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

The returned type is `int64`.

Examples:

- `Second(Now())`

### Seconds

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

func NewSecondFactory[K any]() ottl.Factory[K] {
return ottl.NewFactory("Second", &SecondArguments[K]{}, createSecondFunction[K])
}

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

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

return Second(args.Time)
}

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

func Test_Second_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 := Second(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 @@ -76,6 +76,7 @@ func converters[K any]() []ottl.Factory[K] {
NewParseSimplifiedXMLFactory[K](),
NewParseXMLFactory[K](),
NewRemoveXMLFactory[K](),
NewSecondFactory[K](),
NewSecondsFactory[K](),
NewSHA1Factory[K](),
NewSHA256Factory[K](),
Expand Down
Loading