mcelog.conf(5)

📦
version 204 · 2 versions
, in opensuse-leap 16.0

💖 NAME 💖

mcelog.conf — literally the mcelog.conf reference, bestie. This is the mcelog.conf(5) page from the File Formats Manual, and it’s giving “config file that runs the whole mcelog situation.” 🎀

🌸 SYNOPSIS 🌸

/etc/mcelog.conf

💅 DESCRIPTION 💅

/etc/mcelog.conf is the main configuration file for mcelog(8). It’s split into sections, including a default section. Yes, we’re doing sections, bestie — stay with me. 💖

🧚 General format 🧚

optionname = value

White space is not allowed in value currently, except at the end where it is dropped. Noted. Periodt. ✨

In general, all command line options that are not commands work here. See man mcelog or mcelog --help for a list. For example, to enable the --no-syslog option use:

no-syslog = yes

…or no to disable it.

When the option has a argument, it looks like this:

logfile = /tmp/logfile

Below are the options which are not command line options.

  • cpu = type — set the CPU type for which mcelog decodes events. For valid values for type, please see mcelog --help. If this value is set incorrectly, the decoded output will be likely incorrect. By default, when this parameter is not set, mcelog uses the CPU it is running on; on very new kernels the mcelog events reported by the kernel also carry the CPU type, which is used too when available and not overridden. 🧠✨
  • daemon = yes — enable daemon mode. By default, mcelog just processes the currently pending events and exits. In daemon mode it keeps running as a daemon in the background, polls the kernel for events, and then decodes them. Main character energy: it stays. 👑
  • filter = yes — filter out known broken events by default. 🫶
  • filter-memory-errors = yes — don’t log memory errors individually. They still get accounted if that is enabled. 💅
  • raw = yes — output in undecoded raw format to be easier machine readable; the default is decoded. 🤖
  • cpumhz = 1800.00 — set CPU MHz to decode uptime from time stamp counter. Output is unreliable, and this is not needed on new kernels which report the event time directly. A lot of systems don’t have a linear time stamp clock, and the output is wrong then. Normally mcelog tries to figure out if it the TSC is reliable and only uses the current frequency then. Setting a frequency forces timestamp decoding. This setting is obsolete with modern kernels which report the time directly. 🕰️😭

📝 Log output options 📝

  • syslog = yes — log decoded machine checks in syslog; the default is stdout or syslog for daemon. 📬
  • syslog-error = yes — log decoded machine checks in syslog with error level. 🚨
  • no-syslog = yes — never log anything to syslog. Nope, not even a little. 🙈
  • logfile = filename — append log output to logfile instead of stdout. Only when no syslog logging is active. 📄
  • dmi = no — use SMBIOS information to decode DIMMs (needs root). This function is not recommended to use right now and generally not needed. The exception is memdb prepopulation, which is configured separately below. 🧬
  • run-credentials-user = root — when in daemon mode, run as this user after set up. Note that the triggers will run as this user too. Setting this to non-root will mean that triggers cannot take some corrective action, like offlining objects. ⚠️
  • run-credentials-group = nobody — group to run as daemon with default to the group of the run-credentials-user. 👯

🖥️ The server config section 🖥️

  • client-user = root — user allowed to access client socket. When set to * match any; root is always allowed to access. default: root only. 🔐
  • client-group = root — group allowed to access mcelog. When no group is configured any group matches (but still user checking). When set to * match any. 🫂
  • socket-path = /var/run/mcelog-client — path to the Unix socket for client<->server communication. When no socket-path is configured the server will not start. 🔌
  • initial-ping-timeout = 2 — when mcelog starts it checks if a server is already running. This configures the timeout for this check. ⏱️
  • listen-backlog = 10 — listen backlog for the Unix socket. default: 10. 📚

🧚 The dimm config section 🧚

  • dimm-tracking-enabled = yes — is the in-memory DIMM error tracking enabled? Only works on systems with integrated memory controller and which are supported. Only takes effect in daemon mode. 🧠
  • dmi-prepopulate = yes — use DMI information from the BIOS to prepopulate DIMM database. Note this might not work with all BIOS and requires mcelog to run as root. Alternative is to let mcelog create DIMM objects on demand. 🏗️

