Skip to content

Commit

Permalink
[chore][pkg/stanza] Unexporter reader's logger (open-telemetry#27431)
Browse files Browse the repository at this point in the history
Incremental step towards decoupling the `Reader` struct.
  • Loading branch information
djaglowski committed Oct 4, 2023
1 parent a345161 commit d95256a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion pkg/stanza/fileconsumer/internal/reader/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func (f *Factory) build(file *os.File, m *Metadata, lineSplitFunc bufio.SplitFun
Metadata: m,
file: file,
FileName: file.Name(),
SugaredLogger: f.SugaredLogger.With("path", file.Name()),
logger: f.SugaredLogger.With("path", file.Name()),
decoder: decode.New(f.Encoding),
lineSplitFunc: lineSplitFunc,
}
Expand Down
22 changes: 11 additions & 11 deletions pkg/stanza/fileconsumer/internal/reader/reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ type Metadata struct {

// Reader manages a single file
type Reader struct {
*zap.SugaredLogger
*Config
*Metadata
FileName string
EOF bool
logger *zap.SugaredLogger
file *os.File
lineSplitFunc bufio.SplitFunc
splitFunc bufio.SplitFunc
Expand Down Expand Up @@ -71,7 +71,7 @@ func (r *Reader) NewFingerprintFromFile() (*fingerprint.Fingerprint, error) {
// ReadToEnd will read until the end of the file
func (r *Reader) ReadToEnd(ctx context.Context) {
if _, err := r.file.Seek(r.Offset, 0); err != nil {
r.Errorw("Failed to seek", zap.Error(err))
r.logger.Errorw("Failed to seek", zap.Error(err))
return
}

Expand All @@ -91,14 +91,14 @@ func (r *Reader) ReadToEnd(ctx context.Context) {
if err := s.Error(); err != nil {
// If Scan returned an error then we are not guaranteed to be at the end of the file
r.EOF = false
r.Errorw("Failed during scan", zap.Error(err))
r.logger.Errorw("Failed during scan", zap.Error(err))
}
break
}

token, err := r.decoder.Decode(s.Bytes())
if err != nil {
r.Errorw("decode: %w", zap.Error(err))
r.logger.Errorw("decode: %w", zap.Error(err))
} else if err := r.processFunc(ctx, token, r.FileAttributes); err != nil {
if errors.Is(err, header.ErrEndOfHeader) {
r.finalizeHeader()
Expand All @@ -110,12 +110,12 @@ func (r *Reader) ReadToEnd(ctx context.Context) {
r.splitFunc = r.lineSplitFunc
r.processFunc = r.Emit
if _, err = r.file.Seek(r.Offset, 0); err != nil {
r.Errorw("Failed to seek post-header", zap.Error(err))
r.logger.Errorw("Failed to seek post-header", zap.Error(err))
return
}
s = scanner.New(r, r.MaxLogSize, scanner.DefaultBufferSize, r.Offset, r.splitFunc)
} else {
r.Errorw("process: %w", zap.Error(err))
r.logger.Errorw("process: %w", zap.Error(err))
}
}

Expand All @@ -125,7 +125,7 @@ func (r *Reader) ReadToEnd(ctx context.Context) {

func (r *Reader) finalizeHeader() {
if err := r.headerReader.Stop(); err != nil {
r.Errorw("Failed to stop header pipeline during finalization", zap.Error(err))
r.logger.Errorw("Failed to stop header pipeline during finalization", zap.Error(err))
}
r.headerReader = nil
r.HeaderFinalized = true
Expand All @@ -138,22 +138,22 @@ func (r *Reader) Delete() {
}
r.Close()
if err := os.Remove(r.FileName); err != nil {
r.Errorf("could not delete %s", r.FileName)
r.logger.Errorf("could not delete %s", r.FileName)
}
}

// Close will close the file
func (r *Reader) Close() {
if r.file != nil {
if err := r.file.Close(); err != nil {
r.Debugw("Problem closing reader", zap.Error(err))
r.logger.Debugw("Problem closing reader", zap.Error(err))
}
r.file = nil
}

if r.headerReader != nil {
if err := r.headerReader.Stop(); err != nil {
r.Errorw("Failed to stop header pipeline", zap.Error(err))
r.logger.Errorw("Failed to stop header pipeline", zap.Error(err))
}
}
}
Expand Down Expand Up @@ -201,7 +201,7 @@ func (r *Reader) ValidateFingerprint() bool {
}
refreshedFingerprint, err := fingerprint.New(r.file, r.FingerprintSize)
if err != nil {
r.Debugw("Failed to create fingerprint", zap.Error(err))
r.logger.Debugw("Failed to create fingerprint", zap.Error(err))
return false
}
return refreshedFingerprint.StartsWith(r.Fingerprint)
Expand Down

0 comments on commit d95256a

Please sign in to comment.