Piat is a syslog and trap listeners APIs which are easy to use, it support syslog parsing for multiple vendors
pip install piat
to run both listeners/servers use the PiatServer API:
from piat.servers import PiatServer
def syslog_cb(syslog_msg):
""" callback to be executed on received syslog msg """
data = syslog_msg.get_dictionary()
# do something with syslog data
print(data)
def trap_cb(trap_msg):
""" callback to be executed on received trap msg """
data = trap_msg.get_dictionary()
# do something with trap data
print(data)
if __name__ == '__main__':
server = PiatServer(traps_callbacks=[trap_cb],
syslog_callbacks=[syslog_cb],
trap_community='my_community')
server.start()
syslog data example :
{'ip': '192.168.1.1',
'timestamp':
'2019-04-28 21:26:40.809271',
'tag': 'LSD-4-LABEL_RESOURCE',
'severity': 'warning',
'facility': 'syslogd',
'msg': 'label range 100-150 exhausted'}
{'ip': '192.168.1.9',
'timestamp': '2019-04-28 21:26:41.741839',
'tag': 'SYS-6-LOGGINGHOST_STARTSTOP',
'severity': 'informational',
'facility': 'syslogd',
'msg': 'Logging to host 192.1.1.8 port 514 started - CLI initiated'}
trap data example :
{'ip': '192.168.1.1',
'timestamp': '2019-04-28 21:30:11.536344',
'sysUpTime': '88847929',
'snmpTrapOID': 'CISCO-SMI::cisco.0.1',
'snmpTrapAddress': '192.168.1.1',
'snmpTrapCommunity': 'public',
'snmpTrapEnterprise': 'CISCO-SMI::cisco',
'local': 'root',
'tcpConnState': 'finWait2'}
{'ip': '192.168.1.9',
'timestamp': '2019-04-28 21:30:11.544577',
'sysUpTime': '88847996',
'snmpTrapOID': 'CISCO-SYSLOG-MIB::clogMessageGenerated',
'snmpTrapAddress': '192.168.1.9',
'snmpTrapCommunity': 'public',
'snmpTrapEnterprise': 'CISCO-SYSLOG-MIB::ciscoSyslogMIBNotificationPrefix',
'clogHistFacility': 'LSD',
'clogHistSeverity': 'warning',
'clogHistMsgName': 'LABEL_RESOURCE',
'clogHistMsgText': 'label range 100-150 exhausted',
'clogHistTimestamp': '88847996'}
to run only syslog server:
from piat.servers import SyslogServer
def syslog_cb(syslog_msg):
data = syslog_msg.get_dictionary()
print(data)
# do something with syslog data
if __name__ == '__main__':
server = SyslogServer(callbacks=[syslog_cb])
server.start()
also you can run only trap server:
from piat.servers import SnmpTrapServer
def trap_cb(trap_msg):
data = trap_msg.get_dictionary()
# do something with trap data
print(data)
if __name__ == '__main__':
server = SnmpTrapServer(callbacks=[trap_cb],community='my_comm')
server.start()
- Cisco.
- Arista.:
- Juniper.
- Huawei.
- HP.
- F5.
- Fortinet.
- you can pass as many callback as you want, all callbacks will be running concurrently in separate threads.
- both syslog and trap will be running as an independent process.
- you can add more mib dir to be used by the trap server, use
add_mib_dirkwarg to pass the mib dir location. - Piat uses
pysnmpfor trap listening, so if you want to extend the mib support you need to combile the mib files usingmibdump.pycommand provided bypysnmpto combile the new mibs, then add the compiled mibs dir to piat server usingadd_mib_dir. - we only support Syslog parsing described by rfc3164.