diff --git a/.chloggen/pkg-stanza-decode.yaml b/.chloggen/pkg-stanza-decode.yaml new file mode 100755 index 0000000000000..b26aecba37561 --- /dev/null +++ b/.chloggen/pkg-stanza-decode.yaml @@ -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: Rename 'pkg/stanza/decoder' to 'pkg/stanza/decode' + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [26340] + +# (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: [api] diff --git a/pkg/stanza/decoder/decoder.go b/pkg/stanza/decode/decode.go similarity index 95% rename from pkg/stanza/decoder/decoder.go rename to pkg/stanza/decode/decode.go index 4b0a1fc5bbe2f..af40643a0cc64 100644 --- a/pkg/stanza/decoder/decoder.go +++ b/pkg/stanza/decode/decode.go @@ -1,7 +1,7 @@ // Copyright The OpenTelemetry Authors // SPDX-License-Identifier: Apache-2.0 -package decoder // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" +package decode // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" import ( "errors" diff --git a/pkg/stanza/fileconsumer/config.go b/pkg/stanza/fileconsumer/config.go index 9206479f3e0b1..1bdbf7890f4d0 100644 --- a/pkg/stanza/fileconsumer/config.go +++ b/pkg/stanza/fileconsumer/config.go @@ -12,7 +12,7 @@ import ( "go.opentelemetry.io/collector/featuregate" "go.uber.org/zap" - "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/emit" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/fingerprint" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/header" @@ -132,7 +132,7 @@ func (c Config) buildManager(logger *zap.SugaredLogger, emit emit.Callback, fact var hCfg *header.Config if c.Header != nil { - enc, err := decoder.LookupEncoding(c.Splitter.Encoding) + enc, err := decode.LookupEncoding(c.Splitter.Encoding) if err != nil { return nil, fmt.Errorf("failed to create encoding: %w", err) } @@ -148,7 +148,7 @@ func (c Config) buildManager(logger *zap.SugaredLogger, emit emit.Callback, fact return nil, err } - enc, err := decoder.LookupEncoding(c.Splitter.Encoding) + enc, err := decode.LookupEncoding(c.Splitter.Encoding) if err != nil { return nil, err } @@ -220,7 +220,7 @@ func (c Config) validate() error { return errors.New("`max_batches` must not be negative") } - enc, err := decoder.LookupEncoding(c.Splitter.Encoding) + enc, err := decode.LookupEncoding(c.Splitter.Encoding) if err != nil { return err } diff --git a/pkg/stanza/fileconsumer/reader.go b/pkg/stanza/fileconsumer/reader.go index 94754fde49f98..d8078d03fafc0 100644 --- a/pkg/stanza/fileconsumer/reader.go +++ b/pkg/stanza/fileconsumer/reader.go @@ -12,7 +12,7 @@ import ( "go.uber.org/zap" - "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/emit" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/fingerprint" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/header" @@ -44,7 +44,7 @@ type reader struct { file *os.File lineSplitFunc bufio.SplitFunc splitFunc bufio.SplitFunc - decoder *decoder.Decoder + decoder *decode.Decoder headerReader *header.Reader processFunc emit.Callback generation int diff --git a/pkg/stanza/fileconsumer/reader_factory.go b/pkg/stanza/fileconsumer/reader_factory.go index 9d7b40a966455..ebef53be5af91 100644 --- a/pkg/stanza/fileconsumer/reader_factory.go +++ b/pkg/stanza/fileconsumer/reader_factory.go @@ -12,7 +12,7 @@ import ( "go.uber.org/zap" "golang.org/x/text/encoding" - "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/fingerprint" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/header" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/splitter" @@ -67,7 +67,7 @@ func (f *readerFactory) build(file *os.File, m *readerMetadata, lineSplitFunc bu readerMetadata: m, file: file, SugaredLogger: f.SugaredLogger.With("path", file.Name()), - decoder: decoder.New(f.encoding), + decoder: decode.New(f.encoding), lineSplitFunc: lineSplitFunc, } diff --git a/pkg/stanza/fileconsumer/reader_test.go b/pkg/stanza/fileconsumer/reader_test.go index 9a9ead149aca6..fae443dc24efb 100644 --- a/pkg/stanza/fileconsumer/reader_test.go +++ b/pkg/stanza/fileconsumer/reader_test.go @@ -11,7 +11,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/fingerprint" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/header" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/splitter" @@ -210,7 +210,7 @@ func TestHeaderFingerprintIncluded(t *testing.T) { regexConf := regex.NewConfig() regexConf.Regex = "^#(?P
.*)" - enc, err := decoder.LookupEncoding("utf-8") + enc, err := decode.LookupEncoding("utf-8") require.NoError(t, err) h, err := header.NewConfig("^#", []operator.Config{{Builder: regexConf}}, enc) @@ -239,7 +239,7 @@ func testReaderFactory(t *testing.T) (*readerFactory, chan *emitParams) { func testReaderFactoryWithSplitter(t *testing.T, splitterConfig tokenize.SplitterConfig) (*readerFactory, chan *emitParams) { emitChan := make(chan *emitParams, 100) - enc, err := decoder.LookupEncoding(splitterConfig.Encoding) + enc, err := decode.LookupEncoding(splitterConfig.Encoding) require.NoError(t, err) return &readerFactory{ SugaredLogger: testutil.Logger(t), diff --git a/pkg/stanza/operator/input/file/config.go b/pkg/stanza/operator/input/file/config.go index 589d3c962bc45..7cbcf327aaffa 100644 --- a/pkg/stanza/operator/input/file/config.go +++ b/pkg/stanza/operator/input/file/config.go @@ -6,7 +6,7 @@ package file // import "github.com/open-telemetry/opentelemetry-collector-contri import ( "go.uber.org/zap" - "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper" @@ -47,7 +47,7 @@ func (c Config) Build(logger *zap.SugaredLogger) (operator.Operator, error) { var toBody toBodyFunc = func(token []byte) interface{} { return string(token) } - if decoder.IsNop(c.Config.Splitter.Encoding) { + if decode.IsNop(c.Config.Splitter.Encoding) { toBody = func(token []byte) interface{} { copied := make([]byte, len(token)) copy(copied, token) diff --git a/pkg/stanza/operator/input/tcp/tcp.go b/pkg/stanza/operator/input/tcp/tcp.go index e0222089ea651..191d15a9d50a2 100644 --- a/pkg/stanza/operator/input/tcp/tcp.go +++ b/pkg/stanza/operator/input/tcp/tcp.go @@ -21,7 +21,7 @@ import ( "go.uber.org/zap" "golang.org/x/text/encoding" - "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/tokenize" @@ -115,7 +115,7 @@ func (c Config) Build(logger *zap.SugaredLogger) (operator.Operator, error) { return nil, fmt.Errorf("failed to resolve listen_address: %w", err) } - enc, err := decoder.LookupEncoding(c.Encoding) + enc, err := decode.LookupEncoding(c.Encoding) if err != nil { return nil, err } @@ -263,8 +263,7 @@ func (t *Input) goHandleMessages(ctx context.Context, conn net.Conn, cancel cont defer t.wg.Done() defer cancel() - dec := decoder.New(t.encoding) - + dec := decode.New(t.encoding) if t.OneLogPerPacket { var buf bytes.Buffer _, err := io.Copy(&buf, conn) @@ -293,7 +292,7 @@ func (t *Input) goHandleMessages(ctx context.Context, conn net.Conn, cancel cont }() } -func (t *Input) handleMessage(ctx context.Context, conn net.Conn, dec *decoder.Decoder, log []byte) { +func (t *Input) handleMessage(ctx context.Context, conn net.Conn, dec *decode.Decoder, log []byte) { decoded, err := dec.Decode(log) if err != nil { t.Errorw("Failed to decode data", zap.Error(err)) diff --git a/pkg/stanza/operator/input/udp/udp.go b/pkg/stanza/operator/input/udp/udp.go index b8625c2577490..4072fa7564c22 100644 --- a/pkg/stanza/operator/input/udp/udp.go +++ b/pkg/stanza/operator/input/udp/udp.go @@ -15,7 +15,7 @@ import ( "go.uber.org/zap" "golang.org/x/text/encoding" - "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/tokenize" @@ -85,7 +85,7 @@ func (c Config) Build(logger *zap.SugaredLogger) (operator.Operator, error) { return nil, fmt.Errorf("failed to resolve listen_address: %w", err) } - enc, err := decoder.LookupEncoding(c.Encoding) + enc, err := decode.LookupEncoding(c.Encoding) if err != nil { return nil, err } @@ -153,7 +153,7 @@ func (u *Input) goHandleMessages(ctx context.Context) { go func() { defer u.wg.Done() - dec := decoder.New(u.encoding) + dec := decode.New(u.encoding) buf := make([]byte, 0, MaxUDPSize) for { message, remoteAddr, err := u.readMessage() @@ -200,7 +200,7 @@ func truncateMaxLog(data []byte) (token []byte) { return data } -func (u *Input) handleMessage(ctx context.Context, remoteAddr net.Addr, dec *decoder.Decoder, log []byte) { +func (u *Input) handleMessage(ctx context.Context, remoteAddr net.Addr, dec *decode.Decoder, log []byte) { decoded, err := dec.Decode(log) if err != nil { u.Errorw("Failed to decode data", zap.Error(err)) diff --git a/pkg/stanza/tokenize/splitter.go b/pkg/stanza/tokenize/splitter.go index 2a7b66090ecfe..dafa393792067 100644 --- a/pkg/stanza/tokenize/splitter.go +++ b/pkg/stanza/tokenize/splitter.go @@ -6,7 +6,7 @@ package tokenize // import "github.com/open-telemetry/opentelemetry-collector-co import ( "bufio" - "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder" + "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decode" ) // SplitterConfig consolidates MultilineConfig and FlusherConfig @@ -29,7 +29,7 @@ func NewSplitterConfig() SplitterConfig { // Build builds bufio.SplitFunc based on the config func (c *SplitterConfig) Build(flushAtEOF bool, maxLogSize int) (bufio.SplitFunc, error) { - enc, err := decoder.LookupEncoding(c.Encoding) + enc, err := decode.LookupEncoding(c.Encoding) if err != nil { return nil, err }