Skip to content

Latest commit

 

History

History
158 lines (146 loc) · 20.8 KB

File metadata and controls

158 lines (146 loc) · 20.8 KB

EVE Runtime Configuration Properties

Name Type Default Min Value Max Value Description
app.allow.vnc boolean false (only local access) - - allow access to EVE's VNC ports from external IPs
app.boot.order string "" - - Set device-wide default boot order for VMs. Supported values: "" (default UEFI behavior), "usb" (prioritize USB devices), "nousb" (remove USB devices from boot order). Can be overridden per-VM via Controller API (VmConfig.boot_order) or LPS (/api/v1/appbootinfo). See VM-BOOT-ORDER.md for details.
app.fml.resolution string notset - - Set system-wide value of forced resolution for applications running in FML mode, it can be one of predefined FmlResolution* values.
timer.config.interval integer in seconds 60 (1 minute) 5 86400 (1 day) how frequently device gets config (needs a reboot to take effect)
timer.cert.interval integer in seconds 86400 (1 day) 60 (1 minute) 4294967295 (max uint32) how frequently device checks for new controller certificates
timer.metric.interval integer in seconds 60 (1 minute) 5 3600 (1 hour) how frequently device reports metrics
timer.hardwarehealth.interval integer in seconds 43200 (12 hours) 21600 (6 hours) 4294967295 (max uint32) how frequently device reports hardware health information (ECC, SMART) to controller
timer.hardwareinfo.interval integer in seconds 10800 (3 hours) 10800 (3 hours) 4294967295 (max uint32) how frequently device reports hardware information (SMART) to controller (deprecated)
timer.deviceinfo.interval integer in seconds 600 (10 minutes) 30 4294967295 (max uint32) how frequently device is forced to report device info to controller even though nothing changed (needs a reboot to take effect)
timer.metric.diskscan.interval integer in seconds 300 (5 minutes) 5 3600 (1 hour) how frequently device should scan the disk for metrics
timer.location.cloud.interval integer in seconds 3600 (1 hour) 300 (5 minutes) 4294967295 (max uint32) how frequently device reports geographic location information to controller
timer.location.app.interval integer in seconds 20 5 3600 (1 hour) how frequently device reports geographic location information to applications (to local profile server and to other apps via metadata server)
timer.ntpsources.interval integer in seconds 600 (10 minutes) 60 (1 minute) 4294967295 (max uint32) how frequently device forcibly reports information about NTP sources to which EVE has established a connection for the NTP synchronization. Requests are also sent to the controller if the list of NTP peers or NTP peer fields, such as mode, state, have changed. (doesn't need a reboot to take effect)
timer.send.timeout timer in seconds 120 (2 minutes) 0 3600 (1 hour) time for each http/send
timer.dial.timeout timer in seconds 10 0 3600 (1 hour) maximum time allowed to establish connection
timer.reboot.no.network integer in seconds 604800 (7 days) 120 (2 minutes) 4294967295 (max uint32) reboot after no cloud connectivity
timer.update.fallback.no.network integer in seconds 300 (5 minutes) 60 (1 minute) 4294967295 (max uint32) fallback after no cloud connectivity
timer.test.baseimage.update integer in seconds 600 (10 minutes) 30 3600 (1 hour) commit to update
timer.gc.vdisk integer in seconds 3600 (1 hour) 60 (1 minute) 4294967295 (max uint32) garbage collect unused instance virtual disk
timer.defer.content.delete integer in seconds 0 0 86400 (1 day) if set, keep content trees around for reuse after they have been deleted
timer.download.retry integer in seconds 600 (10 minutes) 60 (1 minute) 4294967295 (max uint32) retry a failed download
timer.download.stalled integer in seconds 600 (10 minutes) 20 4294967295 (max uint32) cancel a stalled download
timer.boot.retry integer in seconds 600 (10 minutes) 10 4294967295 (max uint32) retry a failed domain boot
timer.port.georedo integer in seconds 3600 (1 hour) 60 (1 minute) 4294967295 (max uint32) redo IP geolocation
timer.port.georetry integer in seconds 600 (10 minutes) 5 4294967295 (max uint32) retry geolocation after failure
timer.port.testduration integer in seconds 30 10 3600 (1 hour) wait for DHCP to give address
timer.port.testinterval timer in seconds 300 (5 minutes) 300 (5 minutes) 3600 (1 hour) retest the current port config
timer.port.timeout timer in seconds 15 0 3600 (1 hour) time for each http/send
timer.port.testbetterinterval timer in seconds 600 (10 minutes) 0 4294967295 (max uint32) test a higher prio port config
network.fallback.any.eth "enabled" or "disabled" disabled (enabled forcefully during onboarding if no network config) - - if no connectivity try any Ethernet, WiFi, or LTE with DHCP client
network.download.max.cost 0-255 0 0 255 max port cost for download to avoid e.g., LTE ports
blob.download.max.retries 1-10 5 1 10 max download retries when image verification fails.
debug.enable.usb boolean false - - allow USB e.g. keyboards on device
debug.enable.vga boolean false - - allow VGA console on device
debug.enable.ssh authorized ssh key empty string(ssh disabled) - - allow ssh to EVE
debug.enable.console boolean false - - allow console access to EVE (reboot required to disable)
debug.enable.vnc.shim.vm boolean false - - allow VNC access to the container application shim VM (reboot required to disable)
storage.dom0.disk.minusage.percent integer percent 20 20 80 min. percent of persist partition reserved for dom0
storage.zfs.reserved.percent integer percent 20 1 99 min. percent of persist partition reserved for zfs performance
storage.apps.ignore.disk.check boolean false - - Ignore disk usage check for Apps. Allows apps to create images bigger than available disk
timer.appcontainer.stats.interval integer in seconds 300 (5 minutes) 1 4294967295 (max uint32) collect application container stats
timer.vault.ready.cutoff integer in seconds 300 (5 minutes) 60 (1 minute) 4294967295 (max uint32) reboot after inaccessible vault
maintenance.mode "enabled" or "disabled" "none" - - don't run applications etc
airgap.mode "enabled" or "disabled" "none" - - Enable when the device is expected to operate without connectivity to the main controller and is instead managed locally via the LOC (Local Operator Console)
force.fallback.counter integer 0 0 4294967295 (max uint32) forces fallback to other image if counter is changed
newlog.allow.fastupload boolean false - - allow faster upload gzip logfiles to controller
memory.apps.ignore.check boolean false - - Ignore memory usage check for Apps
memory.vmm.limit.MiB integer 0 0 1073741824 (1 PiB) Manually override how much overhead is allocated for each running VMM
gogc.memory.limit.bytes integer 0 0 4294967295 (max uint32) Golang runtime soft memory limit, see details in API doc ["https://pkg.go.dev/runtime/debug#SetMemoryLimit"]
gogc.percent integer 100 0 500 Golang runtime garbage collector target percentage, see details in API doc ["https://pkg.go.dev/runtime/debug#SetGCPercent"]
gogc.forced.interval.seconds integer in seconds 10 0 1000 minimum interval of forced execution of the GC. Forced GC is disabled when interval is set to 0
gogc.forced.growth.memory.MiB integer in Mbytes 50 10 1024 minimum allocated memory in MiB required for the next GC execution
gogc.forced.growth.memory.percent integer 20 5 300 minimum allocated memory percentage from last reclaim required for the next GC execution
newlog.gzipfiles.ondisk.maxmegabytes integer in Mbytes 2048 10 4294967295 (max uint32) the quota for keepig newlog gzip files on device
process.cloud-init.multipart boolean false - - help VMs which do not handle mime multi-part themselves
netdump.enable boolean true - - enable publishing of network diagnostics (as tgz archives to /persist/netdump)
netdump.topic.preonboard.interval integer in seconds 3600 (1 hour) 60 (1 minute) 4294967295 (max uint32) how frequently (in seconds) can be netdumps of the same topic published while device is not yet onboarded
netdump.topic.postonboard.interval integer in seconds 86400 (1 day) 60 (1 minute) 4294967295 (max uint32) how frequently (in seconds) can be netdumps of the same topic published after device has been onboarded
netdump.topic.maxcount integer 10 1 4294967295 (max uint32) maximum number of netdumps that can be published for each topic. The oldest netdump is unpublished should a new netdump exceed the limit.
netdump.downloader.with.pcap boolean false - - include packet captures inside netdumps for download requests. However, even if enabled, TCP segments carrying non-empty payload (i.e. content which is being downloaded) are excluded and the overall PCAP size is limited to 64MB.
netdump.downloader.http.with.fieldvalue boolean false - - include HTTP header field values in captured network traces for download requests (beware: may contain secrets, such as datastore credentials).
network.switch.enable.arpsnoop boolean true - - enable ARP Snooping on switch Network Instances
wwan.query.visible.providers bool false - - enable to periodically (once per hour) query the set of visible cellular service providers and publish them under WirelessStatus (for every modem)
network.local.legacy.mac.address bool false - - enables legacy MAC address generation for local network instances for those EVE nodes where changing MAC addresses in applications will lead to incorrect network configuration
goroutine.leak.detection.threshold integer 5000 1 4294967295 (max uint32) Amount of goroutines, reaching which will trigger leak detection regardless of growth rate.
goroutine.leak.detection.check.interval.minutes integer (minutes) 1 1 4294967295 (max uint32) Interval in minutes between the measurements of the goroutine count.
goroutine.leak.detection.check.window.minutes integer (minutes) 10 10 4294967295 (max uint32) Interval in minutes for which the leak analysis is performed. It should contain at least 10 measurements, so no less than 10 × goroutine.leak.detection.check.interval.minutes.
goroutine.leak.detection.keep.stats.hours integer (hours) 24 1 4294967295 (max uint32) Amount of hours to keep the stats for leak detection. We keep more stats than the check window to be able to react to settings with a bigger check window via configuration.
goroutine.leak.detection.cooldown.minutes integer (minutes) 5 1 4294967295 (max uint32) Cooldown period in minutes after the leak detection is triggered. During this period, no stack traces are collected; only warning messages are logged.
kubernetes.drain.timeout integer 24 1 4294967295 (max uint32) hours to allow kubernetes to drain a node
memory-monitor.enabled boolean false - - Enable external memory monitoring and memory pressure events handling
internal-memory-monitor.store.enabled boolean true - - Enable Internal Memory Monitor (IMM) data collection and CSV storage. When enabled, the watcher service collects memory metrics (Go heap and RSS) at regular intervals and stores them in /persist/memory-monitor/output/memory_usage.csv for analysis and debugging of potential memory leaks
internal-memory-monitor.analyze.enabled boolean true - - Enable Internal Memory Monitor (IMM) leak detection analysis. When enabled, IMM analyzes collected memory metrics using statistical methods (Theil-Sen slope, Pearson/Spearman correlation) to detect memory growth patterns and compute leak scores. Requires internal-memory-monitor.store.enabled to be true
debug.tui.loglevel string info - - Set log level for EVE Text UI (TUI) monitor. Possible values are "OFF", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" and are case insensitive
log.dedup.window.size integer 0 0 4294967295 (max uint32) The size of the log deduplicator's sliding window (in number of messages). See logging docs for details. If the window size is set to 0 (default), no deduplication is performed.
log.count.filenames string "" - - Comma-separated list of log's filenames to be counted and logged once instead of logging them every time. Example /my-pkg/main.go:123,/other-pkg/code.go:42. Empty string "" doesn't filter anything out, however a single comma "," will filter out all entries that don't have a filename field set (e.g. logs not coming from components written in Golang). See logging docs for details.
log.filter.filenames string "" - - Comma-separated list of log's filenames to be filtered out. Example /my-pkg/main.go:123,/other-pkg/code.go:42. Empty string "" doesn't filter anything out, however a single comma "," will filter out all entries that don't have a filename field set (e.g. logs not coming from components written in Golang). See logging docs for details.
vector.enabled boolean true - - Enable Vector service for advanced log filtering and transformations.
vector.config string "" - - Full base64-encoded configuration file for Vector in YAML format. See the default config for examples. Please only change the transforms and don't touch the sources and sinks.
msrv.prometheus.metrics.rps integer 1 1 4294967295 (max uint32) The maximum number of requests per second (RPS) for the Prometheus metrics endpoint.
msrv.prometheus.metrics.burst integer 10 1 4294967295 (max uint32) The maximum burst size for the Prometheus metrics endpoint.
msrv.prometheus.metrics.idletimeout.seconds integer 240 (4 minutes) 1 4294967295 (max uint32) The idle timeout in seconds for the Prometheus metrics endpoint. If the connection is idle for this duration, the limit is reset.
edgeview.authen.publickey string "" - - Specifies SSH public keys for Edgeview client command authentication. The user must provide the path to the SSH private key in the client script, and the device verifies the command using one of the configured public keys. Separate multiple public keys with newline characters.
wwan.modem.recovery.watchdog boolean false - - Enable watchdog for cellular modems. If a modem firmware crashes and fails to recover, the device will automatically reboot.
wwan.modem.recovery.reload.drivers boolean false - - If a modem firmware crashes and fails to recover, EVE will attempt to reload the MBIM/QMI/MHI drivers as a recovery step. This occurs before the watchdog mechanism is triggered (if enabled).
wwan.modem.recovery.restart.modemmanager boolean false - - If a modem firmware crash occurs and ModemManager fails to properly recognize or manage the restarted modem, EVE will attempt to restart ModemManager as a recovery step. This occurs before the watchdog mechanism is triggered (if enabled) and can be combined with driver reload recovery mechanism.
diag.probe.remote.http.endpoint string "http://www.google.com" - - Remote endpoint (URL, IP instead of hostname is accepted) queried over HTTP to assess the state of network connectivity whenever the controller is not reachable. Used only for diagnostics (no functional impact). Set to an empty string to disable.
diag.probe.remote.https.endpoint string "https://www.google.com" - - Remote endpoint (URL, IP instead of hostname is NOT accepted) queried over HTTPS to assess the state of network connectivity whenever the controller is not reachable. Used only for diagnostics (no functional impact). Set to an empty string to disable.
app.enable.tcp.mss.clamping bool true - - Configuration property that enables EVE to automatically adjust (clamp) the TCP MSS on forwarded application traffic to match the path MTU, preventing fragmentation and connectivity issues on lower-MTU links.

Log levels

Log level can be set for four different components of EVE: EVE microservices, syslog, kernel, and TUI monitor application. Logs for TUI monitor are not sent to the controller and only available locally on the device. 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 /persist/newlog/keepSentQueue/ directory and will be subject to rotation based on the max total size of stored logs.

Due to implementation specifics, there are two different sets of log levels that can be set: logrus and syslog levels. Logrus levels are used by the EVE microservices, while syslog levels are used by syslog and kernel.

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

Furthermore, 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.

Name Type Default Description
debug.default.loglevel string debug default level of logs produced by EVE microservices. Can be overwritten by agent.agentname.debug.loglevel. Uses logrus log levels as described here ["https://pkg.go.dev/github.com/sirupsen/logrus"]: panic, fatal, error, warning, info, debug and trace.
debug.default.remote.loglevel string warning default level of logs sent by EVE microservices to the controller. Can be overwritten by agent.agentname.debug.remote.loglevel. Uses logrus log levels as described here ["https://pkg.go.dev/github.com/sirupsen/logrus"]: panic, fatal, error, warning, info, debug and trace.
debug.syslog.loglevel string info level of the produced syslog messages. System default loglevel string representation should be used as described here ["https://man7.org/linux/man-pages/man3/syslog.3.html"]: emerg, alert, crit, err, warning, notice, info, debug.
debug.syslog.remote.loglevel string info level of the syslog messages sent to the controller. System default loglevel string representation should be used as described here ["https://man7.org/linux/man-pages/man3/syslog.3.html"]: emerg, alert, crit, err, warning, notice, info, debug.
debug.kernel.loglevel string info level of the produced kernel log messages. System default loglevel string representation should be used as described here ["https://man7.org/linux/man-pages/man3/syslog.3.html"]: emerg, alert, crit, err, warning, notice, info, debug.
debug.kernel.remote.loglevel string info level of the kernel log messages sent to the controller. System default loglevel string representation should be used as described here ["https://man7.org/linux/man-pages/man3/syslog.3.html"]: emerg, alert, crit, err, warning, notice, info, debug.
debug.tui.loglevel string info Set log level for EVE Text UI (TUI) monitor. Possible values are "OFF", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" and are case insensitive

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":

Name Type Default Description
agent.agentname.debug.loglevel string if set overrides debug.default.loglevel for this particular agent (Legacy setting debug.agentname.loglevel still supported)
agent.agentname.debug.remote.loglevel string if set overrides debug.default.remote.loglevel for this particular agent (Legacy setting debug.agentname.remote.loglevel)

Right now the following agents support per-agent log level settings:

  • 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