Execute these triggers when the rate of corrected or uncorrected Errors per DIMM exceeds the threshold. Note when the hardware does not report DIMMs this might also be per channel. The default of 10/24h is reasonable for server quality DDR3 DIMMs as of 2009/10.

  • uc-error-trigger = dimm-error-trigger — trigger for uncorrected DIMM error thresholds. 🚨
  • uc-error-threshold = 1 / 24h — uncorrected error threshold. ⏳
  • ce-error-trigger = dimm-error-trigger — trigger for corrected DIMM error thresholds. ✅
  • ce-error-threshold = 10 / 24h — corrected error threshold. 💖

🔌 The socket config section 🔌

  • socket-tracking-enabled = yes — enable memory error accounting per socket. 🧮

Threshold and trigger for uncorrected memory errors on a socket:

  • mem-uc-error-trigger = socket-memory-error-trigger — trigger script for uncorrected memory errors on a socket. 🚨
  • mem-uc-error-threshold = 100 / 24h — threshold for uncorrected memory errors on a socket. ⏳
  • mem-ce-error-trigger = socket-memory-error-trigger — trigger script for corrected memory errors on a socket. ✅
  • mem-ce-error-threshold = 100 / 24h — threshold on when to trigger a correct error for the socket. 📈
  • mem-ce-error-log = yes — log socket error threshold explicitly? 👀
  • bus-uc-threshold-trigger = bus-error-trigger — trigger script for uncorrected bus error events. 🚌
  • iomca-threshold-trigger = iomca-error-trigger — trigger script for uncorrected iomca erors. 🧩
  • unknown-threshold-trigger = unknown-error-trigger — trigger script for other uncategorized errors. ❓

🧊 The cache config section 🧊

Processing of cache error thresholds reported by Intel CPUs.

  • cache-threshold-trigger = cache-error-trigger — trigger for cache error threshold processing from Intel CPUs. 🧠
  • cache-threshold-log = yes — should cache threshold events be logged explicitly? 👀

📄 The page config section 📄

Memory error accounting per 4k memory page. Threshold for the correct memory errors trigger script.

  • memory-ce-threshold = 2 / 24h — threshold for the correct memory errors trigger script. 🧮
  • memory-ce-offline-retry = yes — retry failed offlines with exponential backoff. 🔁
  • memory-ce-trigger = page-error-trigger — trigger script for corrected errors. ✅
  • memory-ce-counter-replacement-threshold = 20 / 24h — memory error counter per 4k memory page. Threshold for the counter replacements trigger script. 🔢
  • memory-ce-counter-replacement-trigger = page-error-counter-replacement-trigger — trigger script for counter replacements. 🛠️
  • memory-ce-log = yes — should page threshold events be logged explicitly? 👀

Specify the internal action in mcelog for exceeding a page error threshold. This is done in addition to executing the trigger script if available:

  • off — no action
  • account — only account errors
  • soft — try to soft-offline page without killing any processes. This requires an uptodate kernel. Might not be successfull. 😬
  • hard — try to hard-offline page by killing processes. Requires an uptodate kernel. Might not be successfull. 💀
  • soft-then-hard — first try to soft offline, then try hard offlining. 🎢
memory-ce-action = off|account|soft|hard|soft-then-hard
memory-ce-action = soft
  • memory-pre-sync-soft-ce-trigger = page-error-pre-sync-soft-trigger — trigger script before doing soft memory offline. This trigger will scan and run all the scipts in the page-error-pre-soft-trigger.extern. 🧚
  • memory-post-sync-soft-ce-trigger = page-error-post-sync-soft-trigger — trigger script after completing soft memory offline. This trigger will scan and run all the scipts in the page-error-post-soft-trigger.extern. 🧚

⚙️ The trigger config section ⚙️

  • children-max = 2 — maximum number of running triggers. 👯
  • directory = /etc/mcelog — execute triggers in this directory. 📁

🌈 SEE ALSO 🌈

🫶 source/version: mcelog · page: mcelog.conf(5) · date: the original footer didn’t list one, so I’m not inventing one, bestie. Periodt. 💖
📦 where this page comes from