Support remote log level #4413

europaul · 2024-10-31T20:33:09Z

This PR is a work in progress, but I appreciate if somebody could take a look at the code and the general approach and give me feedback.

Please see the commit messages (especially the second commit) for the overview of the changes.

Before merging this I need to update the pillar first to include the dependency in newlogd. I also need to update eve-api to include the new metrics.

I'm also planning to add more metrics as well as proper tests for newlogd to at least ensure that there is no regression.

europaul · 2024-10-31T20:37:01Z

the build is gonna break of course because the dependencies are missing in pillar

christoph-zededa · 2024-10-31T22:52:41Z

pkg/newlog/cmd/newlogd.go

+	// create the necessary directories upfront
+	if _, err := os.Stat(collectDir); os.IsNotExist(err) {
+		if err := os.MkdirAll(collectDir, 0755); err != nil {
+			log.Fatal(err)
+		}
+	}
+
+	if _, err := os.Stat(uploadDevDir); os.IsNotExist(err) {
+		if err := os.Mkdir(uploadDevDir, 0755); err != nil {
+			log.Fatal(err)
+		}
+	}
+
+	if _, err := os.Stat(uploadAppDir); os.IsNotExist(err) {
+		if err := os.Mkdir(uploadAppDir, 0755); err != nil {
+			log.Fatal(err)
+		}
+	}
+
+	if _, err := os.Stat(keepSentDir); os.IsNotExist(err) {
+		if err := os.MkdirAll(keepSentDir, 0755); err != nil {
+			log.Fatal(err)
+		}
+	}
+
+	if _, err := os.Stat(panicFileDir); os.IsNotExist(err) {
+		if err := os.MkdirAll(panicFileDir, 0755); err != nil {
+			log.Error(err)
+			return
+		}
+	}


uncleDecart · 2024-11-01T09:05:08Z

pkg/newlog/cmd/newlogd.go

+		// app.log...gz
+		// dev.log.keep...gz
+		// dev.log.upload....gz
+		// TODO: declare a clear order of removal by directory


what is format for saved files? It's not always that alphabetical <=> chronological, i.e. if we don't put zero in front of day/month, it won't work, f.e. '9' > '11' since we do symbol-wise comparison

the files are named like this:
app.6656f860-7563-4bbf-8bba-051f5942982b.log.1730464687367.gz
dev.log.keep.1730404601953.gz
dev.log.upload.1730404601953.gz

so we use timestamps instead of dates and the alphabetical order should also represent the time order.
However I understand that alphabetical order is not ideal and that's why I put that todo for myself :)

Put the correct name for the per-agent log level setting in the CONFIG-PROPERTIES.md file. Signed-off-by: Paul Gaiduk <[email protected]>

As opposed to the default log level, which was setting which logs are produced by EVE's microservices, the remote log level will set which device logs are uploaded to the cloud. So it's assumed that the remote log level is always higher than the default log level. There are no changes in how newlogd collects the logs, only in how it handles the log files. For the logs that are uploaded: - we create a separate file with prefix dev.log.upload in collect - that file is gzipped when it reaches a certain size or by timer - the same as before - once gzipped the file is moved to devUpload - the same as before - once the file is uploaded successfully, it's deleted instead of being moved to keepSentQueue For the logs that stay on the device: - we create a separate file with prefix dev.log.keep in collect - that file is gzipped when it reaches a certain size - no timer - once gzipped the file is moved to keepSentQueue - the name of the folder is preserved The commit also contains some structural changes to the newlogd code: - init fileinfo inside trigMoveToGzip instead of passing it as parameter - add initNewLogfile function Signed-off-by: Paul Gaiduk <[email protected]>

Add new metrics for newlogd: - LatestAvailableLog - the timestamp of the latest log available on the device - TotalSizeLogs - the total size of all logs on the device Signed-off-by: Paul Gaiduk <[email protected]>

naiming-zededa · 2024-11-01T17:29:18Z

pkg/newlog/cmd/newlogd.go

+	defer devStatsKeep.file.Close()
+	devStatsKeep.notUpload = true
+
+	logmetrics.DevMetrics.LatestAvailableLog = time.Now()


This one will change on every reboots of the device, but the older log entries can still stay on the disk, so it won't reflect the earliest one. Also this 'Latest' can mean the most recent timestamp, maybe something like 'oldest_saved' or something like that

that's true, very nice catch!!

Something else to watch out for are devices (like RPi4) with no battery-backed up clock, which always boot on Jan 1st 1970 UTC. ntpd/chronos sets the clock, but if the network is out the agents including newlogd start before the time is set.

@eriknordmark I'm not sure how to address that, because the logs will be then also dated Jan 1st 1970... we cannot wait until the time is set correctly and only then start logging

naiming-zededa · 2024-11-01T17:37:13Z

pkg/pillar/types/newlogtypes.go

