1RECAP.CONF(5) File Formats Manual RECAP.CONF(5)
2
6 recap.conf - recap configuration file
7
9 The /etc/recap.conf file contains configuration information for recap.
10 It stores the default values that determine which reports get generated
11 and how many reports are generated.
12 The output files from the script are written to BASEDIR.
14
16 BASEDIR
17 Directory where recap logs will be written, if defined is used
18 by recaplog and recaptool. (default: /var/log/recap)
19 MAILTO
22 Define this variable if you would like the reports to be sent
23 via email
24 MIN_FREE_SPACE
27 The minimum free disk space (in MB) required in ${BASEDIR} to
28 run recap. (Disabled by default) (default: 0)
29 REPORTS
32 USEFDISK
34 Can be set to yes or no to enable or not "fdisk
35 ${OPTS_FDISK}. This output is written in
36 ${BASEDIR}/fdisk.log (default: no)
37 USEPS
40 Can be set to yes or no to enable or disable the ps.log.
41 (default: yes)
42 USERESOURCES
45 Can be set to yes or no to enable or disable the
46 resources.log. (default: yes)
47 USEDF
50 Can be set to yes or no depending on whether or not "df
51 ${OPTS_DF}" output should be stored in the report output.
52 This requires that USERESOURCES be set to yes. (default:
53 yes)
54 USESLAB
57 Can be set to yes or no depending on whether or not the slab
58 counters should be stored in the report output. This
59 requires that USERESOURCES be set to yes. (default: no)
60 USESAR
63 Can be set to yes or no depending on whether or not "sar"
64 output should be stored in the report output. This requires
65 that USERESOURCES be set to yes. (default: yes)
66 USESARQ
69 Can be set to yes or no depending on whether or not "sar
70 -q"(Queue length, load) output should be stored in the
71 report output. This requires that USERESOURCES be set to
72 yes. (default: no)
73 USESARR
76 Can be set to yes or no depending on whether or not "sar
77 -r"(memory data) output should be stored in the report out‐
78 put. This requires that USERESOURCES be set to yes.
79 (default: no)
80 USEFULLSTATUS
83 Can be set to yes or no depending on whether or not a http
84 request(GET) to OPTS_STATUSURL is required, it requires that
85 the webserver url(OPTS_STATUSURL) is configured to respond
86 to this request. Nginx(nginx_status) and Apache
87 HTTPD(server-status) offer a functionality to provide the
88 status of the webserver via URL. This requires that USERE‐
89 SOURCES be set to yes. (default: no)
90 USEPSTREE
93 Can be set to yes or no depending on whether or not the out‐
94 put of the "pstree" command should be recorded. Makes use of
95 OPTS_PSTREE to modify its options. Please note that this
96 output is written to a separate file in
97 ${BASEDIR}/pstree.log (default: no)
98 USENETSTAT
101 Can be set to yes or no depending on whether or not the out‐
102 put of "ss ${OPTS_NETSTAT}" command should be recorded.
103 Please note that this output is written to a separate file
104 in ${BASEDIR}/netstat.log is required by USENETSTATSUM.
105 (default: yes)
106 USENETSTATSUM
109 Can be set to yes or no depending on whether or not the out‐
110 put of "nstat ${OPTS_NETSTAT_SUM}" command should be
111 recorded. This report requires that USENETSTAT be set to
112 "yes". This output is written in ${BASEDIR}/netstat.log
113 (default: no)
114 USEMYSQL
117 Can be set to yes or no depending on whether or not the out‐
118 put of "mysqladmin status" command should be recorded.
119 Before enabling this option, please make sure that DOTMY‐
120 DOTCNF points to the file that has appropriate credentials
121 for accessing MySQL. Please note that this output is written
122 to a separate file in ${BASEDIR}/mysql.log (default: no)
123 USEMYSQLPROCESSLIST
126 Can be set to yes or no depending on whether or not the out‐
127 put of "mysqladmin processlist" command should be recorded.
128 This report requires that USEMYSQL be set to "yes". This
129 option makes use of MYSQL_PROCESS_LIST, to produce the out‐
130 put vertical or in a table. This output is written in
131 ${BASEDIR}/mysql.log (default: no)
132 USEINNODB
135 Can be set to yes or no depending on whether or not the out‐
136 put of "mysql show engine innodb status" and other vari‐
137 ables(pid_files, tmpdir) command should be recorded. This
138 report requires that USEMYSQL be set to "yes". This output
139 is written in ${BASEDIR}/mysql.log (default: no)
140 COMMAND OPTIONS
143 Options used by the tools generating the reports
144 DOTMYDOTCNF
147 Option required by USEMYSQL, USEMYSQLPROCESSLIST,
148 USEINNODB, defines the path to the mysql client configu‐
149 ration file. (default: "/root/.my.cnf")
150 MYSQL_PROCESS_LIST
153 Format to display MySQL process list, options are "ta‐
154 ble" or "vertical". This requires that USEMYSQLPRO‐
155 CESSLIST be set "yes". (default: table).
156 OPTS_LINKS
159 Options used by links, when using USEFULLSTATUS
160 (default: '-dump')
161 OPTS_DF
164 df options (default: '-x nfs')
165 OPTS_FDISK
168 Option used by USEFDISK. (default: "-l")
169 OPTS_FREE
172 free options (default: "")
173 OPTS_IOSTAT
176 iostat options (default: "-t -x 1 3" )
177 OPTS_IOTOP
180 iotop options (default: "-b -o -t -n 3")
181 OPTS_NETSTAT
184 ss options (default: "-atunp")
185 OPTS_NETSTAT_SUM
188 nstat statistics options (default: "-a")
189 OPTS_PS
192 ps options (default: "auxfww")
193 OPTS_PSTREE
196 pstree options (default: "-p")
197 OPTS_STATUSURL
200 URL to perform the http request when USEFULLSTATUS is
201 enabled. (default: "http://localhost:80/server-status")
202 OPTS_VMSTAT
205 vmstat options (default: "-S M 1 3")
206
209 Bugs and issues to be submitted via github <https://github.com/racker‐
210 labs/recap/issues>.
211
214 The recap scripts are maintained by Rackspace, the list of contributors
215 is available at https://github.com/rackerlabs/recap/blob/mas‐
216 ter/CHANGELOG.md#contributors.
217
219 recap(8), recaplog(8), crontab(5) systemd.timer(5)
220 July 7, 2017 RECAP.CONF(5)