Satellite 6: What is foreman-debug and how do I run it?

Environment

• Red Hat Satellite 6

Issue

• Need to provide foreman-debug in order to troubleshoot Satellite 6 server issues
• Is there an equivalent to Satellite 5 satellite-debug and spacewalk-debug for Satellite 6?
• What is foreman-debug and how do I use it?
• How to gather debug data for Satellite 6?
• What information and data is needed for debugging Satellite 6?
• Cannot find spacewalk-debug or katello-debug on Satellite 6 server

Resolution

Similar to spacewalk-debug for Red Hat Satellite 5, Red Hat Satellite 6 includes a foreman-debug utility (/usr/sbin/foreman-debug) which generates an archive containing Satellite 6 files with debugging information (such as configuration and log files).

[satellite.example ~]# foreman-debug

It can either be run manually from the command line, or included automatically in sosreport:
Currently, it is automatically called by sosreport for Satellite 6 on RHEL 6 and RHEL 7 (as of RHBA-2015:0532-2).

Please note there are situations when the foreman-debug included in a sosreport may not provide the same information that a foreman-debug would. Engineers may need to request the foreman-debug in addition to the sosreport to obtain additional information about the Satellite server to resolve the problem.

sosreport includes a foreman plug-in that calls foreman-debug -g automatically if it detects the "foreman" package on the system (which is always true for Satellite 6 and SAM servers) and saves foreman-debug under sos_commands/foreman/ with the other plug-ins. The extra option -g that sosreport uses causes some generic information (collected by sosreport itself) is skipped during foreman-debug execution.

Be aware that foreman-debug This content is not included.truncates logs in Satellite 6.[0-2] releases, regardless if it is called directly or via sosreport. In case you know some important information can be present at a beginning of some specific log file, we recommend attaching the log file together with foreman-debug / sosreport.

Note:
For Capsule servers, see this solution "Satellite 6 Capsule Server: which files to gather for debugging / troubleshooting Capsule server?"

For Satellite 5, see this solution This content is not included."Satellite 5: What is spacewalk-debug and how do I run it?"

This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.