o w7e5 @sUdZddlZddlZddlZddlZddlmZddlmZ ddlm Z m Z ddl m Z ddlmZddlmZmZdd lmZmZdd lmZd Zd d deegeedededgdgdZeed<eeZdddiiddgddZddgdddgdddgddZe eZe d Z!e d!Z"d"efd#d$Z#dd/d0Z)Gd1d2d2Z*d?d3d4Z+d5e d*dfd6d7Z,d8e-d)ed5e d9e.d*df d:d;Z/dS)@z-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``. cc_rsyslogRsyslogz$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)idnametitle descriptiondistros frequencyexamplesactivate_by_schema_keysmetaz/etc/rsyslog.dz20-cloud-config.confautorsyslogdF) config_dirconfig_filenameservice_reload_commandremotesconfigs check_exepackagesinstall_rsyslogz/usr/local/etc/rsyslog.d)rr!zsysutils/rsyslogz/usr/pkg/etc/rsyslog.d)freebsdopenbsdnetbsdz [ ]*[#]+[ ]*z_^(?P[@]{0,2})(([\[](?P[^\]]*)[\]])|(?P[^:]*))([:](?P[0-9]+))?$distrocCs4t}tt}|j|vrtj|||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_CONFIGosfamilyr mergemanydictr)r&dcfgcfgr/=/usr/lib/python3/dist-packages/cloudinit/config/cc_rsyslog.pydistro_default_rsyslog_configs   r1cCs(t|rdS|durdg}||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)rwhich) install_funcr!r r/r/r0r"s  r"cCs.|dkr|dd}|d|Stj|ddS)Nrrsyslog_svcnamerz try-reloadT)capture) get_optionmanage_servicer)r&commandservicer/r/r0 reload_syslogs  r:r.returnc Cs"|di}t|}t|dtr4tjdddd|di}d|vr*|d|d<d|vr4|d|d <dgtfd |d tfd|dtfd |d tfd |d ttffd |d tfd |d tfd|dtff}|D]&\}}}||vrv|||<qht|||st d|d|dt ||qh|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. rz)The rsyslog key with value of type 'list'z22.2) deprecateddeprecated_versionrrsyslog_filenamer rsyslog_dirrrrr r!r"zInvalid type for key `z`. Expected type(s): z. Current type: ) getr1 isinstancelistr deprecatestrdictbool ValueErrortype)r.r&mycfg distro_configfillupkeydefaultvtypesr/r/r0 load_configsF           rOc Csg}t|D]m\}}t|tr'd|vrtd|dq|d}|d|}n|}|}|}|s:td|dqtj ||}d}||vrNd}| |zd} | d sXd } t j ||| |d Wqtyst td |Yqw|S) Ncontentz%No 'content' entry in config entry %sfilenamezEntry %s has an empty filenameabwb )omodezFailed to write to %s) enumeraterArELOGwarningr@stripospathjoinappendendswithr write_file Exceptionlogexc) r def_fnamecfg_dirfilescur_posentrPrRrWendlr/r/r0apply_rsyslog_changess<    rjc Csz t|\}}|}Wnty|d}}Ynw|}d}t|dkr-|}nt|dkr8|\}}ntd|t|}|sKtd||d}|dpY|d}|d} |d ro| d sotd ||ru|su|}t ||||| d } | | S) NrQzline had multiple spaces: %szInvalid host specification '%s'protoaddr bracket_addrport[]z"host spec had invalid brackets: %srmatchrlrmro) COMMENT_REsplitr[rGlen HOST_PORT_RErsgroup startswithr`SyslogRemotesLinevalidate) linerdatacommenttoksrs host_portrlrmrotr/r/r0parse_remotes_lines8             rc@s0eZdZ d ddZddZddZdd ZdS) rzNcCs^|sd}||_||_|sd}|dkrd}n|dkrd}||_||_|r*t||_dSd|_dS)Nz*.*udp@@@tcp)rrsrlrmintro)selfrrsrlrmror/r/r0__init__&s zSyslogRemotesLine.__init__c CsP|jrzt|jWnty}ztd|j|d}~ww|js&tddS)Nzport '%s' is not an integerzaddress is required)rorrGrm)rer/r/r0r{;szSyslogRemotesLine.validatecCsd|j|j|j|j|jfS)Nz.[name=%s match=%s proto=%s address=%s port=%s]rr)rr/r/r0__repr__GszSyslogRemotesLine.__repr__cCs|jd}|jdkr|d7}n |jdkr|d7}d|jvr'|d|jd7}n||j7}|jr6|d |j7}|jr@|d |j7}|S) N rrrr:rprqz:%sz # %s)rsrlrmror)rbufr/r/r0__str__Ps      zSyslogRemotesLine.__str__)NNNNN)__name__ __module__ __qualname__rr{rrr/r/r/r0rz%s   rzc Cs|sdSg}|dur|||D].\}}|sqz |tt||dWqtyA}ztd|||WYd}~qd}~ww|durK||d|dS)N)rz!failed loading remote %s: %s [%s]rV)r_itemsrDrrGrYrZr^)rheaderfooterlinesrr|rr/r/r0remotes_to_rsyslog_cfgds"  rcloudcCsz |jddWn tjyYdSw|jdd|jttj|jddtdWddS1s?wYdS)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 enabledsyslogdNdisableonestopzOsyslogd is running before cloud-init! Please report this as bug to the porters!) r&r7rProcessExecutionError reload_init contextlibsuppressrYerror)rr/r/r0 disable_and_stop_bsd_base_syslogvs "rrargsc CsTd|vr td|dSt||j}|d}|dr&|t|dddd|jdd}|d d ur@t|jj|d |d d t rO|j d|t ||dsZtddSt |d|d|dd}|sptddSz t|j|dd}Wntjy} zd}tdt| WYd} ~ nd} ~ ww|r|td||dSdS)Nrz;Skipping module named %s, no 'rsyslog' key in configurationrrz# begin remotesz # end remotes)rrr4r"Tr!r )r!r enablez.Empty config rsyslog['configs'], nothing to dorr)rrdrez0restart of syslog not necessary, no changes mader)r8FzFailed to reload syslog %sz%s configured %s files)rYdebugrOr&r_rr6r"install_packagesris_BSDr7rrjr:rrrZrD cycle_logging) rr.rrrIrr9changes restartedrr/r/r0handlesb      r)Nr)r)N)NN)0__doc__rr)r\retextwrapr cloudinitrloggingrrcloudinit.cloudrcloudinit.configrcloudinit.config.schemarr cloudinit.distrosr r cloudinit.settingsr MODULE_DESCRIPTIONr__annotations__r*r( getLoggerrrYcompilertrwr1r"r:rErOrjrrzrrrDrBrr/r/r/r0s       &0     / )& ?"