Skip to content

Commit

Permalink
Move filelog.container.removeOriginalTimeField fg to stable (#37236)
Browse files Browse the repository at this point in the history 
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
Following
#35169.
This PR moves `filelog.container.removeOriginalTimeField` feature gate
to stable.

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Related to
#33389

<!--Describe what testing was performed and which tests were added.-->
#### Testing
Updated

<!--Describe the documentation added.-->
#### Documentation
Updated
<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <[email protected]>
  • Loading branch information
@ChrsMark
ChrsMark authored Jan 15, 2025
1 parent 57a5d0d commit ff70420
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 122 deletions.
27 changes: 27 additions & 0 deletions .chloggen/fg_filelog_stable.yaml
View file
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: breaking

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: pkg/stanza

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Move `filelog.container.removeOriginalTimeField` feature gate to stable

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

# (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]
7 changes: 0 additions & 7 deletions pkg/stanza/docs/operators/container.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -320,10 +320,3 @@ receivers:
</td>
</tr>
</table>

### Removing original time field

In order to remove the original time field from the log records users can enable the
`filelog.container.removeOriginalTimeField` feature gate.
The feature gate `filelog.container.removeOriginalTimeField` will be deprecated and eventually removed
in the future, following the [feature lifecycle](https://github.com/open-telemetry/opentelemetry-collector/tree/main/featuregate#feature-lifecycle).
15 changes: 4 additions & 11 deletions pkg/stanza/operator/parser/container/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/featuregate"
"go.uber.org/zap"

"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/errors"
Expand All @@ -25,11 +24,13 @@ const (
removeOriginalTimeFieldFeatureFlag = "filelog.container.removeOriginalTimeField"
)

var removeOriginalTimeField = featuregate.GlobalRegistry().MustRegister(
var _ = featuregate.GlobalRegistry().MustRegister(
removeOriginalTimeFieldFeatureFlag,
featuregate.StageBeta,
featuregate.StageStable,
featuregate.WithRegisterDescription("When enabled, deletes the original `time` field from the Log Attributes. Time is parsed to Timestamp field, which should be used instead."),
featuregate.WithRegisterReferenceURL("https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/33389"),
featuregate.WithRegisterFromVersion("v0.105.0"),
featuregate.WithRegisterToVersion("v0.118.0"),
)

func init() {
Expand Down Expand Up @@ -79,14 +80,6 @@ func (c Config) Build(set component.TelemetrySettings) (operator.Operator, error
}
}

if !removeOriginalTimeField.IsEnabled() {
// https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/33389
set.Logger.Info("`time` log record attribute will be removed in a future release. Switch now using the feature gate.",
zap.String("attribute", "time"),
zap.String("feature gate", removeOriginalTimeFieldFeatureFlag),
)
}

wg := sync.WaitGroup{}

p := &Parser{
Expand Down
4 changes: 1 addition & 3 deletions pkg/stanza/operator/parser/container/parser.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -343,9 +343,7 @@ func parseTime(e *entry.Entry, layout string) error {
// timeutils.ParseGotime calls timeutils.SetTimestampYear before returning the timeValue
e.Timestamp = timeValue

if removeOriginalTimeField.IsEnabled() {
e.Delete(entry.NewAttributeField(parseFrom))
}
e.Delete(entry.NewAttributeField(parseFrom))

return nil
}
101 changes: 0 additions & 101 deletions pkg/stanza/operator/parser/container/parser_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import (

"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/featuregate"

"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator"
Expand Down Expand Up @@ -631,103 +630,3 @@ func TestCRIRecombineProcessWithFailedDownstreamOperator(t *testing.T) {
})
}
}

func TestProcessWithTimeRemovalFlagDisabled(t *testing.T) {
require.NoError(t, featuregate.GlobalRegistry().Set(removeOriginalTimeField.ID(), false))
t.Cleanup(func() {
require.NoError(t, featuregate.GlobalRegistry().Set(removeOriginalTimeField.ID(), true))
})

cases := []struct {
name string
op func() (operator.Operator, error)
input *entry.Entry
expect *entry.Entry
}{
{
"docker",
func() (operator.Operator, error) {
cfg := NewConfigWithID("test_id")
cfg.AddMetadataFromFilePath = false
cfg.Format = "docker"
set := componenttest.NewNopTelemetrySettings()
return cfg.Build(set)
},
&entry.Entry{
Body: `{"log":"INFO: log line here","stream":"stdout","time":"2029-03-30T08:31:20.545192187Z"}`,
},
&entry.Entry{
Attributes: map[string]any{
"time": "2029-03-30T08:31:20.545192187Z",
"log.iostream": "stdout",
},
Body: "INFO: log line here",
Timestamp: time.Date(2029, time.March, 30, 8, 31, 20, 545192187, time.UTC),
},
},
{
"docker_with_auto_detection",
func() (operator.Operator, error) {
cfg := NewConfigWithID("test_id")
cfg.AddMetadataFromFilePath = false
set := componenttest.NewNopTelemetrySettings()
return cfg.Build(set)
},
&entry.Entry{
Body: `{"log":"INFO: log line here","stream":"stdout","time":"2029-03-30T08:31:20.545192187Z"}`,
},
&entry.Entry{
Attributes: map[string]any{
"time": "2029-03-30T08:31:20.545192187Z",
"log.iostream": "stdout",
},
Body: "INFO: log line here",
Timestamp: time.Date(2029, time.March, 30, 8, 31, 20, 545192187, time.UTC),
},
},
{
"docker_with_auto_detection_and_metadata_from_file_path",
func() (operator.Operator, error) {
cfg := NewConfigWithID("test_id")
cfg.AddMetadataFromFilePath = true
set := componenttest.NewNopTelemetrySettings()
return cfg.Build(set)
},
&entry.Entry{
Body: `{"log":"INFO: log line here","stream":"stdout","time":"2029-03-30T08:31:20.545192187Z"}`,
Attributes: map[string]any{
"log.file.path": "/var/log/pods/some_kube-scheduler-kind-control-plane_49cc7c1fd3702c40b2686ea7486091d3/kube-scheduler44/1.log",
},
},
&entry.Entry{
Attributes: map[string]any{
"log.iostream": "stdout",
"time": "2029-03-30T08:31:20.545192187Z",
"log.file.path": "/var/log/pods/some_kube-scheduler-kind-control-plane_49cc7c1fd3702c40b2686ea7486091d3/kube-scheduler44/1.log",
},
Body: "INFO: log line here",
Resource: map[string]any{
"k8s.pod.name": "kube-scheduler-kind-control-plane",
"k8s.pod.uid": "49cc7c1fd3702c40b2686ea7486091d3",
"k8s.container.name": "kube-scheduler44",
"k8s.container.restart_count": "1",
"k8s.namespace.name": "some",
},
Timestamp: time.Date(2029, time.March, 30, 8, 31, 20, 545192187, time.UTC),
},
},
}

for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
op, err := tc.op()
require.NoError(t, err, "did not expect operator function to return an error, this is a bug with the test case")

err = op.Process(context.Background(), tc.input)
require.NoError(t, err)
require.Equal(t, tc.expect, tc.input)
// Stop the operator
require.NoError(t, op.Stop())
})
}
}

0 comments on commit ff70420

Please sign in to comment.