|
Server IP : 184.107.3.203 / Your IP : 216.73.216.51 Web Server : Apache System : Linux dedicated2.avenfashion.com.ph 4.18.0-553.40.1.el8_10.x86_64 #1 SMP Mon Feb 10 12:11:18 EST 2025 x86_64 User : adminteladeoro ( 1015) PHP Version : 8.2.28 Disable Function : exec,passthru,shell_exec,system MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON Directory (0755) : /usr/lib/python3.6/site-packages/sos/collector/__pycache__/ |
| [ Home ] | [ C0mmand ] | [ Upload File ] |
|---|
3
~ �g"� � @ 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� de�Z"dS )� N)�datetime)�ThreadPoolExecutor)�getpass)�Path)�quote)�
SoSCleaner)�SosNode)�
ClusterOption� str_to_bool)� SoSComponent)�bold)� __version__)� SoSUploadz/etc/sos/groups.dc M s e Zd ZdZdZdddddddg ddg g g ddddddg dd g ddddd dd
dddg dddddg ddg ddddddddg g g dd d d
ddg dddddddddddddddd�LZ� fdd�Zdd� Zedd� �Z edd� �Z
edd� �Z dd� Z edd � �Z
ed d � �Zd_d d �Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd/d0� Zd1d2� Zd3d4� Zd5d6� Zd7d8� Zd9d:� Z d;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.� Z/S )`� 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 simultaneouslyF�autoN� T� r z /etc/sos/cleaner/default_mapping� �rootiX )L�all_logs�
alloptionsZallow_system_changes� become_root�case_id�chroot�clean�cluster_options� cluster_typeZcontainer_runtime�domains�disable_parsersZenable_pluginsZ encrypt_keyZ encrypt_pass�groupZimageZinherit_config_fileZforce_pull_image�skip_cleaning_files�jobsZ journal_size�keywords� keyword_file�keep_binary_files�label� list_options�log_sizeZ low_priority�map_file�primaryZ
namespacesZnode_config_file�nodesZ no_env_vars�no_local�
nopasswd_sudoZ no_pkg_check� no_updateZ only_plugins�password�password_per_node�plugoptsZplugin_timeoutZ cmd_timeoutZpresetZ
registry_userZregistry_passwordZregistry_authfile�
save_groupZsince�
skip_commands�
skip_filesZ skip_plugins�ssh_keyZssh_port�ssh_userZtimeout� transport�verify� usernames�uploadZ
upload_urlZupload_directoryZ upload_userZ upload_passZ
upload_methodZupload_no_ssl_verifyZupload_protocol�upload_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_list�sudo_pwr c S s h | ]}|d d �qS )r r � )�.0�ir@ r@ � /usr/lib/python3.6/__init__.py� <setcomp>� s z(SoSCollector.__init__.<locals>.<setcomp>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 )Nr@ )rA �sr@ r@ rC � <genexpr>� s z(SoSCollector.__init__.<locals>.<genexpr>zFound cluster profiles: zExiting on user cancel� ))�super�__init__�os�umask� client_listr> r) � retrieved�clusterr �manifestZ
components� add_sectionr< �
collect_md� add_field�add_list�setattr�opts�socketZ gethostname�hostname�listZ getaddrinfo�ip_addrs� Exception� log_error�_parse_options�
load_clusters�clustersr& �parse_node_strings�parse_cluster_options� log_debug�join�sys�argv�keys�verify_cluster_options�KeyboardInterrupt�exit)�self�parserZ parsed_argsZ cmdline_args)� __class__r@ rC rJ � 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 Nr_ � )Zsos.collector.clustersZ collectorr_ �
_load_modules�commons)rj �sos�packageZsupported_clustersr_ rO r@ r@ rC r^ � 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__rK �path�isdir�extend�_find_modules_in_path)�clsrq Zsubmod�modulesrs r@ r@ rC rn � s
zSoSCollector._load_modulesc C sr g }t jj|�rnx\tt j|��D ]J}|jd�s0q 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.�.) rK rs �exists�sorted�listdir�endswith�splitextru �_import_modules)rw rs Z
modulenamerx Zpyfile�fname�_�modnamer@ r@ rC rv � s
z"SoSCollector._find_modules_in_pathc C s� |j d�d }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 modulerz � z"Error while trying to load module z: Nr �SosHost�Cluster)r� r� )
�split�
__import__�globals�locals� ImportError�printrl �__name__�inspectZ
getmembersZisclass�copy�remove)rw r� Zmod_short_name�module�erx �modr@ r@ rC r� � s z SoSCollector._import_modulesc
C s | j js dS g }t| j jt�s,| j jg| j _x�| j jD ]�}dd� t|�D �}|jt|�� d}d}xp|D ]h}yJ|}|||� }tjtj |�� d|kr�d|kr�wh|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 )�,r@ )rA rB �mr@ r@ rC �
<listcomp> s z3SoSCollector.parse_node_strings.<locals>.<listcomp>r �[�]r� rm ) rV r* �
isinstancerY � enumerate�append�len�re�compile�escape�lstrip�error)rj r* �nodeZidxs�start�pos�idxZregr@ r@ rC r` s0
z SoSCollector.parse_node_stringsc C sH |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<d=d>� |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`dadbd�tdcdd� |jded dfd� |jdgd dhd� |jdid djd� |jdkdldmdL� |jdndodptdqd(� |jdrdsddtd� |jdudvdL� |jdwdxdydzdd{d|� |jd}dd~d� |jddWd�d� |jd�dd�d� |jd�dd�d� |jd�d�td�d�� |jd�dd d�d
� |jd�dd d�d
� |jd�dd d�d�� |jd�d�dL� |jd�td d�d�� |jd�dtd�d(� |jd�dd d�d
� |jd�d d�d� |jd�d d�d� |jd�d d�d� |jd�d d�d� |jd�ddd�d�gd�d� |jd�d dd�dO� |jd�d d�d� |jd�d d�d� |jd�d d�d� |jd�d d�d� |jd�d d�d� |jd�d d�d� |jd�ddd�d�d�d�gd�d� |j d�d��}|jd�d�d�d�d dd�d�� |jd�d dd�d�d>� |jd�d�g dd�d�� |jd�dg d�d�dʍ |jd�d�dg d�d�dʍ |jd�dg d�d�dʍ |jd�d d�d�dՍ |jd�dd d�d�dʍ |jd�d�d�d�d|� |jd�d�g dd�d�� d S )�NzReport Passthru Optionsz0These options control how report is run on nodesz-az --alloptions�
store_truez Enable all sos report options)�action�helpz
--all-logsz Collect logs regardless of sizez--allow-system-changesFz<Allow sos report to run commands that may alter system state)r� �defaultr� z--chrootr r �alwaysZneverz#chroot executed commands to SYSROOT)r� �choicesr� z--container-runtimezLDefault container runtime to use for collections. 'auto' for policy control.)r� r� z-ez--enable-pluginsru z&Enable specific plugins for sos reportz--journal-sizer z!Limit the size of journals in MiB)�typer� r� z-kz--plugin-optionz
--plugoptsr0 z&Plugin option as plugname.option=value)r� �destr� z
--log-sizez7Limit the size of individual logs (not journals) in MiB)r� r� r� z--low-priorityzRun reports as low priorityz-nz--skip-pluginszSkip these pluginsz-oz--only-pluginszRun these plugins onlyz --namespaceszDlimit number of namespaces to collect output for - 0 means unlimitedz
--no-env-varsz&Do not collect env vars in sos reportsz--plugin-timeoutz#Set the global plugin timeout valuez
--cmd-timeoutz$Set the global command timeout valuez--sincezbEscapes archived files older than date. This will also affect --all-logs. Format: YYYYMMDD[HHMMSS]z--skip-commandsr2 z do not execute these commands)r� r� r� r� z --skip-filesr3 zdo not collect these filesz--verifyz*perform pkg verification during collectionzCollector Optionsz.These options control how collect runs locallyz-bz--becomer z Become root on the remote nodesz --case-idzSpecify case number)r� z--inherit-config-filezKUse the config file from the collector for all nodes to use with sos report)r� r� r� z--node-config-filezCPath to an existing config file on the nodes to use with sos reportz--cluster-typez!Specify a type of cluster profilez-cz--cluster-optionr r� zVSpecify a cluster options used by a profile and takes the form of cluster.option=value)r� r� r� z--groupz Use a predefined group JSON filez --save-groupz%Save a resulting node list to a groupz--imagez;Specify the container image to use for containerized hosts.z--force-pull-imagez--pullTzDForce pull the container image even if it already exists on the host)r� r� r� r� z--registry-userzBUsername to authenticate to the registry with for pulling an imagez--registry-passwordzBPassword to authenticate to the registry with for pulling an imagez--registry-authfilezJUse this authfile to provide registry authentication when pulling an imagez-iz --ssh-keyzSpecify an ssh keyz-jz--jobsr z%Number of concurrent nodes to collectz-lz--list-optionsz#List options available for profilesz--labelz Assign a label to the archivesz --primaryz --managerz --controllerr) z.Specify a primary node for cluster enumeration)r� r� r� z--nopasswd-sudoz Use passwordless sudo on nodesz--nodeszDProvide a comma delimited list of nodes, or a regex to match againstz--no-pkg-checkz^Do not run package checks. Use this with --cluster-type if there are rpm or apt issues on nodez
--no-localz&Do not collect a report from localhostz-pz
--ssh-portz Specify SSH port for all nodes)r� r� z
--passwordz"Prompt for user password for nodesz--password-per-nodez!Prompt for password for each nodez--presetzSpecify a sos preset to use)r� �requiredr� z
--ssh-userz!Specify an SSH user. Default rootz --timeoutz$Timeout for sos report on each node.)r� r� r� z --transportz"Remote connection transport to usez--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 withz
--upload-passz Password to authenticate withz--upload-methodZputZpostz HTTP method to use for uploadingz--upload-no-ssl-verifyz'Disable SSL verification for upload urlz--upload-s3-endpointz#Endpoint to upload to for S3 bucketz--upload-s3-regionzRegion for the 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 protocolzCleaner/Masking Optionsz7These options control how data obfuscation is performedz--cleanz --cleanerz--maskr z Obfuscate sensitive information)r� r� r� r� z--keep-binary-filesr$ zGKeep unprocessable binary files in the archive instead of removing themz --domainsr z$Additional domain names to obfuscatez--disable-parsersr zCDisable specific parsers, so that those elements are not obfuscated)r� r� r� r� z--skip-cleaning-filesz--skip-masking-filesr zBList of files to skip/ignore during cleaning. Globs are supported.z
--keywordsr" z List of keywords to obfuscatez--keyword-filer# z&Provide a file a keywords to obfuscate)r� r� r� z --no-updater- z%Do not update the default cleaner mapz
--map-filer( z /etc/sos/cleaner/default_mappingz;Provide a previously generated mapping file for obfuscationz --usernamesr8 z List of usernames to obfuscate)TF)Zadd_argument_group� add_argument�int�strr
)rw rk Zsos_grpZ collect_grpZ cleaner_grpr@ r@ rC �add_parser_options' st
z SoSCollector.add_parser_optionsc C sl |j d� |j| j� ddddd�}|jd� x8|j� D ],\}}|jdd �t|�d
�|d ��d d
� q8W d S )NzSoS Collect Detailed Helpz Information on cluster profilesz Specific profile informationz'Information on how connections are madez Specific transport information)zcollect.clusterszcollect.clusters.$clusterzcollect.transportsz collect.transports.$transportz8The following help sections may be of further interest:
rE z>8z<40z<30F)�newline)Z set_titleZadd_text�__doc__�itemsr )rw ZsectionZ hsectionsZhsec�valuer@ r@ rC � 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 connectionsrH N)
rO Zcleanupr\ �close_all_connectionsr[ �log_warnrd ri rK �_exit)rj �msgr� �forcer@ r@ rC ri s
zSoSCollector.exitc C s8 | j | j jdk| jtt| j j�t| j��| jd�| _dS )zxFrom commandline options, defaults, etc... build a set of commons
to hand to other collector mechanisms
r )Z cmdlineopts� need_sudo�tmpdir�hostlen�policyN) rV r5 r� �maxr� r) rX r� ro )rj r@ r@ rC r] : s
zSoSCollector._parse_optionsc C s� g }t | jjt�s | jjg| j_| jjr�x�| jjD ]t}|jd�d }|jd�d jd�d }y|jd�d j� d }W n tk
r� d}Y nX |jt|||j|�� q2W || j_d S )Nrz r rm �=�True) r� rV r rY r� �
IndexErrorr� r rl )rj rV �optionrO �namer� r@ r@ rC ra F s
z"SoSCollector.parse_cluster_optionsc C s� | j jr�xf| 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: rz rm N)
rV r r_ r� �optionsr� rO �_validate_optionr� ri )rj �opt�match�clustr� r� r@ r@ rC rg [ 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 %srm �true�on�yes�false�off�nozUInvalid value for %s. Accepted values are: 'true', 'false', 'on', 'off', 'yes', 'no'.)r� r� r� r� r� r� )r� r� r� )�opt_type�boolri r� r� �lower)rj r� Zclir� �valr@ r@ rC r� j s
z SoSCollector._validate_optionc C s | j j|� dS )z.Log info messages to both console and log fileN)�soslog�info)rj r� r@ r@ rC �log_info s zSoSCollector.log_infoc C s | j j|� dS )z.Log warn messages to both console and log fileN)r� Zwarning)rj r� r@ r@ rC r� � s zSoSCollector.log_warnc C s | j j|� dS )z/Log error messages to both console and log fileN)r� r� )rj r� r@ r@ rC r\ � s zSoSCollector.log_errorc C s0 t j� d d }d|� d|� �}| jj|� dS )z.Log debug message to both console and log filerm � z[sos_collector:z] N)r� �stackr� �debug)rj r� Zcallerr@ r@ rC rb � s zSoSCollector.log_debugc s� t jjd� t jjd� x8t| j�D ]*}t jjd|d�d| j| jd�d�� q$W i � xn| jj� D ]`\}}xV|jD ]L}|j� kr�|� |j< qrx0|j D ]&}|� |j j kr�� |j j j
|� q�W qrW qbW t jjd� t jjddd �dd
d �dd d
�ddd�ddd�d� � x�t� � fdd�d�D ]l}� | }ddj dd� t|j �D ��d �d|jd �d|j j
d
�dt|j�d
�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)
rE z<15Z30�
z/
The following cluster options are available:
r� Z25z Option NameZ15ZTypez<10ZDefaultZ10Z Description�<c s
� | j S )N)rO )�x)�_optsr@ rC �<lambda>� s z+SoSCollector.list_options.<locals>.<lambda>)�keyz z, c s s | ]
}|V qd S )Nr@ )rA �cr@ r@ rC rG � s z,SoSCollector.list_options.<locals>.<genexpr>zh
Options take the form of cluster.name=value
E.G. "ovirt.no-database=True" or "pacemaker.offline=False"
N)rd �stdout�writer| r_ Z cluster_namer� r� r� rO r� rc r� r� r� r� � description)rj rO r� r� r� r� Z_optZoptlnr@ )r� rC r& � s* $
0RzSoSCollector.list_optionsc C s t j| j� dS )z8Removes the temp directory and all collected sos reportsN)�shutilZrmtreer� )rj r@ r@ rC �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 jtj�V qd S )N)�randomZchoice�string� lowercase)rA r� r@ r@ rC rG � s z1SoSCollector._get_archive_name.<locals>.<genexpr>� )
rV r% r r ZstrftimeZnowr� Zascii_lowercaser� � NameErrorrb rc �range)rj ZnstrZdt�errZrandr@ r@ rC �_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� )rj Zcomprr@ r@ rC �_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 ||| � q�W |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 )rV r rK rs rc r �home�COLLECTOR_CONFIG_DIRr{ �OSErrorrb �open�json�loadrU r* ru )rj Zgrp�pathsr� rs �hfZ_groupr� r@ r@ rC �_load_group_config� s*
z SoSCollector._load_group_configc
C s� | j j| j j| jjd t| j�d�}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� )rV r1 r) rO r rY r> rK �getuidrs rc r r� �makedirsr� r� r� �dump�chmod)rj ZcfgZ
group_pathr� r� r@ r@ rC �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| jj�s| jj| j_W n" tk
�r& | jd d � Y nX | jj�r�| jj d
k�s�| jj �rZd}| j|d� | jd� d| jj � d�}t
|d�| j_d| jd< n| jd� d| j_| jj�r�y | 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_n�y�d}d }d}| jj �r�tj � dk�r�| jj �r�| jj �s�d}t
|�}|dk�r�| 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"k�r�| j&d# | _'n| j&| jj% | _'| jj%| _%| j
| j'_
n| j(� | j'd k�r�| jj" �r�d$}| j|d� n2| j'd k�r&| jj"�r&| jd%� | j&d# | _'d"| _%| j j d&| j%� | j'�r�| j'| j
_'| jj)d'k�rd| 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
rH r zkCannot become root without obtaining root password. Do not use --batch if you need to become root remotely.rm 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
Tz�Local 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_commonsro rV r. r/ rb �ui_logr� �_fmt_msgr) �batchr5 r r, r? rh ri r Z
root_passwordr� r r� r[ Zpre_work�connect_to_primaryr+ rK r r rR rS �addressrQ r* �set_node_manifest�getattrr r_ rO �determine_clusterr6 Zset_transport_typeZsetupZcluster_ssh_keyr4 � get_nodesr1 r r\ )rj r� r� Z
can_run_localr Zskip_local_msgZgnamer� r@ r@ rC �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
| j�D ]$}| j jd|d| j d � ���� q�W | j jd� | jj�s>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...rm 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 cancelrH )r r� r> r) � connectedri rX �localrV r+ rO �strict_node_listro r| r �inputrh r[ �repr)rj r� r� r@ r@ rC �
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 jr�t| j j�|d< | j j r�t| j j �|d < | j j
d
kr�t| j j
�|d < x*|j � D ] \}}|d |� d
|� d
�7 }q�W |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-logsr7 zlog-size�sysrootr r zcompression-typez--rE zInitial sos cmd set to �sos_cmd� sos_optionsZinitial_sos_cmdN)rV r r r r r7 r' r� r r �compression_typer� �rstriprb ro rR rS )rj r r �k�vr@ r@ rC �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...rm N) r rV r) ro r r� r[ rb ri )rj r� r@ r@ rC 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|j�rX|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 profilerO zCluster type set to N)rY r_ �valuesr� r) Z
check_enabledrl r� rb �
issubclassrO r� r ro r r� )rj ZchecksrO ZcnameZ remainingZrnamer@ r@ rC 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 rO Z
_get_nodesrb )rj r* r@ r@ rC �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 r�x.| 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 )Nr@ )rA �nr@ r@ rC rG 2 s z0SoSCollector.reduce_node_list.<locals>.<genexpr>zNode list reduced to r> )rX r> rV r+ r� rO r rZ r) rY �setrb rR rT )rj rB r% r@ r@ rC �reduce_node_list# 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 )z�Compares 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)rV r* �fnmatch� translater� r� r� rb )rj r� Zregexr� r� r@ r@ rC �compare_node_to_regex6 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 � fdd�dD ��r�| jj � � q�W W Y d
d
}~X nX | jj�r8xR| jjD ]F� t � fdd�dD ���r q� | jkr�| j
d� � d�� | jj� � q�W | j �s�| j
jd�d }x0| jD ]&� |� jd�d k�rX| jj � � �qXW | jj�s�| 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...rm zError parsing node list: z#Setting node list to --nodes optionc 3 s | ]}|� kV qd S )Nr@ )rA rB )r� r@ rC rG X s z)SoSCollector.get_nodes.<locals>.<genexpr>�*�\�?�(�)r� Nc 3 s | ]}|� kV qd S )Nr@ )rA rB )r� r@ rC rG ^ s z*\?()/[]z
Force adding z
to node listrz r )r� r� zCould not set UI spacing: )r+ r, r- r. r/ r� )r) rO ri r$ rV r* r* r> r� r[ rb �anyr� rX r� r r' r� r� ro � TypeError�
ValueError)rj r� r* r� �hostZ _node_maxr� r@ )r� rC r C 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 )z�Try 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 rm )r. N)r ro Z set_clusterrO r rM r� rR r* rQ r r �
disconnectr[ )rj r� �clientr@ r@ rC �_connect_to_nodes s z SoSCollector._connect_to_nodec C s� d}| j jdt� d�� | j|| j �}| j j|� d}| jjs�yt|� | 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 cancelrH rm N) r r� r
r
r� rV r r rh ri r[ )rj Z
disclaimerZ intro_msgr r� r@ r@ rC �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.
rm )r� �sos_logsi� )rV r& ri r7 r r. r! r r r� � archive_nameZ
setup_archive�archiveZget_archive_path� archive_pathr r< )rj r@ r@ rC �execute� s"
zSoSCollector.executec sV t | jj| jjg�� | jjrD� jt | j��s6| jj rD| j j
| j� | j j d� � fdd�| jD �}| j
jr�g }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 k�r
| j jd� t| j �| _| jdk�r0| jd
d� n*| jdk�rZ| j d jd k�rZ| 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 | jd��rn| j j d� | jj � } | �rn| jj!| � d}| j"|| j#| jf � | j$� | j#dk�r�| 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 f�qS )Nr@ )rA r% )�filtersr@ rC r� � s z(SoSCollector.collect.<locals>.<listcomp>z Please enter the password for �@r z: rm )Z chunksizeT)�waitr z No nodes connected. Aborting...z�Collection 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
rH )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� rP )rk �args�cmdline�in_place� hook_commonsr: z Uploaded archive successfullyzUpload attempt failed: )3r& r) r
rX r � intersectionr> rO r rM r� r r� rV r/ r5 r r r! �mapr6 Zshutdownr+ �popr� Z
report_numri �_finalize_sos_cmd�_collectrh r[ �hasattrZ_run_extra_cmdZcollect_extra_cmdr� rN r� �create_cluster_archiver� r9 r: r� r� r@ rP r rk rA rB r< r� ) rj r* Z_nodesr� r� Znode_pwdZpoolZnpoolr� �filesrD Zuploaderr@ )r= rC r< � s�
"
zSoSCollector.collectc C sL y |j � W n: tk
rF } z | jd|j� d|� �� W Y dd}~X nX dS )z�Calls 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
)rj r5 r� r@ r@ rC rH * 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 noderm zError running sos report: N)r Z sosreportrV r+ rN r[ r\ )rj r5 r� r@ r@ rC rI 4 s
zSoSCollector._collectc C s4 x.| j D ]$}|jr| jd|j� �� |j� qW dS )z Close all sessions for nodeszClosing connection to N)rM r rb r
r4 )rj r5 r@ r@ rC r� A 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|�} | r�tjjd |jd �d! �}
|
d
7 }
| jj| |
� q�W | jj| jtjjdd�d � | jj| jtjjdd�d � | jdk �r�| jj | jj � | j � |�r"tjj| j| jj �} |j tjj| dd�dd� |j tjj| dd�dd� |j tjj| dd�dd� | jj!| jj �}
tjj| jtjj"|
��}|�rb|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� r@ r� rP r T)rC rD z$ERROR: unable to obfuscate reports: z"Creating archive of sos reports...r� rm )r� Z checksumsz.sha256r8 zsos.logzui.log)Z
short_nameZ sos_reportsz
manifest.jsonz.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 error���rM ))rM Z file_listr� rV r r� r� r@ rP r r� r Zset_target_pathr< r[ r� r� r� Zobfuscate_stringrK rs rc r: Zadd_fileZget_new_checksumZ
add_stringZ sos_log_fileZsos_ui_log_fileZadd_final_manifest_datar Z_obfuscate_upload_passwords�_nameZobfuscate_file�finalize�basename�replace�renamer9 r� r; ri )rj r( Z arc_pathsr3 r� Zdo_cleanrD Zcleanerr� r� r� ZchecksumZ_dirr� Z
final_nameZmap_namer� r@ r@ rC rK H s�
$
z#SoSCollector.create_cluster_archive)Nr F)0r� �
__module__� __qualname__r� ZdescZ arg_defaultsrJ r^ � classmethodrn rv r� r` r� r� ri r] ra rg r� r� r� r\ rb r& r� r� r� r� r r r r! r r r$ r' r* r r6 r7 r< r< rH rI r� rK �
__classcell__r@ r@ )rl rC r ( s� 2 ! b
(& %
0!e
r )#r( r� r� rK r� r� r� rW r� rd r �concurrent.futuresr r Zpathlibr Zshlexr Z sos.cleanerr Zsos.collector.sosnoder Z sos.optionsr r
Z
sos.componentr Z
sos.utilitiesr rp r
Z
sos.uploadr r� r r@ r@ r@ rC �<module>
s.