3
ܓi @ s d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl Z d dl
m
Z
d dl m Z d dl
m
Z
d dlmZ d dlmZ d dlmZ d dlmZ d d lmZmZ d d
lmZ d d lm Z d d l m Z d d
l m Z dZ!G dd deZ"dS ) N)datetime)ThreadPoolExecutor)getpass)Path)quote)
SoSCleaner)SosNode)
ClusterOption str_to_bool) SoSComponent)bold) __version__) SoSUploadz/etc/sos/groups.dc O s e Zd ZdZdZdddddddg ddg g g ddddddg dd g ddddd dd
dddg dddddg ddg ddddddddg g g dd d d
ddddg ddddddddddddddddNZ fddZdd Zedd Z edd Z
edd Z dd Z ed d Z
ed d Zdad!d"Zd#d$ Zd%d& Zd'd( Zd)d* Zd+d, Zd-d. Zd/d0 Zd1d2 Zd3d4 Zd5d6 Zd7d8 Zd9d: Zd;d< Z d=d> Z d?d@ Z dAdB Z dCdD Z dEdF Z!dGdH Z"dIdJ Z#dKdL Z$dMdN Z%dOdP Z&dQdR Z'dSdT Z(dUdV Z)dWdX Z*dYdZ Z+d[d\ Z,d]d^ Z-d_d` Z. Z/S )b SoSCollectora
sos collect, or SoS Collector, is the formerly standalone sos-collector
project, brought into sos natively in 4.0 and later.
It is meant to collect sos reports from an arbitrary number of remote
nodes, as well as the localhost, at the same time. These nodes may be
either user defined, defined by some clustering software, or both.
For cluster defined lists of nodes, cluster profiles exist that not only
define how these node lists are generated but may also influence the
sos report command run on nodes depending upon their role within the
cluster.
Nodes are connected to via a 'transport' which defaults to the use of
OpenSSH's Control Persist feature. Other transport types are available, and
may be specifically linked to use with a certain cluster profile (or, at
minimum, a node within a certain cluster type even if that profile is not
used).
sos collect may be run from either a node within the cluster that is
capable of enumerating/discovering the other cluster nodes, or may be run
from a user's workstation and instructed to first connect to such a node
via the --primary option. If run in the latter manner, users will likely
want to use the --no-local option, as by default sos collect will also
collect an sos report locally.
Users should expect this command to result in a tarball containing one or
more sos report archives on the system that sos collect was executed on.
z8Collect an sos report from multiple nodes simultaneouslyFautoN T r z /etc/sos/cleaner/default_mapping rootsudoiX obfuscate)Nall_logs
alloptionsZallow_system_changes become_rootcase_idchrootcleancluster_options cluster_typeZcontainer_runtimedomainsdisable_parsersZenable_pluginsZ encrypt_keyZ encrypt_passgroupZimageZinherit_config_fileZforce_pull_imageskip_cleaning_filesjobsZ journal_sizekeywords keyword_filekeep_binary_fileslabel list_optionslog_sizeZ low_prioritymap_fileprimaryZ
namespacesZnode_config_filenodesZ no_env_varsno_local
nopasswd_sudoZ no_pkg_check no_updateZ only_pluginspasswordpassword_per_nodeplugoptsZplugin_timeoutZ cmd_timeoutZpresetZ
registry_userZregistry_passwordZregistry_authfile
save_groupZsince
skip_commands
skip_filesZ skip_pluginsssh_keyZssh_portssh_userZ sudo_binaryZtimeout transporttreat_certificatesverify usernamesuploadZ
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_targetc sn t j||| tjd g | _g | _d | _d| _d | _d | _ | j
j j d | j
j j
| _| jjdd | jjd t| jdd tj | _y$td d
tjtj d D | _W n& tk
r | jd d g| _Y nX | j | j | _ | jj sjyT| j | j | j!d
dj"dd t#j$D | j!d| j j% | j& W n" t'k
rh | j(dd Y nX d S )N? r collectr none node_listsudo_pwr c S s h | ]}|d d qS )r r ).0irC rC /usr/lib/python3.6/__init__.py s z(SoSCollector.__init__..zkCould not get a list of IP addresses from this hostnamne. This may indicate a DNS issue in your environmentz 127.0.0.1z
Executing c s s | ]
}|V qd S )NrC )rD srC rC rF s z(SoSCollector.__init__..zFound cluster profiles: zExiting on user cancel ))super__init__osumask client_listrA r+ retrievedclusterr manifestZ
components add_sectionr?
collect_md add_fieldadd_listsetattroptssocketZ gethostnamehostnamelistZ getaddrinfoip_addrs Exception log_error_parse_options
load_clustersclustersr( parse_node_stringsparse_cluster_options log_debugjoinsysargvkeysverify_cluster_optionsKeyboardInterruptexit)selfparserZ parsed_argsZ cmdline_args) __class__rC rF rM sB
" zSoSCollector.__init__c C sH ddl }|jj}i }| j|d}x"|D ]}|d | j||d < q&W |S )zmLoads all cluster types supported by the local installation for
future comparison and/or use
r Nrb )Zsos.collector.clustersZ collectorrb
_load_modulescommons)rm sospackageZsupported_clustersrb rR rC rC rF ra s
zSoSCollector.load_clustersc C s6 g }x,|j D ]"}tjj|r |j| j|| q W |S )z'Helper to import cluster and host types)__path__rN pathisdirextend_find_modules_in_path)clsrt Zsubmodmodulesrv rC rC rF rq s
zSoSCollector._load_modulesc C sr g }t jj|rnx\tt j|D ]J}|jds0q d|kr:q t jj|\}}d| d| }|j| j| q W |S )aX Given a path and a module name, find everything that can be imported
and then import it
path - the filesystem path of the package
modulename - the name of the module in the package
E.G. a path of 'clusters', and a modulename of 'ovirt' equates to
importing sos.collector.clusters.ovirt
z.py__zsos.collector..) rN rv existssortedlistdirendswithsplitextrx _import_modules)rz rv Z
modulenamer{ Zpyfilefname_modnamerC rC rF ry s
z"SoSCollector._find_modules_in_pathc C s |j dd }yt|t t |g}W n> tk
rd } z"td| d|jj |W Y dd}~X nX tj |tj
}x&|j D ]}|d d kr~|j | q~W |S )
z/Import and return all found classes in a moduler} z"Error while trying to load module z: Nr SosHostCluster)r r )
split
__import__globalslocals ImportErrorprintro __name__inspectZ
getmembersZisclasscopyremove)rz r Zmod_short_namemoduleer{ modrC rC rF r s z SoSCollector._import_modulesc
C s | j js dS g }t| j jts,| j jg| j _x| j jD ]}dd t|D }|jt| d}d}xp|D ]h}yJ|}||| }tjtj | d|krd|krwh|j|j
d |}W qh tj k
r whY qhX qhW |t|kr6|j||d d q6W || j _dS ) ar Parses the given --nodes option(s) to properly format the regex
list that we use. We cannot blindly split on ',' chars since it is a
valid regex character, so we need to scan along the given strings and
check at each comma if we should use the preceeding string by itself
or not, based on if there is a valid regex at that index.
Nc S s g | ]\}}|d kr|qS ),rC )rD rE mrC rC rF
s z3SoSCollector.parse_node_strings..r []r rp ) rY r,
isinstancer\ enumerateappendlenrecompileescapelstriperror)rm r, nodeZidxsstartposidxZregrC rC rF rc s0
z SoSCollector.parse_node_stringsc C st |j dd}|jddddd |jddd d |jd
dd d d
|jdddddgdd |jdddd |jddddd |jd td d d |jd d!d"dd#d$d% |jd&d td'd( |jd)dd d*d
|jd+d,dd-d |jd.d/dg d0d
|jd1d d2d |jd3dd d4d
|jd5td d6d |jd7td d8d |jd9d d:d |jd;g dd |jd?g dd@dAd> |jdBddCd |j dDdE}|jdFdGddHdId% |jdJdKdL |jdMd ddNdO |jdPtd dQd |jdRdSdL |jdTdUdVdWdXdY |jdZd d[d |jd\dd]d |jd^d_dL |jd`dadbdtdcdd |jded dfd |jdgd dhd |jdid djd |jdkdldmdL |jdndodptdqd( |jdrdsddtd |jdudvdL |jdwdxdydzdd{d| |jd}dd~d |jddWdd |jdddd |jdddd |jddtdd |jddd dd
|jddd dd
|jddd dd |jdddL |jddtdd( |jdtd dd |jddtdd( |jddd dd
|jdd dd |jdd dd |jdd dd |jdd dd |jdddddgdd |jdd dddO |jdd dd |jdd dd |jdd dd |jdd dd |jdd dd |jdd dd |jdddddddgdd |j dd}|jddddd dddÍ |jdd dddd> |jddg dddÍ |jddg ddd͍ |jdddg ddd͍ |jddg ddd͍ |jdd ddd؍ |jddd ddd͍ |jddddd| |jddg dddÍ |jdddddgddd d S )NzReport Passthru Optionsz0These options control how report is run on nodesz-az --alloptions
store_truez Enable all sos report options)actionhelpz
--all-logsz Collect logs regardless of sizez--allow-system-changesFz8z<40z<30F)newline)Z set_titleZadd_text__doc__itemsr )rz ZsectionZ hsectionsZhsecvaluerC rC rF display_help s
zSoSCollector.display_helpc C sx | j r| j j |r | j| y | j W n tk
rH | jd Y nX |dkrZ| j |sjtj| n
tj | dS )a Used to terminate and ensure all cleanup is done, setting the exit
code as specified if required.
:param msg: Log the provided message as an error
:type msg: ``str``
:param error: The exit code to use when terminating
:type error: ``int``
:param force: Use os.exit() to break out of nested threads if needed
:type force: ``bool``
z/Warning: Failed to close all remote connectionsrK N)
rR Zcleanupr_ close_all_connectionsr^ log_warnrg rl rN _exit)rm msgr forcerC rC rF rl ) s
zSoSCollector.exitc C s8 | j | j jdk| jtt| j jt| j| jd| _dS )zxFrom commandline options, defaults, etc... build a set of commons
to hand to other collector mechanisms
r )Z cmdlineopts need_sudotmpdirhostlenpolicyN) rY r7 r maxr r+ r[ r rr )rm rC rC rF r` G s
zSoSCollector._parse_optionsc C s g }t | jjts | jjg| j_| jjrx| jjD ]t}|jdd }|jdd jdd }y|jdd j d }W n tk
r d}Y nX |jt|||j| q2W || j_d S )Nr} r rp =True) r rY r r\ r
IndexErrorr r ro )rm rY optionrR namer rC rC rF rd S s
z"SoSCollector.parse_cluster_optionsc C s | j jrxf| j jD ]Z}d}xP| jj D ]B\}}x8|jD ].}|j|jkr6|j|kr6d}| j|||_P q6W q&W qW |s| j d|j d|j d dS )z+Verify that requested cluster options existFTz!Unknown cluster option provided: r} rp N)
rY r rb r optionsr rR _validate_optionr rl )rm optmatchclustr r rC rC rF rj h s z#SoSCollector.verify_cluster_optionsc C sl |j tks<|j |j ks6d}| j||j|j |j f d |jS |jj }|d
krdd }| j||j d |d kS ) aC Checks to make sure that the option given on the CLI is valid.
Valid in this sense means that the type of value given matches what a
cluster profile expects (str for str, bool for bool, etc).
For bool options, this will also convert the string equivalent to an
actual boolean value
z.Invalid option type for %s. Expected %s got %srp trueonyesfalseoffnozUInvalid value for %s. Accepted values are: 'true', 'false', 'on', 'off', 'yes', 'no'.)r r r r r r )r r r )opt_typeboolrl r r lower)rm r Zclir valrC rC rF r w s
z SoSCollector._validate_optionc C s | j j| dS )z.Log info messages to both console and log fileN)sosloginfo)rm r rC rC rF log_info s zSoSCollector.log_infoc C s | j j| dS )z.Log warn messages to both console and log fileN)r Zwarning)rm r rC rC rF r s zSoSCollector.log_warnc C s | j j| dS )z/Log error messages to both console and log fileN)r r )rm r rC rC rF r_ s zSoSCollector.log_errorc C s0 t j d d }d| d| }| jj| dS )z.Log debug message to both console and log filerp z[sos_collector:z] N)r stackr debug)rm r ZcallerrC rC rF re s zSoSCollector.log_debugc s t jjd t jjd x8t| jD ]*}t jjd|dd| j| jdd q$W i xn| jj D ]`\}}xV|jD ]L}|j kr| |j< qrx0|j D ]&}| |j j kr |j j j
| qW qrW qbW t jjd t jjddd dd
d dd d
ddddddd xt fdddD ]l} | }ddj dd t|j D d d|jd d|j j
d
dt|jd
d|jd
d }t jj| q W t jjd dS )z&Display options for available clustersz;
The following clusters are supported by this installation
z@Use the short name with --cluster-type or cluster options (-c)
rH z<15Z30
z/
The following cluster options are available:
r Z25z Option NameZ15ZTypez<10ZDefaultZ10Z Description s z+SoSCollector.list_options..)keyz z, c s s | ]
}|V qd S )NrC )rD crC rC rF rJ s z,SoSCollector.list_options..zh
Options take the form of cluster.name=value
E.G. "ovirt.no-database=True" or "pacemaker.offline=False"
N)rg stdoutwriter rb Z cluster_namer r r rR r rf r r r r description)rm rR r r r r Z_optZoptlnrC )r rF r( s* $
0RzSoSCollector.list_optionsc C s t j| j dS )z8Removes the temp directory and all collected sos reportsN)shutilZrmtreer )rm rC rC rF delete_tmp_dir s zSoSCollector.delete_tmp_dirc C s d}| j jr |d| j j 7 }| j jr8|d| j j 7 }tjtj d}y tjt_W n2 t k
r } z| j
d| W Y dd}~X nX dj dd t d D }| d| d| S )
z(Generates a name for the tarball archivez
sos-collector-z%Y-%m-%dz#Could not cast to ascii_lowercase: Nr c s s | ]}t jtjV qd S )N)randomZchoicestring lowercase)rD r rC rC rF rJ s z1SoSCollector._get_archive_name.. )
rY r' r r ZstrftimeZnowr Zascii_lowercaser NameErrorre rf range)rm ZnstrZdterrZrandrC rC rF _get_archive_name s "z SoSCollector._get_archive_namec C s& | j | _d}| jd | j d | S )zvReturns the path, including filename, of the tarball we build
that contains the collected sos reports
Zgz/z.tar.)r arc_namer )rm ZcomprrC rC rF _get_archive_path s
z SoSCollector._get_archive_pathc C s | j j}|tjjtj d| tjjt|g}d}x |D ]}tjj|r:|}P q:W |dkrjt d| | j
d| t |ddd}t j
|}xBdD ]:}|| r| j
d
| d || d t| j ||| qW |d
r
| j
d|d
d | j jj|d
W dQ R X dS )a
Attempts to load the host group specified on the command line.
Host groups are defined via JSON files, typically saved under
/etc/sos/groups.d/, although users can specify a full filepath
on the commandline to point to one existing anywhere on the system
Host groups define a list of nodes and/or regexes and optionally the
primary and cluster-type options.
z.config/sos/groups.d/Nzno group definition for zLoading host group rzutf-8)encodingr+ r zSetting option 'z' to 'z'per host groupr, zAdding z
to node list)r+ r )rY r! rN rv rf r homeCOLLECTOR_CONFIG_DIRr~ OSErrorre openjsonloadrX r, rx )rm Zgrppathsr rv hfZ_groupr rC rC rF _load_group_config s*
z SoSCollector._load_group_configc
C s | j j| j j| jjd t| jd}tj dkrRtj j
t j d}tj
|dd nt}tj j
||d }t|ddd }tj|| W d
Q R X tj|d |S ) a
Saves the results of this run of sos collect to a host group file
on the system so it can be used later on.
The host group will save the options primary, cluster_type, and nodes
as determined by sos collect prior to execution of sos reports.
r )r r+ r r, z.config/sos/groups.dT)exist_okr wzutf-8)r Ni )rY r3 r+ rR r r\ rA rN getuidrv rf r r makedirsr r r dumpchmod)rm ZcfgZ
group_pathr r rC rC rF write_host_group s
z SoSCollector.write_host_groupc = C s | j j| j | jj rB| jj rB| jd d}| jj| j | y| jjs\| jjr| jj
r| jj r| jd d| jj d}t
|d| j_| jd o| jj o| jj r| jj r| jj r| jd d | jj d
}t
|d| j_n| jjs| jj| j_W n" tk
r& | jd d Y nX | jjr| jj d
ks| jj rZd}| j|d | jd d| jj d}t
|d| j_d| jd< n| jd d| j_| jjry | j W nD tk
r } z&d| jj d| }| j|d W Y d d }~X nX y| j j W n" tk
r, | jdd Y nX | jj
rJ| j d| j_nyd}d }d}| jj rtj dkr| jj r| jj sd}t
|}|dkr| jj| d}d| j_d }n| jj| d}d| j_t d | j||d | _
W n@ tk
r* } z"| jd | | jd d W Y d d }~X nX | j j d | j
j | j j!d! | j j"j!| j
j | j
j#t$| j j"| j
j | jj%r| jj%d"kr| j&d# | _'n| j&| jj% | _'| jj%| _%| j
| j'_
n| j( | j'd kr| jj" rd$}| j|d n2| j'd kr&| jj"r&| jd% | j&d# | _'d"| _%| j j d&| j% | j'r| j'| j
_'| jj)d'krd| j'j* | j_)| j'j+ | j'j,r| jj-s| jd(| j'j, d) | j'j,| j_-| j. | jj/r | jj/}y"| j0 }| jd*| d+| W n: tk
r } z | j1d,| d| W Y d d }~X nX d S )-Nz)password not specified, assuming SSH keyszgsos collect ASSUMES that SSH keys are installed on all nodes unless the --password option is provided.
z&password specified, not using SSH keysz"Provide the SSH password for user z: )promptr z3non-root user specified, will request sudo passwordz=A non-root user has been provided. Provide sudo password for z on remote nodes: z
Exiting on user cancel
rK r zkCannot become root without obtaining root password. Do not use --batch if you need to become root remotely.rp z,non-root user asking to become root remotelyzUser z5 will attempt to become root. Provide root password: FzSOption to become root but ssh user is root. Ignoring request to change user on nodez Could not load specified group zExiting on user cancel
TzLocal sos report generation forcibly skipped due to lack of root privileges.
Either use --nopasswd-sudo, run as root, or do not use --batch so that you will be prompted for a password
r z8Enter local sudo password to generate local sos report: r localhost)
local_sudoZ
load_factsz(Unable to determine local installation: zsUnable to determine local installation. Use the --no-local option if localhost should not be included.
Aborting...
r+ r, r@ ZjbonzFCluster type could not be determined and no nodes provided
Aborting...zCluster type could not be determined, but --nodes is provided. Attempting to continue using JBON cluster type and the node listr r zUpdating SSH key to z per clusterz
Wrote group 'z' to zCould not save group )2r Z set_commonsrr rY r0 r1 re ui_logr _fmt_msgr+ batchr7 r r. rB rk rl r Z
root_passwordr r! r r^ Zpre_workconnect_to_primaryr- rN r r rU rV addressrT r, set_node_manifestgetattrr rb rR determine_clusterr8 Zset_transport_typeZsetupZcluster_ssh_keyr6 get_nodesr3 r r_ )rm r r Z
can_run_localr Zskip_local_msgZgnamer rC rC rF prep# s
zSoSCollector.prepc C sB | j jd | j r*| jj r*| jdd | j jd | jjr| jjdk r| jjrZ| jj p`| j
j s| j jd| jjd| j d x2t
| jD ]$}| j jd|d| j d qW | j jd | jjs>ytd | j jd W nT tk
r
| jd
d Y n4 tk
r< } z| jt|d W Y dd}~X nX dS ) zuPrints a list of nodes to collect from, if available. If no nodes
are discovered or provided, abort.
r zGNo nodes were detected, or nodes do not have sos installed.
Aborting...rp z1The following is a list of nodes to collect from:N r r zC
Press ENTER to continue with these nodes, or press CTRL-C to quit
zExiting on user cancelrK )r r rA r+ connectedrl r[ localrY r- rR strict_node_listrr r r inputrk r^ repr)rm r r rC rC rF
display_nodes s* $
zSoSCollector.display_nodesc C s" d}i }| j jr t| j j|d< | j jr0d|d< | j jr@d|d< | j jrPd|d< | j jrltt| j j|d< | j jrt| j j|d< | j j rt| j j |d < | j j
d
krt| j j
|d < x*|j D ] \}}|d | d
| d
7 }qW |j }| j
d| d| jd< || jd< | jjd| dS )z:Configures the sos report command that is run on the nodeszsosreport --batch zcase-idr r zall-logsr: zlog-sizesysrootr r zcompression-typez--rH zInitial sos cmd set to sos_cmd sos_optionsZinitial_sos_cmdN)rY r r r r r: r) r r r compression_typer rstripre rr rU rV )rm r r kvrC rC rF configure_sos_cmd s2
z SoSCollector.configure_sos_cmdc C sr y.t | jj| j| _| jjd| jj d W n> tk
rl } z"| jd| | jdd W Y dd}~X nX dS )zgIf run with --primary, we will run cluster checks again that
instead of the localhost.
z
Connected to z , determining cluster type...z#Failed to connect to primary node: z.Could not connect to primary node. Aborting...rp N) r rY r+ rr r r r^ re rl )rm r rC rC rF r s z SoSCollector.connect_to_primaryc C s t | jj }x| jj D ]}|j| | j|_|j r|jj}| jd| d xb|D ]Z}t |j|jrX|jj}| jd| d | j|_|j rX| jd| d| d |}P qXW || _
|j | _ | j
| j
d< | jjd | j P qW d
S ) a@ This sets the cluster type and loads that cluster's cluster.
If no cluster type is matched and no list of nodes is provided by
the user, then we abort.
If a list of nodes is given, this is not run, however the cluster
can still be run if the user sets a --cluster-type manually
zInstallation matches z , checking for layered profileszLayered profile z found. Checking installationz*Installation matches both layered profile z and base profile z), setting cluster type to layered profilerR zCluster type set to N)r\ rb valuesr r+ Z
check_enabledro r re
issubclassrR r r rr r r )rm ZchecksrR ZcnameZ remainingZrnamerC rC rF r s,
z SoSCollector.determine_clusterc C s( | j r$| jj }| jd| |S g S )z>Collects the list of nodes from the determined cluster clusterz Node list: )r rR Z
_get_nodesre )rm r, rC rC rF get_nodes_from_cluster( s
z#SoSCollector.get_nodes_from_clusterc C s | j | jkr"| jjr"| jj| j | jjsPx$| jD ]}|| jkr2| jj| q2W | jdk r| jj rx.| jD ]$}|| jj | jjfkrl| jj| qlW t t
dd | jD | _| j d| j | j j
d| j dS )zSReduce duplicate entries of the localhost and/or primary node
if applicableNc s s | ]}|r|V qd S )NrC )rD nrC rC rF rJ ? s z0SoSCollector.reduce_node_list..zNode list reduced to rA )r[ rA rY r- r rR r r] r+ r\ setre rU rW )rm rE r( rC rC rF reduce_node_list0 s
z SoSCollector.reduce_node_listc C sr xl| j jD ]`}y tj|}tj||r*dS W q
tjk
rh } z d}| j||||f W Y dd}~X q
X q
W dS )zCompares a discovered node name to a provided list of nodes from
the user. If there is not a match, the node is removed from the listTz0Error comparing %s to provided node regex %s: %sNF)rY r, fnmatch translater r r re )rm r Zregexr r rC rC rF compare_node_to_regexC s
*z"SoSCollector.compare_node_to_regexc s | j r | j r d}| j|d y@| j }| jjrXx*|D ] | j r8| jj q8W n|| _W nx t k
r } z\| j
d| | j
d | jj| _x0| jD ]& t fdddD r| jj qW W Y d
d
}~X nX | jjr8xR| jjD ]F t fdddD r q | jkr| j
d d | jj qW | j s| j
jdd }x0| jD ]& | jdd krX| jj qXW | jjs| jj| j
| j y,tt| jtd}t|| jd | jd< W n8 ttfk
r } z| j
d| W Y d
d
}~X nX d
S )z4 Sets the list of nodes to collect sos reports from zaCould not determine a cluster type and no list of nodes or primary node was provided.
Aborting...rp zError parsing node list: z#Setting node list to --nodes optionc 3 s | ]}| kV qd S )NrC )rD rE )r rC rF rJ e s z)SoSCollector.get_nodes..*\?()r Nc 3 s | ]}| kV qd S )NrC )rD rE )r rC rF rJ k s z*\?()/[]z
Force adding z
to node listr} r )r r zCould not set UI spacing: )r. r/ r0 r1 r2 r )r+ rR rl r' rY r, r- rA r r^ re anyr r[ r r r* r r rr TypeError
ValueError)rm r r, r hostZ _node_maxr rC )r rF r P sJ
"
zSoSCollector.get_nodesc C s ynt |d | j|d d}|j| j |jrd| jj| | jjj |d |j
t | jj|d n|j W n t
k
r Y nX dS )zTry to connect to the node, and if we can add to the client list to
run sos report on
Positional arguments
node - a tuple specifying (address, password). If no password, set
to None
r rp )r0 N)r rr Z set_clusterrR r rP r rU r, rT r r
disconnectr^ )rm r clientrC rC rF _connect_to_node s z SoSCollector._connect_to_nodec C s d}| j jdt d | j|| j }| j j| d}| jjsyt| | j jd W nL tk
rx | j dd Y n. t
k
r } z| j |d W Y d d }~X nX d S )
zmPrint the intro message and prompts for a case ID if one is not
provided on the command line
ah This utility is used to collect sos reports from multiple nodes simultaneously. Remote connections are made and/or maintained to those nodes via well-known transport protocols such as SSH.
An archive of sos report tarballs collected from the nodes will be generated in %s and may be provided to an appropriate support representative.
The generated archive may contain data considered sensitive and its content should be reviewed by the originating organization before being passed to any third party.
No configuration changes will be made to the system running this utility or remote systems that it connects to.
z
sos collect (version z)
z,
Press ENTER to continue, or CTRL-C to quit
r zExiting on user cancelrK rp N) r r r
r
r rY r r rk rl r^ )rm Z
disclaimerZ intro_msgr r rC rC rF intro s zSoSCollector.introc C s | j jr| j | j | j | j jr<| j jr<| jdd | j | j | j | j | _
| j | j
d | j j
| _| j jdd | j | j d S )Nz
sos-collector was called with incompatible options --batch and --password.
If you need to use --password, please omit batch mode.
rp )r sos_logsi )rY r( rl r: r r0 r$ r r r archive_nameZ
setup_archivearchiveZget_archive_path archive_pathr r? )rm rC rC rF execute s"
zSoSCollector.executec sV t | jj| jjg | jjrD jt | js6| jj rD| j j
| j | j j d fdd| jD }| j
jrg }x@|D ]8}d| j
j d|d d}t|}|j
|d |f qvW |}y t| j
j}|j| j|dd |jd
d | j
jo| j d jd kr
| j jd t| j | _| jdkr0| jd
d n*| jdkrZ| j d jd krZ| jdd | j j d| j d| j
j d t| j
j}|j| j| j dd |jd
d t| j
j}|j| j | j dd |jd
d W nb t k
r | jddd
d Y n> t k
r6 } z d| }| j|dd
d W Y dd}~X nX t | jdrn| j j d | jj } | rn| jj!| d}| j"|| j#| jf | j$ | j#dkr| j% | _&nd}| j|d | j
j's| j
j(rRyN| j)| j*| j+| j
| j,d}
t-| j.| j/| j0d
|
| j&d } | j1 | j j d W n6 t k
rP } z| j j2d | W Y dd}~X nX dS ) zY For each node, start a collection thread and then tar all
collected sos reports z
Connecting to nodes...c s g | ]}| kr|d fqS )NrC )rD r( )filtersrC rF r s z(SoSCollector.collect..z Please enter the password for @r z: rp )Z chunksizeT)waitr
z No nodes connected. Aborting...zCollection would only gather from localhost due to failure to either enumerate or connect to cluster nodes. Assuming single collection from localhost is not desired.
Aborting...z*
Beginning collection of sos reports from z nodes, collecting a maximum of z concurrently
zExiting on user cancel
rK )r z Could not connect to nodes: NZ
run_extra_cmdz/Collecting additional data from primary node...z+
Successfully captured %s of %s sos reportsz4No sos reports were collected, nothing to archive...)r r sys_tmpr rS )rn argscmdlinein_place hook_commonsr= z Uploaded archive successfullyzUpload attempt failed: )3r) r+ r r[ r intersectionrA rR r rP r r r rY r1 r7 r r r# mapr9 Zshutdownr- popr Z
report_numrl _finalize_sos_cmd_collectrk r^ hasattrZ_run_extra_cmdZcollect_extra_cmdr rQ r create_cluster_archiver r< r= r r rC rS r rn rD rE r? r ) rm r, Z_nodesr r Znode_pwdZpoolZnpoolr filesrG ZuploaderrC )r@ rF r? s
"
zSoSCollector.collectc C sL y |j W n: tk
rF } z | jd|j d| W Y dd}~X nX dS )zCalls finalize_sos_cmd() on each node so that we have the final
command before we thread out the actual execution of sos
z#Could not finalize sos command for z: N)Zfinalize_sos_cmdr^ r_ r )rm r8 r rC rC rF rK 7 s z SoSCollector._finalize_sos_cmdc C sp y8|j s|j n| jjs"|j |jr6| jd7 _W n2 tk
rj } z| jd| W Y dd}~X nX dS )z Runs sos report on each noderp zError running sos report: N)r Z sosreportrY r- rQ r^ r_ )rm r8 r rC rC rF rL A s
zSoSCollector._collectc C s4 x.| j D ]$}|jr| jd|j |j qW dS )z Close all sessions for nodeszClosing connection to N)rP r re r r7 )rm r8 rC rC rF r N s z"SoSCollector.close_all_connectionsc C s d}g }x(| j D ] }x|jD ]}|j| q W qW d}| jjr| j| j| j| j| jd}y8| j j
d t d|d}|j | j |j
\}}d}W n4 tk
r } z| j jd| W Y dd}~X nX y| jd x|D ]}|jd d } |r|j| } tjj| j|}
| jj|
| d |r|j|} | rtjjd |jd d! }
|
d
7 }
| jj| |
qW | jj| jtjjddd | jj| jtjjddd | jdk r| jj | jj | j |rtjj| j| jj } |j tjj| dd |j tjj| dd |j tjj| dd | jj!dd}
tjj| jtjj"|
}|rT|j|j#dd}tj$|
| |r|jtjj| j| j% d}tj$|| | j j
d| | j&j
d| | j j
d | j j
d| d |S tk
r } z"d | d | j' }| j(|d d S d}~X nX dS )"zcCalls for creation of tar archive then cleans up the temporary
files created by sos collectNF)r r rC r rS r T)rF rG z$ERROR: unable to obfuscate reports: z"Creating archive of sos reports...r rp )r Z checksumsz.sha256r; zsos.logzui.logZ sos_reportsz
manifest.json)methodz.tarz-obfuscated.tarZ _private_mapz2A mapping of obfuscated elements is available at
zArchive created as zP
The following archive has been created. Please provide it to your support team.r r z Could not finalize archive: z.
Data may still be available uncompressed at r z
Archive errorrQ ))rP Z file_listr rY r r r rC rS r r r Zset_target_pathr? r^ r r r Zobfuscate_stringrN rv rf r= Zadd_fileZget_new_checksumZ
add_stringZ sos_log_fileZsos_ui_log_fileZadd_final_manifest_datar Z_obfuscate_upload_passwords_nameZobfuscate_filefinalizebasenamereplacerenamer< r r> rl )rm r* Z arc_pathsr6 r Zdo_cleanrG Zcleanerr r r ZchecksumZ_dirr Z
final_nameZmap_namer rC rC rF rN U s
$
z#SoSCollector.create_cluster_archive)Nr F)0r
__module__ __qualname__r ZdescZ arg_defaultsrM ra classmethodrq ry r rc r r rl r` rd rj r r r r_ re r( r r r r r r r r$ r r r' r* r- r r9 r: r? r? rK rL r rN
__classcell__rC rC )ro rF r ( s 2 ! m
(& %
0!e
r )#r+ r r rN r r r rZ r rg r concurrent.futuresr r Zpathlibr Zshlexr Z sos.cleanerr Zsos.collector.sosnoder Z sos.optionsr r
Z
sos.componentr Z
sos.utilitiesr rs r
Z
sos.uploadr r r rC rC rC rF
s.