@@ -65,6 +70,7 @@ type NewlogMetrics struct {
 	NumKmessages          uint64            // total input kmessages
 	NumSyslogMessages     uint64            // total input syslog message
 	DevTop10InputBytesPCT map[string]uint32 // top 10 sources device log input in percentage
+	TotalSizeLogs         uint64            // total size of logs on device


we have like 'NumSkipUploadAppFile', maybe we can also record the number of uploaded files.

I think it's already recorded in NumGZipFilesSent

naiming-zededa

This patch in general looks good to me, I have some comments

in collect-info.sh for 'newlog' directory, we should skip the 'devUpload' directory, since those not yet uploaded files will be the duplicates for the keep directory
similar in the edgeview in walkLogDirs() function, we need to skip the 'devUpload' directory to avoid duplicates
in loguploader.go, there is 'failSendDir' and logic to move the failed to send to controller log files and keep them there. With this change, i don't think it is needed anymore, since everything will be in the keep directory. this can simplify some logic
when doing kibana search, i do search for 'Alpine' string for locate when the device has rebooted, now we may not have this. maybe to always log at least the first 5 device log entries?

naiming-zededa · 2024-11-01T17:53:18Z

pkg/newlog/cmd/newlogd.go

@@ -108,8 +109,9 @@ var (
 	// from different goroutines, so in order to push the changes out of the
 	// goroutines local caches and correctly observe changed values in another
 	// goroutine sync/atomic synchronization is used. You've been warned.
-	syslogPrio = types.SyslogKernelLogLevelNum[types.SyslogKernelDefaultLogLevel]
-	kernelPrio = types.SyslogKernelLogLevelNum[types.SyslogKernelDefaultLogLevel]
+	remotelogPrio = types.SyslogKernelLogLevelNum[types.SyslogKernelDefaultLogLevel]


when we will have eve-api to have new config for device remote logging settings, it will be good to handle the setting for 'not upload any device log', which is not part of the log-level strings.

that's a good point!

tbh I was even thinking that we might need yet another log level - the local log level. because the user might not wanna store any logs on the device and only send them to the controller and that's not supported at the moment.
right now we store everything on the device because our default.log.level == local.log.level. and we also assume that the remote log level is going to be higher than default.log.level but we don't have any checks for it

Agreed. We should include some settings through eve-api for defining (in project level, but can be overwritten by device configitem) local logging also. Remote logging level can not be higher than the local settings.

and for end-to-end feature pov, the 'local' config should be per device, while the remote can be project scope. And the controller can add optional timeout for the local settings, e.g. turn on 'debug' for deviceA for 3 hours, controller side will remove this config after it expires.

@europaul I think we always need to store/queue the logs locally since the device might not be connected to the controller when the log is generated. But a notion of which log levels to keep stored on the device (after sent to the controller) might be what makes sense here.

@eriknordmark the logs that are meant to be sent to the controller are queued until they are

sent to the controller - then they are removed

fail to many many times - then we put them in failedUpload

eriknordmark

Can you update the description in https://github.com/lf-edge/eve/blob/master/docs/LOGGING.md with the intended new state of things?

Add a chapter explaining how different log levels are handled in the system. Signed-off-by: Paul Gaiduk <[email protected]>

europaul · 2024-11-06T18:10:24Z

Can you update the description in https://github.com/lf-edge/eve/blob/master/docs/LOGGING.md with the intended new state of things?

@eriknordmark I made the changes to the documentation, please have a look. I'm not sure if it's an overkill with the debug.local.loglevel and is a feature that nobody wants that only makes the system harder to understand?

github-actions bot requested review from deitch, eriknordmark and naiming-zededa October 31, 2024 20:33

christoph-zededa reviewed Oct 31, 2024

View reviewed changes

uncleDecart reviewed Nov 1, 2024

View reviewed changes

europaul added 3 commits November 1, 2024 13:56

correct log level setting in doc

e031097

Put the correct name for the per-agent log level setting in the CONFIG-PROPERTIES.md file. Signed-off-by: Paul Gaiduk <[email protected]>

new metrics for newlogd

d9971b5

Add new metrics for newlogd: - LatestAvailableLog - the timestamp of the latest log available on the device - TotalSizeLogs - the total size of all logs on the device Signed-off-by: Paul Gaiduk <[email protected]>

naiming-zededa reviewed Nov 1, 2024

View reviewed changes

eriknordmark requested changes Nov 5, 2024

View reviewed changes

update LOGGING.md with chapter on log levels

c894bec

Add a chapter explaining how different log levels are handled in the system. Signed-off-by: Paul Gaiduk <[email protected]>

europaul force-pushed the support-remote-log-level branch from 580384e to c894bec Compare November 6, 2024 18:08

github-actions bot requested review from eriknordmark and naiming-zededa November 6, 2024 18:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support remote log level #4413

Support remote log level #4413

europaul commented Oct 31, 2024

europaul commented Oct 31, 2024

christoph-zededa Oct 31, 2024

uncleDecart Nov 1, 2024

europaul Nov 1, 2024

naiming-zededa Nov 1, 2024 •

edited

Loading

europaul Nov 1, 2024

eriknordmark Nov 5, 2024

europaul Nov 13, 2024

naiming-zededa Nov 1, 2024

europaul Nov 1, 2024

naiming-zededa left a comment

naiming-zededa Nov 1, 2024

europaul Nov 1, 2024

naiming-zededa Nov 1, 2024

naiming-zededa Nov 1, 2024 •

edited

Loading

eriknordmark Nov 5, 2024

europaul Nov 6, 2024

eriknordmark left a comment

europaul commented Nov 6, 2024

Support remote log level #4413

Are you sure you want to change the base?

Support remote log level #4413

Conversation

europaul commented Oct 31, 2024

europaul commented Oct 31, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

naiming-zededa Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

naiming-zededa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

naiming-zededa Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eriknordmark left a comment

Choose a reason for hiding this comment

europaul commented Nov 6, 2024

naiming-zededa Nov 1, 2024 •

edited

Loading

naiming-zededa Nov 1, 2024 •

edited

Loading