File: //usr/lib/python3/dist-packages/cloudinit/config/__pycache__/cc_rsyslog.cpython-39.pyc
a
��`|8 � @ s� d Z ddlZddlZddlmZ ddlmZ ddlmZ dZdZ dZ
i Z d Z d
Z
d Zd Zd
ZdZdZe�e�Ze�d�Ze�d�Ze
dfdd�Zdd� Zdd� Zd!dd�Z G dd � d e �Z d"d d �Z d d � Z dS )#a�
.. _cc_rsyslog:
Rsyslog
-------
**Summary:** configure system loggig via rsyslog
This module configures remote system logging using rsyslog.
The rsyslog config file to write to can be specified in ``config_filename``,
which defaults to ``20-cloud-config.conf``. The rsyslog config directory to
write config files to may be specified in ``config_dir``, which defaults to
``/etc/rsyslog.d``.
A list of configurations for rsyslog can be specified under the ``configs`` key
in the ``rsyslog`` config. Each entry in ``configs`` is either a string or a
dictionary. Each config entry contains a configuration string and a file to
write it to. For config entries that are a dictionary, ``filename`` sets the
target filename and ``content`` specifies the config string to write. For
config entries that are only a string, the string is used as the config string
to write. If the filename to write the config to is not specified, the value of
the ``config_filename`` key is used. A file with the selected filename will be
written inside the directory specified by ``config_dir``.
The command to use to reload the rsyslog service after the config has been
updated can be specified in ``service_reload_command``. If this is set to
``auto``, then an appropriate command for the distro will be used. This is the
default behavior. To manually set the command, use a list of command args (e.g.
``[systemctl, restart, rsyslog]``).
Configuration for remote servers can be specified in ``configs``, but for
convenience it can be specified as key value pairs in ``remotes``. Each key
is the name for an rsyslog remote entry. Each value holds the contents of the
remote config for rsyslog. The config consists of the following parts:
- filter for log messages (defaults to ``*.*``)
- optional leading ``@`` or ``@@``, indicating udp and tcp respectively
(defaults to ``@``, for udp)
- ipv4 or ipv6 hostname or address. ipv6 addresses must be in ``[::1]``
format, (e.g. ``@[fd00::1]:514``)
- optional port number (defaults to ``514``)
This module will provide sane defaults for any part of the remote entry that is
not specified, so in most cases remote hosts can be specified just using
``<name>: <address>``.
For backwards compatibility, this module still supports legacy names for the
config entries. Legacy to new mappings are as follows:
- ``rsyslog`` -> ``rsyslog/configs``
- ``rsyslog_filename`` -> ``rsyslog/config_filename``
- ``rsyslog_dir`` -> ``rsyslog/config_dir``
.. note::
The legacy config format does not support specifying
``service_reload_command``.
**Internal name:** ``cc_rsyslog``
**Module frequency:** per instance
**Supported distros:** all
**Config keys**::
rsyslog:
config_dir: config_dir
config_filename: config_filename
configs:
- "*.* @@192.158.1.1"
- content: "*.* @@192.0.2.1:10514"
filename: 01-example.conf
- content: |
*.* @@syslogd.example.com
remotes:
maas: "192.168.1.1"
juju: "10.0.4.1"
service_reload_command: [your, syslog, restart, command]
**Legacy config keys**::
rsyslog:
- "*.* @@192.158.1.1"
rsyslog_dir: /etc/rsyslog-config.d/
rsyslog_filename: 99-local.conf
� N)�log)�subp)�utilz20-cloud-config.confz/etc/rsyslog.d�auto�configsZconfig_filenameZ
config_dirZservice_reload_commandZrsyslog_filenameZ rsyslog_dir�remotesz [ ]*[#]+[ ]*z_^(?P<proto>[@]{0,2})(([\[](?P<bracket_addr>[^\]]*)[\]])|(?P<addr>[^:]*))([:](?P<port>[0-9]+))?$Fc C s> d}| t kr(|r dd|g}q,d|dg}n| }tj|dd� d S )N�rsyslog� systemctlzreload-or-try-restart�service�restartT)�capture)�
DEF_RELOADr )�command�systemdr
�cmd� r �=/usr/lib/python3/dist-packages/cloudinit/config/cc_rsyslog.py�
reload_syslog� s r c C s� | � di �}t| � d�t�rRt| � d�i}t| v r>| t |t< t| v rR| t |t< tg tfttt ftt
t ft t t tfft
ttff}|D ](\}}}||vs�t|| |�s�|||< q�|S )Nr )�get�
isinstance�list�KEYNAME_CONFIGS�KEYNAME_LEGACY_FILENAME�KEYNAME_FILENAME�KEYNAME_LEGACY_DIR� KEYNAME_DIR�DEF_DIR�str� DEF_FILENAME�KEYNAME_RELOADr
�KEYNAME_REMOTES� DEF_REMOTES�dict)�cfg�mycfgZfillup�key�defaultZvtypesr r r � load_config� s" �
r' c
C s� g }t | �D ]�\}}t|t�rNd|vr8t�d|d � q |d }|�d|�}n|}|}|�� }|stt�d|d � q tj� ||�}d}||vr�d}|�
|� z*d} |� d �s�d } t j
||| |d
� W q ty� t �td |� Y q 0 q |S ) N�contentz%No 'content' entry in config entry %s� �filenamez Entry %s has an empty filename�ab�wb� �
)�omodezFailed to write to %s)� enumerater r" �LOG�warningr �strip�os�path�join�append�endswithr �
write_file� Exception�logexc)
r � def_fname�cfg_dir�filesZcur_pos�entr( r* r/ Zendlr r r �apply_rsyslog_changes� s:
�
r@ c C s zt �| �\}}|�� }W n ty6 | d }}Y n0 |�� �� }d }t|�dkrZ|}n"t|�dkrp|\}}n td| ��t�|�}|s�td| ��|�d�}|�d�p�|�d�}|�d�} |�d �r�|� d
�s�td | ��|r�|s�|}t
||||| d �}
|
� � |
S )
Nr) � z line had multiple spaces: %sz Invalid host specification '%s'�proto�addrZ bracket_addr�port�[�]z"host spec had invalid brackets: %s��name�matchrB rC rD ) �
COMMENT_RE�splitr3 �
ValueError�len� HOST_PORT_RErI �group�
startswithr8 �SyslogRemotesLine�validate) �linerH �data�comment�toksrI � host_portrB rC rD �tr r r �parse_remotes_line s6
�rY c @ s. e Zd Zd
dd�Zdd� Zdd� Zdd � ZdS ) rQ Nc C s\ |sd}|| _ || _|s d}|dkr*d}n |dkr6d}|| _|| _|rRt|�| _nd | _d S )Nz*.*�udp�@�@@�tcp)rH rI rB rC �intrD )�selfrH rI rB rC rD r r r �__init__F s zSyslogRemotesLine.__init__c
C s\ | j rJzt| j � W n4 tyH } z td| j �|�W Y d }~n
d }~0 0 | jsXtd��d S )Nzport '%s' is not an integerzaddress is required)rD r^ rL rC )r_ �er r r rR Z s ��zSyslogRemotesLine.validatec C s d| j | j| j| j| jf S )Nz.[name=%s match=%s proto=%s address=%s port=%s]rG )r_ r r r �__repr__f s �zSyslogRemotesLine.__repr__c C s� | j d }| jdkr |d7 }n| jdkr0|d7 }d| jv rN|d| j d 7 }n
|| j7 }| jrl|d | j 7 }| jr�|d
| j 7 }|S ) N� rZ r[ r] r\ �:rE rF z:%sz # %s)rI rB rC rD rH )r_ �bufr r r �__str__k s
zSyslogRemotesLine.__str__)NNNNN)�__name__�
__module__� __qualname__r` rR rb rf r r r r rQ E s �
rQ c C s� | sd S g }|d ur |� |� | �� D ]^\}}|s4q&z|� tt||d��� W q& ty� } z t�d|||� W Y d }~q&d }~0 0 q&|d ur�|� |� d�|�d S )N)rH z!failed loading remote %s: %s [%s]r. )r7 �itemsr rY rL r1 r2 r6 )r �header�footer�linesrH rS ra r r r �remotes_to_rsyslog_cfg s
(
rn c
C s� d|vr|� d| � d S t|�}|t }|t rH|�t|t ddd�� |d s^|� d� d S t|t |t |t d�}|s�|� d � d S z t |t
|j � � d
�f}W n6 t
jy� } z d }|�d | � W Y d } ~ n
d } ~ 0 0 |r�|�� |� d
| |� d S )Nr z;Skipping module named %s, no 'rsyslog' key in configurationz# begin remotesz
# end remotes)rk rl r z.Empty config rsyslog['configs'], nothing to do)r r< r= z0restart of syslog not necessary, no changes made)r r FzFailed to reload syslogz%s configured %s files)�debugr' r r r7 rn r@ r r r r �distro� uses_systemdr �ProcessExecutionErrorr2 �
cycle_logging)
rH r# �cloudr �_argsr$ r ZchangesZ restartedra r r r �handle� sJ ���
�
� "rv )N)NN)!�__doc__r4 �re� cloudinitr �loggingr r r r r
r! r r r r r r r � getLoggerrg r1 �compilerJ rN r r' r@ rY �objectrQ rn rv r r r r �<module> s: -
� (
%: