Set Log Levels

Introduction

Log levels can be set for three different components of EVE-OS: EVE-OS microservices, syslog, and kernel. The log levels set this way are used to control the verbosity of the logs produced by the corresponding components. All logs produced this way will be saved locally in the /persist/newlog/keepSentQueue/ directory and will be subject to rotation based on the max total size of stored logs.

You might want to change your log levels for a variety of reasons. For example, if you have low bandwidth, you might disable info messages and only enable more serious levels of logging.  

Prerequisites

• You must have at least the SysOperator role in your ZEDEDA Cloud enterprise.
• ZCLI is running.

Logrus and Syslog Levels

There are two different sets of log levels that can be set:

• Logrus levels are used by the EVE microservices - the logrus levels are as follows: panic, fatal, error, warning, info, debug, and trace ["https://pkg.go.dev/github.com/sirupsen/logrus"].
• Syslog levels are used by syslog and kernel - the syslog levels are as follows: emerg, alert, crit, err, warning, notice, info, debug ["https://man7.org/linux/man-pages/man3/syslog.3.html"].

Additionally all log levels can be set to "none" to disable logging for the corresponding component or to "all" to enable all log levels.

Remote Log Levels

The "remote" log levels control which subset of the generated logs are sent to the controller. A corresponding "remote" log level can be set for each of the three components: EVE microservices, syslog, and kernel.

Per-Agent Log Levels

In addition, there can be per-agent settings to overwrite the default log level set for EVE microservices. These use the same log levels as the default log level settings (logrus). The per-agent settings begin with "agent.agentname.setting":

The following agents support per-agent log level settings with "agent.agentname.setting":

• newlogd
• wwan
• nodeagent
• downloader
• tpmmgr
• client
• vcomlink
• executor
• vaultmgr
• baseosmgr
• zedagent
• verifier
• wstunnelclient
• zfsmanager
• zedkube
• ledmanager
• faultinjection
• zedmanager
• nim
• loguploader
• watcher
• volumemgr
• zedrouter
• msrv
• domainmgr
• diag

In case of updates: https://github.com/lf-edge/eve/blob/master/docs/CONFIG-PROPERTIES.md#log-levels

Use the ZCLI to Set the Log Level

You can set edge node log configurations through ZCLI (such as loglevel, debug.enable.ssh, interval, and more) at both the project and edge node levels. If you set a log configuration at the project level, all devices onboarded under that project will inherit the project's configurations. If you set log configurations at both the project and edge node levels, the device will inherit the project level settings as well as the specific configurations set at the device level. The edge node level settings take precedence over project level settings. If you set a parameter at the project level, then the edge node level, and then the project level again - the edge node level will still take precedence.

To set the log level for an edge node or for a project, use the update command with the --config option. Enter the “key” for the type of log and the “value” for the log level. See the following examples for the syntax. 

Single edge node

zcli edge-node update <name> [--config=<key:value>...]

zcli edge-node update MY-NODE --config="debug.default.loglevel:error"

Project

zcli project update <name> [--config=<key:value>...]

zcli project update MY-PROJECT --config="debug.default.loglevel:error"

Next Steps

• Collect diagnostic data from edge nodes with collect info sh
• How to collect logs from an edge device with a USB drive