Skip to content
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/pkg-stanza-decode.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: 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]
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
8 changes: 4 additions & 4 deletions pkg/stanza/fileconsumer/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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)
}
Expand All @@ -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
}
Expand Down Expand Up @@ -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
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/stanza/fileconsumer/reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions pkg/stanza/fileconsumer/reader_factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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,
}

Expand Down
6 changes: 3 additions & 3 deletions pkg/stanza/fileconsumer/reader_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -210,7 +210,7 @@ func TestHeaderFingerprintIncluded(t *testing.T) {
regexConf := regex.NewConfig()
regexConf.Regex = "^#(?P<header>.*)"

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)
Expand Down Expand Up @@ -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),
Expand Down
4 changes: 2 additions & 2 deletions pkg/stanza/operator/input/file/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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)
Expand Down
9 changes: 4 additions & 5 deletions pkg/stanza/operator/input/tcp/tcp.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
}
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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))
Expand Down
8 changes: 4 additions & 4 deletions pkg/stanza/operator/input/udp/udp.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
}
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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))
Expand Down
4 changes: 2 additions & 2 deletions pkg/stanza/tokenize/splitter.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
}
Expand Down