�
oB�]c @ s d Z d d l Z d d l Z d d l Z d d l m Z d d l m Z d Z d Z d Z
i Z d Z d Z
d
Z d Z d Z d
Z d Z e j e � Z e j d � Z e j d � Z e
e d � Z d � Z d � Z d d � Z d e f d � � YZ d d d � Z! d � Z" d S( s�
.. _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
i����N( t log( t utils 20-cloud-config.confs /etc/rsyslog.dt autot configst config_filenamet
config_dirt service_reload_commandt rsyslog_filenamet rsyslog_dirt remotess [ ]*[#]+[ ]*s_ ^(?P<proto>[@]{0,2})(([\[](?P<bracket_addr>[^\]]*)[\]])|(?P<addr>[^:]*))([:](?P<port>[0-9]+))?$c C sY d } | t k r< | r* d d | g } qB d | d g } n | } t j | d t �d S( Nt rsyslogt systemctls reload-or-try-restartt servicet restartt capture( t
DEF_RELOADR t subpt True( t commandt systemdR t cmd( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt
reload_syslog� s c C s | j d i � } t | j d � t � r} i | j d � t 6} t | k r] | t | t <n t | k r} | t | t <q} n t g t f t t t j
f t t t j
f t t
t j
t f f t t t f f } xD | D]< \ } } } | | k st | | | � r� | | | <q� q� W| S( NR
( t gett
isinstancet listt KEYNAME_CONFIGSt KEYNAME_LEGACY_FILENAMEt KEYNAME_FILENAMEt KEYNAME_LEGACY_DIRt KEYNAME_DIRt DEF_DIRt sixt string_typest DEF_FILENAMEt KEYNAME_RELOADR t KEYNAME_REMOTESt DEF_REMOTESt dict( t cfgt mycfgt fillupt keyt defaultt vtypes( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt load_config� s c
C sS g } xFt | � D]8\ } } t | t � rs d | k rT t j d | d � q n | d } | j d | � } n | } | } | j � } | s� t j d | d � q n t j j | | � } d } | | k r� d } | j
| � n y< d } | j d � s d } n t j
| | | d
| �Wq t k
rJt j t d | � q Xq W| S( Nt contents% No 'content' entry in config entry %si t filenames Entry %s has an empty filenamet abt wbt s
t omodes Failed to write to %s( t enumerateR R% t LOGt warningR t stript ost patht joint appendt endswithR t
write_filet Exceptiont logexc(
R t def_fnamet cfg_dirt filest cur_post entR- R. R2 t endl( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt apply_rsyslog_changes� s8
c C s� y% t j | � \ } } | j � } Wn t k
rE | d } } n X| j � j � } d } t | � d k ry | } n1 t | � d k r� | \ } } n t d | � � t j | � } | s� t d | � � n | j d � } | j d � p� | j d � } | j d � } | j d � r@| j
d
� r@t d | � � n | rV| rV| } n t d | d
| d | d | d | � }
|
j � |
S( Ni i s line had multiple spaces: %ss Invalid host specification '%s't protot addrt bracket_addrt portt [t ]s" host spec had invalid brackets: %st namet match(
t
COMMENT_REt splitR6 t
ValueErrort Nonet lent HOST_PORT_RERM t groupt
startswithR; t SyslogRemotesLinet validate( t lineRL t datat commentt toksRM t host_portRF RG RI t t( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt parse_remotes_line s4
RV c B s; e Z d d d d d d � Z d � Z d � Z d � Z RS( c C s� | s d } n | | _ | | _ | s0 d } n | d k rE d } n | d k rZ d } n | | _ | | _ | r� t | � | _ n d | _ d S( Ns *.*t udpt @s @@t tcp( RL RM RF RG t intRI RQ ( t selfRL RM RF RG RI ( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt __init__F s c C s` | j rD y t | j � WqD t k
r@ t d | j � � qD Xn | j s\ t d � � n d S( Ns port '%s' is not an integers address is required( RI Rb RP RG ( Rc ( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyRW Z s
c C s& d | j | j | j | j | j f S( Ns. [name=%s match=%s proto=%s address=%s port=%s]( RL RM RF RG RI ( Rc ( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt __repr__d s c C s� | j d } | j d k r) | d 7} n | j d k rE | d 7} n d | j k rl | d | j d 7} n
| | j 7} | j r� | d | j 7} n | j r� | d
| j 7} n | S( Nt R_ R` Ra s @@t :RJ RK s :%ss # %s( RM RF RG RI RL ( Rc t buf( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt __str__i s
N( t __name__t
__module__RQ Rd RW Re Ri ( ( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyRV E s
c C s� | s
d Sg } | d k r, | j | � n xu | j � D]g \ } } | sQ q9 n y# | j t t | d | �� � Wq9 t k
r� } t j d | | | � q9 Xq9 W| d k r� | j | � n d j | � d S( NRL s! failed loading remote %s: %s [%s]s
( RQ R: t itemst strR^ RP R4 R5 R9 ( R t headert footert linesRL RX t e( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt remotes_to_rsyslog_cfg} s # c
C sA d | k r | j d | � d St | � } | t } | t rf | j t | t d d d d �� n | d s� | j d � d St d | t d | t d
| t � } | s� | j d � d Sy) t d | t
d
| j j � � f } Wn, t
j k
r} t } | j d | � n X| r=| j � | j d | | � n d S( NR
s; Skipping module named %s, no 'rsyslog' key in configurationRn s # begin remotesRo s
# end remotesR s. Empty config rsyslog['configs'], nothing to doR? R@ s0 restart of syslog not necessary, no changes madeR R s Failed to reload syslogs %s configured %s files( t debugR, R R# R: Rr RE R R R R" t distrot uses_systemdR t ProcessExecutionErrort FalseR5 t
cycle_logging(
RL R& t cloudR t _argsR' R t changest restartedRq ( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt handle� s@
(# t __doc__R7 t reR t cloudinitR t loggingR R! R R R$ R R R R" R R R# t getLoggerRj R4 t compileRN RS Rw R R, RE RQ R^ t objectRV Rr R} ( ( ( s? /usr/lib/python2.7/site-packages/cloudinit/config/cc_rsyslog.pyt <module>^ s6 W ( %8