/usr/lib/python3/dist-packages/sos/collector/__pycache__
Edit: /usr/lib/python3/dist-packages/sos/collector/__pycache__/sosnode.cpython-310.pyc (29093B)
o
G%@i͗ @ s d dl Z d dlZd dlZd dlZd dlZd dlmZ d dlmZ d dl m
Z
d dl m Z d dl
mZ d dlmZ d dlmZ d d lmZ d d
lmZmZmZmZ d d lmZ eeeee d Z G d
d dZ dS ) N)quote)load)
InitSystem)JujuSSH)SSHControlPersist)LocalTransport) OCTransport)SaltStackMaster)CommandTimeoutExceptionConnectionExceptionUnsupportedHostExceptionInvalidTransportException)sos_parse_version)localcontrol_persistoc saltstackjujuc @ s e Zd Z dhddZedd Zdd Zd d
Zd d Zed
d Z dd Z
dd Z dd Z dd Z
diddZedd Zd d Zd d Zd d! Zd"d# Zd$d% Zd&d' Zd(d) Zd*d+ Zd,d- Zdid.d/Zd0d1 Zd2d3 Zd4d5 Z d6d7 Z djd:d;Z d
d? Z d@dA Z!dBdC Z"dDdE Z#dFdG Z$dHdI Z%dJdK Z&dLdM Z'dNdO Z(dPdQ Z)dRdS Z*dTdU Z+dVdW Z,dXdY Z-dZd[ Z.d\d] Z/d^d_ Z0d`da Z1dbdc Z2ddde Z3dfdg Z4dS )kSosNodeNTc
C s | | _|| _|d | _| |d | _|d | _|d | _|d | _| jj | _ | jj
| _
d| _ d | _ d | _
d | _i | _i | _|pF| jj| _| jjsU| jjsU| j| j_|r[|| j_d | _d| _d| _g | _d g g g g |d d| _d | _t d
| _ t d | _ | || _ | j j!r| j j!d k| _z | j "| j W n t#y } z | $d
| d }~ww | % | _ | j j| _| j r| jj&rd}| j'r|r| j s| j ( d S | j r| ) rd| j _*| j j*r| + | , d S )N cmdlineoptstmpdirhostlen need_sudo sos_optionsFsos_cmd)versionenableddisabledoptionspresetsr sosreportsossos_uirootz Unable to open remote session: )-stripaddresscommonsopts_assign_config_optsr r r r node_config_fileinherit_config_filer hostclusterhostname sos_env_vars _env_varspassword _password
nopasswd_sudosudo_pwsos_path retrievedhash_retrieved file_listsos_infosos_binlogging getLoggersoslogui_log_load_remote_transport
_transport default_userconnect Exception log_errordetermine_host_policyno_local connected
disconnectcheck_in_container
containerizedcreate_sos_container_load_sos_info)selfr% r& r0
local_sudo
load_factserr rP 7/usr/lib/python3/dist-packages/sos/collector/sosnode.py__init__, sx
zSosNode.__init__c C s | j r| j jS dS )NT)r? rF rL rP rP rQ rF q s zSosNode.connectedc C s | j dS )zDWrapper to close the remote session via our transport agent
N)r? rG rS rP rP rQ rG x s zSosNode.disconnectc C st | j dv rd| _t| j |S | jjtv r t| jj | j |S | jjdkr4| d| jj t| jjt| j |S )zDetermine the type of remote transport to load for this node, then
return an instantiated instance of that transport
) localhostz 127.0.0.1Tautoz4Connection failed: unknown or unsupported transport ) r% r r r' transport
TRANSPORTSrC r
r )rL r& rP rP rQ r> } s
z SosNode._load_remote_transportc C s | j d| jd d| S )N< z : ) _hostnamer rL msgrP rP rQ _fmt_msg s zSosNode._fmt_msgc C sp | j s5| jrtj | _ | j S | d}|d dkr5|d dD ]}|s&q!|d}|d | j |d < q!| j S )Nz
env --nullstatusr output =rY )r/ r osenvironcopy run_commandsplit)rL retln_valrP rP rQ env_vars s
zSosNode.env_varsc C s` || _ | j d| j | j d| jj | j d| jd | j dd | j d| jj dS ) z>Set the manifest section that this node will write to
r- policy sos_versionr final_sos_command rV N)manifest add_fieldrZ r+ os_release_namer8 r? name)rL ro rP rP rQ set_node_manifest s zSosNode.set_node_manifestc C s< t jdr
| d dS t jddur | d dS dS )zV
Tries to identify if we are currently running in a container or not.
z/run/.containerenvz/Found /run/.containerenv. Running in container.T containerNz/Found env var 'container'. Running in containerF)rb pathexists log_debugrc getrS rP rP rQ rH s
zSosNode.check_in_containerc C s | j jru| j j| jj| | jjd}| j|dd}|d dv ri|d dkr@d|d v r3| d t d
|d v r@| d t | j| j
dd}|d d kr]| d
| j j d dS | d|d t | d|d t dS )zJIf the host is containerized, create the container we'll be using
)imageauth
force_pullT need_rootr^ )r } r~ z unable to retrieve auth tokenr_ zHCould not pull image. Provide either a username and password or authfilezunknown: Not foundz%Specified image not found on registryr zTemporary container z createdz(Could not start container after create: z$Could not create container on host: F)
r+ rI rJ r' ry get_container_authforce_pull_imagere rC rB restart_sos_containerlog_infosos_container_name)rL cmdresrg rP rP rQ rJ sD
z SosNode.create_sos_containerc C sB | j jr| jjd | j j| j jS | jjd | j jp | jjS )zrDetermine what the auth string should be to pull the image used to
deploy our temporary container
default) r'
registry_userr+ runtimesfmt_registry_credentialsregistry_passwordfmt_registry_authfileregistry_authfilecontainer_authfilerS rP rP rQ r s zSosNode.get_container_authFc C s8 z| j d| |d}|d dkW S ty Y dS w )z3Checks for the presence of fname on the remote nodezstat r| r^ r F)re rB )rL fnamer} r rP rP rQ file_exists s zSosNode.file_existsc C s | j r d| j vr | j S | jS )NrT )r- r% rS rP rP rQ rZ s zSosNode._hostnamec C s d}t |d|S )zUAttempts to obfuscate sensitive information in log messages such as
passwordsz>(?P(pass|key|secret|PASS|KEY|SECRET).*?=)(?P.*?\s)z\g****** )resub)rL r\ regrP rP rQ _sanitize_log_msg s zSosNode._sanitize_log_msgc C s | j | | dS )z:Format a ui message that includes host name and formattingN)r= infor] r[ rP rP rQ ui_msg s zSosNode.ui_msgc C 8 t d d }d| j d| d| }| j| dS )z#Used to print and log info messagesrY [:] N)inspectstackrZ r< r rL r\ callerlmsgrP rP rQ r zSosNode.log_infoc C r )z$Used to print and log error messagesrY r r r r N)r r rZ r< errorr rP rP rQ rC r zSosNode.log_errorc C sB | |}t d d }d| j d| d| }| j| dS )z$Used to print and log debug messagesrY r r r r N)r r r rZ r< debug)rL r\ r rP rP rQ rw s
zSosNode.log_debugc C sR | j dtjddk}| jr|r|S | jjr dt| S | jr'd| S |S )zIf we need to provide a sudo or root password to a command, then
here we prefix the command with the correct bits
USERr# zsu -c zsudo -S ) r/ rx rb rc r r' become_rootr r )rL r is_rootrP rP rQ _format_cmd s
zSosNode._format_cmdc
C s d}d}| j jdu r'| j j| j j}|dur&d|d }|d r&|d }n | j| j jddd}|d dkrC|d d
\}}}|r{t |dd krR|d 7 }z|d
|dd 7 }W n t
yz } z| d
| W Y d}~nd}~ww || j d< | j d r|
d| j d n| j| jjks| d d| _dS | drd| _| j d}| j|ddd}|d dkr| |d | dr| dS )zLQueries the node for information about the installed version of sos
N.r releaseT
use_containerr} r^ r r_ - z.0z#Unable to fully parse sos release: zsos version is z!sos is not installed on this nodeFz4.0z
sos reportz -l3.6)r+ container_version_commandpackage_manager pkg_version sos_pkg_namejoinre r$ rf lenrB rw r8 r r% r' primaryrC rF check_sos_versionr9 _load_sos_plugins_load_sos_presets) rL verrelpkgpkgs_rO r sosinforP rP rQ rK # sN
zSosNode._load_sos_infoc C sr | j d}| j|ddd}|d dkr5|d D ] }| dr4|dd }| jd | qd S d S )
Nz --list-presetsTr r^ r r_ zname:rY r )r9 re
splitlinesr$
startswithrf r8 append)rL r r linepnamerP rP rQ r W s zSosNode._load_sos_presetsc C s d}d}d}d}d}|d | }|d | }|d | } |d d }
| ||| jd< | ||| jd < | | || jd
< | |
|d | jd < d S )
Nz,The following plugins are currently enabled:z-The following plugins are currently disabled:z4The following options are available for ALL plugins:z+The following plugin options are available:z Profiles:z(.*?)z
r r r Tprofiles)_regex_sos_helpr8 ) rL r ENABLEDDISABLED ALL_OPTIONSOPTIONSPROFILES enableregdisregoptregproregrP rP rQ r ` s zSosNode._load_sos_pluginsc
C s g }t ||t jD ]D}| D ]=}|s>z| }r"||d W q ty= } z| d| W Y d }~qd }~ww |d} |dd | D qq
|S )Nr zError parsing sos help: ,c s s | ] }| r| V qd S N)r$ ).0prP rP rQ } s z*SosNode._regex_sos_help..) r findallSr rf r rB rw extend)
rL regexr is_listr resultr lsrO rrP rP rQ r q s
zSosNode._regex_sos_helpc
C s\ z| d| | j|W S ty- } z| d| d| W Y d}~dS d}~ww )z1Reads the specified file and returns the contentsz
Reading file zException while reading : Nrn )r r? read_filerB rC )rL to_readrO rP rP rQ r s zSosNode.read_filec C sv | j r| d| jd j | jd S ti | jjt d| jj |
dd}|r4| d|j d |S | d t ) z[Attempts to identify the host installation against supported
distributions
zusing local policy rk Tz/etc/os-release)cachesysrootinit
probe_runtime remote_exec remote_checkzloaded policy z for hostz4Unable to determine host installation. Ignoring node)
r r r& rq r r' r r r? re r rC r )rL r+ rP rP rQ rD s
z SosNode.determine_host_policyc
C sT z| j d }t|t|kW S ty) } z| d| W Y d}~dS d}~ww )a Checks to see if the sos installation on the node is AT LEAST the
given ver. This means that if the installed version is greater than
ver, this will still return True
:param ver: Version number we are trying to verify is installed
:type ver: ``str``
:returns: True if installed version is at least ``ver``, else False
:rtype: ``bool``
r z Error checking sos version: NF)r8 r rB rC )rL r _node_verrO rP rP rQ r s
zSosNode.check_sos_versionc C s | j sdS | j j|duS )z2Checks if a given package is installed on the nodeFN)r+ r pkg_by_name)rL r rP rP rQ is_installed s zSosNode.is_installed rU c
C s | j s3| js3| d z| j| j}|s | d tW n ty2 } z | d| d}~ww |r?| jj r?| j
|}|rF| |}|rP| j } |
|}| j|||||S )a Runs a given cmd, either via the SSH session or locally
:param cmd: The full command to be run
:type cmd: ``str``
:param timeout: Time in seconds to wait for `cmd` to complete
:type timeout: ``int``
:param use_shell: If a shell is needed to run `cmd`, set to True
:type use_shell: ``bool`` or ``auto`` for transport-determined
:param use_container: Run this command in a container *IF* the host
is a containerized host
:type use_container: ``bool``
:param env: Pass environment variables to set for this `cmd`
:type env: ``dict``
z-Node is disconnected, attempting to reconnectzFailed to reconnect to nodez!Error while trying to reconnect: N)rF r rw r? reconnectr1 r rB r+ rI format_container_commandr rj updatere )
rL r timeout use_shellr} r env reconnectedrO _cmd_envrP rP rQ re s.
zSosNode.run_commandc
C sx z| }|r
| | n| d | jr| | _W n ty5 } z| d| W Y d}~nd}~ww | dS )z.Run an sos report on the node, then collect itz'Unable to determine path of sos archivez Error during sos execution: N)execute_sos_commandfinalize_sos_pathrC r4 retrieve_sosreportr5 rB cleanup)rL ru rO rP rP rQ r s
zSosNode.sosreportc C || j d v S )z/Verifies if the given preset exists on the noder r8 )rL presetrP rP rQ _preset_exists zSosNode._preset_existsc s& t fdd| jd | jd fD S )z/Verifies if the given plugin exists on the nodec 3 | ]} |v V qd S r rP )r spluginrP rQ r z)SosNode._plugin_exists..r r )anyr8 rL r rP r rQ _plugin_exists s
zSosNode._plugin_existsc C r )z6Checks to see if the plugin is default enabled on noder r r rP rP rQ _check_enabled r zSosNode._check_enabledc C r )z7Checks to see if the plugin is default disabled on noder r r rP rP rQ _check_disabled r zSosNode._check_disabledc C sR | dd }| |sdS | |r|| jjvrdS | |r'|| jd v S dS )zAttempts to verify that the given option is available on the node.
Note that we only get available options for enabled plugins, so if a
plugin has been force-enabled we cannot validate if the plugin option
is correct or notr r Fr T)rf r r r' enable_pluginsr r8 )rL optplugrP rP rQ _plugin_option_exists s
z SosNode._plugin_option_existsc s d fdd|D S )z^Returns a comma delimited list for sos plugins that are confirmed
to exist on the noder c 3 s | ]
} |r|V qd S r r r orS rP rQ r s z,SosNode._fmt_sos_opt_list..)r )rL r' rP rS rQ _fmt_sos_opt_list s zSosNode._fmt_sos_opt_listc C s
|| _ dS )zVExpose the node to the cluster profile determined for the
environment
N)r, )rL r, rP rP rQ set_cluster s
zSosNode.set_clusterc s^ | j jr| js
| j j| _n | d| j j d | j jr.| j jD ]
}|| jvr-| j| q | j jrG| j jD ] | jvrF| j j | j < q6| j jro| j jD ] t fdd| j
D sn d| j j }| j
| qO| j | r| j j | j
| W d dS 1 sw Y dS | j j | j | W d dS 1 sw Y dS )a+ This is used to modify the sos report command run on the nodes.
By default, sos report is run without any options, using this will
allow the profile to specify what plugins to run or not and what
options to use.
This will NOT override user supplied options.
zCluster specified preset z> but user has also defined a preset. Using user specification.c 3 r r rP r r rP rQ r 2 r z2SosNode.update_cmd_from_cluster..ra N)r,
sos_presetr r sos_pluginsr r r sos_plugin_optionsr plugoptscheck_node_is_primarylockset_primary_optionsset_node_options)rL r optionrP r rQ update_cmd_from_cluster s:
"
"z SosNode.update_cmd_from_clusterc C sJ t | jj| _t | jj| _t | jj| _t | jj| _t | jj| _dS )zFrom the global opts configuration, assign those values locally
to this node so that they may be acted on individually.
N)listr' only_plugins skip_pluginsr r r rS rP rP rQ r( > s
zSosNode._assign_config_optsc s j d } }|r| dt| d}g } dr0 jjdkr0|dtt jj drG jjrG|dtt jj drn jj rU|d jj
r^|d
jj rn|d t jj d r jj r|d
td
jj jjr|dtd
jj dr jjr|dtt jj ds dr؈ jjdkr|d jj jjr|d jj dr jjr|d jj jjr|d |dtj
jj j} jD ]} j| }|d| d|r|nd q j rE fd d j D }|rE|d td
d d! |D j rf j r\|d"t j n
d# j d$ j rÇ fd%d j D }t!|t! j krt"t# j t#| } d&| d' $ j } | r|d(t| | dd
| _% &d) j% j'(d* j% d+S j)r fd,d j)D }
t!|
t! j)krt"t# j)t#|
} d-| d. $|
} | r|d/t| j*r? fd0d j*D }t!|t! j*kr-t"t# j*t#| }
d1|
d2 $|}|r?|d3t| | dd
| _% &d) j% j'(d* j% d+S )4zZUse host facts and compare to the cluster type to modify the sos
command if neededr r z
--threads=z3.7z--plugin-timeout=z3.8z--allow-system-changesz
--no-env-varsz--since=z4.1z--skip-commands=r z
--skip-files=z4.2z--cmd-timeout=z4.3z4.2-13rU z--container-runtime=z
--namespaces=z4.5.2z--journal-size=z--low-priorityr z--rn c s8 g | ]} |d d r |dd r|qS )r r ra )r rf r r rS rP rQ
s
z,SosNode.finalize_sos_cmd..z-k c s s | ]}|V qd S r rP r rP rP rQ r s z+SosNode.finalize_sos_cmd..z --preset=zRequested to enable preset z" but preset does not exist on nodec g | ] } |r|qS rP r r rS rP rQ r zRequested plugins z. were requested to be enabled but do not existz--only-plugins=zFinal sos command set to rm Nc r rP )r r rS rP rQ r r zRequested to skip plugins z%, but plugins are already not enabledz--skip-plugins=c s. g | ]}| j vr |r |r|qS rP )r r r r rS rP rQ r s
z Requested to enable plugins z1, but plugins are already enabled or do not existz--enable-plugins=)+r8 determine_sos_labelr r r' threadsr strplugin_timeoutallow_system_changes no_env_varssince
skip_commandsr
skip_files cmd_timeoutcontainer_runtime
namespaces journal_size low_priorityr replacerb ru r+ sos_bin_pathr9 r r r r rw r r r setr
r r ro rp r r )rL r labelsos_optsr ri r' plugsnot_onlyonlyskipnot_skipskiplnnot_onenablerP rS rQ finalize_sos_cmdI s
$$
zSosNode.finalize_sos_cmdc C s d}|| j | 7 }| jjr ||s| jj nd| jj 7 }|s"dS | d| | dr2d}nd}| jdd d| }| d
| S ) z?Determine what, if any, label should be added to the sos reportrn r Nz Label for sos report set to r z--labelz--namer r ra )r, get_node_labelr' r0 rw r r% rf )rL r0 lcmdrP rP rQ r s
zSosNode.determine_sos_labelc C s^ | j j}|r ||d}| d }| d| || _|dd | _| jd| j dS )z\Use host facts to determine if we need to change the sos path
we are retrieving fromrn r zFinal sos path: /collected_archiveN) r+ sos_path_stripr- rf r r4 archivero rp )rL ru pstriprP rP rQ r s zSosNode.finalize_sos_pathc C sT |dkrdS |dkrd|v rdS |dkrdS t |dkr%|d dd S d
| S ) Nr> z+sos report process received SIGKILL on noderY sudozsudo attempt failed z4sos report terminated unexpectedly. Check disk spacer
zsos exited with code )r rf )rL rcstdoutrP rP rQ determine_sos_error s
zSosNode.determine_sos_errorc
C s | d zd}d}d}| jjrd| jj }n)| jjrA| js:d| jdd d}| j| jj | d| }nd| jj }|rL| j
d | | _
| j | j
| jj d
d
d
| j
d }|d d
kr|d D ]$}t|drs| }|dr|dd }qg|dr| d }qg|r| jd| t|dkr| jdd |W S t|dkr| jdd |W S | jdd |W S | jdd |W S | |d |d }| d |d d |d t| ty | d ty } z| d | | d | d!}~ww )"z2Run sos report and capture the resulting file pathzGenerating sos report...Frn z--config-file=z/tmp/r= r> z.confr T)r r r} r r r^ r r_ z*sosreport-*tar*)z sha256 z md5 rY zThe checksum is: r checksum
checksum_typemd5@ sha256unknownz Error running sos report. rc = z msg = zTimeout exceededz'Exception during sos report execution: zError running sos report: N)r r' r) r* r r rf r? copy_file_to_remote config_filer re r r. r fnmatchr$ r ro rp r rH rw rB r
rC r )rL ru rJ config_file_arg
remote_configr r rO rP rP rQ r s~
zSosNode.execute_sos_commandc
C s | j d }tj||dd }z$| |r*| d| d| | j||W S | d| d W dS t
yS } z| d| d | W Y d
}~dS d
}~ww ) z7Copies the specified file from the host to our temp dirr= r> zCopying remote z
to local z Attempting to copy remote file %, but it does not exist on filesystemFzFailed to retrieve r N) r rb ru r rf r r r?
retrieve_filerw rB )rL ru destdirdestrO rP rP rQ rW 5 s
zSosNode.retrieve_filec
C s d | }zAt|ddkr | d| d W dS | |r=| d| d| }| j|d d
}|d d kW S | d
| d W dS tyf } z| d| d| W Y d}~dS d}~ww )z|Removes the spciefied file from the host. This should only be used
after we have retrieved the file already
rn r= r zRefusing to remove path z0: appears to be incorrect and possibly dangerousFzRemoving file zrm -f Tr| r^ r z!Attempting to remove remote file rV zFailed to remove r N)r rf r rw r r re rB )rL ru r r erP rP rQ remove_fileD s"
zSosNode.remove_filec
C s | j s| jjr z| | j W n ty | d Y dS w | d| j | d z|
| j}W n tyM } z | | W Y d}~dS d}~ww |rc| d | j | j
dd d S | d
dS ) z,Collect the sos report archive from the nodez Failed to make archive readableFzRetrieving sos report from zRetrieving sos report...Nz!Successfully collected sos reportr= r> Tz Failed to retrieve sos report)r r' r make_archive_readabler4 rB rC r r% r rW r7 r rf )rL rg rO rP rP rQ r Z s,
zSosNode.retrieve_sosreportc C sX | j du s| jr
dS d| j vr| d| j d dS | | j }|s*| d dS dS )zvRemove the sos report archive from the node, since we have
collected it and it would be wasted space otherwiseNr zNode sos report path z/ looks incorrect. Not attempting to remove pathzFailed to remove sos report)r4 r rw r[ rC )rL removedrP rP rQ remove_sos_archivep s
zSosNode.remove_sos_archivec C sP | | jrdD ] }| | j| r nq | j }|r&| j|dd dS dS )z z/Error collecting additional data from primary: ) r r' r r\ rB rC rw rW r7 r rf r[ )rL filenamesfilenamerO rg rZ r\ rP rP rQ collect_extra_cmd s2
zSosNode.collect_extra_cmdc C sH d| }| j |ddd}|d dkrdS d}| |||d f t)zUsed to make the given archive world-readable, which is slightly
better than changing the ownership outright.
This is only used when we're not connecting as root.
z
chmod o+r
T)r r} r^ r z6Exception while making %s readable. Return code was %s)re rC rB )rL filepathr r r\ rP rP rQ r\ s
z SosNode.make_archive_readable)NNT)F)r rU FFN)5__name__
__module__ __qualname__rR propertyrF rG r> r] rj rs rH rJ r r rZ r r r rC rw r rK r r r r rD r r re r r r r r r r
r r r( r: r r rH r rW r[ r r^ r rc r\ rP rP rP rQ r * st
E
(
4
(( < r ) rS r r: rb r shlexr sos.policiesr sos.policies.init_systemsr sos.collector.transports.jujur (sos.collector.transports.control_persistr sos.collector.transports.localr sos.collector.transports.ocr "sos.collector.transports.saltstackr sos.collector.exceptionsr
r r r
sos.utilitiesr rW r rP rP rP rQ s,