diff --git a/modules/sysadmin_guide/pages/debuginfod.adoc b/modules/sysadmin_guide/pages/debuginfod.adoc index 0c527df..b20f344 100644 --- a/modules/sysadmin_guide/pages/debuginfod.adoc +++ b/modules/sysadmin_guide/pages/debuginfod.adoc @@ -42,16 +42,15 @@ The daemon uses systemd and `/etc/sysconfig/debuginfod` to set basic parameters. These have been tuned from the distro defaults via experimental hand-editing or ansible. Key parameters are: -[arabic] -. The -I/-X include/exclude regexes. These tell debuginfod what fedora +* The -I/-X include/exclude regexes. These tell debuginfod what fedora versions to include RPMs for. If index disk space starts to run low, one can eliminate some older fedoras from the index to free up space (after the next groom cycle). -. The --fdcache related parameters. These tell debuginfod how much data +* The --fdcache related parameters. These tell debuginfod how much data to cache from RPMs. (Some debuginfo files - kernel, llvm, gtkweb, ...) are huge and worth retaining instead of repeated extracting.) This is straight disk space vs. time tradeoff. -. The -t (scan interval) parameter. Scanning lets an index get bigger, +* The -t (scan interval) parameter. Scanning lets an index get bigger, as new RPMs in koji are examined and their contents indexed. Each pass takes a bunch of hours to traverse the entire koji NFS directory structure to fstat() everything for newness or change. A smaller scan @@ -59,7 +58,7 @@ interval lets debuginfod react quicker to koji builds coming into existence, but increases load on the NFS server. More -n (scan threads) may help the indexing process go faster, if the networking fabric & NFS server are underloaded. -. The -g (groom interval) parameter. Grooming lets an index get smaller, +* The -g (groom interval) parameter. Grooming lets an index get smaller, as files removed from koji will be forgotten about. It can be run very intermittently - weekly or less - since it takes many hours and cannot run concurrently with scanning. @@ -89,13 +88,12 @@ The debuginfod daemons answer the standard /metrics URL endpoint to serve a variety of operational metrics in prometheus. Important metrics include: -[arabic] -. filesys_free_ratio - free space on the filesystems. (These are also +* filesys_free_ratio - free space on the filesystems. (These are also monitored via fedora-infra nagios.) If the free space on the database or tmp partition falls low, further indexing or even service may be impacted. Add more disk space if possible, or start eliding older fedora versions from the database via the -I/-X daemon options. -. thread_busy - number of busy threads. During indexing, 1-6 threads may +* thread_busy - number of busy threads. During indexing, 1-6 threads may be busy for minutes or even days, intermittently. User requests show up as "buildid" (real request) or "buildid-after-you" (deferred duplicate request) labels. If there are more than a handful of "buildid" ones, @@ -103,7 +101,7 @@ there may be an overload/abuse underway, in which case it's time to identify the excessive traffic via the logs and get a temporary iptables block going. Or perhaps there is an outage or slowdown of the koji NFS storage system, in which case there's not much to do. -. error_count. These should be zero or near zero all the time. +* error_count. These should be zero or near zero all the time. === Logs