RECAP.CONF(5)

🌸 RECAP.CONF 🌸

okay bestie, welcome to the recap.conf page — that's the recap configuration file, and it lives in the File Formats Manual section of the man pages. grab a snack, we're going in 💖

✨ NAME ✨

recap.conf — the recap configuration file, aka the glow-up settings sheet for recap 👑

💅 DESCRIPTION 💅

so like, the /etc/recap.conf file holds all the configuration info for recap. it's where you stash the default values that decide which reports get generated and how many reports are generated. it's giving "control room" energy fr fr.

and where do the output files from the script actually go? they get written to BASEDIR. that's the spot. periodt.

🎀 OPTIONS 🎀

• BASEDIR — the directory where recap logs get written. if it's defined, it's used by recaplog and recaptool. (default: /var/log/recap) 📁
• MAILTO — set this variable if you want your reports to be sent over email. like, sliding into your inbox 💌
• MIN_FREE_SPACE — the minimum free disk space (in MB) that's required in ${BASEDIR} for recap to even run. (Disabled by default) (default: 0) 🚨

🌈 REPORTS 🌈

• USEFDISK — can be set to yes or no to enable or not "fdisk ${OPTS_FDISK}". this output is written in ${BASEDIR}/fdisk.log (default: no)
• USEPS — can be set to yes or no to enable or disable the ps.log. (default: yes)
• USERESOURCES — can be set to yes or no to enable or disable the resources.log. (default: yes)
• USEDF — can be set to yes or no depending on whether or not "df ${OPTS_DF}" output should be stored in the report output. ⚠️ this requires that USERESOURCES be set to yes. (default: yes)
• USESLAB — can be set to yes or no depending on whether or not the slab counters should be stored in the report output. ⚠️ this requires that USERESOURCES be set to yes. (default: no)
• USESAR — can be set to yes or no depending on whether or not "sar" output should be stored in the report output. ⚠️ this requires that USERESOURCES be set to yes. (default: yes)
• USESARQ — can be set to yes or no depending on whether or not "sar -q" (Queue length, load) output should be stored in the report output. ⚠️ this requires that USERESOURCES be set to yes. (default: no)
• USESARR — can be set to yes or no depending on whether or not "sar -r" (memory data) output should be stored in the report output. ⚠️ this requires that USERESOURCES be set to yes. (default: no)
• USEFULLSTATUS — can be set to yes or no depending on whether or not a http request (GET) to OPTS_STATUSURL is required. it requires that the webserver url (OPTS_STATUSURL) is configured to respond to this request. Nginx (nginx_status) and Apache HTTPD (server-status) both offer a functionality to provide the status of the webserver via URL. ⚠️ this requires that USERESOURCES be set to yes. (default: no)
• USEPSTREE — can be set to yes or no depending on whether or not the output of the "pstree" command should be recorded. makes use of OPTS_PSTREE to modify its options. 🌳 please note that this output is written to a separate file in ${BASEDIR}/pstree.log (default: no)
• USENETSTAT — can be set to yes or no depending on whether or not the output of "ss ${OPTS_NETSTAT}" command should be recorded. please note that this output is written to a separate file in ${BASEDIR}/netstat.log — and it's required by USENETSTATSUM. (default: yes)
• USENETSTATSUM — can be set to yes or no depending on whether or not the output of "nstat ${OPTS_NETSTAT_SUM}" command should be recorded. ⚠️ this report requires that USENETSTAT be set to "yes". this output is written in ${BASEDIR}/netstat.log (default: no)
• USEMYSQL — can be set to yes or no depending on whether or not the output of "mysqladmin status" command should be recorded. 🚨 before enabling this option, please make sure that DOTMYDOTCNF points to the file that has appropriate credentials for accessing MySQL. please note that this output is written to a separate file in ${BASEDIR}/mysql.log (default: no)
• USEMYSQLPROCESSLIST — can be set to yes or no depending on whether or not the output of "mysqladmin processlist" command should be recorded. ⚠️ this report requires that USEMYSQL be set to "yes". this option makes use of MYSQL_PROCESS_LIST, to produce the output vertical or in a table. this output is written in ${BASEDIR}/mysql.log (default: no)
• USEINNODB — can be set to yes or no depending on whether or not the output of "mysql show engine innodb status" and other variables (pid_files, tmpdir) command should be recorded. ⚠️ this report requires that USEMYSQL be set to "yes". this output is written in ${BASEDIR}/mysql.log (default: no)

🦋 COMMAND OPTIONS 🦋

options used by the tools generating the reports, iykyk 🔧

• DOTMYDOTCNF — option required by USEMYSQL, USEMYSQLPROCESSLIST, USEINNODB. it defines the path to the mysql client configuration file. (default: "/root/.my.cnf")
• MYSQL_PROCESS_LIST — the format to display the MySQL process list. options are "table" or "vertical". ⚠️ this requires that USEMYSQLPROCESSLIST be set "yes". (default: table).
• OPTS_LINKS — options used by links, when using USEFULLSTATUS (default: '-dump')
• OPTS_DF — df options (default: '-x nfs')
• OPTS_FDISK — option used by USEFDISK. (default: "-l")
• OPTS_FREE — free options (default: "")
• OPTS_IOSTAT — iostat options (default: "-t -x 1 3")
• OPTS_IOTOP — iotop options (default: "-b -o -t -n 3")
• OPTS_NETSTAT — ss options (default: "-atunp")
• OPTS_NETSTAT_SUM — nstat statistics options (default: "-a")
• OPTS_PS — ps options (default: "auxfww")
• OPTS_PSTREE — pstree options (default: "-p")
• OPTS_STATUSURL — the URL to perform the http request on when USEFULLSTATUS is enabled. (default: "http://localhost:80/server-status")
• OPTS_VMSTAT — vmstat options (default: "-S M 1 3")

🙈 REPORTING BUGS 🙈

found a bug? an issue? a little glitch that's giving chaos? bestie, submit it via github: <https://github.com/rackerlabs/recap/issues>. they'll take care of you, no cap 🫶

👑 AUTHOR 👑

the recap scripts are maintained by Rackspace, and the full list of contributors is available at <https://github.com/rackerlabs/recap/blob/master/CHANGELOG.md#contributors>. iconic behaviour honestly 💜

🌟 SEE ALSO 🌟

recap(8), recaplog(8), crontab(5) systemd.timer(5)

and that's the whole page, bestie!! this one's from the File Formats Manual, dated July 7, 2017 — yeah she's an elder but she ATE and she's still serving. go configure something slay 💖✨🎀