Skip to content

Commit 04d768d

Browse files
mergify[bot]mergify[bot]
authored
[8.19](backport #45086) [Chore] Replace global logger with local logger #10 (#45220)
* [Chore] Replace global logger with local logger #10 (#45086)
1 parent e2eada2 commit 04d768d

File tree

117 files changed

+471
-350
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+471
-350
lines changed

‎auditbeat/module/file_integrity/eventreader_kprobes.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ type kProbesReader struct {
4747

4848
func newKProbesReader(config Config, l *logp.Logger, parsers []FileParser) (*kProbesReader, error) {
4949
processor, err := add_process_metadata.NewWithConfig(
50+
l,
5051
add_process_metadata.ConfigOverwriteKeys(true),
5152
add_process_metadata.ConfigMatchPIDs([]string{"process.pid"}),
5253
)

‎filebeat/beater/diagnostics.go

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -70,41 +70,44 @@ func getRegexpsForRegistryFiles() ([]*regexp.Regexp, error) {
7070
return registryFileRegExps, nil
7171
}
7272

73-
func gzipRegistry() []byte {
74-
logger := logp.L().Named("diagnostics")
75-
buf := bytes.Buffer{}
76-
dataPath := paths.Resolve(paths.Data, "")
77-
registryPath := filepath.Join(dataPath, "registry")
78-
f, err := os.CreateTemp("", "filebeat-registry-*.tar")
79-
if err != nil {
80-
logger.Errorw("cannot create temporary registry archive", "error.message", err)
81-
}
82-
// Close the file, we just need the empty file created to use it later
83-
f.Close()
84-
defer logger.Debug("finished gziping Filebeat's registry")
85-
86-
defer func() {
87-
if err := os.Remove(f.Name()); err != nil {
88-
logger.Warnf("cannot remove temporary registry archive '%s': '%s'", f.Name(), err)
73+
func gzipRegistry(logger *logp.Logger) func() []byte {
74+
logger = logger.Named("diagnostics")
75+
76+
return func() []byte {
77+
buf := bytes.Buffer{}
78+
dataPath := paths.Resolve(paths.Data, "")
79+
registryPath := filepath.Join(dataPath, "registry")
80+
f, err := os.CreateTemp("", "filebeat-registry-*.tar")
81+
if err != nil {
82+
logger.Errorw("cannot create temporary registry archive", "error.message", err)
83+
}
84+
// Close the file, we just need the empty file created to use it later
85+
f.Close()
86+
defer logger.Debug("finished gziping Filebeat's registry")
87+
88+
defer func() {
89+
if err := os.Remove(f.Name()); err != nil {
90+
logger.Warnf("cannot remove temporary registry archive '%s': '%s'", f.Name(), err)
91+
}
92+
}()
93+
94+
logger.Debugf("temporary file '%s' created", f.Name())
95+
if err := tarFolder(logger, registryPath, f.Name()); err != nil {
96+
logger.Errorw(fmt.Sprintf("cannot archive Filebeat's registry at '%s'", f.Name()), "error.message", err)
8997
}
90-
}()
9198

92-
logger.Debugf("temporary file '%s' created", f.Name())
93-
if err := tarFolder(logger, registryPath, f.Name()); err != nil {
94-
logger.Errorw(fmt.Sprintf("cannot archive Filebeat's registry at '%s'", f.Name()), "error.message", err)
95-
}
99+
if err := gzipFile(logger, f.Name(), &buf); err != nil {
100+
logger.Errorw("cannot gzip Filebeat's registry", "error.message", err)
101+
}
96102

97-
if err := gzipFile(logger, f.Name(), &buf); err != nil {
98-
logger.Errorw("cannot gzip Filebeat's registry", "error.message", err)
99-
}
103+
// if the final file is too large, skip it
104+
if buf.Len() >= 20_000_000 { // 20 Mb
105+
logger.Warnf("registry is too large for diagnostics, %dmb bytes > 20mb", buf.Len()/1_000_000)
106+
return nil
107+
}
100108

101-
// if the final file is too large, skip it
102-
if buf.Len() >= 20_000_000 { // 20 Mb
103-
logger.Warnf("registry is too large for diagnostics, %dmb bytes > 20mb", buf.Len()/1_000_000)
104-
return nil
109+
return buf.Bytes()
105110
}
106-
107-
return buf.Bytes()
108111
}
109112

110113
// gzipFile gzips src writing the compressed data to dst

‎filebeat/beater/filebeat.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ func newBeater(b *beat.Beat, plugins PluginFactory, rawConfig *conf.C) (beat.Bea
144144
"Filebeat's registry",
145145
"registry.tar.gz",
146146
"application/octet-stream",
147-
gzipRegistry)
147+
gzipRegistry(b.Info.Logger))
148148
}
149149

150150
// Add inputs created by the modules

‎filebeat/input/filestream/input.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ func (inp *filestream) open(
252252

253253
r = readfile.NewFilemeta(r, fs.newPath, fs.desc.Info, fs.desc.Fingerprint, offset)
254254

255-
r = inp.parsers.Create(r)
255+
r = inp.parsers.Create(r, log)
256256

257257
r = readfile.NewLimitReader(r, inp.readerConfig.MaxBytes)
258258

‎filebeat/input/journald/input.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ func (inp *journald) Run(
191191
converter: journalfield.NewConverter(ctx.Logger, nil),
192192
canceler: ctx.Cancelation,
193193
saveRemoteHostname: inp.SaveRemoteHostname,
194-
})
194+
}, logger)
195195

196196
ctx.UpdateStatus(status.Running, "Running")
197197
for {

‎filebeat/input/kafka/input.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ func (h *groupHandler) ack(message *sarama.ConsumerMessage) {
308308

309309
func (h *groupHandler) ConsumeClaim(session sarama.ConsumerGroupSession, claim sarama.ConsumerGroupClaim) error {
310310
reader := h.createReader(claim)
311-
parser := h.parsers.Create(reader)
311+
parser := h.parsers.Create(reader, h.log)
312312
for h.session.Context().Err() == nil {
313313
message, err := parser.Next()
314314
if errors.Is(err, io.EOF) {

‎filebeat/input/log/harvester.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -685,17 +685,17 @@ func (h *Harvester) newLogFileReader() (reader.Reader, error) {
685685

686686
if h.config.DockerJSON != nil {
687687
// Docker json-file format, add custom parsing to the pipeline
688-
r = readjson.New(r, h.config.DockerJSON.Stream, h.config.DockerJSON.Partial, h.config.DockerJSON.Format, h.config.DockerJSON.CRIFlags)
688+
r = readjson.New(r, h.config.DockerJSON.Stream, h.config.DockerJSON.Partial, h.config.DockerJSON.Format, h.config.DockerJSON.CRIFlags, h.logger)
689689
}
690690

691691
if h.config.JSON != nil {
692-
r = readjson.NewJSONReader(r, h.config.JSON)
692+
r = readjson.NewJSONReader(r, h.config.JSON, h.logger)
693693
}
694694

695695
r = readfile.NewStripNewline(r, h.config.LineTerminator)
696696

697697
if h.config.Multiline != nil {
698-
r, err = multiline.New(r, "\n", h.config.MaxBytes, h.config.Multiline)
698+
r, err = multiline.New(r, "\n", h.config.MaxBytes, h.config.Multiline, h.logger)
699699
if err != nil {
700700
return nil, err
701701
}

‎filebeat/input/registry.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ type Factory = func(config *conf.C, connector channel.Connector, context Context
4343
var registry = make(map[string]Factory)
4444

4545
func Register(name string, factory Factory) error {
46-
logp.Info("Registering input factory")
4746
if name == "" {
4847
return fmt.Errorf("Error registering input: name cannot be empty") //nolint:staticcheck //Keep old behavior
4948
}
@@ -55,7 +54,6 @@ func Register(name string, factory Factory) error {
5554
}
5655

5756
registry[name] = factory
58-
logp.Info("Successfully registered input")
5957

6058
return nil
6159
}

‎filebeat/registrar/migrate.go

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,13 @@ func NewMigrator(cfg config.Registry, logger *logp.Logger) *Migrator {
6969
func (m *Migrator) Run() error {
7070
migrateFile := m.migrateFile
7171
if migrateFile == "" {
72-
if isFile(m.dataPath) {
72+
if isFile(m.dataPath, m.logger) {
7373
migrateFile = m.dataPath
7474
}
7575
}
7676

7777
fbRegHome := filepath.Join(m.dataPath, "filebeat")
78-
version, err := readVersion(fbRegHome, migrateFile)
78+
version, err := readVersion(fbRegHome, migrateFile, m.logger)
7979
if err != nil {
8080
return err
8181
}
@@ -101,7 +101,7 @@ func (m *Migrator) Run() error {
101101
// format to the current version. If so continue with
102102
// the migration and try again.
103103
backupFile := migrateFile + ".bak"
104-
if isFile(backupFile) {
104+
if isFile(backupFile, m.logger) {
105105
migrateFile = backupFile
106106
version = legacyVersion
107107
break
@@ -129,13 +129,13 @@ func (m *Migrator) updateToVersion0(regHome, migrateFile string) error {
129129

130130
if m.dataPath == migrateFile {
131131
backupFile := migrateFile + ".bak"
132-
if isFile(migrateFile) {
132+
if isFile(migrateFile, m.logger) {
133133
m.logger.Infof("Move registry file to backup file: %v", backupFile)
134134
if err := helper.SafeFileRotate(backupFile, migrateFile); err != nil {
135135
return err
136136
}
137137
migrateFile = backupFile
138-
} else if isFile(backupFile) {
138+
} else if isFile(backupFile, m.logger) {
139139
m.logger.Info("Old registry backup file found, continue migration")
140140
migrateFile = backupFile
141141
}
@@ -146,7 +146,7 @@ func (m *Migrator) updateToVersion0(regHome, migrateFile string) error {
146146
}
147147

148148
dataFile := filepath.Join(regHome, "data.json")
149-
if !isFile(dataFile) && isFile(migrateFile) {
149+
if !isFile(dataFile, m.logger) && isFile(migrateFile, m.logger) {
150150
m.logger.Info("Migrate old registry file to new data file")
151151
err := helper.SafeFileRotate(dataFile, migrateFile)
152152
if err != nil {
@@ -158,15 +158,15 @@ func (m *Migrator) updateToVersion0(regHome, migrateFile string) error {
158158
}
159159

160160
func initVersion0Registry(regHome string, perm os.FileMode, logger *logp.Logger) error {
161-
if !isDir(regHome) {
161+
if !isDir(regHome, logger) {
162162
logger.Infof("No registry home found. Create: %v", regHome)
163163
if err := os.MkdirAll(regHome, 0o750); err != nil {
164164
return fmt.Errorf("failed to create registry dir '%v': %w", regHome, err)
165165
}
166166
}
167167

168168
metaFile := filepath.Join(regHome, "meta.json")
169-
if !isFile(metaFile) {
169+
if !isFile(metaFile, logger) {
170170
logger.Info("Initialize registry meta file")
171171
err := safeWriteFile(metaFile, []byte(`{"version": "0"}`), perm)
172172
if err != nil {
@@ -184,7 +184,7 @@ func (m *Migrator) updateToVersion1(regHome string) error {
184184
m.logger.Info("Migrate registry version 0 to version 1")
185185

186186
origDataFile := filepath.Join(regHome, "data.json")
187-
if !isFile(origDataFile) {
187+
if !isFile(origDataFile, m.logger) {
188188
return fmt.Errorf("missing original data file at: %v", origDataFile)
189189
}
190190

@@ -248,17 +248,17 @@ func (m *Migrator) updateToVersion1(regHome string) error {
248248
return nil
249249
}
250250

251-
func readVersion(regHome, migrateFile string) (registryVersion, error) {
252-
if isFile(migrateFile) {
251+
func readVersion(regHome, migrateFile string, log *logp.Logger) (registryVersion, error) {
252+
if isFile(migrateFile, log) {
253253
return legacyVersion, nil
254254
}
255255

256-
if !isDir(regHome) {
256+
if !isDir(regHome, log) {
257257
return noRegistry, nil
258258
}
259259

260260
metaFile := filepath.Join(regHome, "meta.json")
261-
if !isFile(metaFile) {
261+
if !isFile(metaFile, log) {
262262
return noRegistry, nil
263263
}
264264

@@ -275,17 +275,17 @@ func readVersion(regHome, migrateFile string) (registryVersion, error) {
275275
return registryVersion(meta.Version), nil
276276
}
277277

278-
func isDir(path string) bool {
278+
func isDir(path string, log *logp.Logger) bool {
279279
fi, err := os.Stat(path)
280280
exists := err == nil && fi.IsDir()
281-
logp.Debug("test", "isDir(%v) -> %v", path, exists)
281+
log.Named("test").Debugf("isDir(%v) -> %v", path, exists)
282282
return exists
283283
}
284284

285-
func isFile(path string) bool {
285+
func isFile(path string, log *logp.Logger) bool {
286286
fi, err := os.Stat(path)
287287
exists := err == nil && fi.Mode().IsRegular()
288-
logp.Debug("test", "isFile(%v) -> %v", path, exists)
288+
log.Named("test").Debugf("isFile(%v) -> %v", path, exists)
289289
return exists
290290
}
291291

‎filebeat/scripts/tester/main.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ import (
3535
"github.com/elastic/beats/v7/libbeat/reader/multiline"
3636
"github.com/elastic/beats/v7/libbeat/reader/readfile"
3737
"github.com/elastic/beats/v7/libbeat/reader/readfile/encoding"
38+
"github.com/elastic/elastic-agent-libs/logp"
3839
"github.com/elastic/elastic-agent-libs/mapstr"
3940
)
4041

@@ -151,6 +152,10 @@ func getLogsFromFile(logfile string, conf *logReaderConfig) ([]string, error) {
151152

152153
r = readfile.NewStripNewline(r, readfile.LineFeed)
153154

155+
logger, err := logp.NewDevelopmentLogger("")
156+
if err != nil {
157+
return nil, err
158+
}
154159
if conf.multiPattern != "" {
155160
p, err := match.Compile(conf.multiPattern)
156161
if err != nil {
@@ -162,7 +167,7 @@ func getLogsFromFile(logfile string, conf *logReaderConfig) ([]string, error) {
162167
Match: conf.matchMode,
163168
Pattern: &p,
164169
}
165-
r, err = multiline.New(r, "\n", 1<<20, &c)
170+
r, err = multiline.New(r, "\n", 1<<20, &c, logger)
166171
if err != nil {
167172
return nil, err
168173
}

0 commit comments

Comments
 (0)