.\" .\" This is free documentation; you can redistribute it and/or .\" modify it under the terms of the GNU General Public License as .\" published by the Free Software Foundation; either version 2 of .\" the License, or (at your option) any later version. .\" .\" The GNU General Public License's references to "object code" .\" and "executables" are to be interpreted as the output of any .\" document formatting or typesetting system, including .\" intermediate and printed output. .\" .\" This manual is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public .\" License along with this manual; if not, write to the Free .\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor, .\" Boston, MA 02110-1301 USA. .\" .TH RECAP.CONF 5 "July 7, 2017" .SH NAME recap.conf \- recap configuration file .SH DESCRIPTION The .IR /etc/recap.conf file contains configuration information for recap. It stores the default values that determine which reports get generated and how many reports are generated. The output files from the script are written to .IR BASEDIR "." .SH OPTIONS .LP .IP \fBBASEDIR\fR .br Directory where recap logs will be written, if defined is used by recaplog and recaptool. (default: /var/log/recap) .IP \fBMAILTO\fR .br Define this variable if you would like the reports to be sent via email .IP \fBMIN_FREE_SPACE\fR .br The minimum free disk space (in MB) required in ${BASEDIR} to run recap. (Disabled by default) (default: 0) .PP REPORTS .RS 4 .IP \fBUSEFDISK\fR .br Can be set to yes or no to enable or not "fdisk ${OPTS_FDISK}. This output is written in .IR ${BASEDIR}/fdisk.log (default: no) .IP \fBUSEPS\fR .br Can be set to yes or no to enable or disable the ps.log. (default: yes) .IP \fBUSERESOURCES\fR .br Can be set to yes or no to enable or disable the resources.log. (default: yes) .IP \fBUSEDF\fR .br 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) .IP \fBUSESLAB\fR .br 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) .IP \fBUSESAR\fR .br 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) .IP \fBUSESARQ\fR .br 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) .IP \fBUSESARR\fR .br 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) .IP \fBUSEFULLSTATUS\fR .br 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) offer a functionality to provide the status of the webserver via URL. This requires that USERESOURCES be set to yes. (default: no) .IP \fBUSEPSTREE\fR .br 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 .IR ${BASEDIR}/pstree.log (default: no) .IP \fBUSENETSTAT\fR .br 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 .IR ${BASEDIR}/netstat.log is required by USENETSTATSUM. (default: yes) .IP \fBUSENETSTATSUM\fR .br 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 .IR ${BASEDIR}/netstat.log (default: no) .IP \fBUSEMYSQL\fR .br 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 .IR ${BASEDIR}/mysql.log (default: no) .IP \fBUSEMYSQLPROCESSLIST\fR .br 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 .IR ${BASEDIR}/mysql.log (default: no) .IP \fBUSEINNODB\fR .br 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 .IR ${BASEDIR}/mysql.log (default: no) .PP COMMAND OPTIONS .RS 4 Options used by the tools generating the reports .IP \fBDOTMYDOTCNF\fR .br Option required by USEMYSQL, USEMYSQLPROCESSLIST, USEINNODB, defines the path to the mysql client configuration file. (default: "/root/.my.cnf") .IP \fBMYSQL_PROCESS_LIST\fR .br Format to display MySQL process list, options are "table" or "vertical". This requires that USEMYSQLPROCESSLIST be set "yes". (default: table). .IP \fBOPTS_LINKS\fR .br Options used by links, when using USEFULLSTATUS (default: '\-dump') .IP \fBOPTS_DF\fR .br df options (default: '\-x nfs') .IP \fBOPTS_FDISK\fR .br Option used by USEFDISK. (default: "\-l") .IP \fBOPTS_FREE\fR .br free options (default: "") .IP \fBOPTS_IOSTAT\fR .br iostat options (default: "\-t \-x 1 3" ) .IP \fBOPTS_IOTOP\fR .br iotop options (default: "\-b \-o \-t \-n 3") .IP \fBOPTS_NETSTAT\fR .br ss options (default: "\-atunp") .IP \fBOPTS_NETSTAT_SUM\fR .br nstat statistics options (default: "\-a") .IP \fBOPTS_PS\fR .br ps options (default: "auxfww") .IP \fBOPTS_PSTREE\fR .br pstree options (default: "\-p") .IP \fBOPTS_STATUSURL\fR .br URL to perform the http request when USEFULLSTATUS is enabled. (default: "http://localhost:80/server\-status") .IP \fBOPTS_VMSTAT\fR .br vmstat options (default: "\-S M 1 3") .SH "REPORTING BUGS" Bugs and issues to be submitted via github . .SH AUTHOR The recap scripts are maintained by Rackspace, the list of contributors is available at https://github.com/rackerlabs/recap/blob/master/CHANGELOG.md#contributors. .SH "SEE ALSO" .BR recap (8), .BR recaplog (8), .BR crontab (5) .BR systemd.timer (5)