Updated documentation for alert definition, example added #8414
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cardigliano
reviewed
May 30, 2024
cardigliano
reviewed
May 30, 2024
doc/src/alerts/developing_alerts.rst
Outdated
| .. figure:: ../img/developing_alerts_alert_structure.png | ||
| :align: center | ||
| :alt: BlacklistedFlowAlert Flow Alert | ||
| Let's begin by creating al the files of the alert. |
There was a problem hiding this comment.
Typo: all
Also, I would describe the whole list of files that should be created, before showing their content
There was a problem hiding this comment.
And I would specify the new files that should be created, and the files that should be modified (e.g. to add new keys, or register the check)
doc/src/alerts/developing_alerts.rst
Outdated
| :alt: BlacklistedFlowAlert Flow Alert | ||
| Let's begin by creating al the files of the alert. | ||
|
|
||
| Under :code:`scripts/lua/modules/alert_definitions/host/` create a new file, in this case :code:`host_alert_http_contacts` |
There was a problem hiding this comment.
The file name is missing the .lua suffix
| Formatting the output | ||
| ---------------------- | ||
|
|
||
| One last thing we can do is to modify the locales in order to visualize both the check enable section and the alert launched in a readable format. |
There was a problem hiding this comment.
Please specify that the localized strings are those referenced in the alert or check definition
cardigliano
reviewed
May 30, 2024
|
|
||
| - create new files in the specified directory: | ||
|
|
||
| - place :code:`host_alert_http_contacts.lua` under :code:`scripts/lua/modules/alert_definitions/host/` this file is responsable for the representation of the alert on the GUI. |
There was a problem hiding this comment.
What about the check definitions (scripts/lua/modules/check_definitions/)?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.