U Ld5 @sUdZddlZddlZddlZddlZddlmZddlmZ ddlm Z m Z ddl m Z ddlmZddlmZmZdd lmZmZdd lmZd Zd d deegeedededgdgdZeed<eeZdddiiddgddZddgdddgdddgddZe eZe d Z!e d!Z"ed"d#d$Z#d:d%d&Z$d;d'd(Z%e&ee&d)d*d+Z'd,d-Z(dz-Rsyslog: Configure system logging via rsyslogN)dedent)log)subputil)Cloud)Config) MetaSchema get_meta_doc) ALL_DISTROSDistro) PER_INSTANCEamThis 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)idnametitleZ descriptionZdistrosZ frequencyZexamplesZactivate_by_schema_keysmetaz/etc/rsyslog.dz20-cloud-config.confautoZrsyslogdF) config_dirconfig_filenameservice_reload_commandremotesconfigs check_exepackagesinstall_rsyslogz/usr/local/etc/rsyslog.d)rrzsysutils/rsyslogz/usr/pkg/etc/rsyslog.d)ZfreebsdZopenbsdZnetbsdz [ ]*[#]+[ ]*z_^(?P[@]{0,2})(([\[](?P[^\]]*)[\]])|(?P[^:]*))([:](?P[0-9]+))?$)distrocCs4t}tt}|j|kr0tj|||jgdd}|S)zConstruct 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_OVERRIDEScopyRSYSLOG_CONFIGZosfamilyrZ mergemanydictr)rZdcfgcfgr!=/usr/lib/python3/dist-packages/cloudinit/config/cc_rsyslog.pydistro_default_rsyslog_configs   r#cCs(t|rdS|dkrdg}||dS)aiInstall 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 )rZwhich)Z install_funcrrr!r!r"rs rcCs.|dkr |dd}|d|Stj|ddS)Nrrsyslog_svcnamer z try-reloadT)Zcapture) get_optionmanage_servicer)rcommandservicer!r!r" reload_syslogs  r))r rreturnc Cs"|di}t|}t|dtrhtjdddd|di}d|krT|d|d<d|krh|d|d <dgtfd |d tfd|dtfd |d tfd |d ttffd |d tfd |d tfd|dtff}|D]L\}}}||kr|||<qt|||st d|d|dt ||q|S)zReturn 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_versionrZrsyslog_filenamerZ rsyslog_dirrrrrrrzInvalid type for key `z`. Expected type(s): z. Current type: ) getr# isinstancelistrZ deprecatestrdictbool ValueErrortype)r rmycfgZ distro_configZfillupkeydefaultZvtypesr!r!r" load_configs@          r6c Csg}t|D]\}}t|trNd|kr8td|dq |d}|d|}n|}|}|}|sttd|dq tj ||}d}||krd}| |z*d} | d sd } t j ||| |d Wq tk rt td |Yq Xq |S) Ncontentz%No 'content' entry in config entry %sfilenamezEntry %s has an empty filenameZabwb )omodezFailed to write to %s) enumerater,r/LOGwarningr+stripospathjoinappendendswithrZ write_file ExceptionZlogexc) r def_fnamecfg_dirfilesZcur_posZentr7r9r=Zendlr!r!r"apply_rsyslog_changess<   rKc Cs zt|\}}|}Wntk r8|d}}YnX|}d}t|dkr\|}n"t|dkrr|\}}n td|t|}|std||d}|dp|d}|d} |d r| d std ||r|s|}t ||||| d } | | S) Nr8zline had multiple spaces: %szInvalid host specification '%s'protoaddrZ bracket_addrport[]z"host spec had invalid brackets: %srmatchrMrNrO) COMMENT_REsplitrAr1len HOST_PORT_RErSgroup startswithrFSyslogRemotesLinevalidate) linerdataZcommentZtoksrSZ host_portrMrNrOtr!r!r"parse_remotes_lines>           r_c@s.eZdZd ddZddZddZdd ZdS) rZNcCs\|sd}||_||_|sd}|dkr*d}n |dkr6d}||_||_|rRt||_nd|_dS)Nz*.*udp@@@tcp)rrSrMrNintrO)selfrrSrMrNrOr!r!r"__init__&s zSyslogRemotesLine.__init__c CsZ|jrHzt|jWn2tk rF}ztd|j|W5d}~XYnX|jsVtddS)Nzport '%s' is not an integerzaddress is required)rOrdr1rN)reer!r!r"r[;szSyslogRemotesLine.validatecCsd|j|j|j|j|jfS)Nz.[name=%s match=%s proto=%s address=%s port=%s]rR)rer!r!r"__repr__GszSyslogRemotesLine.__repr__cCs|jd}|jdkr|d7}n|jdkr0|d7}d|jkrN|d|jd7}n ||j7}|jrl|d |j7}|jr|d |j7}|S) N r`rarcrb:rPrQz:%sz # %s)rSrMrNrOr)reZbufr!r!r"__str__Ps      zSyslogRemotesLine.__str__)NNNNN)__name__ __module__ __qualname__rfr[rhrkr!r!r!r"rZ%s   rZc Cs|sdSg}|dk r|||D]\\}}|s4q&z|tt||dWq&tk r}ztd|||W5d}~XYq&Xq&|dk r||d|dS)N)rz!failed loading remote %s: %s [%s]r<)rEitemsr.r_r1r?r@rD)rheaderfooterlinesrr\rgr!r!r"remotes_to_rsyslog_cfgds $ rs)cloudr*c Csxz|jddWntjk r*YdSX|jdd|jttj|jddtdW5QRXdS)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 enabledZsyslogdNdisableZonestopzOsyslogd is running before cloud-init! Please report this as bug to the porters!) rr&rProcessExecutionErrorZ reload_init contextlibsuppressr?error)rtr!r!r" disable_and_stop_bsd_base_syslogvs r{)rr rtargsr*c CsRd|krtd|dSt||j}|d}|drL|t|dddd|jdd}|d d krt|jj|d |d d t r|j d|t ||dstddSt |d|d|dd}|stddSzt|j|dd}Wn:tjk r0} zd}tdt| W5d} ~ XYnX|rN|td||dS)Nr z;Skipping module named %s, no 'rsyslog' key in configurationrrz# begin remotesz # end remotes)rprqr$rTrr)rrenablez.Empty config rsyslog['configs'], nothing to dorr)rrHrIz0restart of syslog not necessary, no changes mader)r'FzFailed to reload syslog %sz%s configured %s files)r?debugr6rrErsr%rZinstall_packagesrZis_BSDr&r{rKr)rrwr@r.Z cycle_logging) rr rtr|r3rr(ZchangesZ restartedrgr!r!r"handles`     "r)Nr )r)N)NN)0__doc__rxrrBretextwraprZ cloudinitrZloggingrrZcloudinit.cloudrZcloudinit.configrZcloudinit.config.schemarr Zcloudinit.distrosr r Zcloudinit.settingsr ZMODULE_DESCRIPTIONr__annotations__rrZ getLoggerrlr?compilerTrWr#rr)r/r6rKr_rZrsr{r.r-rr!r!r!r" s      &0     /) &?