format-cef

A small helper for formatting ArcSight Common Event Format (CEF) compliant messages


Keywords
cef, logging
License
MIT
Install
pip install format-cef==0.0.4

Documentation

format_cef

format_cef is a little helper library for producing ArcSight Common Event Format (CEF) compliant messages from structured arguments. You can use it like this:

>>> from format_cef import format_cef
>>> format_cef(
    'acme corp', 'TNT', 1.0, '404 | not found', 'Explosives not found', 10
    oextensions={'deviceAction': 'bang = !'})
'CEF:0|acme corp|TNT|1.0|404 \| not found|Explosives not found|10|act=bang \= !'

Notice how the format format_cef takes care of escaping delimiters correctly. It will also ensure that each CEF extension complies to the restrictions outlined in the CEF documentation.

This module deliberately remains agnostic as to the log message transport protocol (as does CEF itself). It is also designed to remain stateless so as to easy to test and use as a building block in larger systems.