streamalert
streamalert copied to clipboard
Improvement: Parse Rules with RST
Background
There is no current standard for gathering rule metadata context into alerts. An ideal improvement would be parsing StreamAlert rule docstrings as RST and adding this metadata to the alert structure.
Desired Outcome
A structured RST rule docstring with labeled fields:
Example:
:Description: My new rule
:Version: 1
:Authors:
- Me
- Myself
- I
And in the alert:
{
'rule': {
'description': 'My new rule',
'version': 1,
'authors': 'Me, myself, and I'
}
}