File: //snap/core20/2669/lib/python3/dist-packages/cloudinit/cmd/devel/__pycache__/logs.cpython-38.pyc
U
\hN7 � @ s4 d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl m Z m
Z
ddl m Z m
Z
mZmZmZmZmZ ddlmZ ddlmZ ddlmZmZ ddlmZ dd l m Z m Z m Z eej e�!e"��Z#G d
d � d e�Z$e$d d
�e$dd�e$dd�gZ%e$dd�e$dd�e$dd�e$dd�e$dd�e$d d �e$d d �e$d d!�e$d"d#�e$d$d%�e$d&d%�e$d'd(�g Z&d^eej' ej'd)�d*d+�Z(ee) ej*e)ee) d,�d-d.�Z+ee) ej*e)dd,�d/d0�Z,ej*ej*e-dd1�d2d3�Z.ej*e-dd4�d5d6�Z/ej*dd7�d8d9�Z0ej*e-dd4�d:d;�Z1e
e)e f eej* d<�d=d>�Z2e�*d?�fej*eej* d@�dAdB�Z3ej*eej* dC�dDdE�Z4ej*eej* dF�dGdH�Z5ej*e
e)e f ej*ej*e-ddI�dJdK�Z6e�*dL�e�*dM�dNfe)e
e)e f ej*ej*e-ddO�dPdQ�Z7e8ddR�dSdT�Z9d_e)e8e-e-ddV�dWdX�Z:e)ej;e8dY�dZd[�Z<e"d\k�r0e�=e<d]e(� �>� �� dS )`zGDefine 'collect-logs' utility and handler to include in cloud-init cmd.� N)�datetime�timezone)�Any�Dict�Iterator�List�
NamedTuple�Optional�cast)�loggers)�Init)�ProcessExecutionError�subp)�tempdir)�copy�get_config_logfiles�
write_filec @ s e Zd ZU eed< eed< dS )�
ApportFile�pathZlabelN)�__name__�
__module__� __qualname__�str�__annotations__� r r �:/usr/lib/python3/dist-packages/cloudinit/cmd/devel/logs.pyr s
r z(/var/log/installer/autoinstall-user-dataZAutoInstallUserDataz/autoinstall.yamlZAutoInstallYAMLz'/etc/cloud/cloud.cfg.d/99-installer.cfgZInstallerCloudCfgz//var/log/installer/ubuntu_desktop_installer.logZUdiLogz-/var/log/installer/subiquity-server-debug.logZSubiquityServerDebugz-/var/log/installer/subiquity-client-debug.logZSubiquityClientDebugz%/var/log/installer/curtin-install.logZ CurtinLogz0/var/log/installer/subiquity-curtin-install.confZCurtinInstallConfigz8/var/log/installer/curtin-install/subiquity-initial.confZCurtinConfigInitialz:/var/log/installer/curtin-install/subiquity-curthooks.confZCurtinConfigCurtHooksz8/var/log/installer/curtin-install/subiquity-extract.confZCurtinConfigExtractz=/var/log/installer/curtin-install/subiquity-partitioning.confZCurtinConfigPartitioningz(/var/log/installer/curtin-error-logs.tarZ CurtinErrorz$/var/log/installer/curtin-errors.tarz(/var/log/installer/block/probe-data.jsonZ ProbeData)�parser�returnc C sh | st jddd�} | jdddddd d
� | jd d d
dd� | jddddddd� | jdddddd� | S )a2 Build or extend and arg parser for collect-logs utility.
@param parser: Optional existing ArgumentParser instance representing the
collect-logs subcommand which will be extended to support the args of
this utility.
@returns: ArgumentParser with proper argument configuration.
z collect-logsz)Collect and tar all cloud-init debug info)�progZ descriptionz --verbosez-v�countr � verbosityzBe more verbose.)�action�default�dest�helpz --tarfilez-tzcloud-init.tar.gzzOThe tarfile to create containing all collected logs. Default: cloud-init.tar.gz)r" r$ z--include-userdataz-uF�
store_true�userdataz?DEPRECATED: This is default behavior and this flag does nothing)r" r! r# r$ z--redact-sensitivez-rz�Redact potentially sensitive data from logs. Sensitive data may include passwords or keys in user data and root read-only files.)r" r! r$ )�argparse�ArgumentParser� add_argument)r r r r �
get_parserO sF ��� �
� r* )�cmd� file_path�msgr c
C s~ |j jddd� zt| �j}W n@ tk
r^ } z"t|t|�� t�d|� d}W 5 d}~X Y n X t||� t�d||j � |S )zCHelper which runs a command and writes output or error to filename.T��parents�exist_ok�collecting %s failed.N�collected %s to file '%s')
�parent�mkdirr �stdoutr
r r �LOG�debug�stem)r+ r, r- �output�er r r � _write_command_output_to_file� s
r; c
C s� |j jddd� z*|�d��}tj| ||d� W 5 Q R X W n< tk
rv } z t|t|�� t� d|� W 5 d}~X Y nX t� d||j
� dS )z�Helper which runs a command and writes output or error to filename.
`subprocess.call` is invoked directly here to stream output to the file.
Otherwise memory usage can be high for large outputs.
Tr. �w)r5 �stderrr1 Nr2 ) r3 r4 �open�
subprocessZcall�OSErrorr r r6 r7 r8 )r+ r, r- �fr: r r r � _stream_command_output_to_file� s rB )r �out_dir�include_sensitiver c C s` | � � rP|s | �� jtj@ rB|jddd� t| |� t�d| � q\t�d| � n t�d| � dS )z-Collect a file into what will be the tarball.Tr. zcollected file: %sz#sensitive file %s was not collectedzfile %s did not existN) �is_file�stat�st_mode�S_IROTHr4 r r6 r7 Ztrace)r rC rD r r r �
_collect_file� s
rI )�log_dirrD r c C sx t D ]2}t�| |jdd� �j}tt�|j�|dd� q|rttD ]2}t�| |jdd� �j}tt�|j�|dd� q@dS )z'Obtain subiquity logs and config files.� NT)rD )�INSTALLER_APPORT_FILES�pathlib�Pathr r3 rI � INSTALLER_APPORT_SENSITIVE_FILES)rJ rD Zsrc_fileZdestination_dirr r r �_collect_installer_logs� s
�
�rP )rJ r c C s@ t ddg| d dd�}t ddddg| d d
d�}|s<|p:d }d S )
z8Include cloud-init version and dpkg version in the logs.z
cloud-initz --version�versionzcloud-init --version�r+ r, r- z
dpkg-queryz--showz-f=${Version}
z dpkg-versionz dpkg versionz
not-availableN)r; )rJ rQ Zdpkg_verr r r �_collect_version_info� s �
�rS c C sT |rt dg| d dd� t ddddg| d d
d� t dd ddgt�| d �d
d� dS )z0Include dmesg and journalctl output in the logs.Zdmesgz dmesg.txtz dmesg outputrR Z
journalctlz--boot=0z-oz
short-precisez journal.txtz systemd journal of current bootz --boot=-1zjournal-previous.txtz systemd journal of previous bootN)rB rM rN )rJ rD r r r �_collect_system_logs� s �
�
�rT )�log_cfgr c c s t | �D ]}t�|�V qdS )z7Get paths for cloud-init.log and cloud-init-output.log.N)r rM rN )rU r r r r �_get_cloudinit_logs� s rV z
/etc/cloud)�
etc_cloud_dirr c # s4 | d | d dg� � fdd�| � d�D �E dH dS )z�Get paths for all files in /etc/cloud.
Excludes:
/etc/cloud/keys because it may contain non-useful sensitive data.
/etc/cloud/templates because we already know its contents
�keysZ templatesz99-installer.cfgc 3 s& | ] }|j � kr|j� kr|V qd S �N)�namer3 )�.0r ��ignorer r � <genexpr> s
�z!_get_etc_cloud.<locals>.<genexpr>z**/*N��glob)rW r r\ r �_get_etc_cloud s
�
�ra )� cloud_dirr c C s: t �| �d�| �d�| �d�dd� | �d�D �| �d��S )zkGet paths for files in /var/lib/cloud.
Skip user-provided scripts, semaphores, and old instances.
zdata/*z
handlers/*zseed/*c s s | ]}|� � r|V qd S rY )rE )r[ �pr r r r^ s z%_get_var_lib_cloud.<locals>.<genexpr>z
instance/*zinstance/handlers)� itertools�chainr` �rb r r r �_get_var_lib_cloud s �rg )�run_dirr c C s
| � d�S )z�Get all paths under /run/cloud-init except for hook-hotplug-cmd.
Note that this only globs the top-level directory as there are currently
no relevant files within subdirectories.
�*r_ �rh r r r � _get_run_dir$ s rk )rJ rU rh rb rD r c C s� t | � t| |� t| |� t|�D ]"}t|| t�|�j�d� d� q$t �
t � t |d�t
|d��D ]"}t|| t�|�j�d� |� qddS )z8Collect all cloud-init logs into the provided directory.�/Trf rj N)rS rT rP rV rI rM rN r3 � relative_tord re ra rg rk )rJ rU rh rb rD Zlogfiler r r �_collect_logs_into_tmp_dir- s&
���rn z/run/cloud-initz/var/lib/cloudT)�tarfilerU rh rb rD r c C s� t j�| �} t�tj��� �d�}t |d��J}t
� ||�}t |||||d� t
dd| d|t|��|� d�d�g� W 5 Q R X t�d | � d
S ) a� Collect all cloud-init logs and tar them up into the provided tarfile.
:param tarfile: The path of the tar-gzipped file to create.
:param log_cfg: The cloud-init base configuration containing logging cfg.
:param run_dir: The path to the cloud-init run directory.
:param cloud_dir: The path to the cloud-init cloud directory.
:param include_sensitive: Boolean, true means include sensitive data.
zcloud-init-logs-%Y-%m-%d)�dir)rJ rU rh rb rD ZtarZczfz-Crl � zWrote %sN)�osr �abspathr Znowr Zutc�date�strftimer rM rN rn r r �replacer6 �info)ro rU rh rb rD Zdir_nameZtmp_dirrJ r r r � collect_logsN s, � ���
rx )r r c C s^ t �� | dkrtj}n| dkr(tj}nt j}t�|� t�� }|� t�
d�� t� |� dS )z�Set up the logger for CLI use.
The verbosity controls which level gets printed to stderr. By default,
DEBUG and TRACE are hidden.
r rK z %(message)sN) r Z
reset_logging�logging�INFO�DEBUGZTRACEr6 ZsetLevelZ
StreamHandlerZ setFormatterZ FormatterZ
addHandler)r �levelZhandlerr r r �
_setup_loggerw s
r} F)ro r �redact_sensitive�include_userdatar c C sx t |� t�� dkr td��|r*t�d� tg d�}|�� t| |j t
� |j j
�t
� |j j�| d� |stt�d� dS )z:Handle calls to 'cloud-init collect-logs' as a subcommand.r z!This command must be run as root.z;The --include-userdata flag is deprecated and does nothing.)Zds_deps)ro rU rh rb rD z�WARNING:
Sensitive data may have been included in the collected logs.
Please review the contents of the tarball before sharing or
rerun with --redact-sensitive to redact sensitive data.N)r} rr �getuid� RuntimeErrorr6 Zwarningr Zread_cfgrx ZcfgrM rN �pathsrh rb )ro r r~ r Zinitr r r �collect_logs_cli� s( �
��r� )�_name�argsr c
C sd t � �� }z t|j|j|j|jd� W dS tk
r^ } zt|t j
d� W Y �dS d}~X Y nX dS )z}Handle the CLI interface to the module.
Parse CLI args, redirect all exceptions to stderr, and return an exit code.
)r ro r~ r r )�filerK N) r* �
parse_argsr� r ro r~ r& � Exception�print�sysr= )r� r� r: r r r �handle_collect_logs_args� s
�r� �__main__rq )N)r TF)?�__doc__r' rd ry rr rM rF r? r� r r �typingr r r r r r r
Z
cloudinit.logr Zcloudinit.stagesr Zcloudinit.subpr
r Zcloudinit.temp_utilsr Zcloudinit.utilr r r ZCustomLoggerTypeZ getLoggerr r6 r rO rL r( r* r rN r; rB �boolrI rP rS rT rV ra rg rk rn rx �intr} r� Z Namespacer� �exitr� r r r r �<module> s $ �� � �������& �� :� � � � �
� ��
� $�
� ) �� !