[pkg/stanza] Remove helper.Duration

This struct was a wrapper around time.Duration, for the sole purpose of providing a default unit (s) for users. It is not used elsewhere in the collector and does not need to be used here either.
open-telemetry · Aug 20, 2022 · b858a14 · b858a14
1 parent 0da606e
commit b858a14
Show file tree

Hide file tree

Showing 21 changed files with 86 additions and 442 deletions.
diff --git a/pkg/stanza/docs/types/duration.md b/pkg/stanza/docs/types/duration.md
diff --git a/pkg/stanza/fileconsumer/config.go b/pkg/stanza/fileconsumer/config.go
@@ -36,7 +36,7 @@ func NewConfig() *Config {
 		IncludeFilePath:         false,
 		IncludeFileNameResolved: false,
 		IncludeFilePathResolved: false,
-		PollInterval:            helper.Duration{Duration: 200 * time.Millisecond},
+		PollInterval:            200 * time.Millisecond,
 		Splitter:                helper.NewSplitterConfig(),
 		StartAt:                 "end",
 		FingerprintSize:         DefaultFingerprintSize,
@@ -52,7 +52,7 @@ type Config struct {
 	IncludeFilePath         bool                  `mapstructure:"include_file_path,omitempty"              json:"include_file_path,omitempty"             yaml:"include_file_path,omitempty"`
 	IncludeFileNameResolved bool                  `mapstructure:"include_file_name_resolved,omitempty"     json:"include_file_name_resolved,omitempty"    yaml:"include_file_name_resolved,omitempty"`
 	IncludeFilePathResolved bool                  `mapstructure:"include_file_path_resolved,omitempty"     json:"include_file_path_resolved,omitempty"    yaml:"include_file_path_resolved,omitempty"`
-	PollInterval            helper.Duration       `mapstructure:"poll_interval,omitempty"                  json:"poll_interval,omitempty"                 yaml:"poll_interval,omitempty"`
+	PollInterval            time.Duration         `mapstructure:"poll_interval,omitempty"                  json:"poll_interval,omitempty"                 yaml:"poll_interval,omitempty"`
 	StartAt                 string                `mapstructure:"start_at,omitempty"                       json:"start_at,omitempty"                      yaml:"start_at,omitempty"`
 	FingerprintSize         helper.ByteSize       `mapstructure:"fingerprint_size,omitempty"               json:"fingerprint_size,omitempty"              yaml:"fingerprint_size,omitempty"`
 	MaxLogSize              helper.ByteSize       `mapstructure:"max_log_size,omitempty"                   json:"max_log_size,omitempty"                  yaml:"max_log_size,omitempty"`
@@ -131,7 +131,7 @@ func (c Config) Build(logger *zap.SugaredLogger, emit EmitFunc) (*Manager, error
 		},
 		finder:        c.Finder,
 		roller:        newRoller(),
-		pollInterval:  c.PollInterval.Raw(),
+		pollInterval:  c.PollInterval,
 		maxBatchFiles: c.MaxConcurrentFiles / 2,
 		knownFiles:    make([]*Reader, 0, 10),
 		seenPaths:     make(map[string]struct{}, 100),

diff --git a/pkg/stanza/fileconsumer/config_test.go b/pkg/stanza/fileconsumer/config_test.go
@@ -177,7 +177,7 @@ func TestUnmarshal(t *testing.T) {
 			ExpectErr: false,
 			Expect: func() *Config {
 				cfg := NewConfig()
-				cfg.PollInterval = helper.NewDuration(time.Second)
+				cfg.PollInterval = time.Second
 				return cfg
 			}(),
 		},
@@ -186,7 +186,7 @@ func TestUnmarshal(t *testing.T) {
 			ExpectErr: false,
 			Expect: func() *Config {
 				cfg := NewConfig()
-				cfg.PollInterval = helper.NewDuration(time.Second)
+				cfg.PollInterval = time.Second
 				return cfg
 			}(),
 		},
@@ -195,7 +195,7 @@ func TestUnmarshal(t *testing.T) {
 			ExpectErr: false,
 			Expect: func() *Config {
 				cfg := NewConfig()
-				cfg.PollInterval = helper.NewDuration(time.Millisecond)
+				cfg.PollInterval = time.Millisecond
 				return cfg
 			}(),
 		},
@@ -204,7 +204,7 @@ func TestUnmarshal(t *testing.T) {
 			ExpectErr: false,
 			Expect: func() *Config {
 				cfg := NewConfig()
-				cfg.PollInterval = helper.NewDuration(time.Second)
+				cfg.PollInterval = time.Second
 				return cfg
 			}(),
 		},
@@ -399,7 +399,7 @@ func TestBuild(t *testing.T) {
 		cfg := NewConfig()
 		cfg.Include = []string{"/var/log/testpath.*"}
 		cfg.Exclude = []string{"/var/log/testpath.ex*"}
-		cfg.PollInterval = helper.Duration{Duration: 10 * time.Millisecond}
+		cfg.PollInterval = 10 * time.Millisecond
 		return cfg
 	}
 
@@ -562,12 +562,12 @@ func TestMapStructureDecodeConfigWithHook(t *testing.T) {
 		"resource":      map[string]interface{}{},
 		"include":       expect.Include,
 		"exclude":       expect.Exclude,
-		"poll_interval": 0.2,
+		"poll_interval": 200 * time.Millisecond,
 		"multiline": map[string]interface{}{
 			"line_start_pattern": expect.Splitter.Multiline.LineStartPattern,
 			"line_end_pattern":   expect.Splitter.Multiline.LineEndPattern,
 		},
-		"force_flush_period":   0.5,
+		"force_flush_period":   500 * time.Millisecond,
 		"include_file_name":    true,
 		"include_file_path":    false,
 		"start_at":             "end",
@@ -589,13 +589,11 @@ func TestMapStructureDecodeConfigWithHook(t *testing.T) {
 func TestMapStructureDecodeConfig(t *testing.T) {
 	expect := NewTestConfig()
 	cfgMap := map[string]interface{}{
-		"attributes": map[string]interface{}{},
-		"resource":   map[string]interface{}{},
-		"include":    expect.Include,
-		"exclude":    expect.Exclude,
-		"poll_interval": map[string]interface{}{
-			"Duration": 200 * 1000 * 1000,
-		},
+		"attributes":    map[string]interface{}{},
+		"resource":      map[string]interface{}{},
+		"include":       expect.Include,
+		"exclude":       expect.Exclude,
+		"poll_interval": 200 * time.Millisecond,
 		"multiline": map[string]interface{}{
 			"line_start_pattern": expect.Splitter.Multiline.LineStartPattern,
 			"line_end_pattern":   expect.Splitter.Multiline.LineEndPattern,
@@ -607,9 +605,7 @@ func TestMapStructureDecodeConfig(t *testing.T) {
 		"max_log_size":         1024 * 1024,
 		"max_concurrent_files": 1024,
 		"encoding":             "utf16",
-		"force_flush_period": map[string]interface{}{
-			"Duration": 500 * 1000 * 1000,
-		},
+		"force_flush_period":   500 * time.Millisecond,
 	}
 
 	var actual Config

diff --git a/pkg/stanza/fileconsumer/file_test.go b/pkg/stanza/fileconsumer/file_test.go
@@ -492,7 +492,7 @@ func TestNoNewline(t *testing.T) {
 	cfg := NewConfig().includeDir(tempDir)
 	cfg.StartAt = "beginning"
 	cfg.Splitter = helper.NewSplitterConfig()
-	cfg.Splitter.Flusher.Period.Duration = time.Nanosecond
+	cfg.Splitter.Flusher.Period = time.Nanosecond
 	operator, emitCalls := buildTestManager(t, cfg)
 
 	temp := openTemp(t, tempDir)

diff --git a/pkg/stanza/fileconsumer/rotation_test.go b/pkg/stanza/fileconsumer/rotation_test.go
@@ -27,7 +27,6 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/testutil"
 )
 
@@ -262,7 +261,7 @@ func (rt rotationTest) run(tc rotationTest, copyTruncate, sequential bool) func(
 		tempDir := t.TempDir()
 		cfg := NewConfig().includeDir(tempDir)
 		cfg.StartAt = "beginning"
-		cfg.PollInterval = helper.NewDuration(tc.pollInterval)
+		cfg.PollInterval = tc.pollInterval
 		emitCalls := make(chan *emitParams, tc.totalLines)
 		operator := buildTestManagerWithEmit(t, cfg, emitCalls)
 

diff --git a/pkg/stanza/fileconsumer/testdata/poll_interval_no_units.yaml b/pkg/stanza/fileconsumer/testdata/poll_interval_no_units.yaml
@@ -1 +1 @@
-poll_interval: 1
+poll_interval: 1000000000
diff --git a/pkg/stanza/operator/helper/duration.go b/pkg/stanza/operator/helper/duration.go