Skip to content

Commit d02eabc

Browse files
ridwanmsharifdjaglowski
authored andcommitted
pkg/stanza/fileconsumer: remove new file log when the noStateTracker is used (open-telemetry#39861)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Add to the interface to be able to identify which tracker is being used. Also mute the log when no state is tracked. <!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. --> #### Link to tracking issue Fixes open-telemetry#39855 Signed-off-by: Ridwan Sharif <[email protected]> Co-authored-by: Daniel Jaglowski <[email protected]>
1 parent 19069c0 commit d02eabc

File tree

3 files changed

+47
-1
lines changed

3 files changed

+47
-1
lines changed

.chloggen/mute-log.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: bug_fix
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: pkg/stanza/fileconsumer
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Mute new reader log when the noStateTracker is used
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [39855]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: []

pkg/stanza/fileconsumer/file.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,8 +261,13 @@ func (m *Manager) newReader(ctx context.Context, file *os.File, fp *fingerprint.
261261
return r, nil
262262
}
263263

264+
// When the NoStateTracker is used, this would result in log spam as new
265+
// readers are created every scrape interval.
266+
if m.tracker.Name() != tracker.NoStateTracker {
267+
m.set.Logger.Info("Started watching file", zap.String("path", file.Name()))
268+
}
269+
264270
// If we don't match any previously known files, create a new reader from scratch
265-
m.set.Logger.Info("Started watching file", zap.String("path", file.Name()))
266271
r, err := m.readerFactory.NewReader(file, fp)
267272
if err != nil {
268273
return nil, err

pkg/stanza/fileconsumer/internal/tracker/tracker.go

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ import (
1616
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator"
1717
)
1818

19+
const (
20+
FileTracker = "fileTracker"
21+
NoStateTracker = "noStateTracker"
22+
)
23+
1924
// Interface for tracking files that are being consumed.
2025
type Tracker interface {
26+
Name() string
2127
Add(reader *reader.Reader)
2228
GetCurrentFile(fp *fingerprint.Fingerprint) *reader.Reader
2329
GetOpenFile(fp *fingerprint.Fingerprint) *reader.Reader
@@ -63,6 +69,10 @@ func NewFileTracker(ctx context.Context, set component.TelemetrySettings, maxBat
6369
return t
6470
}
6571

72+
func (t *fileTracker) Name() string {
73+
return FileTracker
74+
}
75+
6676
func (t *fileTracker) Add(reader *reader.Reader) {
6777
// add a new reader for tracking
6878
t.currentPollFiles.Add(reader)
@@ -155,6 +165,10 @@ func NewNoStateTracker(set component.TelemetrySettings, maxBatchFiles int) Track
155165
}
156166
}
157167

168+
func (t *noStateTracker) Name() string {
169+
return NoStateTracker
170+
}
171+
158172
func (t *noStateTracker) Add(reader *reader.Reader) {
159173
// add a new reader for tracking
160174
t.currentPollFiles.Add(reader)

0 commit comments

Comments
 (0)