3
\�me�5 �
@ s� U d Z ddlZddlZddlZddlZddlZddlmZ ddlm Z m
Z
m Z ddl m
Z
ddlmZ ddlmZmZ ddlmZmZ dd lmZ d
Zd d d
eegeed�ed�ed�gdgd�Zeee�Z dddi i ddgdd�Zddgd�ddgd�d dgd�d �Zej e �Z ej d �Z ej d �Z!ed �d!d"�Z"d8d#d$�Z#d9d%d&�Z$e%ee%d'�d(d)�Z&d*d+� Z'd:d,d-�Z(G d.d/� d/�Z)d;d0d1�Z*e
dd2�d3d4�Z+e,ee
e-dd5�d6d7�Z.dS )<z-Rsyslog: Configure system logging via rsyslog� N)�dedent)�log�subp�util)�Cloud)�Config)�
MetaSchema� get_meta_doc)� ALL_DISTROS�Distro)� PER_INSTANCEam This module configures remote system logging using rsyslog.
Configuration for remote servers can be specified in ``configs``, but for
convenience it can be specified as key value pairs in ``remotes``.
This module can install rsyslog if not already present on the system using the
``install_rsyslog``, ``packages``, and ``check_exe`` options. Installation
may not work on systems where this module runs before networking is up.
.. note::
On BSD cloud-init will attempt to disable and stop the base system syslogd.
This may fail on a first run.
We recommend creating images with ``service syslogd disable``.
Z
cc_rsyslogZRsyslogz$Configure system logging via rsyslogz� rsyslog:
remotes:
maas: 192.168.1.1
juju: 10.0.4.1
service_reload_command: auto
a7 rsyslog:
config_dir: /opt/etc/rsyslog.d
config_filename: 99-late-cloud-config.conf
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]
a # default (no) configuration with package installation on FreeBSD
rsyslog:
config_dir: /usr/local/etc/rsyslog.d
check_exe: "rsyslogd"
packages: ["rsyslogd"]
install_rsyslog: True
�rsyslog)�id�name�title� descriptionZdistrosZ frequencyZexamplesZactivate_by_schema_keysz/etc/rsyslog.dz20-cloud-config.conf�autoZrsyslogdF)�
config_dir�config_filename�service_reload_command�remotes�configs� check_exe�packages�install_rsyslogz/usr/local/etc/rsyslog.d)r r zsysutils/rsyslogz/usr/pkg/etc/rsyslog.d)ZfreebsdZopenbsdZnetbsdz [ ]*[#]+[ ]*z_^(?P<proto>[@]{0,2})(([\[](?P<bracket_addr>[^\]]*)[\]])|(?P<addr>[^:]*))([:](?P<port>[0-9]+))?$)�distroc C s4 t }tjt�}| j|kr0tj||| j gdd�}|S )z�Construct a distro-specific rsyslog config dictionary by merging
distro specific changes into base config.
@param distro: String providing the distro class name.
@returns: Dict of distro configurations for ntp clients.
T)�reverse)�DISTRO_OVERRIDES�copy�RSYSLOG_CONFIGZosfamilyr Z
mergemanydictr )r Zdcfg�cfg� r! � /usr/lib/python3.6/cc_rsyslog.py� distro_default_rsyslog_config� s
r# c C s( t j|�rdS |dkr dg}| |� dS )ai Install rsyslog package if not already installed.
@param install_func: function. This parameter is invoked with the contents
of the packages parameter.
@param packages: list. This parameter defaults to ['rsyslog'].
@param check_exe: string. The name of a binary that indicates the package
the specified package is already installed.
Nr
)r Zwhich)Z install_funcr r r! r! r" r � s
r c C s. |dkr | j dd�}| jd|�S tj|dd�S )Nr �rsyslog_svcnamer
z
try-reloadT)Zcapture)�
get_option�manage_servicer )r �command�servicer! r! r" �
reload_syslog� s r) )r r �returnc
C s& | j di �}t|�}t| j d�t�rhtjddd� d| j d�i}d| krT| d |d< d| krh| d |d < dg tfd |d tfd|d tfd
|d
tfd |d ttffd |d tfd
|d
tfd|d tff}xT|D ]L\}}}||kr�|||< q�t|| |�s�t d|� d|� dt
|| �� ���q�W |S )z�Return an updated config.
Support converting the old top level format into new format.
Raise a `ValueError` if some top level entry has an incorrect type.
r
z)The rsyslog key with value of type 'list'z22.2)Z
deprecatedZdeprecated_versionr Zrsyslog_filenamer Z rsyslog_dirr r r r r r zInvalid type for key `z`. Expected type(s): z. Current type: ) �getr# �
isinstance�listr Z deprecate�str�dict�bool�
ValueError�type)r r �mycfgZ
distro_configZfillup�key�defaultZvtypesr! r! r" � load_config� s8
$r6 c
C s� g }x�t | �D ]�\}}t|t�rPd|kr:tjd|d � q|d }|jd|�}n|}|}|j� }|svtjd|d � qtjj ||�}d}||kr�d}|j
|� y*d} |j d �s�d } t j
||| |d
� W q tk
r� t jtd |� Y qX qW |S ) N�contentz%No 'content' entry in config entry %s� �filenamez Entry %s has an empty filenameZab�wb� �
)�omodezFailed to write to %s)� enumerater, r/ �LOG�warningr+ �strip�os�path�join�append�endswithr Z
write_file� ExceptionZlogexc)
r � def_fname�cfg_dir�filesZcur_posZentr7 r9 r= Zendlr! r! r" �apply_rsyslog_changes� s8
rK c C s yt j| �\}}|j� }W n tk
r8 | d }}Y nX |j� j� }d }t|�dkr\|}n"t|�dkrr|\}}n td| ��tj|�}|s�td| ��|jd�}|jd�p�|jd�}|jd�} |jd �r�|j d
� r�td | ��|r�| r�|}t
||||| d �}
|
j � |
S )
Nr8 � z line had multiple spaces: %sz Invalid host specification '%s'�proto�addrZ bracket_addr�port�[�]z"host spec had invalid brackets: %s)r �matchrM rN rO ) �
COMMENT_RE�splitrA r1 �len� HOST_PORT_RErR �group�
startswithrF �SyslogRemotesLine�validate) �liner �dataZcommentZtoksrR Z host_portrM rN rO �tr! r! r" �parse_remotes_line� s4
r^ c @ s. e Zd Zd
dd�Zdd� Zdd� Zdd � ZdS ) rY Nc C s\ |sd}|| _ || _|s d}|dkr*d}n |dkr6d}|| _|| _|rRt|�| _nd | _d S )Nz*.*�udp�@z@@�tcp)r rR rM rN �intrO )�selfr rR rM rN rO r! r! r" �__init__& s zSyslogRemotesLine.__init__c C sZ | j rHyt| j � W n2 tk
rF } ztd| j �|�W Y d d }~X nX | jsVtd��d S )Nzport '%s' is not an integerzaddress is required)rO rb r1 rN )rc �er! r! r" rZ ; s
zSyslogRemotesLine.validatec C s d| j | j| j| j| jf S )Nz.[name=%s match=%s proto=%s address=%s port=%s])r rR rM rN rO )rc r! r! r" �__repr__G s zSyslogRemotesLine.__repr__c C s� | j d }| jdkr |d7 }n| jdkr0|d7 }d| jkrN|d| j d 7 }n
|| j7 }| jrl|d | j 7 }| jr�|d
| j 7 }|S ) N� r_ r` ra z@@�:rP rQ z:%sz # %s)rR rM rN rO r )rc Zbufr! r! r" �__str__P s
zSyslogRemotesLine.__str__)NNNNN)�__name__�
__module__� __qualname__rd rZ rf ri r! r! r! r" rY % s
rY c C s� | sd S g }|d k r |j |� xh| j� D ]\\}}|s6q(y|j tt||d��� W q( tk
r� } ztjd|||� W Y d d }~X q(X q(W |d k r�|j |� dj|�d S )N)r z!failed loading remote %s: %s [%s]r< )rE �itemsr. r^ r1 r? r@ rD )r �header�footer�linesr r[ re r! r! r" �remotes_to_rsyslog_cfgd s
&
rq )�cloudr* c C sv y| j jdd� W n tjk
r( dS X | j jdd� | j j� tjtj�� | j jdd� tjd� W dQ R X dS )z�
This helper function bundles the necessary steps to disable BSD base syslog
``rc(8)`` reads its configuration on start, so after disabling syslogd, we
need to tell rc to reload its config
ZenabledZsyslogdN�disableZonestopzOsyslogd is running before cloud-init! Please report this as bug to the porters!) r r& r �ProcessExecutionErrorZ reload_init�
contextlib�suppressr? �error)rr r! r! r" � disable_and_stop_bsd_base_syslogv s
rx )r r rr �argsr* c
C s^ d|krt jd| � d S t||j�}|d }|d rL|jt|d ddd�� |jjdd�}|d d
kr�t|jj|d |d d
� t j
� r�|jj d|� t |� |d s�t jd� d S t
|d |d |d d�}|s�t jd� d S yt|j|d d�}W n: tjk
�r0 } zd}t jdt| �� W Y d d } ~ X nX |�rZtj� tj|j� t jd| |� d S )Nr
z;Skipping module named %s, no 'rsyslog' key in configurationr r z# begin remotesz
# end remotes)rn ro r$ r Tr r )r r �enablez.Empty config rsyslog['configs'], nothing to dor r )r rH rI z0restart of syslog not necessary, no changes mader )r' FzFailed to reload syslog %sz%s configured %s files)r? �debugr6 r rE rq r% r Zinstall_packagesr Zis_BSDr& rx rK r) r rt r@ r. r Z
reset_loggingZ
setup_loggingr )
r r rr ry r3 r r( ZchangesZ restartedre r! r! r" �handle� sR
" r| )Nr
)r )N)NN)/�__doc__ru r ZloggingrB �re�textwrapr Z cloudinitr r r Zcloudinit.cloudr Zcloudinit.configr Zcloudinit.config.schemar r Zcloudinit.distrosr
r Zcloudinit.settingsr ZMODULE_DESCRIPTION�metar r Z getLoggerrj r? �compilerS rV r# r r) r/ r6 rK r^ rY rq rx r. r- r| r! r! r! r" �<module> sn
/)
&?