3
ܓi@ @ s` d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlmZ d dlZd dl m
Z
d dl m Z d dl
mZ d dlZd dlmZmZmZmZmZmZmZmZ d dlmZ d dlm Z d d l m Z d dl Zd d
l m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z* d d l+m,Z, d d l-m.Z. ej/ej0fZ1d ddZ2dd Z3dddgZ4ddddddhZ5G d d d e Z6dS ) N)datetime)ThreadPoolExecutor) TimeoutError)rmtree)ImporterHelperSoSTimeoutErrorboldsos_get_command_outputTIMEOUT_DEFAULTlistdir
is_executablescrub_url_credential)_sos) __version__) SoSComponent)
ReportSectionCommand
CopiedFile CreatedFileAlertNotePlainTextReport
JSONReport
HTMLReport)
SoSCleaner) SoSUploadF, c C s g }| }|rt | d }nd}xB|D ]:}t |t | t | dkrR|j| |}|| | }q$W |t | d |kr|d t | }|j| |S )N H )lenappend)Z
first_lineitemsindentseplineslinenewlineitem r* /usr/lib/python3.6/__init__.py _format_list. s
r, c C s t j| ddS )z This function will format --since arg to append 0s if enduser
didn't. It's used in the _get_parser.
This will also be a good place to add human readable and relative
date parsing (like '2 days ago') in the future z<014sz %Y%m%d%H%M%S)r Zstrptime)Zdater* r* r+
_format_since@ s r- autoalwaysZneverZ
http_proxyZ https_proxyZ
HTTP_PROXYZ HTTPS_PROXYZNO_PROXYZ ALL_PROXYc @ s e Zd ZdZdZdZdddddddddg g g dddg dg dg ddddd dd
g g g ddddddg deeg dddg dddddddddddddddddd d ?Z fd
dZe dd Z
e dd Z dd Z dd Z
dd Zdd Zdd Zd d Zd d Zd!d" Zd#d$ Zdd%d&Zd'd( Zd)d* Zd+d, Zd-d. Zd/d0 Zd1d2 Zd3d4 Z d5d6 Z e d7d8 Z dd9d:Z d;d< Z!d=d> Z"d?d@ Z#dAdB Z$dCdD Z%dEdF Z&ddHdIZ'dJdK Z(dLdM Z)dNdO Z*dPdQ Z+dRdS Z,dTdU Z-dVdW Z.dXdY Z/dZd[ Z0d\d] Z1d^d_ Z2dd`daZ3dbdc Z4ddde Z5dfdg Z6dhdi Z7djdk Z8dldm Z9dndo Z:dpdq Z;drds Zdxdy Z?dzd{ Z@d|d} ZAd~d ZBdd ZCdd ZDdd ZEdd ZFdd ZGdd ZH ZIS ) SoSReportzaRun a set of commands and file collections and save them to a report for
future analysis
z.Collect files and command output in an archiveTFr r. d N z /etc/sos/cleaner/default_mapping obfuscate)?
alloptionsall_logsbuildcase_idchrootcleancontainer_runtimekeep_binary_filesdescdomainsdisable_parsersskip_cleaning_filesZdry_run
estimate_only experimentalenable_plugins journal_sizekeywords keyword_fileplugoptslabel list_plugins list_presets
list_profileslog_sizeZ low_prioritymap_file
skip_commands
skip_files skip_plugins
namespaces no_report no_env_vars no_postproc no_updatenote only_pluginspresetplugin_timeout cmd_timeoutprofilessinceverifyallow_system_changes usernamesupload
upload_urlZupload_directoryZ upload_userZ upload_passZ
upload_methodZupload_no_ssl_verifyZupload_protocolupload_s3_endpointZupload_s3_regionZupload_s3_bucketZupload_s3_access_keyZupload_s3_secret_keyZupload_s3_object_prefixZ
upload_target
add_preset
del_presettreat_certificatesc s t j||| g | _g | _g | _t| _|| _d| _i | _ | j
| j | j j
| _| jjjd| _| j d}| j j| _| jjrd}n| j j r| jtjkrd}| jjd| j d| d | jjtkr| jj d | jj t j | j j | j!d
| j" | j# | j$ d S ) N/reportdefaultcmdlinepolicyzset sysroot to 'z' ()zinvalid chroot mode: )%super__init__loaded_pluginsskipped_plugins all_optionsdefault_env_varsenv_varsZ_argssysrootestimated_plugsizes print_header
_set_debugri Zis_rootZ_is_rootmanifestZ
components add_section report_md_set_directoriesoptsZ in_containerosr% soslogdebugr8 chroot_modeserrorloggingshutdown
tempfile_utilr9 _exit_check_container_runtime_get_namespaces_get_hardware_devices)selfparserargsrh msg) __class__r* r+ rm s8
zSoSReport.__init__c
C s |j dd}|jddddddd |jd
dd dd d |jd
ddd tdd |jdddddd |jddddd |jddddd d d |jd d d d |jd!d"tdd#d$d% |jd&dd'd( |jd)dd*d( |jd+dd,dd-d |jd.d/d0d1td2g d3 |jd4td5d6d7d8 |jd9d:d;d0dd?dd@dAd |jdBdCddDddEd |jdFddGd( |jdHddIddJd |jdKddLtdMdNdO |jdPdddQdR |jdSd dTd |jdUdVd0dWtdXg d3 |jdYddZdd[d |jd\dd]dd^d |jd_dd`ddadb |jdctdd#ddd% |jdedfd0dgtdhg d3 |jdidtdjd dk |jdld dmd |jdnd dod |jdpdqdrd0dstg dtdO |jdug d0dvdwdx |jdyg d0dzd{dx |jd|dd}dd~d |jdddddd |jdddddR |jdd dd |jdd dd |jdd dd |jdd dd |jdd d ddgdd |jddddd |jdd dd |jdd dd |jdd dd |jdd dd |jdd dd |jdd dd |jdd d ddddgdd |j }|jdtddd |jdtddd |j dd}|jdddddddd |jddg d0dd |jdd0g ddd |jddd0g ddd |jdd0g ddd |jdd dddč |jdddddd |jddddd̍ |jddddddx |jddg d0dd |jdddddgdddٍ d S )NzReport Optionsz.These options control how report collects dataz-az --alloptions
store_truer4 Fz%enable all options for loaded plugins)actiondestrg helpz
--all-logsr5 z-collect all available logs regardless of sizez--sinceZstorer[ zbEscapes archived files older than date. This will also affect --all-logs. Format: YYYYMMDD[HHMMSS])r r rg typer z--buildr6 z;preserve the temporary directory and do not package resultsz --case-idr7 zspecify case identifier)r r r z-cz--chrootr8 r. zHchroot executed commands to SYSROOT [auto, always, never] (default=auto)z--container-runtimezLDefault container runtime to use for collections. 'auto' for policy control.)rg r z--descz
--descriptionr z Description for a new preset)r r rg r z --dry-runz#Run plugins but do not collect data)r r z--estimate-onlyzzApproximate disk space requirements for a real sos run; disables --clean and --collect, sets --threads=1 and --no-postprocz--experimentalrA zenable experimental pluginsz-ez--enable-pluginsextendrB zenable these plugins)r r r r rg z--journal-sizer1 rC z+limit the size of collected journals in MiB)r rg r r z-kz--plugin-optionz
--plugoptsrF z7plugin options in plugname.option=value format (see -l)z--labelz--namerG z"specify an additional report labelz-lz--list-pluginsrH z)list plugins and available plugin optionsz--list-presetsz#display a list of available presetsz--list-profilesrJ zBdisplay a list of available profiles and plugins that they includez
--log-sizerK r2 z6limit the size of collected logs (not journals) in MiB)r r r rg r z--low-priorityz(generate report with low system priority)r rg r z --namespaceszDlimit number of namespaces to collect output for - 0 means unlimitedz-nz--skip-pluginsrO zdisable these pluginsz --no-reportrQ z disable plaintext/HTML reportingz
--no-env-varsrR z$Do not collect environment variablesz
--no-postprocrS zDisable all post-processing)rg r r r z--notez Behaviour notes for new presetz-oz--only-pluginsrV zenable these plugins onlyz--presetzA preset identifier)r r r rg z--plugin-timeoutz set a timeout for all pluginsz
--cmd-timeoutz%set a command timeout for all pluginsz-pz --profilez
--profilesrZ z)enable plugins used by the given profilesz--skip-commandsrM z do not execute these commands)rg r r r z --skip-filesrN zdo not collect these filesz--verifyr\ z+perform data verification during collectionz--allow-system-changesr] zJRun commands even if they can change the system (e.g. load kernel modules)z--uploadz+Upload archive to a policy-default locationz --upload-urlz&Upload the archive to specified serverz--upload-directoryz$Specify upload directory for archivez
--upload-userz'Username to authenticate to server withz
--upload-passz'Password to authenticate to server withz--upload-methodZputZpostz HTTP method to use for uploading)rg choicesr z--upload-no-ssl-verifyz'Disable SSL verification for upload url)rg r r z--upload-s3-endpointz#Endpoint to upload to for S3 bucketz--upload-s3-regionz!Region to upload to for S3 bucketz--upload-s3-bucketz"Name of the S3 bucket to upload toz--upload-s3-access-keyz Access key for the S3 bucketz--upload-s3-secret-keyz Secret key for the S3 bucketz--upload-s3-object-prefixz Prefix for the S3 object/keyz--upload-protocolZhttpsZftpZsftpZs3z$Manually specify the upload protocolz --add-presetz#Add a new named command line preset)r r r z --del-presetz$Delete the named command line presetzCleaner/Masking Optionsz7These options control how data obfuscation is performedz--cleanz --cleanerz--maskr9 z Obfuscate sensitive information)r rg r r z --domainsr= z$Additional domain names to obfuscatez--disable-parsersr> zCDisable specific parsers, so that those elements are not obfuscated)r rg r r z--skip-cleaning-filesz--skip-masking-filesr? zBList of files to skip/ignore during cleaning. Globs are supported.z
--keywordsrD z List of keywords to obfuscatez--keyword-filerE z&Provide a file a keywords to obfuscate)rg r r z --no-updaterT z%Do not update the default cleaner mapz
--map-filerL z /etc/sos/cleaner/default_mappingz;Provide a previously generated mapping file for obfuscation)r rg r z--keep-binary-filesr; zGKeep unprocessable binary files in the archive instead of removing themz --usernamesr^ z List of usernames to obfuscatez--treat-certificatesr3 keepremoverd zHow to treat the certificate files [.csr .crt .pem]. Defaults to "obfuscate" after convert the file to text. "Key" certificate files are always removed.)rg r r r )Zadd_argument_group add_argumentr- strintZ add_mutually_exclusive_group)clsr Z
report_grpZ
preset_grpZ cleaner_grpr* r* r+ add_parser_options sd
z SoSReport.add_parser_optionsc C s |j d |jd |jd |jd |jdd}|jd |jd |jd d}|jd
td d td
|jdtd d dddd}d}x.|j D ]"\}}|jd|d| dd qW |j| d S )NzSoS Report Detailed HelpzThe report command is the most common use case for SoS, and aims to collect relevant diagnostic and troubleshooting data to assist with issue analysis without actively performing that analysis on the system while it is in use.zAdditionally, sos report archives can be used for ongoing inspection for pre-emptive issue monitoring, such as that done by the Insights project.zThe typical result of an execution of 'sos report' is a tarball that contains troubleshooting command output, copies of config files, and copies of relevant sections of the host filesystem. Root privileges are required for collections.z How Collections Are Determined)titlezSoS report performs its collections by way of 'plugins' that individually specify what files to copy and what commands to run. Plugins typically map to specific components or software packages.aF Plugins may specify different collections on different distributions, and some plugins may only be for specific distributions. Distributions are represented within SoS by 'policies' and may influence how other SoS commands or options function. For example policies can alter where the --upload option defaults to or functions.zSee Alsoz5For information on available options for report, see zsos report --helpz and zman sos-reportzThe following zsos helpz sections may be of interest:
z'Information on the plugin design of sosz!Information on a specific $pluginz+How sos operates on different distributions)zreport.pluginszreport.plugins.$pluginZpoliciesr z<36F)r( )Z set_titleZadd_textrx r r# )r sectionZpsecZssecZ
help_linesZhelplnlnvaluer* r* r+ display_help s.
zSoSReport.display_helpc C s$ | j jdtdt d d d S )N
zsos report (version rj )ui_loginfo_r )r r* r* r+ ru s zSoSReport.print_headerc C s. | j | j d| j | j | j d| _d S )N)blockZfibre)ZstoragenetworkZnamespaced_networkZfstype)_get_block_devs_get_fibre_devs_get_network_devs _get_network_namespace_devices_get_devices_by_fstypedevices)r r* r* r+ r s
z SoSReport._get_hardware_devicesc C s | j jdkr| j jj }|dkr6i | j_| jjd n| jjsXd| d}| jj| nt|| jjj krdj d d
| jjj D }t
d | d | n2| jj| | jjd
< | jjd| jjd
j d dS )a[ Check the loaded container runtimes, and the policy default runtime
(if set), against any requested --container-runtime value. This can be
useful for systems that have multiple runtimes, such as RHCOS, but do
not have a clearly defined 'default' (or one that is determined based
entirely on configuration).
r. noneoffdiabledz0Disabled all container runtimes per user option.zVWARNING: No container runtimes are active, ignoring option to set default runtime to 'z'
z, c s s | ]}|d kr|V qdS )rg Nr* ).0pr* r* r+ s z5SoSReport._check_container_runtime..z Cannot use container runtime 'z1': no such runtime detected. Available runtimes: rg z"Set default container runtime to ''N)r r r ) r{ r: lowerri Zruntimesr} r warningkeysjoin Exceptionname)r Zcrunr Zvalidr* r* r+ r s z"SoSReport._check_container_runtimec C s yLg }ddddg}x6|D ].}t jjd| r|jtjd| d qW |S tk
r~ } z| jjd| g S d}~X nX dS ) zEnumerate a list of fibrechannel devices on this system so that
plugins can iterate over them
These devices are used by add_device_cmd() in the Plugin class.
Zfc_hostZ fc_transportZfc_remote_portsZ fc_vportsz /sys/class/z/*z!Could not get fibre device list: N)r| pathisdirr globr r} r )r ZdevsZdevdirsZdevdirerrr* r* r+ r s
zSoSReport._get_fibre_devsc s ydd t jdD }td}g |d dkrbx2|d j D ]"}|j d jdd } j| q s z-SoSReport._get_block_devs..z
/sys/blockzlosetup --all --noheadingsstatusr output:r c s" g | ]}|j d r| kr|qS )Zloop)
startswith)r dev)real_loop_devicesr* r+ r " s
z!Could not get block device list: N) r| r r
splitlinessplitreplacer" listsetr r} r )r Z device_listZ loop_devicesZloop_devZ loop_deviceZghost_loop_devsZdev_listr r* )r r+ r s zSoSReport._get_block_devsc C s d| j i| _d S )Nr )_get_network_namespacesrP )r r* r* r+ r + s zSoSReport._get_namespacesc C s g g g g d}yPt d| jjdr.|j| j |d s\| jjd |j| j | j |d< W n4 t k
r } z| jj
d| W Y dd}~X nX |S ) a Helper to encapsulate network devices probed by sos. Rather than
probing lists of distinct device types like we do for storage, we can
do some introspection of device enumeration where a single interface
may have multiple device types. E.G an 'ethernet' device could also be
a bond, and that is pertinent information for device iteration.
:returns: A collection of enumerated devices sorted by device type
:rtype: ``dict`` with keys being device types
)ethernetbridgeZteambondZnmcli)rs r zZNetwork devices not enumerated by nmcli. Will attempt to manually compile list of devices.r z%Could not enumerate network devices: N) r r{ rs update_get_nmcli_devsr} r~
_get_eth_devs_get_bridge_devsr r )r _devsr r* r* r+ r 0 s $zSoSReport._get_network_devsc C s. i }x$| j d D ]}d| j|i||< qW |S )zqEnumerate the network devices that exist within each network
namespace that exists on the system
r r )rP r )r Z_nmdevsZnmspr* r* r+ r O s z(SoSReport._get_network_namespace_devicesc C s i }yt d}|d dkrtxX|d j dd D ]@}|j \}}||krT|g||< n|| j| |d j| q0W tt|d |d< W n4 tk
r } z| jjd| W Y dd}~X nX |S ) zUse nmcli, if available, to enumerate network devices. From this
output, manually grok together lists of devices.
z nmcli --fields DEVICE,TYPE devr r r rk Nr z Could not parse nmcli devices: ) r r r r" r r r r} r~ )r r Z_ndevsr ZdnameZdtyper r* r* r+ r Z s $zSoSReport._get_nmcli_devsc s
dg g }|sby fddt ddD }W q tk
r^ } z| jjd| W Y dd}~X qX nyLd| d}t|}|d d
krx&|d j D ]}| kr|j| qW W n: tk
r } z | jjd | d
| W Y dd}~X nX |dd |D dd |D dS )a8 Enumerate a list of ethernet network devices so that plugins can
reliably iterate over the same set of devices without doing piecemeal
discovery.
These devices are used by `add_device_cmd()` when `devices` includes
"ethernet" or "network".
:param namespace: Inspect this existing network namespace, if
provided
:type namespace: ``str``
:returns: All valid ethernet devices found, potentially within a
given namespace
:rtype: ``list``
Zbonding_mastersc s g | ]}| kr|qS r* r* )r r ) filt_devsr* r+ r s z+SoSReport._get_eth_devs..z/sys/class/netNz.Failed to manually determine network devices: zip netns exec z ls /sys/class/netr r r z'Could not determine network namespace 'z ' devices: c S s g | ]}|j d r|qS )r )r )r Zbdr* r* r+ r s c S s g | ]}|j d r|qS )tun)r )r Ztdr* r* r+ r s )r r r )r r r} r r r r" )r namespaceZ _eth_devsr Z_nscmdZ_nsoutZ_nsethr* )r r+ r n s* $ zSoSReport._get_eth_devsc C s g }yt ddd}W n4 tk
rH } z| jjd| W Y dd}~X nX |d dkrxn|d j d d D ]V}y|j|j d W ql tk
r } z | jjd
| d | W Y dd}~X qlX qlW |S ) zEnumerate a list of bridge devices so that plugins can reliably
iterate over the same set of bridges.
These devices are used by `add_device_cmd()` when `devices` includes
"bridge" or "network".
z
brctl show )timeoutz$Unable to enumerate bridge devices: Nr r r rk z"Could not parse device from line 'z': )r r r} r r r" r r )r Z_bridgesZ_boutr Z_bliner* r* r+ r s $ (zSoSReport._get_bridge_devsc C s` g }t d}|d dkr\xB|d j D ]2}|j s&|dd j rDq&|j|jdd q&W |S )zEnumerate a list of network namespaces on this system so that
plugins can iterate over them
Note that stderr is not collected, so no handling of error lines.
zip netnsr r r Nrk r )r r isspacer" partition)r Zout_nsZip_netnsr' r* r* r+ r s z!SoSReport._get_network_namespacesc C s i }t d}|d dkr |S xr|d j D ]b}|j j }t|dkrR|jdd d|d krfd|d< |j|d g ||d j|d q*W |S ) Nzlsblk -snrpo FSTYPE,NAMEr r r rk unknownZextZext4)r r stripr r! insert
setdefaultr" )r Z _dev_fstypesr r' helperr* r* r+ r s z SoSReport._get_devices_by_fstypec C s4 | j | j| j| j| j| j| j| jj| j| j | j
d S )N) cmddirlogdirrptdirtmpdirr} ri rs verbosityZ cmdlineoptsr rP ) r r r r r} ri rs r{ r r rP )r r* r* r+ get_commons s zSoSReport.get_commonsc C s
| j j S )N)r new)r r* r* r+
get_temp_file s zSoSReport.get_temp_filec C s4 | j j| jd | j j| jd | j j| jd d S )Ni )archivemakedirsr r r )r r* r* r+ _make_archive_paths s z SoSReport._make_archive_pathsc C s d| _ d| _d| _d S )NZ sos_commandssos_logs sos_reports)r r r )r r* r* r+ rz s zSoSReport._set_directoriesc C s" | j jr| jt_d| _nd| _d S )NTF)r{ r~
_exceptionsys
excepthook
raise_plugins)r r* r* r+ rv s zSoSReport._set_debugc C sN t tdstjj r&tj| || n$tj| ||dtjd t t j
dS )z* Wrap exception in debugger if not in tty Zps1 )limitfileN) hasattrr stderrisatty__excepthook__ tracebackprint_exceptionstdoutprintpdbZpm)etypeZeval_Zetracer* r* r+ r s
zSoSReport._exceptionc C sV | j s | jr>tj \}}}tj|||tjd t tj | |rR|rR| j
|| d S )N)r ) r Z exit_processr exc_infor r r r r Z post_mortem_log_plugin_exception)r plugnamefuncr valtbr* r* r+ handle_exception s
zSoSReport.handle_exceptionc C sT t | dd r(| jj| jtjjddd t | dd rP| jj| jtjjddd d S )N sos_log_filer zsos.log)r sos_ui_log_filezui.log)getattrr add_filer r| r r r )r r* r* r+
_add_sos_logs s
zSoSReport._add_sos_logsc sR j j} j jsdS t|ds"dS |r: j|j r:dS t fdd|jD S )NTrZ Fc 3 s | ]}| j jkV qd S )N)r{ rZ )r r )r r* r+ r ' s z+SoSReport._is_in_profile..)r{ rV rZ r _is_not_specifiedr any)r plugin_classrV r* )r r+ _is_in_profile s
zSoSReport._is_in_profilec C s || j jkS )N)r{ rO )r plugin_namer* r* r+ _is_skipped) s zSoSReport._is_skippedc C s* || j j o(|| jjko(|| jjkS )N)r Z
check_enabledr{ rB rV )r r pluginClassr* r* r+ _is_inactive, s zSoSReport._is_inactivec C s* || j j o(|| jjko(|| jjkS )N)r Zdefault_enabledr{ rB rV )r r r r* r* r+ _is_not_default1 s zSoSReport._is_not_defaultc C s | j jo|| j jkS )N)r{ rV )r r r* r* r+ r
6 s zSoSReport._is_not_specifiedr c C s" | j j|j || j |f d S )N)ro r" r r )r r reasonr* r* r+ _skip: s
zSoSReport._skipc C s | j j|j || j f d S )N)rn r" r r )r r r* r* r+ _loadA s zSoSReport._loadc C s t jjj}tt jj}|j }g | _t | _t | j
j}| j j }g }| j
j
r\|jt jjj t|| }| j j}t| j
j} x|D ]}
tjj|
\} } yp|| |}
|
sw| j j|
}||| j
j
ds| jjtd|
d | j
jdkr| j|td w| jj| | j |}|s2| j|td w| j | rP| j|td w| j | |rp| j|td w| j | |r| j|td wt |d
r| jj!|j | o|}| j"| r|r| j|td wx$|jD ]}|| kr| j#| qW | j$| W q t%k
rT } z*| jjtd|
d | | j& W Y d d }~X qX qW t | dkr| jj'td
dj(| | j) | j*d d S )N)rA zplugin z does not validate, skippingr zdoes not validateZexcludedZskippedZinactiveZoptionalrZ z
not specifiedz does not install, skipping: z)Unknown or inactive profile(s) provided: z, rk )+sosrf plugins
import_pluginr Z get_modules plugin_namesr rZ r! r{ ri Zvalid_subclassesrA r" ZExperimentalPlugintuplevalidate_pluginr r| r splitextZ match_pluginr} r r r r r
r r r r r r
r r r r r r rJ r )r r r r Zusing_profilesZpolicy_classesZ
extra_classesZvalid_plugin_classesr Zremaining_profilesplugZplugbase__Zplugin_classesr Z
in_profileZdefault_profileier* r* r+ load_pluginsG st
zSoSReport.load_pluginsc C sD | j jr@x6| jD ],\}}x"|jj D ]}t|jkr$d|_q$W qW d S )NT)r{ r4 rn optionsvaluesboolZval_typer )r r r optr* r* r+ _set_all_options s
zSoSReport._set_all_optionsc $ C s$ | j jr i } x| j jD ]}y|jd\}}W n tk
rH d}Y nX t|tr|j }|dkrjd}n0|dkrxd
}n"y t|}W n tk
r Y nX y|jd\}}W n tk
r |}d}Y nX y || W n tk
r i ||< Y nX ||| |< qW x| j D ]\}}||krx|| D ]}||j
kr^| j j d| d| d | j
d y:|j
| j|| | | j jd| d|j
| W n: tk
r } z | j j | | j
d W Y d d }~X nX q*W ||= qW x"|D ]}| j j d| d qW |j r | j j d d S )N=Tonenableenabledtrueyesr disabledisabledfalsenoF.zno such option "z" for plugin (rj rk zSet z plugin option to zCWARNING: unable to set option for disabled or non-existing plugin (z).r )r( r) r* r+ r, )r r- r. r/ r0 )r{ rF r
ValueError
isinstancer r r KeyErrorrn r" r} r r Z set_valuer~ r r )r r{ r% r argr r r r* r* r+
_set_tunables sZ
"
zSoSReport._set_tunablesc C s dd l }xR|j| jj| jjD ]:}|jdd }|| jkr | jjd| d | j d q W x.| jj
D ]"}|| jkrf| jj d| d qfW d S )Nr r1 za non-existing plugin (z$) was specified in the command line.rk z'Requested to skip non-existing plugin 'z'.) itertoolschainr{ rV rB r r r} fatalr rO r )r r7 pluginr r* r* r+ _check_for_unknown_plugins s
z$SoSReport._check_for_unknown_pluginsc C s: x4| j D ]*\}}x |jD ]}| jj|j| qW qW d S )N)rn r" rp r" )r r r: r% r* r* r+ _set_plugin_options s z SoSReport._set_plugin_optionsc C s d}g }| j jdkr2|d| j j dg7 }d| j _| j jsL|dg7 }d| j _| j jsf|dg7 }d| j _| j jr|dg7 }d | j _| j jr|d
g7 }d | j _|r|d d j| 7 }n|d
7 }|d7 }|S )Nz
Estimate-only mode enabledrk z
--threads=z overriden to 1z--build enabledTz--no-postproc enabledz--clean disabledFz--upload* options disabledz", which overrides some options:
z
r1 z
)r{ threadsr6 rS r9 r_ r )r r Zext_msgr* r* r+ _set_estimate_only s,
z SoSReport._set_estimate_onlyc C sd | j jd | jr:| j jdt| j dt| j d n| j jdt| j d | j jd d S )Nr r z profiles, z pluginsz profiles)r r rn r! rZ )r r* r* r+ _report_profiles_and_plugins s
(z&SoSReport._report_profiles_and_pluginsc
C s | j r$| j r$| jjtd d S | j rz| jjtd | jjd xB| j D ]&\}}| jjd|dd|j qNW n| jjtd | jjd | jr| jjtd | jjd x:| jD ]0\}}}| jjd|dd|dd|j qW | jjd | jr| jjtd | j d
d j }x|D ]}|| }|j
}|j
dkr|d krh| j j pdt
}n |d
kr| j jp~t
}nt
}|jdkr| j j }| jjd|jdd|dd|j q0W | jjd | jjtd x| jD ]}|jdkr|j
|jkrqt|j
tr4|j
dkr.d} nd} n|j
} | d krHd
} | jjd|j d|j dd| dd|j qW n| jjtd | jjd t| j}
|
j td|
dd} x | D ]} | jjd| qW | j d S ) Nzno valid plugins foundz,The following plugins are currently enabled:r r z<30zNo plugin enabled.z-The following plugins are currently disabled:z<14z4The following options are available for ALL plugins:r rk r cmd-timeoutpostprocz<25z<15z+The following plugin options are available:Tr( r r1 z<40z No plugin options available.z
Profiles: )r$ )r rA r@ )rn ro r} r9 r r r Zget_descriptionrp Zget_default_plugin_optsr r{ rX r
rY r rS r< rg r3 r$ r: r rZ sortr, r? )
r r r Z plugclassr Z _defaultsZ_optr% r ZtmpoptrZ r& r' r* r* r+ rH sj $ *
,
:
zSoSReport.list_pluginsc C s | j s| jjtd d S | jjtd | jjd dd }t| j }|j xr|D ]j}g }x.| jD ]$\}}||rf||j krf|j | qfW t
|d|dd}x |D ]}| jjd | qW qVW | j d S )
Nzno valid profiles foundz%The following profiles are available:r c S s
t | dS )NrZ )r )cr* r* r+ _has_profa s z*SoSReport.list_profiles.._has_profz<15T)r$ r ) rZ r} r9 r r r r rC rn r" r, r? ) r rE rZ Zprofiler r r: r& r' r* r* r+ rJ Z s"
zSoSReport.list_profilesc C s | j js | jjtd d S | jjtd | jjd x| j jj D ]}|sPqF| j j|}| jjddd|j | jjddd|j
|j r| jjddd|j | j j
d k r|j j }d
dd}t||d dd }x|D ]}| jj| qW | jjd qFW d S )
Nzno valid presets foundz$The following presets are available:r zname:z>14r z description:znote:r zoptions:T)r$ r% )ri Zpresetsr} r9 r r r r find_presetr r< rU r{ r to_argsr, )r rW r Z options_strr& r' r* r* r+ rI p s(
zSoSReport.list_presetsc C s | j }|j|r(| jjd| d dS |p2| jj}|p>| jj}y|j|||| jd W n2 tk
r } z| jjd| dS d}~X nX | j j
d}| j d| | j |d d }| jj d
| d d j | d
dS )zAdd a new command line preset for the current options with the
specified name.
:param name: the name of the new preset
:returns: True on success or False otherwise
zA preset named 'z' already existsF)r r< rU r{ zCould not add preset: Nz --add-presetr r zAdded preset 'z' with options r r T)
ri rF r r r{ r< rU rb r rh indexr r )r r r< rU ri r Z arg_indexr r* r* r+ rb s
zSoSReport.add_presetc C s | j }|j|s(| jjd| d dS y|j|d W n6 tk
rn } z| jjt| d dS d}~X nX | jjd| d d S )
zDelete a named command line preset.
:param name: the name of the preset to delete
:returns: True on success or False otherwise
zPreset 'z ' not foundF)r r NzDeleted preset 'z'
T)ri rF r r rc r r r )r r ri r r* r* r+ rc s
zSoSReport.del_presetc C s | j j }| jjr || j 7 }| jjr4| jj| np|td7 }y t | W nV t
k
rv | jj d | j d Y n. t
k
r } z| j d| W Y d d }~X nX d S )Nz,Press ENTER to continue, or CTRL-C to quit.
zExiting on user cancel rk )ri Zget_msgr{ r@ r> batchr r r inputKeyboardInterruptr r r )r r r r* r* r+ rJ s
zSoSReport.batchc C sr t j }d}| d}tjj| j|}| jj| d| d| d | jjd| | jj | d|dd d S )
Nz!caught exception in plugin methodz-plugin-errors.txtz "r1 z()"zwriting traceback to r a)mode)
r
format_excr| r r r r} r r
add_string)r r: methodZtracer Zplugin_err_logZlogpathr* r* r+ r s
z SoSReport._log_plugin_exceptionc C s | j j y$| jjtd | j | j d S tk
r } zD|jt krnt
d t
d|j d t
d nt
d| W Y d d }~X nN t k
r } z2| jj
d | jj
d tj | jj
| W Y d d }~X nX | jd d S )Nz Setting up archive ...r r z while setting up archivezError setting up archive: z) Unexpected exception setting up archive:rk )ri Zpre_workr r r Z
setup_archiver OSErrorerrnofatal_fs_errorsr strerrorr r r print_excr )r r r* r* r+ prework s&
zSoSReport.preworkc C sr | j jtd xZ| jD ]N\}}y| jjj| |jt| jj| t j
}|j j d| | j
|_
|j |j | jj|j | jjr|j t j
}|j j d| |j j d|| W q tk
r tY q tk
rH } zV|jtkr,| j jd | j jd|j d | j jd | j d | j |d W Y d d }~X q t k
rh | j |d Y qX qW d S )
Nz Setting up plugins ...Z setup_startZ setup_endZ
setup_timer r z while setting up pluginsrk setup) r r r rn ry r rx Zset_plugin_manifestr r nowrw add_fieldr Zadd_default_collectionsrX rr r Z _env_varsr{ r\ Z setup_verifyrL rR rS rT r rU r r r )r r r startendr r* r* r+ rX s:
zSoSReport.setupc C s. g }|j dt | jjdj|dd dS )zWFetch version information from all plugins and store in the report
version filez sos report: r z version.txt)Zcontentr N)r" r r rP r )r Zversionsr* r* r+ version
s zSoSReport.versionc C s | j jtd | j jd d}g | _g | _x*| jD ] }|d7 }| jj||d f q4W ydg }t| jj }|j
| j t | j}W d Q R X x"|D ]}|s| j
jd| qW | j jd W n* tk
r | j jd tjd Y nX d S )Nz! Running plugins. Please wait ...r r rk z Unexpected plugin task result: z
Exiting on user cancel
)r r r pluglist
running_plugsrn r" r r{ r= map_collect_pluginr r} r~ rL r r| r )r Z plugruncountr resultsexecutorresr* r* r+ collect s(
zSoSReport.collectc C s t d
}y|| j|d d d }|j| j|}|jp:d}tj }|jjd| |j |d tj }|jjd| |jjd|| W n t
k
r d|d d }| j j d
| d | j
j| | jj|d | j|d d d j |jd d
|jj Y nX W dQ R X | jjr| jj } y0td| }
t|
d j d | j |d < W n$ t k
r d| j |d < Y nX xTt j | D ]F} t j j!| | } t j j"| rt j j#| rt$| n
t j%| qW d S )zaWraps the collect_plugin() method so we can apply a timeout
against the plugin as a wholerk r NZ
start_time)r Zend_timeZrun_timezPlugin z
timed outz
r T)waitzdu -sB1 r )&r rn Zsubmitcollect_pluginr r rY rw rZ resultFuturesTimeoutErrorr r r} r r_ r Zset_timeout_hitr Z_threadsclearr{ r@ r Z get_tmp_dirr r r rt r r| r r r r islinkr unlink) r r: ZpoolZ_plugtr r[ r\ r r Zdufr* r* r+ ra , s@
"
zSoSReport._collect_pluginc $ C s, y*|\}}| j |d d }| jj| W n tk
r> dS X t| j }d| d| dd|dddjd d
| jD d }| j| y|j y| jj | W n( t
k
r | j j d | d
Y nX y| jj | W n* t
k
r
| j j d | d Y nX d}t| jt
| jjkrV| jrVdddddjdd
| jD d }| j rn| j rnd}|r~| j| W n tk
r Y n tk
r } zT|jtkr| jjd|j d | jjd| j d tjd | j|d W Y d d }~X n" tk
r& | j|d Y nX d S )Nrk Fz Starting re z<5r z<15z [Running: c s s | ]
}|V qd S )Nr* )r r r* r* r+ r e s z+SoSReport.collect_plugin..]zCould not remove z from plugin list, ignoring...z& from running plugin list, ignoring...r z Finishing plugins z<12c s s | ]
}|V qd S )Nr* )r r r* r* r+ r ~ s z
Finished running pluginsz
z while collecting plugin dataz# Data collected still available at r re )rn r_ r" r r! r ui_progressrg r^ r r2 r} r~ r r{ r= r rR rS rT r r rU r r| r r ) r r: countr r Znumplugs status_liner r r* r* r+ rg ] sT
8
&
zSoSReport.collect_pluginc C sT | j jdkr(| j j r(d|jd }n
| d}| j jsPtjj| tjj d S )Nr
Z r ) r{ r rJ ljustquietr r writeflush)r rr r* r* r+ rp s
zSoSReport.ui_progressc C s@ | j s
d S djdd dd | j D D d }| jj|d d S )Nr c S s" g | ]\}}| d t | qS )r' )r
)r r r r* r* r+ r s z.SoSReport.collect_env_vars..c S s. g | ]&}t jj|d k r|t jj| fqS )N)r| environget)r r r* r* r+ r s Z environment)rr r r rP )r envr* r* r+ collect_env_vars s zSoSReport.collect_env_varsc C s t }x| jD ]\}}t|d}x |jD ]}|jt| q(W |jrT|jt|j x,|jD ]"}|jt |d d|d d q\W x>|j
D ]4}|jt |d dt j
jd| j d |d d
qW x0|jD ]&\}}}|jt|t j
jd|d qW |j| qW td d ftd
dftddff} x| D ]\}
} } yT| j }
|
|j }|jddj }|
j| |
j | jj |
t j
jd| d W nn t k
r } zP|j t kr| j j!d | j j!d|j" d| d | j j!d | j#d W Y d d }~X nX q$W d S )N)r Zsrcpathz..Zdstpath)r hrefcmdr r r )r Z return_coder} zsos.txttextzsos.jsonZJSONzsos.htmlZHTMLzutf-8r r )r r r z while writing z reportrk )$r rn r Zalertsaddr Z custom_textr Z copied_filesr Zexecuted_commandsr r| r r r Z copy_stringsr r r r r Zunicodeencodedecoderw rx r r rR rS rT r r rU r )r rf r r r Zalertrn r~ r Z
formatlistZclass_filenameZtype_fdr r r* r* r+ generate_reports sN
zSoSReport.generate_reportsc C s x| j D ]\}}yh|jdrhtj }|jjd| |j tj }|jjd| |jjd|| n| jjd| W q
t k
r } zT|j
t kr| j j
d | j j
d|j d | j j
d | jd | j|d W Y d d }~X q
tk
r | j|d Y q
X q
W d S )
NrA Zpostproc_startZ postproc_endZ
postproc_timez Skipping postproc for plugin r r z" while post-processing plugin datark )rn Z
get_optionr rY rw rZ rA r} r rR rS rT r r rU r r r )r r r r[ r\ r r* r* r+ rA s*
zSoSReport.postprocc C sv |sdS yHd}t j|}t|d&}x |j|}|s6P |j| q&W W d Q R X W n tk
rl | j Y nX |j S )NFi r rbi )hashlibr openreadr r r Z hexdigest)r r hash_nameZ hash_sizeZdigestZ
archive_fpZhashdatar* r* r+ _create_checksum s
zSoSReport._create_checksumc
C s8 t |d | ddd}|r*|j|d W d Q R X d S )Nr1 wzutf-8)encodingr )r rw )r r r checksumfpr* r* r+ _write_checksum s zSoSReport._write_checksumc R s: d }d }d }| j d}| jjryJ| j| j| j| j| jd}td|d}|j| j j
|j \}}d}W n4 t k
r } zt
td| W Y d d }~X nX | j | jd k r| j j| jj | j |r&tjj| j| j j} |jtjj| dd |jtjj| dd |jtjj| d d
| jjr8| j | jjr d d lm d d
l m }
|
| j} t dd | j dD | j!d< t | j!j" } | j#j$d| t%| j!j& dd ddd d }
dj fdd|
D }| j#j$d| | j#j$d | j#j$d | j#j$d | j#j$d | jj'stj(d }| jjsJt
td zy&|r`| j j)| | j j*| jj}W n t+k
r } zLt
d t
td |j, d | j j
t
d |j-t.kr| j/d! W Y d d }~X n" t k
r | jj0r dS X W d tj(| X n| jj1s$| jj2r0| j#j3d" | j j
}tjj4|}|rV|j5|}y$tjj| j|}tj6|| |}W n( t+k
r t
td#| dS X d }| jj's$|st
d$ q8y| jj7 }| j8||}W n" t k
r t
td% dS X y| j9||| W n( t+k
r< t
td&| Y nX tjj4|}|rb|j5|j:d'd(}tjj| j|}tj;|}|d) | }|d) | }ytj6|| |}W n( t+k
r t
td*| dS X ytj6|| W n( t+k
r
t
td+| Y nX | jj<|||||d, n| jj<||||d, | jj=sV| jj>sV| jj?r| jj'syP| j| j| j| j| jd}t@| jA| jB| jCd||d-}|j | j#j$td. W n6 t k
r } z| j#jDd/| W Y d d }~X nX nd0}| j#jD| tEjF | jGr| jGj | jr6tjjH| jr6tI| j dS )1NF)ri r sys_tmpr" rw T)in_place hook_commonsz#ERROR: Unable to obfuscate report: r zsos.logzui.logr z
manifest.jsonr )get_human_readable)Pathc s s | ]}|j jV qd S )N)lstatst_size)r rn r* r* r+ r E s z'SoSReport.final_work..z**/*Zsos_logs_reportszNEstimated disk space requirement for whole uncompressed sos report directory: c S s | d S )Nrk r* )xr* r* r+ K s z&SoSReport.final_work..)keyreverse z, c 3 s( | ] \}}| d |dd V qdS )z: r )Z precisionNr* )r r v)r r* r+ r L s zFive biggest plugins: r z>Please note the estimation is relevant to the current options.zBe aware that the real disk space requirements might be different. A rule of thumb is to reserve at least double the estimation.? z Creating compressed archive...r z while finalizing archive rk zQ
Unable to encrypt when using --build. Encryption is only available for archives.zError moving directory: z Creating archive tarball failed.z:Error generating archive checksum after archive creation.
z!Error writing checksum for file: z.tarz-obfuscated.tarr1 zError moving archive file: z Error moving checksum file: )rL )r r rh r r r z Uploaded archive successfullyzUpload attempt failed: zEUnable to upload archive when using --build as no archive is created.)J generate_manifest_tag_summaryr{ r9 ri r r rw r Zset_target_pathr Zget_archive_pathexecuter r r r Zadd_final_manifest_dataZcompression_typeZ_obfuscate_upload_passwordsr| r r _nameZobfuscate_filerv Zadd_ui_log_to_stdoutr@
sos.utilitiesr Zpathlibr sumr rt r# r r sortedr# r6 umaskZrename_archive_rootfinalizerR rU rS rT r r~ Z encrypt_passZ encrypt_keyr basenameZobfuscate_stringrenameZget_preferred_hash_namer r r statZdisplay_resultsr_ r` ra r r r rh r r r r r r ) r r Z directoryrL Zdo_cleanr ZcleanerZ_pathsr Z_dirr Z tmpdir_pathZ_sumZ
bigpluginsZbp_outZ old_umaskr Zdir_nameZ final_dirr r Z base_archiveZ
final_nameZ archivestatZ archive_hashZ
final_hashZuploaderr r* )r r+
final_work
s
$
&
zSoSReport.final_workc C s | j s| jjtd dS dS )Nz no valid plugins were enabledFT)rn r} r r )r r* r* r+ verify_plugins s zSoSReport.verify_pluginsc C s | j jd| j | j jd| jr&| jjnd | j jd| jj d}tdr~t dt
j }|d d kr~|d
j d j
d }| j jd | j jjd
| | j jjdt
jd | j jd x&| jj D ]\}}| j jj|| qW | j jd| jj | j jd| jj | j jd dS )zgAdd 'global' data to the manifest, that is any information that is
not plugin-specific
rs rW ZunsetrZ r Zionicez
ionice -p r r r r priorityZio_classZnicenessr Zenabled_pluginsZdisabled_pluginsr N)ry rZ rs rW r Zadd_listr{ rZ r r r| getpidr r rx r nicer r# rB rO )r Z _io_class_ior r r* r* r+ add_manifest_data s$ zSoSReport.add_manifest_datac s d fdd }i xZ| j jD ]N}x|jD ] }|| q(W x|jD ]}||d q@W x|jD ] }|| qZW q W | j jdtt j dS )ac Add a section to the manifest that contains a dict summarizing the
tags that were created and assigned during this report's creation.
This summary dict can be used for easier inspection of tagged items by
inspection/analyzer projects such as Red Hat Insights. The format of
this dict is `{tag_name: [file_list]}`.
filepathc
s x| d D ]v}| | s
| r q
y | }W n t k
rD g }Y nX |jt| | tr`| | n| | g ttt| |< q
W d S )NZtags)r4 r r3 r r r )Zentr tagr ) tag_summaryr* r+ compile_tags
s
"z=SoSReport.generate_manifest_tag_summary..compile_tagsZ files_copiedr N)r ) ry r Zcommandsfiles collectionsrZ dictr r# )r r r r~ Z_fileZ
collectionr* )r r+ r s
z'SoSReport.generate_manifest_tag_summaryc C s | j jdt ddj| j d | jjj }dt d| jj ddj| d}| j j| | j jdt ddj| jj d S ) N[z:setup] executing 'sos r r z:setup] using 'z' preset defaults (rj z :setup] effective options now: ) r} r __name__r rh rW r{ rG r )r Z preset_argsr r* r* r+ _merge_preset_options% s
" " z SoSReport._merge_preset_optionsc C s
yB| j j| j | j | j | j | j | j | j | j j
rX| j
t | j j rl| j t | j j
r| j
t | j jr| j| j j t | j jr| j| j j t | j st | j | j | j | j | j | j js| j | j js
| j | j js*| jj d | j n | jj d | j | j S t k
r | j j!rb t"j#dd dks|| j$ Y n| t%k
r | jj&d | j$ | j'd Y nJ t k
r } z,t"j#dd dks| j$ t(j)|j* W Y d d }~X nX | j'd dS ) Nz*Starting post-processing of collected dataz*Skipping post-processing of collected dataZ
SOS_TEST_LOGSr z
Exiting on user cancelrI rk F)+ri Z set_commonsr r! r& r r6 r; r< r{ rH
SystemExitrJ rI rb rc r rJ rW r rX re rR r| rQ r rS r r rA r] r rR r~ r| getenvZcleanuprL r r r exitcode)r r r* r* r+ r 4 sn
zSoSReport.execute)N)NN)r )r r )Jr
__module__ __qualname____doc__r< Z
root_requiredr
Z arg_defaultsrm classmethodr r ru r r r r r r r r r r r r r r r rz rv staticmethodr r r r
r r r r
r r r! r& r6 r; r< r> r? rH rJ rI rb rc rJ r rW rX r] re ra rg rp r| r rA r r r r r r r r
__classcell__r* r* )r r+ r0 R s ' X 7
2
O;
I
17
7 Z r0 )Fr )7r r r| rS r r r r r concurrent.futuresr r ri Zshutilr Zsos.report.pluginsr r r r r r r
r r r
r r r Z
sos.componentr Z sos.policiesZsos.report.reportingr r r r r r r r r r Z sos.cleanerr Z
sos.uploadr ZENOSPCZEROFSrT r, r- r rq r0 r* r* r* r+
s6 ( 0