Current File : //lib/python2.7/site-packages/salt/engines/junos_syslog.pyo
�
���^c @@ s~ d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z y| d d l m Z d d l
m Z m Z d d l
m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z e Z Wn- e k
r� e Z d e f d � � YZ n Xd d l j j Z d d l! m" Z" d d
l# m$ Z$ e j% e& � Z' d Z( d � Z) d
e f d � � YZ* d e f d � � YZ+ d d � Z, d S( u@
Junos Syslog Engine
==========================
.. versionadded:: 2017.7.0
:depends: pyparsing, twisted
An engine that listens to syslog message from Junos devices,
extract event information and generate message on SaltStack bus.
The event topic sent to salt is dynamically generated according to the topic title
specified by the user. The incoming event data (from the junos device) consists
of the following fields:
1. hostname
2. hostip
3. daemon
4. event
5. severity
6. priority
7. timestamp
8. message
9. pid
10. raw (the raw event data forwarded from the device)
The topic title can consist of any of the combination of above fields, but the
topic has to start with ``jnpr/syslog``. Here are a couple example
combinations:
- jnpr/syslog/hostip/daemon/event
- jnpr/syslog/daemon/severity
The corresponding dynamic topic sent on salt event bus would look something like:
- jnpr/syslog/1.1.1.1/mgd/UI_COMMIT_COMPLETED
- jnpr/syslog/sshd/7
The default topic title is ``jnpr/syslog/hostname/event``.
One can choose the type of data they want from the event bus. For example, if
one wants only events pertaining to a particular daemon, this can be specified
in the configuration file:
.. code-block:: yaml
daemon: mgd
One can even have a list of daemons:
.. code-block:: yaml
daemon:
- mgd
- sshd
Example configuration (to be written in master config file)
.. code-block:: yaml
engines:
- junos_syslog:
port: 9999
topic: jnpr/syslog/hostip/daemon/event
daemon:
- mgd
- sshd
For junos_syslog engine to receive events, syslog must be set on the junos device.
This can be done via following configuration:
.. code-block:: text
set system syslog host <ip-of-the-salt-device> port 516 any any
Below is a sample syslog event which is received from the junos device:
.. code-block:: text
<30>May 29 05:18:12 bng-ui-vm-9 mspd[1492]: No chassis configuration found
The source for parsing the syslog messages is taken from:
https://gist.github.com/leandrosilva/3651640#file-xlog-py
i ( t absolute_importt print_functiont unicode_literalsN( t DatagramProtocol( t reactort threads( t Wordt alphast Suppresst Combinet numst stringt Optionalt Regext LineEndt StringEndt
delimitedListR c B@ s e Z RS( ( t __name__t
__module__( ( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyR h s ( t six( t rangeu junos_syslogc C@ s t s t d f St S( u>
Load only if twisted and pyparsing libs are present.
u\ junos_syslog could not be loaded. Make sure you have twisted and pyparsing python libraries.( t HAS_TWISTED_AND_PYPARSINGt Falset True( ( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt __virtual__w s
t _Parserc B@ s e Z d � Z d � Z RS( c C@ se t t � } t � j � } t t | d d t �t d � � } t d � | t d � } t t j t j
d d �} | } t | d | d | � } | | | } t t t d d d � } t t t d
d d d � t t d � | t d � � t d � }
t
d
� } | | | | |
| t � | B| _ | | | | | t � | B| _ d S( Nu .t combineu :u <u >t exacti u _u -u /u [u ]u .*( R R
R t suppressR R R R R t uppercaset lowercaseR R R
R t _Parser__patternt _Parser__pattern_without_daemon( t selft intst EOLt ipAddresst priorityt montht dayt hourt timestampt hostnamet daemont message( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt __init__� s$
H (c C@ s� y | j j | � } Wn< t k
rT y | j j | � } WqU t k
rP d SXn Xt | � d k r� i } t | d � | d <| d d @| d <| d d ?| d <t j d � | d <| d
| d <d | d
<| d | d <d | d <| | d <| St | � d k r�i } t | d � | d <| d d @| d <| d d ?| d <t j d � | d <| d
| d <| d | d
<| d | d <d | d <t j d | d � } | r�| j
d � | d <n | | d <| St | � d k r�i } t | d � | d <| d d @| d <| d d ?| d <t j d � | d <| d
| d <| d | d
<| d | d <| d | d <d | d <t j d | d � } | r�| j
d � | d <| j
d � | d <n | | d <| St | � d k r�i } | d | d <t | d � | d <| d d @| d <| d d ?| d <t j d � | d <| d | d <| d | d
<| d | d <| d | d <d | d <t j d | d � } | r�| j
d � | d <| j
d � | d <n | | d <| Sd S( Ni i u priorityi u severityi u facilityu %Y-%m-%d %H:%M:%Su timestampi u hostnameu unknownu daemoni u messageu SYSTEMu eventu rawu (\w+): (.*)i i u pidi i u hostip( R t parseStringt ExceptionR t lent intt timet strftimet ret matcht group( R! t linet parsedt payloadt obj( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt parse� s�
( R R R- R; ( ( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyR � s 't _SyslogServerFactoryc B@ s5 e Z d � Z d � Z d � Z d � Z d � Z RS( c
C@ sQ | | _ t � | _ d d d d d d d d d d
g
} d | j k r8| d j d � | j d <| d j d � } | | _ t | � d
k s� | d d k s� | d d k r� t j d � d d d d
g | _ nV xS t d
t | � � D]< } | | | k r� t j d � d d d d
g | _ Pq� q� W| j d =n d d d d
g | _ d S( Nu hostipu priorityu severityu facilityu timestampu hostnameu daemonu pidu messageu eventu topicu /i i u jnpri u syslogur The topic specified in configuration should start with "jnpr/syslog". Using the default topic.uK Please check the topic specified. Only the following keywords can be specified in the topic: hostip, priority, severity, facility, timestamp, hostname, daemon, pid, message, event. Using the default topic.(
t optionsR R: t stript splitt titleR0 t logt debugR ( R! R= t datat topicst i( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyR- � s8 2
c C@ s� | j j | � } | | d <t j d | | | � t } x� | D]� } | | k rt | | t j t f � r� t j | | � t j | | � k rt
} Pqqt | | t � r� xN | | D], } t j | � t j | | � k r� Pq� q� Wt
} Pqt d � � q? t d � � q? W| r�d | k r�d } xU t
d t | j � � D]; } | d t j | | j | � 7} t j d | | � qHWi t d
6| d 6| d 6}
|
St d
� � n i t
d
6}
|
Sd S( u�
This function will parse the raw syslog data, dynamically create the
topic according to the topic specified by the user (if specified) and
decide whether to send the syslog data as an event on the master bus,
based on the constraints given by the user.
:param data: The raw syslog event data which is to be parsed.
:param host: The IP of the host from where syslog is forwarded.
:param port: Port of the junos device from which the data is sent
:param options: kwargs provided by the user in the configuration file.
:return: The result dictionary which contains the data and the topic,
if the event is to be sent on the bus.
u hostipu5 Junos Syslog - received %s from %s, sent from port %su* Arguments in config not specified properlyu^ Please check the arguments given to junos engine in the configuration fileu eventu jnpr/syslogi u /u8 Junos Syslog - sending this event on the bus: %s from %su sendu datau topicu5 The incoming event data could not be parsed properly.N( R: R; RA RB R t
isinstanceR t string_typesR1 t text_typeR t listR/ R R0 R@ ( R! RC t hostt portR= t send_this_eventt keyt optt topicRE t result( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt parseData! sH
&"
"
c C@ so | d rk | d } | d } t d d k rQ t j t t d � j | | � qk t d d | d | � n d
S( u�
This function identifies whether the engine is running on the master
or the minion and sends the data to the master event bus accordingly.
:param result: It's a dictionary which has the final data and topic.
u sendu datau topicu __roleu masteru sock_diru event.fire_masterRC t tagN( t __opts__t eventt get_master_eventt
fire_eventt __salt__( R! RP RC RO ( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt send_event_to_salt` s
c C@ s t j | j � d S( u)
Log the error messages.
N( RA t errort getErrorMessage( R! t err_msg( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt handle_errorv s c C@ sG | \ } } t j | j | | | | j � } | j | j | j � d S( N( R t
deferToThreadRQ R= t addCallbacksRX R\ ( R! RC t connection_detailsRJ RK t d( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt datagramReceived| s ( R R R- RQ RX R\ Ra ( ( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyR< � s
- ? i c K@ s4 t j d | � t j | t | � � t j � d S( Nu& Starting junos syslog engine (port %s)( RA t infoR t listenUDPR< t run( RK t kwargs( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt start� s (- t __doc__t
__future__R R R R4 t loggingR2 t twisted.internet.protocolR t twisted.internetR R t pyparsingR R R R R
R R R
R R R R R t ImportErrorR t objectt salt.utils.eventt utilsRT t salt.extR t salt.ext.six.movesR t getLoggerR RA t __virtualname__R R R< Rf ( ( ( s= /usr/lib/python2.7/site-packages/salt/engines/junos_syslog.pyt <module>W s* L
q�
Mini Shell